dodopayments 2.21.0 → 2.22.0

data/rbi/dodopayments/models/webhook_payload.rbi

@@ -20,6 +20,7 @@ module Dodopayments
             Dodopayments::WebhookPayload::Data::Refund,
             Dodopayments::WebhookPayload::Data::Dispute,
             Dodopayments::WebhookPayload::Data::LicenseKey,
+            Dodopayments::WebhookPayload::Data::Payout,
             Dodopayments::WebhookPayload::Data::CreditLedgerEntry,
             Dodopayments::WebhookPayload::Data::CreditBalanceLow,
             Dodopayments::WebhookPayload::Data::AbandonedCheckout,
@@ -49,6 +50,7 @@ module Dodopayments
               Dodopayments::WebhookPayload::Data::Refund::OrHash,
               Dodopayments::WebhookPayload::Data::Dispute::OrHash,
               Dodopayments::WebhookPayload::Data::LicenseKey::OrHash,
+              Dodopayments::WebhookPayload::Data::Payout::OrHash,
               Dodopayments::WebhookPayload::Data::CreditLedgerEntry::OrHash,
               Dodopayments::WebhookPayload::Data::CreditBalanceLow::OrHash,
               Dodopayments::WebhookPayload::Data::AbandonedCheckout::OrHash,
@@ -82,6 +84,7 @@ module Dodopayments
                 Dodopayments::WebhookPayload::Data::Refund,
                 Dodopayments::WebhookPayload::Data::Dispute,
                 Dodopayments::WebhookPayload::Data::LicenseKey,
+                Dodopayments::WebhookPayload::Data::Payout,
                 Dodopayments::WebhookPayload::Data::CreditLedgerEntry,
                 Dodopayments::WebhookPayload::Data::CreditBalanceLow,
                 Dodopayments::WebhookPayload::Data::AbandonedCheckout,
@@ -108,6 +111,7 @@ module Dodopayments
               Dodopayments::WebhookPayload::Data::Refund,
               Dodopayments::WebhookPayload::Data::Dispute,
               Dodopayments::WebhookPayload::Data::LicenseKey,
+              Dodopayments::WebhookPayload::Data::Payout,
               Dodopayments::WebhookPayload::Data::CreditLedgerEntry,
               Dodopayments::WebhookPayload::Data::CreditBalanceLow,
               Dodopayments::WebhookPayload::Data::AbandonedCheckout,
@@ -222,6 +226,215 @@ module Dodopayments
           end
         end
 
+        class Payout < Dodopayments::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Dodopayments::WebhookPayload::Data::Payout,
+                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::OrSymbol) }
+          attr_accessor :currency
+
+          # The fee charged for processing the payout.
+          sig { returns(Integer) }
+          attr_accessor :fee
+
+          sig { returns(Symbol) }
+          attr_accessor :payload_type
+
+          # 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::WebhookPayload::Data::Payout::Status::OrSymbol
+            )
+          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::WebhookPayload::Data::Payout::Status::OrSymbol,
+              tax: Integer,
+              updated_at: Time,
+              name: T.nilable(String),
+              payout_document_url: T.nilable(String),
+              remarks: T.nilable(String),
+              payload_type: Symbol
+            ).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,
+            payload_type: :Payout
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                amount: Integer,
+                business_id: String,
+                chargebacks: Integer,
+                created_at: Time,
+                currency: Dodopayments::Currency::OrSymbol,
+                fee: Integer,
+                payload_type: Symbol,
+                payment_method: String,
+                payout_id: String,
+                refunds: Integer,
+                status:
+                  Dodopayments::WebhookPayload::Data::Payout::Status::OrSymbol,
+                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::WebhookPayload::Data::Payout::Status
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            NOT_INITIATED =
+              T.let(
+                :not_initiated,
+                Dodopayments::WebhookPayload::Data::Payout::Status::TaggedSymbol
+              )
+            IN_PROGRESS =
+              T.let(
+                :in_progress,
+                Dodopayments::WebhookPayload::Data::Payout::Status::TaggedSymbol
+              )
+            ON_HOLD =
+              T.let(
+                :on_hold,
+                Dodopayments::WebhookPayload::Data::Payout::Status::TaggedSymbol
+              )
+            FAILED =
+              T.let(
+                :failed,
+                Dodopayments::WebhookPayload::Data::Payout::Status::TaggedSymbol
+              )
+            SUCCESS =
+              T.let(
+                :success,
+                Dodopayments::WebhookPayload::Data::Payout::Status::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Dodopayments::WebhookPayload::Data::Payout::Status::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+
         class CreditLedgerEntry < Dodopayments::Models::CreditEntitlements::CreditLedgerEntry
           OrHash =
             T.type_alias do

data/rbi/dodopayments/models.rbi

@@ -381,10 +381,21 @@ module Dodopayments
   PaymentSucceededWebhookEvent =
     Dodopayments::Models::PaymentSucceededWebhookEvent
 
+  PayoutCreatedWebhookEvent = Dodopayments::Models::PayoutCreatedWebhookEvent
+
+  PayoutFailedWebhookEvent = Dodopayments::Models::PayoutFailedWebhookEvent
+
+  PayoutInProgressWebhookEvent =
+    Dodopayments::Models::PayoutInProgressWebhookEvent
+
   PayoutListParams = Dodopayments::Models::PayoutListParams
 
+  PayoutOnHoldWebhookEvent = Dodopayments::Models::PayoutOnHoldWebhookEvent
+
   Payouts = Dodopayments::Models::Payouts
 
+  PayoutSuccessWebhookEvent = Dodopayments::Models::PayoutSuccessWebhookEvent
+
   Price = Dodopayments::Models::Price
 
   Product = Dodopayments::Models::Product

data/rbi/dodopayments/resources/payments.rbi

@@ -137,7 +137,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/resources/webhooks.rbi

@@ -173,6 +173,11 @@ module Dodopayments
             Dodopayments::PaymentFailedWebhookEvent,
             Dodopayments::PaymentProcessingWebhookEvent,
             Dodopayments::PaymentSucceededWebhookEvent,
+            Dodopayments::PayoutCreatedWebhookEvent,
+            Dodopayments::PayoutFailedWebhookEvent,
+            Dodopayments::PayoutInProgressWebhookEvent,
+            Dodopayments::PayoutOnHoldWebhookEvent,
+            Dodopayments::PayoutSuccessWebhookEvent,
             Dodopayments::RefundFailedWebhookEvent,
             Dodopayments::RefundSucceededWebhookEvent,
             Dodopayments::SubscriptionActiveWebhookEvent,
@@ -229,6 +234,11 @@ module Dodopayments
             Dodopayments::PaymentFailedWebhookEvent,
             Dodopayments::PaymentProcessingWebhookEvent,
             Dodopayments::PaymentSucceededWebhookEvent,
+            Dodopayments::PayoutCreatedWebhookEvent,
+            Dodopayments::PayoutFailedWebhookEvent,
+            Dodopayments::PayoutInProgressWebhookEvent,
+            Dodopayments::PayoutOnHoldWebhookEvent,
+            Dodopayments::PayoutSuccessWebhookEvent,
             Dodopayments::RefundFailedWebhookEvent,
             Dodopayments::RefundSucceededWebhookEvent,
             Dodopayments::SubscriptionActiveWebhookEvent,

data/sig/dodopayments/models/payment.rbs

@@ -30,7 +30,6 @@ module Dodopayments
         discounts: ::Array[Dodopayments::DiscountDetail]?,
         error_code: String?,
         error_message: String?,
-        failure_details: Dodopayments::Payment::FailureDetails?,
         invoice_id: String?,
         invoice_url: String?,
         payment_link: String?,
@@ -103,8 +102,6 @@ module Dodopayments
 
       attr_accessor error_message: String?
 
-      attr_accessor failure_details: Dodopayments::Payment::FailureDetails?
-
       attr_accessor invoice_id: String?
 
       attr_accessor invoice_url: String?
@@ -160,7 +157,6 @@ module Dodopayments
         ?discounts: ::Array[Dodopayments::DiscountDetail]?,
         ?error_code: String?,
         ?error_message: String?,
-        ?failure_details: Dodopayments::Payment::FailureDetails?,
         ?invoice_id: String?,
         ?invoice_url: String?,
         ?payment_link: String?,
@@ -205,7 +201,6 @@ module Dodopayments
         discounts: ::Array[Dodopayments::DiscountDetail]?,
         error_code: String?,
         error_message: String?,
-        failure_details: Dodopayments::Payment::FailureDetails?,
         invoice_id: String?,
         invoice_url: String?,
         payment_link: String?,
@@ -233,136 +228,6 @@ module Dodopayments
         def self?.values: -> ::Array[Dodopayments::Models::Payment::payment_provider]
       end
 
-      type failure_details =
-        {
-          code: String,
-          customer_cta: Dodopayments::Models::Payment::FailureDetails::customer_cta,
-          customer_fixable: bool,
-          customer_message: String,
-          customer_template: Dodopayments::Models::Payment::FailureDetails::customer_template,
-          decline_type: Dodopayments::Models::Payment::FailureDetails::decline_type,
-          merchant_message: String
-        }
-
-      class FailureDetails < Dodopayments::Internal::Type::BaseModel
-        attr_accessor code: String
-
-        attr_accessor customer_cta: Dodopayments::Models::Payment::FailureDetails::customer_cta
-
-        attr_accessor customer_fixable: bool
-
-        attr_accessor customer_message: String
-
-        attr_accessor customer_template: Dodopayments::Models::Payment::FailureDetails::customer_template
-
-        attr_accessor decline_type: Dodopayments::Models::Payment::FailureDetails::decline_type
-
-        attr_accessor merchant_message: String
-
-        def initialize: (
-          code: String,
-          customer_cta: Dodopayments::Models::Payment::FailureDetails::customer_cta,
-          customer_fixable: bool,
-          customer_message: String,
-          customer_template: Dodopayments::Models::Payment::FailureDetails::customer_template,
-          decline_type: Dodopayments::Models::Payment::FailureDetails::decline_type,
-          merchant_message: String
-        ) -> void
-
-        def to_hash: -> {
-          code: String,
-          customer_cta: Dodopayments::Models::Payment::FailureDetails::customer_cta,
-          customer_fixable: bool,
-          customer_message: String,
-          customer_template: Dodopayments::Models::Payment::FailureDetails::customer_template,
-          decline_type: Dodopayments::Models::Payment::FailureDetails::decline_type,
-          merchant_message: String
-        }
-
-        type customer_cta =
-          :edit_and_retry
-          | :use_another_method
-          | :try_again
-          | :try_later
-          | :retry_and_verify
-          | :restart
-          | :update_method
-
-        module CustomerCta
-          extend Dodopayments::Internal::Type::Enum
-
-          EDIT_AND_RETRY: :edit_and_retry
-          USE_ANOTHER_METHOD: :use_another_method
-          TRY_AGAIN: :try_again
-          TRY_LATER: :try_later
-          RETRY_AND_VERIFY: :retry_and_verify
-          RESTART: :restart
-          UPDATE_METHOD: :update_method
-
-          def self?.values: -> ::Array[Dodopayments::Models::Payment::FailureDetails::customer_cta]
-        end
-
-        type customer_template =
-          :C1
-          | :C2
-          | :C3
-          | :C4
-          | :C5
-          | :C6
-          | :C7
-          | :C8
-          | :C9
-          | :C10
-          | :C11
-          | :C12
-          | :C13
-          | :C14
-          | :C15
-          | :C16
-          | :C17
-          | :C18
-          | :C19
-          | :C20
-
-        module CustomerTemplate
-          extend Dodopayments::Internal::Type::Enum
-
-          C1: :C1
-          C2: :C2
-          C3: :C3
-          C4: :C4
-          C5: :C5
-          C6: :C6
-          C7: :C7
-          C8: :C8
-          C9: :C9
-          C10: :C10
-          C11: :C11
-          C12: :C12
-          C13: :C13
-          C14: :C14
-          C15: :C15
-          C16: :C16
-          C17: :C17
-          C18: :C18
-          C19: :C19
-          C20: :C20
-
-          def self?.values: -> ::Array[Dodopayments::Models::Payment::FailureDetails::customer_template]
-        end
-
-        type decline_type = :soft | :hard
-
-        module DeclineType
-          extend Dodopayments::Internal::Type::Enum
-
-          SOFT: :soft
-          HARD: :hard
-
-          def self?.values: -> ::Array[Dodopayments::Models::Payment::FailureDetails::decline_type]
-        end
-      end
-
       type product_cart = { product_id: String, quantity: Integer }
 
       class ProductCart < Dodopayments::Internal::Type::BaseModel

data/sig/dodopayments/models/payout_created_webhook_event.rbs

@@ -0,0 +1,137 @@
+module Dodopayments
+  module Models
+    type payout_created_webhook_event =
+      {
+        business_id: String,
+        data: Dodopayments::PayoutCreatedWebhookEvent::Data,
+        timestamp: Time,
+        type: :"payout.created"
+      }
+
+    class PayoutCreatedWebhookEvent < Dodopayments::Internal::Type::BaseModel
+      attr_accessor business_id: String
+
+      attr_accessor data: Dodopayments::PayoutCreatedWebhookEvent::Data
+
+      attr_accessor timestamp: Time
+
+      attr_accessor type: :"payout.created"
+
+      def initialize: (
+        business_id: String,
+        data: Dodopayments::PayoutCreatedWebhookEvent::Data,
+        timestamp: Time,
+        ?type: :"payout.created"
+      ) -> void
+
+      def to_hash: -> {
+        business_id: String,
+        data: Dodopayments::PayoutCreatedWebhookEvent::Data,
+        timestamp: Time,
+        type: :"payout.created"
+      }
+
+      type data =
+        {
+          amount: Integer,
+          business_id: String,
+          chargebacks: Integer,
+          created_at: Time,
+          currency: Dodopayments::Models::currency,
+          fee: Integer,
+          payment_method: String,
+          payout_id: String,
+          refunds: Integer,
+          status: Dodopayments::Models::PayoutCreatedWebhookEvent::Data::status,
+          tax: Integer,
+          updated_at: Time,
+          name: String?,
+          payout_document_url: String?,
+          remarks: String?
+        }
+
+      class Data < Dodopayments::Internal::Type::BaseModel
+        attr_accessor amount: Integer
+
+        attr_accessor business_id: String
+
+        attr_accessor chargebacks: Integer
+
+        attr_accessor created_at: Time
+
+        attr_accessor currency: Dodopayments::Models::currency
+
+        attr_accessor fee: Integer
+
+        attr_accessor payment_method: String
+
+        attr_accessor payout_id: String
+
+        attr_accessor refunds: Integer
+
+        attr_accessor status: Dodopayments::Models::PayoutCreatedWebhookEvent::Data::status
+
+        attr_accessor tax: Integer
+
+        attr_accessor updated_at: Time
+
+        attr_accessor name: String?
+
+        attr_accessor payout_document_url: String?
+
+        attr_accessor remarks: String?
+
+        def initialize: (
+          amount: Integer,
+          business_id: String,
+          chargebacks: Integer,
+          created_at: Time,
+          currency: Dodopayments::Models::currency,
+          fee: Integer,
+          payment_method: String,
+          payout_id: String,
+          refunds: Integer,
+          status: Dodopayments::Models::PayoutCreatedWebhookEvent::Data::status,
+          tax: Integer,
+          updated_at: Time,
+          ?name: String?,
+          ?payout_document_url: String?,
+          ?remarks: String?
+        ) -> void
+
+        def to_hash: -> {
+          amount: Integer,
+          business_id: String,
+          chargebacks: Integer,
+          created_at: Time,
+          currency: Dodopayments::Models::currency,
+          fee: Integer,
+          payment_method: String,
+          payout_id: String,
+          refunds: Integer,
+          status: Dodopayments::Models::PayoutCreatedWebhookEvent::Data::status,
+          tax: Integer,
+          updated_at: Time,
+          name: String?,
+          payout_document_url: String?,
+          remarks: String?
+        }
+
+        type status =
+          :not_initiated | :in_progress | :on_hold | :failed | :success
+
+        module Status
+          extend Dodopayments::Internal::Type::Enum
+
+          NOT_INITIATED: :not_initiated
+          IN_PROGRESS: :in_progress
+          ON_HOLD: :on_hold
+          FAILED: :failed
+          SUCCESS: :success
+
+          def self?.values: -> ::Array[Dodopayments::Models::PayoutCreatedWebhookEvent::Data::status]
+        end
+      end
+    end
+  end
+end