whop_sdk 0.0.2 → 0.0.3

data/rbi/whop_sdk/models/product_create_params.rbi

@@ -19,22 +19,6 @@ module WhopSDK
       sig { returns(String) }
       attr_accessor :title
 
-      # The different types an access pass can be.
-      sig { returns(T.nilable(WhopSDK::AccessPassType::OrSymbol)) }
-      attr_accessor :access_pass_type
-
-      # A banner image for the product in png, jpeg format
-      sig { returns(T.nilable(WhopSDK::ProductCreateParams::BannerImage)) }
-      attr_reader :banner_image
-
-      sig do
-        params(
-          banner_image:
-            T.nilable(WhopSDK::ProductCreateParams::BannerImage::OrHash)
-        ).void
-      end
-      attr_writer :banner_image
-
       # The different business types a company can be.
       sig { returns(T.nilable(WhopSDK::BusinessTypes::OrSymbol)) }
       attr_accessor :business_type
@@ -129,9 +113,6 @@ module WhopSDK
         params(
           company_id: String,
           title: String,
-          access_pass_type: T.nilable(WhopSDK::AccessPassType::OrSymbol),
-          banner_image:
-            T.nilable(WhopSDK::ProductCreateParams::BannerImage::OrHash),
           business_type: T.nilable(WhopSDK::BusinessTypes::OrSymbol),
           collect_shipping_address: T.nilable(T::Boolean),
           custom_cta: T.nilable(WhopSDK::CustomCta::OrSymbol),
@@ -165,10 +146,6 @@ module WhopSDK
         company_id:,
         # The title of the product.
         title:,
-        # The different types an access pass can be.
-        access_pass_type: nil,
-        # A banner image for the product in png, jpeg format
-        banner_image: nil,
         # The different business types a company can be.
         business_type: nil,
         # Whether or not to collect shipping information at checkout from the customer.
@@ -218,8 +195,6 @@ module WhopSDK
           {
             company_id: String,
             title: String,
-            access_pass_type: T.nilable(WhopSDK::AccessPassType::OrSymbol),
-            banner_image: T.nilable(WhopSDK::ProductCreateParams::BannerImage),
             business_type: T.nilable(WhopSDK::BusinessTypes::OrSymbol),
             collect_shipping_address: T.nilable(T::Boolean),
             custom_cta: T.nilable(WhopSDK::CustomCta::OrSymbol),
@@ -251,55 +226,6 @@ module WhopSDK
       def to_hash
       end
 
-      class BannerImage < WhopSDK::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              WhopSDK::ProductCreateParams::BannerImage,
-              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(T.nilable(String)) }
-        attr_accessor :id
-
-        # 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(T.nilable(String)) }
-        attr_accessor :direct_upload_id
-
-        # A banner image for the product in png, jpeg format
-        sig do
-          params(
-            id: T.nilable(String),
-            direct_upload_id: T.nilable(String)
-          ).returns(T.attached_class)
-        end
-        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: nil,
-          # 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: nil
-        )
-        end
-
-        sig do
-          override.returns(
-            { id: T.nilable(String), direct_upload_id: T.nilable(String) }
-          )
-        end
-        def to_hash
-        end
-      end
-
       class PlanOptions < WhopSDK::Internal::Type::BaseModel
         OrHash =
           T.type_alias do

data/rbi/whop_sdk/models/product_list_item.rbi

@@ -20,6 +20,12 @@ module WhopSDK
       sig { returns(Time) }
       attr_accessor :created_at
 
+      # A unique identifier used to create or update products. When provided on product
+      # creation endpoints, we’ll look up an existing product by this identifier — if it
+      # exists, we’ll update it; if not, we’ll create a new one.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :external_identifier
+
       # The headline of the product.
       sig { returns(T.nilable(String)) }
       attr_accessor :headline
@@ -62,6 +68,7 @@ module WhopSDK
           id: String,
           business_type: T.nilable(WhopSDK::BusinessTypes::OrSymbol),
           created_at: Time,
+          external_identifier: T.nilable(String),
           headline: T.nilable(String),
           industry_type: T.nilable(WhopSDK::IndustryTypes::OrSymbol),
           member_count: Integer,
@@ -80,6 +87,10 @@ module WhopSDK
         business_type:,
         # When the product was created.
         created_at:,
+        # A unique identifier used to create or update products. When provided on product
+        # creation endpoints, we’ll look up an existing product by this identifier — if it
+        # exists, we’ll update it; if not, we’ll create a new one.
+        external_identifier:,
         # The headline of the product.
         headline:,
         # The different industry types a company can be in.
@@ -107,6 +118,7 @@ module WhopSDK
             id: String,
             business_type: T.nilable(WhopSDK::BusinessTypes::TaggedSymbol),
             created_at: Time,
+            external_identifier: T.nilable(String),
             headline: T.nilable(String),
             industry_type: T.nilable(WhopSDK::IndustryTypes::TaggedSymbol),
             member_count: Integer,

data/rbi/whop_sdk/models/product_update_params.rbi

@@ -85,6 +85,18 @@ module WhopSDK
       sig { returns(T.nilable(String)) }
       attr_accessor :route
 
+      # Configuration for a product on the company's store page.
+      sig { returns(T.nilable(WhopSDK::ProductUpdateParams::StorePageConfig)) }
+      attr_reader :store_page_config
+
+      sig do
+        params(
+          store_page_config:
+            T.nilable(WhopSDK::ProductUpdateParams::StorePageConfig::OrHash)
+        ).void
+      end
+      attr_writer :store_page_config
+
       # The title of the product.
       sig { returns(T.nilable(String)) }
       attr_accessor :title
@@ -114,6 +126,8 @@ module WhopSDK
           product_tax_code_id: T.nilable(String),
           redirect_purchase_url: T.nilable(String),
           route: T.nilable(String),
+          store_page_config:
+            T.nilable(WhopSDK::ProductUpdateParams::StorePageConfig::OrHash),
           title: T.nilable(String),
           visibility: T.nilable(WhopSDK::Visibility::OrSymbol),
           request_options: WhopSDK::RequestOptions::OrHash
@@ -154,6 +168,8 @@ module WhopSDK
         redirect_purchase_url: nil,
         # The route of the product.
         route: nil,
+        # Configuration for a product on the company's store page.
+        store_page_config: nil,
         # The title of the product.
         title: nil,
         # Visibility of a resource
@@ -183,6 +199,8 @@ module WhopSDK
             product_tax_code_id: T.nilable(String),
             redirect_purchase_url: T.nilable(String),
             route: T.nilable(String),
+            store_page_config:
+              T.nilable(WhopSDK::ProductUpdateParams::StorePageConfig),
             title: T.nilable(String),
             visibility: T.nilable(WhopSDK::Visibility::OrSymbol),
             request_options: WhopSDK::RequestOptions
@@ -240,6 +258,47 @@ module WhopSDK
         def to_hash
         end
       end
+
+      class StorePageConfig < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              WhopSDK::ProductUpdateParams::StorePageConfig,
+              WhopSDK::Internal::AnyHash
+            )
+          end
+
+        # Custom call-to-action text for the product's store page.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :custom_cta
+
+        # Whether or not to show the price on the product's store page.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_accessor :show_price
+
+        # Configuration for a product on the company's store page.
+        sig do
+          params(
+            custom_cta: T.nilable(String),
+            show_price: T.nilable(T::Boolean)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Custom call-to-action text for the product's store page.
+          custom_cta: nil,
+          # Whether or not to show the price on the product's store page.
+          show_price: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            { custom_cta: T.nilable(String), show_price: T.nilable(T::Boolean) }
+          )
+        end
+        def to_hash
+        end
+      end
     end
   end
 end

data/rbi/whop_sdk/models/promo_code.rbi

@@ -0,0 +1,248 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class PromoCode < WhopSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(WhopSDK::PromoCode, WhopSDK::Internal::AnyHash) }
+
+      # The ID of the promo.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The amount off (% or flat amount) for the promo.
+      sig { returns(Float) }
+      attr_accessor :amount_off
+
+      # Restricts promo use to only users who have churned from the company before.
+      sig { returns(T::Boolean) }
+      attr_accessor :churned_users_only
+
+      # The specific code used to apply the promo at checkout.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :code
+
+      # The company for the promo code.
+      sig { returns(WhopSDK::PromoCode::Company) }
+      attr_reader :company
+
+      sig { params(company: WhopSDK::PromoCode::Company::OrHash).void }
+      attr_writer :company
+
+      # The timestamp of when the promo was created.
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # The monetary currency of the promo code.
+      sig { returns(WhopSDK::Currency::TaggedSymbol) }
+      attr_accessor :currency
+
+      # The duration setting for the promo code
+      sig { returns(T.nilable(WhopSDK::PromoDuration::TaggedSymbol)) }
+      attr_accessor :duration
+
+      # Restricts promo use to only be applied to already purchased memberships.
+      sig { returns(T::Boolean) }
+      attr_accessor :existing_memberships_only
+
+      # The date/time of when the promo expires.
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :expires_at
+
+      # Restricts promo use to only users who have never purchased from the company
+      # before.
+      sig { returns(T::Boolean) }
+      attr_accessor :new_users_only
+
+      # Restricts promo use to only be applied once per customer.
+      sig { returns(T::Boolean) }
+      attr_accessor :one_per_customer
+
+      # The access pass associated with the promo code.
+      sig { returns(T.nilable(WhopSDK::PromoCode::Product)) }
+      attr_reader :product
+
+      sig do
+        params(product: T.nilable(WhopSDK::PromoCode::Product::OrHash)).void
+      end
+      attr_writer :product
+
+      # The number of months the promo is applied for.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :promo_duration_months
+
+      # The type (% or flat amount) of the promo.
+      sig { returns(WhopSDK::PromoType::TaggedSymbol) }
+      attr_accessor :promo_type
+
+      # Indicates if the promo code is live or disabled.
+      sig { returns(WhopSDK::PromoCodeStatus::TaggedSymbol) }
+      attr_accessor :status
+
+      # The quantity limit on the number of uses.
+      sig { returns(Integer) }
+      attr_accessor :stock
+
+      # Whether or not the promo code has unlimited stock.
+      sig { returns(T::Boolean) }
+      attr_accessor :unlimited_stock
+
+      # The amount of times the promo codes has been used.
+      sig { returns(Integer) }
+      attr_accessor :uses
+
+      # An object representing a promo code for a plan.
+      sig do
+        params(
+          id: String,
+          amount_off: Float,
+          churned_users_only: T::Boolean,
+          code: T.nilable(String),
+          company: WhopSDK::PromoCode::Company::OrHash,
+          created_at: Time,
+          currency: WhopSDK::Currency::OrSymbol,
+          duration: T.nilable(WhopSDK::PromoDuration::OrSymbol),
+          existing_memberships_only: T::Boolean,
+          expires_at: T.nilable(Time),
+          new_users_only: T::Boolean,
+          one_per_customer: T::Boolean,
+          product: T.nilable(WhopSDK::PromoCode::Product::OrHash),
+          promo_duration_months: T.nilable(Integer),
+          promo_type: WhopSDK::PromoType::OrSymbol,
+          status: WhopSDK::PromoCodeStatus::OrSymbol,
+          stock: Integer,
+          unlimited_stock: T::Boolean,
+          uses: Integer
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID of the promo.
+        id:,
+        # The amount off (% or flat amount) for the promo.
+        amount_off:,
+        # Restricts promo use to only users who have churned from the company before.
+        churned_users_only:,
+        # The specific code used to apply the promo at checkout.
+        code:,
+        # The company for the promo code.
+        company:,
+        # The timestamp of when the promo was created.
+        created_at:,
+        # The monetary currency of the promo code.
+        currency:,
+        # The duration setting for the promo code
+        duration:,
+        # Restricts promo use to only be applied to already purchased memberships.
+        existing_memberships_only:,
+        # The date/time of when the promo expires.
+        expires_at:,
+        # Restricts promo use to only users who have never purchased from the company
+        # before.
+        new_users_only:,
+        # Restricts promo use to only be applied once per customer.
+        one_per_customer:,
+        # The access pass associated with the promo code.
+        product:,
+        # The number of months the promo is applied for.
+        promo_duration_months:,
+        # The type (% or flat amount) of the promo.
+        promo_type:,
+        # Indicates if the promo code is live or disabled.
+        status:,
+        # The quantity limit on the number of uses.
+        stock:,
+        # Whether or not the promo code has unlimited stock.
+        unlimited_stock:,
+        # The amount of times the promo codes has been used.
+        uses:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            amount_off: Float,
+            churned_users_only: T::Boolean,
+            code: T.nilable(String),
+            company: WhopSDK::PromoCode::Company,
+            created_at: Time,
+            currency: WhopSDK::Currency::TaggedSymbol,
+            duration: T.nilable(WhopSDK::PromoDuration::TaggedSymbol),
+            existing_memberships_only: T::Boolean,
+            expires_at: T.nilable(Time),
+            new_users_only: T::Boolean,
+            one_per_customer: T::Boolean,
+            product: T.nilable(WhopSDK::PromoCode::Product),
+            promo_duration_months: T.nilable(Integer),
+            promo_type: WhopSDK::PromoType::TaggedSymbol,
+            status: WhopSDK::PromoCodeStatus::TaggedSymbol,
+            stock: Integer,
+            unlimited_stock: T::Boolean,
+            uses: Integer
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Company < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(WhopSDK::PromoCode::Company, WhopSDK::Internal::AnyHash)
+          end
+
+        # The ID of the company
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The written name of the company.
+        sig { returns(String) }
+        attr_accessor :title
+
+        # The company for the promo code.
+        sig { params(id: String, title: String).returns(T.attached_class) }
+        def self.new(
+          # The ID of the company
+          id:,
+          # The written name of the company.
+          title:
+        )
+        end
+
+        sig { override.returns({ id: String, title: String }) }
+        def to_hash
+        end
+      end
+
+      class Product < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(WhopSDK::PromoCode::Product, WhopSDK::Internal::AnyHash)
+          end
+
+        # The internal ID of the public product.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The title of the product. Use for Whop 4.0.
+        sig { returns(String) }
+        attr_accessor :title
+
+        # The access pass associated with the promo code.
+        sig { params(id: String, title: String).returns(T.attached_class) }
+        def self.new(
+          # The internal ID of the public product.
+          id:,
+          # The title of the product. Use for Whop 4.0.
+          title:
+        )
+        end
+
+        sig { override.returns({ id: String, title: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/promo_code_create_params.rbi

@@ -0,0 +1,161 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class PromoCodeCreateParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::PromoCodeCreateParams, WhopSDK::Internal::AnyHash)
+        end
+
+      # The amount off (% or flat amount) for the promo.
+      sig { returns(Float) }
+      attr_accessor :amount_off
+
+      # The monetary currency of the promo code.
+      sig { returns(WhopSDK::Currency::OrSymbol) }
+      attr_accessor :base_currency
+
+      # The specific code used to apply the promo at checkout.
+      sig { returns(String) }
+      attr_accessor :code
+
+      # The id of the company to create the promo code for.
+      sig { returns(String) }
+      attr_accessor :company_id
+
+      # Restricts promo use to only users who have never purchased from the company
+      # before.
+      sig { returns(T::Boolean) }
+      attr_accessor :new_users_only
+
+      # The number of months this promo code is applied and valid for.
+      sig { returns(Integer) }
+      attr_accessor :promo_duration_months
+
+      # The type (% or flat amount) of the promo.
+      sig { returns(WhopSDK::PromoType::OrSymbol) }
+      attr_accessor :promo_type
+
+      # Restricts promo use to only users who have churned from the company before.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :churned_users_only
+
+      # Whether this promo code is for existing memberships only (cancelations)
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :existing_memberships_only
+
+      # The date/time of when the promo expires.
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :expires_at
+
+      # Restricts promo use to only be applied once per customer.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :one_per_customer
+
+      # The IDs of the plans that the promo code applies to. If product_id is provided,
+      # it will only apply to plans attached to that product
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_accessor :plan_ids
+
+      # The product to lock the promo code to, if any. If provided will filter out any
+      # plan ids not attached to this product
+      sig { returns(T.nilable(String)) }
+      attr_accessor :product_id
+
+      # The quantity limit on the number of uses.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :stock
+
+      # Whether or not the promo code should have unlimited stock.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :unlimited_stock
+
+      sig do
+        params(
+          amount_off: Float,
+          base_currency: WhopSDK::Currency::OrSymbol,
+          code: String,
+          company_id: String,
+          new_users_only: T::Boolean,
+          promo_duration_months: Integer,
+          promo_type: WhopSDK::PromoType::OrSymbol,
+          churned_users_only: T.nilable(T::Boolean),
+          existing_memberships_only: T.nilable(T::Boolean),
+          expires_at: T.nilable(Time),
+          one_per_customer: T.nilable(T::Boolean),
+          plan_ids: T.nilable(T::Array[String]),
+          product_id: T.nilable(String),
+          stock: T.nilable(Integer),
+          unlimited_stock: T.nilable(T::Boolean),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The amount off (% or flat amount) for the promo.
+        amount_off:,
+        # The monetary currency of the promo code.
+        base_currency:,
+        # The specific code used to apply the promo at checkout.
+        code:,
+        # The id of the company to create the promo code for.
+        company_id:,
+        # Restricts promo use to only users who have never purchased from the company
+        # before.
+        new_users_only:,
+        # The number of months this promo code is applied and valid for.
+        promo_duration_months:,
+        # The type (% or flat amount) of the promo.
+        promo_type:,
+        # Restricts promo use to only users who have churned from the company before.
+        churned_users_only: nil,
+        # Whether this promo code is for existing memberships only (cancelations)
+        existing_memberships_only: nil,
+        # The date/time of when the promo expires.
+        expires_at: nil,
+        # Restricts promo use to only be applied once per customer.
+        one_per_customer: nil,
+        # The IDs of the plans that the promo code applies to. If product_id is provided,
+        # it will only apply to plans attached to that product
+        plan_ids: nil,
+        # The product to lock the promo code to, if any. If provided will filter out any
+        # plan ids not attached to this product
+        product_id: nil,
+        # The quantity limit on the number of uses.
+        stock: nil,
+        # Whether or not the promo code should have unlimited stock.
+        unlimited_stock: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            amount_off: Float,
+            base_currency: WhopSDK::Currency::OrSymbol,
+            code: String,
+            company_id: String,
+            new_users_only: T::Boolean,
+            promo_duration_months: Integer,
+            promo_type: WhopSDK::PromoType::OrSymbol,
+            churned_users_only: T.nilable(T::Boolean),
+            existing_memberships_only: T.nilable(T::Boolean),
+            expires_at: T.nilable(Time),
+            one_per_customer: T.nilable(T::Boolean),
+            plan_ids: T.nilable(T::Array[String]),
+            product_id: T.nilable(String),
+            stock: T.nilable(Integer),
+            unlimited_stock: T.nilable(T::Boolean),
+            request_options: WhopSDK::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/promo_code_delete_params.rbi

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

@@ -0,0 +1,8 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    PromoCodeDeleteResponse =
+      T.let(T::Boolean, WhopSDK::Internal::Type::Converter)
+  end
+end