whop_sdk 0.0.2 → 0.0.4

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

data/rbi/whop_sdk/models/course_update_params.rbi

@@ -0,0 +1,339 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class CourseUpdateParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::CourseUpdateParams, WhopSDK::Internal::AnyHash)
+        end
+
+      # 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 chapters and lessons to update
+      sig { returns(T.nilable(T::Array[WhopSDK::CourseUpdateParams::Chapter])) }
+      attr_accessor :chapters
+
+      # The cover image URL of the course
+      sig { returns(T.nilable(String)) }
+      attr_accessor :cover_image
+
+      # A short description of the course
+      sig { returns(T.nilable(String)) }
+      attr_accessor :description
+
+      # The available languages for a course
+      sig { returns(T.nilable(WhopSDK::Languages::OrSymbol)) }
+      attr_accessor :language
+
+      # Whether the course requires students to complete the previous lesson before
+      # moving on to the next one
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :require_completing_lessons_in_order
+
+      # A short tagline for the course
+      sig { returns(T.nilable(String)) }
+      attr_accessor :tagline
+
+      # The thumbnail for the course in png, jpeg, or gif format
+      sig do
+        returns(
+          T.nilable(
+            T.any(
+              WhopSDK::CourseUpdateParams::Thumbnail::AttachmentInputWithDirectUploadID,
+              WhopSDK::CourseUpdateParams::Thumbnail::AttachmentInputWithID
+            )
+          )
+        )
+      end
+      attr_accessor :thumbnail
+
+      # The title of the course
+      sig { returns(T.nilable(String)) }
+      attr_accessor :title
+
+      sig do
+        params(
+          certificate_after_completion_enabled: T.nilable(T::Boolean),
+          chapters:
+            T.nilable(T::Array[WhopSDK::CourseUpdateParams::Chapter::OrHash]),
+          cover_image: T.nilable(String),
+          description: T.nilable(String),
+          language: T.nilable(WhopSDK::Languages::OrSymbol),
+          require_completing_lessons_in_order: T.nilable(T::Boolean),
+          tagline: T.nilable(String),
+          thumbnail:
+            T.nilable(
+              T.any(
+                WhopSDK::CourseUpdateParams::Thumbnail::AttachmentInputWithDirectUploadID::OrHash,
+                WhopSDK::CourseUpdateParams::Thumbnail::AttachmentInputWithID::OrHash
+              )
+            ),
+          title: T.nilable(String),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Whether the course will award its students a PDF certificate after completing
+        # all lessons
+        certificate_after_completion_enabled: nil,
+        # The chapters and lessons to update
+        chapters: nil,
+        # The cover image URL of the course
+        cover_image: nil,
+        # A short description of the course
+        description: nil,
+        # The available languages for a course
+        language: nil,
+        # Whether the course requires students to complete the previous lesson before
+        # moving on to the next one
+        require_completing_lessons_in_order: nil,
+        # A short tagline for the course
+        tagline: nil,
+        # The thumbnail for the course in png, jpeg, or gif format
+        thumbnail: nil,
+        # The title of the course
+        title: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            certificate_after_completion_enabled: T.nilable(T::Boolean),
+            chapters: T.nilable(T::Array[WhopSDK::CourseUpdateParams::Chapter]),
+            cover_image: T.nilable(String),
+            description: T.nilable(String),
+            language: T.nilable(WhopSDK::Languages::OrSymbol),
+            require_completing_lessons_in_order: T.nilable(T::Boolean),
+            tagline: T.nilable(String),
+            thumbnail:
+              T.nilable(
+                T.any(
+                  WhopSDK::CourseUpdateParams::Thumbnail::AttachmentInputWithDirectUploadID,
+                  WhopSDK::CourseUpdateParams::Thumbnail::AttachmentInputWithID
+                )
+              ),
+            title: T.nilable(String),
+            request_options: WhopSDK::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Chapter < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              WhopSDK::CourseUpdateParams::Chapter,
+              WhopSDK::Internal::AnyHash
+            )
+          end
+
+        # The ID of the chapter to update
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The order of the chapter within its course
+        sig { returns(Integer) }
+        attr_accessor :order
+
+        # The title of the chapter
+        sig { returns(String) }
+        attr_accessor :title
+
+        # The lessons to update within this chapter
+        sig do
+          returns(
+            T.nilable(T::Array[WhopSDK::CourseUpdateParams::Chapter::Lesson])
+          )
+        end
+        attr_accessor :lessons
+
+        # Input for updating a chapter while updating a course
+        sig do
+          params(
+            id: String,
+            order: Integer,
+            title: String,
+            lessons:
+              T.nilable(
+                T::Array[WhopSDK::CourseUpdateParams::Chapter::Lesson::OrHash]
+              )
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The ID of the chapter to update
+          id:,
+          # The order of the chapter within its course
+          order:,
+          # The title of the chapter
+          title:,
+          # The lessons to update within this chapter
+          lessons: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              order: Integer,
+              title: String,
+              lessons:
+                T.nilable(
+                  T::Array[WhopSDK::CourseUpdateParams::Chapter::Lesson]
+                )
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Lesson < WhopSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                WhopSDK::CourseUpdateParams::Chapter::Lesson,
+                WhopSDK::Internal::AnyHash
+              )
+            end
+
+          # The ID of the lesson to update
+          sig { returns(String) }
+          attr_accessor :id
+
+          # The ID of the chapter this lesson belongs to (for moving between chapters)
+          sig { returns(String) }
+          attr_accessor :chapter_id
+
+          # The order of the lesson within its chapter
+          sig { returns(Integer) }
+          attr_accessor :order
+
+          # The title of the lesson
+          sig { returns(String) }
+          attr_accessor :title
+
+          # Input for updating a lesson while updating a course
+          sig do
+            params(
+              id: String,
+              chapter_id: String,
+              order: Integer,
+              title: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The ID of the lesson to update
+            id:,
+            # The ID of the chapter this lesson belongs to (for moving between chapters)
+            chapter_id:,
+            # The order of the lesson within its chapter
+            order:,
+            # The title of the lesson
+            title:
+          )
+          end
+
+          sig do
+            override.returns(
+              { id: String, chapter_id: String, order: Integer, title: String }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+
+      # The thumbnail for the course in png, jpeg, or gif format
+      module Thumbnail
+        extend WhopSDK::Internal::Type::Union
+
+        Variants =
+          T.type_alias do
+            T.any(
+              WhopSDK::CourseUpdateParams::Thumbnail::AttachmentInputWithDirectUploadID,
+              WhopSDK::CourseUpdateParams::Thumbnail::AttachmentInputWithID
+            )
+          end
+
+        class AttachmentInputWithDirectUploadID < WhopSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                WhopSDK::CourseUpdateParams::Thumbnail::AttachmentInputWithDirectUploadID,
+                WhopSDK::Internal::AnyHash
+              )
+            end
+
+          # This ID should be used the first time you upload an attachment. It is the ID of
+          # the direct upload that was created when uploading the file to S3 via the
+          # mediaDirectUpload mutation.
+          sig { returns(String) }
+          attr_accessor :direct_upload_id
+
+          # Input for an attachment
+          sig { params(direct_upload_id: String).returns(T.attached_class) }
+          def self.new(
+            # This ID should be used the first time you upload an attachment. It is the ID of
+            # the direct upload that was created when uploading the file to S3 via the
+            # mediaDirectUpload mutation.
+            direct_upload_id:
+          )
+          end
+
+          sig { override.returns({ direct_upload_id: String }) }
+          def to_hash
+          end
+        end
+
+        class AttachmentInputWithID < WhopSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                WhopSDK::CourseUpdateParams::Thumbnail::AttachmentInputWithID,
+                WhopSDK::Internal::AnyHash
+              )
+            end
+
+          # The ID of an existing attachment object. Use this when updating a resource and
+          # keeping a subset of the attachments. Don't use this unless you know what you're
+          # doing.
+          sig { returns(String) }
+          attr_accessor :id
+
+          # Input for an attachment
+          sig { params(id: String).returns(T.attached_class) }
+          def self.new(
+            # The ID of an existing attachment object. Use this when updating a resource and
+            # keeping a subset of the attachments. Don't use this unless you know what you're
+            # doing.
+            id:
+          )
+          end
+
+          sig { override.returns({ id: String }) }
+          def to_hash
+          end
+        end
+
+        sig do
+          override.returns(
+            T::Array[WhopSDK::CourseUpdateParams::Thumbnail::Variants]
+          )
+        end
+        def self.variants
+        end
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/experience_duplicate_params.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class ExperienceDuplicateParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::ExperienceDuplicateParams, WhopSDK::Internal::AnyHash)
+        end
+
+      # The name of the new experience
+      sig { returns(T.nilable(String)) }
+      attr_accessor :name
+
+      sig do
+        params(
+          name: T.nilable(String),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The name of the new experience
+        name: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          { name: T.nilable(String), request_options: WhopSDK::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end