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 course from the courses app

Parameters:

  • id (String) (defaults to: ) —

    The ID of the course. Looks like cors_XXX

  • certificate_after_completion_enabled (Boolean, nil) (defaults to: ) —

    Whether the course will award its students a PDF certificate after completing al

  • cover_image (String, nil) (defaults to: ) —

    The URL of the course’s cover image, which is shown in course preview cards

  • created_at (Time) (defaults to: ) —

    The timestamp of when the course was created

  • description (String, nil) (defaults to: ) —

    A short description of the course

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

    The language spoken in the video content of the course, used to generate closed

  • order (String) (defaults to: ) —

    The order of the course within its experience

  • require_completing_lessons_in_order (Boolean) (defaults to: ) —

    Whether the course requires students to complete the previous lesson before movi

  • tagline (String, nil) (defaults to: ) —

    A short tagline for the course. It is displayed under the course title in the UI

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

    The thumbnail for the course

  • title (String, nil) (defaults to: ) —

    The title of the course

  • updated_at (Time) (defaults to: ) —

    The timestamp of when the course was last updated

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

    The visibility of the course. Determines how / whether this course is visible to




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

Instance Attribute Details

#certificate_after_completion_enabled ⇒ Boolean?

Whether the course will award its students a PDF certificate after completing all lessons

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’s cover image, which is shown in course preview cards

Returns:

  • (String, nil) 


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

required :cover_image, String, nil?: true

#created_at ⇒ Time

The timestamp of when the course was created

Returns:

  • (Time) 


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

required :created_at, Time

#description ⇒ String?

A short description of the course

Returns:

  • (String, nil) 


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

required :description, String, nil?: true

#id ⇒ String

The ID of the course. Looks like cors_XXX

Returns:

  • (String) 


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

required :id, String

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

The language spoken in the video content of the course, used to generate closed captions in the right language

Returns:



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

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

#order ⇒ String

The order of the course within its experience

Returns:

  • (String) 


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

required :order, String

#require_completing_lessons_in_order ⇒ Boolean

Whether the course requires students to complete the previous lesson before moving on to the next one

Returns:

  • (Boolean) 


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

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

#tagline ⇒ String?

A short tagline for the course. It is displayed under the course title in the UI

Returns:

  • (String, nil) 


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

required :tagline, String, nil?: true

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

The thumbnail for the course

Returns:



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

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

#title ⇒ String?

The title of the course

Returns:

  • (String, nil) 


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

required :title, String, nil?: true

#updated_at ⇒ Time

The timestamp of when the course was last updated

Returns:

  • (Time) 


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

required :updated_at, Time

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

The visibility of the course. Determines how / whether this course is visible to users.

Returns:



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

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