whop_sdk 0.0.39 → 0.0.41

data/lib/whop_sdk/resources/plans.rb

@@ -2,7 +2,12 @@
 
 module WhopSDK
   module Resources
-    # Plans
+    # A Plan defines how customers buy a product. It controls pricing, billing
+    # cadence, availability, tax behavior, checkout fields, and purchase visibility.
+    #
+    # Use the Plans API to create plans for products, list existing plans, retrieve or
+    # update plan configuration, calculate tax for checkout, and delete plans that
+    # should no longer be offered.
     class Plans
       # Some parameter documentations has been truncated, see
       # {WhopSDK::Models::PlanCreateParams} for more details.
@@ -10,81 +15,75 @@ module WhopSDK
       # Create a new pricing plan for a product. The plan defines the billing interval,
       # price, and availability for customers.
       #
-      # Required permissions:
+      # @overload create(account_id: nil, adaptive_pricing_enabled: nil, billing_period: nil, checkout_styling: nil, currency: nil, custom_fields: nil, description: nil, expiration_days: nil, image: nil, initial_price: nil, internal_notes: nil, legacy_payment_method_controls: nil, metadata: nil, override_tax_type: nil, payment_method_configuration: nil, plan_type: nil, product_id: nil, release_method: nil, renewal_price: nil, split_pay_required_payments: nil, stock: nil, three_ds_level: nil, title: nil, trial_period_days: nil, unlimited_stock: nil, visibility: nil, request_options: {})
       #
-      # - `plan:create`
-      # - `access_pass:basic:read`
-      # - `plan:basic:read`
-      #
-      # @overload create(company_id:, product_id:, adaptive_pricing_enabled: nil, billing_period: nil, checkout_styling: nil, currency: nil, custom_fields: nil, description: nil, expiration_days: nil, image: nil, initial_price: nil, internal_notes: nil, legacy_payment_method_controls: nil, override_tax_type: nil, payment_method_configuration: nil, plan_type: nil, release_method: nil, renewal_price: nil, split_pay_required_payments: nil, stock: nil, title: nil, trial_period_days: nil, unlimited_stock: nil, visibility: nil, request_options: {})
-      #
-      # @param company_id [String] The unique identifier of the company to create this plan for.
-      #
-      # @param product_id [String] The unique identifier of the product to attach this plan to.
+      # @param account_id [String] The unique identifier of the account to create this plan for. Defaults to the ca
       #
       # @param adaptive_pricing_enabled [Boolean, nil] Whether this plan accepts local currency payments via adaptive pricing.
       #
-      # @param billing_period [Integer, nil] The number of days between recurring charges. For example, 30 for monthly or 365
+      # @param billing_period [Integer, nil] Recurring billing interval in days, such as 30 for monthly or 365 for annual.
       #
-      # @param checkout_styling [WhopSDK::Models::PlanCreateParams::CheckoutStyling, nil] Checkout styling overrides for this plan. Pass null to inherit from the company
+      # @param checkout_styling [Object, nil] Checkout styling overrides for this plan.
       #
-      # @param currency [Symbol, WhopSDK::Models::Currency, nil] The available currencies on the platform
+      # @param currency [String] The three-letter ISO currency code for the plan's pricing. Defaults to USD.
       #
-      # @param custom_fields [Array<WhopSDK::Models::PlanCreateParams::CustomField>, nil] An array of custom field definitions to collect from customers at checkout.
+      # @param custom_fields [Array<WhopSDK::Models::PlanCreateParams::CustomField>, nil] An array of custom field definitions to collect from customers at checkout. Omit
       #
       # @param description [String, nil] A text description of the plan displayed to customers on the product page.
       #
-      # @param expiration_days [Integer, nil] The number of days until the membership expires and access is revoked. Used for
+      # @param expiration_days [Integer, nil] Access duration in days before the membership expires.
       #
       # @param image [WhopSDK::Models::PlanCreateParams::Image, nil] An image displayed on the product page to represent this plan.
       #
-      # @param initial_price [Float, nil] The amount charged on the first purchase. For one-time plans, this is the full p
+      # @param initial_price [Float, nil] Initial amount charged in the plan's currency, e.g. 10.43 for $10.43.
       #
-      # @param internal_notes [String, nil] Private notes visible only to the business owner. Not shown to customers.
+      # @param internal_notes [String, nil] Private notes visible only to the account owner. Not shown to customers.
       #
       # @param legacy_payment_method_controls [Boolean, nil] Whether this plan uses legacy payment method controls.
       #
-      # @param override_tax_type [Symbol, WhopSDK::Models::TaxType, nil] Whether or not the tax is included in a plan's price (or if it hasn't been set u
+      # @param metadata [Object, nil] Custom key-value pairs to store on the plan. Included in webhook payloads for pa
       #
-      # @param payment_method_configuration [WhopSDK::Models::PlanCreateParams::PaymentMethodConfiguration, nil] Explicit payment method configuration for the plan. When not provided, the compa
+      # @param override_tax_type [String] Override the default tax classification for this specific plan.
       #
-      # @param plan_type [Symbol, WhopSDK::Models::PlanType, nil] The type of plan that can be attached to a product
+      # @param payment_method_configuration [WhopSDK::Models::PlanCreateParams::PaymentMethodConfiguration, nil] Explicit payment method configuration for the plan. When not provided, the accou
       #
-      # @param release_method [Symbol, WhopSDK::Models::ReleaseMethod, nil] The methods of how a plan can be released.
+      # @param plan_type [String] Plan billing type, such as `one_time` or `renewal`.
       #
-      # @param renewal_price [Float, nil] The amount charged each billing period for recurring plans. Provided in the plan
+      # @param product_id [String] The unique identifier of the product to attach this plan to.
       #
-      # @param split_pay_required_payments [Integer, nil] The number of installment payments required before the subscription pauses.
+      # @param release_method [String] Sales method for this plan, such as `buy_now` or `waitlist`.
+      #
+      # @param renewal_price [Float, nil] The amount charged each billing period for recurring plans, in the plan's curren
+      #
+      # @param split_pay_required_payments [Integer, nil] Installment payments required before the subscription pauses.
       #
       # @param stock [Integer, nil] The maximum number of units available for purchase. Ignored when unlimited_stock
       #
+      # @param three_ds_level [Symbol, WhopSDK::Models::PlanCreateParams::ThreeDSLevel] 3D Secure behavior for this plan. Send `null` to inherit the account default.
+      #
       # @param title [String, nil] The display name of the plan shown to customers on the product page.
       #
-      # @param trial_period_days [Integer, nil] The number of free trial days before the first charge on a recurring plan.
+      # @param trial_period_days [Integer, nil] Free trial duration before the first recurring charge.
       #
-      # @param unlimited_stock [Boolean, nil] Whether the plan has unlimited stock. When true, the stock field is ignored. Def
+      # @param unlimited_stock [Boolean, nil] Whether the plan has unlimited stock. When true, the stock field is ignored.
       #
-      # @param visibility [Symbol, WhopSDK::Models::Visibility, nil] Visibility of a resource
+      # @param visibility [String] Whether the plan is visible to customers or hidden from public view.
       #
       # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [WhopSDK::Models::Plan]
       #
       # @see WhopSDK::Models::PlanCreateParams
-      def create(params)
+      def create(params = {})
         parsed, options = WhopSDK::PlanCreateParams.dump_request(params)
         @client.request(method: :post, path: "plans", body: parsed, model: WhopSDK::Plan, options: options)
       end
 
       # Retrieves the details of an existing plan.
       #
-      # Required permissions:
-      #
-      # - `plan:basic:read`
-      #
       # @overload retrieve(id, request_options: {})
       #
-      # @param id [String] The unique identifier of the plan.
+      # @param id [String] Plan ID, prefixed `plan_`.
       #
       # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -106,59 +105,57 @@ module WhopSDK
       # Update a plan's pricing, billing interval, visibility, stock, and other
       # settings.
       #
-      # Required permissions:
-      #
-      # - `plan:update`
-      # - `access_pass:basic:read`
-      # - `plan:basic:read`
+      # @overload update(id, adaptive_pricing_enabled: nil, billing_period: nil, checkout_styling: nil, currency: nil, custom_fields: nil, description: nil, expiration_days: nil, image: nil, initial_price: nil, internal_notes: nil, legacy_payment_method_controls: nil, metadata: nil, offer_cancel_discount: nil, override_tax_type: nil, payment_method_configuration: nil, renewal_price: nil, stock: nil, strike_through_initial_price: nil, strike_through_renewal_price: nil, three_ds_level: nil, title: nil, trial_period_days: nil, unlimited_stock: nil, visibility: nil, request_options: {})
       #
-      # @overload update(id, adaptive_pricing_enabled: nil, billing_period: nil, checkout_styling: nil, currency: nil, custom_fields: nil, description: nil, expiration_days: nil, image: nil, initial_price: nil, internal_notes: nil, legacy_payment_method_controls: nil, offer_cancel_discount: nil, override_tax_type: nil, payment_method_configuration: nil, renewal_price: nil, stock: nil, strike_through_initial_price: nil, strike_through_renewal_price: nil, title: nil, trial_period_days: nil, unlimited_stock: nil, visibility: nil, request_options: {})
-      #
-      # @param id [String] The unique identifier of the plan to update.
+      # @param id [String] Plan ID, prefixed `plan_`.
       #
       # @param adaptive_pricing_enabled [Boolean, nil] Whether this plan accepts local currency payments via adaptive pricing.
       #
-      # @param billing_period [Integer, nil] The number of days between recurring charges. For example, 30 for monthly or 365
+      # @param billing_period [Integer, nil] Recurring billing interval in days, such as 30 for monthly or 365 for annual.
       #
-      # @param checkout_styling [WhopSDK::Models::PlanUpdateParams::CheckoutStyling, nil] Checkout styling overrides for this plan. Pass null to remove all overrides and
+      # @param checkout_styling [Object, nil] Checkout styling overrides for this plan.
       #
-      # @param currency [Symbol, WhopSDK::Models::Currency, nil] The available currencies on the platform
+      # @param currency [String] The three-letter ISO currency code for the plan's pricing. Defaults to USD.
       #
-      # @param custom_fields [Array<WhopSDK::Models::PlanUpdateParams::CustomField>, nil] An array of custom field definitions to collect from customers at checkout.
+      # @param custom_fields [Array<WhopSDK::Models::PlanUpdateParams::CustomField>, nil] An array of custom field definitions to collect from customers at checkout. Omit
       #
       # @param description [String, nil] A text description of the plan displayed to customers on the product page.
       #
-      # @param expiration_days [Integer, nil] The number of days until the membership expires and access is revoked. For examp
+      # @param expiration_days [Integer, nil] Access duration in days before the membership expires.
       #
       # @param image [WhopSDK::Models::PlanUpdateParams::Image, nil] An image displayed on the product page to represent this plan.
       #
-      # @param initial_price [Float, nil] The amount charged on the first purchase. Provided in the plan's currency (e.g.,
+      # @param initial_price [Float, nil] Initial amount charged in the plan's currency, e.g. 10.43 for $10.43.
       #
-      # @param internal_notes [String, nil] Private notes visible only to the business owner. Not shown to customers.
+      # @param internal_notes [String, nil] Private notes visible only to the account owner. Not shown to customers.
       #
       # @param legacy_payment_method_controls [Boolean, nil] Whether this plan uses legacy payment method controls.
       #
+      # @param metadata [Object, nil] Custom key-value pairs to store on the plan. Included in webhook payloads for pa
+      #
       # @param offer_cancel_discount [Boolean, nil] Whether to offer a retention discount when a customer attempts to cancel.
       #
-      # @param override_tax_type [Symbol, WhopSDK::Models::TaxType, nil] Whether or not the tax is included in a plan's price (or if it hasn't been set u
+      # @param override_tax_type [String] Override the default tax classification for this specific plan.
       #
-      # @param payment_method_configuration [WhopSDK::Models::PlanUpdateParams::PaymentMethodConfiguration, nil] Explicit payment method configuration for the plan. Sending null removes any cus
+      # @param payment_method_configuration [WhopSDK::Models::PlanUpdateParams::PaymentMethodConfiguration, nil] Explicit payment method configuration for the plan. When not provided, the accou
       #
-      # @param renewal_price [Float, nil] The amount charged each billing period for recurring plans. Provided in the plan
+      # @param renewal_price [Float, nil] The amount charged each billing period for recurring plans, in the plan's curren
       #
       # @param stock [Integer, nil] The maximum number of units available for purchase. Ignored when unlimited_stock
       #
-      # @param strike_through_initial_price [Float, nil] A comparison price displayed with a strikethrough for the initial price. Provide
+      # @param strike_through_initial_price [Float, nil] A comparison price displayed with a strikethrough for the initial price.
       #
-      # @param strike_through_renewal_price [Float, nil] A comparison price displayed with a strikethrough for the renewal price. Provide
+      # @param strike_through_renewal_price [Float, nil] A comparison price displayed with a strikethrough for the renewal price.
+      #
+      # @param three_ds_level [Symbol, WhopSDK::Models::PlanUpdateParams::ThreeDSLevel] 3D Secure behavior for this plan. Send `null` to inherit the account default.
       #
       # @param title [String, nil] The display name of the plan shown to customers on the product page.
       #
-      # @param trial_period_days [Integer, nil] The number of free trial days before the first charge on a recurring plan.
+      # @param trial_period_days [Integer, nil] Free trial duration before the first recurring charge.
       #
       # @param unlimited_stock [Boolean, nil] Whether the plan has unlimited stock. When true, the stock field is ignored.
       #
-      # @param visibility [Symbol, WhopSDK::Models::Visibility, nil] Visibility of a resource
+      # @param visibility [String] Whether the plan is visible to customers or hidden from public view.
       #
       # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -176,40 +173,36 @@ module WhopSDK
         )
       end
 
-      # Returns a paginated list of plans belonging to a company, with optional
+      # Returns a paginated list of plans belonging to an account, with optional
       # filtering by visibility, type, release method, and product.
       #
-      # Required permissions:
-      #
-      # - `plan:basic:read`
+      # @overload list(account_id:, after: nil, before: nil, created_after: nil, created_before: nil, direction: nil, first: nil, last: nil, order: nil, plan_types: nil, product_ids: nil, release_methods: nil, visibilities: nil, request_options: {})
       #
-      # @overload list(company_id:, after: nil, before: nil, created_after: nil, created_before: nil, direction: nil, first: nil, last: nil, order: nil, plan_types: nil, product_ids: nil, release_methods: nil, visibilities: nil, request_options: {})
+      # @param account_id [String] The unique identifier of the account to list plans for.
       #
-      # @param company_id [String] The unique identifier of the company to list plans for.
+      # @param after [String] A cursor; returns plans after this position.
       #
-      # @param after [String, nil] Returns the elements in the list that come after the specified cursor.
+      # @param before [String] A cursor; returns plans before this position.
       #
-      # @param before [String, nil] Returns the elements in the list that come before the specified cursor.
+      # @param created_after [String] Only return plans created after this timestamp.
       #
-      # @param created_after [Time, nil] Only return plans created after this timestamp.
+      # @param created_before [String] Only return plans created before this timestamp.
       #
-      # @param created_before [Time, nil] Only return plans created before this timestamp.
+      # @param direction [Symbol, WhopSDK::Models::PlanListParams::Direction] The sort direction for results. Defaults to descending.
       #
-      # @param direction [Symbol, WhopSDK::Models::Direction, nil] The direction of the sort.
+      # @param first [Integer] The number of plans to return (default and max 100).
       #
-      # @param first [Integer, nil] Returns the first _n_ elements from the list.
+      # @param last [Integer] The number of plans to return from the end of the range.
       #
-      # @param last [Integer, nil] Returns the last _n_ elements from the list.
+      # @param order [Symbol, WhopSDK::Models::PlanListParams::Order] The field to sort results by. Defaults to created_at.
       #
-      # @param order [Symbol, WhopSDK::Models::PlanListParams::Order, nil] The ways a relation of Plans can be ordered
+      # @param plan_types [Array<String>] Filter to only plans matching these billing types.
       #
-      # @param plan_types [Array<Symbol, WhopSDK::Models::PlanType>, nil] Filter to only plans matching these billing types.
+      # @param product_ids [Array<String>] Filter to only plans belonging to these product identifiers.
       #
-      # @param product_ids [Array<String>, nil] Filter to only plans belonging to these product identifiers.
+      # @param release_methods [Array<String>] Filter to only plans matching these release methods.
       #
-      # @param release_methods [Array<Symbol, WhopSDK::Models::ReleaseMethod>, nil] Filter to only plans matching these release methods.
-      #
-      # @param visibilities [Array<Symbol, WhopSDK::Models::VisibilityFilter>, nil] Filter to only plans matching these visibility states.
+      # @param visibilities [Array<String>] Filter to only plans matching these visibility states.
       #
       # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -232,13 +225,9 @@ module WhopSDK
       # Permanently delete a plan from a product. Existing memberships on this plan will
       # not be affected.
       #
-      # Required permissions:
-      #
-      # - `plan:delete`
-      #
       # @overload delete(id, request_options: {})
       #
-      # @param id [String] The unique identifier of the plan to delete.
+      # @param id [String] Plan ID, prefixed `plan_`.
       #
       # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -254,6 +243,37 @@ module WhopSDK
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {WhopSDK::Models::PlanCalculateTaxParams} for more details.
+      #
+      # Previews tax for a plan before checkout, based on the buyer's location.
+      #
+      # @overload calculate_tax(id, address: nil, ip_address: nil, tax_ids: nil, request_options: {})
+      #
+      # @param id [String] Plan ID, prefixed `plan_`.
+      #
+      # @param address [WhopSDK::Models::PlanCalculateTaxParams::Address, nil] Buyer billing address used for tax calculation. Provide either `address.country`
+      #
+      # @param ip_address [String] Buyer IP address used to infer location when no billing address is provided.
+      #
+      # @param tax_ids [Array<WhopSDK::Models::PlanCalculateTaxParams::TaxID>, nil] Optional buyer tax ID for B2B exemptions. At most one entry is supported.
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::PlanCalculateTaxResponse]
+      #
+      # @see WhopSDK::Models::PlanCalculateTaxParams
+      def calculate_tax(id, params = {})
+        parsed, options = WhopSDK::PlanCalculateTaxParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["plans/%1$s/calculate_tax", id],
+          body: parsed,
+          model: WhopSDK::Models::PlanCalculateTaxResponse,
+          options: options
+        )
+      end
+
       # @api private
       #
       # @param client [WhopSDK::Client]

data/lib/whop_sdk/resources/products.rb

@@ -2,58 +2,55 @@
 
 module WhopSDK
   module Resources
-    # Products
+    # A Product is a digital good or service sold on Whop. Products may contain plans
+    # for pricing and/or experiences for content delivery.
+    #
+    # Use the Products API to create products, list products visible to your
+    # credentials, retrieve product details, update product metadata or merchandising
+    # fields, and delete products that should no longer be sold.
     class Products
       # Some parameter documentations has been truncated, see
       # {WhopSDK::Models::ProductCreateParams} for more details.
       #
-      # Create a new product for a company. The product serves as the top-level
-      # container for plans and experiences.
+      # Creates a new product for a company.
       #
-      # Required permissions:
-      #
-      # - `access_pass:create`
-      # - `access_pass:basic:read`
-      #
-      # @overload create(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: {})
-      #
-      # @param company_id [String] The unique identifier of the company to create this product for.
+      # @overload create(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: {})
       #
       # @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}, nil]
       #
@@ -71,15 +68,12 @@ module WhopSDK
         )
       end
 
-      # Retrieves the details of an existing product.
-      #
-      # Required permissions:
-      #
-      # - `access_pass:basic:read`
+      # Retrieves the details of an existing product. This endpoint is publicly
+      # accessible.
       #
       # @overload retrieve(id, request_options: {})
       #
-      # @param id [String] The unique identifier or route slug of the product.
+      # @param id [String] The unique identifier of the product.
       #
       # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -98,52 +92,25 @@ module WhopSDK
       # Some parameter documentations has been truncated, see
       # {WhopSDK::Models::ProductUpdateParams} for more details.
       #
-      # Update a product's title, description, visibility, and other settings.
-      #
-      # Required permissions:
-      #
-      # - `access_pass:update`
-      # - `access_pass:basic:read`
-      #
-      # @overload update(id, collect_shipping_address: nil, custom_cta: nil, custom_cta_url: nil, custom_statement_descriptor: nil, description: nil, gallery_images: nil, global_affiliate_percentage: nil, global_affiliate_status: nil, headline: nil, member_affiliate_percentage: nil, member_affiliate_status: nil, product_tax_code_id: nil, redirect_purchase_url: nil, route: nil, send_welcome_message: nil, store_page_config: nil, title: nil, visibility: nil, request_options: {})
-      #
-      # @param id [String] The unique identifier of the product to update.
-      #
-      # @param collect_shipping_address [Boolean, nil] Whether the checkout flow collects a shipping address from the customer.
-      #
-      # @param custom_cta [Symbol, WhopSDK::Models::CustomCta, nil] The different types of custom CTAs that can be selected.
-      #
-      # @param custom_cta_url [String, nil] A URL that the call-to-action button links to instead of the default checkout fl
+      # Updates an existing product.
       #
-      # @param custom_statement_descriptor [String, nil] A custom text label that appears on the customer's bank statement. Must be 5-22
+      # @overload update(id, description: nil, headline: nil, metadata: nil, product_tax_code_id: nil, send_welcome_message: nil, title: nil, visibility: nil, request_options: {})
       #
-      # @param description [String, nil] A written description of the product displayed on its product page.
+      # @param id [String] The unique identifier of the product.
       #
-      # @param gallery_images [Array<WhopSDK::Models::ProductUpdateParams::GalleryImage>, nil] The gallery images for the 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 headline [String, nil] A short marketing headline for the product page.
       #
-      # @param global_affiliate_status [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil] The different statuses of the global affiliate program for a product.
+      # @param metadata [Object, nil] Custom key-value pairs to store on the product.
       #
-      # @param headline [String, nil] A short marketing headline displayed prominently on 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_status [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil] The different statuses of the global affiliate program for a product.
-      #
-      # @param product_tax_code_id [String, nil] The unique identifier of the tax classification code to apply to this product.
-      #
-      # @param redirect_purchase_url [String, nil] A URL to redirect the customer to after completing a purchase.
-      #
-      # @param route [String, nil] The URL slug for the product's public link.
+      # @param product_tax_code_id [String, nil] The unique identifier of the tax classification code. See the available [product
       #
       # @param send_welcome_message [Boolean, nil] Whether to send an automated welcome message via support chat when a user joins
       #
-      # @param store_page_config [WhopSDK::Models::ProductUpdateParams::StorePageConfig, nil] Layout and display configuration for this product on the company's store page.
-      #
-      # @param title [String, nil] The display name of the product. Maximum 80 characters.
+      # @param title [String] The display name of the product.
       #
-      # @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}, nil]
       #
@@ -161,36 +128,27 @@ module WhopSDK
         )
       end
 
-      # Returns a paginated list of products belonging to a company, with optional
-      # filtering by type, visibility, and creation date.
+      # Returns a paginated list of products belonging to a company.
       #
-      # Required permissions:
-      #
-      # - `access_pass:basic:read`
-      #
-      # @overload list(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: {})
+      # @overload list(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 access_pass_types [Array<String>] Filter to only products matching these types.
       #
-      # @param created_after [Time, nil] Only return products created after this timestamp.
+      # @param after [String] A cursor; returns products after this position.
       #
-      # @param created_before [Time, nil] Only return products created before this timestamp.
+      # @param before [String] A cursor; returns products before this position.
       #
-      # @param direction [Symbol, WhopSDK::Models::Direction, nil] The direction of the sort.
+      # @param direction [Symbol, WhopSDK::Models::ProductListParams::Direction] The sort direction for results. Defaults to descending.
       #
-      # @param first [Integer, nil] Returns the first _n_ elements from the list.
+      # @param first [Integer] The number of products to return (default and max 100).
       #
-      # @param last [Integer, nil] Returns the last _n_ elements from the list.
+      # @param last [Integer] The number of products to return from the end of the range.
       #
-      # @param order [Symbol, WhopSDK::Models::ProductListParams::Order, nil] The ways a relation of AccessPasses can be ordered
+      # @param order [String] The field to sort results by. Defaults to created_at.
       #
-      # @param product_types [Array<Symbol, WhopSDK::Models::AccessPassType>, nil] Filter to only products matching these type classifications.
-      #
-      # @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}, nil]
       #
@@ -210,15 +168,12 @@ module WhopSDK
         )
       end
 
-      # Permanently delete a product and remove it from the company's catalog.
-      #
-      # Required permissions:
-      #
-      # - `access_pass:delete`
+      # Deletes a product. Only products with no memberships, entries, reviews, or
+      # invoices can be deleted.
       #
       # @overload delete(id, request_options: {})
       #
-      # @param id [String] The unique identifier of the product to delete.
+      # @param id [String] The unique identifier of the product.
       #
       # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #

data/lib/whop_sdk/resources/promo_codes.rb

@@ -2,7 +2,6 @@
 
 module WhopSDK
   module Resources
-    # Promo codes
     class PromoCodes
       # Some parameter documentations has been truncated, see
       # {WhopSDK::Models::PromoCodeCreateParams} for more details.

data/lib/whop_sdk/resources/reactions.rb

@@ -2,7 +2,6 @@
 
 module WhopSDK
   module Resources
-    # Reactions
     class Reactions
       # Some parameter documentations has been truncated, see
       # {WhopSDK::Models::ReactionCreateParams} for more details.