Cyphi.Course (Cyphi v0.1.0)

Provides struct and types for a Course

Summary

Types

t()

@type t() :: %Cyphi.Course{
  access_code: String.t() | nil,
  allow_reenrollment: boolean() | nil,
  allow_unenrollment: boolean() | nil,
  archived: boolean() | nil,
  archived_at: DateTime.t() | nil,
  archiver_id: integer() | nil,
  auto_complete_on_visit: boolean() | nil,
  auto_enroll_from_waitlist: boolean() | nil,
  catalog_categories: [String.t()] | nil,
  class_times: [map()] | nil,
  course_code: String.t() | nil,
  credits: number() | nil,
  current_module_id: integer() | nil,
  custom_fields: map() | nil,
  delete_history_on_unenroll: boolean() | nil,
  disable_completion: boolean() | nil,
  display_in_catalog: boolean() | nil,
  enrollment_open: boolean() | nil,
  finish_at: Date.t() | nil,
  id: integer() | nil,
  locked: boolean() | nil,
  long_description: String.t() | nil,
  max_seats: integer() | nil,
  max_students: integer() | nil,
  metadata: Cyphi.CourseMetadata.t() | nil,
  must_repurchase_to_reenroll: boolean() | nil,
  name: String.t() | nil,
  open_enrollment: boolean() | nil,
  organization_id: integer() | nil,
  organization_name: String.t() | nil,
  parent_id: integer() | nil,
  path: boolean() | nil,
  picture: String.t() | nil,
  price: number() | nil,
  private: boolean() | nil,
  section_code: String.t() | nil,
  short_description: String.t() | nil,
  sis_id: String.t() | nil,
  sis_pid: String.t() | nil,
  start_at: Date.t() | nil,
  style: String.t() | nil,
  tags: [String.t()] | nil,
  tax_exempt: boolean() | nil,
  time_zone: String.t() | nil,
  used_seats: String.t() | nil,
  waitlist_after_limit: boolean() | nil,
  weight_using_categories: boolean() | nil,
  weights: String.t() | nil
}