dodopayments 2.4.1 → 2.6.0

data/rbi/dodopayments/models/dunning_started_webhook_event.rbi

@@ -0,0 +1,249 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class DunningStartedWebhookEvent < Dodopayments::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::DunningStartedWebhookEvent,
+            Dodopayments::Internal::AnyHash
+          )
+        end
+
+      # The business identifier
+      sig { returns(String) }
+      attr_accessor :business_id
+
+      # Webhook payload for dunning.started and dunning.recovered events
+      sig { returns(Dodopayments::DunningStartedWebhookEvent::Data) }
+      attr_reader :data
+
+      sig do
+        params(
+          data: Dodopayments::DunningStartedWebhookEvent::Data::OrHash
+        ).void
+      end
+      attr_writer :data
+
+      # The timestamp of when the event occurred
+      sig { returns(Time) }
+      attr_accessor :timestamp
+
+      # The event type
+      sig do
+        returns(Dodopayments::DunningStartedWebhookEvent::Type::TaggedSymbol)
+      end
+      attr_accessor :type
+
+      sig do
+        params(
+          business_id: String,
+          data: Dodopayments::DunningStartedWebhookEvent::Data::OrHash,
+          timestamp: Time,
+          type: Dodopayments::DunningStartedWebhookEvent::Type::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The business identifier
+        business_id:,
+        # Webhook payload for dunning.started and dunning.recovered events
+        data:,
+        # The timestamp of when the event occurred
+        timestamp:,
+        # The event type
+        type:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            business_id: String,
+            data: Dodopayments::DunningStartedWebhookEvent::Data,
+            timestamp: Time,
+            type: Dodopayments::DunningStartedWebhookEvent::Type::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < Dodopayments::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::DunningStartedWebhookEvent::Data,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
+        sig { returns(Time) }
+        attr_accessor :created_at
+
+        sig { returns(String) }
+        attr_accessor :customer_id
+
+        sig do
+          returns(
+            Dodopayments::DunningStartedWebhookEvent::Data::Status::TaggedSymbol
+          )
+        end
+        attr_accessor :status
+
+        sig { returns(String) }
+        attr_accessor :subscription_id
+
+        sig do
+          returns(
+            Dodopayments::DunningStartedWebhookEvent::Data::TriggerState::TaggedSymbol
+          )
+        end
+        attr_accessor :trigger_state
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :payment_id
+
+        # Webhook payload for dunning.started and dunning.recovered events
+        sig do
+          params(
+            created_at: Time,
+            customer_id: String,
+            status:
+              Dodopayments::DunningStartedWebhookEvent::Data::Status::OrSymbol,
+            subscription_id: String,
+            trigger_state:
+              Dodopayments::DunningStartedWebhookEvent::Data::TriggerState::OrSymbol,
+            payment_id: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          created_at:,
+          customer_id:,
+          status:,
+          subscription_id:,
+          trigger_state:,
+          payment_id: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              created_at: Time,
+              customer_id: String,
+              status:
+                Dodopayments::DunningStartedWebhookEvent::Data::Status::TaggedSymbol,
+              subscription_id: String,
+              trigger_state:
+                Dodopayments::DunningStartedWebhookEvent::Data::TriggerState::TaggedSymbol,
+              payment_id: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module Status
+          extend Dodopayments::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Dodopayments::DunningStartedWebhookEvent::Data::Status
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          RECOVERING =
+            T.let(
+              :recovering,
+              Dodopayments::DunningStartedWebhookEvent::Data::Status::TaggedSymbol
+            )
+          RECOVERED =
+            T.let(
+              :recovered,
+              Dodopayments::DunningStartedWebhookEvent::Data::Status::TaggedSymbol
+            )
+          EXHAUSTED =
+            T.let(
+              :exhausted,
+              Dodopayments::DunningStartedWebhookEvent::Data::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Dodopayments::DunningStartedWebhookEvent::Data::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        module TriggerState
+          extend Dodopayments::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Dodopayments::DunningStartedWebhookEvent::Data::TriggerState
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ON_HOLD =
+            T.let(
+              :on_hold,
+              Dodopayments::DunningStartedWebhookEvent::Data::TriggerState::TaggedSymbol
+            )
+          CANCELLED =
+            T.let(
+              :cancelled,
+              Dodopayments::DunningStartedWebhookEvent::Data::TriggerState::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Dodopayments::DunningStartedWebhookEvent::Data::TriggerState::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
+      # The event type
+      module Type
+        extend Dodopayments::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Dodopayments::DunningStartedWebhookEvent::Type)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        DUNNING_STARTED =
+          T.let(
+            :"dunning.started",
+            Dodopayments::DunningStartedWebhookEvent::Type::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Dodopayments::DunningStartedWebhookEvent::Type::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/payouts/breakup/detail_download_csv_params.rbi

@@ -0,0 +1,45 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    module Payouts
+      module Breakup
+        class DetailDownloadCsvParams < Dodopayments::Internal::Type::BaseModel
+          extend Dodopayments::Internal::Type::RequestParameters::Converter
+          include Dodopayments::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                Dodopayments::Payouts::Breakup::DetailDownloadCsvParams,
+                Dodopayments::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :payout_id
+
+          sig do
+            params(
+              payout_id: String,
+              request_options: Dodopayments::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(payout_id:, request_options: {})
+          end
+
+          sig do
+            override.returns(
+              {
+                payout_id: String,
+                request_options: Dodopayments::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/payouts/breakup/detail_list_params.rbi

@@ -0,0 +1,70 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    module Payouts
+      module Breakup
+        class DetailListParams < Dodopayments::Internal::Type::BaseModel
+          extend Dodopayments::Internal::Type::RequestParameters::Converter
+          include Dodopayments::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                Dodopayments::Payouts::Breakup::DetailListParams,
+                Dodopayments::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :payout_id
+
+          # Page number (0-indexed). Default: 0.
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :page_number
+
+          sig { params(page_number: Integer).void }
+          attr_writer :page_number
+
+          # Number of items per page. Default: 10, Max: 100.
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :page_size
+
+          sig { params(page_size: Integer).void }
+          attr_writer :page_size
+
+          sig do
+            params(
+              payout_id: String,
+              page_number: Integer,
+              page_size: Integer,
+              request_options: Dodopayments::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            payout_id:,
+            # Page number (0-indexed). Default: 0.
+            page_number: nil,
+            # Number of items per page. Default: 10, Max: 100.
+            page_size: nil,
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                payout_id: String,
+                page_number: Integer,
+                page_size: Integer,
+                request_options: Dodopayments::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/payouts/breakup/detail_list_response.rbi

@@ -0,0 +1,116 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    module Payouts
+      module Breakup
+        class DetailListResponse < Dodopayments::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Dodopayments::Models::Payouts::Breakup::DetailListResponse,
+                Dodopayments::Internal::AnyHash
+              )
+            end
+
+          # Unique identifier of the balance ledger entry.
+          sig { returns(String) }
+          attr_accessor :id
+
+          # Timestamp when this entry was created.
+          sig { returns(Time) }
+          attr_accessor :created_at
+
+          # The type of balance ledger event (e.g., "payment", "refund", "dispute",
+          # "payment_fees").
+          sig { returns(String) }
+          attr_accessor :event_type
+
+          # Original amount in the original currency (in smallest currency unit, e.g.,
+          # cents).
+          sig { returns(Integer) }
+          attr_accessor :original_amount
+
+          # Original currency as ISO 4217 code (e.g., "USD", "EUR").
+          sig { returns(String) }
+          attr_accessor :original_currency
+
+          # Amount in the payout's currency (in smallest currency unit). Uses cumulative
+          # rounding to ensure sum matches payout total exactly.
+          sig { returns(Integer) }
+          attr_accessor :payout_currency_amount
+
+          # USD equivalent of the original amount (in cents).
+          sig { returns(Integer) }
+          attr_accessor :usd_equivalent_amount
+
+          # Human-readable description of the transaction.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :description
+
+          # ID of the related object (e.g., payment ID, refund ID) if applicable.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :reference_object_id
+
+          # Individual balance ledger entry for a payout, with amounts pro-rated into the
+          # payout's currency.
+          sig do
+            params(
+              id: String,
+              created_at: Time,
+              event_type: String,
+              original_amount: Integer,
+              original_currency: String,
+              payout_currency_amount: Integer,
+              usd_equivalent_amount: Integer,
+              description: T.nilable(String),
+              reference_object_id: T.nilable(String)
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Unique identifier of the balance ledger entry.
+            id:,
+            # Timestamp when this entry was created.
+            created_at:,
+            # The type of balance ledger event (e.g., "payment", "refund", "dispute",
+            # "payment_fees").
+            event_type:,
+            # Original amount in the original currency (in smallest currency unit, e.g.,
+            # cents).
+            original_amount:,
+            # Original currency as ISO 4217 code (e.g., "USD", "EUR").
+            original_currency:,
+            # Amount in the payout's currency (in smallest currency unit). Uses cumulative
+            # rounding to ensure sum matches payout total exactly.
+            payout_currency_amount:,
+            # USD equivalent of the original amount (in cents).
+            usd_equivalent_amount:,
+            # Human-readable description of the transaction.
+            description: nil,
+            # ID of the related object (e.g., payment ID, refund ID) if applicable.
+            reference_object_id: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                created_at: Time,
+                event_type: String,
+                original_amount: Integer,
+                original_currency: String,
+                payout_currency_amount: Integer,
+                usd_equivalent_amount: Integer,
+                description: T.nilable(String),
+                reference_object_id: T.nilable(String)
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/payouts/breakup_retrieve_params.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    module Payouts
+      class BreakupRetrieveParams < Dodopayments::Internal::Type::BaseModel
+        extend Dodopayments::Internal::Type::RequestParameters::Converter
+        include Dodopayments::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::Payouts::BreakupRetrieveParams,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :payout_id
+
+        sig do
+          params(
+            payout_id: String,
+            request_options: Dodopayments::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(payout_id:, request_options: {})
+        end
+
+        sig do
+          override.returns(
+            { payout_id: String, request_options: Dodopayments::RequestOptions }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/payouts/breakup_retrieve_response.rbi

@@ -0,0 +1,53 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    module Payouts
+      class BreakupRetrieveResponseItem < Dodopayments::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::Models::Payouts::BreakupRetrieveResponseItem,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
+        # The type of balance ledger event (e.g., "payment", "refund", "dispute",
+        # "payment_fees").
+        sig { returns(String) }
+        attr_accessor :event_type
+
+        # Total amount for this event type in the payout's currency (in smallest currency
+        # unit, e.g., cents).
+        sig { returns(Integer) }
+        attr_accessor :total
+
+        # Payout breakup aggregated by event type, with amounts in the payout's currency.
+        sig do
+          params(event_type: String, total: Integer).returns(T.attached_class)
+        end
+        def self.new(
+          # The type of balance ledger event (e.g., "payment", "refund", "dispute",
+          # "payment_fees").
+          event_type:,
+          # Total amount for this event type in the payout's currency (in smallest currency
+          # unit, e.g., cents).
+          total:
+        )
+        end
+
+        sig { override.returns({ event_type: String, total: Integer }) }
+        def to_hash
+        end
+      end
+
+      BreakupRetrieveResponse =
+        T.let(
+          Dodopayments::Internal::Type::ArrayOf[
+            Dodopayments::Models::Payouts::BreakupRetrieveResponseItem
+          ],
+          Dodopayments::Internal::Type::Converter
+        )
+    end
+  end
+end

data/rbi/dodopayments/models/subscription_update_params.rbi

@@ -29,6 +29,15 @@ module Dodopayments
       sig { returns(T.nilable(T::Boolean)) }
       attr_accessor :cancel_at_next_billing_date
 
+      sig do
+        returns(
+          T.nilable(
+            Dodopayments::SubscriptionUpdateParams::CancelReason::OrSymbol
+          )
+        )
+      end
+      attr_accessor :cancel_reason
+
       # Update credit entitlement cart settings
       sig do
         returns(
@@ -78,6 +87,10 @@ module Dodopayments
           subscription_id: String,
           billing: T.nilable(Dodopayments::BillingAddress::OrHash),
           cancel_at_next_billing_date: T.nilable(T::Boolean),
+          cancel_reason:
+            T.nilable(
+              Dodopayments::SubscriptionUpdateParams::CancelReason::OrSymbol
+            ),
           credit_entitlement_cart:
             T.nilable(
               T::Array[
@@ -101,6 +114,7 @@ module Dodopayments
         billing: nil,
         # When set, the subscription will remain active until the end of billing period
         cancel_at_next_billing_date: nil,
+        cancel_reason: nil,
         # Update credit entitlement cart settings
         credit_entitlement_cart: nil,
         customer_name: nil,
@@ -119,6 +133,10 @@ module Dodopayments
             subscription_id: String,
             billing: T.nilable(Dodopayments::BillingAddress),
             cancel_at_next_billing_date: T.nilable(T::Boolean),
+            cancel_reason:
+              T.nilable(
+                Dodopayments::SubscriptionUpdateParams::CancelReason::OrSymbol
+              ),
             credit_entitlement_cart:
               T.nilable(
                 T::Array[
@@ -141,6 +159,42 @@ module Dodopayments
       def to_hash
       end
 
+      module CancelReason
+        extend Dodopayments::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Dodopayments::SubscriptionUpdateParams::CancelReason)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        CANCELLED_BY_CUSTOMER =
+          T.let(
+            :cancelled_by_customer,
+            Dodopayments::SubscriptionUpdateParams::CancelReason::TaggedSymbol
+          )
+        CANCELLED_BY_MERCHANT =
+          T.let(
+            :cancelled_by_merchant,
+            Dodopayments::SubscriptionUpdateParams::CancelReason::TaggedSymbol
+          )
+        CANCELLED_BY_MERCHANT_SEND_DUNNING =
+          T.let(
+            :cancelled_by_merchant_send_dunning,
+            Dodopayments::SubscriptionUpdateParams::CancelReason::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Dodopayments::SubscriptionUpdateParams::CancelReason::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
       class CreditEntitlementCart < Dodopayments::Internal::Type::BaseModel
         OrHash =
           T.type_alias do

data/rbi/dodopayments/models/unsafe_unwrap_webhook_event.rbi

@@ -8,6 +8,8 @@ module Dodopayments
       Variants =
         T.type_alias do
           T.any(
+            Dodopayments::AbandonedCheckoutDetectedWebhookEvent,
+            Dodopayments::AbandonedCheckoutRecoveredWebhookEvent,
             Dodopayments::CreditAddedWebhookEvent,
             Dodopayments::CreditBalanceLowWebhookEvent,
             Dodopayments::CreditDeductedWebhookEvent,
@@ -23,6 +25,8 @@ module Dodopayments
             Dodopayments::DisputeLostWebhookEvent,
             Dodopayments::DisputeOpenedWebhookEvent,
             Dodopayments::DisputeWonWebhookEvent,
+            Dodopayments::DunningRecoveredWebhookEvent,
+            Dodopayments::DunningStartedWebhookEvent,
             Dodopayments::LicenseKeyCreatedWebhookEvent,
             Dodopayments::PaymentCancelledWebhookEvent,
             Dodopayments::PaymentFailedWebhookEvent,

data/rbi/dodopayments/models/unwrap_webhook_event.rbi

@@ -8,6 +8,8 @@ module Dodopayments
       Variants =
         T.type_alias do
           T.any(
+            Dodopayments::AbandonedCheckoutDetectedWebhookEvent,
+            Dodopayments::AbandonedCheckoutRecoveredWebhookEvent,
             Dodopayments::CreditAddedWebhookEvent,
             Dodopayments::CreditBalanceLowWebhookEvent,
             Dodopayments::CreditDeductedWebhookEvent,
@@ -23,6 +25,8 @@ module Dodopayments
             Dodopayments::DisputeLostWebhookEvent,
             Dodopayments::DisputeOpenedWebhookEvent,
             Dodopayments::DisputeWonWebhookEvent,
+            Dodopayments::DunningRecoveredWebhookEvent,
+            Dodopayments::DunningStartedWebhookEvent,
             Dodopayments::LicenseKeyCreatedWebhookEvent,
             Dodopayments::PaymentCancelledWebhookEvent,
             Dodopayments::PaymentFailedWebhookEvent,