Class: WhopSDK::Models::CourseStudentListResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/whop_sdk/models/course_student_list_response.rb

Overview

See Also:

Defined Under Namespace

Classes: User

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(id: , completed_lessons_count: , completion_rate: , first_interaction_at: , last_interaction_at: , total_lessons_count: , user: ) ⇒ Object

A course student (enrollment of a student in a course)

Parameters:

  • id (String) (defaults to: ) —

    The ID of the course student. Looks like crsi_XXX

  • completed_lessons_count (Integer) (defaults to: ) —

    The number of lessons the student has completed

  • completion_rate (Float) (defaults to: ) —

    The percentage of lessons completed (0-100)

  • first_interaction_at (Time) (defaults to: ) —

    When the student first interacted with the course

  • last_interaction_at (Time) (defaults to: ) —

    When the student last interacted with the course

  • total_lessons_count (Integer) (defaults to: ) —

    The total number of lessons the student has access to

  • user (WhopSDK::Models::CourseStudentListResponse::User) (defaults to: ) —

    The user who is enrolled in the course




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

Instance Attribute Details

#completed_lessons_count ⇒ Integer

The number of lessons the student has completed

Returns:

  • (Integer) 


17
 
# File 'lib/whop_sdk/models/course_student_list_response.rb', line 17

required :completed_lessons_count, Integer

#completion_rate ⇒ Float

The percentage of lessons completed (0-100)

Returns:

  • (Float) 


23
 
# File 'lib/whop_sdk/models/course_student_list_response.rb', line 23

required :completion_rate, Float

#first_interaction_at ⇒ Time

When the student first interacted with the course

Returns:

  • (Time) 


29
 
# File 'lib/whop_sdk/models/course_student_list_response.rb', line 29

required :first_interaction_at, Time

#id ⇒ String

The ID of the course student. Looks like crsi_XXX

Returns:

  • (String) 


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

required :id, String

#last_interaction_at ⇒ Time

When the student last interacted with the course

Returns:

  • (Time) 


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

required :last_interaction_at, Time

#total_lessons_count ⇒ Integer

The total number of lessons the student has access to

Returns:

  • (Integer) 


41
 
# File 'lib/whop_sdk/models/course_student_list_response.rb', line 41

required :total_lessons_count, Integer

#user ⇒ WhopSDK::Models::CourseStudentListResponse::User

The user who is enrolled in the course

Returns:



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

required :user, -> { WhopSDK::Models::CourseStudentListResponse::User }