dodopayments 2.20.1 → 2.22.0

data/lib/dodopayments/models/payment.rb

@@ -184,7 +184,9 @@ module Dodopayments
       optional :error_code, String, nil?: true
 
       # @!attribute error_message
-      #   An error message if the payment failed
+      #   An error message if the payment failed. When `error_code` is a recognised
+      #   unified code, this is the merchant-facing headline + recommended action (Payment
+      #   Details copy) rather than the raw connector text.
       #
       #   @return [String, nil]
       optional :error_message, String, nil?: true
@@ -331,7 +333,7 @@ module Dodopayments
       #
       #   @param error_code [String, nil] An error code if the payment failed
       #
-      #   @param error_message [String, nil] An error message if the payment failed
+      #   @param error_message [String, nil] An error message if the payment failed. When `error_code` is a recognised
       #
       #   @param invoice_id [String, nil] Invoice ID for this payment. Uses India-specific invoice ID if available.
       #

data/lib/dodopayments/models/payment_list_params.rb

@@ -25,6 +25,12 @@ module Dodopayments
       #   @return [Time, nil]
       optional :created_at_lte, Time
 
+      # @!attribute currency
+      #   Filter by currency
+      #
+      #   @return [Symbol, Dodopayments::Models::PaymentListParams::Currency, nil]
+      optional :currency, enum: -> { Dodopayments::PaymentListParams::Currency }
+
       # @!attribute customer_id
       #   Filter by customer id
       #
@@ -32,7 +38,8 @@ module Dodopayments
       optional :customer_id, String
 
       # @!attribute page_number
-      #   Page number default is 0
+      #   Page number default is 0. Capped to bound OFFSET-based deep pagination, which
+      #   forces Postgres to scan and discard every preceding row.
       #
       #   @return [Integer, nil]
       optional :page_number, Integer
@@ -61,16 +68,21 @@ module Dodopayments
       #   @return [String, nil]
       optional :subscription_id, String
 
-      # @!method initialize(brand_id: nil, created_at_gte: nil, created_at_lte: nil, customer_id: nil, page_number: nil, page_size: nil, product_id: nil, status: nil, subscription_id: nil, request_options: {})
+      # @!method initialize(brand_id: nil, created_at_gte: nil, created_at_lte: nil, currency: nil, customer_id: nil, page_number: nil, page_size: nil, product_id: nil, status: nil, subscription_id: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::PaymentListParams} for more details.
+      #
       #   @param brand_id [String] filter by Brand id
       #
       #   @param created_at_gte [Time] Get events after this created time
       #
       #   @param created_at_lte [Time] Get events created before this time
       #
+      #   @param currency [Symbol, Dodopayments::Models::PaymentListParams::Currency] Filter by currency
+      #
       #   @param customer_id [String] Filter by customer id
       #
-      #   @param page_number [Integer] Page number default is 0
+      #   @param page_number [Integer] Page number default is 0. Capped to bound OFFSET-based deep pagination,
       #
       #   @param page_size [Integer] Page size default is 10 max is 100
       #
@@ -82,6 +94,160 @@ module Dodopayments
       #
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
 
+      # Filter by currency
+      module Currency
+        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
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
       # Filter by status
       module Status
         extend Dodopayments::Internal::Type::Enum

data/lib/dodopayments/models/payment_method_types.rb

@@ -85,7 +85,6 @@ 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/payout_created_webhook_event.rb

@@ -0,0 +1,188 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    class PayoutCreatedWebhookEvent < Dodopayments::Internal::Type::BaseModel
+      # @!attribute business_id
+      #   The business identifier
+      #
+      #   @return [String]
+      required :business_id, String
+
+      # @!attribute data
+      #
+      #   @return [Dodopayments::Models::PayoutCreatedWebhookEvent::Data]
+      required :data, -> { Dodopayments::PayoutCreatedWebhookEvent::Data }
+
+      # @!attribute timestamp
+      #   The timestamp of when the event occurred
+      #
+      #   @return [Time]
+      required :timestamp, Time
+
+      # @!attribute type
+      #   The event type
+      #
+      #   @return [Symbol, :"payout.created"]
+      required :type, const: :"payout.created"
+
+      # @!method initialize(business_id:, data:, timestamp:, type: :"payout.created")
+      #   @param business_id [String] The business identifier
+      #
+      #   @param data [Dodopayments::Models::PayoutCreatedWebhookEvent::Data]
+      #
+      #   @param timestamp [Time] The timestamp of when the event occurred
+      #
+      #   @param type [Symbol, :"payout.created"] The event type
+
+      # @see Dodopayments::Models::PayoutCreatedWebhookEvent#data
+      class Data < Dodopayments::Internal::Type::BaseModel
+        # @!attribute amount
+        #   The total amount of the payout.
+        #
+        #   @return [Integer]
+        required :amount, Integer
+
+        # @!attribute business_id
+        #   The unique identifier of the business associated with the payout.
+        #
+        #   @return [String]
+        required :business_id, String
+
+        # @!attribute chargebacks
+        #   @deprecated Use the v3 payout breakup endpoints instead. Will be removed in a future
+        #   release.
+        #
+        #   The total value of chargebacks associated with the payout.
+        #
+        #   @return [Integer]
+        required :chargebacks, Integer
+
+        # @!attribute created_at
+        #   The timestamp when the payout was created, in UTC.
+        #
+        #   @return [Time]
+        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::Currency }
+
+        # @!attribute fee
+        #   The fee charged for processing the payout.
+        #
+        #   @return [Integer]
+        required :fee, Integer
+
+        # @!attribute payment_method
+        #   The payment method used for the payout (e.g., bank transfer, card, etc.).
+        #
+        #   @return [String]
+        required :payment_method, String
+
+        # @!attribute payout_id
+        #   The unique identifier of the payout.
+        #
+        #   @return [String]
+        required :payout_id, String
+
+        # @!attribute refunds
+        #   @deprecated Use the v3 payout breakup endpoints instead. Will be removed in a future
+        #   release.
+        #
+        #   The total value of refunds associated with the payout.
+        #
+        #   @return [Integer]
+        required :refunds, Integer
+
+        # @!attribute status
+        #   The current status of the payout.
+        #
+        #   @return [Symbol, Dodopayments::Models::PayoutCreatedWebhookEvent::Data::Status]
+        required :status, enum: -> { Dodopayments::PayoutCreatedWebhookEvent::Data::Status }
+
+        # @!attribute tax
+        #   @deprecated Use the v3 payout breakup endpoints instead. Will be removed in a future
+        #   release.
+        #
+        #   The tax applied to the payout.
+        #
+        #   @return [Integer]
+        required :tax, Integer
+
+        # @!attribute updated_at
+        #   The timestamp when the payout was last updated, in UTC.
+        #
+        #   @return [Time]
+        required :updated_at, Time
+
+        # @!attribute name
+        #   The name of the payout recipient or purpose.
+        #
+        #   @return [String, nil]
+        optional :name, String, nil?: true
+
+        # @!attribute payout_document_url
+        #   The URL of the document associated with the payout.
+        #
+        #   @return [String, nil]
+        optional :payout_document_url, String, nil?: true
+
+        # @!attribute remarks
+        #   Any additional remarks or notes associated with the payout.
+        #
+        #   @return [String, nil]
+        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] 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::Currency] The currency of the payout, represented as an ISO 4217 currency code.
+        #
+        #   @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::PayoutCreatedWebhookEvent::Data::Status] The current status of the payout.
+        #
+        #   @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.
+
+        # The current status of the payout.
+        #
+        # @see Dodopayments::Models::PayoutCreatedWebhookEvent::Data#status
+        module Status
+          extend Dodopayments::Internal::Type::Enum
+
+          NOT_INITIATED = :not_initiated
+          IN_PROGRESS = :in_progress
+          ON_HOLD = :on_hold
+          FAILED = :failed
+          SUCCESS = :success
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/dodopayments/models/payout_failed_webhook_event.rb

@@ -0,0 +1,188 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    class PayoutFailedWebhookEvent < Dodopayments::Internal::Type::BaseModel
+      # @!attribute business_id
+      #   The business identifier
+      #
+      #   @return [String]
+      required :business_id, String
+
+      # @!attribute data
+      #
+      #   @return [Dodopayments::Models::PayoutFailedWebhookEvent::Data]
+      required :data, -> { Dodopayments::PayoutFailedWebhookEvent::Data }
+
+      # @!attribute timestamp
+      #   The timestamp of when the event occurred
+      #
+      #   @return [Time]
+      required :timestamp, Time
+
+      # @!attribute type
+      #   The event type
+      #
+      #   @return [Symbol, :"payout.failed"]
+      required :type, const: :"payout.failed"
+
+      # @!method initialize(business_id:, data:, timestamp:, type: :"payout.failed")
+      #   @param business_id [String] The business identifier
+      #
+      #   @param data [Dodopayments::Models::PayoutFailedWebhookEvent::Data]
+      #
+      #   @param timestamp [Time] The timestamp of when the event occurred
+      #
+      #   @param type [Symbol, :"payout.failed"] The event type
+
+      # @see Dodopayments::Models::PayoutFailedWebhookEvent#data
+      class Data < Dodopayments::Internal::Type::BaseModel
+        # @!attribute amount
+        #   The total amount of the payout.
+        #
+        #   @return [Integer]
+        required :amount, Integer
+
+        # @!attribute business_id
+        #   The unique identifier of the business associated with the payout.
+        #
+        #   @return [String]
+        required :business_id, String
+
+        # @!attribute chargebacks
+        #   @deprecated Use the v3 payout breakup endpoints instead. Will be removed in a future
+        #   release.
+        #
+        #   The total value of chargebacks associated with the payout.
+        #
+        #   @return [Integer]
+        required :chargebacks, Integer
+
+        # @!attribute created_at
+        #   The timestamp when the payout was created, in UTC.
+        #
+        #   @return [Time]
+        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::Currency }
+
+        # @!attribute fee
+        #   The fee charged for processing the payout.
+        #
+        #   @return [Integer]
+        required :fee, Integer
+
+        # @!attribute payment_method
+        #   The payment method used for the payout (e.g., bank transfer, card, etc.).
+        #
+        #   @return [String]
+        required :payment_method, String
+
+        # @!attribute payout_id
+        #   The unique identifier of the payout.
+        #
+        #   @return [String]
+        required :payout_id, String
+
+        # @!attribute refunds
+        #   @deprecated Use the v3 payout breakup endpoints instead. Will be removed in a future
+        #   release.
+        #
+        #   The total value of refunds associated with the payout.
+        #
+        #   @return [Integer]
+        required :refunds, Integer
+
+        # @!attribute status
+        #   The current status of the payout.
+        #
+        #   @return [Symbol, Dodopayments::Models::PayoutFailedWebhookEvent::Data::Status]
+        required :status, enum: -> { Dodopayments::PayoutFailedWebhookEvent::Data::Status }
+
+        # @!attribute tax
+        #   @deprecated Use the v3 payout breakup endpoints instead. Will be removed in a future
+        #   release.
+        #
+        #   The tax applied to the payout.
+        #
+        #   @return [Integer]
+        required :tax, Integer
+
+        # @!attribute updated_at
+        #   The timestamp when the payout was last updated, in UTC.
+        #
+        #   @return [Time]
+        required :updated_at, Time
+
+        # @!attribute name
+        #   The name of the payout recipient or purpose.
+        #
+        #   @return [String, nil]
+        optional :name, String, nil?: true
+
+        # @!attribute payout_document_url
+        #   The URL of the document associated with the payout.
+        #
+        #   @return [String, nil]
+        optional :payout_document_url, String, nil?: true
+
+        # @!attribute remarks
+        #   Any additional remarks or notes associated with the payout.
+        #
+        #   @return [String, nil]
+        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] 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::Currency] The currency of the payout, represented as an ISO 4217 currency code.
+        #
+        #   @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::PayoutFailedWebhookEvent::Data::Status] The current status of the payout.
+        #
+        #   @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.
+
+        # The current status of the payout.
+        #
+        # @see Dodopayments::Models::PayoutFailedWebhookEvent::Data#status
+        module Status
+          extend Dodopayments::Internal::Type::Enum
+
+          NOT_INITIATED = :not_initiated
+          IN_PROGRESS = :in_progress
+          ON_HOLD = :on_hold
+          FAILED = :failed
+          SUCCESS = :success
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end