dodopayments 2.27.0 → 2.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61c6a925f218355a2aba34cb88fa3d7c8437ee680117a6680d391f910b84b0aa
-  data.tar.gz: 8c87f0e94b56fa287717e63ce036a7a446658614002b28661f2a210ff5cf9238
+  metadata.gz: b32ea53fb134977455a92138cff5c8a7bceead17ce5eccdbdd485356d1f3a5ba
+  data.tar.gz: d414ba715f8003dd68dedc9794653a9026981713b7e6d64b20d79a592b85b61e
 SHA512:
-  metadata.gz: 6d5fd0af281615885f02185d8e8f1d7aba85ff06ca74ee05983d1f314a4f4c8388940a44686ba22c0f15e213b79b4cbf815c4cd94398f5f6ea1e6cb6f6fbc15d
-  data.tar.gz: 64b8eea6e263ec017b549b68749504eeea4269f99e5867351af6ad1658186b9f07c4cc3075df247919e658569a4832d31765e0c41fc9525c71eee70b3b3c7c48
+  metadata.gz: f54eb9030b4e66d423f4b96cf1f3bb44348ca401fc0c998e92ff6d215ac64b94b0083bc80168280e5862a59afa6daaa9cb1afe91a7ba0029d6f288ea256a96e7
+  data.tar.gz: d322f54386e42dbb6ea72b73b4803b0823802018430abef804274d7cc0dcb8f9716e5f7cbac438bd8ec30c81b26a7d8ed96f727ee1b4a19ac9e8279ea42f824a

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [2.28.0](https://github.com/dodopayments/dodopayments-ruby/compare/v2.27.0...v2.28.0) (2026-09-10)
+
+
+### Features
+
+* **api:** add customer email logs ([05c9087](https://github.com/dodopayments/dodopayments-ruby/commit/05c90872fff106b200f7abf64bb7be0fe8fd566a))
+* **api:** add customer email logs ([87730fa](https://github.com/dodopayments/dodopayments-ruby/commit/87730faf0153a9b9a02cdee21ee0c5fe386a3532))
+
 ## [2.27.0](https://github.com/dodopayments/dodopayments-ruby/compare/v2.26.0...v2.27.0) (2026-09-01)
 
 

data/README.md

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

data/lib/dodopayments/internal/type/union.rb

@@ -11,7 +11,7 @@ module Dodopayments
       #   when Dodopayments::Price::OneTimePrice
       #     puts(price.currency)
       #   when Dodopayments::Price::RecurringPrice
-      #     puts(price.discount)
+      #     puts(price.payment_frequency_count)
       #   when Dodopayments::Price::UsageBasedPrice
       #     puts(price.fixed_price)
       #   else
@@ -20,11 +20,21 @@ module Dodopayments
       #
       # @example
       #   case price
-      #   in {type: :one_time_price, currency: currency, discount: discount, price: price}
+      #   in {type: :one_time_price, currency: currency, price: price, discount: discount}
       #     puts(currency)
-      #   in {type: :recurring_price, currency: currency, discount: discount, payment_frequency_count: payment_frequency_count}
-      #     puts(discount)
-      #   in {type: :usage_based_price, currency: currency, discount: discount, fixed_price: fixed_price}
+      #   in {
+      #     type: :recurring_price,
+      #     currency: currency,
+      #     payment_frequency_count: payment_frequency_count,
+      #     payment_frequency_interval: payment_frequency_interval
+      #   }
+      #     puts(payment_frequency_count)
+      #   in {
+      #     type: :usage_based_price,
+      #     currency: currency,
+      #     fixed_price: fixed_price,
+      #     payment_frequency_count: payment_frequency_count
+      #   }
       #     puts(fixed_price)
       #   else
       #     puts(price)

data/lib/dodopayments/models/balance_ledger_entry.rb

@@ -110,6 +110,8 @@ module Dodopayments
         DUNNING_FEES = :dunning_fees
         PAYMENT_RETRY_FEE = :payment_retry_fee
         BYOP_FEE = :byop_fee
+        ETHOCA_FEES = :ethoca_fees
+        ETHOCA_FEES_REVERSAL = :ethoca_fees_reversal
 
         # @!method self.values
         #   @return [Array<Symbol>]

data/lib/dodopayments/models/balance_retrieve_ledger_params.rb

@@ -257,6 +257,8 @@ module Dodopayments
         DUNNING_FEES = :dunning_fees
         PAYMENT_RETRY_FEE = :payment_retry_fee
         BYOP_FEE = :byop_fee
+        ETHOCA_FEES = :ethoca_fees
+        ETHOCA_FEES_REVERSAL = :ethoca_fees_reversal
 
         # @!method self.values
         #   @return [Array<Symbol>]

data/lib/dodopayments/models/checkout_session_preview_response.rb

@@ -31,6 +31,13 @@ module Dodopayments
       #   @return [Boolean]
       required :is_byop, Dodopayments::Internal::Type::Boolean
 
+      # @!attribute payment_method_required
+      #   False when the customer can confirm this session with no card. True for every
+      #   other cart, including a one-time cart.
+      #
+      #   @return [Boolean]
+      required :payment_method_required, Dodopayments::Internal::Type::Boolean
+
       # @!attribute product_cart
       #   The total product cart
       #
@@ -100,7 +107,7 @@ module Dodopayments
       #   @return [Integer, nil]
       optional :trial_period_days, Integer, nil?: true
 
-      # @!method initialize(billing_country:, currency:, current_breakup:, is_byop:, product_cart:, total_price:, next_billing_date: nil, recurring_breakup: nil, tax_id_business_name: nil, tax_id_err_msg: nil, tax_id_format_name: nil, total_tax: nil, trial_amount: nil, trial_period_days: nil)
+      # @!method initialize(billing_country:, currency:, current_breakup:, is_byop:, payment_method_required:, product_cart:, total_price:, next_billing_date: nil, recurring_breakup: nil, tax_id_business_name: nil, tax_id_err_msg: nil, tax_id_format_name: nil, total_tax: nil, trial_amount: nil, trial_period_days: nil)
       #   Some parameter documentations has been truncated, see
       #   {Dodopayments::Models::CheckoutSessionPreviewResponse} for more details.
       #
@@ -114,6 +121,8 @@ module Dodopayments
       #
       #   @param is_byop [Boolean] Whether the payment will be routed through the merchant's own
       #
+      #   @param payment_method_required [Boolean] False when the customer can confirm this session with no card. True for
+      #
       #   @param product_cart [Array<Dodopayments::Models::CheckoutSessionPreviewResponse::ProductCart>] The total product cart
       #
       #   @param total_price [Integer] Total calculate price of the product cart

data/lib/dodopayments/models/credit_entitlements/balance_create_ledger_entry_params.rb

@@ -46,7 +46,7 @@ module Dodopayments
 
         # @!attribute metadata
         #   Optional metadata (max 50 key-value pairs, key max 40 chars, value max 500
-        #   chars)
+        #   chars).
         #
         #   @return [Hash{Symbol=>String, Float, Boolean}, nil]
         optional :metadata,

data/lib/dodopayments/models/credit_entitlements/balance_create_ledger_entry_response.rb

@@ -50,6 +50,12 @@ module Dodopayments
         #   @return [Boolean]
         required :is_credit, Dodopayments::Internal::Type::Boolean
 
+        # @!attribute metadata
+        #   Metadata stored on this entry.
+        #
+        #   @return [Hash{Symbol=>String, Float, Boolean}]
+        required :metadata, -> { Dodopayments::Internal::Type::HashOf[union: Dodopayments::MetadataItem] }
+
         # @!attribute overage_after
         #
         #   @return [String]
@@ -70,21 +76,35 @@ module Dodopayments
         #   @return [String, nil]
         optional :reason, String, nil?: true
 
-        # @!method initialize(id:, amount:, balance_after:, balance_before:, created_at:, credit_entitlement_id:, customer_id:, entry_type:, is_credit:, overage_after:, overage_before:, grant_id: nil, reason: nil)
+        # @!method initialize(id:, amount:, balance_after:, balance_before:, created_at:, credit_entitlement_id:, customer_id:, entry_type:, is_credit:, metadata:, overage_after:, overage_before:, grant_id: nil, reason: nil)
         #   Response for creating a ledger entry
         #
         #   @param id [String]
+        #
         #   @param amount [String]
+        #
         #   @param balance_after [String]
+        #
         #   @param balance_before [String]
+        #
         #   @param created_at [Time]
+        #
         #   @param credit_entitlement_id [String]
+        #
         #   @param customer_id [String]
+        #
         #   @param entry_type [Symbol, Dodopayments::Models::CreditEntitlements::LedgerEntryType]
+        #
         #   @param is_credit [Boolean]
+        #
+        #   @param metadata [Hash{Symbol=>String, Float, Boolean}] Metadata stored on this entry.
+        #
         #   @param overage_after [String]
+        #
         #   @param overage_before [String]
+        #
         #   @param grant_id [String, nil]
+        #
         #   @param reason [String, nil]
       end
     end

data/lib/dodopayments/models/credit_entitlements/credit_ledger_entry.rb

@@ -57,9 +57,7 @@ module Dodopayments
         required :is_credit, Dodopayments::Internal::Type::Boolean
 
         # @!attribute metadata
-        #   Metadata associated with the credit grant's source (the subscription or payment
-        #   created at checkout). Empty when the grant has no resolvable source (e.g.
-        #   credits granted directly via the API).
+        #   Metadata associated with this entry.
         #
         #   @return [Hash{Symbol=>String, Float, Boolean}]
         required :metadata, -> { Dodopayments::Internal::Type::HashOf[union: Dodopayments::MetadataItem] }
@@ -101,9 +99,6 @@ module Dodopayments
         optional :reference_type, String, nil?: true
 
         # @!method initialize(id:, amount:, balance_after:, balance_before:, brand_id:, business_id:, created_at:, credit_entitlement_id:, customer_id:, is_credit:, metadata:, overage_after:, overage_before:, transaction_type:, description: nil, grant_id: nil, reference_id: nil, reference_type: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Dodopayments::Models::CreditEntitlements::CreditLedgerEntry} for more details.
-        #
         #   Response for a ledger entry
         #
         #   @param id [String]
@@ -126,7 +121,7 @@ module Dodopayments
         #
         #   @param is_credit [Boolean]
         #
-        #   @param metadata [Hash{Symbol=>String, Float, Boolean}] Metadata associated with the credit grant's source (the subscription or
+        #   @param metadata [Hash{Symbol=>String, Float, Boolean}] Metadata associated with this entry.
         #
         #   @param overage_after [String]
         #

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module Customers
+      # @see Dodopayments::Resources::Customers::Emails#retrieve_body
+      class EmailBody < Dodopayments::Internal::Type::BaseModel
+        # @!attribute merchant_authored
+        #   Whether the merchant wrote this content. It is true for the recovery and dunning
+        #   emails, which the merchant writes.
+        #
+        #   The content is email HTML. Render it in a sandbox, whatever this value is.
+        #
+        #   @return [Boolean]
+        required :merchant_authored, Dodopayments::Internal::Type::Boolean
+
+        # @!attribute failure_code
+        #   Why the email did not arrive. It is null unless the email failed.
+        #
+        #   @return [Symbol, Dodopayments::Models::Customers::EmailFailureCode, nil]
+        optional :failure_code, enum: -> { Dodopayments::Customers::EmailFailureCode }, nil?: true
+
+        # @!attribute failure_reason
+        #   A sentence that explains `failure_code`. It is null unless the email failed.
+        #
+        #   @return [String, nil]
+        optional :failure_reason, String, nil?: true
+
+        # @!attribute html
+        #   The stored HTML. It is null on a text-only email.
+        #
+        #   @return [String, nil]
+        optional :html, String, nil?: true
+
+        # @!attribute text
+        #   The stored plain text.
+        #
+        #   @return [String, nil]
+        optional :text, String, nil?: true
+
+        # @!method initialize(merchant_authored:, failure_code: nil, failure_reason: nil, html: nil, text: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Dodopayments::Models::Customers::EmailBody} for more details.
+        #
+        #   @param merchant_authored [Boolean] Whether the merchant wrote this content. It is true for the recovery
+        #
+        #   @param failure_code [Symbol, Dodopayments::Models::Customers::EmailFailureCode, nil] Why the email did not arrive. It is null unless the email failed.
+        #
+        #   @param failure_reason [String, nil] A sentence that explains `failure_code`. It is null unless the email
+        #
+        #   @param html [String, nil] The stored HTML. It is null on a text-only email.
+        #
+        #   @param text [String, nil] The stored plain text.
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module Customers
+      # Why an email did not reach the recipient.
+      #
+      # The code is stable. `send_failed` is the catch-all: it covers every failure that
+      # the other codes do not name.
+      module EmailFailureCode
+        extend Dodopayments::Internal::Type::Enum
+
+        MAILBOX_NOT_FOUND = :mailbox_not_found
+        ADDRESS_REJECTED = :address_rejected
+        ADDRESS_SUPPRESSED = :address_suppressed
+        MAILBOX_FULL = :mailbox_full
+        TEMPORARY_FAILURE = :temporary_failure
+        MESSAGE_TOO_LARGE = :message_too_large
+        MARKED_AS_SPAM = :marked_as_spam
+        SEND_FAILED = :send_failed
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module Customers
+      # @see Dodopayments::Resources::Customers::Emails#list
+      class EmailListParams < Dodopayments::Internal::Type::BaseModel
+        extend Dodopayments::Internal::Type::RequestParameters::Converter
+        include Dodopayments::Internal::Type::RequestParameters
+
+        # @!attribute customer_id
+        #
+        #   @return [String]
+        required :customer_id, String
+
+        # @!attribute page_number
+        #   Which page to return. The default is 0.
+        #
+        #   @return [Integer, nil]
+        optional :page_number, Integer
+
+        # @!attribute page_size
+        #   How many emails to return. The default is 10 and the maximum is 100.
+        #
+        #   @return [Integer, nil]
+        optional :page_size, Integer
+
+        # @!method initialize(customer_id:, page_number: nil, page_size: nil, request_options: {})
+        #   @param customer_id [String]
+        #
+        #   @param page_number [Integer] Which page to return. The default is 0.
+        #
+        #   @param page_size [Integer] How many emails to return. The default is 10 and the maximum is 100.
+        #
+        #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module Customers
+      # @see Dodopayments::Resources::Customers::Emails#list
+      class EmailLogItem < Dodopayments::Internal::Type::BaseModel
+        # @!attribute category
+        #   The group this email belongs to: payments, refunds, subscriptions,
+        #   dunning_recovery, entitlements or auth.
+        #
+        #   @return [String]
+        required :category, String
+
+        # @!attribute created_at
+        #   When this email was sent.
+        #
+        #   @return [Time]
+        required :created_at, Time
+
+        # @!attribute email_log_id
+        #   Identifies this email. Use it to read the body or to send it again.
+        #
+        #   @return [String]
+        required :email_log_id, String
+
+        # @!attribute email_type
+        #   What kind of email this is, for example `payment_successful`.
+        #
+        #   @return [String]
+        required :email_type, String
+
+        # @!attribute has_preview
+        #   Whether this email has content to show. The content endpoint can still refuse,
+        #   because the content is removed after 180 days.
+        #
+        #   @return [Boolean]
+        required :has_preview, Dodopayments::Internal::Type::Boolean
+
+        # @!attribute policies
+        #   What you may do with this email.
+        #
+        #   @return [Dodopayments::Models::Customers::EmailPolicies]
+        required :policies, -> { Dodopayments::Customers::EmailPolicies }
+
+        # @!attribute status
+        #   Where the email got to: sent, delivered, failed, complained or blocked.
+        #
+        #   @return [Symbol, Dodopayments::Models::Customers::EmailLogStatus]
+        required :status, enum: -> { Dodopayments::Customers::EmailLogStatus }
+
+        # @!attribute failure_code
+        #   Why the email did not arrive. It is null unless the email failed.
+        #
+        #   @return [Symbol, Dodopayments::Models::Customers::EmailFailureCode, nil]
+        optional :failure_code, enum: -> { Dodopayments::Customers::EmailFailureCode }, nil?: true
+
+        # @!attribute failure_reason
+        #   A sentence that explains `failure_code`. It is null unless the email failed.
+        #
+        #   @return [String, nil]
+        optional :failure_reason, String, nil?: true
+
+        # @!attribute from
+        #   The address the email was sent from.
+        #
+        #   @return [String, nil]
+        optional :from, String, nil?: true
+
+        # @!attribute intended_recipient
+        #   What the merchant typed, when test mode redirected the send to the business
+        #   owner.
+        #
+        #   @return [String, nil]
+        optional :intended_recipient, String, nil?: true
+
+        # @!attribute recipient
+        #   The address the email reached.
+        #
+        #   @return [String, nil]
+        optional :recipient, String, nil?: true
+
+        # @!attribute subject
+        #   The subject line as it was sent. Empty until the provider replicates.
+        #
+        #   @return [String, nil]
+        optional :subject, String, nil?: true
+
+        # @!method initialize(category:, created_at:, email_log_id:, email_type:, has_preview:, policies:, status:, failure_code: nil, failure_reason: nil, from: nil, intended_recipient: nil, recipient: nil, subject: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Dodopayments::Models::Customers::EmailLogItem} for more details.
+        #
+        #   @param category [String] The group this email belongs to: payments, refunds, subscriptions,
+        #
+        #   @param created_at [Time] When this email was sent.
+        #
+        #   @param email_log_id [String] Identifies this email. Use it to read the body or to send it again.
+        #
+        #   @param email_type [String] What kind of email this is, for example `payment_successful`.
+        #
+        #   @param has_preview [Boolean] Whether this email has content to show. The content endpoint can still
+        #
+        #   @param policies [Dodopayments::Models::Customers::EmailPolicies] What you may do with this email.
+        #
+        #   @param status [Symbol, Dodopayments::Models::Customers::EmailLogStatus] Where the email got to: sent, delivered, failed, complained or blocked.
+        #
+        #   @param failure_code [Symbol, Dodopayments::Models::Customers::EmailFailureCode, nil] Why the email did not arrive. It is null unless the email failed.
+        #
+        #   @param failure_reason [String, nil] A sentence that explains `failure_code`. It is null unless the email
+        #
+        #   @param from [String, nil] The address the email was sent from.
+        #
+        #   @param intended_recipient [String, nil] What the merchant typed, when test mode redirected the send to the
+        #
+        #   @param recipient [String, nil] The address the email reached.
+        #
+        #   @param subject [String, nil] The subject line as it was sent. Empty until the provider replicates.
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module Customers
+      # The delivery status of one email.
+      #
+      # `sent` also covers an email that is still on its way. A status only becomes
+      # `delivered`, `failed` or `complained` when the mail server answers.
+      module EmailLogStatus
+        extend Dodopayments::Internal::Type::Enum
+
+        SENT = :sent
+        DELIVERED = :delivered
+        FAILED = :failed
+        COMPLAINED = :complained
+        BLOCKED = :blocked
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module Customers
+      class EmailPolicies < Dodopayments::Internal::Type::BaseModel
+        # @!attribute requires_different_address
+        #   A permanent failure was recorded, so the same address would be a no-op.
+        #
+        #   @return [Boolean]
+        required :requires_different_address, Dodopayments::Internal::Type::Boolean
+
+        # @!attribute resend_allowed
+        #   The row was delivered and may be sent again.
+        #
+        #   @return [Boolean]
+        required :resend_allowed, Dodopayments::Internal::Type::Boolean
+
+        # @!attribute resends_remaining
+        #   How many sends are left in this email's chain.
+        #
+        #   @return [Integer]
+        required :resends_remaining, Integer
+
+        # @!attribute retry_allowed
+        #   The row failed and may be sent again.
+        #
+        #   @return [Boolean]
+        required :retry_allowed, Dodopayments::Internal::Type::Boolean
+
+        # @!method initialize(requires_different_address:, resend_allowed:, resends_remaining:, retry_allowed:)
+        #   What the merchant may do with one row. The server decides; the client never
+        #   derives eligibility itself.
+        #
+        #   @param requires_different_address [Boolean] A permanent failure was recorded, so the same address would be a no-op.
+        #
+        #   @param resend_allowed [Boolean] The row was delivered and may be sent again.
+        #
+        #   @param resends_remaining [Integer] How many sends are left in this email's chain.
+        #
+        #   @param retry_allowed [Boolean] The row failed and may be sent again.
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module Customers
+      # @see Dodopayments::Resources::Customers::Emails#retrieve_body
+      class EmailRetrieveBodyParams < Dodopayments::Internal::Type::BaseModel
+        extend Dodopayments::Internal::Type::RequestParameters::Converter
+        include Dodopayments::Internal::Type::RequestParameters
+
+        # @!attribute customer_id
+        #
+        #   @return [String]
+        required :customer_id, String
+
+        # @!attribute email_log_id
+        #
+        #   @return [String]
+        required :email_log_id, String
+
+        # @!method initialize(customer_id:, email_log_id:, request_options: {})
+        #   @param customer_id [String]
+        #   @param email_log_id [String]
+        #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end