Class: WhopSDK::Models::CourseUpdateParams

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

Overview

See Also:

  • WhopSDK::Resources::Courses#update

Defined Under Namespace

Classes: Chapter, Thumbnail

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

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(id:, chapter_id:, order:, title:) ⇒ Object

Input for updating a lesson while updating a course

Parameters:

  • id (String) —

    The ID of the lesson to update

  • chapter_id (String) —

    The ID of the chapter this lesson belongs to (for moving between chapters)

  • order (Integer) —

    The order of the lesson within its chapter

  • title (String) —

    The title of the lesson




# File 'lib/whop_sdk/models/course_update_params.rb', line 173

Instance Attribute Details

#certificate_after_completion_enabled ⇒ Boolean?

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

Parameters:

  • value (Boolean, nil)

Returns:

  • (Boolean, nil) 


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

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

#chapters ⇒ Array<WhopSDK::Models::CourseUpdateParams::Chapter>?

A list of chapters with nested lessons to reorder or rename in bulk.

Parameters:

  • value (::Array[WhopSDK::CourseUpdateParams::Chapter], nil)

Returns:



26
27
28
 
# File 'lib/whop_sdk/models/course_update_params.rb', line 26

optional :chapters,
-> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::CourseUpdateParams::Chapter] },
nil?: true

#description ⇒ String?

A short description of the course displayed to students on the course page.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


34
 
# File 'lib/whop_sdk/models/course_update_params.rb', line 34

optional :description, String, nil?: true

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


13
 
# File 'lib/whop_sdk/models/course_update_params.rb', line 13

required :id, String

#language ⇒ Symbol, ...

The available languages for a course

Parameters:

  • value (WhopSDK::Models::languages, nil)

Returns:



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

optional :language, enum: -> { WhopSDK::Languages }, nil?: true

#order ⇒ String?

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

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


47
 
# File 'lib/whop_sdk/models/course_update_params.rb', line 47

optional :order, String, nil?: true

#require_completing_lessons_in_order ⇒ Boolean?

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

Parameters:

  • value (Boolean, nil)

Returns:

  • (Boolean, nil) 


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

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").

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


61
 
# File 'lib/whop_sdk/models/course_update_params.rb', line 61

optional :tagline, String, nil?: true

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

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

Parameters:

  • value (WhopSDK::CourseUpdateParams::Thumbnail, nil)

Returns:



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

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

#title ⇒ String?

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

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


73
 
# File 'lib/whop_sdk/models/course_update_params.rb', line 73

optional :title, String, nil?: true

#visibility ⇒ Symbol, ...

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

Parameters:

  • value (WhopSDK::Models::course_visibilities, nil)

Returns:



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

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

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


60
 
# File 'sig/whop_sdk/models/course_update_params.rbs', line 60

def to_hash: -> {