whop_sdk 0.0.39 → 0.0.41

data/rbi/whop_sdk/models/product_create_params.rbi

@@ -11,80 +11,73 @@ module WhopSDK
           T.any(WhopSDK::ProductCreateParams, WhopSDK::Internal::AnyHash)
         end
 
-      # The unique identifier of the company to create this product for.
-      sig { returns(String) }
-      attr_accessor :company_id
-
       # The display name of the product. Maximum 80 characters.
       sig { returns(String) }
       attr_accessor :title
 
-      # Whether the checkout flow collects a shipping address from the customer.
+      # Whether to collect a shipping address at checkout.
       sig { returns(T.nilable(T::Boolean)) }
       attr_accessor :collect_shipping_address
 
-      # The different types of custom CTAs that can be selected.
-      sig { returns(T.nilable(WhopSDK::CustomCta::OrSymbol)) }
+      # The unique identifier of the company to create this product for.
+      sig { returns(T.nilable(String)) }
+      attr_reader :company_id
+
+      sig { params(company_id: String).void }
+      attr_writer :company_id
+
+      # The call-to-action button label.
+      sig { returns(T.nilable(String)) }
       attr_accessor :custom_cta
 
-      # A URL that the call-to-action button links to instead of the default checkout
-      # flow.
+      # A URL the call-to-action button links to.
       sig { returns(T.nilable(String)) }
       attr_accessor :custom_cta_url
 
-      # A custom text label that appears on the customer's bank statement. Must be 5-22
-      # characters, contain at least one letter, and not contain <, >, \, ', or "
-      # characters.
+      # Custom bank statement descriptor. Must start with WHOP\*.
       sig { returns(T.nilable(String)) }
       attr_accessor :custom_statement_descriptor
 
-      # A written description of the product displayed on its product page.
+      # A written description displayed on the product page.
       sig { returns(T.nilable(String)) }
       attr_accessor :description
 
-      # The unique identifiers of experiences to connect to this product.
-      sig { returns(T.nilable(T::Array[String])) }
-      attr_accessor :experience_ids
-
-      # The commission rate as a percentage that affiliates earn through the global
-      # affiliate program.
+      # The commission rate affiliates earn.
       sig { returns(T.nilable(Float)) }
       attr_accessor :global_affiliate_percentage
 
-      # The different statuses of the global affiliate program for a product.
-      sig { returns(T.nilable(WhopSDK::GlobalAffiliateStatus::OrSymbol)) }
-      attr_accessor :global_affiliate_status
+      # The enrollment status in the global affiliate program.
+      sig { returns(T.nilable(String)) }
+      attr_reader :global_affiliate_status
+
+      sig { params(global_affiliate_status: String).void }
+      attr_writer :global_affiliate_status
 
-      # A short marketing headline displayed prominently on the product page.
+      # A short marketing headline for the product page.
       sig { returns(T.nilable(String)) }
       attr_accessor :headline
 
-      # The commission rate as a percentage that members earn through the member
-      # affiliate program.
+      # The commission rate members earn.
       sig { returns(T.nilable(Float)) }
       attr_accessor :member_affiliate_percentage
 
-      # The different statuses of the global affiliate program for a product.
-      sig { returns(T.nilable(WhopSDK::GlobalAffiliateStatus::OrSymbol)) }
-      attr_accessor :member_affiliate_status
+      # The enrollment status in the member affiliate program.
+      sig { returns(T.nilable(String)) }
+      attr_reader :member_affiliate_status
 
-      # Configuration for an automatically generated plan to attach to this product.
-      sig { returns(T.nilable(WhopSDK::ProductCreateParams::PlanOptions)) }
-      attr_reader :plan_options
+      sig { params(member_affiliate_status: String).void }
+      attr_writer :member_affiliate_status
 
-      sig do
-        params(
-          plan_options:
-            T.nilable(WhopSDK::ProductCreateParams::PlanOptions::OrHash)
-        ).void
-      end
-      attr_writer :plan_options
+      # Custom key-value pairs to store on the product.
+      sig { returns(T.nilable(T.anything)) }
+      attr_accessor :metadata
 
-      # The unique identifier of the tax classification code to apply to this product.
+      # The unique identifier of the tax classification code. See the available
+      # [product categories](https://docs.numeral.com/essentials/product-categories).
       sig { returns(T.nilable(String)) }
       attr_accessor :product_tax_code_id
 
-      # A URL to redirect the customer to after completing a purchase.
+      # A URL to redirect the customer to after purchase.
       sig { returns(T.nilable(String)) }
       attr_accessor :redirect_purchase_url
 
@@ -97,81 +90,74 @@ module WhopSDK
       sig { returns(T.nilable(T::Boolean)) }
       attr_accessor :send_welcome_message
 
-      # Visibility of a resource
-      sig { returns(T.nilable(WhopSDK::Visibility::OrSymbol)) }
-      attr_accessor :visibility
+      # Whether the product is visible to customers.
+      sig { returns(T.nilable(String)) }
+      attr_reader :visibility
+
+      sig { params(visibility: String).void }
+      attr_writer :visibility
 
       sig do
         params(
-          company_id: String,
           title: String,
           collect_shipping_address: T.nilable(T::Boolean),
-          custom_cta: T.nilable(WhopSDK::CustomCta::OrSymbol),
+          company_id: String,
+          custom_cta: T.nilable(String),
           custom_cta_url: T.nilable(String),
           custom_statement_descriptor: T.nilable(String),
           description: T.nilable(String),
-          experience_ids: T.nilable(T::Array[String]),
           global_affiliate_percentage: T.nilable(Float),
-          global_affiliate_status:
-            T.nilable(WhopSDK::GlobalAffiliateStatus::OrSymbol),
+          global_affiliate_status: String,
           headline: T.nilable(String),
           member_affiliate_percentage: T.nilable(Float),
-          member_affiliate_status:
-            T.nilable(WhopSDK::GlobalAffiliateStatus::OrSymbol),
-          plan_options:
-            T.nilable(WhopSDK::ProductCreateParams::PlanOptions::OrHash),
+          member_affiliate_status: String,
+          metadata: T.nilable(T.anything),
           product_tax_code_id: T.nilable(String),
           redirect_purchase_url: T.nilable(String),
           route: T.nilable(String),
           send_welcome_message: T.nilable(T::Boolean),
-          visibility: T.nilable(WhopSDK::Visibility::OrSymbol),
+          visibility: String,
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
-        # The unique identifier of the company to create this product for.
-        company_id:,
         # The display name of the product. Maximum 80 characters.
         title:,
-        # Whether the checkout flow collects a shipping address from the customer.
+        # Whether to collect a shipping address at checkout.
         collect_shipping_address: nil,
-        # The different types of custom CTAs that can be selected.
+        # The unique identifier of the company to create this product for.
+        company_id: nil,
+        # The call-to-action button label.
         custom_cta: nil,
-        # A URL that the call-to-action button links to instead of the default checkout
-        # flow.
+        # A URL the call-to-action button links to.
         custom_cta_url: nil,
-        # A custom text label that appears on the customer's bank statement. Must be 5-22
-        # characters, contain at least one letter, and not contain <, >, \, ', or "
-        # characters.
+        # Custom bank statement descriptor. Must start with WHOP\*.
         custom_statement_descriptor: nil,
-        # A written description of the product displayed on its product page.
+        # A written description displayed on the product page.
         description: nil,
-        # The unique identifiers of experiences to connect to this product.
-        experience_ids: nil,
-        # The commission rate as a percentage that affiliates earn through the global
-        # affiliate program.
+        # The commission rate affiliates earn.
         global_affiliate_percentage: nil,
-        # The different statuses of the global affiliate program for a product.
+        # The enrollment status in the global affiliate program.
         global_affiliate_status: nil,
-        # A short marketing headline displayed prominently on the product page.
+        # A short marketing headline for the product page.
         headline: nil,
-        # The commission rate as a percentage that members earn through the member
-        # affiliate program.
+        # The commission rate members earn.
         member_affiliate_percentage: nil,
-        # The different statuses of the global affiliate program for a product.
+        # The enrollment status in the member affiliate program.
         member_affiliate_status: nil,
-        # Configuration for an automatically generated plan to attach to this product.
-        plan_options: nil,
-        # The unique identifier of the tax classification code to apply to this product.
+        # Custom key-value pairs to store on the product.
+        metadata: nil,
+        # The unique identifier of the tax classification code. See the available
+        # [product categories](https://docs.numeral.com/essentials/product-categories).
         product_tax_code_id: nil,
-        # A URL to redirect the customer to after completing a purchase.
+        # A URL to redirect the customer to after purchase.
         redirect_purchase_url: nil,
         # The URL slug for the product's public link.
         route: nil,
         # Whether to send an automated welcome message via support chat when a user joins
         # this product. Defaults to true.
         send_welcome_message: nil,
-        # Visibility of a resource
+        # Whether the product is visible to customers.
         visibility: nil,
         request_options: {}
       )
@@ -180,220 +166,30 @@ module WhopSDK
       sig do
         override.returns(
           {
-            company_id: String,
             title: String,
             collect_shipping_address: T.nilable(T::Boolean),
-            custom_cta: T.nilable(WhopSDK::CustomCta::OrSymbol),
+            company_id: String,
+            custom_cta: T.nilable(String),
             custom_cta_url: T.nilable(String),
             custom_statement_descriptor: T.nilable(String),
             description: T.nilable(String),
-            experience_ids: T.nilable(T::Array[String]),
             global_affiliate_percentage: T.nilable(Float),
-            global_affiliate_status:
-              T.nilable(WhopSDK::GlobalAffiliateStatus::OrSymbol),
+            global_affiliate_status: String,
             headline: T.nilable(String),
             member_affiliate_percentage: T.nilable(Float),
-            member_affiliate_status:
-              T.nilable(WhopSDK::GlobalAffiliateStatus::OrSymbol),
-            plan_options: T.nilable(WhopSDK::ProductCreateParams::PlanOptions),
+            member_affiliate_status: String,
+            metadata: T.nilable(T.anything),
             product_tax_code_id: T.nilable(String),
             redirect_purchase_url: T.nilable(String),
             route: T.nilable(String),
             send_welcome_message: T.nilable(T::Boolean),
-            visibility: T.nilable(WhopSDK::Visibility::OrSymbol),
+            visibility: String,
             request_options: WhopSDK::RequestOptions
           }
         )
       end
       def to_hash
       end
-
-      class PlanOptions < WhopSDK::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              WhopSDK::ProductCreateParams::PlanOptions,
-              WhopSDK::Internal::AnyHash
-            )
-          end
-
-        # The available currencies on the platform
-        sig { returns(T.nilable(WhopSDK::Currency::OrSymbol)) }
-        attr_accessor :base_currency
-
-        # The interval at which the plan charges (renewal plans).
-        sig { returns(T.nilable(Integer)) }
-        attr_accessor :billing_period
-
-        # An array of custom field objects.
-        sig do
-          returns(
-            T.nilable(
-              T::Array[WhopSDK::ProductCreateParams::PlanOptions::CustomField]
-            )
-          )
-        end
-        attr_accessor :custom_fields
-
-        # An additional amount charged upon first purchase. Provided as a number in the
-        # specified currency. Eg: 10.43 for $10.43 USD.
-        sig { returns(T.nilable(Float)) }
-        attr_accessor :initial_price
-
-        # The type of plan that can be attached to a product
-        sig { returns(T.nilable(WhopSDK::PlanType::OrSymbol)) }
-        attr_accessor :plan_type
-
-        # The methods of how a plan can be released.
-        sig { returns(T.nilable(WhopSDK::ReleaseMethod::OrSymbol)) }
-        attr_accessor :release_method
-
-        # The amount the customer is charged every billing period. Provided as a number in
-        # the specified currency. Eg: 10.43 for $10.43 USD.
-        sig { returns(T.nilable(Float)) }
-        attr_accessor :renewal_price
-
-        # Visibility of a resource
-        sig { returns(T.nilable(WhopSDK::Visibility::OrSymbol)) }
-        attr_accessor :visibility
-
-        # Configuration for an automatically generated plan to attach to this product.
-        sig do
-          params(
-            base_currency: T.nilable(WhopSDK::Currency::OrSymbol),
-            billing_period: T.nilable(Integer),
-            custom_fields:
-              T.nilable(
-                T::Array[
-                  WhopSDK::ProductCreateParams::PlanOptions::CustomField::OrHash
-                ]
-              ),
-            initial_price: T.nilable(Float),
-            plan_type: T.nilable(WhopSDK::PlanType::OrSymbol),
-            release_method: T.nilable(WhopSDK::ReleaseMethod::OrSymbol),
-            renewal_price: T.nilable(Float),
-            visibility: T.nilable(WhopSDK::Visibility::OrSymbol)
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # The available currencies on the platform
-          base_currency: nil,
-          # The interval at which the plan charges (renewal plans).
-          billing_period: nil,
-          # An array of custom field objects.
-          custom_fields: nil,
-          # An additional amount charged upon first purchase. Provided as a number in the
-          # specified currency. Eg: 10.43 for $10.43 USD.
-          initial_price: nil,
-          # The type of plan that can be attached to a product
-          plan_type: nil,
-          # The methods of how a plan can be released.
-          release_method: nil,
-          # The amount the customer is charged every billing period. Provided as a number in
-          # the specified currency. Eg: 10.43 for $10.43 USD.
-          renewal_price: nil,
-          # Visibility of a resource
-          visibility: nil
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              base_currency: T.nilable(WhopSDK::Currency::OrSymbol),
-              billing_period: T.nilable(Integer),
-              custom_fields:
-                T.nilable(
-                  T::Array[
-                    WhopSDK::ProductCreateParams::PlanOptions::CustomField
-                  ]
-                ),
-              initial_price: T.nilable(Float),
-              plan_type: T.nilable(WhopSDK::PlanType::OrSymbol),
-              release_method: T.nilable(WhopSDK::ReleaseMethod::OrSymbol),
-              renewal_price: T.nilable(Float),
-              visibility: T.nilable(WhopSDK::Visibility::OrSymbol)
-            }
-          )
-        end
-        def to_hash
-        end
-
-        class CustomField < WhopSDK::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                WhopSDK::ProductCreateParams::PlanOptions::CustomField,
-                WhopSDK::Internal::AnyHash
-              )
-            end
-
-          # The type of the custom field.
-          sig { returns(Symbol) }
-          attr_accessor :field_type
-
-          # The name of the custom field.
-          sig { returns(String) }
-          attr_accessor :name
-
-          # The ID of the custom field (if being updated)
-          sig { returns(T.nilable(String)) }
-          attr_accessor :id
-
-          # The order of the field.
-          sig { returns(T.nilable(Integer)) }
-          attr_accessor :order
-
-          # The placeholder value of the field.
-          sig { returns(T.nilable(String)) }
-          attr_accessor :placeholder
-
-          # Whether or not the field is required.
-          sig { returns(T.nilable(T::Boolean)) }
-          attr_accessor :required
-
-          sig do
-            params(
-              name: String,
-              id: T.nilable(String),
-              order: T.nilable(Integer),
-              placeholder: T.nilable(String),
-              required: T.nilable(T::Boolean),
-              field_type: Symbol
-            ).returns(T.attached_class)
-          end
-          def self.new(
-            # The name of the custom field.
-            name:,
-            # The ID of the custom field (if being updated)
-            id: nil,
-            # The order of the field.
-            order: nil,
-            # The placeholder value of the field.
-            placeholder: nil,
-            # Whether or not the field is required.
-            required: nil,
-            # The type of the custom field.
-            field_type: :text
-          )
-          end
-
-          sig do
-            override.returns(
-              {
-                field_type: Symbol,
-                name: String,
-                id: T.nilable(String),
-                order: T.nilable(Integer),
-                placeholder: T.nilable(String),
-                required: T.nilable(T::Boolean)
-              }
-            )
-          end
-          def to_hash
-          end
-        end
-      end
     end
   end
 end

data/rbi/whop_sdk/models/product_list_item.rbi

@@ -16,9 +16,8 @@ module WhopSDK
       sig { returns(Time) }
       attr_accessor :created_at
 
-      # A unique identifier used to create or update products via the API. When provided
-      # on product creation endpoints, an existing product with this identifier will be
-      # updated instead of creating a new one.
+      # External identifier for the product. Providing it on a product creation endpoint
+      # updates the existing product with this identifier instead of creating a new one.
       sig { returns(T.nilable(String)) }
       attr_accessor :external_identifier
 
@@ -26,17 +25,23 @@ module WhopSDK
       sig { returns(T.nilable(String)) }
       attr_accessor :headline
 
-      # The number of users who currently hold an active membership to this product.
-      # Returns 0 if the company has disabled public member counts.
+      # Active memberships for this product. Returns `0` if the account has disabled
+      # public member counts.
       sig { returns(Integer) }
       attr_accessor :member_count
 
+      # Custom key-value pairs stored on the product and included in payment and
+      # membership webhook payloads. Max 50 keys, 100 characters per key, 500 characters
+      # per string value.
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_accessor :metadata
+
       # The total number of published customer reviews for this product's company.
       sig { returns(Integer) }
       attr_accessor :published_reviews_count
 
-      # The URL slug used in the product's public link (e.g., 'my-product' in
-      # whop.com/company/my-product).
+      # URL slug in the product's public link, e.g. `pickaxe-analytics` in
+      # whop.com/company/pickaxe-analytics.
       sig { returns(String) }
       attr_accessor :route
 
@@ -67,6 +72,7 @@ module WhopSDK
           external_identifier: T.nilable(String),
           headline: T.nilable(String),
           member_count: Integer,
+          metadata: T.nilable(T::Hash[Symbol, T.anything]),
           published_reviews_count: Integer,
           route: String,
           title: String,
@@ -80,19 +86,22 @@ module WhopSDK
         id:,
         # The datetime the product was created.
         created_at:,
-        # A unique identifier used to create or update products via the API. When provided
-        # on product creation endpoints, an existing product with this identifier will be
-        # updated instead of creating a new one.
+        # External identifier for the product. Providing it on a product creation endpoint
+        # updates the existing product with this identifier instead of creating a new one.
         external_identifier:,
         # A short marketing headline displayed prominently on the product's product page.
         headline:,
-        # The number of users who currently hold an active membership to this product.
-        # Returns 0 if the company has disabled public member counts.
+        # Active memberships for this product. Returns `0` if the account has disabled
+        # public member counts.
         member_count:,
+        # Custom key-value pairs stored on the product and included in payment and
+        # membership webhook payloads. Max 50 keys, 100 characters per key, 500 characters
+        # per string value.
+        metadata:,
         # The total number of published customer reviews for this product's company.
         published_reviews_count:,
-        # The URL slug used in the product's public link (e.g., 'my-product' in
-        # whop.com/company/my-product).
+        # URL slug in the product's public link, e.g. `pickaxe-analytics` in
+        # whop.com/company/pickaxe-analytics.
         route:,
         # The display name of the product shown to customers on the product page and in
         # search results.
@@ -115,6 +124,7 @@ module WhopSDK
             external_identifier: T.nilable(String),
             headline: T.nilable(String),
             member_count: Integer,
+            metadata: T.nilable(T::Hash[Symbol, T.anything]),
             published_reviews_count: Integer,
             route: String,
             title: String,