whop_sdk 0.0.2 → 0.0.3

data/rbi/whop_sdk/models/checkout_configuration_create_params.rbi

@@ -166,7 +166,26 @@ module WhopSDK
         sig { returns(T.nilable(WhopSDK::PlanType::OrSymbol)) }
         attr_accessor :plan_type
 
-        # The product the plan is related to.
+        # Pass this object to create a new product for this plan. We will use the product
+        # external identifier to find or create an existing product.
+        sig do
+          returns(
+            T.nilable(WhopSDK::CheckoutConfigurationCreateParams::Plan::Product)
+          )
+        end
+        attr_reader :product
+
+        sig do
+          params(
+            product:
+              T.nilable(
+                WhopSDK::CheckoutConfigurationCreateParams::Plan::Product::OrHash
+              )
+          ).void
+        end
+        attr_writer :product
+
+        # The product the plan is related to. Either this or product is required.
         sig { returns(T.nilable(String)) }
         attr_accessor :product_id
 
@@ -213,6 +232,10 @@ module WhopSDK
             internal_notes: T.nilable(String),
             override_tax_type: T.nilable(WhopSDK::TaxType::OrSymbol),
             plan_type: T.nilable(WhopSDK::PlanType::OrSymbol),
+            product:
+              T.nilable(
+                WhopSDK::CheckoutConfigurationCreateParams::Plan::Product::OrHash
+              ),
             product_id: T.nilable(String),
             release_method: T.nilable(WhopSDK::ReleaseMethod::OrSymbol),
             renewal_price: T.nilable(Float),
@@ -248,7 +271,10 @@ module WhopSDK
           override_tax_type: nil,
           # The type of plan that can be attached to an access pass
           plan_type: nil,
-          # The product the plan is related to.
+          # Pass this object to create a new product for this plan. We will use the product
+          # external identifier to find or create an existing product.
+          product: nil,
+          # The product the plan is related to. Either this or product is required.
           product_id: nil,
           # The methods of how a plan can be released.
           release_method: nil,
@@ -286,6 +312,10 @@ module WhopSDK
               internal_notes: T.nilable(String),
               override_tax_type: T.nilable(WhopSDK::TaxType::OrSymbol),
               plan_type: T.nilable(WhopSDK::PlanType::OrSymbol),
+              product:
+                T.nilable(
+                  WhopSDK::CheckoutConfigurationCreateParams::Plan::Product
+                ),
               product_id: T.nilable(String),
               release_method: T.nilable(WhopSDK::ReleaseMethod::OrSymbol),
               renewal_price: T.nilable(Float),
@@ -421,6 +451,157 @@ module WhopSDK
           def to_hash
           end
         end
+
+        class Product < WhopSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                WhopSDK::CheckoutConfigurationCreateParams::Plan::Product,
+                WhopSDK::Internal::AnyHash
+              )
+            end
+
+          # A unique ID used to find or create a product. When provided during creation, we
+          # will look for an existing product with this external identifier — if found, it
+          # will be updated; otherwise, a new product will be created.
+          sig { returns(String) }
+          attr_accessor :external_identifier
+
+          # The title of the product.
+          sig { returns(String) }
+          attr_accessor :title
+
+          # The different business types a company can be.
+          sig { returns(T.nilable(WhopSDK::BusinessTypes::OrSymbol)) }
+          attr_accessor :business_type
+
+          # Whether or not to collect shipping information at checkout from the customer.
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_accessor :collect_shipping_address
+
+          # The custom statement descriptor for the product i.e. WHOP\*SPORTS, must be
+          # between 5 and 22 characters, contain at least one letter, and not contain any of
+          # the following characters: <, >, \, ', "
+          sig { returns(T.nilable(String)) }
+          attr_accessor :custom_statement_descriptor
+
+          # A written description of the product.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :description
+
+          # The percentage of the revenue that goes to the global affiliate program.
+          sig { returns(T.nilable(Float)) }
+          attr_accessor :global_affiliate_percentage
+
+          # The different statuses of the global affiliate program for an access pass.
+          sig { returns(T.nilable(WhopSDK::GlobalAffiliateStatus::OrSymbol)) }
+          attr_accessor :global_affiliate_status
+
+          # The headline of the product.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :headline
+
+          # The different industry types a company can be in.
+          sig { returns(T.nilable(WhopSDK::IndustryTypes::OrSymbol)) }
+          attr_accessor :industry_type
+
+          # The ID of the product tax code to apply to this product.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :product_tax_code_id
+
+          # The URL to redirect the customer to after a purchase.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :redirect_purchase_url
+
+          # The route of the product.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :route
+
+          # Visibility of a resource
+          sig { returns(T.nilable(WhopSDK::Visibility::OrSymbol)) }
+          attr_accessor :visibility
+
+          # Pass this object to create a new product for this plan. We will use the product
+          # external identifier to find or create an existing product.
+          sig do
+            params(
+              external_identifier: String,
+              title: String,
+              business_type: T.nilable(WhopSDK::BusinessTypes::OrSymbol),
+              collect_shipping_address: T.nilable(T::Boolean),
+              custom_statement_descriptor: T.nilable(String),
+              description: T.nilable(String),
+              global_affiliate_percentage: T.nilable(Float),
+              global_affiliate_status:
+                T.nilable(WhopSDK::GlobalAffiliateStatus::OrSymbol),
+              headline: T.nilable(String),
+              industry_type: T.nilable(WhopSDK::IndustryTypes::OrSymbol),
+              product_tax_code_id: T.nilable(String),
+              redirect_purchase_url: T.nilable(String),
+              route: T.nilable(String),
+              visibility: T.nilable(WhopSDK::Visibility::OrSymbol)
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # A unique ID used to find or create a product. When provided during creation, we
+            # will look for an existing product with this external identifier — if found, it
+            # will be updated; otherwise, a new product will be created.
+            external_identifier:,
+            # The title of the product.
+            title:,
+            # The different business types a company can be.
+            business_type: nil,
+            # Whether or not to collect shipping information at checkout from the customer.
+            collect_shipping_address: nil,
+            # The custom statement descriptor for the product i.e. WHOP\*SPORTS, must be
+            # between 5 and 22 characters, contain at least one letter, and not contain any of
+            # the following characters: <, >, \, ', "
+            custom_statement_descriptor: nil,
+            # A written description of the product.
+            description: nil,
+            # The percentage of the revenue that goes to the global affiliate program.
+            global_affiliate_percentage: nil,
+            # The different statuses of the global affiliate program for an access pass.
+            global_affiliate_status: nil,
+            # The headline of the product.
+            headline: nil,
+            # The different industry types a company can be in.
+            industry_type: nil,
+            # The ID of the product tax code to apply to this product.
+            product_tax_code_id: nil,
+            # The URL to redirect the customer to after a purchase.
+            redirect_purchase_url: nil,
+            # The route of the product.
+            route: nil,
+            # Visibility of a resource
+            visibility: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                external_identifier: String,
+                title: String,
+                business_type: T.nilable(WhopSDK::BusinessTypes::OrSymbol),
+                collect_shipping_address: T.nilable(T::Boolean),
+                custom_statement_descriptor: T.nilable(String),
+                description: T.nilable(String),
+                global_affiliate_percentage: T.nilable(Float),
+                global_affiliate_status:
+                  T.nilable(WhopSDK::GlobalAffiliateStatus::OrSymbol),
+                headline: T.nilable(String),
+                industry_type: T.nilable(WhopSDK::IndustryTypes::OrSymbol),
+                product_tax_code_id: T.nilable(String),
+                redirect_purchase_url: T.nilable(String),
+                route: T.nilable(String),
+                visibility: T.nilable(WhopSDK::Visibility::OrSymbol)
+              }
+            )
+          end
+          def to_hash
+          end
+        end
       end
     end
   end

data/rbi/whop_sdk/models/checkout_configuration_list_response.rbi

@@ -38,7 +38,8 @@ module WhopSDK
       end
       attr_writer :plan
 
-      # The URL to redirect the user to after the checkout configuration is created
+      # A URL you can send to customers to complete a checkout. It looks like
+      # `/checkout/plan_xxxx?session={id}`
       sig { returns(String) }
       attr_accessor :purchase_url
 
@@ -74,7 +75,8 @@ module WhopSDK
         metadata:,
         # The plan to use for the checkout configuration
         plan:,
-        # The URL to redirect the user to after the checkout configuration is created
+        # A URL you can send to customers to complete a checkout. It looks like
+        # `/checkout/plan_xxxx?session={id}`
         purchase_url:,
         # The URL to redirect the user to after the checkout configuration is created
         redirect_url:

data/rbi/whop_sdk/models/course.rbi

@@ -0,0 +1,313 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class Course < WhopSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(WhopSDK::Course, WhopSDK::Internal::AnyHash) }
+
+      # 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 chapters in this course
+      sig { returns(T::Array[WhopSDK::Course::Chapter]) }
+      attr_accessor :chapters
+
+      # 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::Course::Thumbnail)) }
+      attr_reader :thumbnail
+
+      sig do
+        params(thumbnail: T.nilable(WhopSDK::Course::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),
+          chapters: T::Array[WhopSDK::Course::Chapter::OrHash],
+          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::Course::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 chapters in this course
+        chapters:,
+        # 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),
+            chapters: T::Array[WhopSDK::Course::Chapter],
+            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::Course::Thumbnail),
+            title: T.nilable(String),
+            updated_at: Time
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Chapter < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(WhopSDK::Course::Chapter, WhopSDK::Internal::AnyHash)
+          end
+
+        # The ID of the chapter. Looks like chap_XXX
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The lessons in this chapter
+        sig { returns(T::Array[WhopSDK::Course::Chapter::Lesson]) }
+        attr_accessor :lessons
+
+        # 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
+
+        # A chapter from the courses app
+        sig do
+          params(
+            id: String,
+            lessons: T::Array[WhopSDK::Course::Chapter::Lesson::OrHash],
+            order: Integer,
+            title: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The ID of the chapter. Looks like chap_XXX
+          id:,
+          # The lessons in this chapter
+          lessons:,
+          # The order of the chapter within its course
+          order:,
+          # The title of the chapter
+          title:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              lessons: T::Array[WhopSDK::Course::Chapter::Lesson],
+              order: Integer,
+              title: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Lesson < WhopSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                WhopSDK::Course::Chapter::Lesson,
+                WhopSDK::Internal::AnyHash
+              )
+            end
+
+          # The ID of the lesson
+          sig { returns(String) }
+          attr_accessor :id
+
+          # The type of the lesson (text, video, pdf, multi, quiz, knowledge_check)
+          sig { returns(WhopSDK::LessonTypes::TaggedSymbol) }
+          attr_accessor :lesson_type
+
+          # 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
+
+          # A lesson from the courses app
+          sig do
+            params(
+              id: String,
+              lesson_type: WhopSDK::LessonTypes::OrSymbol,
+              order: Integer,
+              title: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The ID of the lesson
+            id:,
+            # The type of the lesson (text, video, pdf, multi, quiz, knowledge_check)
+            lesson_type:,
+            # The order of the lesson within its chapter
+            order:,
+            # The title of the lesson
+            title:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                lesson_type: WhopSDK::LessonTypes::TaggedSymbol,
+                order: Integer,
+                title: String
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+
+      class Thumbnail < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(WhopSDK::Course::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_chapter.rbi

@@ -0,0 +1,101 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class CourseChapter < WhopSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::CourseChapter, WhopSDK::Internal::AnyHash)
+        end
+
+      # The ID of the chapter. Looks like chap_XXX
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The lessons in this chapter
+      sig { returns(T::Array[WhopSDK::CourseChapter::Lesson]) }
+      attr_accessor :lessons
+
+      # 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
+
+      # A chapter from the courses app
+      sig do
+        params(
+          id: String,
+          lessons: T::Array[WhopSDK::CourseChapter::Lesson::OrHash],
+          order: Integer,
+          title: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID of the chapter. Looks like chap_XXX
+        id:,
+        # The lessons in this chapter
+        lessons:,
+        # The order of the chapter within its course
+        order:,
+        # The title of the chapter
+        title:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            lessons: T::Array[WhopSDK::CourseChapter::Lesson],
+            order: Integer,
+            title: String
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Lesson < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(WhopSDK::CourseChapter::Lesson, WhopSDK::Internal::AnyHash)
+          end
+
+        # The ID of the lesson
+        sig { returns(String) }
+        attr_accessor :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
+
+        # A lesson from the courses app
+        sig do
+          params(id: String, order: Integer, title: String).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # The ID of the lesson
+          id:,
+          # The order of the lesson within its chapter
+          order:,
+          # The title of the lesson
+          title:
+        )
+        end
+
+        sig { override.returns({ id: String, order: Integer, title: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/course_chapter_create_params.rbi

@@ -0,0 +1,51 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class CourseChapterCreateParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::CourseChapterCreateParams, WhopSDK::Internal::AnyHash)
+        end
+
+      # The ID of the course to create the chapter in
+      sig { returns(String) }
+      attr_accessor :course_id
+
+      # The title of the chapter
+      sig { returns(T.nilable(String)) }
+      attr_accessor :title
+
+      sig do
+        params(
+          course_id: String,
+          title: T.nilable(String),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID of the course to create the chapter in
+        course_id:,
+        # The title of the chapter
+        title: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            course_id: String,
+            title: T.nilable(String),
+            request_options: WhopSDK::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end