schema.graphql

type Activity implements Node {
  # The ID of an object
  id: ID!
  user_id: ID!
  date: String!
  activity_link: String!
  type: String!
  type_desc: String
  content: String!
}

# A connection to a list of items.
type ActivityConnection {
  # Information to aid in pagination.
  pageInfo: PageInfo!

  # A list of edges.
  edges: [ActivityEdge]
}

# An edge in a connection.
type ActivityEdge {
  # The item at the end of the edge
  node: Activity

  # A cursor for use in pagination
  cursor: String!
}

# Authentication strategy object, provides a flexible structure for various auth methods
type AuthStrategy implements Node {
  # The ID of an object
  id: ID!
  auth_id: ID!
  email: String
  method: String!
  version: String!
}

# A connection to a list of items.
type AuthStrategyConnection {
  # Information to aid in pagination.
  pageInfo: PageInfo!

  # A list of edges.
  edges: [AuthStrategyEdge]
}

# An edge in a connection.
type AuthStrategyEdge {
  # The item at the end of the edge
  node: AuthStrategy

  # A cursor for use in pagination
  cursor: String!
}

# Operation Completion Report
type CompletionObj {
  code: String
  msg: String
  msg_id: String
  processed: Int
  modified: Int
}

# EXLskills course
type Course implements Node {
  # The ID of an object
  id: ID!
  title: String!
  headline: String!
  description: String!
  organization_ids: [ID]
  primary_locale: String
  logo_url: String!
  cover_url: String!
  is_published: Boolean!
  is_organization_only: Boolean!
  subscription_level: Int!

  # Course units
  units(orderBy: [OrderBy], filterValues: FilterValues, resolverArgs: [QueryResolverArgs], after: String, first: Int, before: String, last: Int): CourseUnitConnection
  topics: [String]
  enrolled_count: Int!
  view_count: Int!
  info_md: String!
  repo_url: String
  verified_cert_cost: Float
  skill_level: Int
  est_minutes: Int
  primary_topic: String
  last_accessed_at: String
  last_accessed_unit: String
  last_accessed_section: String
  last_accessed_card: String
  delivery_methods: [String]
  instructor_timekit: InstructorTimekit
  weight: Float
}

# A connection to a list of items.
type CourseConnection {
  # Information to aid in pagination.
  pageInfo: PageInfo!

  # A list of edges.
  edges: [CourseEdge]
}

# Course Delivery Schedule
type CourseDeliverySchedule implements Node {
  # The ID of an object
  id: ID!
  _id: String
  delivery_methods: [String]
  delivery_structure: String
  course_duration: EventDuration
  course_notes: String
  session_info: [ScheduledRunSessionInfoType]
  scheduled_runs: [ScheduledRunType]
}

# An edge in a connection.
type CourseEdge {
  # The item at the end of the edge
  node: Course

  # A cursor for use in pagination
  cursor: String!
}

enum CourseItem {
  course
  unit
  section
  card
}

type CourseItemHighlight {
  inTitle: [String]
  inHeadline: [String]
  inText: [String]
  inCode: [String]
}

# Unit of an EXLskills course
type CourseUnit implements Node {
  # The ID of an object
  id: ID!
  index: Int
  title: String
  headline: String

  # Units sections
  sections(orderBy: [OrderBy], filterValues: FilterValues, resolverArgs: [QueryResolverArgs], after: String, first: Int, before: String, last: Int): UnitSectionConnection
  sections_list: [UnitSection]
  has_exam: Boolean
  final_exam_weight_pct: Float
  attempts_left: Int
  unit_progress_state: Int
  ema: Float
  grade: Float
  is_continue_exam: Boolean
  exam_attempt_id: String

  # The ID of an object
  exam_session_id: ID!
  last_attempted_at: String
  attempts: Int
  passed: Boolean
}

# A connection to a list of items.
type CourseUnitConnection {
  # Information to aid in pagination.
  pageInfo: PageInfo!

  # A list of edges.
  edges: [CourseUnitEdge]
}

# An edge in a connection.
type CourseUnitEdge {
  # The item at the end of the edge
  node: CourseUnit

  # A cursor for use in pagination
  cursor: String!
}

enum CudAction {
  CREATE
  UPDATE
  DELETE
}

input DateRange {
  date_from: DateTime
  date_to: DateTime
}

# A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the
# `date-time` format outlined in section 5.6 of the RFC 3339 profile of the ISO
# 8601 standard for representation of dates and times using the Gregorian calendar.
scalar DateTime

# EXLskills Digital Diploma Program
type DigitalDiploma implements Node {
  # The ID of an object
  id: ID!
  title: String!
  headline: String!
  description: String!
  organization_ids: [ID]
  primary_locale: String
  logo_url: String!
  cover_url: String!
  is_published: Boolean!
  topics: [String]
  info_md: String!
  skill_level: Int
  est_minutes: Int
  is_project: Boolean
  primary_topic: String
  instructor_timekit: InstructorTimekit
  plans: [DigitalDiplomaPlan]
}

# A connection to a list of items.
type DigitalDiplomaConnection {
  # Information to aid in pagination.
  pageInfo: PageInfo!

  # A list of edges.
  edges: [DigitalDiplomaEdge]
}

# An edge in a connection.
type DigitalDiplomaEdge {
  # The item at the end of the edge
  node: DigitalDiploma

  # A cursor for use in pagination
  cursor: String!
}

type DigitalDiplomaPlan {
  _id: String
  title: String
  headline: String
  cost: Float
  is_hidden: Boolean
  closes_at: String
  opens_at: String
  is_shipping_required: Boolean
}

# Event Duration
type EventDuration {
  months: Int
  weeks: Int
  days: Int
  hours: Int
  minutes: Int
}

type Exam implements Node {
  # The ID of an object
  id: ID!
  creator_id: ID!
  question_ids: [ID]
  tags: [String]
  random_order: Boolean!
  question_count: Int!
  time_limit: Int
  use_ide_test_mode: Boolean!
  est_time: Int
}

# ExamSession
type ExamSession implements Node {
  # The ID of an object
  id: ID!
  exam_id: ID!
  user_id: ID!
  course_unit_id: ID!
  question_ids: [ID]
  question_interaction_ids: [ID]!
  started_at: String
  is_active: Boolean
  submitted_at: String
  time_limit_exceeded: Boolean
}

input FieldCud {
  field: String
  valueToAssign: String
  valueToFind: String
  cudAction: CudAction
}

input FilterValues {
  filterValuesString: String
}

input GenerateCourseBadgeInput {
  course_id: ID!
  badge_type: String
  clientMutationId: String
}

type GenerateCourseBadgePayload {
  badge_uid: String
  completionObj: CompletionObj
  clientMutationId: String
}

input GetCurrentExamQuestionAnswerInput {
  exam_session_id: ID!
  question_id: ID!
  clientMutationId: String
}

type GetCurrentExamQuestionAnswerPayload {
  submitted_at: DateTime
  response_data: String
  completionObj: CompletionObj
  clientMutationId: String
}

type InstructorTimekit {
  intervals: [TimekitInterval]
}

# Item Price
type ItemPriceType {
  amount: Float
}

# Application Lang
type Lang implements Node {
  # The ID of an object
  id: ID!
  label: String
  value: String
}

type ListDef implements Node {
  # The ID of an object
  id: ID!
  type: String!
  value: String!
}

type Mutation {
  readNotification(input: ReadNotificationInput!): ReadNotificationPayload
  startExam(input: StartExamInput!): StartExamPayload
  submitExam(input: SubmitExamInput!): SubmitExamPayload
  submitAnswer(input: SubmitAnswerInput!): SubmitAnswerPayload
  getCurrentExamQuestionAnswer(input: GetCurrentExamQuestionAnswerInput!): GetCurrentExamQuestionAnswerPayload
  setCardQuestionAnswer(input: SubmitAnswerInput!): SubmitAnswerPayload
  setExamQuestionAnswer(input: SetExamQuestionAnswerInput!): SetExamQuestionAnswerPayload
  updateUserProfile(input: UpdateUserProfileInput!): UpdateUserProfilePayload
  updateUserUnitStatus(input: UpdateUserUnitStatusInput!): UpdateUserUnitStatusPayload
  updateUserCourseRole(input: UpdateUserCourseRoleInput!): UpdateUserCourseRolePayload
  setCardInteraction(input: SetCardInteractionInput!): SetCardInteractionPayload
  generateCourseBadge(input: GenerateCourseBadgeInput!): GenerateCourseBadgePayload
}

# NextQuestion
type NextQuestion {
  course_id: String
  section_id: String
  unit_id: String
}

# An object with an ID
interface Node {
  # The id of the object.
  id: ID!
}

type notificationPaging {
  notifications(orderBy: [OrderBy], filterValues: FilterValues, resolverArgs: [QueryResolverArgs], after: String, first: Int, before: String, last: Int): UserNotificationConnection
}

input OrderBy {
  field: String
  direction: OrderByDirection
}

enum OrderByDirection {
  DESC
  ASC
}

# Information about pagination in a connection.
type PageInfo {
  # When paginating forwards, are there more items?
  hasNextPage: Boolean!

  # When paginating backwards, are there more items?
  hasPreviousPage: Boolean!

  # When paginating backwards, the cursor to continue.
  startCursor: String

  # When paginating forwards, the cursor to continue.
  endCursor: String
}

type Query {
  # Fetches an object given its ID
  node(
    # The ID of an object
    id: ID!
  ): Node
  getDigitalDiplomaById(digital_diploma_id: String): DigitalDiploma
  getCourseById(course_id: String): Course
  courseById(course_id: String): Course

  # Course Unit
  courseUnit(course_id: String, unit_id: String): CourseUnit
  getCourseDeliverySchedule(course_id: String, delivery_method: String, date_on_or_after: DateTime): CourseDeliverySchedule
  courseDeliverySchedule(course_id: String, delivery_method: String, date_on_or_after: DateTime): CourseDeliverySchedule

  # SectionCard Entry
  cardEntry(course_id: ID!, unit_id: ID!, section_id: ID!, card_id: ID!): SectionCard

  # SectionCard Entry
  getCard(course_id: ID!, unit_id: ID!, section_id: ID!, card_id: ID!): SectionCard

  # Card Entry by question ID
  getCardByQuestion(question_id: String!): SectionCard
  topicFilter: [ListDef]
  getUserActivityCountByDate(dateRange: DateRange, activityTypes: [String]): [UserActivity]
  getUserProfile(user_id: String): User
  userProfile(user_id: String): User
  examToTake(unit_id: String, course_id: String): Exam
  examSession(unit_id: String): [ExamSession]

  # Activities
  listActivities(orderBy: [OrderBy], filterValues: FilterValues, resolverArgs: [QueryResolverArgs], activityTypes: [String], dateRange: DateRange, listDefVersion: Int, after: String, first: Int, before: String, last: Int): ActivityConnection

  # all Cards in the Section
  listCards(orderBy: [OrderBy], filterValues: FilterValues, resolverArgs: [QueryResolverArgs], after: String, first: Int, before: String, last: Int): SectionCardConnection

  # all Courses in the database
  coursePaging(orderBy: [OrderBy], filterValues: FilterValues, resolverArgs: [QueryResolverArgs], after: String, first: Int, before: String, last: Int): CourseConnection

  # all Courses in the database
  listCourses(orderBy: [OrderBy], filterValues: FilterValues, resolverArgs: [QueryResolverArgs], after: String, first: Int, before: String, last: Int): CourseConnection

  # Text Docs for Matching Course Items
  listTextMatchingCourseItems(searchText: String!, course_id: String, unit_id: String, section_id: String, orderBy: [OrderBy], filterValues: FilterValues, resolverArgs: [QueryResolverArgs], after: String, first: Int, before: String, last: Int): TextDocCourseItemConnection
  langType: [Lang]

  # Instructors
  listInstructors(orderBy: [OrderBy], filterValues: FilterValues, resolverArgs: [QueryResolverArgs], instructorTopics: [String], after: String, first: Int, before: String, last: Int): UserConnection

  # Notifications for the logged in user
  notificationPaging: notificationPaging

  # Question Entry
  getQuestionHint(orderBy: [OrderBy], filterValues: FilterValues, resolverArgs: [QueryResolverArgs], after: String, first: Int, before: String, last: Int): Question

  # Question Entry
  questionHint(orderBy: [OrderBy], filterValues: FilterValues, resolverArgs: [QueryResolverArgs], after: String, first: Int, before: String, last: Int): Question

  # all Sections in the Unit
  listSections(orderBy: [OrderBy], filterValues: FilterValues, resolverArgs: [QueryResolverArgs], after: String, first: Int, before: String, last: Int): UnitSectionConnection

  # all Units in the course
  unitPaging(orderBy: [OrderBy], filterValues: FilterValues, resolverArgs: [QueryResolverArgs], after: String, first: Int, before: String, last: Int): CourseUnitConnection

  # all Units in the course
  listUnits(orderBy: [OrderBy], filterValues: FilterValues, resolverArgs: [QueryResolverArgs], after: String, first: Int, before: String, last: Int): CourseUnitConnection

  # all DigitalDiplomas in the database
  listDigitalDiplomas(orderBy: [OrderBy], filterValues: FilterValues, resolverArgs: [QueryResolverArgs], after: String, first: Int, before: String, last: Int): DigitalDiplomaConnection

  # User exam status for Course
  userCourseUnitExamStatusPaging(orderBy: [OrderBy], filterValues: FilterValues, resolverArgs: [QueryResolverArgs], after: String, first: Int, before: String, last: Int): CourseUnitConnection
}

input QueryResolverArgs {
  param: String
  value: String
}

type Question implements Node {
  # The ID of an object
  id: ID!
  tags: [String]!
  points: Int
  est_time_sec: Int
  compl_level: Int
  question_type: String!
  question_text: String!
  data: QuestionData!
  question_answer: String
  hint: String
  hint_exists: Boolean

  # The ID of an object
  card_id: ID!
}

# Question data for several question types
type QuestionData implements Node {
  # The ID of an object
  id: ID!
  tmpl_files: String
  environment_key: String
  use_advanced_features: Boolean
  explanation: String
  src_files: String
  options: [QuestionMultipleData]
}

# Question data for the `multiple_choice_single` and `multiple_choice_many` question types
type QuestionMultipleData implements Node {
  # The ID of an object
  id: ID!
  seq: Int!
  explanation: String!
  is_answer: Boolean!
  text: String!
}

input ReadNotificationInput {
  notif_id: String!
  clientMutationId: String
}

type ReadNotificationPayload {
  completionObj: CompletionObj
  clientMutationId: String
}

# Scheduled Run Session Info
type ScheduledRunSessionInfoType implements Node {
  # The ID of an object
  id: ID!
  session_seq: Int
  headline: String
  desc: String
  session_notes: String
}

# Scheduled Run Session
type ScheduledRunSessionType implements Node {
  # The ID of an object
  id: ID!
  session_seq: Int
  session_start_date: DateTime
  _id: String
  session_run_notes: String
  instructors: [SessionInstructorType]
  session_duration: EventDuration
}

# Scheduled Run
type ScheduledRunType implements Node {
  # The ID of an object
  id: ID!
  run_start_date: DateTime
  _id: String
  offered_at_price: ItemPriceType
  run_sessions: [ScheduledRunSessionType]
  seat_purchased: Boolean
}

# Card of an EXLskills section
type SectionCard implements Node {
  # The ID of an object
  id: ID!
  index: Int
  title: String
  headline: String
  content_id: ID
  tags: [String]
  question_ids: [ID]
  ema: Float
  was_viewed: Boolean
  github_edit_url: String
  content: VersionedContentRecord
  question: Question
  questions: [Question]

  # The ID of an object
  currentCourseId: ID!

  # The ID of an object
  currentUnitId: ID!

  # The ID of an object
  currentSectionId: ID!
  updated_at: DateTime
}

# A connection to a list of items.
type SectionCardConnection {
  # Information to aid in pagination.
  pageInfo: PageInfo!

  # A list of edges.
  edges: [SectionCardEdge]
}

# An edge in a connection.
type SectionCardEdge {
  # The item at the end of the edge
  node: SectionCard

  # A cursor for use in pagination
  cursor: String!
}

# Session Instructor
type SessionInstructorType implements Node {
  # The ID of an object
  id: ID!
  _id: String
  full_name: String
  username: String
  avatar_url: String
  headline: String
  biography: String
}

input SetCardInteractionInput {
  course_id: ID!
  unit_id: ID!
  section_id: ID
  card_id: ID!
  interaction: String
  clientMutationId: String
}

type SetCardInteractionPayload {
  completionObj: CompletionObj
  clientMutationId: String
}

input SetExamQuestionAnswerInput {
  exam_session_id: ID!
  question_id: ID!
  response_data: String
  clientMutationId: String
}

type SetExamQuestionAnswerPayload {
  completionObj: CompletionObj
  clientMutationId: String
}

input StartExamInput {
  courseId: ID!
  unitId: ID!
  clientMutationId: String
}

type StartExamPayload {
  exam_session_id: String
  exam_time_limit: Float
  exam_id: String
  completionObj: CompletionObj
  clientMutationId: String
}

input SubmitAnswerInput {
  exam_attempt_id: ID
  question_id: ID!
  response_data: String
  checkAnswer: Boolean
  quiz: Boolean
  is_quiz_start: Boolean
  is_last_question: Boolean
  clientMutationId: String
}

type SubmitAnswerPayload {
  is_correct: Boolean
  explain_text: String
  grading_response: String
  completionObj: CompletionObj
  next_question: NextQuestion
  clientMutationId: String
}

input SubmitExamInput {
  exam_session_id: ID!
  clientMutationId: String
}

type SubmitExamPayload {
  final_grade_pct: Float
  pass_mark_pct: Int
  completionObj: CompletionObj
  clientMutationId: String
}

# A connection to a list of items.
type TextDocCourseItemConnection {
  # Information to aid in pagination.
  pageInfo: PageInfo!

  # A list of edges.
  edges: [TextDocCourseItemEdge]
}

# An edge in a connection.
type TextDocCourseItemEdge {
  # The item at the end of the edge
  node: TextDocMatchedCourseItem

  # A cursor for use in pagination
  cursor: String!
}

# EXLskills Text Doc for Matched Course Item
type TextDocMatchedCourseItem implements Node {
  # The ID of an object
  id: ID!
  score: Float
  itemType: CourseItem
  title: String
  headline: String
  highlights: CourseItemHighlight
  course_id: String
  unit_id: String
  section_id: String
  card_id: String
}

type TimekitInterval {
  credits: Float
  duration_seconds: Int
  project_id: String
}

# Section of an EXLskills unit
type UnitSection implements Node {
  # The ID of an object
  id: ID!
  index: Int
  title: String
  headline: String
  ema: Float
  cards_list: [SectionCard]

  # Section cards
  cards(orderBy: [OrderBy], filterValues: FilterValues, resolverArgs: [QueryResolverArgs], after: String, first: Int, before: String, last: Int): SectionCardConnection
}

# A connection to a list of items.
type UnitSectionConnection {
  # Information to aid in pagination.
  pageInfo: PageInfo!

  # A list of edges.
  edges: [UnitSectionEdge]
}

# An edge in a connection.
type UnitSectionEdge {
  # The item at the end of the edge
  node: UnitSection

  # A cursor for use in pagination
  cursor: String!
}

input UpdateUserCourseRoleInput {
  user_id: ID!
  course_id: ID!
  cudContent: [FieldCud]!
  clientMutationId: String
}

type UpdateUserCourseRolePayload {
  completionObj: CompletionObj
  clientMutationId: String
}

input UpdateUserProfileInput {
  locale: String
  profile: UserProfileInput
  clientMutationId: String
}

type UpdateUserProfilePayload {
  completionObj: CompletionObj
  clientMutationId: String
}

input UpdateUserUnitStatusInput {
  unit_id: String
  course_id: String
  clientMutationId: String
}

type UpdateUserUnitStatusPayload {
  completionObj: CompletionObj
  clientMutationId: String
}

# Application user
type User implements Node {
  # The ID of an object
  id: ID!
  full_name: String
  username: String
  primary_email: String
  pwd: String
  secondary_emails: [String]
  biography: String
  is_demo: Boolean
  is_instructor: Boolean
  headline: String
  has_completed_first_tutorial: Boolean
  instructor_topics_en: [String]
  instructor_topics_locale: [String]
  locales: [String]
  primary_locale: String!
  subscription: UserSubscriptionConnection
  avatar_url: String
  twitter_username: String
  linkedin_username: String
  location_name: String
  is_verified: Boolean
  auth_strategies(after: String, first: Int, before: String, last: Int): AuthStrategyConnection
  organization_roles(after: String, first: Int, before: String, last: Int): UserOrganizationRoleConnection
  instructor_timekit: InstructorTimekit
  course_roles(after: String, first: Int, before: String, last: Int): UserCourseRoleConnection
}

# Defines a user’s activity which are pre-calculated
type UserActivity {
  # The ID of an object
  id: ID!
  date: String!
  count: Int!
}

# A connection to a list of items.
type UserConnection {
  # Information to aid in pagination.
  pageInfo: PageInfo!

  # A list of edges.
  edges: [UserEdge]
}

# Defines a users role in a course
type UserCourseRole implements Node {
  # The ID of an object
  id: ID!
  course_id: ID!
  role: [String]!
  last_accessed_at: String
}

# A connection to a list of items.
type UserCourseRoleConnection {
  # Information to aid in pagination.
  pageInfo: PageInfo!

  # A list of edges.
  edges: [UserCourseRoleEdge]
}

# An edge in a connection.
type UserCourseRoleEdge {
  # The item at the end of the edge
  node: UserCourseRole

  # A cursor for use in pagination
  cursor: String!
}

# An edge in a connection.
type UserEdge {
  # The item at the end of the edge
  node: User

  # A cursor for use in pagination
  cursor: String!
}

# User notifications
type UserNotification implements Node {
  # The ID of an object
  id: ID!
  actor: String
  notification_link: String!
  def_id: String!
  is_read: Boolean!
  created_at: String!
  updated_at: String!
  content: String
}

# A connection to a list of items.
type UserNotificationConnection {
  # Information to aid in pagination.
  pageInfo: PageInfo!

  # A list of edges.
  edges: [UserNotificationEdge]
}

# An edge in a connection.
type UserNotificationEdge {
  # The item at the end of the edge
  node: UserNotification

  # A cursor for use in pagination
  cursor: String!
}

# Defines a users role in an organization
type UserOrganizationRole implements Node {
  # The ID of an object
  id: ID!
  organization_id: ID!
  role: String!
}

# A connection to a list of items.
type UserOrganizationRoleConnection {
  # Information to aid in pagination.
  pageInfo: PageInfo!

  # A list of edges.
  edges: [UserOrganizationRoleEdge]
}

# An edge in a connection.
type UserOrganizationRoleEdge {
  # The item at the end of the edge
  node: UserOrganizationRole

  # A cursor for use in pagination
  cursor: String!
}

# User profile field for update
input UserProfileInput {
  id: ID
  full_name: String
  username: String
  primary_email: String
  biography: String
  headline: String
  locales: [String]
  primary_locale: String
  avatar_url: String
  is_public: Boolean
  linkedin_username: String
  twitter_username: String
}

# The users subscription level. All users have this field -- they then vary by their level
type UserSubscription implements Node {
  # The ID of an object
  id: ID!
  level: Int!
}

# A connection to a list of items.
type UserSubscriptionConnection {
  # Information to aid in pagination.
  pageInfo: PageInfo!

  # A list of edges.
  edges: [UserSubscriptionEdge]
}

# An edge in a connection.
type UserSubscriptionEdge {
  # The item at the end of the edge
  node: UserSubscription

  # A cursor for use in pagination
  cursor: String!
}

# Object that matches a version number with an actual piece of content
type VersionedContentRecord implements Node {
  # The ID of an object
  id: ID!
  version: Int!
  content: String!
}