dodopayments 1.16.1 → 1.18.0

data/lib/dodopayments/models/payment.rb

@@ -49,6 +49,19 @@ module Dodopayments
       #   @return [Array<Dodopayments::Models::Refund>]
       required :refunds, -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::Models::Refund] }
 
+      # @!attribute settlement_amount
+      #   The amount that will be credited to your Dodo balance after currency conversion
+      #   and processing. Especially relevant for adaptive pricing where the customer's
+      #   payment currency differs from your settlement currency.
+      #
+      #   @return [Integer]
+      required :settlement_amount, Integer
+
+      # @!attribute settlement_currency
+      #
+      #   @return [Symbol, Dodopayments::Models::Payment::SettlementCurrency]
+      required :settlement_currency, enum: -> { Dodopayments::Models::Payment::SettlementCurrency }
+
       # @!attribute total_amount
       #   Total amount charged to the customer including tax, in smallest currency unit
       #   (e.g. cents)
@@ -117,53 +130,28 @@ module Dodopayments
       #   @return [Time, nil]
       optional :updated_at, Time, nil?: true
 
-      # @!parse
-      #   # @param business_id [String]
-      #   # @param created_at [Time]
-      #   # @param currency [Symbol, Dodopayments::Models::Payment::Currency]
-      #   # @param customer [Dodopayments::Models::CustomerLimitedDetails]
-      #   # @param disputes [Array<Dodopayments::Models::Dispute>]
-      #   # @param metadata [Hash{Symbol=>String}]
-      #   # @param payment_id [String]
-      #   # @param refunds [Array<Dodopayments::Models::Refund>]
-      #   # @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 status [Symbol, Dodopayments::Models::IntentStatus, nil]
-      #   # @param subscription_id [String, nil]
-      #   # @param tax [Integer, nil]
-      #   # @param updated_at [Time, nil]
-      #   #
-      #   def initialize(
-      #     business_id:,
-      #     created_at:,
-      #     currency:,
-      #     customer:,
-      #     disputes:,
-      #     metadata:,
-      #     payment_id:,
-      #     refunds:,
-      #     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,
-      #     **
-      #   )
-      #     super
-      #   end
-
-      # def initialize: (Hash | Dodopayments::Internal::Type::BaseModel) -> void
+      # @!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]
+      #   @param currency [Symbol, Dodopayments::Models::Payment::Currency]
+      #   @param customer [Dodopayments::Models::CustomerLimitedDetails]
+      #   @param disputes [Array<Dodopayments::Models::Dispute>]
+      #   @param metadata [Hash{Symbol=>String}]
+      #   @param payment_id [String]
+      #   @param refunds [Array<Dodopayments::Models::Refund>]
+      #   @param settlement_amount [Integer]
+      #   @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 status [Symbol, Dodopayments::Models::IntentStatus, nil]
+      #   @param subscription_id [String, nil]
+      #   @param tax [Integer, nil]
+      #   @param updated_at [Time, nil]
 
       # @see Dodopayments::Models::Payment#currency
       module Currency
@@ -315,11 +303,162 @@ module Dodopayments
         ZAR = :ZAR
         ZMW = :ZMW
 
-        finalize!
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see Dodopayments::Models::Payment#settlement_currency
+      module SettlementCurrency
+        extend Dodopayments::Internal::Type::Enum
+
+        AED = :AED
+        ALL = :ALL
+        AMD = :AMD
+        ANG = :ANG
+        AOA = :AOA
+        ARS = :ARS
+        AUD = :AUD
+        AWG = :AWG
+        AZN = :AZN
+        BAM = :BAM
+        BBD = :BBD
+        BDT = :BDT
+        BGN = :BGN
+        BHD = :BHD
+        BIF = :BIF
+        BMD = :BMD
+        BND = :BND
+        BOB = :BOB
+        BRL = :BRL
+        BSD = :BSD
+        BWP = :BWP
+        BYN = :BYN
+        BZD = :BZD
+        CAD = :CAD
+        CHF = :CHF
+        CLP = :CLP
+        CNY = :CNY
+        COP = :COP
+        CRC = :CRC
+        CUP = :CUP
+        CVE = :CVE
+        CZK = :CZK
+        DJF = :DJF
+        DKK = :DKK
+        DOP = :DOP
+        DZD = :DZD
+        EGP = :EGP
+        ETB = :ETB
+        EUR = :EUR
+        FJD = :FJD
+        FKP = :FKP
+        GBP = :GBP
+        GEL = :GEL
+        GHS = :GHS
+        GIP = :GIP
+        GMD = :GMD
+        GNF = :GNF
+        GTQ = :GTQ
+        GYD = :GYD
+        HKD = :HKD
+        HNL = :HNL
+        HRK = :HRK
+        HTG = :HTG
+        HUF = :HUF
+        IDR = :IDR
+        ILS = :ILS
+        INR = :INR
+        IQD = :IQD
+        JMD = :JMD
+        JOD = :JOD
+        JPY = :JPY
+        KES = :KES
+        KGS = :KGS
+        KHR = :KHR
+        KMF = :KMF
+        KRW = :KRW
+        KWD = :KWD
+        KYD = :KYD
+        KZT = :KZT
+        LAK = :LAK
+        LBP = :LBP
+        LKR = :LKR
+        LRD = :LRD
+        LSL = :LSL
+        LYD = :LYD
+        MAD = :MAD
+        MDL = :MDL
+        MGA = :MGA
+        MKD = :MKD
+        MMK = :MMK
+        MNT = :MNT
+        MOP = :MOP
+        MRU = :MRU
+        MUR = :MUR
+        MVR = :MVR
+        MWK = :MWK
+        MXN = :MXN
+        MYR = :MYR
+        MZN = :MZN
+        NAD = :NAD
+        NGN = :NGN
+        NIO = :NIO
+        NOK = :NOK
+        NPR = :NPR
+        NZD = :NZD
+        OMR = :OMR
+        PAB = :PAB
+        PEN = :PEN
+        PGK = :PGK
+        PHP = :PHP
+        PKR = :PKR
+        PLN = :PLN
+        PYG = :PYG
+        QAR = :QAR
+        RON = :RON
+        RSD = :RSD
+        RUB = :RUB
+        RWF = :RWF
+        SAR = :SAR
+        SBD = :SBD
+        SCR = :SCR
+        SEK = :SEK
+        SGD = :SGD
+        SHP = :SHP
+        SLE = :SLE
+        SLL = :SLL
+        SOS = :SOS
+        SRD = :SRD
+        SSP = :SSP
+        STN = :STN
+        SVC = :SVC
+        SZL = :SZL
+        THB = :THB
+        TND = :TND
+        TOP = :TOP
+        TRY = :TRY
+        TTD = :TTD
+        TWD = :TWD
+        TZS = :TZS
+        UAH = :UAH
+        UGX = :UGX
+        USD = :USD
+        UYU = :UYU
+        UZS = :UZS
+        VES = :VES
+        VND = :VND
+        VUV = :VUV
+        WST = :WST
+        XAF = :XAF
+        XCD = :XCD
+        XOF = :XOF
+        XPF = :XPF
+        YER = :YER
+        ZAR = :ZAR
+        ZMW = :ZMW
 
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
 
       class ProductCart < Dodopayments::Internal::Type::BaseModel
@@ -333,13 +472,9 @@ module Dodopayments
         #   @return [Integer]
         required :quantity, Integer
 
-        # @!parse
-        #   # @param product_id [String]
-        #   # @param quantity [Integer]
-        #   #
-        #   def initialize(product_id:, quantity:, **) = super
-
-        # def initialize: (Hash | Dodopayments::Internal::Type::BaseModel) -> void
+        # @!method initialize(product_id:, quantity:)
+        #   @param product_id [String]
+        #   @param quantity [Integer]
       end
     end
   end

data/lib/dodopayments/models/payment_create_params.rb

@@ -4,8 +4,7 @@ module Dodopayments
   module Models
     # @see Dodopayments::Resources::Payments#create
     class PaymentCreateParams < Dodopayments::Internal::Type::BaseModel
-      # @!parse
-      #   extend Dodopayments::Internal::Type::RequestParameters::Converter
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 
       # @!attribute billing
@@ -51,15 +50,11 @@ module Dodopayments
       #   @return [String, nil]
       optional :discount_code, String, nil?: true
 
-      # @!attribute [r] metadata
+      # @!attribute metadata
       #
       #   @return [Hash{Symbol=>String}, nil]
       optional :metadata, Dodopayments::Internal::Type::HashOf[String]
 
-      # @!parse
-      #   # @return [Hash{Symbol=>String}]
-      #   attr_writer :metadata
-
       # @!attribute payment_link
       #   Whether to generate a payment link. Defaults to false if not specified.
       #
@@ -73,16 +68,12 @@ module Dodopayments
       #   @return [String, nil]
       optional :return_url, String, nil?: true
 
-      # @!attribute [r] show_saved_payment_methods
+      # @!attribute show_saved_payment_methods
       #   Display saved payment methods of a returning customer False by default
       #
       #   @return [Boolean, nil]
       optional :show_saved_payment_methods, Dodopayments::Internal::Type::Boolean
 
-      # @!parse
-      #   # @return [Boolean]
-      #   attr_writer :show_saved_payment_methods
-
       # @!attribute tax_id
       #   Tax ID in case the payment is B2B. If tax id validation fails the payment
       #   creation will fail
@@ -90,39 +81,19 @@ module Dodopayments
       #   @return [String, nil]
       optional :tax_id, String, nil?: true
 
-      # @!parse
-      #   # @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 billing_currency [Symbol, Dodopayments::Models::PaymentCreateParams::BillingCurrency, nil]
-      #   # @param discount_code [String, nil]
-      #   # @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 request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
-      #   #
-      #   def 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: {},
-      #     **
-      #   )
-      #     super
-      #   end
-
-      # def initialize: (Hash | Dodopayments::Internal::Type::BaseModel) -> void
+      # @!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: {})
+      #   @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 billing_currency [Symbol, Dodopayments::Models::PaymentCreateParams::BillingCurrency, nil]
+      #   @param discount_code [String, nil]
+      #   @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 request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
 
       module AllowedPaymentMethodType
         extend Dodopayments::Internal::Type::Enum
@@ -146,11 +117,8 @@ module Dodopayments
         AMAZON_PAY = :amazon_pay
         AFTERPAY_CLEARPAY = :afterpay_clearpay
 
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
 
       module BillingCurrency
@@ -302,11 +270,8 @@ module Dodopayments
         ZAR = :ZAR
         ZMW = :ZMW
 
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
     end
   end

data/lib/dodopayments/models/payment_create_response.rb

@@ -53,31 +53,15 @@ module Dodopayments
                -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::Models::OneTimeProductCartItem] },
                nil?: true
 
-      # @!parse
-      #   # @param client_secret [String]
-      #   # @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]
-      #   #
-      #   def initialize(
-      #     client_secret:,
-      #     customer:,
-      #     metadata:,
-      #     payment_id:,
-      #     total_amount:,
-      #     discount_id: nil,
-      #     payment_link: nil,
-      #     product_cart: nil,
-      #     **
-      #   )
-      #     super
-      #   end
-
-      # def initialize: (Hash | Dodopayments::Internal::Type::BaseModel) -> void
+      # @!method initialize(client_secret:, customer:, metadata:, payment_id:, total_amount:, discount_id: nil, payment_link: nil, product_cart: nil)
+      #   @param client_secret [String]
+      #   @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]
     end
   end
 end

data/lib/dodopayments/models/payment_list_params.rb

@@ -4,8 +4,7 @@ module Dodopayments
   module Models
     # @see Dodopayments::Resources::Payments#list
     class PaymentListParams < Dodopayments::Internal::Type::BaseModel
-      # @!parse
-      #   extend Dodopayments::Internal::Type::RequestParameters::Converter
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 
       # @!attribute created_at_gte
@@ -50,31 +49,15 @@ module Dodopayments
       #   @return [String, nil]
       optional :subscription_id, String, nil?: true
 
-      # @!parse
-      #   # @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 request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
-      #   #
-      #   def 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: {},
-      #     **
-      #   )
-      #     super
-      #   end
-
-      # def initialize: (Hash | Dodopayments::Internal::Type::BaseModel) -> void
+      # @!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 request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
     end
   end
 end

data/lib/dodopayments/models/payment_list_response.rb

@@ -54,35 +54,17 @@ module Dodopayments
       #   @return [String, nil]
       optional :subscription_id, String, nil?: true
 
-      # @!parse
-      #   # @param created_at [Time]
-      #   # @param currency [Symbol, Dodopayments::Models::PaymentListResponse::Currency]
-      #   # @param customer [Dodopayments::Models::CustomerLimitedDetails]
-      #   # @param metadata [Hash{Symbol=>String}]
-      #   # @param payment_id [String]
-      #   # @param total_amount [Integer]
-      #   # @param payment_method [String, nil]
-      #   # @param payment_method_type [String, nil]
-      #   # @param status [Symbol, Dodopayments::Models::IntentStatus, nil]
-      #   # @param subscription_id [String, nil]
-      #   #
-      #   def initialize(
-      #     created_at:,
-      #     currency:,
-      #     customer:,
-      #     metadata:,
-      #     payment_id:,
-      #     total_amount:,
-      #     payment_method: nil,
-      #     payment_method_type: nil,
-      #     status: nil,
-      #     subscription_id: nil,
-      #     **
-      #   )
-      #     super
-      #   end
-
-      # def initialize: (Hash | Dodopayments::Internal::Type::BaseModel) -> void
+      # @!method initialize(created_at:, currency:, customer:, metadata:, payment_id:, total_amount:, payment_method: nil, payment_method_type: nil, status: nil, subscription_id: nil)
+      #   @param created_at [Time]
+      #   @param currency [Symbol, Dodopayments::Models::PaymentListResponse::Currency]
+      #   @param customer [Dodopayments::Models::CustomerLimitedDetails]
+      #   @param metadata [Hash{Symbol=>String}]
+      #   @param payment_id [String]
+      #   @param total_amount [Integer]
+      #   @param payment_method [String, nil]
+      #   @param payment_method_type [String, nil]
+      #   @param status [Symbol, Dodopayments::Models::IntentStatus, nil]
+      #   @param subscription_id [String, nil]
 
       # @see Dodopayments::Models::PaymentListResponse#currency
       module Currency
@@ -234,11 +216,8 @@ module Dodopayments
         ZAR = :ZAR
         ZMW = :ZMW
 
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
     end
   end

data/lib/dodopayments/models/payment_retrieve_params.rb

@@ -4,16 +4,11 @@ module Dodopayments
   module Models
     # @see Dodopayments::Resources::Payments#retrieve
     class PaymentRetrieveParams < Dodopayments::Internal::Type::BaseModel
-      # @!parse
-      #   extend Dodopayments::Internal::Type::RequestParameters::Converter
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 
-      # @!parse
-      #   # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
-      #   #
-      #   def initialize(request_options: {}, **) = super
-
-      # def initialize: (Hash | Dodopayments::Internal::Type::BaseModel) -> void
+      # @!method initialize(request_options: {})
+      #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
     end
   end
 end

data/lib/dodopayments/models/payout_list_params.rb

@@ -4,8 +4,7 @@ module Dodopayments
   module Models
     # @see Dodopayments::Resources::Payouts#list
     class PayoutListParams < Dodopayments::Internal::Type::BaseModel
-      # @!parse
-      #   extend Dodopayments::Internal::Type::RequestParameters::Converter
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 
       # @!attribute page_number
@@ -20,14 +19,10 @@ module Dodopayments
       #   @return [Integer, nil]
       optional :page_size, Integer, nil?: true
 
-      # @!parse
-      #   # @param page_number [Integer, nil]
-      #   # @param page_size [Integer, nil]
-      #   # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
-      #   #
-      #   def initialize(page_number: nil, page_size: nil, request_options: {}, **) = super
-
-      # def initialize: (Hash | Dodopayments::Internal::Type::BaseModel) -> void
+      # @!method initialize(page_number: nil, page_size: nil, request_options: {})
+      #   @param page_number [Integer, nil]
+      #   @param page_size [Integer, nil]
+      #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
     end
   end
 end