dodopayments 2.21.0 → 2.22.0

data/rbi/dodopayments/models/payment.rbi

@@ -135,26 +135,12 @@ module Dodopayments
       sig { returns(T.nilable(String)) }
       attr_accessor :error_code
 
-      # 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.
       sig { returns(T.nilable(String)) }
       attr_accessor :error_message
 
-      # Purpose-built failure messaging for the merchant and the customer, derived from
-      # `error_code`. Present whenever `error_code` is set, regardless of payment
-      # status; unrecognised codes still resolve via a generic fallback rather than
-      # being omitted. The customer copy is always generic for fraud-sensitive declines
-      # (lost/stolen/pickup/fraudulent) so the true reason is never leaked.
-      sig { returns(T.nilable(Dodopayments::Payment::FailureDetails)) }
-      attr_reader :failure_details
-
-      sig do
-        params(
-          failure_details:
-            T.nilable(Dodopayments::Payment::FailureDetails::OrHash)
-        ).void
-      end
-      attr_writer :failure_details
-
       # Invoice ID for this payment. Uses India-specific invoice ID if available.
       sig { returns(T.nilable(String)) }
       attr_accessor :invoice_id
@@ -244,8 +230,6 @@ module Dodopayments
           discounts: T.nilable(T::Array[Dodopayments::DiscountDetail::OrHash]),
           error_code: T.nilable(String),
           error_message: T.nilable(String),
-          failure_details:
-            T.nilable(Dodopayments::Payment::FailureDetails::OrHash),
           invoice_id: T.nilable(String),
           invoice_url: T.nilable(String),
           payment_link: T.nilable(String),
@@ -328,14 +312,10 @@ module Dodopayments
         discounts: nil,
         # An error code if the payment failed
         error_code: nil,
-        # 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.
         error_message: nil,
-        # Purpose-built failure messaging for the merchant and the customer, derived from
-        # `error_code`. Present whenever `error_code` is set, regardless of payment
-        # status; unrecognised codes still resolve via a generic fallback rather than
-        # being omitted. The customer copy is always generic for fraud-sensitive declines
-        # (lost/stolen/pickup/fraudulent) so the true reason is never leaked.
-        failure_details: nil,
         # Invoice ID for this payment. Uses India-specific invoice ID if available.
         invoice_id: nil,
         # URL to download the invoice PDF for this payment.
@@ -403,7 +383,6 @@ module Dodopayments
             discounts: T.nilable(T::Array[Dodopayments::DiscountDetail]),
             error_code: T.nilable(String),
             error_message: T.nilable(String),
-            failure_details: T.nilable(Dodopayments::Payment::FailureDetails),
             invoice_id: T.nilable(String),
             invoice_url: T.nilable(String),
             payment_link: T.nilable(String),
@@ -450,328 +429,6 @@ module Dodopayments
         end
       end
 
-      class FailureDetails < Dodopayments::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              Dodopayments::Payment::FailureDetails,
-              Dodopayments::Internal::AnyHash
-            )
-          end
-
-        # The unified error code (echoes `error_code`).
-        sig { returns(String) }
-        attr_accessor :code
-
-        # The primary CTA to show the customer.
-        sig do
-          returns(
-            Dodopayments::Payment::FailureDetails::CustomerCta::TaggedSymbol
-          )
-        end
-        attr_accessor :customer_cta
-
-        # Whether the customer can resolve this themselves (e.g. fix CVC).
-        sig { returns(T::Boolean) }
-        attr_accessor :customer_fixable
-
-        # The customer-facing string. Always generic (`C11`) for the fraud-4.
-        sig { returns(String) }
-        attr_accessor :customer_message
-
-        # The customer message template identifier (C1..C20).
-        sig do
-          returns(
-            Dodopayments::Payment::FailureDetails::CustomerTemplate::TaggedSymbol
-          )
-        end
-        attr_accessor :customer_template
-
-        # Soft or hard decline.
-        sig do
-          returns(
-            Dodopayments::Payment::FailureDetails::DeclineType::TaggedSymbol
-          )
-        end
-        attr_accessor :decline_type
-
-        # Merchant-facing headline + recommended action (Payment Details). For the fraud-4
-        # this includes the operator "do not reveal" warning.
-        sig { returns(String) }
-        attr_accessor :merchant_message
-
-        # Purpose-built failure messaging for the merchant and the customer, derived from
-        # `error_code`. Present whenever `error_code` is set, regardless of payment
-        # status; unrecognised codes still resolve via a generic fallback rather than
-        # being omitted. The customer copy is always generic for fraud-sensitive declines
-        # (lost/stolen/pickup/fraudulent) so the true reason is never leaked.
-        sig do
-          params(
-            code: String,
-            customer_cta:
-              Dodopayments::Payment::FailureDetails::CustomerCta::OrSymbol,
-            customer_fixable: T::Boolean,
-            customer_message: String,
-            customer_template:
-              Dodopayments::Payment::FailureDetails::CustomerTemplate::OrSymbol,
-            decline_type:
-              Dodopayments::Payment::FailureDetails::DeclineType::OrSymbol,
-            merchant_message: String
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # The unified error code (echoes `error_code`).
-          code:,
-          # The primary CTA to show the customer.
-          customer_cta:,
-          # Whether the customer can resolve this themselves (e.g. fix CVC).
-          customer_fixable:,
-          # The customer-facing string. Always generic (`C11`) for the fraud-4.
-          customer_message:,
-          # The customer message template identifier (C1..C20).
-          customer_template:,
-          # Soft or hard decline.
-          decline_type:,
-          # Merchant-facing headline + recommended action (Payment Details). For the fraud-4
-          # this includes the operator "do not reveal" warning.
-          merchant_message:
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              code: String,
-              customer_cta:
-                Dodopayments::Payment::FailureDetails::CustomerCta::TaggedSymbol,
-              customer_fixable: T::Boolean,
-              customer_message: String,
-              customer_template:
-                Dodopayments::Payment::FailureDetails::CustomerTemplate::TaggedSymbol,
-              decline_type:
-                Dodopayments::Payment::FailureDetails::DeclineType::TaggedSymbol,
-              merchant_message: String
-            }
-          )
-        end
-        def to_hash
-        end
-
-        # The primary CTA to show the customer.
-        module CustomerCta
-          extend Dodopayments::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(Symbol, Dodopayments::Payment::FailureDetails::CustomerCta)
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          EDIT_AND_RETRY =
-            T.let(
-              :edit_and_retry,
-              Dodopayments::Payment::FailureDetails::CustomerCta::TaggedSymbol
-            )
-          USE_ANOTHER_METHOD =
-            T.let(
-              :use_another_method,
-              Dodopayments::Payment::FailureDetails::CustomerCta::TaggedSymbol
-            )
-          TRY_AGAIN =
-            T.let(
-              :try_again,
-              Dodopayments::Payment::FailureDetails::CustomerCta::TaggedSymbol
-            )
-          TRY_LATER =
-            T.let(
-              :try_later,
-              Dodopayments::Payment::FailureDetails::CustomerCta::TaggedSymbol
-            )
-          RETRY_AND_VERIFY =
-            T.let(
-              :retry_and_verify,
-              Dodopayments::Payment::FailureDetails::CustomerCta::TaggedSymbol
-            )
-          RESTART =
-            T.let(
-              :restart,
-              Dodopayments::Payment::FailureDetails::CustomerCta::TaggedSymbol
-            )
-          UPDATE_METHOD =
-            T.let(
-              :update_method,
-              Dodopayments::Payment::FailureDetails::CustomerCta::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                Dodopayments::Payment::FailureDetails::CustomerCta::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
-
-        # The customer message template identifier (C1..C20).
-        module CustomerTemplate
-          extend Dodopayments::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(
-                Symbol,
-                Dodopayments::Payment::FailureDetails::CustomerTemplate
-              )
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          C1 =
-            T.let(
-              :C1,
-              Dodopayments::Payment::FailureDetails::CustomerTemplate::TaggedSymbol
-            )
-          C2 =
-            T.let(
-              :C2,
-              Dodopayments::Payment::FailureDetails::CustomerTemplate::TaggedSymbol
-            )
-          C3 =
-            T.let(
-              :C3,
-              Dodopayments::Payment::FailureDetails::CustomerTemplate::TaggedSymbol
-            )
-          C4 =
-            T.let(
-              :C4,
-              Dodopayments::Payment::FailureDetails::CustomerTemplate::TaggedSymbol
-            )
-          C5 =
-            T.let(
-              :C5,
-              Dodopayments::Payment::FailureDetails::CustomerTemplate::TaggedSymbol
-            )
-          C6 =
-            T.let(
-              :C6,
-              Dodopayments::Payment::FailureDetails::CustomerTemplate::TaggedSymbol
-            )
-          C7 =
-            T.let(
-              :C7,
-              Dodopayments::Payment::FailureDetails::CustomerTemplate::TaggedSymbol
-            )
-          C8 =
-            T.let(
-              :C8,
-              Dodopayments::Payment::FailureDetails::CustomerTemplate::TaggedSymbol
-            )
-          C9 =
-            T.let(
-              :C9,
-              Dodopayments::Payment::FailureDetails::CustomerTemplate::TaggedSymbol
-            )
-          C10 =
-            T.let(
-              :C10,
-              Dodopayments::Payment::FailureDetails::CustomerTemplate::TaggedSymbol
-            )
-          C11 =
-            T.let(
-              :C11,
-              Dodopayments::Payment::FailureDetails::CustomerTemplate::TaggedSymbol
-            )
-          C12 =
-            T.let(
-              :C12,
-              Dodopayments::Payment::FailureDetails::CustomerTemplate::TaggedSymbol
-            )
-          C13 =
-            T.let(
-              :C13,
-              Dodopayments::Payment::FailureDetails::CustomerTemplate::TaggedSymbol
-            )
-          C14 =
-            T.let(
-              :C14,
-              Dodopayments::Payment::FailureDetails::CustomerTemplate::TaggedSymbol
-            )
-          C15 =
-            T.let(
-              :C15,
-              Dodopayments::Payment::FailureDetails::CustomerTemplate::TaggedSymbol
-            )
-          C16 =
-            T.let(
-              :C16,
-              Dodopayments::Payment::FailureDetails::CustomerTemplate::TaggedSymbol
-            )
-          C17 =
-            T.let(
-              :C17,
-              Dodopayments::Payment::FailureDetails::CustomerTemplate::TaggedSymbol
-            )
-          C18 =
-            T.let(
-              :C18,
-              Dodopayments::Payment::FailureDetails::CustomerTemplate::TaggedSymbol
-            )
-          C19 =
-            T.let(
-              :C19,
-              Dodopayments::Payment::FailureDetails::CustomerTemplate::TaggedSymbol
-            )
-          C20 =
-            T.let(
-              :C20,
-              Dodopayments::Payment::FailureDetails::CustomerTemplate::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                Dodopayments::Payment::FailureDetails::CustomerTemplate::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
-
-        # Soft or hard decline.
-        module DeclineType
-          extend Dodopayments::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(Symbol, Dodopayments::Payment::FailureDetails::DeclineType)
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          SOFT =
-            T.let(
-              :soft,
-              Dodopayments::Payment::FailureDetails::DeclineType::TaggedSymbol
-            )
-          HARD =
-            T.let(
-              :hard,
-              Dodopayments::Payment::FailureDetails::DeclineType::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                Dodopayments::Payment::FailureDetails::DeclineType::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
-      end
-
       class ProductCart < Dodopayments::Internal::Type::BaseModel
         OrHash =
           T.type_alias do

data/rbi/dodopayments/models/payment_list_params.rbi

@@ -55,7 +55,8 @@ module Dodopayments
       sig { params(customer_id: String).void }
       attr_writer :customer_id
 
-      # 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.
       sig { returns(T.nilable(Integer)) }
       attr_reader :page_number
 
@@ -120,7 +121,8 @@ module Dodopayments
         currency: nil,
         # Filter by customer id
         customer_id: nil,
-        # 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.
         page_number: nil,
         # Page size default is 10 max is 100
         page_size: nil,

data/rbi/dodopayments/models/payout_created_webhook_event.rbi

@@ -0,0 +1,270 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class PayoutCreatedWebhookEvent < Dodopayments::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::PayoutCreatedWebhookEvent,
+            Dodopayments::Internal::AnyHash
+          )
+        end
+
+      # The business identifier
+      sig { returns(String) }
+      attr_accessor :business_id
+
+      sig { returns(Dodopayments::PayoutCreatedWebhookEvent::Data) }
+      attr_reader :data
+
+      sig do
+        params(data: Dodopayments::PayoutCreatedWebhookEvent::Data::OrHash).void
+      end
+      attr_writer :data
+
+      # The timestamp of when the event occurred
+      sig { returns(Time) }
+      attr_accessor :timestamp
+
+      # The event type
+      sig { returns(Symbol) }
+      attr_accessor :type
+
+      sig do
+        params(
+          business_id: String,
+          data: Dodopayments::PayoutCreatedWebhookEvent::Data::OrHash,
+          timestamp: Time,
+          type: Symbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The business identifier
+        business_id:,
+        data:,
+        # The timestamp of when the event occurred
+        timestamp:,
+        # The event type
+        type: :"payout.created"
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            business_id: String,
+            data: Dodopayments::PayoutCreatedWebhookEvent::Data,
+            timestamp: Time,
+            type: Symbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < Dodopayments::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::PayoutCreatedWebhookEvent::Data,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
+        # The total amount of the payout.
+        sig { returns(Integer) }
+        attr_accessor :amount
+
+        # The unique identifier of the business associated with the payout.
+        sig { returns(String) }
+        attr_accessor :business_id
+
+        # The total value of chargebacks associated with the payout.
+        sig { returns(Integer) }
+        attr_accessor :chargebacks
+
+        # The timestamp when the payout was created, in UTC.
+        sig { returns(Time) }
+        attr_accessor :created_at
+
+        # The currency of the payout, represented as an ISO 4217 currency code.
+        sig { returns(Dodopayments::Currency::TaggedSymbol) }
+        attr_accessor :currency
+
+        # The fee charged for processing the payout.
+        sig { returns(Integer) }
+        attr_accessor :fee
+
+        # The payment method used for the payout (e.g., bank transfer, card, etc.).
+        sig { returns(String) }
+        attr_accessor :payment_method
+
+        # The unique identifier of the payout.
+        sig { returns(String) }
+        attr_accessor :payout_id
+
+        # The total value of refunds associated with the payout.
+        sig { returns(Integer) }
+        attr_accessor :refunds
+
+        # The current status of the payout.
+        sig do
+          returns(
+            Dodopayments::PayoutCreatedWebhookEvent::Data::Status::TaggedSymbol
+          )
+        end
+        attr_accessor :status
+
+        # The tax applied to the payout.
+        sig { returns(Integer) }
+        attr_accessor :tax
+
+        # The timestamp when the payout was last updated, in UTC.
+        sig { returns(Time) }
+        attr_accessor :updated_at
+
+        # The name of the payout recipient or purpose.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :name
+
+        # The URL of the document associated with the payout.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :payout_document_url
+
+        # Any additional remarks or notes associated with the payout.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :remarks
+
+        sig do
+          params(
+            amount: Integer,
+            business_id: String,
+            chargebacks: Integer,
+            created_at: Time,
+            currency: Dodopayments::Currency::OrSymbol,
+            fee: Integer,
+            payment_method: String,
+            payout_id: String,
+            refunds: Integer,
+            status:
+              Dodopayments::PayoutCreatedWebhookEvent::Data::Status::OrSymbol,
+            tax: Integer,
+            updated_at: Time,
+            name: T.nilable(String),
+            payout_document_url: T.nilable(String),
+            remarks: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The total amount of the payout.
+          amount:,
+          # The unique identifier of the business associated with the payout.
+          business_id:,
+          # The total value of chargebacks associated with the payout.
+          chargebacks:,
+          # The timestamp when the payout was created, in UTC.
+          created_at:,
+          # The currency of the payout, represented as an ISO 4217 currency code.
+          currency:,
+          # The fee charged for processing the payout.
+          fee:,
+          # The payment method used for the payout (e.g., bank transfer, card, etc.).
+          payment_method:,
+          # The unique identifier of the payout.
+          payout_id:,
+          # The total value of refunds associated with the payout.
+          refunds:,
+          # The current status of the payout.
+          status:,
+          # The tax applied to the payout.
+          tax:,
+          # The timestamp when the payout was last updated, in UTC.
+          updated_at:,
+          # The name of the payout recipient or purpose.
+          name: nil,
+          # The URL of the document associated with the payout.
+          payout_document_url: nil,
+          # Any additional remarks or notes associated with the payout.
+          remarks: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              amount: Integer,
+              business_id: String,
+              chargebacks: Integer,
+              created_at: Time,
+              currency: Dodopayments::Currency::TaggedSymbol,
+              fee: Integer,
+              payment_method: String,
+              payout_id: String,
+              refunds: Integer,
+              status:
+                Dodopayments::PayoutCreatedWebhookEvent::Data::Status::TaggedSymbol,
+              tax: Integer,
+              updated_at: Time,
+              name: T.nilable(String),
+              payout_document_url: T.nilable(String),
+              remarks: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The current status of the payout.
+        module Status
+          extend Dodopayments::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Dodopayments::PayoutCreatedWebhookEvent::Data::Status
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          NOT_INITIATED =
+            T.let(
+              :not_initiated,
+              Dodopayments::PayoutCreatedWebhookEvent::Data::Status::TaggedSymbol
+            )
+          IN_PROGRESS =
+            T.let(
+              :in_progress,
+              Dodopayments::PayoutCreatedWebhookEvent::Data::Status::TaggedSymbol
+            )
+          ON_HOLD =
+            T.let(
+              :on_hold,
+              Dodopayments::PayoutCreatedWebhookEvent::Data::Status::TaggedSymbol
+            )
+          FAILED =
+            T.let(
+              :failed,
+              Dodopayments::PayoutCreatedWebhookEvent::Data::Status::TaggedSymbol
+            )
+          SUCCESS =
+            T.let(
+              :success,
+              Dodopayments::PayoutCreatedWebhookEvent::Data::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Dodopayments::PayoutCreatedWebhookEvent::Data::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end