dodopayments 2.34.0 → 2.35.0

data/rbi/dodopayments/resources/checkout_sessions.rbi

@@ -140,6 +140,7 @@ module Dodopayments
       sig do
         params(
           product_cart: T::Array[Dodopayments::ProductItemReq::OrHash],
+          locale: String,
           allowed_payment_method_types:
             T.nilable(T::Array[Dodopayments::PaymentMethodTypes::OrSymbol]),
           billing_address:
@@ -176,20 +177,29 @@ module Dodopayments
         ).returns(Dodopayments::Models::CheckoutSessionPreviewResponse)
       end
       def preview(
-        # The products of the checkout. A cart holds at most 20 of them, one-time and
-        # subscription products together. An empty cart is valid for the
+        # Body param: The products of the checkout. A cart holds at most 20 of them,
+        # one-time and subscription products together. An empty cart is valid for the
         # product-collection flow, where the customer chooses the product later.
         product_cart:,
-        # Customers will never see payment methods that are not in this list. However,
-        # adding a method here does not guarantee customers will see it. Availability
-        # still depends on other factors (e.g., customer location, merchant settings).
+        # Query param: Shows the translated name, description and unit of the catalog
+        # entities in this locale. The value must be a code from `GET /locales`, for
+        # example `fr`. A field with no translation, an unknown code, or no code shows the
+        # base text.
+        #
+        # Do not send a text from a localized response back in a create or update request.
+        # The base text then changes to the translated text.
+        locale: nil,
+        # Body param: Customers will never see payment methods that are not in this list.
+        # However, adding a method here does not guarantee customers will see it.
+        # Availability still depends on other factors (e.g., customer location, merchant
+        # settings).
         #
         # Disclaimar: Always provide 'credit' and 'debit' as a fallback. If all payment
         # methods are unavailable, checkout session will fail.
         allowed_payment_method_types: nil,
-        # Billing address information for the session
+        # Body param: Billing address information for the session
         billing_address: nil,
-        # The currency to charge the customer in.
+        # Body param: The currency to charge the customer in.
         #
         # Adaptive pricing must be enabled for the business. The customer then pays in
         # this currency. If you do not set it, the currency comes from the billing
@@ -198,61 +208,67 @@ module Dodopayments
         # If adaptive pricing is disabled, the API discards this field. The currency then
         # comes from the product price, or from the billing country.
         billing_currency: nil,
-        # The URL to redirect the customer if they cancel or go back from the checkout. If
-        # not provided, the back button will not be displayed.
+        # Body param: The URL to redirect the customer if they cancel or go back from the
+        # checkout. If not provided, the back button will not be displayed.
         cancel_url: nil,
-        # If confirm is true, all the details will be finalized. If required data is
-        # missing, an API error is thrown.
+        # Body param: If confirm is true, all the details will be finalized. If required
+        # data is missing, an API error is thrown.
         confirm: nil,
-        # Custom fields to collect from customer during checkout (max 5 fields)
+        # Body param: Custom fields to collect from customer during checkout (max 5
+        # fields)
         custom_fields: nil,
-        # Customer details for the session
+        # Body param: Customer details for the session
         customer: nil,
-        # Optional business / legal name associated with the tax id. When provided
-        # together with a valid tax id for a B2B purchase, this name is rendered on the
-        # invoice instead of the customer's personal name.
+        # Body param: Optional business / legal name associated with the tax id. When
+        # provided together with a valid tax id for a B2B purchase, this name is rendered
+        # on the invoice instead of the customer's personal name.
         customer_business_name: nil,
-        # Customization for the checkout session page
+        # Body param: Customization for the checkout session page
         customization: nil,
-        # DEPRECATED: Use discount_codes instead. Cannot be used together with
+        # Body param: DEPRECATED: Use discount_codes instead. Cannot be used together with
         # discount_codes.
         discount_code: nil,
-        # Stacked discount codes to apply, in order. Max 20. Cannot be used together with
-        # discount_code.
+        # Body param: Stacked discount codes to apply, in order. Max 20. Cannot be used
+        # together with discount_code.
         discount_codes: nil,
+        # Body param
         feature_flags: nil,
-        # Override merchant default 3DS behaviour for this session
+        # Body param: Override merchant default 3DS behaviour for this session
         force_3ds: nil,
-        # Override the merchant-level mandate floor (in INR paise) for INR e-mandates on
-        # Indian-card recurring payments. The mandate amount sent to the processor is
-        # `max(this_floor, actual_billing_amount)`, so this is effectively the
-        # customer-facing authorization ceiling whenever billing is lower. When unset, the
-        # merchant setting applies; when that's also unset, the system default of ₹15,000
-        # applies.
+        # Body param: Override the merchant-level mandate floor (in INR paise) for INR
+        # e-mandates on Indian-card recurring payments. The mandate amount sent to the
+        # processor is `max(this_floor, actual_billing_amount)`, so this is effectively
+        # the customer-facing authorization ceiling whenever billing is lower. When unset,
+        # the merchant setting applies; when that's also unset, the system default of
+        # ₹15,000 applies.
         mandate_min_amount_inr_paise: nil,
-        # Additional metadata associated with the payment. Defaults to empty if not
-        # provided.
+        # Body param: Additional metadata associated with the payment. Defaults to empty
+        # if not provided.
         metadata: nil,
-        # If true, only zipcode is required when confirm is true; other address fields
-        # remain optional
+        # Body param: If true, only zipcode is required when confirm is true; other
+        # address fields remain optional
         #
         # Default is true when `feature_flags.single_page` is true. Otherwise, default is
         # false.
         minimal_address: nil,
-        # Optional payment method ID to use for this checkout session. Only allowed when
-        # `confirm` is true. If provided, existing customer id must also be provided.
+        # Body param: Optional payment method ID to use for this checkout session. Only
+        # allowed when `confirm` is true. If provided, existing customer id must also be
+        # provided.
         payment_method_id: nil,
-        # Product collection ID for collection-based checkout flow
+        # Body param: Product collection ID for collection-based checkout flow
         product_collection_id: nil,
-        # The url to redirect after payment failure or success.
+        # Body param: The url to redirect after payment failure or success.
         return_url: nil,
-        # If true, returns a shortened checkout URL. Defaults to false if not specified.
+        # Body param: If true, returns a shortened checkout URL. Defaults to false if not
+        # specified.
         short_link: nil,
-        # Display saved payment methods of a returning customer False by default
+        # Body param: Display saved payment methods of a returning customer False by
+        # default
         show_saved_payment_methods: nil,
+        # Body param
         subscription_data: nil,
-        # Tax ID for the customer (e.g. VAT number). Requires billing_address with
-        # country.
+        # Body param: Tax ID for the customer (e.g. VAT number). Requires billing_address
+        # with country.
         tax_id: nil,
         request_options: {}
       )

data/rbi/dodopayments/resources/credit_entitlements/translations.rbi

@@ -0,0 +1,81 @@
+# typed: strong
+
+module Dodopayments
+  module Resources
+    class CreditEntitlements
+      class Translations
+        # Creates or replaces the translation of one locale. The response is 201 for a new
+        # locale and 200 for a replaced locale.
+        sig do
+          params(
+            locale: Dodopayments::Locale::OrSymbol,
+            id: String,
+            name: T.nilable(String),
+            unit: T.nilable(String),
+            request_options: Dodopayments::RequestOptions::OrHash
+          ).returns(
+            Dodopayments::CreditEntitlements::CreditEntitlementTranslation
+          )
+        end
+        def update(
+          # Path param: A locale that the checkout and the customer portal can show.
+          #
+          # The codes are a copy of the checkout locales. `GET /locales` lists them.
+          locale,
+          # Path param: Credit Entitlement Id
+          id:,
+          # Body param: The translated name.
+          name: nil,
+          # Body param: The translated unit.
+          unit: nil,
+          request_options: {}
+        )
+        end
+
+        # Lists the translations, for all the locales or for the locales of the filter.
+        sig do
+          params(
+            id: String,
+            locale: T::Array[String],
+            request_options: Dodopayments::RequestOptions::OrHash
+          ).returns(
+            Dodopayments::CreditEntitlements::CreditEntitlementTranslationsListResponse
+          )
+        end
+        def list(
+          # Credit Entitlement Id
+          id,
+          # Returns only these locales, for example `?locale=fr&locale=de`. With no value,
+          # the response has all the locales.
+          locale: nil,
+          request_options: {}
+        )
+        end
+
+        # Deletes the translation of one locale.
+        sig do
+          params(
+            locale: Dodopayments::Locale::OrSymbol,
+            id: String,
+            request_options: Dodopayments::RequestOptions::OrHash
+          ).void
+        end
+        def delete(
+          # A locale that the checkout and the customer portal can show.
+          #
+          # The codes are a copy of the checkout locales. `GET /locales` lists them.
+          locale,
+          # Credit Entitlement Id
+          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/credit_entitlements.rbi

@@ -3,6 +3,9 @@
 module Dodopayments
   module Resources
     class CreditEntitlements
+      sig { returns(Dodopayments::Resources::CreditEntitlements::Translations) }
+      attr_reader :translations
+
       sig { returns(Dodopayments::Resources::CreditEntitlements::Balances) }
       attr_reader :balances
 
@@ -134,12 +137,20 @@ module Dodopayments
       sig do
         params(
           id: String,
+          locale: String,
           request_options: Dodopayments::RequestOptions::OrHash
         ).returns(Dodopayments::CreditEntitlement)
       end
       def retrieve(
         # Credit Entitlement ID
         id,
+        # Shows the translated name, description and unit of the catalog entities in this
+        # locale. The value must be a code from `GET /locales`, for example `fr`. A field
+        # with no translation, an unknown code, or no code shows the base text.
+        #
+        # Do not send a text from a localized response back in a create or update request.
+        # The base text then changes to the translated text.
+        locale: nil,
         request_options: {}
       )
       end
@@ -286,6 +297,7 @@ module Dodopayments
       sig do
         params(
           deleted: T::Boolean,
+          locale: String,
           page_number: Integer,
           page_size: Integer,
           request_options: Dodopayments::RequestOptions::OrHash
@@ -298,6 +310,13 @@ module Dodopayments
       def list(
         # List deleted credit entitlements
         deleted: nil,
+        # Shows the translated name, description and unit of the catalog entities in this
+        # locale. The value must be a code from `GET /locales`, for example `fr`. A field
+        # with no translation, an unknown code, or no code shows the base text.
+        #
+        # Do not send a text from a localized response back in a create or update request.
+        # The base text then changes to the translated text.
+        locale: nil,
         # Page number default is 0
         page_number: nil,
         # Page size default is 10 max is 100

data/rbi/dodopayments/resources/customers.rbi

@@ -18,6 +18,7 @@ module Dodopayments
           name: String,
           metadata: T::Hash[Symbol, Dodopayments::MetadataItem::Variants],
           phone_number: T.nilable(String),
+          preferred_locale: T.nilable(Dodopayments::Locale::OrSymbol),
           request_options: Dodopayments::RequestOptions::OrHash
         ).returns(Dodopayments::Customer)
       end
@@ -27,6 +28,10 @@ module Dodopayments
         # Additional metadata for the customer
         metadata: nil,
         phone_number: nil,
+        # The language of the customer emails, a code from `GET /locales`. With no value,
+        # the emails are in English until a checkout or the customer portal sets a
+        # language.
+        preferred_locale: nil,
         request_options: {}
       )
       end
@@ -52,6 +57,7 @@ module Dodopayments
             T.nilable(T::Hash[Symbol, Dodopayments::MetadataItem::Variants]),
           name: T.nilable(String),
           phone_number: T.nilable(String),
+          preferred_locale: T.nilable(Dodopayments::Locale::OrSymbol),
           request_options: Dodopayments::RequestOptions::OrHash
         ).returns(Dodopayments::Customer)
       end
@@ -63,6 +69,10 @@ module Dodopayments
         metadata: nil,
         name: nil,
         phone_number: nil,
+        # The language of the customer emails, a code from `GET /locales`. A value
+        # replaces the current language, and `null` removes it. Send this field only to
+        # change the language on purpose. With no language, the emails are in English.
+        preferred_locale: nil,
         request_options: {}
       )
       end

data/rbi/dodopayments/resources/entitlements/translations.rbi

@@ -0,0 +1,87 @@
+# typed: strong
+
+module Dodopayments
+  module Resources
+    class Entitlements
+      class Translations
+        # Creates or replaces the translation of one locale. The response is 201 for a new
+        # locale and 200 for a replaced locale.
+        sig do
+          params(
+            locale: Dodopayments::Locale::OrSymbol,
+            id: String,
+            activation_message: T.nilable(String),
+            description: T.nilable(String),
+            instructions: T.nilable(String),
+            name: T.nilable(String),
+            request_options: Dodopayments::RequestOptions::OrHash
+          ).returns(Dodopayments::Entitlements::EntitlementTranslation)
+        end
+        def update(
+          # Path param: A locale that the checkout and the customer portal can show.
+          #
+          # The codes are a copy of the checkout locales. `GET /locales` lists them.
+          locale,
+          # Path param: Entitlement Id
+          id:,
+          # Body param: The translated activation message. Only a `license_key` entitlement
+          # has it.
+          activation_message: nil,
+          # Body param: The translated description.
+          description: nil,
+          # Body param: The translated delivery instructions. Only a `digital_files`
+          # entitlement has them.
+          instructions: nil,
+          # Body param: The translated name.
+          name: nil,
+          request_options: {}
+        )
+        end
+
+        # Lists the translations, for all the locales or for the locales of the filter.
+        sig do
+          params(
+            id: String,
+            locale: T::Array[String],
+            request_options: Dodopayments::RequestOptions::OrHash
+          ).returns(
+            Dodopayments::Entitlements::EntitlementTranslationsListResponse
+          )
+        end
+        def list(
+          # Entitlement Id
+          id,
+          # Returns only these locales, for example `?locale=fr&locale=de`. With no value,
+          # the response has all the locales.
+          locale: nil,
+          request_options: {}
+        )
+        end
+
+        # Deletes the translation of one locale.
+        sig do
+          params(
+            locale: Dodopayments::Locale::OrSymbol,
+            id: String,
+            request_options: Dodopayments::RequestOptions::OrHash
+          ).void
+        end
+        def delete(
+          # A locale that the checkout and the customer portal can show.
+          #
+          # The codes are a copy of the checkout locales. `GET /locales` lists them.
+          locale,
+          # Entitlement Id
+          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/entitlements.rbi

@@ -3,6 +3,9 @@
 module Dodopayments
   module Resources
     class Entitlements
+      sig { returns(Dodopayments::Resources::Entitlements::Translations) }
+      attr_reader :translations
+
       sig { returns(Dodopayments::Resources::Entitlements::Files) }
       attr_reader :files
 
@@ -50,12 +53,20 @@ module Dodopayments
       sig do
         params(
           id: String,
+          locale: String,
           request_options: Dodopayments::RequestOptions::OrHash
         ).returns(Dodopayments::Entitlement)
       end
       def retrieve(
         # Entitlement ID
         id,
+        # Shows the translated name, description and unit of the catalog entities in this
+        # locale. The value must be a code from `GET /locales`, for example `fr`. A field
+        # with no translation, an unknown code, or no code shows the base text.
+        #
+        # Do not send a text from a localized response back in a create or update request.
+        # The base text then changes to the translated text.
+        locale: nil,
         request_options: {}
       )
       end
@@ -108,6 +119,7 @@ module Dodopayments
         params(
           integration_type:
             Dodopayments::EntitlementListParams::IntegrationType::OrSymbol,
+          locale: String,
           page_number: Integer,
           page_size: Integer,
           request_options: Dodopayments::RequestOptions::OrHash
@@ -120,6 +132,13 @@ module Dodopayments
       def list(
         # Filter by integration type
         integration_type: nil,
+        # Shows the translated name, description and unit of the catalog entities in this
+        # locale. The value must be a code from `GET /locales`, for example `fr`. A field
+        # with no translation, an unknown code, or no code shows the base text.
+        #
+        # Do not send a text from a localized response back in a create or update request.
+        # The base text then changes to the translated text.
+        locale: nil,
         # Page number (default 0)
         page_number: nil,
         # Page size (default 10, max 100)

data/rbi/dodopayments/resources/meters/translations.rbi

@@ -0,0 +1,77 @@
+# typed: strong
+
+module Dodopayments
+  module Resources
+    class Meters
+      class Translations
+        # Creates or replaces the translation of one locale. The response is 201 for a new
+        # locale and 200 for a replaced locale.
+        sig do
+          params(
+            locale: Dodopayments::Locale::OrSymbol,
+            id: String,
+            description: T.nilable(String),
+            name: T.nilable(String),
+            request_options: Dodopayments::RequestOptions::OrHash
+          ).returns(Dodopayments::Products::Translation)
+        end
+        def update(
+          # Path param: A locale that the checkout and the customer portal can show.
+          #
+          # The codes are a copy of the checkout locales. `GET /locales` lists them.
+          locale,
+          # Path param: Meter Id
+          id:,
+          # Body param: The translated description.
+          description: nil,
+          # Body param: The translated name.
+          name: nil,
+          request_options: {}
+        )
+        end
+
+        # Lists the translations, for all the locales or for the locales of the filter.
+        sig do
+          params(
+            id: String,
+            locale: T::Array[String],
+            request_options: Dodopayments::RequestOptions::OrHash
+          ).returns(Dodopayments::Products::TranslationsListResponse)
+        end
+        def list(
+          # Meter Id
+          id,
+          # Returns only these locales, for example `?locale=fr&locale=de`. With no value,
+          # the response has all the locales.
+          locale: nil,
+          request_options: {}
+        )
+        end
+
+        # Deletes the translation of one locale.
+        sig do
+          params(
+            locale: Dodopayments::Locale::OrSymbol,
+            id: String,
+            request_options: Dodopayments::RequestOptions::OrHash
+          ).void
+        end
+        def delete(
+          # A locale that the checkout and the customer portal can show.
+          #
+          # The codes are a copy of the checkout locales. `GET /locales` lists them.
+          locale,
+          # Meter Id
+          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/meters.rbi

@@ -3,6 +3,9 @@
 module Dodopayments
   module Resources
     class Meters
+      sig { returns(Dodopayments::Resources::Meters::Translations) }
+      attr_reader :translations
+
       sig do
         params(
           aggregation: Dodopayments::MeterAggregation::OrHash,
@@ -34,12 +37,43 @@ module Dodopayments
       sig do
         params(
           id: String,
+          locale: String,
           request_options: Dodopayments::RequestOptions::OrHash
         ).returns(Dodopayments::Meter)
       end
       def retrieve(
         # Meter ID
         id,
+        # Shows the translated name, description and unit of the catalog entities in this
+        # locale. The value must be a code from `GET /locales`, for example `fr`. A field
+        # with no translation, an unknown code, or no code shows the base text.
+        #
+        # Do not send a text from a localized response back in a create or update request.
+        # The base text then changes to the translated text.
+        locale: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        params(
+          id: String,
+          description: T.nilable(String),
+          measurement_unit: T.nilable(String),
+          name: T.nilable(String),
+          request_options: Dodopayments::RequestOptions::OrHash
+        ).returns(Dodopayments::Meter)
+      end
+      def update(
+        # Meter ID
+        id,
+        # Description of the meter. Send `null` to remove the description. Omit it to keep
+        # it.
+        description: nil,
+        # Measurement unit
+        measurement_unit: nil,
+        # Name of the meter
+        name: nil,
         request_options: {}
       )
       end
@@ -47,6 +81,7 @@ module Dodopayments
       sig do
         params(
           archived: T::Boolean,
+          locale: String,
           page_number: Integer,
           page_size: Integer,
           request_options: Dodopayments::RequestOptions::OrHash
@@ -59,6 +94,13 @@ module Dodopayments
       def list(
         # List archived meters
         archived: nil,
+        # Shows the translated name, description and unit of the catalog entities in this
+        # locale. The value must be a code from `GET /locales`, for example `fr`. A field
+        # with no translation, an unknown code, or no code shows the base text.
+        #
+        # Do not send a text from a localized response back in a create or update request.
+        # The base text then changes to the translated text.
+        locale: nil,
         # Page number default is 0
         page_number: nil,
         # Page size default is 10 max is 100

data/rbi/dodopayments/resources/misc.rbi

@@ -3,6 +3,15 @@
 module Dodopayments
   module Resources
     class Misc
+      # Lists the locales that a translation can have.
+      sig do
+        params(request_options: Dodopayments::RequestOptions::OrHash).returns(
+          T::Array[Dodopayments::LocaleInfo]
+        )
+      end
+      def list_locales(request_options: {})
+      end
+
       sig do
         params(request_options: Dodopayments::RequestOptions::OrHash).returns(
           T::Array[Dodopayments::CountryCode::TaggedSymbol]

data/rbi/dodopayments/resources/payments.rbi

@@ -155,12 +155,16 @@ module Dodopayments
       sig do
         params(
           payment_id: String,
+          currency: Dodopayments::Currency::OrSymbol,
           request_options: Dodopayments::RequestOptions::OrHash
         ).returns(Dodopayments::Models::PaymentRetrieveLineItemsResponse)
       end
       def retrieve_line_items(
         # Payment Id
         payment_id,
+        # The currency of the amounts. It must be the currency that the customer paid in.
+        # Without it, the amounts are in the settlement currency.
+        currency: nil,
         request_options: {}
       )
       end

data/rbi/dodopayments/resources/payouts/breakup/details.rbi

@@ -8,7 +8,9 @@ module Dodopayments
           # Returns paginated individual balance ledger entries for a payout. Each entry is
           # converted into the payout's currency at the rate the payout settled at. Supports
           # pagination via `page_size` (default 10, max 100) and `page_number` (default 0)
-          # query parameters.
+          # query parameters. A settlement batch payout shows its rows in native amounts.
+          # `unattributed` is the payout amount less the sum of its rows in the payout
+          # currency.
           sig do
             params(
               payout_id: String,
@@ -35,7 +37,8 @@ module Dodopayments
           # Downloads the complete payout breakup as a CSV file. Each row represents a
           # balance ledger entry with columns: Ledger ID, Event Type, Original Amount,
           # Original Currency, Reference Object ID, Description, Created At, USD Equivalent
-          # Amount, and Payout Currency Amount.
+          # Amount, and Payout Currency Amount. A settlement batch payout shows its rows in
+          # native amounts.
           sig do
             params(
               payout_id: String,

data/rbi/dodopayments/resources/payouts/breakup.rbi

@@ -10,7 +10,10 @@ module Dodopayments
         # Returns the breakdown of a payout by event type (payments, refunds, disputes,
         # fees, etc.) in the payout's currency. Each amount is proportionally allocated
         # based on USD equivalent values, ensuring the total sums exactly to the payout
-        # amount.
+        # amount. A settlement batch payout shows its rows in native amounts. The
+        # `carried_over` line holds the opening balance from the switch to settlement
+        # batches and the rows dated before that opening balance. The `unattributed` line
+        # shows the payout amount that the rows do not account for.
         sig do
           params(
             payout_id: String,