whop_sdk 0.0.39 → 0.0.41

data/lib/whop_sdk/models/product_create_params.rb

@@ -7,12 +7,6 @@ module WhopSDK
       extend WhopSDK::Internal::Type::RequestParameters::Converter
       include WhopSDK::Internal::Type::RequestParameters
 
-      # @!attribute company_id
-      #   The unique identifier of the company to create this product for.
-      #
-      #   @return [String]
-      required :company_id, String
-
       # @!attribute title
       #   The display name of the product. Maximum 80 characters.
       #
@@ -20,90 +14,86 @@ module WhopSDK
       required :title, String
 
       # @!attribute collect_shipping_address
-      #   Whether the checkout flow collects a shipping address from the customer.
+      #   Whether to collect a shipping address at checkout.
       #
       #   @return [Boolean, nil]
       optional :collect_shipping_address, WhopSDK::Internal::Type::Boolean, nil?: true
 
+      # @!attribute company_id
+      #   The unique identifier of the company to create this product for.
+      #
+      #   @return [String, nil]
+      optional :company_id, String
+
       # @!attribute custom_cta
-      #   The different types of custom CTAs that can be selected.
+      #   The call-to-action button label.
       #
-      #   @return [Symbol, WhopSDK::Models::CustomCta, nil]
-      optional :custom_cta, enum: -> { WhopSDK::CustomCta }, nil?: true
+      #   @return [String, nil]
+      optional :custom_cta, String, nil?: true
 
       # @!attribute custom_cta_url
-      #   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.
       #
       #   @return [String, nil]
       optional :custom_cta_url, String, nil?: true
 
       # @!attribute custom_statement_descriptor
-      #   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\*.
       #
       #   @return [String, nil]
       optional :custom_statement_descriptor, String, nil?: true
 
       # @!attribute description
-      #   A written description of the product displayed on its product page.
+      #   A written description displayed on the product page.
       #
       #   @return [String, nil]
       optional :description, String, nil?: true
 
-      # @!attribute experience_ids
-      #   The unique identifiers of experiences to connect to this product.
-      #
-      #   @return [Array<String>, nil]
-      optional :experience_ids, WhopSDK::Internal::Type::ArrayOf[String], nil?: true
-
       # @!attribute global_affiliate_percentage
-      #   The commission rate as a percentage that affiliates earn through the global
-      #   affiliate program.
+      #   The commission rate affiliates earn.
       #
       #   @return [Float, nil]
       optional :global_affiliate_percentage, Float, nil?: true
 
       # @!attribute global_affiliate_status
-      #   The different statuses of the global affiliate program for a product.
+      #   The enrollment status in the global affiliate program.
       #
-      #   @return [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil]
-      optional :global_affiliate_status, enum: -> { WhopSDK::GlobalAffiliateStatus }, nil?: true
+      #   @return [String, nil]
+      optional :global_affiliate_status, String
 
       # @!attribute headline
-      #   A short marketing headline displayed prominently on the product page.
+      #   A short marketing headline for the product page.
       #
       #   @return [String, nil]
       optional :headline, String, nil?: true
 
       # @!attribute member_affiliate_percentage
-      #   The commission rate as a percentage that members earn through the member
-      #   affiliate program.
+      #   The commission rate members earn.
       #
       #   @return [Float, nil]
       optional :member_affiliate_percentage, Float, nil?: true
 
       # @!attribute member_affiliate_status
-      #   The different statuses of the global affiliate program for a product.
+      #   The enrollment status in the member affiliate program.
       #
-      #   @return [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil]
-      optional :member_affiliate_status, enum: -> { WhopSDK::GlobalAffiliateStatus }, nil?: true
+      #   @return [String, nil]
+      optional :member_affiliate_status, String
 
-      # @!attribute plan_options
-      #   Configuration for an automatically generated plan to attach to this product.
+      # @!attribute metadata
+      #   Custom key-value pairs to store on the product.
       #
-      #   @return [WhopSDK::Models::ProductCreateParams::PlanOptions, nil]
-      optional :plan_options, -> { WhopSDK::ProductCreateParams::PlanOptions }, nil?: true
+      #   @return [Object, nil]
+      optional :metadata, WhopSDK::Internal::Type::Unknown, nil?: true
 
       # @!attribute product_tax_code_id
-      #   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).
       #
       #   @return [String, nil]
       optional :product_tax_code_id, String, nil?: true
 
       # @!attribute redirect_purchase_url
-      #   A URL to redirect the customer to after completing a purchase.
+      #   A URL to redirect the customer to after purchase.
       #
       #   @return [String, nil]
       optional :redirect_purchase_url, String, nil?: true
@@ -122,183 +112,52 @@ module WhopSDK
       optional :send_welcome_message, WhopSDK::Internal::Type::Boolean, nil?: true
 
       # @!attribute visibility
-      #   Visibility of a resource
+      #   Whether the product is visible to customers.
       #
-      #   @return [Symbol, WhopSDK::Models::Visibility, nil]
-      optional :visibility, enum: -> { WhopSDK::Visibility }, nil?: true
+      #   @return [String, nil]
+      optional :visibility, String
 
-      # @!method initialize(company_id:, title:, collect_shipping_address: nil, custom_cta: nil, custom_cta_url: nil, custom_statement_descriptor: nil, description: nil, experience_ids: nil, global_affiliate_percentage: nil, global_affiliate_status: nil, headline: nil, member_affiliate_percentage: nil, member_affiliate_status: nil, plan_options: nil, product_tax_code_id: nil, redirect_purchase_url: nil, route: nil, send_welcome_message: nil, visibility: nil, request_options: {})
+      # @!method initialize(title:, collect_shipping_address: nil, company_id: nil, custom_cta: nil, custom_cta_url: nil, custom_statement_descriptor: nil, description: nil, global_affiliate_percentage: nil, global_affiliate_status: nil, headline: nil, member_affiliate_percentage: nil, member_affiliate_status: nil, metadata: nil, product_tax_code_id: nil, redirect_purchase_url: nil, route: nil, send_welcome_message: nil, visibility: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {WhopSDK::Models::ProductCreateParams} for more details.
       #
-      #   @param company_id [String] The unique identifier of the company to create this product for.
-      #
       #   @param title [String] The display name of the product. Maximum 80 characters.
       #
-      #   @param collect_shipping_address [Boolean, nil] Whether the checkout flow collects a shipping address from the customer.
+      #   @param collect_shipping_address [Boolean, nil] Whether to collect a shipping address at checkout.
       #
-      #   @param custom_cta [Symbol, WhopSDK::Models::CustomCta, nil] The different types of custom CTAs that can be selected.
+      #   @param company_id [String] The unique identifier of the company to create this product for.
       #
-      #   @param custom_cta_url [String, nil] A URL that the call-to-action button links to instead of the default checkout fl
+      #   @param custom_cta [String, nil] The call-to-action button label.
       #
-      #   @param custom_statement_descriptor [String, nil] A custom text label that appears on the customer's bank statement. Must be 5-22
+      #   @param custom_cta_url [String, nil] A URL the call-to-action button links to.
       #
-      #   @param description [String, nil] A written description of the product displayed on its product page.
+      #   @param custom_statement_descriptor [String, nil] Custom bank statement descriptor. Must start with WHOP\*.
       #
-      #   @param experience_ids [Array<String>, nil] The unique identifiers of experiences to connect to this product.
+      #   @param description [String, nil] A written description displayed on the product page.
       #
-      #   @param global_affiliate_percentage [Float, nil] The commission rate as a percentage that affiliates earn through the global affi
+      #   @param global_affiliate_percentage [Float, nil] The commission rate affiliates earn.
       #
-      #   @param global_affiliate_status [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil] The different statuses of the global affiliate program for a product.
+      #   @param global_affiliate_status [String] The enrollment status in the global affiliate program.
       #
-      #   @param headline [String, nil] A short marketing headline displayed prominently on the product page.
+      #   @param headline [String, nil] A short marketing headline for the product page.
       #
-      #   @param member_affiliate_percentage [Float, nil] The commission rate as a percentage that members earn through the member affilia
+      #   @param member_affiliate_percentage [Float, nil] The commission rate members earn.
       #
-      #   @param member_affiliate_status [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil] The different statuses of the global affiliate program for a product.
+      #   @param member_affiliate_status [String] The enrollment status in the member affiliate program.
       #
-      #   @param plan_options [WhopSDK::Models::ProductCreateParams::PlanOptions, nil] Configuration for an automatically generated plan to attach to this product.
+      #   @param metadata [Object, nil] Custom key-value pairs to store on the product.
       #
-      #   @param product_tax_code_id [String, nil] The unique identifier of the tax classification code to apply to this product.
+      #   @param product_tax_code_id [String, nil] The unique identifier of the tax classification code. See the available [product
       #
-      #   @param redirect_purchase_url [String, nil] A URL to redirect the customer to after completing a purchase.
+      #   @param redirect_purchase_url [String, nil] A URL to redirect the customer to after purchase.
       #
       #   @param route [String, nil] The URL slug for the product's public link.
       #
       #   @param send_welcome_message [Boolean, nil] Whether to send an automated welcome message via support chat when a user joins
       #
-      #   @param visibility [Symbol, WhopSDK::Models::Visibility, nil] Visibility of a resource
+      #   @param visibility [String] Whether the product is visible to customers.
       #
       #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
-
-      class PlanOptions < WhopSDK::Internal::Type::BaseModel
-        # @!attribute base_currency
-        #   The available currencies on the platform
-        #
-        #   @return [Symbol, WhopSDK::Models::Currency, nil]
-        optional :base_currency, enum: -> { WhopSDK::Currency }, nil?: true
-
-        # @!attribute billing_period
-        #   The interval at which the plan charges (renewal plans).
-        #
-        #   @return [Integer, nil]
-        optional :billing_period, Integer, nil?: true
-
-        # @!attribute custom_fields
-        #   An array of custom field objects.
-        #
-        #   @return [Array<WhopSDK::Models::ProductCreateParams::PlanOptions::CustomField>, nil]
-        optional :custom_fields,
-                 -> {
-                   WhopSDK::Internal::Type::ArrayOf[WhopSDK::ProductCreateParams::PlanOptions::CustomField]
-                 },
-                 nil?: true
-
-        # @!attribute initial_price
-        #   An additional amount charged upon first purchase. Provided as a number in the
-        #   specified currency. Eg: 10.43 for $10.43 USD.
-        #
-        #   @return [Float, nil]
-        optional :initial_price, Float, nil?: true
-
-        # @!attribute plan_type
-        #   The type of plan that can be attached to a product
-        #
-        #   @return [Symbol, WhopSDK::Models::PlanType, nil]
-        optional :plan_type, enum: -> { WhopSDK::PlanType }, nil?: true
-
-        # @!attribute release_method
-        #   The methods of how a plan can be released.
-        #
-        #   @return [Symbol, WhopSDK::Models::ReleaseMethod, nil]
-        optional :release_method, enum: -> { WhopSDK::ReleaseMethod }, nil?: true
-
-        # @!attribute renewal_price
-        #   The amount the customer is charged every billing period. Provided as a number in
-        #   the specified currency. Eg: 10.43 for $10.43 USD.
-        #
-        #   @return [Float, nil]
-        optional :renewal_price, Float, nil?: true
-
-        # @!attribute visibility
-        #   Visibility of a resource
-        #
-        #   @return [Symbol, WhopSDK::Models::Visibility, nil]
-        optional :visibility, enum: -> { WhopSDK::Visibility }, nil?: true
-
-        # @!method initialize(base_currency: nil, billing_period: nil, custom_fields: nil, initial_price: nil, plan_type: nil, release_method: nil, renewal_price: nil, visibility: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {WhopSDK::Models::ProductCreateParams::PlanOptions} for more details.
-        #
-        #   Configuration for an automatically generated plan to attach to this product.
-        #
-        #   @param base_currency [Symbol, WhopSDK::Models::Currency, nil] The available currencies on the platform
-        #
-        #   @param billing_period [Integer, nil] The interval at which the plan charges (renewal plans).
-        #
-        #   @param custom_fields [Array<WhopSDK::Models::ProductCreateParams::PlanOptions::CustomField>, nil] An array of custom field objects.
-        #
-        #   @param initial_price [Float, nil] An additional amount charged upon first purchase. Provided as a number in the sp
-        #
-        #   @param plan_type [Symbol, WhopSDK::Models::PlanType, nil] The type of plan that can be attached to a product
-        #
-        #   @param release_method [Symbol, WhopSDK::Models::ReleaseMethod, nil] The methods of how a plan can be released.
-        #
-        #   @param renewal_price [Float, nil] The amount the customer is charged every billing period. Provided as a number in
-        #
-        #   @param visibility [Symbol, WhopSDK::Models::Visibility, nil] Visibility of a resource
-
-        class CustomField < WhopSDK::Internal::Type::BaseModel
-          # @!attribute field_type
-          #   The type of the custom field.
-          #
-          #   @return [Symbol, :text]
-          required :field_type, const: :text
-
-          # @!attribute name
-          #   The name of the custom field.
-          #
-          #   @return [String]
-          required :name, String
-
-          # @!attribute id
-          #   The ID of the custom field (if being updated)
-          #
-          #   @return [String, nil]
-          optional :id, String, nil?: true
-
-          # @!attribute order
-          #   The order of the field.
-          #
-          #   @return [Integer, nil]
-          optional :order, Integer, nil?: true
-
-          # @!attribute placeholder
-          #   The placeholder value of the field.
-          #
-          #   @return [String, nil]
-          optional :placeholder, String, nil?: true
-
-          # @!attribute required
-          #   Whether or not the field is required.
-          #
-          #   @return [Boolean, nil]
-          optional :required, WhopSDK::Internal::Type::Boolean, nil?: true
-
-          # @!method initialize(name:, id: nil, order: nil, placeholder: nil, required: nil, field_type: :text)
-          #   @param name [String] The name of the custom field.
-          #
-          #   @param id [String, nil] The ID of the custom field (if being updated)
-          #
-          #   @param order [Integer, nil] The order of the field.
-          #
-          #   @param placeholder [String, nil] The placeholder value of the field.
-          #
-          #   @param required [Boolean, nil] Whether or not the field is required.
-          #
-          #   @param field_type [Symbol, :text] The type of the custom field.
-        end
-      end
     end
   end
 end

data/lib/whop_sdk/models/product_list_item.rb

@@ -16,9 +16,8 @@ module WhopSDK
       required :created_at, Time
 
       # @!attribute external_identifier
-      #   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.
       #
       #   @return [String, nil]
       required :external_identifier, String, nil?: true
@@ -30,12 +29,20 @@ module WhopSDK
       required :headline, String, nil?: true
 
       # @!attribute member_count
-      #   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.
       #
       #   @return [Integer]
       required :member_count, Integer
 
+      # @!attribute metadata
+      #   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.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      required :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
+
       # @!attribute published_reviews_count
       #   The total number of published customer reviews for this product's company.
       #
@@ -43,8 +50,8 @@ module WhopSDK
       required :published_reviews_count, Integer
 
       # @!attribute route
-      #   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.
       #
       #   @return [String]
       required :route, String
@@ -75,7 +82,7 @@ module WhopSDK
       #   @return [Symbol, WhopSDK::Models::Visibility]
       required :visibility, enum: -> { WhopSDK::Visibility }
 
-      # @!method initialize(id:, created_at:, external_identifier:, headline:, member_count:, published_reviews_count:, route:, title:, updated_at:, verified:, visibility:)
+      # @!method initialize(id:, created_at:, external_identifier:, headline:, member_count:, metadata:, published_reviews_count:, route:, title:, updated_at:, verified:, visibility:)
       #   Some parameter documentations has been truncated, see
       #   {WhopSDK::Models::ProductListItem} for more details.
       #
@@ -86,15 +93,17 @@ module WhopSDK
       #
       #   @param created_at [Time] The datetime the product was created.
       #
-      #   @param external_identifier [String, nil] A unique identifier used to create or update products via the API. When provided
+      #   @param external_identifier [String, nil] External identifier for the product. Providing it on a product creation endpoint
       #
       #   @param headline [String, nil] A short marketing headline displayed prominently on the product's product page.
       #
-      #   @param member_count [Integer] The number of users who currently hold an active membership to this product. Ret
+      #   @param member_count [Integer] Active memberships for this product. Returns `0` if the account has disabled pub
+      #
+      #   @param metadata [Hash{Symbol=>Object}, nil] Custom key-value pairs stored on the product and included in payment and members
       #
       #   @param published_reviews_count [Integer] The total number of published customer reviews for this product's company.
       #
-      #   @param route [String] The URL slug used in the product's public link (e.g., 'my-product' in whop.com/c
+      #   @param route [String] URL slug in the product's public link, e.g. `pickaxe-analytics` in whop.com/comp
       #
       #   @param title [String] The display name of the product shown to customers on the product page and in se
       #

data/lib/whop_sdk/models/product_list_params.rb

@@ -13,103 +13,81 @@ module WhopSDK
       #   @return [String]
       required :company_id, String
 
+      # @!attribute access_pass_types
+      #   Filter to only products matching these types.
+      #
+      #   @return [Array<String>, nil]
+      optional :access_pass_types, WhopSDK::Internal::Type::ArrayOf[String]
+
       # @!attribute after
-      #   Returns the elements in the list that come after the specified cursor.
+      #   A cursor; returns products after this position.
       #
       #   @return [String, nil]
-      optional :after, String, nil?: true
+      optional :after, String
 
       # @!attribute before
-      #   Returns the elements in the list that come before the specified cursor.
+      #   A cursor; returns products before this position.
       #
       #   @return [String, nil]
-      optional :before, String, nil?: true
-
-      # @!attribute created_after
-      #   Only return products created after this timestamp.
-      #
-      #   @return [Time, nil]
-      optional :created_after, Time, nil?: true
-
-      # @!attribute created_before
-      #   Only return products created before this timestamp.
-      #
-      #   @return [Time, nil]
-      optional :created_before, Time, nil?: true
+      optional :before, String
 
       # @!attribute direction
-      #   The direction of the sort.
+      #   The sort direction for results. Defaults to descending.
       #
-      #   @return [Symbol, WhopSDK::Models::Direction, nil]
-      optional :direction, enum: -> { WhopSDK::Direction }, nil?: true
+      #   @return [Symbol, WhopSDK::Models::ProductListParams::Direction, nil]
+      optional :direction, enum: -> { WhopSDK::ProductListParams::Direction }
 
       # @!attribute first
-      #   Returns the first _n_ elements from the list.
+      #   The number of products to return (default and max 100).
       #
       #   @return [Integer, nil]
-      optional :first, Integer, nil?: true
+      optional :first, Integer
 
       # @!attribute last
-      #   Returns the last _n_ elements from the list.
+      #   The number of products to return from the end of the range.
       #
       #   @return [Integer, nil]
-      optional :last, Integer, nil?: true
+      optional :last, Integer
 
       # @!attribute order
-      #   The ways a relation of AccessPasses can be ordered
+      #   The field to sort results by. Defaults to created_at.
       #
-      #   @return [Symbol, WhopSDK::Models::ProductListParams::Order, nil]
-      optional :order, enum: -> { WhopSDK::ProductListParams::Order }, nil?: true
-
-      # @!attribute product_types
-      #   Filter to only products matching these type classifications.
-      #
-      #   @return [Array<Symbol, WhopSDK::Models::AccessPassType>, nil]
-      optional :product_types,
-               -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::AccessPassType] },
-               nil?: true
+      #   @return [String, nil]
+      optional :order, String
 
       # @!attribute visibilities
       #   Filter to only products matching these visibility states.
       #
-      #   @return [Array<Symbol, WhopSDK::Models::VisibilityFilter>, nil]
-      optional :visibilities,
-               -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::VisibilityFilter] },
-               nil?: true
+      #   @return [Array<String>, nil]
+      optional :visibilities, WhopSDK::Internal::Type::ArrayOf[String]
 
-      # @!method initialize(company_id:, after: nil, before: nil, created_after: nil, created_before: nil, direction: nil, first: nil, last: nil, order: nil, product_types: nil, visibilities: nil, request_options: {})
+      # @!method initialize(company_id:, access_pass_types: nil, after: nil, before: nil, direction: nil, first: nil, last: nil, order: nil, visibilities: nil, request_options: {})
       #   @param company_id [String] The unique identifier of the company to list products for.
       #
-      #   @param after [String, nil] Returns the elements in the list that come after the specified cursor.
-      #
-      #   @param before [String, nil] Returns the elements in the list that come before the specified cursor.
-      #
-      #   @param created_after [Time, nil] Only return products created after this timestamp.
+      #   @param access_pass_types [Array<String>] Filter to only products matching these types.
       #
-      #   @param created_before [Time, nil] Only return products created before this timestamp.
+      #   @param after [String] A cursor; returns products after this position.
       #
-      #   @param direction [Symbol, WhopSDK::Models::Direction, nil] The direction of the sort.
+      #   @param before [String] A cursor; returns products before this position.
       #
-      #   @param first [Integer, nil] Returns the first _n_ elements from the list.
+      #   @param direction [Symbol, WhopSDK::Models::ProductListParams::Direction] The sort direction for results. Defaults to descending.
       #
-      #   @param last [Integer, nil] Returns the last _n_ elements from the list.
+      #   @param first [Integer] The number of products to return (default and max 100).
       #
-      #   @param order [Symbol, WhopSDK::Models::ProductListParams::Order, nil] The ways a relation of AccessPasses can be ordered
+      #   @param last [Integer] The number of products to return from the end of the range.
       #
-      #   @param product_types [Array<Symbol, WhopSDK::Models::AccessPassType>, nil] Filter to only products matching these type classifications.
+      #   @param order [String] The field to sort results by. Defaults to created_at.
       #
-      #   @param visibilities [Array<Symbol, WhopSDK::Models::VisibilityFilter>, nil] Filter to only products matching these visibility states.
+      #   @param visibilities [Array<String>] Filter to only products matching these visibility states.
       #
       #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
 
-      # The ways a relation of AccessPasses can be ordered
-      module Order
+      # The sort direction for results. Defaults to descending.
+      module Direction
         extend WhopSDK::Internal::Type::Enum
 
-        ACTIVE_MEMBERSHIPS_COUNT = :active_memberships_count
-        CREATED_AT = :created_at
-        USD_GMV = :usd_gmv
-        USD_GMV_30_DAYS = :usd_gmv_30_days
+        ASC = :asc
+        DESC = :desc
 
         # @!method self.values
         #   @return [Array<Symbol>]