dodopayments 1.18.0 → 1.18.1

data/lib/dodopayments/models/license_key.rb

@@ -77,18 +77,33 @@ module Dodopayments
       optional :subscription_id, String, nil?: true
 
       # @!method initialize(id:, business_id:, created_at:, customer_id:, instances_count:, key:, payment_id:, product_id:, status:, activations_limit: nil, expires_at: nil, subscription_id: nil)
-      #   @param id [String]
-      #   @param business_id [String]
-      #   @param created_at [Time]
-      #   @param customer_id [String]
-      #   @param instances_count [Integer]
-      #   @param key [String]
-      #   @param payment_id [String]
-      #   @param product_id [String]
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::LicenseKey} for more details.
+      #
+      #   @param id [String] The unique identifier of the license key.
+      #
+      #   @param business_id [String] The unique identifier of the business associated with the license key.
+      #
+      #   @param created_at [Time] The timestamp indicating when the license key was created, in UTC.
+      #
+      #   @param customer_id [String] The unique identifier of the customer associated with the license key.
+      #
+      #   @param instances_count [Integer] The current number of instances activated for this license key.
+      #
+      #   @param key [String] The license key string.
+      #
+      #   @param payment_id [String] The unique identifier of the payment associated with the license key.
+      #
+      #   @param product_id [String] The unique identifier of the product associated with the license key.
+      #
       #   @param status [Symbol, Dodopayments::Models::LicenseKeyStatus]
-      #   @param activations_limit [Integer, nil]
-      #   @param expires_at [Time, nil]
-      #   @param subscription_id [String, nil]
+      #
+      #   @param activations_limit [Integer, nil] The maximum number of activations allowed for this license key.
+      #
+      #   @param expires_at [Time, nil] The timestamp indicating when the license key expires, in UTC.
+      #
+      #   @param subscription_id [String, nil] The unique identifier of the subscription associated with the license key, if an
+      #   ...
     end
   end
 end

data/lib/dodopayments/models/license_key_instance_list_params.rb

@@ -26,9 +26,12 @@ module Dodopayments
       optional :page_size, Integer, nil?: true
 
       # @!method initialize(license_key_id: nil, page_number: nil, page_size: nil, request_options: {})
-      #   @param license_key_id [String, nil]
-      #   @param page_number [Integer, nil]
-      #   @param page_size [Integer, nil]
+      #   @param license_key_id [String, nil] Filter by license key ID
+      #
+      #   @param page_number [Integer, nil] Page number default is 0
+      #
+      #   @param page_size [Integer, nil] Page size default is 10 max is 100
+      #
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/dodopayments/models/license_key_list_params.rb

@@ -38,11 +38,16 @@ module Dodopayments
       optional :status, enum: -> { Dodopayments::Models::LicenseKeyStatus }, nil?: true
 
       # @!method initialize(customer_id: nil, page_number: nil, page_size: nil, product_id: nil, status: nil, request_options: {})
-      #   @param customer_id [String, nil]
-      #   @param page_number [Integer, nil]
-      #   @param page_size [Integer, nil]
-      #   @param product_id [String, nil]
-      #   @param status [Symbol, Dodopayments::Models::LicenseKeyStatus, nil]
+      #   @param customer_id [String, nil] Filter by customer ID
+      #
+      #   @param page_number [Integer, nil] Page number default is 0
+      #
+      #   @param page_size [Integer, nil] Page size default is 10 max is 100
+      #
+      #   @param product_id [String, nil] Filter by product ID
+      #
+      #   @param status [Symbol, Dodopayments::Models::LicenseKeyStatus, nil] Filter by license key status
+      #
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/dodopayments/models/license_key_update_params.rb

@@ -29,9 +29,15 @@ module Dodopayments
       optional :expires_at, Time, nil?: true
 
       # @!method initialize(activations_limit: nil, disabled: nil, expires_at: nil, request_options: {})
-      #   @param activations_limit [Integer, nil]
-      #   @param disabled [Boolean, nil]
-      #   @param expires_at [Time, nil]
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::LicenseKeyUpdateParams} for more details.
+      #
+      #   @param activations_limit [Integer, nil] The updated activation limit for the license key. ...
+      #
+      #   @param disabled [Boolean, nil] Indicates whether the license key should be disabled. ...
+      #
+      #   @param expires_at [Time, nil] The updated expiration timestamp for the license key in UTC. ...
+      #
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/dodopayments/models/one_time_product_cart_item.rb

@@ -22,9 +22,15 @@ module Dodopayments
       optional :amount, Integer, nil?: true
 
       # @!method initialize(product_id:, quantity:, amount: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::OneTimeProductCartItem} for more details.
+      #
       #   @param product_id [String]
+      #
       #   @param quantity [Integer]
-      #   @param amount [Integer, nil]
+      #
+      #   @param amount [Integer, nil] Amount the customer pays if pay_what_you_want is enabled. If disabled then amoun
+      #   ...
     end
   end
 end

data/lib/dodopayments/models/payment.rb

@@ -131,27 +131,52 @@ module Dodopayments
       optional :updated_at, Time, nil?: true
 
       # @!method initialize(business_id:, created_at:, currency:, customer:, disputes:, metadata:, payment_id:, refunds:, settlement_amount:, settlement_currency:, total_amount:, discount_id: nil, error_message: nil, payment_link: nil, payment_method: nil, payment_method_type: nil, product_cart: nil, status: nil, subscription_id: nil, tax: nil, updated_at: nil)
-      #   @param business_id [String]
-      #   @param created_at [Time]
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::Payment} for more details.
+      #
+      #   @param business_id [String] Identifier of the business associated with the payment
+      #
+      #   @param created_at [Time] Timestamp when the payment was created
+      #
       #   @param currency [Symbol, Dodopayments::Models::Payment::Currency]
+      #
       #   @param customer [Dodopayments::Models::CustomerLimitedDetails]
-      #   @param disputes [Array<Dodopayments::Models::Dispute>]
+      #
+      #   @param disputes [Array<Dodopayments::Models::Dispute>] List of disputes associated with this payment
+      #
       #   @param metadata [Hash{Symbol=>String}]
-      #   @param payment_id [String]
-      #   @param refunds [Array<Dodopayments::Models::Refund>]
-      #   @param settlement_amount [Integer]
+      #
+      #   @param payment_id [String] Unique identifier for the payment
+      #
+      #   @param refunds [Array<Dodopayments::Models::Refund>] List of refunds issued for this payment
+      #
+      #   @param settlement_amount [Integer] The amount that will be credited to your Dodo balance after currency conversion
+      #   ...
+      #
       #   @param settlement_currency [Symbol, Dodopayments::Models::Payment::SettlementCurrency]
-      #   @param total_amount [Integer]
-      #   @param discount_id [String, nil]
-      #   @param error_message [String, nil]
-      #   @param payment_link [String, nil]
-      #   @param payment_method [String, nil]
-      #   @param payment_method_type [String, nil]
-      #   @param product_cart [Array<Dodopayments::Models::Payment::ProductCart>, nil]
+      #
+      #   @param total_amount [Integer] Total amount charged to the customer including tax, in smallest currency unit (e
+      #   ...
+      #
+      #   @param discount_id [String, nil] The discount id if discount is applied
+      #
+      #   @param error_message [String, nil] An error message if the payment failed
+      #
+      #   @param payment_link [String, nil] Checkout URL
+      #
+      #   @param payment_method [String, nil] Payment method used by customer (e.g. "card", "bank_transfer")
+      #
+      #   @param payment_method_type [String, nil] Specific type of payment method (e.g. "visa", "mastercard")
+      #
+      #   @param product_cart [Array<Dodopayments::Models::Payment::ProductCart>, nil] List of products purchased in a one-time payment
+      #
       #   @param status [Symbol, Dodopayments::Models::IntentStatus, nil]
-      #   @param subscription_id [String, nil]
-      #   @param tax [Integer, nil]
-      #   @param updated_at [Time, nil]
+      #
+      #   @param subscription_id [String, nil] Identifier of the subscription if payment is part of a subscription
+      #
+      #   @param tax [Integer, nil] Amount of tax collected in smallest currency unit (e.g. cents)
+      #
+      #   @param updated_at [Time, nil] Timestamp when the payment was last updated
 
       # @see Dodopayments::Models::Payment#currency
       module Currency

data/lib/dodopayments/models/payment_create_params.rb

@@ -82,17 +82,32 @@ module Dodopayments
       optional :tax_id, String, nil?: true
 
       # @!method initialize(billing:, customer:, product_cart:, allowed_payment_method_types: nil, billing_currency: nil, discount_code: nil, metadata: nil, payment_link: nil, return_url: nil, show_saved_payment_methods: nil, tax_id: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::PaymentCreateParams} for more details.
+      #
       #   @param billing [Dodopayments::Models::BillingAddress]
+      #
       #   @param customer [Dodopayments::Models::AttachExistingCustomer, Dodopayments::Models::CreateNewCustomer]
-      #   @param product_cart [Array<Dodopayments::Models::OneTimeProductCartItem>]
-      #   @param allowed_payment_method_types [Array<Symbol, Dodopayments::Models::PaymentCreateParams::AllowedPaymentMethodType>, nil]
+      #
+      #   @param product_cart [Array<Dodopayments::Models::OneTimeProductCartItem>] List of products in the cart. Must contain at least 1 and at most 100 items.
+      #
+      #   @param allowed_payment_method_types [Array<Symbol, Dodopayments::Models::PaymentCreateParams::AllowedPaymentMethodType>, nil] List of payment methods allowed during checkout. ...
+      #
       #   @param billing_currency [Symbol, Dodopayments::Models::PaymentCreateParams::BillingCurrency, nil]
-      #   @param discount_code [String, nil]
+      #
+      #   @param discount_code [String, nil] Discount Code to apply to the transaction
+      #
       #   @param metadata [Hash{Symbol=>String}]
-      #   @param payment_link [Boolean, nil]
-      #   @param return_url [String, nil]
-      #   @param show_saved_payment_methods [Boolean]
-      #   @param tax_id [String, nil]
+      #
+      #   @param payment_link [Boolean, nil] Whether to generate a payment link. Defaults to false if not specified.
+      #
+      #   @param return_url [String, nil] Optional URL to redirect the customer after payment. ...
+      #
+      #   @param show_saved_payment_methods [Boolean] Display saved payment methods of a returning customer ...
+      #
+      #   @param tax_id [String, nil] Tax ID in case the payment is B2B. If tax id validation fails the payment creati
+      #   ...
+      #
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
 
       module AllowedPaymentMethodType

data/lib/dodopayments/models/payment_create_response.rb

@@ -54,14 +54,24 @@ module Dodopayments
                nil?: true
 
       # @!method initialize(client_secret:, customer:, metadata:, payment_id:, total_amount:, discount_id: nil, payment_link: nil, product_cart: nil)
-      #   @param client_secret [String]
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::PaymentCreateResponse} for more details.
+      #
+      #   @param client_secret [String] Client secret used to load Dodo checkout SDK ...
+      #
       #   @param customer [Dodopayments::Models::CustomerLimitedDetails]
+      #
       #   @param metadata [Hash{Symbol=>String}]
-      #   @param payment_id [String]
-      #   @param total_amount [Integer]
-      #   @param discount_id [String, nil]
-      #   @param payment_link [String, nil]
-      #   @param product_cart [Array<Dodopayments::Models::OneTimeProductCartItem>, nil]
+      #
+      #   @param payment_id [String] Unique identifier for the payment
+      #
+      #   @param total_amount [Integer] Total amount of the payment in smallest currency unit (e.g. cents)
+      #
+      #   @param discount_id [String, nil] The discount id if discount is applied
+      #
+      #   @param payment_link [String, nil] Optional URL to a hosted payment page
+      #
+      #   @param product_cart [Array<Dodopayments::Models::OneTimeProductCartItem>, nil] Optional list of products included in the payment
     end
   end
 end

data/lib/dodopayments/models/payment_list_params.rb

@@ -50,13 +50,20 @@ module Dodopayments
       optional :subscription_id, String, nil?: true
 
       # @!method initialize(created_at_gte: nil, created_at_lte: nil, customer_id: nil, page_number: nil, page_size: nil, status: nil, subscription_id: nil, request_options: {})
-      #   @param created_at_gte [Time, nil]
-      #   @param created_at_lte [Time, nil]
-      #   @param customer_id [String, nil]
-      #   @param page_number [Integer, nil]
-      #   @param page_size [Integer, nil]
-      #   @param status [Symbol, Dodopayments::Models::IntentStatus, nil]
-      #   @param subscription_id [String, nil]
+      #   @param created_at_gte [Time, nil] Get events after this created time
+      #
+      #   @param created_at_lte [Time, nil] Get events created before this time
+      #
+      #   @param customer_id [String, nil] Filter by customer id
+      #
+      #   @param page_number [Integer, nil] Page number default is 0
+      #
+      #   @param page_size [Integer, nil] Page size default is 10 max is 100
+      #
+      #   @param status [Symbol, Dodopayments::Models::IntentStatus, nil] Filter by status
+      #
+      #   @param subscription_id [String, nil] Filter by subscription id
+      #
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/dodopayments/models/payout_list_params.rb

@@ -20,8 +20,10 @@ module Dodopayments
       optional :page_size, Integer, nil?: true
 
       # @!method initialize(page_number: nil, page_size: nil, request_options: {})
-      #   @param page_number [Integer, nil]
-      #   @param page_size [Integer, nil]
+      #   @param page_number [Integer, nil] Page number default is 0
+      #
+      #   @param page_size [Integer, nil] Page size default is 10 max is 100
+      #
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/dodopayments/models/payout_list_response.rb

@@ -93,21 +93,35 @@ module Dodopayments
       optional :remarks, String, nil?: true
 
       # @!method initialize(amount:, business_id:, chargebacks:, created_at:, currency:, fee:, payment_method:, payout_id:, refunds:, status:, tax:, updated_at:, name: nil, payout_document_url: nil, remarks: nil)
-      #   @param amount [Integer]
-      #   @param business_id [String]
-      #   @param chargebacks [Integer]
-      #   @param created_at [Time]
+      #   @param amount [Integer] The total amount of the payout.
+      #
+      #   @param business_id [String] The unique identifier of the business associated with the payout.
+      #
+      #   @param chargebacks [Integer] The total value of chargebacks associated with the payout.
+      #
+      #   @param created_at [Time] The timestamp when the payout was created, in UTC.
+      #
       #   @param currency [Symbol, Dodopayments::Models::PayoutListResponse::Currency]
-      #   @param fee [Integer]
-      #   @param payment_method [String]
-      #   @param payout_id [String]
-      #   @param refunds [Integer]
+      #
+      #   @param fee [Integer] The fee charged for processing the payout.
+      #
+      #   @param payment_method [String] The payment method used for the payout (e.g., bank transfer, card, etc.).
+      #
+      #   @param payout_id [String] The unique identifier of the payout.
+      #
+      #   @param refunds [Integer] The total value of refunds associated with the payout.
+      #
       #   @param status [Symbol, Dodopayments::Models::PayoutListResponse::Status]
-      #   @param tax [Integer]
-      #   @param updated_at [Time]
-      #   @param name [String, nil]
-      #   @param payout_document_url [String, nil]
-      #   @param remarks [String, nil]
+      #
+      #   @param tax [Integer] The tax applied to the payout.
+      #
+      #   @param updated_at [Time] The timestamp when the payout was last updated, in UTC.
+      #
+      #   @param name [String, nil] The name of the payout recipient or purpose.
+      #
+      #   @param payout_document_url [String, nil] The URL of the document associated with the payout.
+      #
+      #   @param remarks [String, nil] Any additional remarks or notes associated with the payout.
 
       # @see Dodopayments::Models::PayoutListResponse#currency
       module Currency

data/lib/dodopayments/models/price.rb

@@ -67,13 +67,24 @@ module Dodopayments
         optional :tax_inclusive, Dodopayments::Internal::Type::Boolean, nil?: true
 
         # @!method initialize(currency:, discount:, price:, purchasing_power_parity:, pay_what_you_want: nil, suggested_price: nil, tax_inclusive: nil, type: :one_time_price)
+        #   Some parameter documentations has been truncated, see
+        #   {Dodopayments::Models::Price::OneTimePrice} for more details.
+        #
         #   @param currency [Symbol, Dodopayments::Models::Price::OneTimePrice::Currency]
-        #   @param discount [Float]
-        #   @param price [Integer]
-        #   @param purchasing_power_parity [Boolean]
-        #   @param pay_what_you_want [Boolean]
-        #   @param suggested_price [Integer, nil]
-        #   @param tax_inclusive [Boolean, nil]
+        #
+        #   @param discount [Float] Discount applied to the price, represented as a percentage (0 to 100).
+        #
+        #   @param price [Integer] The payment amount, in the smallest denomination of the currency (e.g., cents fo
+        #   ...
+        #
+        #   @param purchasing_power_parity [Boolean] Indicates if purchasing power parity adjustments are applied to the price. ...
+        #
+        #   @param pay_what_you_want [Boolean] Indicates whether the customer can pay any amount they choose. ...
+        #
+        #   @param suggested_price [Integer, nil] A suggested price for the user to pay. This value is only considered if ...
+        #
+        #   @param tax_inclusive [Boolean, nil] Indicates if the price is tax inclusive.
+        #
         #   @param type [Symbol, :one_time_price]
 
         # @see Dodopayments::Models::Price::OneTimePrice#currency
@@ -299,16 +310,30 @@ module Dodopayments
         optional :trial_period_days, Integer
 
         # @!method initialize(currency:, discount:, payment_frequency_count:, payment_frequency_interval:, price:, purchasing_power_parity:, subscription_period_count:, subscription_period_interval:, tax_inclusive: nil, trial_period_days: nil, type: :recurring_price)
+        #   Some parameter documentations has been truncated, see
+        #   {Dodopayments::Models::Price::RecurringPrice} for more details.
+        #
         #   @param currency [Symbol, Dodopayments::Models::Price::RecurringPrice::Currency]
-        #   @param discount [Float]
-        #   @param payment_frequency_count [Integer]
+        #
+        #   @param discount [Float] Discount applied to the price, represented as a percentage (0 to 100).
+        #
+        #   @param payment_frequency_count [Integer] Number of units for the payment frequency. ...
+        #
         #   @param payment_frequency_interval [Symbol, Dodopayments::Models::TimeInterval]
-        #   @param price [Integer]
-        #   @param purchasing_power_parity [Boolean]
-        #   @param subscription_period_count [Integer]
+        #
+        #   @param price [Integer] The payment amount. Represented in the lowest denomination of the currency (e.g.
+        #   ...
+        #
+        #   @param purchasing_power_parity [Boolean] Indicates if purchasing power parity adjustments are applied to the price. ...
+        #
+        #   @param subscription_period_count [Integer] Number of units for the subscription period. ...
+        #
         #   @param subscription_period_interval [Symbol, Dodopayments::Models::TimeInterval]
-        #   @param tax_inclusive [Boolean, nil]
-        #   @param trial_period_days [Integer]
+        #
+        #   @param tax_inclusive [Boolean, nil] Indicates if the price is tax inclusive
+        #
+        #   @param trial_period_days [Integer] Number of days for the trial period. A value of `0` indicates no trial period.
+        #
         #   @param type [Symbol, :recurring_price]
 
         # @see Dodopayments::Models::Price::RecurringPrice#currency

data/lib/dodopayments/models/product.rb

@@ -94,21 +94,39 @@ module Dodopayments
       optional :name, String, nil?: true
 
       # @!method initialize(business_id:, created_at:, is_recurring:, license_key_enabled:, price:, product_id:, tax_category:, updated_at:, addons: nil, description: nil, image: nil, license_key_activation_message: nil, license_key_activations_limit: nil, license_key_duration: nil, name: nil)
-      #   @param business_id [String]
-      #   @param created_at [Time]
-      #   @param is_recurring [Boolean]
-      #   @param license_key_enabled [Boolean]
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::Product} for more details.
+      #
+      #   @param business_id [String] Unique identifier for the business to which the product belongs.
+      #
+      #   @param created_at [Time] Timestamp when the product was created.
+      #
+      #   @param is_recurring [Boolean] Indicates if the product is recurring (e.g., subscriptions).
+      #
+      #   @param license_key_enabled [Boolean] Indicates whether the product requires a license key.
+      #
       #   @param price [Dodopayments::Models::Price::OneTimePrice, Dodopayments::Models::Price::RecurringPrice]
-      #   @param product_id [String]
-      #   @param tax_category [Symbol, Dodopayments::Models::Product::TaxCategory]
-      #   @param updated_at [Time]
-      #   @param addons [Array<String>, nil]
-      #   @param description [String, nil]
-      #   @param image [String, nil]
-      #   @param license_key_activation_message [String, nil]
-      #   @param license_key_activations_limit [Integer, nil]
+      #
+      #   @param product_id [String] Unique identifier for the product.
+      #
+      #   @param tax_category [Symbol, Dodopayments::Models::Product::TaxCategory] Represents the different categories of taxation applicable to various products a
+      #   ...
+      #
+      #   @param updated_at [Time] Timestamp when the product was last updated.
+      #
+      #   @param addons [Array<String>, nil] Available Addons for subscription products
+      #
+      #   @param description [String, nil] Description of the product, optional.
+      #
+      #   @param image [String, nil] URL of the product image, optional.
+      #
+      #   @param license_key_activation_message [String, nil] Message sent upon license key activation, if applicable.
+      #
+      #   @param license_key_activations_limit [Integer, nil] Limit on the number of activations for the license key, if enabled.
+      #
       #   @param license_key_duration [Dodopayments::Models::LicenseKeyDuration, nil]
-      #   @param name [String, nil]
+      #
+      #   @param name [String, nil] Name of the product, optional.
 
       # Represents the different categories of taxation applicable to various products
       # and services.

data/lib/dodopayments/models/product_create_params.rb

@@ -61,15 +61,28 @@ module Dodopayments
       optional :name, String, nil?: true
 
       # @!method initialize(price:, tax_category:, addons: nil, description: nil, license_key_activation_message: nil, license_key_activations_limit: nil, license_key_duration: nil, license_key_enabled: nil, name: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::ProductCreateParams} for more details.
+      #
       #   @param price [Dodopayments::Models::Price::OneTimePrice, Dodopayments::Models::Price::RecurringPrice]
-      #   @param tax_category [Symbol, Dodopayments::Models::ProductCreateParams::TaxCategory]
-      #   @param addons [Array<String>, nil]
-      #   @param description [String, nil]
-      #   @param license_key_activation_message [String, nil]
-      #   @param license_key_activations_limit [Integer, nil]
+      #
+      #   @param tax_category [Symbol, Dodopayments::Models::ProductCreateParams::TaxCategory] Represents the different categories of taxation applicable to various products a
+      #   ...
+      #
+      #   @param addons [Array<String>, nil] Addons available for subscription product
+      #
+      #   @param description [String, nil] Optional description of the product
+      #
+      #   @param license_key_activation_message [String, nil] Optional message displayed during license key activation
+      #
+      #   @param license_key_activations_limit [Integer, nil] The number of times the license key can be activated. ...
+      #
       #   @param license_key_duration [Dodopayments::Models::LicenseKeyDuration, nil]
-      #   @param license_key_enabled [Boolean, nil]
-      #   @param name [String, nil]
+      #
+      #   @param license_key_enabled [Boolean, nil] When true, generates and sends a license key to your customer. ...
+      #
+      #   @param name [String, nil] Optional name of the product
+      #
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
 
       # Represents the different categories of taxation applicable to various products

data/lib/dodopayments/models/product_list_params.rb

@@ -36,10 +36,17 @@ module Dodopayments
       optional :recurring, Dodopayments::Internal::Type::Boolean, nil?: true
 
       # @!method initialize(archived: nil, page_number: nil, page_size: nil, recurring: nil, request_options: {})
-      #   @param archived [Boolean]
-      #   @param page_number [Integer, nil]
-      #   @param page_size [Integer, nil]
-      #   @param recurring [Boolean, nil]
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::ProductListParams} for more details.
+      #
+      #   @param archived [Boolean] List archived products
+      #
+      #   @param page_number [Integer, nil] Page number default is 0
+      #
+      #   @param page_size [Integer, nil] Page size default is 10 max is 100
+      #
+      #   @param recurring [Boolean, nil] Filter products by pricing type: ...
+      #
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/dodopayments/models/product_list_response.rb

@@ -91,19 +91,35 @@ module Dodopayments
       optional :tax_inclusive, Dodopayments::Internal::Type::Boolean, nil?: true
 
       # @!method initialize(business_id:, created_at:, is_recurring:, product_id:, tax_category:, updated_at:, currency: nil, description: nil, image: nil, name: nil, price: nil, price_detail: nil, tax_inclusive: nil)
-      #   @param business_id [String]
-      #   @param created_at [Time]
-      #   @param is_recurring [Boolean]
-      #   @param product_id [String]
-      #   @param tax_category [Symbol, Dodopayments::Models::ProductListResponse::TaxCategory]
-      #   @param updated_at [Time]
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::ProductListResponse} for more details.
+      #
+      #   @param business_id [String] Unique identifier for the business to which the product belongs.
+      #
+      #   @param created_at [Time] Timestamp when the product was created.
+      #
+      #   @param is_recurring [Boolean] Indicates if the product is recurring (e.g., subscriptions).
+      #
+      #   @param product_id [String] Unique identifier for the product.
+      #
+      #   @param tax_category [Symbol, Dodopayments::Models::ProductListResponse::TaxCategory] Represents the different categories of taxation applicable to various products a
+      #   ...
+      #
+      #   @param updated_at [Time] Timestamp when the product was last updated.
+      #
       #   @param currency [Symbol, Dodopayments::Models::ProductListResponse::Currency, nil]
-      #   @param description [String, nil]
-      #   @param image [String, nil]
-      #   @param name [String, nil]
-      #   @param price [Integer, nil]
+      #
+      #   @param description [String, nil] Description of the product, optional.
+      #
+      #   @param image [String, nil] URL of the product image, optional.
+      #
+      #   @param name [String, nil] Name of the product, optional.
+      #
+      #   @param price [Integer, nil] Price of the product, optional. ...
+      #
       #   @param price_detail [Dodopayments::Models::Price::OneTimePrice, Dodopayments::Models::Price::RecurringPrice, nil]
-      #   @param tax_inclusive [Boolean, nil]
+      #
+      #   @param tax_inclusive [Boolean, nil] Indicates if the price is tax inclusive
 
       # Represents the different categories of taxation applicable to various products
       # and services.

data/lib/dodopayments/models/product_update_params.rb

@@ -76,16 +76,30 @@ module Dodopayments
       optional :tax_category, enum: -> { Dodopayments::Models::ProductUpdateParams::TaxCategory }, nil?: true
 
       # @!method initialize(addons: nil, description: nil, image_id: nil, license_key_activation_message: nil, license_key_activations_limit: nil, license_key_duration: nil, license_key_enabled: nil, name: nil, price: nil, tax_category: nil, request_options: {})
-      #   @param addons [Array<String>, nil]
-      #   @param description [String, nil]
-      #   @param image_id [String, nil]
-      #   @param license_key_activation_message [String, nil]
-      #   @param license_key_activations_limit [Integer, nil]
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::ProductUpdateParams} for more details.
+      #
+      #   @param addons [Array<String>, nil] Available Addons for subscription products
+      #
+      #   @param description [String, nil] Description of the product, optional and must be at most 1000 characters.
+      #
+      #   @param image_id [String, nil] Product image id after its uploaded to S3
+      #
+      #   @param license_key_activation_message [String, nil] Message sent to the customer upon license key activation. ...
+      #
+      #   @param license_key_activations_limit [Integer, nil] Limit for the number of activations for the license key. ...
+      #
       #   @param license_key_duration [Dodopayments::Models::LicenseKeyDuration, nil]
-      #   @param license_key_enabled [Boolean, nil]
-      #   @param name [String, nil]
+      #
+      #   @param license_key_enabled [Boolean, nil] Whether the product requires a license key. ...
+      #
+      #   @param name [String, nil] Name of the product, optional and must be at most 100 characters.
+      #
       #   @param price [Dodopayments::Models::Price::OneTimePrice, Dodopayments::Models::Price::RecurringPrice, nil]
-      #   @param tax_category [Symbol, Dodopayments::Models::ProductUpdateParams::TaxCategory, nil]
+      #
+      #   @param tax_category [Symbol, Dodopayments::Models::ProductUpdateParams::TaxCategory, nil] Represents the different categories of taxation applicable to various products a
+      #   ...
+      #
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
 
       # Represents the different categories of taxation applicable to various products