Class: WhopSDK::Models::CourseCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/whop_sdk/models/course_create_params.rb

Overview

See Also:

Defined Under Namespace

Classes: Thumbnail

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Method Summary

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, #initialize, 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

This class inherits a constructor from WhopSDK::Internal::Type::BaseModel

Instance Attribute Details

#certificate_after_completion_enabled ⇒ Boolean?

Whether the course awards students a PDF certificate after completing all lessons.

Returns:

  • (Boolean, nil) 


28
 
# File 'lib/whop_sdk/models/course_create_params.rb', line 28

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

#experience_id ⇒ String

The unique identifier of the experience to create the course in (e.g., “exp_XXXXX”).

Returns:

  • (String) 


15
 
# File 'lib/whop_sdk/models/course_create_params.rb', line 15

required :experience_id, String

#order ⇒ String?

The decimal order position of the course within its experience. Use fractional values (e.g., “1.5”) to place between existing courses.

Returns:

  • (String, nil) 


35
 
# File 'lib/whop_sdk/models/course_create_params.rb', line 35

optional :order, String, nil?: true

#require_completing_lessons_in_order ⇒ Boolean?

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

Returns:

  • (Boolean, nil) 


42
 
# File 'lib/whop_sdk/models/course_create_params.rb', line 42

optional :require_completing_lessons_in_order, WhopSDK::Internal::Type::Boolean, nil?: true

#tagline ⇒ String?

A short tagline displayed beneath the course title (e.g., “Master the fundamentals of design”).

Returns:

  • (String, nil) 


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

optional :tagline, String, nil?: true

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

The thumbnail image for the course in PNG, JPEG, or GIF format.

Returns:



55
 
# File 'lib/whop_sdk/models/course_create_params.rb', line 55

optional :thumbnail, -> { WhopSDK::CourseCreateParams::Thumbnail }, nil?: true

#title ⇒ String

The display title of the course (e.g., “Introduction to Web Development”).

Returns:

  • (String) 


21
 
# File 'lib/whop_sdk/models/course_create_params.rb', line 21

required :title, String

#visibility ⇒ Symbol, ...

The available visibilities for a course. Determines how / whether a course is visible to users.

Returns:



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

optional :visibility, enum: -> { WhopSDK::CourseVisibilities }, nil?: true