whop_sdk 0.0.2 → 0.0.4

data/rbi/whop_sdk/models/course_list_params.rbi

@@ -0,0 +1,83 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class CourseListParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::CourseListParams, WhopSDK::Internal::AnyHash)
+        end
+
+      # 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
+
+      # The ID of the company
+      sig { returns(T.nilable(String)) }
+      attr_accessor :company_id
+
+      # The ID of the experience
+      sig { returns(T.nilable(String)) }
+      attr_accessor :experience_id
+
+      # Returns the first _n_ elements from the list.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :first
+
+      # Returns the last _n_ elements from the list.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :last
+
+      sig do
+        params(
+          after: T.nilable(String),
+          before: T.nilable(String),
+          company_id: T.nilable(String),
+          experience_id: T.nilable(String),
+          first: T.nilable(Integer),
+          last: T.nilable(Integer),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # 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,
+        # The ID of the company
+        company_id: nil,
+        # The ID of the experience
+        experience_id: nil,
+        # Returns the first _n_ elements from the list.
+        first: nil,
+        # Returns the last _n_ elements from the list.
+        last: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            after: T.nilable(String),
+            before: T.nilable(String),
+            company_id: T.nilable(String),
+            experience_id: T.nilable(String),
+            first: T.nilable(Integer),
+            last: T.nilable(Integer),
+            request_options: WhopSDK::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/course_list_response.rbi

@@ -0,0 +1,198 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class CourseListResponse < WhopSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::Models::CourseListResponse, WhopSDK::Internal::AnyHash)
+        end
+
+      # The ID of the course. Looks like cors_XXX
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Whether the course will award its students a PDF certificate after completing
+      # all lessons
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :certificate_after_completion_enabled
+
+      # The timestamp of when the course was created
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # A short description of the course
+      sig { returns(T.nilable(String)) }
+      attr_accessor :description
+
+      # The language spoken in the video content of the course, used to generate closed
+      # captions in the right language
+      sig { returns(WhopSDK::Languages::TaggedSymbol) }
+      attr_accessor :language
+
+      # Whether the course requires students to complete the previous lesson before
+      # moving on to the next one
+      sig { returns(T::Boolean) }
+      attr_accessor :require_completing_lessons_in_order
+
+      # A short tagline for the course. It is displayed under the course title in the UI
+      sig { returns(T.nilable(String)) }
+      attr_accessor :tagline
+
+      # The thumbnail for the course
+      sig { returns(T.nilable(WhopSDK::Models::CourseListResponse::Thumbnail)) }
+      attr_reader :thumbnail
+
+      sig do
+        params(
+          thumbnail:
+            T.nilable(WhopSDK::Models::CourseListResponse::Thumbnail::OrHash)
+        ).void
+      end
+      attr_writer :thumbnail
+
+      # The title of the course
+      sig { returns(T.nilable(String)) }
+      attr_accessor :title
+
+      # The timestamp of when the course was last updated
+      sig { returns(Time) }
+      attr_accessor :updated_at
+
+      # A course from the courses app
+      sig do
+        params(
+          id: String,
+          certificate_after_completion_enabled: T.nilable(T::Boolean),
+          created_at: Time,
+          description: T.nilable(String),
+          language: WhopSDK::Languages::OrSymbol,
+          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
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID of the course. Looks like cors_XXX
+        id:,
+        # Whether the course will award its students a PDF certificate after completing
+        # all lessons
+        certificate_after_completion_enabled:,
+        # The timestamp of when the course was created
+        created_at:,
+        # A short description of the course
+        description:,
+        # The language spoken in the video content of the course, used to generate closed
+        # captions in the right language
+        language:,
+        # Whether the course requires students to complete the previous lesson before
+        # moving on to the next one
+        require_completing_lessons_in_order:,
+        # A short tagline for the course. It is displayed under the course title in the UI
+        tagline:,
+        # The thumbnail for the course
+        thumbnail:,
+        # The title of the course
+        title:,
+        # The timestamp of when the course was last updated
+        updated_at:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            certificate_after_completion_enabled: T.nilable(T::Boolean),
+            created_at: Time,
+            description: T.nilable(String),
+            language: WhopSDK::Languages::TaggedSymbol,
+            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
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Thumbnail < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              WhopSDK::Models::CourseListResponse::Thumbnail,
+              WhopSDK::Internal::AnyHash
+            )
+          end
+
+        # The ID of the attachment
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The attachment's content type (e.g., image/jpg, video/mp4)
+        sig { returns(T.nilable(String)) }
+        attr_accessor :content_type
+
+        # The name of the file
+        sig { returns(T.nilable(String)) }
+        attr_accessor :filename
+
+        # This is the URL you use to render optimized attachments on the client. This
+        # should be used for apps.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :optimized_url
+
+        # The original URL of the attachment, such as a direct link to S3. This should
+        # never be displayed on the client and always passed to an Imgproxy transformer.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :source_url
+
+        # The thumbnail for the course
+        sig do
+          params(
+            id: String,
+            content_type: T.nilable(String),
+            filename: T.nilable(String),
+            optimized_url: T.nilable(String),
+            source_url: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The ID of the attachment
+          id:,
+          # The attachment's content type (e.g., image/jpg, video/mp4)
+          content_type:,
+          # The name of the file
+          filename:,
+          # This is the URL you use to render optimized attachments on the client. This
+          # should be used for apps.
+          optimized_url:,
+          # The original URL of the attachment, such as a direct link to S3. This should
+          # never be displayed on the client and always passed to an Imgproxy transformer.
+          source_url:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              content_type: T.nilable(String),
+              filename: T.nilable(String),
+              optimized_url: T.nilable(String),
+              source_url: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/course_retrieve_params.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class CourseRetrieveParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::CourseRetrieveParams, 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_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