Class: WhopSDK::Models::CourseListResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/whop_sdk/models/course_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:, certificate_after_completion_enabled:, cover_image:, created_at:, description:, language:, order:, require_completing_lessons_in_order:, tagline:, thumbnail:, title:, updated_at:, visibility:) ⇒ Object

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

A structured learning module containing chapters and lessons, belonging to an experience.

Parameters:

  • id (String) —

    The unique identifier for the course.

  • certificate_after_completion_enabled (Boolean, nil) —

    Whether students receive a PDF certificate after completing all lessons in this

  • cover_image (String, nil) —

    The URL of the course cover image shown on preview cards. Null if no cover image

  • created_at (Time) —

    The datetime the course was created.

  • description (String, nil) —

    A brief summary of the course content and objectives. Null if no description has

  • language (Symbol, WhopSDK::Models::Languages) —

    The spoken language of the video content, used to generate accurate closed capti

  • order (String) —

    The sort position of this course within its parent experience, as a decimal for

  • require_completing_lessons_in_order (Boolean) —

    Whether students must complete each lesson sequentially before advancing to the

  • tagline (String, nil) —

    A short marketing tagline displayed beneath the course title. Null if no tagline

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

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

  • title (String, nil) —

    The display name of the course shown to students. Null if no title has been set.

  • updated_at (Time) —

    The datetime the course was last updated.

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

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




# File 'lib/whop_sdk/models/course_list_response.rb', line 95

Instance Attribute Details

#certificate_after_completion_enabled ⇒ Boolean?

Whether students receive a PDF certificate after completing all lessons in this course. Null if the setting has not been configured.

Returns:

  • (Boolean, nil) 


18
 
# File 'lib/whop_sdk/models/course_list_response.rb', line 18

required :certificate_after_completion_enabled, WhopSDK::Internal::Type::Boolean, nil?: true

#cover_image ⇒ String?

The URL of the course cover image shown on preview cards. Null if no cover image has been uploaded.

Returns:

  • (String, nil) 


25
 
# File 'lib/whop_sdk/models/course_list_response.rb', line 25

required :cover_image, String, nil?: true

#created_at ⇒ Time

The datetime the course was created.

Returns:

  • (Time) 


31
 
# File 'lib/whop_sdk/models/course_list_response.rb', line 31

required :created_at, Time

#description ⇒ String?

A brief summary of the course content and objectives. Null if no description has been set.

Returns:

  • (String, nil) 


38
 
# File 'lib/whop_sdk/models/course_list_response.rb', line 38

required :description, String, nil?: true

#id ⇒ String

The unique identifier for the course.

Returns:

  • (String) 


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

required :id, String

#language ⇒ Symbol, WhopSDK::Models::Languages

The spoken language of the video content, used to generate accurate closed captions. One of: en, es, it, pt, de, fr, pl, ru, nl, ca, tr, sv, uk, no, fi, sk, el, cs, hr, da, ro, bg.

Returns:



46
 
# File 'lib/whop_sdk/models/course_list_response.rb', line 46

required :language, enum: -> { WhopSDK::Languages }

#order ⇒ String

The sort position of this course within its parent experience, as a decimal for flexible ordering.

Returns:

  • (String) 


53
 
# File 'lib/whop_sdk/models/course_list_response.rb', line 53

required :order, String

#require_completing_lessons_in_order ⇒ Boolean

Whether students must complete each lesson sequentially before advancing to the next one.

Returns:

  • (Boolean) 


60
 
# File 'lib/whop_sdk/models/course_list_response.rb', line 60

required :require_completing_lessons_in_order, WhopSDK::Internal::Type::Boolean

#tagline ⇒ String?

A short marketing tagline displayed beneath the course title. Null if no tagline has been set.

Returns:

  • (String, nil) 


67
 
# File 'lib/whop_sdk/models/course_list_response.rb', line 67

required :tagline, String, nil?: true

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

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

Returns:



74
 
# File 'lib/whop_sdk/models/course_list_response.rb', line 74

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

#title ⇒ String?

The display name of the course shown to students. Null if no title has been set.

Returns:

  • (String, nil) 


80
 
# File 'lib/whop_sdk/models/course_list_response.rb', line 80

required :title, String, nil?: true

#updated_at ⇒ Time

The datetime the course was last updated.

Returns:

  • (Time) 


86
 
# File 'lib/whop_sdk/models/course_list_response.rb', line 86

required :updated_at, Time

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

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

Returns:



93
 
# File 'lib/whop_sdk/models/course_list_response.rb', line 93

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