dodopayments 1.52.5 → 1.53.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90035c1d14b5aa55b3c8e33db01257b8f45bb2636259d2aca65d08f77a8303b2
-  data.tar.gz: 17bb0b417c9f606ee48df9a06bec7ecf9b8d7b1985146d6c03190509aeddc775
+  metadata.gz: bb2f30302531705f194f8d09e1d5089cc9fe3fc8aea054da364ba62d46443711
+  data.tar.gz: 6adf25e6ee0b749862d00605d9df09e1264dd5bab4d7be103ae9007cc426a51a
 SHA512:
-  metadata.gz: 193a65895d8e20cf1f818a6ea8f725a00a0bffefeaaf46def43ec2f1c64fb4662e1c845cda63e72fa4f4df6e4ecbd485fe4153ddc4c7ea6d4333380002300b6a
-  data.tar.gz: 6a50f094b283c7d173271bba624b2cd95346f9519dc9f051d404e90852def09a57011afdb47f7765057cb915cf3197f8651e5109ea9cac8f09a85ab45791b4c6
+  metadata.gz: b5156a2dc8e2c6097bc665a6f1c8ba88e61df89ec439ec2c1e4b3e148260ef6f07e396d6f8ca49a8f388189a3d3532417dabbcc3511c9198742abd6e0101b11e
+  data.tar.gz: f438f2c43c49bb731a956491eb90da07f7576d2ae711c26fcdfa9a7647f2e8615104eb7a26e41e098cf1604e7bab472284703c3ac2762764145b07dfb8a347c7

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 1.53.2 (2025-09-13)
+
+Full Changelog: [v1.52.5...v1.53.2](https://github.com/dodopayments/dodopayments-ruby/compare/v1.52.5...v1.53.2)
+
+### Features
+
+* **api:** updated openapi spec to v1.53.2 with customer credits. ([c367cc9](https://github.com/dodopayments/dodopayments-ruby/commit/c367cc958324895dbb042f095a42a8db5f4dccee))
+
 ## 1.52.5 (2025-09-04)
 
 Full Changelog: [v1.52.4...v1.52.5](https://github.com/dodopayments/dodopayments-ruby/compare/v1.52.4...v1.52.5)

data/README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "dodopayments", "~> 1.52.5"
+gem "dodopayments", "~> 1.53.2"
 ```
 
 <!-- x-release-please-end -->

data/lib/dodopayments/models/customers/customer_wallet.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module Customers
+      class CustomerWallet < Dodopayments::Internal::Type::BaseModel
+        # @!attribute balance
+        #
+        #   @return [Integer]
+        required :balance, Integer
+
+        # @!attribute created_at
+        #
+        #   @return [Time]
+        required :created_at, Time
+
+        # @!attribute currency
+        #
+        #   @return [Symbol, Dodopayments::Models::Currency]
+        required :currency, enum: -> { Dodopayments::Currency }
+
+        # @!attribute customer_id
+        #
+        #   @return [String]
+        required :customer_id, String
+
+        # @!attribute updated_at
+        #
+        #   @return [Time]
+        required :updated_at, Time
+
+        # @!method initialize(balance:, created_at:, currency:, customer_id:, updated_at:)
+        #   @param balance [Integer]
+        #   @param created_at [Time]
+        #   @param currency [Symbol, Dodopayments::Models::Currency]
+        #   @param customer_id [String]
+        #   @param updated_at [Time]
+      end
+    end
+
+    CustomerWallet = Customers::CustomerWallet
+  end
+end

data/lib/dodopayments/models/customers/wallet_list_params.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module Customers
+      # @see Dodopayments::Resources::Customers::Wallets#list
+      class WalletListParams < Dodopayments::Internal::Type::BaseModel
+        extend Dodopayments::Internal::Type::RequestParameters::Converter
+        include Dodopayments::Internal::Type::RequestParameters
+
+        # @!method initialize(request_options: {})
+        #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/dodopayments/models/customers/wallet_list_response.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module Customers
+      # @see Dodopayments::Resources::Customers::Wallets#list
+      class WalletListResponse < Dodopayments::Internal::Type::BaseModel
+        # @!attribute items
+        #
+        #   @return [Array<Dodopayments::Models::Customers::CustomerWallet>]
+        required :items, -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::Customers::CustomerWallet] }
+
+        # @!attribute total_balance_usd
+        #   Sum of all wallet balances converted to USD (in smallest unit)
+        #
+        #   @return [Integer]
+        required :total_balance_usd, Integer
+
+        # @!method initialize(items:, total_balance_usd:)
+        #   @param items [Array<Dodopayments::Models::Customers::CustomerWallet>]
+        #
+        #   @param total_balance_usd [Integer] Sum of all wallet balances converted to USD (in smallest unit)
+      end
+    end
+  end
+end

data/lib/dodopayments/models/customers/wallets/customer_wallet_transaction.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module Customers
+      module Wallets
+        # @see Dodopayments::Resources::Customers::Wallets::LedgerEntries#list
+        class CustomerWalletTransaction < Dodopayments::Internal::Type::BaseModel
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute after_balance
+          #
+          #   @return [Integer]
+          required :after_balance, Integer
+
+          # @!attribute amount
+          #
+          #   @return [Integer]
+          required :amount, Integer
+
+          # @!attribute before_balance
+          #
+          #   @return [Integer]
+          required :before_balance, Integer
+
+          # @!attribute business_id
+          #
+          #   @return [String]
+          required :business_id, String
+
+          # @!attribute created_at
+          #
+          #   @return [Time]
+          required :created_at, Time
+
+          # @!attribute currency
+          #
+          #   @return [Symbol, Dodopayments::Models::Currency]
+          required :currency, enum: -> { Dodopayments::Currency }
+
+          # @!attribute customer_id
+          #
+          #   @return [String]
+          required :customer_id, String
+
+          # @!attribute event_type
+          #
+          #   @return [Symbol, Dodopayments::Models::Customers::Wallets::CustomerWalletTransaction::EventType]
+          required :event_type, enum: -> { Dodopayments::Customers::Wallets::CustomerWalletTransaction::EventType }
+
+          # @!attribute is_credit
+          #
+          #   @return [Boolean]
+          required :is_credit, Dodopayments::Internal::Type::Boolean
+
+          # @!attribute reason
+          #
+          #   @return [String, nil]
+          optional :reason, String, nil?: true
+
+          # @!attribute reference_object_id
+          #
+          #   @return [String, nil]
+          optional :reference_object_id, String, nil?: true
+
+          # @!method initialize(id:, after_balance:, amount:, before_balance:, business_id:, created_at:, currency:, customer_id:, event_type:, is_credit:, reason: nil, reference_object_id: nil)
+          #   @param id [String]
+          #   @param after_balance [Integer]
+          #   @param amount [Integer]
+          #   @param before_balance [Integer]
+          #   @param business_id [String]
+          #   @param created_at [Time]
+          #   @param currency [Symbol, Dodopayments::Models::Currency]
+          #   @param customer_id [String]
+          #   @param event_type [Symbol, Dodopayments::Models::Customers::Wallets::CustomerWalletTransaction::EventType]
+          #   @param is_credit [Boolean]
+          #   @param reason [String, nil]
+          #   @param reference_object_id [String, nil]
+
+          # @see Dodopayments::Models::Customers::Wallets::CustomerWalletTransaction#event_type
+          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
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dodopayments/models/customers/wallets/ledger_entry_create_params.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module Customers
+      module Wallets
+        # @see Dodopayments::Resources::Customers::Wallets::LedgerEntries#create
+        class LedgerEntryCreateParams < Dodopayments::Internal::Type::BaseModel
+          extend Dodopayments::Internal::Type::RequestParameters::Converter
+          include Dodopayments::Internal::Type::RequestParameters
+
+          # @!attribute amount
+          #
+          #   @return [Integer]
+          required :amount, Integer
+
+          # @!attribute currency
+          #   Currency of the wallet to adjust
+          #
+          #   @return [Symbol, Dodopayments::Models::Currency]
+          required :currency, enum: -> { Dodopayments::Currency }
+
+          # @!attribute entry_type
+          #   Type of ledger entry - credit or debit
+          #
+          #   @return [Symbol, Dodopayments::Models::Customers::Wallets::LedgerEntryCreateParams::EntryType]
+          required :entry_type, enum: -> { Dodopayments::Customers::Wallets::LedgerEntryCreateParams::EntryType }
+
+          # @!attribute idempotency_key
+          #   Optional idempotency key to prevent duplicate entries
+          #
+          #   @return [String, nil]
+          optional :idempotency_key, String, nil?: true
+
+          # @!attribute reason
+          #
+          #   @return [String, nil]
+          optional :reason, String, nil?: true
+
+          # @!method initialize(amount:, currency:, entry_type:, idempotency_key: nil, reason: nil, request_options: {})
+          #   @param amount [Integer]
+          #
+          #   @param currency [Symbol, Dodopayments::Models::Currency] Currency of the wallet to adjust
+          #
+          #   @param entry_type [Symbol, Dodopayments::Models::Customers::Wallets::LedgerEntryCreateParams::EntryType] Type of ledger entry - credit or debit
+          #
+          #   @param idempotency_key [String, nil] Optional idempotency key to prevent duplicate entries
+          #
+          #   @param reason [String, nil]
+          #
+          #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+
+          # Type of ledger entry - credit or debit
+          module EntryType
+            extend Dodopayments::Internal::Type::Enum
+
+            CREDIT = :credit
+            DEBIT = :debit
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dodopayments/models/customers/wallets/ledger_entry_list_params.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module Customers
+      module Wallets
+        # @see Dodopayments::Resources::Customers::Wallets::LedgerEntries#list
+        class LedgerEntryListParams < Dodopayments::Internal::Type::BaseModel
+          extend Dodopayments::Internal::Type::RequestParameters::Converter
+          include Dodopayments::Internal::Type::RequestParameters
+
+          # @!attribute currency
+          #   Optional currency filter
+          #
+          #   @return [Symbol, Dodopayments::Models::Currency, nil]
+          optional :currency, enum: -> { Dodopayments::Currency }
+
+          # @!attribute page_number
+          #
+          #   @return [Integer, nil]
+          optional :page_number, Integer
+
+          # @!attribute page_size
+          #
+          #   @return [Integer, nil]
+          optional :page_size, Integer
+
+          # @!method initialize(currency: nil, page_number: nil, page_size: nil, request_options: {})
+          #   @param currency [Symbol, Dodopayments::Models::Currency] Optional currency filter
+          #
+          #   @param page_number [Integer]
+          #
+          #   @param page_size [Integer]
+          #
+          #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/dodopayments/models/license_activate_response.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::Licenses#activate
+    class LicenseActivateResponse < Dodopayments::Internal::Type::BaseModel
+      # @!attribute id
+      #   License key instance ID
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute business_id
+      #   Business ID
+      #
+      #   @return [String]
+      required :business_id, String
+
+      # @!attribute created_at
+      #   Creation timestamp
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute customer
+      #   Limited customer details associated with the license key.
+      #
+      #   @return [Dodopayments::Models::CustomerLimitedDetails]
+      required :customer, -> { Dodopayments::CustomerLimitedDetails }
+
+      # @!attribute license_key_id
+      #   Associated license key ID
+      #
+      #   @return [String]
+      required :license_key_id, String
+
+      # @!attribute name
+      #   Instance name
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute product
+      #   Related product info. Present if the license key is tied to a product.
+      #
+      #   @return [Dodopayments::Models::LicenseActivateResponse::Product]
+      required :product, -> { Dodopayments::Models::LicenseActivateResponse::Product }
+
+      # @!method initialize(id:, business_id:, created_at:, customer:, license_key_id:, name:, product:)
+      #   @param id [String] License key instance ID
+      #
+      #   @param business_id [String] Business ID
+      #
+      #   @param created_at [Time] Creation timestamp
+      #
+      #   @param customer [Dodopayments::Models::CustomerLimitedDetails] Limited customer details associated with the license key.
+      #
+      #   @param license_key_id [String] Associated license key ID
+      #
+      #   @param name [String] Instance name
+      #
+      #   @param product [Dodopayments::Models::LicenseActivateResponse::Product] Related product info. Present if the license key is tied to a product.
+
+      # @see Dodopayments::Models::LicenseActivateResponse#product
+      class Product < Dodopayments::Internal::Type::BaseModel
+        # @!attribute product_id
+        #   Unique identifier for the product.
+        #
+        #   @return [String]
+        required :product_id, String
+
+        # @!attribute name
+        #   Name of the product, if set by the merchant.
+        #
+        #   @return [String, nil]
+        optional :name, String, nil?: true
+
+        # @!method initialize(product_id:, name: nil)
+        #   Related product info. Present if the license key is tied to a product.
+        #
+        #   @param product_id [String] Unique identifier for the product.
+        #
+        #   @param name [String, nil] Name of the product, if set by the merchant.
+      end
+    end
+  end
+end

data/lib/dodopayments/models/payment.rb

@@ -67,8 +67,8 @@ module Dodopayments
       # @!attribute refunds
       #   List of refunds issued for this payment
       #
-      #   @return [Array<Dodopayments::Models::Refund>]
-      required :refunds, -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::Refund] }
+      #   @return [Array<Dodopayments::Models::Payment::Refund>]
+      required :refunds, -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::Payment::Refund] }
 
       # @!attribute settlement_amount
       #   The amount that will be credited to your Dodo balance after currency conversion
@@ -224,7 +224,7 @@ module Dodopayments
       #
       #   @param payment_id [String] Unique identifier for the payment
       #
-      #   @param refunds [Array<Dodopayments::Models::Refund>] List of refunds issued for this payment
+      #   @param refunds [Array<Dodopayments::Models::Payment::Refund>] List of refunds issued for this payment
       #
       #   @param settlement_amount [Integer] The amount that will be credited to your Dodo balance after currency conversion
       #
@@ -266,6 +266,81 @@ module Dodopayments
       #
       #   @param updated_at [Time, nil] Timestamp when the payment was last updated
 
+      class Refund < Dodopayments::Internal::Type::BaseModel
+        # @!attribute business_id
+        #   The unique identifier of the business issuing the refund.
+        #
+        #   @return [String]
+        required :business_id, String
+
+        # @!attribute created_at
+        #   The timestamp of when the refund was created in UTC.
+        #
+        #   @return [Time]
+        required :created_at, Time
+
+        # @!attribute is_partial
+        #   If true the refund is a partial refund
+        #
+        #   @return [Boolean]
+        required :is_partial, Dodopayments::Internal::Type::Boolean
+
+        # @!attribute payment_id
+        #   The unique identifier of the payment associated with the refund.
+        #
+        #   @return [String]
+        required :payment_id, String
+
+        # @!attribute refund_id
+        #   The unique identifier of the refund.
+        #
+        #   @return [String]
+        required :refund_id, String
+
+        # @!attribute status
+        #   The current status of the refund.
+        #
+        #   @return [Symbol, Dodopayments::Models::RefundStatus]
+        required :status, enum: -> { Dodopayments::RefundStatus }
+
+        # @!attribute amount
+        #   The refunded amount.
+        #
+        #   @return [Integer, nil]
+        optional :amount, Integer, nil?: true
+
+        # @!attribute currency
+        #   The currency of the refund, represented as an ISO 4217 currency code.
+        #
+        #   @return [Symbol, Dodopayments::Models::Currency, nil]
+        optional :currency, enum: -> { Dodopayments::Currency }, nil?: true
+
+        # @!attribute reason
+        #   The reason provided for the refund, if any. Optional.
+        #
+        #   @return [String, nil]
+        optional :reason, String, nil?: true
+
+        # @!method initialize(business_id:, created_at:, is_partial:, payment_id:, refund_id:, status:, amount: nil, currency: nil, reason: nil)
+        #   @param business_id [String] The unique identifier of the business issuing the refund.
+        #
+        #   @param created_at [Time] The timestamp of when the refund was created in UTC.
+        #
+        #   @param is_partial [Boolean] If true the refund is a partial refund
+        #
+        #   @param payment_id [String] The unique identifier of the payment associated with the refund.
+        #
+        #   @param refund_id [String] The unique identifier of the refund.
+        #
+        #   @param status [Symbol, Dodopayments::Models::RefundStatus] The current status of the refund.
+        #
+        #   @param amount [Integer, nil] The refunded amount.
+        #
+        #   @param currency [Symbol, Dodopayments::Models::Currency, nil] The currency of the refund, represented as an ISO 4217 currency code.
+        #
+        #   @param reason [String, nil] The reason provided for the refund, if any. Optional.
+      end
+
       class ProductCart < Dodopayments::Internal::Type::BaseModel
         # @!attribute product_id
         #

data/lib/dodopayments/models/refund.rb

@@ -16,6 +16,12 @@ module Dodopayments
       #   @return [Time]
       required :created_at, Time
 
+      # @!attribute customer
+      #   Details about the customer for this refund (from the associated payment)
+      #
+      #   @return [Dodopayments::Models::CustomerLimitedDetails]
+      required :customer, -> { Dodopayments::CustomerLimitedDetails }
+
       # @!attribute is_partial
       #   If true the refund is a partial refund
       #
@@ -58,11 +64,13 @@ module Dodopayments
       #   @return [String, nil]
       optional :reason, String, nil?: true
 
-      # @!method initialize(business_id:, created_at:, is_partial:, payment_id:, refund_id:, status:, amount: nil, currency: nil, reason: nil)
+      # @!method initialize(business_id:, created_at:, customer:, is_partial:, payment_id:, refund_id:, status:, amount: nil, currency: nil, reason: nil)
       #   @param business_id [String] The unique identifier of the business issuing the refund.
       #
       #   @param created_at [Time] The timestamp of when the refund was created in UTC.
       #
+      #   @param customer [Dodopayments::Models::CustomerLimitedDetails] Details about the customer for this refund (from the associated payment)
+      #
       #   @param is_partial [Boolean] If true the refund is a partial refund
       #
       #   @param payment_id [String] The unique identifier of the payment associated with the refund.

data/lib/dodopayments/models/refund_list_response.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::Refunds#list
+    class RefundListResponse < Dodopayments::Internal::Type::BaseModel
+      # @!attribute business_id
+      #   The unique identifier of the business issuing the refund.
+      #
+      #   @return [String]
+      required :business_id, String
+
+      # @!attribute created_at
+      #   The timestamp of when the refund was created in UTC.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute is_partial
+      #   If true the refund is a partial refund
+      #
+      #   @return [Boolean]
+      required :is_partial, Dodopayments::Internal::Type::Boolean
+
+      # @!attribute payment_id
+      #   The unique identifier of the payment associated with the refund.
+      #
+      #   @return [String]
+      required :payment_id, String
+
+      # @!attribute refund_id
+      #   The unique identifier of the refund.
+      #
+      #   @return [String]
+      required :refund_id, String
+
+      # @!attribute status
+      #   The current status of the refund.
+      #
+      #   @return [Symbol, Dodopayments::Models::RefundStatus]
+      required :status, enum: -> { Dodopayments::RefundStatus }
+
+      # @!attribute amount
+      #   The refunded amount.
+      #
+      #   @return [Integer, nil]
+      optional :amount, Integer, nil?: true
+
+      # @!attribute currency
+      #   The currency of the refund, represented as an ISO 4217 currency code.
+      #
+      #   @return [Symbol, Dodopayments::Models::Currency, nil]
+      optional :currency, enum: -> { Dodopayments::Currency }, nil?: true
+
+      # @!attribute reason
+      #   The reason provided for the refund, if any. Optional.
+      #
+      #   @return [String, nil]
+      optional :reason, String, nil?: true
+
+      # @!method initialize(business_id:, created_at:, is_partial:, payment_id:, refund_id:, status:, amount: nil, currency: nil, reason: nil)
+      #   @param business_id [String] The unique identifier of the business issuing the refund.
+      #
+      #   @param created_at [Time] The timestamp of when the refund was created in UTC.
+      #
+      #   @param is_partial [Boolean] If true the refund is a partial refund
+      #
+      #   @param payment_id [String] The unique identifier of the payment associated with the refund.
+      #
+      #   @param refund_id [String] The unique identifier of the refund.
+      #
+      #   @param status [Symbol, Dodopayments::Models::RefundStatus] The current status of the refund.
+      #
+      #   @param amount [Integer, nil] The refunded amount.
+      #
+      #   @param currency [Symbol, Dodopayments::Models::Currency, nil] The currency of the refund, represented as an ISO 4217 currency code.
+      #
+      #   @param reason [String, nil] The reason provided for the refund, if any. Optional.
+    end
+  end
+end