dodopayments 1.20.0 → 1.47.0

data/lib/dodopayments/models/payment_list_params.rb

@@ -7,64 +7,92 @@ module Dodopayments
       extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 
+      # @!attribute brand_id
+      #   filter by Brand id
+      #
+      #   @return [String, nil]
+      optional :brand_id, String
+
       # @!attribute created_at_gte
       #   Get events after this created time
       #
       #   @return [Time, nil]
-      optional :created_at_gte, Time, nil?: true
+      optional :created_at_gte, Time
 
       # @!attribute created_at_lte
       #   Get events created before this time
       #
       #   @return [Time, nil]
-      optional :created_at_lte, Time, nil?: true
+      optional :created_at_lte, Time
 
       # @!attribute customer_id
       #   Filter by customer id
       #
       #   @return [String, nil]
-      optional :customer_id, String, nil?: true
+      optional :customer_id, String
 
       # @!attribute page_number
       #   Page number default is 0
       #
       #   @return [Integer, nil]
-      optional :page_number, Integer, nil?: true
+      optional :page_number, Integer
 
       # @!attribute page_size
       #   Page size default is 10 max is 100
       #
       #   @return [Integer, nil]
-      optional :page_size, Integer, nil?: true
+      optional :page_size, Integer
 
       # @!attribute status
       #   Filter by status
       #
-      #   @return [Symbol, Dodopayments::Models::IntentStatus, nil]
-      optional :status, enum: -> { Dodopayments::Models::IntentStatus }, nil?: true
+      #   @return [Symbol, Dodopayments::Models::PaymentListParams::Status, nil]
+      optional :status, enum: -> { Dodopayments::PaymentListParams::Status }
 
       # @!attribute subscription_id
       #   Filter by subscription id
       #
       #   @return [String, nil]
-      optional :subscription_id, String, nil?: true
+      optional :subscription_id, String
 
-      # @!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] Get events after this created time
+      # @!method initialize(brand_id: nil, 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 brand_id [String] filter by Brand id
+      #
+      #   @param created_at_gte [Time] Get events after this created time
       #
-      #   @param created_at_lte [Time, nil] Get events created before this time
+      #   @param created_at_lte [Time] Get events created before this time
       #
-      #   @param customer_id [String, nil] Filter by customer id
+      #   @param customer_id [String] Filter by customer id
       #
-      #   @param page_number [Integer, nil] Page number default is 0
+      #   @param page_number [Integer] Page number default is 0
       #
-      #   @param page_size [Integer, nil] Page size default is 10 max is 100
+      #   @param page_size [Integer] Page size default is 10 max is 100
       #
-      #   @param status [Symbol, Dodopayments::Models::IntentStatus, nil] Filter by status
+      #   @param status [Symbol, Dodopayments::Models::PaymentListParams::Status] Filter by status
       #
-      #   @param subscription_id [String, nil] Filter by subscription id
+      #   @param subscription_id [String] Filter by subscription id
       #
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+
+      # Filter by status
+      module Status
+        extend Dodopayments::Internal::Type::Enum
+
+        SUCCEEDED = :succeeded
+        FAILED = :failed
+        CANCELLED = :cancelled
+        PROCESSING = :processing
+        REQUIRES_CUSTOMER_ACTION = :requires_customer_action
+        REQUIRES_MERCHANT_ACTION = :requires_merchant_action
+        REQUIRES_PAYMENT_METHOD = :requires_payment_method
+        REQUIRES_CONFIRMATION = :requires_confirmation
+        REQUIRES_CAPTURE = :requires_capture
+        PARTIALLY_CAPTURED = :partially_captured
+        PARTIALLY_CAPTURED_AND_CAPTURABLE = :partially_captured_and_capturable
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
     end
   end
 end

data/lib/dodopayments/models/payment_list_response.rb

@@ -4,6 +4,11 @@ module Dodopayments
   module Models
     # @see Dodopayments::Resources::Payments#list
     class PaymentListResponse < Dodopayments::Internal::Type::BaseModel
+      # @!attribute brand_id
+      #
+      #   @return [String]
+      required :brand_id, String
+
       # @!attribute created_at
       #
       #   @return [Time]
@@ -12,12 +17,17 @@ module Dodopayments
       # @!attribute currency
       #
       #   @return [Symbol, Dodopayments::Models::Currency]
-      required :currency, enum: -> { Dodopayments::Models::Currency }
+      required :currency, enum: -> { Dodopayments::Currency }
 
       # @!attribute customer
       #
       #   @return [Dodopayments::Models::CustomerLimitedDetails]
-      required :customer, -> { Dodopayments::Models::CustomerLimitedDetails }
+      required :customer, -> { Dodopayments::CustomerLimitedDetails }
+
+      # @!attribute digital_products_delivered
+      #
+      #   @return [Boolean]
+      required :digital_products_delivered, Dodopayments::Internal::Type::Boolean
 
       # @!attribute metadata
       #
@@ -47,17 +57,19 @@ module Dodopayments
       # @!attribute status
       #
       #   @return [Symbol, Dodopayments::Models::IntentStatus, nil]
-      optional :status, enum: -> { Dodopayments::Models::IntentStatus }, nil?: true
+      optional :status, enum: -> { Dodopayments::IntentStatus }, nil?: true
 
       # @!attribute subscription_id
       #
       #   @return [String, nil]
       optional :subscription_id, String, nil?: true
 
-      # @!method initialize(created_at:, currency:, customer:, metadata:, payment_id:, total_amount:, payment_method: nil, payment_method_type: nil, status: nil, subscription_id: nil)
+      # @!method initialize(brand_id:, created_at:, currency:, customer:, digital_products_delivered:, metadata:, payment_id:, total_amount:, payment_method: nil, payment_method_type: nil, status: nil, subscription_id: nil)
+      #   @param brand_id [String]
       #   @param created_at [Time]
       #   @param currency [Symbol, Dodopayments::Models::Currency]
       #   @param customer [Dodopayments::Models::CustomerLimitedDetails]
+      #   @param digital_products_delivered [Boolean]
       #   @param metadata [Hash{Symbol=>String}]
       #   @param payment_id [String]
       #   @param total_amount [Integer]

data/lib/dodopayments/models/payment_method_types.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module PaymentMethodTypes
+      extend Dodopayments::Internal::Type::Enum
+
+      CREDIT = :credit
+      DEBIT = :debit
+      UPI_COLLECT = :upi_collect
+      UPI_INTENT = :upi_intent
+      APPLE_PAY = :apple_pay
+      CASHAPP = :cashapp
+      GOOGLE_PAY = :google_pay
+      MULTIBANCO = :multibanco
+      BANCONTACT_CARD = :bancontact_card
+      EPS = :eps
+      IDEAL = :ideal
+      PRZELEWY24 = :przelewy24
+      AFFIRM = :affirm
+      KLARNA = :klarna
+      SEPA = :sepa
+      ACH = :ach
+      AMAZON_PAY = :amazon_pay
+      AFTERPAY_CLEARPAY = :afterpay_clearpay
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/dodopayments/models/payment_retrieve_line_items_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::Payments#retrieve_line_items
+    class PaymentRetrieveLineItemsParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/dodopayments/models/payment_retrieve_line_items_response.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::Payments#retrieve_line_items
+    class PaymentRetrieveLineItemsResponse < Dodopayments::Internal::Type::BaseModel
+      # @!attribute currency
+      #
+      #   @return [Symbol, Dodopayments::Models::Currency]
+      required :currency, enum: -> { Dodopayments::Currency }
+
+      # @!attribute items
+      #
+      #   @return [Array<Dodopayments::Models::PaymentRetrieveLineItemsResponse::Item>]
+      required :items,
+               -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::Models::PaymentRetrieveLineItemsResponse::Item] }
+
+      # @!method initialize(currency:, items:)
+      #   @param currency [Symbol, Dodopayments::Models::Currency]
+      #   @param items [Array<Dodopayments::Models::PaymentRetrieveLineItemsResponse::Item>]
+
+      class Item < Dodopayments::Internal::Type::BaseModel
+        # @!attribute amount
+        #
+        #   @return [Integer]
+        required :amount, Integer
+
+        # @!attribute items_id
+        #
+        #   @return [String]
+        required :items_id, String
+
+        # @!attribute refundable_amount
+        #
+        #   @return [Integer]
+        required :refundable_amount, Integer
+
+        # @!attribute tax
+        #
+        #   @return [Integer]
+        required :tax, Integer
+
+        # @!attribute description
+        #
+        #   @return [String, nil]
+        optional :description, String, nil?: true
+
+        # @!attribute name
+        #
+        #   @return [String, nil]
+        optional :name, String, nil?: true
+
+        # @!method initialize(amount:, items_id:, refundable_amount:, tax:, description: nil, name: nil)
+        #   @param amount [Integer]
+        #   @param items_id [String]
+        #   @param refundable_amount [Integer]
+        #   @param tax [Integer]
+        #   @param description [String, nil]
+        #   @param name [String, nil]
+      end
+    end
+  end
+end

data/lib/dodopayments/models/payout_list_params.rb

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

data/lib/dodopayments/models/payout_list_response.rb

@@ -29,9 +29,10 @@ module Dodopayments
       required :created_at, Time
 
       # @!attribute currency
+      #   The currency of the payout, represented as an ISO 4217 currency code.
       #
       #   @return [Symbol, Dodopayments::Models::Currency]
-      required :currency, enum: -> { Dodopayments::Models::Currency }
+      required :currency, enum: -> { Dodopayments::Currency }
 
       # @!attribute fee
       #   The fee charged for processing the payout.
@@ -58,6 +59,7 @@ module Dodopayments
       required :refunds, Integer
 
       # @!attribute status
+      #   The current status of the payout.
       #
       #   @return [Symbol, Dodopayments::Models::PayoutListResponse::Status]
       required :status, enum: -> { Dodopayments::Models::PayoutListResponse::Status }
@@ -101,7 +103,7 @@ module Dodopayments
       #
       #   @param created_at [Time] The timestamp when the payout was created, in UTC.
       #
-      #   @param currency [Symbol, Dodopayments::Models::Currency]
+      #   @param currency [Symbol, Dodopayments::Models::Currency] The currency of the payout, represented as an ISO 4217 currency code.
       #
       #   @param fee [Integer] The fee charged for processing the payout.
       #
@@ -111,7 +113,7 @@ module Dodopayments
       #
       #   @param refunds [Integer] The total value of refunds associated with the payout.
       #
-      #   @param status [Symbol, Dodopayments::Models::PayoutListResponse::Status]
+      #   @param status [Symbol, Dodopayments::Models::PayoutListResponse::Status] The current status of the payout.
       #
       #   @param tax [Integer] The tax applied to the payout.
       #
@@ -123,6 +125,8 @@ module Dodopayments
       #
       #   @param remarks [String, nil] Any additional remarks or notes associated with the payout.
 
+      # The current status of the payout.
+      #
       # @see Dodopayments::Models::PayoutListResponse#status
       module Status
         extend Dodopayments::Internal::Type::Enum

data/lib/dodopayments/models/price.rb

@@ -2,20 +2,22 @@
 
 module Dodopayments
   module Models
+    # One-time price details.
     module Price
       extend Dodopayments::Internal::Type::Union
 
-      discriminator :type
+      # One-time price details.
+      variant -> { Dodopayments::Price::OneTimePrice }
 
-      variant :one_time_price, -> { Dodopayments::Models::Price::OneTimePrice }
-
-      variant :recurring_price, -> { Dodopayments::Models::Price::RecurringPrice }
+      # Recurring price details.
+      variant -> { Dodopayments::Price::RecurringPrice }
 
       class OneTimePrice < Dodopayments::Internal::Type::BaseModel
         # @!attribute currency
+        #   The currency in which the payment is made.
         #
         #   @return [Symbol, Dodopayments::Models::Currency]
-        required :currency, enum: -> { Dodopayments::Models::Currency }
+        required :currency, enum: -> { Dodopayments::Currency }
 
         # @!attribute discount
         #   Discount applied to the price, represented as a percentage (0 to 100).
@@ -42,8 +44,8 @@ module Dodopayments
 
         # @!attribute type
         #
-        #   @return [Symbol, :one_time_price]
-        required :type, const: :one_time_price
+        #   @return [Symbol, Dodopayments::Models::Price::OneTimePrice::Type]
+        required :type, enum: -> { Dodopayments::Price::OneTimePrice::Type }
 
         # @!attribute pay_what_you_want
         #   Indicates whether the customer can pay any amount they choose. If set to `true`,
@@ -66,33 +68,45 @@ module Dodopayments
         #   @return [Boolean, nil]
         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)
+        # @!method initialize(currency:, discount:, price:, purchasing_power_parity:, type:, pay_what_you_want: nil, suggested_price: nil, tax_inclusive: nil)
         #   Some parameter documentations has been truncated, see
         #   {Dodopayments::Models::Price::OneTimePrice} for more details.
         #
-        #   @param currency [Symbol, Dodopayments::Models::Currency]
+        #   One-time price details.
+        #
+        #   @param currency [Symbol, Dodopayments::Models::Currency] The currency in which the payment is made.
         #
         #   @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 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 type [Symbol, Dodopayments::Models::Price::OneTimePrice::Type]
         #
-        #   @param suggested_price [Integer, nil] A suggested price for the user to pay. This value is only considered if ...
+        #   @param pay_what_you_want [Boolean] Indicates whether the customer can pay any amount they choose.
         #
-        #   @param tax_inclusive [Boolean, nil] Indicates if the price is tax inclusive.
+        #   @param suggested_price [Integer, nil] A suggested price for the user to pay. This value is only considered if
         #
-        #   @param type [Symbol, :one_time_price]
+        #   @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
       end
 
       class RecurringPrice < Dodopayments::Internal::Type::BaseModel
         # @!attribute currency
+        #   The currency in which the payment is made.
         #
         #   @return [Symbol, Dodopayments::Models::Currency]
-        required :currency, enum: -> { Dodopayments::Models::Currency }
+        required :currency, enum: -> { Dodopayments::Currency }
 
         # @!attribute discount
         #   Discount applied to the price, represented as a percentage (0 to 100).
@@ -108,9 +122,10 @@ module Dodopayments
         required :payment_frequency_count, Integer
 
         # @!attribute payment_frequency_interval
+        #   The time interval for the payment frequency (e.g., day, month, year).
         #
         #   @return [Symbol, Dodopayments::Models::TimeInterval]
-        required :payment_frequency_interval, enum: -> { Dodopayments::Models::TimeInterval }
+        required :payment_frequency_interval, enum: -> { Dodopayments::TimeInterval }
 
         # @!attribute price
         #   The payment amount. Represented in the lowest denomination of the currency
@@ -134,14 +149,15 @@ module Dodopayments
         required :subscription_period_count, Integer
 
         # @!attribute subscription_period_interval
+        #   The time interval for the subscription period (e.g., day, month, year).
         #
         #   @return [Symbol, Dodopayments::Models::TimeInterval]
-        required :subscription_period_interval, enum: -> { Dodopayments::Models::TimeInterval }
+        required :subscription_period_interval, enum: -> { Dodopayments::TimeInterval }
 
         # @!attribute type
         #
-        #   @return [Symbol, :recurring_price]
-        required :type, const: :recurring_price
+        #   @return [Symbol, Dodopayments::Models::Price::RecurringPrice::Type]
+        required :type, enum: -> { Dodopayments::Price::RecurringPrice::Type }
 
         # @!attribute tax_inclusive
         #   Indicates if the price is tax inclusive
@@ -155,32 +171,43 @@ 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:, tax_inclusive: nil, trial_period_days: nil, type: :recurring_price)
+        # @!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)
         #   Some parameter documentations has been truncated, see
         #   {Dodopayments::Models::Price::RecurringPrice} for more details.
         #
-        #   @param currency [Symbol, Dodopayments::Models::Currency]
+        #   Recurring price details.
+        #
+        #   @param currency [Symbol, Dodopayments::Models::Currency] The currency in which the payment is made.
         #
         #   @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_count [Integer] Number of units for the payment frequency.
         #
-        #   @param payment_frequency_interval [Symbol, Dodopayments::Models::TimeInterval]
+        #   @param payment_frequency_interval [Symbol, Dodopayments::Models::TimeInterval] The time interval for the payment frequency (e.g., day, month, year).
         #
         #   @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 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_count [Integer] Number of units for the subscription period. ...
+        #   @param subscription_period_interval [Symbol, Dodopayments::Models::TimeInterval] The time interval for the subscription period (e.g., day, month, year).
         #
-        #   @param subscription_period_interval [Symbol, Dodopayments::Models::TimeInterval]
+        #   @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.
-        #
-        #   @param type [Symbol, :recurring_price]
+
+        # @see Dodopayments::Models::Price::RecurringPrice#type
+        module Type
+          extend Dodopayments::Internal::Type::Enum
+
+          RECURRING_PRICE = :recurring_price
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
       end
 
       # @!method self.variants