dodopayments 1.52.5 → 1.53.2

data/rbi/dodopayments/models/subscription_charge_params.rbi

@@ -25,6 +25,26 @@ module Dodopayments
       sig { returns(T.nilable(T::Boolean)) }
       attr_accessor :adaptive_currency_fees_inclusive
 
+      # Specify how customer balance is used for the payment
+      sig do
+        returns(
+          T.nilable(
+            Dodopayments::SubscriptionChargeParams::CustomerBalanceConfig
+          )
+        )
+      end
+      attr_reader :customer_balance_config
+
+      sig do
+        params(
+          customer_balance_config:
+            T.nilable(
+              Dodopayments::SubscriptionChargeParams::CustomerBalanceConfig::OrHash
+            )
+        ).void
+      end
+      attr_writer :customer_balance_config
+
       # Metadata for the payment. If not passed, the metadata of the subscription will
       # be taken
       sig { returns(T.nilable(T::Hash[Symbol, String])) }
@@ -44,6 +64,10 @@ module Dodopayments
         params(
           product_price: Integer,
           adaptive_currency_fees_inclusive: T.nilable(T::Boolean),
+          customer_balance_config:
+            T.nilable(
+              Dodopayments::SubscriptionChargeParams::CustomerBalanceConfig::OrHash
+            ),
           metadata: T.nilable(T::Hash[Symbol, String]),
           product_currency: T.nilable(Dodopayments::Currency::OrSymbol),
           product_description: T.nilable(String),
@@ -58,6 +82,8 @@ module Dodopayments
         # added on top (false). This field is ignored if adaptive pricing is not enabled
         # for the business.
         adaptive_currency_fees_inclusive: nil,
+        # Specify how customer balance is used for the payment
+        customer_balance_config: nil,
         # Metadata for the payment. If not passed, the metadata of the subscription will
         # be taken
         metadata: nil,
@@ -76,6 +102,10 @@ module Dodopayments
           {
             product_price: Integer,
             adaptive_currency_fees_inclusive: T.nilable(T::Boolean),
+            customer_balance_config:
+              T.nilable(
+                Dodopayments::SubscriptionChargeParams::CustomerBalanceConfig
+              ),
             metadata: T.nilable(T::Hash[Symbol, String]),
             product_currency: T.nilable(Dodopayments::Currency::OrSymbol),
             product_description: T.nilable(String),
@@ -85,6 +115,50 @@ module Dodopayments
       end
       def to_hash
       end
+
+      class CustomerBalanceConfig < Dodopayments::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::SubscriptionChargeParams::CustomerBalanceConfig,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
+        # Allows Customer Credit to be purchased to settle payments
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_accessor :allow_customer_credits_purchase
+
+        # Allows Customer Credit Balance to be used to settle payments
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_accessor :allow_customer_credits_usage
+
+        # Specify how customer balance is used for the payment
+        sig do
+          params(
+            allow_customer_credits_purchase: T.nilable(T::Boolean),
+            allow_customer_credits_usage: T.nilable(T::Boolean)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Allows Customer Credit to be purchased to settle payments
+          allow_customer_credits_purchase: nil,
+          # Allows Customer Credit Balance to be used to settle payments
+          allow_customer_credits_usage: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              allow_customer_credits_purchase: T.nilable(T::Boolean),
+              allow_customer_credits_usage: T.nilable(T::Boolean)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
     end
   end
 end

data/rbi/dodopayments/resources/customers/wallets/ledger_entries.rbi

@@ -0,0 +1,67 @@
+# typed: strong
+
+module Dodopayments
+  module Resources
+    class Customers
+      class Wallets
+        class LedgerEntries
+          sig do
+            params(
+              customer_id: String,
+              amount: Integer,
+              currency: Dodopayments::Currency::OrSymbol,
+              entry_type:
+                Dodopayments::Customers::Wallets::LedgerEntryCreateParams::EntryType::OrSymbol,
+              idempotency_key: T.nilable(String),
+              reason: T.nilable(String),
+              request_options: Dodopayments::RequestOptions::OrHash
+            ).returns(Dodopayments::Customers::CustomerWallet)
+          end
+          def create(
+            # Customer ID
+            customer_id,
+            amount:,
+            # Currency of the wallet to adjust
+            currency:,
+            # Type of ledger entry - credit or debit
+            entry_type:,
+            # Optional idempotency key to prevent duplicate entries
+            idempotency_key: nil,
+            reason: nil,
+            request_options: {}
+          )
+          end
+
+          sig do
+            params(
+              customer_id: String,
+              currency: Dodopayments::Currency::OrSymbol,
+              page_number: Integer,
+              page_size: Integer,
+              request_options: Dodopayments::RequestOptions::OrHash
+            ).returns(
+              Dodopayments::Internal::DefaultPageNumberPagination[
+                Dodopayments::Customers::Wallets::CustomerWalletTransaction
+              ]
+            )
+          end
+          def list(
+            # Customer ID
+            customer_id,
+            # Optional currency filter
+            currency: nil,
+            page_number: nil,
+            page_size: nil,
+            request_options: {}
+          )
+          end
+
+          # @api private
+          sig { params(client: Dodopayments::Client).returns(T.attached_class) }
+          def self.new(client:)
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/resources/customers/wallets.rbi

@@ -0,0 +1,32 @@
+# typed: strong
+
+module Dodopayments
+  module Resources
+    class Customers
+      class Wallets
+        sig do
+          returns(Dodopayments::Resources::Customers::Wallets::LedgerEntries)
+        end
+        attr_reader :ledger_entries
+
+        sig do
+          params(
+            customer_id: String,
+            request_options: Dodopayments::RequestOptions::OrHash
+          ).returns(Dodopayments::Models::Customers::WalletListResponse)
+        end
+        def list(
+          # Customer ID
+          customer_id,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Dodopayments::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/resources/customers.rbi

@@ -6,6 +6,9 @@ module Dodopayments
       sig { returns(Dodopayments::Resources::Customers::CustomerPortal) }
       attr_reader :customer_portal
 
+      sig { returns(Dodopayments::Resources::Customers::Wallets) }
+      attr_reader :wallets
+
       sig do
         params(
           email: String,

data/rbi/dodopayments/resources/licenses.rbi

@@ -8,7 +8,7 @@ module Dodopayments
           license_key: String,
           name: String,
           request_options: Dodopayments::RequestOptions::OrHash
-        ).returns(Dodopayments::LicenseKeyInstance)
+        ).returns(Dodopayments::Models::LicenseActivateResponse)
       end
       def activate(license_key:, name:, request_options: {})
       end

data/rbi/dodopayments/resources/refunds.rbi

@@ -47,7 +47,7 @@ module Dodopayments
           request_options: Dodopayments::RequestOptions::OrHash
         ).returns(
           Dodopayments::Internal::DefaultPageNumberPagination[
-            Dodopayments::Refund
+            Dodopayments::Models::RefundListResponse
           ]
         )
       end

data/rbi/dodopayments/resources/subscriptions.rbi

@@ -181,6 +181,10 @@ module Dodopayments
           subscription_id: String,
           product_price: Integer,
           adaptive_currency_fees_inclusive: T.nilable(T::Boolean),
+          customer_balance_config:
+            T.nilable(
+              Dodopayments::SubscriptionChargeParams::CustomerBalanceConfig::OrHash
+            ),
           metadata: T.nilable(T::Hash[Symbol, String]),
           product_currency: T.nilable(Dodopayments::Currency::OrSymbol),
           product_description: T.nilable(String),
@@ -197,6 +201,8 @@ module Dodopayments
         # added on top (false). This field is ignored if adaptive pricing is not enabled
         # for the business.
         adaptive_currency_fees_inclusive: nil,
+        # Specify how customer balance is used for the payment
+        customer_balance_config: nil,
         # Metadata for the payment. If not passed, the metadata of the subscription will
         # be taken
         metadata: nil,

data/sig/dodopayments/models/customers/customer_wallet.rbs

@@ -0,0 +1,44 @@
+module Dodopayments
+  module Models
+    class CustomerWallet = Customers::CustomerWallet
+
+    module Customers
+      type customer_wallet =
+        {
+          balance: Integer,
+          created_at: Time,
+          currency: Dodopayments::Models::currency,
+          customer_id: String,
+          updated_at: Time
+        }
+
+      class CustomerWallet < Dodopayments::Internal::Type::BaseModel
+        attr_accessor balance: Integer
+
+        attr_accessor created_at: Time
+
+        attr_accessor currency: Dodopayments::Models::currency
+
+        attr_accessor customer_id: String
+
+        attr_accessor updated_at: Time
+
+        def initialize: (
+          balance: Integer,
+          created_at: Time,
+          currency: Dodopayments::Models::currency,
+          customer_id: String,
+          updated_at: Time
+        ) -> void
+
+        def to_hash: -> {
+          balance: Integer,
+          created_at: Time,
+          currency: Dodopayments::Models::currency,
+          customer_id: String,
+          updated_at: Time
+        }
+      end
+    end
+  end
+end

data/sig/dodopayments/models/customers/wallet_list_params.rbs

@@ -0,0 +1,17 @@
+module Dodopayments
+  module Models
+    module Customers
+      type wallet_list_params =
+        {  } & Dodopayments::Internal::Type::request_parameters
+
+      class WalletListParams < Dodopayments::Internal::Type::BaseModel
+        extend Dodopayments::Internal::Type::RequestParameters::Converter
+        include Dodopayments::Internal::Type::RequestParameters
+
+        def initialize: (?request_options: Dodopayments::request_opts) -> void
+
+        def to_hash: -> { request_options: Dodopayments::RequestOptions }
+      end
+    end
+  end
+end

data/sig/dodopayments/models/customers/wallet_list_response.rbs

@@ -0,0 +1,27 @@
+module Dodopayments
+  module Models
+    module Customers
+      type wallet_list_response =
+        {
+          items: ::Array[Dodopayments::Customers::CustomerWallet],
+          total_balance_usd: Integer
+        }
+
+      class WalletListResponse < Dodopayments::Internal::Type::BaseModel
+        attr_accessor items: ::Array[Dodopayments::Customers::CustomerWallet]
+
+        attr_accessor total_balance_usd: Integer
+
+        def initialize: (
+          items: ::Array[Dodopayments::Customers::CustomerWallet],
+          total_balance_usd: Integer
+        ) -> void
+
+        def to_hash: -> {
+          items: ::Array[Dodopayments::Customers::CustomerWallet],
+          total_balance_usd: Integer
+        }
+      end
+    end
+  end
+end

data/sig/dodopayments/models/customers/wallets/customer_wallet_transaction.rbs

@@ -0,0 +1,102 @@
+module Dodopayments
+  module Models
+    module Customers
+      module Wallets
+        type customer_wallet_transaction =
+          {
+            id: String,
+            after_balance: Integer,
+            amount: Integer,
+            before_balance: Integer,
+            business_id: String,
+            created_at: Time,
+            currency: Dodopayments::Models::currency,
+            customer_id: String,
+            event_type: Dodopayments::Models::Customers::Wallets::CustomerWalletTransaction::event_type,
+            is_credit: bool,
+            reason: String?,
+            reference_object_id: String?
+          }
+
+        class CustomerWalletTransaction < Dodopayments::Internal::Type::BaseModel
+          attr_accessor id: String
+
+          attr_accessor after_balance: Integer
+
+          attr_accessor amount: Integer
+
+          attr_accessor before_balance: Integer
+
+          attr_accessor business_id: String
+
+          attr_accessor created_at: Time
+
+          attr_accessor currency: Dodopayments::Models::currency
+
+          attr_accessor customer_id: String
+
+          attr_accessor event_type: Dodopayments::Models::Customers::Wallets::CustomerWalletTransaction::event_type
+
+          attr_accessor is_credit: bool
+
+          attr_accessor reason: String?
+
+          attr_accessor reference_object_id: String?
+
+          def initialize: (
+            id: String,
+            after_balance: Integer,
+            amount: Integer,
+            before_balance: Integer,
+            business_id: String,
+            created_at: Time,
+            currency: Dodopayments::Models::currency,
+            customer_id: String,
+            event_type: Dodopayments::Models::Customers::Wallets::CustomerWalletTransaction::event_type,
+            is_credit: bool,
+            ?reason: String?,
+            ?reference_object_id: String?
+          ) -> void
+
+          def to_hash: -> {
+            id: String,
+            after_balance: Integer,
+            amount: Integer,
+            before_balance: Integer,
+            business_id: String,
+            created_at: Time,
+            currency: Dodopayments::Models::currency,
+            customer_id: String,
+            event_type: Dodopayments::Models::Customers::Wallets::CustomerWalletTransaction::event_type,
+            is_credit: bool,
+            reason: String?,
+            reference_object_id: String?
+          }
+
+          type event_type =
+            :payment
+            | :payment_reversal
+            | :refund
+            | :refund_reversal
+            | :dispute
+            | :dispute_reversal
+            | :merchant_adjustment
+
+          module EventType
+            extend Dodopayments::Internal::Type::Enum
+
+            PAYMENT: :payment
+            PAYMENT_REVERSAL: :payment_reversal
+            REFUND: :refund
+            REFUND_REVERSAL: :refund_reversal
+            DISPUTE: :dispute
+            DISPUTE_REVERSAL: :dispute_reversal
+            MERCHANT_ADJUSTMENT: :merchant_adjustment
+
+            def self?.values: -> ::Array[Dodopayments::Models::Customers::Wallets::CustomerWalletTransaction::event_type]
+          end
+        end
+      end
+    end
+  end
+end

data/sig/dodopayments/models/customers/wallets/ledger_entry_create_params.rbs

@@ -0,0 +1,61 @@
+module Dodopayments
+  module Models
+    module Customers
+      module Wallets
+        type ledger_entry_create_params =
+          {
+            amount: Integer,
+            currency: Dodopayments::Models::currency,
+            entry_type: Dodopayments::Models::Customers::Wallets::LedgerEntryCreateParams::entry_type,
+            idempotency_key: String?,
+            reason: String?
+          }
+          & Dodopayments::Internal::Type::request_parameters
+
+        class LedgerEntryCreateParams < Dodopayments::Internal::Type::BaseModel
+          extend Dodopayments::Internal::Type::RequestParameters::Converter
+          include Dodopayments::Internal::Type::RequestParameters
+
+          attr_accessor amount: Integer
+
+          attr_accessor currency: Dodopayments::Models::currency
+
+          attr_accessor entry_type: Dodopayments::Models::Customers::Wallets::LedgerEntryCreateParams::entry_type
+
+          attr_accessor idempotency_key: String?
+
+          attr_accessor reason: String?
+
+          def initialize: (
+            amount: Integer,
+            currency: Dodopayments::Models::currency,
+            entry_type: Dodopayments::Models::Customers::Wallets::LedgerEntryCreateParams::entry_type,
+            ?idempotency_key: String?,
+            ?reason: String?,
+            ?request_options: Dodopayments::request_opts
+          ) -> void
+
+          def to_hash: -> {
+            amount: Integer,
+            currency: Dodopayments::Models::currency,
+            entry_type: Dodopayments::Models::Customers::Wallets::LedgerEntryCreateParams::entry_type,
+            idempotency_key: String?,
+            reason: String?,
+            request_options: Dodopayments::RequestOptions
+          }
+
+          type entry_type = :credit | :debit
+
+          module EntryType
+            extend Dodopayments::Internal::Type::Enum
+
+            CREDIT: :credit
+            DEBIT: :debit
+
+            def self?.values: -> ::Array[Dodopayments::Models::Customers::Wallets::LedgerEntryCreateParams::entry_type]
+          end
+        end
+      end
+    end
+  end
+end

data/sig/dodopayments/models/customers/wallets/ledger_entry_list_params.rbs

@@ -0,0 +1,48 @@
+module Dodopayments
+  module Models
+    module Customers
+      module Wallets
+        type ledger_entry_list_params =
+          {
+            currency: Dodopayments::Models::currency,
+            page_number: Integer,
+            page_size: Integer
+          }
+          & Dodopayments::Internal::Type::request_parameters
+
+        class LedgerEntryListParams < Dodopayments::Internal::Type::BaseModel
+          extend Dodopayments::Internal::Type::RequestParameters::Converter
+          include Dodopayments::Internal::Type::RequestParameters
+
+          attr_reader currency: Dodopayments::Models::currency?
+
+          def currency=: (
+            Dodopayments::Models::currency
+          ) -> Dodopayments::Models::currency
+
+          attr_reader page_number: Integer?
+
+          def page_number=: (Integer) -> Integer
+
+          attr_reader page_size: Integer?
+
+          def page_size=: (Integer) -> Integer
+
+          def initialize: (
+            ?currency: Dodopayments::Models::currency,
+            ?page_number: Integer,
+            ?page_size: Integer,
+            ?request_options: Dodopayments::request_opts
+          ) -> void
+
+          def to_hash: -> {
+            currency: Dodopayments::Models::currency,
+            page_number: Integer,
+            page_size: Integer,
+            request_options: Dodopayments::RequestOptions
+          }
+        end
+      end
+    end
+  end
+end

data/sig/dodopayments/models/license_activate_response.rbs

@@ -0,0 +1,62 @@
+module Dodopayments
+  module Models
+    type license_activate_response =
+      {
+        id: String,
+        business_id: String,
+        created_at: Time,
+        customer: Dodopayments::CustomerLimitedDetails,
+        license_key_id: String,
+        name: String,
+        product: Dodopayments::Models::LicenseActivateResponse::Product
+      }
+
+    class LicenseActivateResponse < Dodopayments::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor business_id: String
+
+      attr_accessor created_at: Time
+
+      attr_accessor customer: Dodopayments::CustomerLimitedDetails
+
+      attr_accessor license_key_id: String
+
+      attr_accessor name: String
+
+      attr_accessor product: Dodopayments::Models::LicenseActivateResponse::Product
+
+      def initialize: (
+        id: String,
+        business_id: String,
+        created_at: Time,
+        customer: Dodopayments::CustomerLimitedDetails,
+        license_key_id: String,
+        name: String,
+        product: Dodopayments::Models::LicenseActivateResponse::Product
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        business_id: String,
+        created_at: Time,
+        customer: Dodopayments::CustomerLimitedDetails,
+        license_key_id: String,
+        name: String,
+        product: Dodopayments::Models::LicenseActivateResponse::Product
+      }
+
+      type product = { product_id: String, name: String? }
+
+      class Product < Dodopayments::Internal::Type::BaseModel
+        attr_accessor product_id: String
+
+        attr_accessor name: String?
+
+        def initialize: (product_id: String, ?name: String?) -> void
+
+        def to_hash: -> { product_id: String, name: String? }
+      end
+    end
+  end
+end