whop_sdk 0.0.3 → 0.0.5

data/rbi/whop_sdk/models/course_list_response.rbi

@@ -30,6 +30,10 @@ module WhopSDK
       sig { returns(WhopSDK::Languages::TaggedSymbol) }
       attr_accessor :language
 
+      # The order of the course within its experience
+      sig { returns(String) }
+      attr_accessor :order
+
       # Whether the course requires students to complete the previous lesson before
       # moving on to the next one
       sig { returns(T::Boolean) }
@@ -59,6 +63,11 @@ module WhopSDK
       sig { returns(Time) }
       attr_accessor :updated_at
 
+      # The visibility of the course. Determines how / whether this course is visible to
+      # users.
+      sig { returns(WhopSDK::CourseVisibilities::TaggedSymbol) }
+      attr_accessor :visibility
+
       # A course from the courses app
       sig do
         params(
@@ -67,12 +76,14 @@ module WhopSDK
           created_at: Time,
           description: T.nilable(String),
           language: WhopSDK::Languages::OrSymbol,
+          order: String,
           require_completing_lessons_in_order: T::Boolean,
           tagline: T.nilable(String),
           thumbnail:
             T.nilable(WhopSDK::Models::CourseListResponse::Thumbnail::OrHash),
           title: T.nilable(String),
-          updated_at: Time
+          updated_at: Time,
+          visibility: WhopSDK::CourseVisibilities::OrSymbol
         ).returns(T.attached_class)
       end
       def self.new(
@@ -88,6 +99,8 @@ module WhopSDK
         # The language spoken in the video content of the course, used to generate closed
         # captions in the right language
         language:,
+        # The order of the course within its experience
+        order:,
         # Whether the course requires students to complete the previous lesson before
         # moving on to the next one
         require_completing_lessons_in_order:,
@@ -98,7 +111,10 @@ module WhopSDK
         # The title of the course
         title:,
         # The timestamp of when the course was last updated
-        updated_at:
+        updated_at:,
+        # The visibility of the course. Determines how / whether this course is visible to
+        # users.
+        visibility:
       )
       end
 
@@ -110,12 +126,14 @@ module WhopSDK
             created_at: Time,
             description: T.nilable(String),
             language: WhopSDK::Languages::TaggedSymbol,
+            order: String,
             require_completing_lessons_in_order: T::Boolean,
             tagline: T.nilable(String),
             thumbnail:
               T.nilable(WhopSDK::Models::CourseListResponse::Thumbnail),
             title: T.nilable(String),
-            updated_at: Time
+            updated_at: Time,
+            visibility: WhopSDK::CourseVisibilities::TaggedSymbol
           }
         )
       end

data/rbi/whop_sdk/models/course_student_list_params.rbi

@@ -0,0 +1,83 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class CourseStudentListParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::CourseStudentListParams, WhopSDK::Internal::AnyHash)
+        end
+
+      # The ID of the course
+      sig { returns(String) }
+      attr_accessor :course_id
+
+      # Returns the elements in the list that come after the specified cursor.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :after
+
+      # Returns the elements in the list that come before the specified cursor.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :before
+
+      # Returns the first _n_ elements from the list.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :first
+
+      # Filter students by name - returns students whose names match the keyword
+      sig { returns(T.nilable(String)) }
+      attr_accessor :keyword
+
+      # Returns the last _n_ elements from the list.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :last
+
+      sig do
+        params(
+          course_id: String,
+          after: T.nilable(String),
+          before: T.nilable(String),
+          first: T.nilable(Integer),
+          keyword: T.nilable(String),
+          last: T.nilable(Integer),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID of the course
+        course_id:,
+        # Returns the elements in the list that come after the specified cursor.
+        after: nil,
+        # Returns the elements in the list that come before the specified cursor.
+        before: nil,
+        # Returns the first _n_ elements from the list.
+        first: nil,
+        # Filter students by name - returns students whose names match the keyword
+        keyword: nil,
+        # Returns the last _n_ elements from the list.
+        last: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            course_id: String,
+            after: T.nilable(String),
+            before: T.nilable(String),
+            first: T.nilable(Integer),
+            keyword: T.nilable(String),
+            last: T.nilable(Integer),
+            request_options: WhopSDK::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/course_student_list_response.rbi

@@ -0,0 +1,142 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class CourseStudentListResponse < WhopSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            WhopSDK::Models::CourseStudentListResponse,
+            WhopSDK::Internal::AnyHash
+          )
+        end
+
+      # The ID of the course student. Looks like crsi_XXX
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The number of lessons the student has completed
+      sig { returns(Integer) }
+      attr_accessor :completed_lessons_count
+
+      # The percentage of lessons completed (0-100)
+      sig { returns(Float) }
+      attr_accessor :completion_rate
+
+      # When the student first interacted with the course
+      sig { returns(Time) }
+      attr_accessor :first_interaction_at
+
+      # When the student last interacted with the course
+      sig { returns(Time) }
+      attr_accessor :last_interaction_at
+
+      # The total number of lessons the student has access to
+      sig { returns(Integer) }
+      attr_accessor :total_lessons_count
+
+      # The user who is enrolled in the course
+      sig { returns(WhopSDK::Models::CourseStudentListResponse::User) }
+      attr_reader :user
+
+      sig do
+        params(
+          user: WhopSDK::Models::CourseStudentListResponse::User::OrHash
+        ).void
+      end
+      attr_writer :user
+
+      # A course student (enrollment of a student in a course)
+      sig do
+        params(
+          id: String,
+          completed_lessons_count: Integer,
+          completion_rate: Float,
+          first_interaction_at: Time,
+          last_interaction_at: Time,
+          total_lessons_count: Integer,
+          user: WhopSDK::Models::CourseStudentListResponse::User::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID of the course student. Looks like crsi_XXX
+        id:,
+        # The number of lessons the student has completed
+        completed_lessons_count:,
+        # The percentage of lessons completed (0-100)
+        completion_rate:,
+        # When the student first interacted with the course
+        first_interaction_at:,
+        # When the student last interacted with the course
+        last_interaction_at:,
+        # The total number of lessons the student has access to
+        total_lessons_count:,
+        # The user who is enrolled in the course
+        user:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            completed_lessons_count: Integer,
+            completion_rate: Float,
+            first_interaction_at: Time,
+            last_interaction_at: Time,
+            total_lessons_count: Integer,
+            user: WhopSDK::Models::CourseStudentListResponse::User
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class User < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              WhopSDK::Models::CourseStudentListResponse::User,
+              WhopSDK::Internal::AnyHash
+            )
+          end
+
+        # The internal ID of the user.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The name of the user from their Whop account.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :name
+
+        # The username of the user from their Whop account.
+        sig { returns(String) }
+        attr_accessor :username
+
+        # The user who is enrolled in the course
+        sig do
+          params(id: String, name: T.nilable(String), username: String).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # The internal ID of the user.
+          id:,
+          # The name of the user from their Whop account.
+          name:,
+          # The username of the user from their Whop account.
+          username:
+        )
+        end
+
+        sig do
+          override.returns(
+            { id: String, name: T.nilable(String), username: String }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/course_student_retrieve_params.rbi

@@ -0,0 +1,30 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class CourseStudentRetrieveParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            WhopSDK::CourseStudentRetrieveParams,
+            WhopSDK::Internal::AnyHash
+          )
+        end
+
+      sig do
+        params(request_options: WhopSDK::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({ request_options: WhopSDK::RequestOptions }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/course_student_retrieve_response.rbi

@@ -0,0 +1,250 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class CourseStudentRetrieveResponse < WhopSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            WhopSDK::Models::CourseStudentRetrieveResponse,
+            WhopSDK::Internal::AnyHash
+          )
+        end
+
+      # The ID of the course student. Looks like crsi_XXX
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The number of lessons the student has completed
+      sig { returns(Integer) }
+      attr_accessor :completed_lessons_count
+
+      # The percentage of lessons completed (0-100)
+      sig { returns(Float) }
+      attr_accessor :completion_rate
+
+      # The course the student is enrolled in
+      sig { returns(WhopSDK::Models::CourseStudentRetrieveResponse::Course) }
+      attr_reader :course
+
+      sig do
+        params(
+          course: WhopSDK::Models::CourseStudentRetrieveResponse::Course::OrHash
+        ).void
+      end
+      attr_writer :course
+
+      # When the student first interacted with the course
+      sig { returns(Time) }
+      attr_accessor :first_interaction_at
+
+      # When the student last interacted with the course
+      sig { returns(Time) }
+      attr_accessor :last_interaction_at
+
+      # The total number of lessons the student has access to
+      sig { returns(Integer) }
+      attr_accessor :total_lessons_count
+
+      # The user who is enrolled in the course
+      sig { returns(WhopSDK::Models::CourseStudentRetrieveResponse::User) }
+      attr_reader :user
+
+      sig do
+        params(
+          user: WhopSDK::Models::CourseStudentRetrieveResponse::User::OrHash
+        ).void
+      end
+      attr_writer :user
+
+      # A course student (enrollment of a student in a course)
+      sig do
+        params(
+          id: String,
+          completed_lessons_count: Integer,
+          completion_rate: Float,
+          course:
+            WhopSDK::Models::CourseStudentRetrieveResponse::Course::OrHash,
+          first_interaction_at: Time,
+          last_interaction_at: Time,
+          total_lessons_count: Integer,
+          user: WhopSDK::Models::CourseStudentRetrieveResponse::User::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID of the course student. Looks like crsi_XXX
+        id:,
+        # The number of lessons the student has completed
+        completed_lessons_count:,
+        # The percentage of lessons completed (0-100)
+        completion_rate:,
+        # The course the student is enrolled in
+        course:,
+        # When the student first interacted with the course
+        first_interaction_at:,
+        # When the student last interacted with the course
+        last_interaction_at:,
+        # The total number of lessons the student has access to
+        total_lessons_count:,
+        # The user who is enrolled in the course
+        user:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            completed_lessons_count: Integer,
+            completion_rate: Float,
+            course: WhopSDK::Models::CourseStudentRetrieveResponse::Course,
+            first_interaction_at: Time,
+            last_interaction_at: Time,
+            total_lessons_count: Integer,
+            user: WhopSDK::Models::CourseStudentRetrieveResponse::User
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Course < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              WhopSDK::Models::CourseStudentRetrieveResponse::Course,
+              WhopSDK::Internal::AnyHash
+            )
+          end
+
+        # The ID of the course. Looks like cors_XXX
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The experience that the course belongs to
+        sig do
+          returns(
+            WhopSDK::Models::CourseStudentRetrieveResponse::Course::Experience
+          )
+        end
+        attr_reader :experience
+
+        sig do
+          params(
+            experience:
+              WhopSDK::Models::CourseStudentRetrieveResponse::Course::Experience::OrHash
+          ).void
+        end
+        attr_writer :experience
+
+        # The title of the course
+        sig { returns(T.nilable(String)) }
+        attr_accessor :title
+
+        # The course the student is enrolled in
+        sig do
+          params(
+            id: String,
+            experience:
+              WhopSDK::Models::CourseStudentRetrieveResponse::Course::Experience::OrHash,
+            title: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The ID of the course. Looks like cors_XXX
+          id:,
+          # The experience that the course belongs to
+          experience:,
+          # The title of the course
+          title:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              experience:
+                WhopSDK::Models::CourseStudentRetrieveResponse::Course::Experience,
+              title: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Experience < WhopSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                WhopSDK::Models::CourseStudentRetrieveResponse::Course::Experience,
+                WhopSDK::Internal::AnyHash
+              )
+            end
+
+          # The unique ID representing this experience
+          sig { returns(String) }
+          attr_accessor :id
+
+          # The experience that the course belongs to
+          sig { params(id: String).returns(T.attached_class) }
+          def self.new(
+            # The unique ID representing this experience
+            id:
+          )
+          end
+
+          sig { override.returns({ id: String }) }
+          def to_hash
+          end
+        end
+      end
+
+      class User < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              WhopSDK::Models::CourseStudentRetrieveResponse::User,
+              WhopSDK::Internal::AnyHash
+            )
+          end
+
+        # The internal ID of the user.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The name of the user from their Whop account.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :name
+
+        # The username of the user from their Whop account.
+        sig { returns(String) }
+        attr_accessor :username
+
+        # The user who is enrolled in the course
+        sig do
+          params(id: String, name: T.nilable(String), username: String).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # The internal ID of the user.
+          id:,
+          # The name of the user from their Whop account.
+          name:,
+          # The username of the user from their Whop account.
+          username:
+        )
+        end
+
+        sig do
+          override.returns(
+            { id: String, name: T.nilable(String), username: String }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end