Class: WhopSDK::Models::CourseLessonListResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/whop_sdk/models/course_lesson_list_response.rb

Overview

See Also:

Defined Under Namespace

Classes: Thumbnail

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(id:, content:, created_at:, days_from_course_start_until_unlock:, embed_id:, embed_type:, lesson_type:, order:, thumbnail:, title:, visibility:) ⇒ Object

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

An individual learning unit within a chapter, which can contain text, video, PDF, or assessment content.

Parameters:

  • id (String) —

    The unique identifier for the lesson.

  • content (String, nil) —

    The Markdown content body of the lesson. Null if the lesson has no text content.

  • created_at (Time) —

    The datetime the lesson was created.

  • days_from_course_start_until_unlock (Integer, nil) —

    The number of days after a student starts the course before this lesson becomes

  • embed_id (String, nil) —

    The external video identifier for embedded video lessons, such as a YouTube vide

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

    The type of embed for a lesson

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

    The content format of this lesson. One of: text, video, pdf, multi, quiz, knowle

  • order (Integer) —

    The sort position of this lesson within its parent chapter, starting from zero.

  • thumbnail (WhopSDK::Models::CourseLessonListResponse::Thumbnail, nil) —

    The thumbnail image displayed on lesson cards and previews. Null if no thumbnail

  • title (String) —

    The display name of the lesson shown to students. Maximum 120 characters.

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

    The visibility setting that controls whether this lesson appears to students. On




# File 'lib/whop_sdk/models/course_lesson_list_response.rb', line 78

Instance Attribute Details

#content ⇒ String?

The Markdown content body of the lesson. Null if the lesson has no text content.

Returns:

  • (String, nil) 


17
 
# File 'lib/whop_sdk/models/course_lesson_list_response.rb', line 17

required :content, String, nil?: true

#created_at ⇒ Time

The datetime the lesson was created.

Returns:

  • (Time) 


23
 
# File 'lib/whop_sdk/models/course_lesson_list_response.rb', line 23

required :created_at, Time

#days_from_course_start_until_unlock ⇒ Integer?

The number of days after a student starts the course before this lesson becomes accessible. Null if the lesson is available immediately.

Returns:

  • (Integer, nil) 


30
 
# File 'lib/whop_sdk/models/course_lesson_list_response.rb', line 30

required :days_from_course_start_until_unlock, Integer, nil?: true

#embed_id ⇒ String?

The external video identifier for embedded video lessons, such as a YouTube video ID or Loom share ID. Null if the lesson has no embed.

Returns:

  • (String, nil) 


37
 
# File 'lib/whop_sdk/models/course_lesson_list_response.rb', line 37

required :embed_id, String, nil?: true

#embed_type ⇒ Symbol, ...

The type of embed for a lesson

Returns:



43
 
# File 'lib/whop_sdk/models/course_lesson_list_response.rb', line 43

required :embed_type, enum: -> { WhopSDK::EmbedType }, nil?: true

#id ⇒ String

The unique identifier for the lesson.

Returns:

  • (String) 


11
 
# File 'lib/whop_sdk/models/course_lesson_list_response.rb', line 11

required :id, String

#lesson_type ⇒ Symbol, WhopSDK::Models::LessonTypes

The content format of this lesson. One of: text, video, pdf, multi, quiz, knowledge_check.

Returns:



50
 
# File 'lib/whop_sdk/models/course_lesson_list_response.rb', line 50

required :lesson_type, enum: -> { WhopSDK::LessonTypes }

#order ⇒ Integer

The sort position of this lesson within its parent chapter, starting from zero.

Returns:

  • (Integer) 


56
 
# File 'lib/whop_sdk/models/course_lesson_list_response.rb', line 56

required :order, Integer

#thumbnail ⇒ WhopSDK::Models::CourseLessonListResponse::Thumbnail?

The thumbnail image displayed on lesson cards and previews. Null if no thumbnail has been uploaded.

Returns:



63
 
# File 'lib/whop_sdk/models/course_lesson_list_response.rb', line 63

required :thumbnail, -> { WhopSDK::Models::CourseLessonListResponse::Thumbnail }, nil?: true

#title ⇒ String

The display name of the lesson shown to students. Maximum 120 characters.

Returns:

  • (String) 


69
 
# File 'lib/whop_sdk/models/course_lesson_list_response.rb', line 69

required :title, String

#visibility ⇒ Symbol, WhopSDK::Models::LessonVisibilities

The visibility setting that controls whether this lesson appears to students. One of: visible, hidden.

Returns:



76
 
# File 'lib/whop_sdk/models/course_lesson_list_response.rb', line 76

required :visibility, enum: -> { WhopSDK::LessonVisibilities }