Class: WhopSDK::Models::CourseLessonCreateParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/whop_sdk/models/course_lesson_create_params.rb

Overview

See Also:

• Resources::CourseLessons#create

Defined Under Namespace

Modules: Thumbnail

Instance Attribute Summary

• #chapter_id ⇒ String

  The ID of the chapter to create the lesson in.

• #content ⇒ String^?

  The content of the lesson.

• #days_from_course_start_until_unlock ⇒ Integer^?

  Days from course start until unlock.

• #embed_id ⇒ String^?

  ID for the embed (YouTube video ID or Loom share ID).

• #embed_type ⇒ Symbol, ...

  The type of embed for a lesson.

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

  The type of the lesson.

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

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

• #title ⇒ String^?

  The title of the lesson.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(chapter_id: , lesson_type: , content: nil, days_from_course_start_until_unlock: nil, embed_id: nil, embed_type: nil, thumbnail: nil, title: nil, request_options: {}) ⇒ Object constructor

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(chapter_id: , lesson_type: , content: nil, days_from_course_start_until_unlock: nil, embed_id: nil, embed_type: nil, thumbnail: nil, title: nil, request_options: {}) ⇒ Object

Parameters:

• chapter_id (String) (defaults to: ) —

  The ID of the chapter to create the lesson in

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

  The type of the lesson

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

  The content of the lesson

• days_from_course_start_until_unlock (Integer, nil) (defaults to: nil) —

  Days from course start until unlock

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

  ID for the embed (YouTube video ID or Loom share ID)

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

  The type of embed for a lesson

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

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

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

  The title of the lesson

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

# File 'lib/whop_sdk/models/course_lesson_create_params.rb', line 58

Instance Attribute Details

#chapter_id ⇒ String

The ID of the chapter to create the lesson in

Returns:

• (String)

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

required :chapter_id, String

#content ⇒ String^?

The content of the lesson

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/course_lesson_create_params.rb', line 26

optional :content, String, nil?: true

#days_from_course_start_until_unlock ⇒ Integer^?

Days from course start until unlock

Returns:

• (Integer, nil)

# File 'lib/whop_sdk/models/course_lesson_create_params.rb', line 32

optional :days_from_course_start_until_unlock, Integer, nil?: true

#embed_id ⇒ String^?

ID for the embed (YouTube video ID or Loom share ID)

Returns:

• (String, nil)

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

optional :embed_id, String, nil?: true

#embed_type ⇒ Symbol, ...

The type of embed for a lesson

Returns:

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

# File 'lib/whop_sdk/models/course_lesson_create_params.rb', line 44

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

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

The type of the lesson

Returns:

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

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

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

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

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

Returns:

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

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

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

#title ⇒ String^?

The title of the lesson

Returns:

• (String, nil)

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

optional :title, String, nil?: true