dodopayments 2.9.1 → 2.11.0

data/lib/dodopayments/models/payment_cancelled_webhook_event.rb

@@ -23,29 +23,17 @@ module Dodopayments
       # @!attribute type
       #   The event type
       #
-      #   @return [Symbol, Dodopayments::Models::PaymentCancelledWebhookEvent::Type]
-      required :type, enum: -> { Dodopayments::PaymentCancelledWebhookEvent::Type }
+      #   @return [Symbol, :"payment.cancelled"]
+      required :type, const: :"payment.cancelled"
 
-      # @!method initialize(business_id:, data:, timestamp:, type:)
+      # @!method initialize(business_id:, data:, timestamp:, type: :"payment.cancelled")
       #   @param business_id [String] The business identifier
       #
       #   @param data [Dodopayments::Models::Payment]
       #
       #   @param timestamp [Time] The timestamp of when the event occurred
       #
-      #   @param type [Symbol, Dodopayments::Models::PaymentCancelledWebhookEvent::Type] The event type
-
-      # The event type
-      #
-      # @see Dodopayments::Models::PaymentCancelledWebhookEvent#type
-      module Type
-        extend Dodopayments::Internal::Type::Enum
-
-        PAYMENT_CANCELLED = :"payment.cancelled"
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
+      #   @param type [Symbol, :"payment.cancelled"] The event type
     end
   end
 end

data/lib/dodopayments/models/payment_create_params.rb

@@ -52,12 +52,30 @@ module Dodopayments
       #   @return [Symbol, Dodopayments::Models::Currency, nil]
       optional :billing_currency, enum: -> { Dodopayments::Currency }, nil?: true
 
+      # @!attribute customer_business_name
+      #   Optional business / legal name associated with the tax id. When provided
+      #   together with a valid tax id for a B2B purchase, this name is rendered on the
+      #   invoice instead of the customer's personal name.
+      #
+      #   @return [String, nil]
+      optional :customer_business_name, String, nil?: true
+
       # @!attribute discount_code
-      #   Discount Code to apply to the transaction
+      #   @deprecated Use `discount_id` instead.
+      #
+      #   DEPRECATED: Use discount_codes instead. Cannot be used together with
+      #   discount_codes.
       #
       #   @return [String, nil]
       optional :discount_code, String, nil?: true
 
+      # @!attribute discount_codes
+      #   Stacked discount codes to apply, in order of application. Max 20. Cannot be used
+      #   together with discount_code.
+      #
+      #   @return [Array<String>, nil]
+      optional :discount_codes, Dodopayments::Internal::Type::ArrayOf[String], nil?: true
+
       # @!attribute force_3ds
       #   Override merchant default 3DS behaviour for this payment
       #
@@ -126,7 +144,7 @@ module Dodopayments
       #   @return [String, nil]
       optional :tax_id, String, nil?: true
 
-      # @!method initialize(billing:, customer:, product_cart:, adaptive_currency_fees_inclusive: nil, allowed_payment_method_types: nil, billing_currency: nil, discount_code: nil, force_3ds: nil, metadata: nil, payment_link: nil, payment_method_id: nil, redirect_immediately: nil, require_phone_number: nil, return_url: nil, short_link: nil, show_saved_payment_methods: nil, tax_id: nil, request_options: {})
+      # @!method initialize(billing:, customer:, product_cart:, adaptive_currency_fees_inclusive: nil, allowed_payment_method_types: nil, billing_currency: nil, customer_business_name: nil, discount_code: nil, discount_codes: nil, force_3ds: nil, metadata: nil, payment_link: nil, payment_method_id: nil, redirect_immediately: nil, require_phone_number: nil, return_url: nil, short_link: nil, show_saved_payment_methods: nil, tax_id: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Dodopayments::Models::PaymentCreateParams} for more details.
       #
@@ -142,7 +160,11 @@ module Dodopayments
       #
       #   @param billing_currency [Symbol, Dodopayments::Models::Currency, nil] Fix the currency in which the end customer is billed.
       #
-      #   @param discount_code [String, nil] Discount Code to apply to the transaction
+      #   @param customer_business_name [String, nil] Optional business / legal name associated with the tax id. When provided
+      #
+      #   @param discount_code [String, nil] DEPRECATED: Use discount_codes instead. Cannot be used together with discount_co
+      #
+      #   @param discount_codes [Array<String>, nil] Stacked discount codes to apply, in order of application. Max 20.
       #
       #   @param force_3ds [Boolean, nil] Override merchant default 3DS behaviour for this payment
       #

data/lib/dodopayments/models/payment_create_response.rb

@@ -36,11 +36,20 @@ module Dodopayments
       required :total_amount, Integer
 
       # @!attribute discount_id
-      #   The discount id if discount is applied
+      #   @deprecated Use `discounts` instead.
+      #
+      #   DEPRECATED: Use discount_ids instead. Returns the first discount's ID if
+      #   present.
       #
       #   @return [String, nil]
       optional :discount_id, String, nil?: true
 
+      # @!attribute discount_ids
+      #   All stacked discount IDs applied, in order of application
+      #
+      #   @return [Array<String>, nil]
+      optional :discount_ids, Dodopayments::Internal::Type::ArrayOf[String], nil?: true
+
       # @!attribute expires_on
       #   Expiry timestamp of the payment link
       #
@@ -61,7 +70,7 @@ module Dodopayments
                -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::OneTimeProductCartItem] },
                nil?: true
 
-      # @!method initialize(client_secret:, customer:, metadata:, payment_id:, total_amount:, discount_id: nil, expires_on: nil, payment_link: nil, product_cart: nil)
+      # @!method initialize(client_secret:, customer:, metadata:, payment_id:, total_amount:, discount_id: nil, discount_ids: nil, expires_on: nil, payment_link: nil, product_cart: nil)
       #   Some parameter documentations has been truncated, see
       #   {Dodopayments::Models::PaymentCreateResponse} for more details.
       #
@@ -75,7 +84,9 @@ module Dodopayments
       #
       #   @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 discount_id [String, nil] DEPRECATED: Use discount_ids instead. Returns the first discount's ID if present
+      #
+      #   @param discount_ids [Array<String>, nil] All stacked discount IDs applied, in order of application
       #
       #   @param expires_on [Time, nil] Expiry timestamp of the payment link
       #

data/lib/dodopayments/models/payment_failed_webhook_event.rb

@@ -23,29 +23,17 @@ module Dodopayments
       # @!attribute type
       #   The event type
       #
-      #   @return [Symbol, Dodopayments::Models::PaymentFailedWebhookEvent::Type]
-      required :type, enum: -> { Dodopayments::PaymentFailedWebhookEvent::Type }
+      #   @return [Symbol, :"payment.failed"]
+      required :type, const: :"payment.failed"
 
-      # @!method initialize(business_id:, data:, timestamp:, type:)
+      # @!method initialize(business_id:, data:, timestamp:, type: :"payment.failed")
       #   @param business_id [String] The business identifier
       #
       #   @param data [Dodopayments::Models::Payment]
       #
       #   @param timestamp [Time] The timestamp of when the event occurred
       #
-      #   @param type [Symbol, Dodopayments::Models::PaymentFailedWebhookEvent::Type] The event type
-
-      # The event type
-      #
-      # @see Dodopayments::Models::PaymentFailedWebhookEvent#type
-      module Type
-        extend Dodopayments::Internal::Type::Enum
-
-        PAYMENT_FAILED = :"payment.failed"
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
+      #   @param type [Symbol, :"payment.failed"] The event type
     end
   end
 end

data/lib/dodopayments/models/payment_method_types.rb

@@ -85,6 +85,7 @@ module Dodopayments
       SEPA = :sepa
       SEPA_BANK_TRANSFER = :sepa_bank_transfer
       SOFORT = :sofort
+      SUNBIT = :sunbit
       SWISH = :swish
       TOUCH_N_GO = :touch_n_go
       TRUSTLY = :trustly

data/lib/dodopayments/models/payment_processing_webhook_event.rb

@@ -23,29 +23,17 @@ module Dodopayments
       # @!attribute type
       #   The event type
       #
-      #   @return [Symbol, Dodopayments::Models::PaymentProcessingWebhookEvent::Type]
-      required :type, enum: -> { Dodopayments::PaymentProcessingWebhookEvent::Type }
+      #   @return [Symbol, :"payment.processing"]
+      required :type, const: :"payment.processing"
 
-      # @!method initialize(business_id:, data:, timestamp:, type:)
+      # @!method initialize(business_id:, data:, timestamp:, type: :"payment.processing")
       #   @param business_id [String] The business identifier
       #
       #   @param data [Dodopayments::Models::Payment]
       #
       #   @param timestamp [Time] The timestamp of when the event occurred
       #
-      #   @param type [Symbol, Dodopayments::Models::PaymentProcessingWebhookEvent::Type] The event type
-
-      # The event type
-      #
-      # @see Dodopayments::Models::PaymentProcessingWebhookEvent#type
-      module Type
-        extend Dodopayments::Internal::Type::Enum
-
-        PAYMENT_PROCESSING = :"payment.processing"
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
+      #   @param type [Symbol, :"payment.processing"] The event type
     end
   end
 end

data/lib/dodopayments/models/payment_succeeded_webhook_event.rb

@@ -23,29 +23,17 @@ module Dodopayments
       # @!attribute type
       #   The event type
       #
-      #   @return [Symbol, Dodopayments::Models::PaymentSucceededWebhookEvent::Type]
-      required :type, enum: -> { Dodopayments::PaymentSucceededWebhookEvent::Type }
+      #   @return [Symbol, :"payment.succeeded"]
+      required :type, const: :"payment.succeeded"
 
-      # @!method initialize(business_id:, data:, timestamp:, type:)
+      # @!method initialize(business_id:, data:, timestamp:, type: :"payment.succeeded")
       #   @param business_id [String] The business identifier
       #
       #   @param data [Dodopayments::Models::Payment]
       #
       #   @param timestamp [Time] The timestamp of when the event occurred
       #
-      #   @param type [Symbol, Dodopayments::Models::PaymentSucceededWebhookEvent::Type] The event type
-
-      # The event type
-      #
-      # @see Dodopayments::Models::PaymentSucceededWebhookEvent#type
-      module Type
-        extend Dodopayments::Internal::Type::Enum
-
-        PAYMENT_SUCCEEDED = :"payment.succeeded"
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
+      #   @param type [Symbol, :"payment.succeeded"] The event type
     end
   end
 end

data/lib/dodopayments/models/payout_list_response.rb

@@ -17,7 +17,8 @@ module Dodopayments
       required :business_id, String
 
       # @!attribute chargebacks
-      #   @deprecated
+      #   @deprecated Use the v3 payout breakup endpoints instead. Will be removed in a future
+      #   release.
       #
       #   The total value of chargebacks associated with the payout.
       #
@@ -55,7 +56,8 @@ module Dodopayments
       required :payout_id, String
 
       # @!attribute refunds
-      #   @deprecated
+      #   @deprecated Use the v3 payout breakup endpoints instead. Will be removed in a future
+      #   release.
       #
       #   The total value of refunds associated with the payout.
       #
@@ -69,7 +71,8 @@ module Dodopayments
       required :status, enum: -> { Dodopayments::Models::PayoutListResponse::Status }
 
       # @!attribute tax
-      #   @deprecated
+      #   @deprecated Use the v3 payout breakup endpoints instead. Will be removed in a future
+      #   release.
       #
       #   The tax applied to the payout.
       #

data/lib/dodopayments/models/price.rb

@@ -6,14 +6,16 @@ module Dodopayments
     module Price
       extend Dodopayments::Internal::Type::Union
 
+      discriminator :type
+
       # One-time price details.
-      variant -> { Dodopayments::Price::OneTimePrice }
+      variant :one_time_price, -> { Dodopayments::Price::OneTimePrice }
 
       # Recurring price details.
-      variant -> { Dodopayments::Price::RecurringPrice }
+      variant :recurring_price, -> { Dodopayments::Price::RecurringPrice }
 
       # Usage Based price details.
-      variant -> { Dodopayments::Price::UsageBasedPrice }
+      variant :usage_based_price, -> { Dodopayments::Price::UsageBasedPrice }
 
       class OneTimePrice < Dodopayments::Internal::Type::BaseModel
         # @!attribute currency
@@ -47,8 +49,8 @@ module Dodopayments
 
         # @!attribute type
         #
-        #   @return [Symbol, Dodopayments::Models::Price::OneTimePrice::Type]
-        required :type, enum: -> { Dodopayments::Price::OneTimePrice::Type }
+        #   @return [Symbol, :one_time_price]
+        required :type, const: :one_time_price
 
         # @!attribute pay_what_you_want
         #   Indicates whether the customer can pay any amount they choose. If set to `true`,
@@ -71,7 +73,7 @@ module Dodopayments
         #   @return [Boolean, nil]
         optional :tax_inclusive, Dodopayments::Internal::Type::Boolean, nil?: true
 
-        # @!method initialize(currency:, discount:, price:, purchasing_power_parity:, type:, pay_what_you_want: nil, suggested_price: nil, tax_inclusive: nil)
+        # @!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.
         #
@@ -85,23 +87,13 @@ module Dodopayments
         #
         #   @param purchasing_power_parity [Boolean] Indicates if purchasing power parity adjustments are applied to the price.
         #
-        #   @param type [Symbol, Dodopayments::Models::Price::OneTimePrice::Type]
-        #
         #   @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.
-
-        # @see Dodopayments::Models::Price::OneTimePrice#type
-        module Type
-          extend Dodopayments::Internal::Type::Enum
-
-          ONE_TIME_PRICE = :one_time_price
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
+        #
+        #   @param type [Symbol, :one_time_price]
       end
 
       class RecurringPrice < Dodopayments::Internal::Type::BaseModel
@@ -159,8 +151,8 @@ module Dodopayments
 
         # @!attribute type
         #
-        #   @return [Symbol, Dodopayments::Models::Price::RecurringPrice::Type]
-        required :type, enum: -> { Dodopayments::Price::RecurringPrice::Type }
+        #   @return [Symbol, :recurring_price]
+        required :type, const: :recurring_price
 
         # @!attribute tax_inclusive
         #   Indicates if the price is tax inclusive
@@ -174,7 +166,7 @@ module Dodopayments
         #   @return [Integer, nil]
         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:, type:, tax_inclusive: nil, trial_period_days: nil)
+        # @!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.
         #
@@ -196,21 +188,11 @@ module Dodopayments
         #
         #   @param subscription_period_interval [Symbol, Dodopayments::Models::TimeInterval] The time interval for the subscription period (e.g., day, month, year).
         #
-        #   @param type [Symbol, Dodopayments::Models::Price::RecurringPrice::Type]
-        #
         #   @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.
-
-        # @see Dodopayments::Models::Price::RecurringPrice#type
-        module Type
-          extend Dodopayments::Internal::Type::Enum
-
-          RECURRING_PRICE = :recurring_price
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
+        #
+        #   @param type [Symbol, :recurring_price]
       end
 
       class UsageBasedPrice < Dodopayments::Internal::Type::BaseModel
@@ -268,8 +250,8 @@ module Dodopayments
 
         # @!attribute type
         #
-        #   @return [Symbol, Dodopayments::Models::Price::UsageBasedPrice::Type]
-        required :type, enum: -> { Dodopayments::Price::UsageBasedPrice::Type }
+        #   @return [Symbol, :usage_based_price]
+        required :type, const: :usage_based_price
 
         # @!attribute meters
         #
@@ -286,7 +268,7 @@ module Dodopayments
         #   @return [Boolean, nil]
         optional :tax_inclusive, Dodopayments::Internal::Type::Boolean, nil?: true
 
-        # @!method initialize(currency:, discount:, fixed_price:, payment_frequency_count:, payment_frequency_interval:, purchasing_power_parity:, subscription_period_count:, subscription_period_interval:, type:, meters: nil, tax_inclusive: nil)
+        # @!method initialize(currency:, discount:, fixed_price:, payment_frequency_count:, payment_frequency_interval:, purchasing_power_parity:, subscription_period_count:, subscription_period_interval:, meters: nil, tax_inclusive: nil, type: :usage_based_price)
         #   Some parameter documentations has been truncated, see
         #   {Dodopayments::Models::Price::UsageBasedPrice} for more details.
         #
@@ -308,21 +290,11 @@ module Dodopayments
         #
         #   @param subscription_period_interval [Symbol, Dodopayments::Models::TimeInterval] The time interval for the subscription period (e.g., day, month, year).
         #
-        #   @param type [Symbol, Dodopayments::Models::Price::UsageBasedPrice::Type]
-        #
         #   @param meters [Array<Dodopayments::Models::AddMeterToPrice>, nil]
         #
         #   @param tax_inclusive [Boolean, nil] Indicates if the price is tax inclusive
-
-        # @see Dodopayments::Models::Price::UsageBasedPrice#type
-        module Type
-          extend Dodopayments::Internal::Type::Enum
-
-          USAGE_BASED_PRICE = :usage_based_price
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
+        #
+        #   @param type [Symbol, :usage_based_price]
       end
 
       # @!method self.variants

data/lib/dodopayments/models/product.rb

@@ -42,7 +42,7 @@ module Dodopayments
       required :is_recurring, Dodopayments::Internal::Type::Boolean
 
       # @!attribute license_key_enabled
-      #   @deprecated
+      #   @deprecated Use the dedicated entitlements API to configure license-key delivery.
       #
       #   Indicates whether the product requires a license key.
       #
@@ -105,7 +105,7 @@ module Dodopayments
       optional :image, String, nil?: true
 
       # @!attribute license_key_activation_message
-      #   @deprecated
+      #   @deprecated Use the dedicated entitlements API to configure license-key delivery.
       #
       #   Message sent upon license key activation, if applicable.
       #
@@ -113,7 +113,7 @@ module Dodopayments
       optional :license_key_activation_message, String, nil?: true
 
       # @!attribute license_key_activations_limit
-      #   @deprecated
+      #   @deprecated Use the dedicated entitlements API to configure license-key delivery.
       #
       #   Limit on the number of activations for the license key, if enabled.
       #

data/lib/dodopayments/models/product_collection.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::ProductCollections#create
+    class ProductCollection < Dodopayments::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique identifier for the product collection
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute brand_id
+      #   Brand ID for the collection
+      #
+      #   @return [String]
+      required :brand_id, String
+
+      # @!attribute created_at
+      #   Timestamp when the collection was created
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute groups
+      #   Groups in this collection
+      #
+      #   @return [Array<Dodopayments::Models::ProductCollections::ProductCollectionGroupResponse>]
+      required :groups,
+               -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::ProductCollections::ProductCollectionGroupResponse] }
+
+      # @!attribute name
+      #   Name of the collection
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute updated_at
+      #   Timestamp when the collection was last updated
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!attribute description
+      #   Description of the collection
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!attribute image
+      #   URL of the collection image
+      #
+      #   @return [String, nil]
+      optional :image, String, nil?: true
+
+      # @!method initialize(id:, brand_id:, created_at:, groups:, name:, updated_at:, description: nil, image: nil)
+      #   @param id [String] Unique identifier for the product collection
+      #
+      #   @param brand_id [String] Brand ID for the collection
+      #
+      #   @param created_at [Time] Timestamp when the collection was created
+      #
+      #   @param groups [Array<Dodopayments::Models::ProductCollections::ProductCollectionGroupResponse>] Groups in this collection
+      #
+      #   @param name [String] Name of the collection
+      #
+      #   @param updated_at [Time] Timestamp when the collection was last updated
+      #
+      #   @param description [String, nil] Description of the collection
+      #
+      #   @param image [String, nil] URL of the collection image
+    end
+  end
+end

data/lib/dodopayments/models/product_collection_create_params.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::ProductCollections#create
+    class ProductCollectionCreateParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      # @!attribute groups
+      #   Groups of products in this collection
+      #
+      #   @return [Array<Dodopayments::Models::ProductCollections::ProductCollectionGroupDetails>]
+      required :groups,
+               -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::ProductCollections::ProductCollectionGroupDetails] }
+
+      # @!attribute name
+      #   Name of the product collection
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute brand_id
+      #   Brand id for the collection, if not provided will default to primary brand
+      #
+      #   @return [String, nil]
+      optional :brand_id, String, nil?: true
+
+      # @!attribute description
+      #   Optional description of the product collection
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!method initialize(groups:, name:, brand_id: nil, description: nil, request_options: {})
+      #   @param groups [Array<Dodopayments::Models::ProductCollections::ProductCollectionGroupDetails>] Groups of products in this collection
+      #
+      #   @param name [String] Name of the product collection
+      #
+      #   @param brand_id [String, nil] Brand id for the collection, if not provided will default to primary brand
+      #
+      #   @param description [String, nil] Optional description of the product collection
+      #
+      #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/dodopayments/models/product_collection_delete_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::ProductCollections#delete
+    class ProductCollectionDeleteParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String]
+      #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/dodopayments/models/product_collection_list_params.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::ProductCollections#list
+    class ProductCollectionListParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      # @!attribute archived
+      #   List archived collections
+      #
+      #   @return [Boolean, nil]
+      optional :archived, Dodopayments::Internal::Type::Boolean
+
+      # @!attribute brand_id
+      #   Filter by Brand id
+      #
+      #   @return [String, nil]
+      optional :brand_id, String
+
+      # @!attribute page_number
+      #   Page number default is 0
+      #
+      #   @return [Integer, nil]
+      optional :page_number, Integer
+
+      # @!attribute page_size
+      #   Page size default is 10 max is 100
+      #
+      #   @return [Integer, nil]
+      optional :page_size, Integer
+
+      # @!method initialize(archived: nil, brand_id: nil, page_number: nil, page_size: nil, request_options: {})
+      #   @param archived [Boolean] List archived collections
+      #
+      #   @param brand_id [String] Filter by Brand id
+      #
+      #   @param page_number [Integer] Page number default is 0
+      #
+      #   @param page_size [Integer] Page size default is 10 max is 100
+      #
+      #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end