Class: WhopSDK::Resources::CourseLessons

Inherits:

Object

• Object
• WhopSDK::Resources::CourseLessons

Defined in:

lib/whop_sdk/resources/course_lessons.rb

Instance Method Summary

• #create(chapter_id: , lesson_type: , content: nil, days_from_course_start_until_unlock: nil, embed_id: nil, embed_type: nil, thumbnail: nil, title: nil, request_options: {}) ⇒ WhopSDK::Models::Lesson

  Creates a new course lesson.

• #delete(id, request_options: {}) ⇒ Boolean

  Deletes a course lesson.

• #initialize(client:) ⇒ CourseLessons constructor private

  A new instance of CourseLessons.

• #list(after: nil, before: nil, chapter_id: nil, course_id: nil, first: nil, last: nil, request_options: {}) ⇒ WhopSDK::Internal::CursorPage<WhopSDK::Models::CourseLessonListResponse>

  Lists lessons for a course or chapter.

• #mark_as_completed(lesson_id, request_options: {}) ⇒ Boolean

  Marks a course lesson as completed.

• #retrieve(id, request_options: {}) ⇒ WhopSDK::Models::Lesson

  Retrieves a course lesson by ID.

• #start(lesson_id, request_options: {}) ⇒ Boolean

  Starts a course lesson.

• #submit_assessment(lesson_id, answers: , request_options: {}) ⇒ WhopSDK::Models::CourseLessonSubmitAssessmentResponse

  Submits answers for a course assessment.

• #update(id, assessment_completion_requirement: nil, assessment_questions: nil, attachments: nil, content: nil, days_from_course_start_until_unlock: nil, embed_id: nil, embed_type: nil, lesson_type: nil, main_pdf: nil, max_attempts: nil, mux_asset_id: nil, thumbnail: nil, title: nil, visibility: nil, request_options: {}) ⇒ WhopSDK::Models::Lesson

  Some parameter documentations has been truncated, see Models::CourseLessonUpdateParams for more details.

Constructor Details

#initialize(client:) ⇒ CourseLessons

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of CourseLessons.

Parameters:

• client (WhopSDK::Client)

# File 'lib/whop_sdk/resources/course_lessons.rb', line 255

def initialize(client:)
  @client = client
end

Instance Method Details

#create(chapter_id: , lesson_type: , content: nil, days_from_course_start_until_unlock: nil, embed_id: nil, embed_type: nil, thumbnail: nil, title: nil, request_options: {}) ⇒ WhopSDK::Models::Lesson

Creates a new course lesson

Required permissions:

• ‘courses:update`

Parameters:

• chapter_id (String) —

  The ID of the chapter to create the lesson in

• lesson_type (Symbol, WhopSDK::Models::LessonTypes) —

  The type of the lesson

• content (String, nil) —

  The content of the lesson

• days_from_course_start_until_unlock (Integer, nil) —

  Days from course start until unlock

• embed_id (String, nil) —

  ID for the embed (YouTube video ID or Loom share ID)

• embed_type (Symbol, WhopSDK::Models::EmbedType, nil) —

  The type of embed for a lesson

• thumbnail (WhopSDK::Models::CourseLessonCreateParams::Thumbnail::AttachmentInputWithDirectUploadID, WhopSDK::Models::CourseLessonCreateParams::Thumbnail::AttachmentInputWithID, nil) —

  The thumbnail for the lesson in png, jpeg, or gif format

• title (String, nil) —

  The title of the lesson

• request_options (WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (WhopSDK::Models::Lesson)

See Also:

• Models::CourseLessonCreateParams

# File 'lib/whop_sdk/resources/course_lessons.rb', line 35

def create(params)
  parsed, options = WhopSDK::CourseLessonCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "course_lessons",
    body: parsed,
    model: WhopSDK::Lesson,
    options: options
  )
end

#delete(id, request_options: {}) ⇒ Boolean

Deletes a course lesson

Required permissions:

• ‘courses:update`

Parameters:

• id (String) —

  The ID of the lesson to delete

• request_options (WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (Boolean)

See Also:

• Models::CourseLessonDeleteParams

# File 'lib/whop_sdk/resources/course_lessons.rb', line 179

def delete(id, params = {})
  @client.request(
    method: :delete,
    path: ["course_lessons/%1$s", id],
    model: WhopSDK::Internal::Type::Boolean,
    options: params[:request_options]
  )
end

#list(after: nil, before: nil, chapter_id: nil, course_id: nil, first: nil, last: nil, request_options: {}) ⇒ WhopSDK::Internal::CursorPage<WhopSDK::Models::CourseLessonListResponse>

Lists lessons for a course or chapter

Required permissions:

• ‘courses:read`

Parameters:

• after (String, nil) —

  Returns the elements in the list that come after the specified cursor.

• before (String, nil) —

  Returns the elements in the list that come before the specified cursor.

• chapter_id (String, nil) —

  The ID of the chapter (returns lessons only for this chapter)

• course_id (String, nil) —

  The ID of the course (returns all lessons across all chapters)

• first (Integer, nil) —

  Returns the first n elements from the list.

• last (Integer, nil) —

  Returns the last n elements from the list.

• request_options (WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (WhopSDK::Internal::CursorPage<WhopSDK::Models::CourseLessonListResponse>)

See Also:

• Models::CourseLessonListParams

# File 'lib/whop_sdk/resources/course_lessons.rb', line 152

def list(params = {})
  parsed, options = WhopSDK::CourseLessonListParams.dump_request(params)
  @client.request(
    method: :get,
    path: "course_lessons",
    query: parsed,
    page: WhopSDK::Internal::CursorPage,
    model: WhopSDK::Models::CourseLessonListResponse,
    options: options
  )
end

#mark_as_completed(lesson_id, request_options: {}) ⇒ Boolean

Marks a course lesson as completed

Parameters:

• lesson_id (String) —

  The ID of the lesson to mark as completed

• request_options (WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (Boolean)

See Also:

• Models::CourseLessonMarkAsCompletedParams

# File 'lib/whop_sdk/resources/course_lessons.rb', line 199

def mark_as_completed(lesson_id, params = {})
  @client.request(
    method: :post,
    path: ["course_lessons/%1$s/mark_as_completed", lesson_id],
    model: WhopSDK::Internal::Type::Boolean,
    options: params[:request_options]
  )
end

#retrieve(id, request_options: {}) ⇒ WhopSDK::Models::Lesson

Retrieves a course lesson by ID

Required permissions:

• ‘courses:read`

Parameters:

• id (String) —

  The ID of the lesson

• request_options (WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (WhopSDK::Models::Lesson)

See Also:

• Models::CourseLessonRetrieveParams

# File 'lib/whop_sdk/resources/course_lessons.rb', line 61

def retrieve(id, params = {})
  @client.request(
    method: :get,
    path: ["course_lessons/%1$s", id],
    model: WhopSDK::Lesson,
    options: params[:request_options]
  )
end

#start(lesson_id, request_options: {}) ⇒ Boolean

Starts a course lesson

Parameters:

• lesson_id (String) —

  The ID of the lesson being started

• request_options (WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (Boolean)

See Also:

• Models::CourseLessonStartParams

# File 'lib/whop_sdk/resources/course_lessons.rb', line 219

def start(lesson_id, params = {})
  @client.request(
    method: :post,
    path: ["course_lessons/%1$s/start", lesson_id],
    model: WhopSDK::Internal::Type::Boolean,
    options: params[:request_options]
  )
end

#submit_assessment(lesson_id, answers: , request_options: {}) ⇒ WhopSDK::Models::CourseLessonSubmitAssessmentResponse

Submits answers for a course assessment

Parameters:

• lesson_id (String) —

  The ID of the lesson (quiz or knowledge check) to submit answers for

• answers (Array<WhopSDK::Models::CourseLessonSubmitAssessmentParams::Answer>) —

  The answers to the assessment questions

• request_options (WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (WhopSDK::Models::CourseLessonSubmitAssessmentResponse)

See Also:

• Models::CourseLessonSubmitAssessmentParams

# File 'lib/whop_sdk/resources/course_lessons.rb', line 241

def submit_assessment(lesson_id, params)
  parsed, options = WhopSDK::CourseLessonSubmitAssessmentParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["course_lessons/%1$s/submit_assessment", lesson_id],
    body: parsed,
    model: WhopSDK::Models::CourseLessonSubmitAssessmentResponse,
    options: options
  )
end

#update(id, assessment_completion_requirement: nil, assessment_questions: nil, attachments: nil, content: nil, days_from_course_start_until_unlock: nil, embed_id: nil, embed_type: nil, lesson_type: nil, main_pdf: nil, max_attempts: nil, mux_asset_id: nil, thumbnail: nil, title: nil, visibility: nil, request_options: {}) ⇒ WhopSDK::Models::Lesson

Some parameter documentations has been truncated, see Models::CourseLessonUpdateParams for more details.

Updates a course lesson

Required permissions:

• ‘courses:update`

Parameters:

• id (String) —

  The ID of the lesson to update

• assessment_completion_requirement (WhopSDK::Models::CourseLessonUpdateParams::AssessmentCompletionRequirement, nil) —

  Completion requirements for quiz/knowledge check lessons

• assessment_questions (Array<WhopSDK::Models::CourseLessonUpdateParams::AssessmentQuestion>, nil) —

  Assessment questions for quiz/knowledge check lessons. Replaces all existing que

• attachments (Array<WhopSDK::Models::CourseLessonUpdateParams::Attachment::AttachmentInputWithDirectUploadID, WhopSDK::Models::CourseLessonUpdateParams::Attachment::AttachmentInputWithID>, nil) —

  General attachments for the lesson (PDFs, files, etc). Replaces all existing att

• content (String, nil) —

  The content of the lesson

• days_from_course_start_until_unlock (Integer, nil) —

  Days from course start until unlock

• embed_id (String, nil) —

  ID for the embed (YouTube video ID or Loom share ID)

• embed_type (Symbol, WhopSDK::Models::EmbedType, nil) —

  The type of embed for a lesson

• lesson_type (Symbol, WhopSDK::Models::LessonTypes, nil) —

  The available types for a lesson

• main_pdf (WhopSDK::Models::CourseLessonUpdateParams::MainPdf::AttachmentInputWithDirectUploadID, WhopSDK::Models::CourseLessonUpdateParams::MainPdf::AttachmentInputWithID, nil) —

  The main PDF file for this lesson

• max_attempts (Integer, nil) —

  Maximum number of attempts allowed for assessments

• mux_asset_id (String, nil) —

  The ID of the Mux asset to attach to this lesson for video lessons

• thumbnail (WhopSDK::Models::CourseLessonUpdateParams::Thumbnail::AttachmentInputWithDirectUploadID, WhopSDK::Models::CourseLessonUpdateParams::Thumbnail::AttachmentInputWithID, nil) —

  The thumbnail for the lesson in png, jpeg, or gif format

• title (String, nil) —

  The title of the lesson

• visibility (Symbol, WhopSDK::Models::LessonVisibilities, nil) —

  The available visibilities for a lesson. Determines how / whether a lesson is vi

• request_options (WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (WhopSDK::Models::Lesson)

See Also:

• Models::CourseLessonUpdateParams

# File 'lib/whop_sdk/resources/course_lessons.rb', line 116

def update(id, params = {})
  parsed, options = WhopSDK::CourseLessonUpdateParams.dump_request(params)
  @client.request(
    method: :patch,
    path: ["course_lessons/%1$s", id],
    body: parsed,
    model: WhopSDK::Lesson,
    options: options
  )
end