Class: WhopSDK::Models::CourseCreateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• WhopSDK::Models::CourseCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/whop_sdk/models/course_create_params.rb

Overview

See Also:

• Resources::Courses#create

Defined Under Namespace

Modules: Thumbnail

Instance Attribute Summary

• #certificate_after_completion_enabled ⇒ Boolean^?

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

• #cover_image ⇒ String^?

  The cover image URL of the course.

• #experience_id ⇒ String

  The ID of the experience to create the course in.

• #require_completing_lessons_in_order ⇒ Boolean^?

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

• #tagline ⇒ String^?

  The tagline of the course.

• #thumbnail ⇒ WhopSDK::Models::CourseCreateParams::Thumbnail::AttachmentInputWithDirectUploadID, ...

  The thumbnail for the course in png, jpeg, or gif format.

• #title ⇒ String

  The title of the course.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(experience_id: , title: , certificate_after_completion_enabled: nil, cover_image: nil, require_completing_lessons_in_order: nil, tagline: nil, thumbnail: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see CourseCreateParams for more details.

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, 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(experience_id: , title: , certificate_after_completion_enabled: nil, cover_image: nil, require_completing_lessons_in_order: nil, tagline: nil, thumbnail: nil, request_options: {}) ⇒ Object

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

Parameters:

• experience_id (String) (defaults to: ) —

  The ID of the experience to create the course in

• title (String) (defaults to: ) —

  The title of the course

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

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

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

  The cover image URL of the course

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

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

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

  The tagline of the course

• thumbnail (WhopSDK::Models::CourseCreateParams::Thumbnail::AttachmentInputWithDirectUploadID, WhopSDK::Models::CourseCreateParams::Thumbnail::AttachmentInputWithID, nil) (defaults to: nil) —

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

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

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

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)

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

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

#cover_image ⇒ String^?

The cover image URL of the course

Returns:

• (String, nil)

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

optional :cover_image, String, nil?: true

#experience_id ⇒ String

The ID of the experience to create the course in

Returns:

• (String)

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

required :experience_id, 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, nil)

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

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

#tagline ⇒ String^?

The tagline of the course

Returns:

• (String, nil)

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

optional :tagline, String, nil?: true

#thumbnail ⇒ WhopSDK::Models::CourseCreateParams::Thumbnail::AttachmentInputWithDirectUploadID, ...

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

Returns:

• (WhopSDK::Models::CourseCreateParams::Thumbnail::AttachmentInputWithDirectUploadID, WhopSDK::Models::CourseCreateParams::Thumbnail::AttachmentInputWithID, nil)

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

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

#title ⇒ String

The title of the course

Returns:

• (String)

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

required :title, String