Class: WhopSDK::Models::CourseChapter

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/whop_sdk/models/course_chapter.rb,
sig/whop_sdk/models/course_chapter.rbs

Overview

See Also:

  • WhopSDK::Resources::CourseChapters#create

Defined Under Namespace

Classes: Lesson

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 ⇒ Object 



20
 
# File 'sig/whop_sdk/models/course_chapter.rbs', line 20

def initialize: (

Instance Attribute Details

#id ⇒ String

The unique identifier for the chapter.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :id, String

#lessons ⇒ Array<WhopSDK::Models::CourseChapter::Lesson>

An ordered list of lessons in this chapter, sorted by display position. Hidden lessons are excluded for non-admin users.

Parameters:

  • value (::Array[WhopSDK::CourseChapter::Lesson])

Returns:



18
 
# File 'lib/whop_sdk/models/course_chapter.rb', line 18

required :lessons, -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::CourseChapter::Lesson] }

#order ⇒ Integer

The sort position of this chapter within its parent course, starting from zero.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


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

required :order, Integer

#title ⇒ String

The display name of the chapter shown to students. Maximum 150 characters.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :title, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


27
 
# File 'sig/whop_sdk/models/course_chapter.rbs', line 27

def to_hash: -> {