dodopayments 2.33.0 → 2.35.0

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,

data/rbi/dodopayments/resources/product_collections/groups.rbi

@@ -51,7 +51,8 @@ module Dodopayments
           # Path param: Product Collection Id
           id:,
           # Body param: Optional group name update: Some(Some(name)) = set name, Some(None)
-          # = clear name, None = no change
+          # = clear name, None = no change The API returns 422 if another group in the
+          # collection has no name.
           group_name: nil,
           # Body param: Optional new order for products in this group (array of
           # product_collection_group_pdts UUIDs)

data/rbi/dodopayments/resources/product_collections/translations.rbi

@@ -0,0 +1,77 @@
+# typed: strong
+
+module Dodopayments
+  module Resources
+    class ProductCollections
+      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: Product Collection 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(
+          # Product Collection 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,
+          # Product Collection 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/product_collections.rbi

@@ -3,6 +3,9 @@
 module Dodopayments
   module Resources
     class ProductCollections
+      sig { returns(Dodopayments::Resources::ProductCollections::Translations) }
+      attr_reader :translations
+
       sig { returns(Dodopayments::Resources::ProductCollections::Groups) }
       attr_reader :groups
 
@@ -69,12 +72,20 @@ module Dodopayments
       sig do
         params(
           id: String,
+          locale: String,
           request_options: Dodopayments::RequestOptions::OrHash
         ).returns(Dodopayments::ProductCollection)
       end
       def retrieve(
         # Product Collection 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
@@ -146,6 +157,7 @@ module Dodopayments
         params(
           archived: T::Boolean,
           brand_id: String,
+          locale: String,
           page_number: Integer,
           page_size: Integer,
           request_options: Dodopayments::RequestOptions::OrHash
@@ -160,6 +172,13 @@ module Dodopayments
         archived: nil,
         # Filter by Brand id
         brand_id: 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/products/translations.rbi

@@ -0,0 +1,77 @@
+# typed: strong
+
+module Dodopayments
+  module Resources
+    class Products
+      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: Product 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(
+          # Product 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,
+          # Product 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/products.rbi

@@ -3,6 +3,9 @@
 module Dodopayments
   module Resources
     class Products
+      sig { returns(Dodopayments::Resources::Products::Translations) }
+      attr_reader :translations
+
       sig { returns(Dodopayments::Resources::Products::Images) }
       attr_reader :images
 
@@ -101,12 +104,20 @@ module Dodopayments
       sig do
         params(
           id: String,
+          locale: String,
           request_options: Dodopayments::RequestOptions::OrHash
         ).returns(Dodopayments::Product)
       end
       def retrieve(
         # Product 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
@@ -216,6 +227,7 @@ module Dodopayments
         params(
           archived: T::Boolean,
           brand_id: String,
+          locale: String,
           page_number: Integer,
           page_size: Integer,
           recurring: T::Boolean,
@@ -231,6 +243,13 @@ module Dodopayments
         archived: nil,
         # filter by Brand id
         brand_id: 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/refunds.rbi

@@ -6,6 +6,7 @@ module Dodopayments
       sig do
         params(
           payment_id: String,
+          currency: T.nilable(Dodopayments::Currency::OrSymbol),
           items:
             T.nilable(T::Array[Dodopayments::RefundCreateParams::Item::OrHash]),
           metadata: T::Hash[Symbol, Dodopayments::MetadataItem::Variants],
@@ -16,6 +17,9 @@ module Dodopayments
       def create(
         # The unique identifier of the payment to be refunded.
         payment_id:,
+        # The currency of every `items[].amount`. It must be the currency the customer
+        # paid in. Without it, the amounts are in the settlement currency.
+        currency: nil,
         # Partially Refund an Individual Item
         items: nil,
         # Additional metadata associated with the refund.

data/rbi/dodopayments/resources/subscriptions.rbi

@@ -116,12 +116,20 @@ module Dodopayments
       sig do
         params(
           subscription_id: String,
+          locale: String,
           request_options: Dodopayments::RequestOptions::OrHash
         ).returns(Dodopayments::Subscription)
       end
       def retrieve(
         # Subscription Id
         subscription_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
@@ -224,6 +232,7 @@ module Dodopayments
           created_at_gte: Time,
           created_at_lte: Time,
           customer_id: String,
+          locale: String,
           page_number: Integer,
           page_size: Integer,
           product_id: String,
@@ -246,6 +255,13 @@ module Dodopayments
         created_at_lte: nil,
         # Filter by customer id
         customer_id: 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
@@ -369,6 +385,11 @@ module Dodopayments
         # - `apply_change` (default): Apply plan change immediately regardless of payment
         #   outcome
         #
+        # With `effective_at: next_billing_date`, the plan change payment replaces the
+        # renewal payment. If that payment fails with `prevent_change`, the plan change is
+        # cancelled. The subscription then renews on the current plan, with the usual
+        # payment retries.
+        #
         # If not specified, uses the business-level default setting.
         on_payment_failure: nil,
         # The URL that receives the customer after they pay the payment link. Needs
@@ -525,6 +546,11 @@ module Dodopayments
         # - `apply_change` (default): Apply plan change immediately regardless of payment
         #   outcome
         #
+        # With `effective_at: next_billing_date`, the plan change payment replaces the
+        # renewal payment. If that payment fails with `prevent_change`, the plan change is
+        # cancelled. The subscription then renews on the current plan, with the usual
+        # payment retries.
+        #
         # If not specified, uses the business-level default setting.
         on_payment_failure: nil,
         # The URL that receives the customer after they pay the payment link. Needs

data/sig/dodopayments/models/addon_delete_params.rbs

@@ -0,0 +1,23 @@
+module Dodopayments
+  module Models
+    type addon_delete_params =
+      { id: String } & Dodopayments::Internal::Type::request_parameters
+
+    class AddonDeleteParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      attr_accessor id: String
+
+      def initialize: (
+        id: String,
+        ?request_options: Dodopayments::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        request_options: Dodopayments::RequestOptions
+      }
+    end
+  end
+end

data/sig/dodopayments/models/addon_list_params.rbs

@@ -1,13 +1,26 @@
 module Dodopayments
   module Models
     type addon_list_params =
-      { page_number: Integer, page_size: Integer }
+      {
+        archived: bool,
+        locale: String,
+        page_number: Integer,
+        page_size: Integer
+      }
       & Dodopayments::Internal::Type::request_parameters
 
     class AddonListParams < Dodopayments::Internal::Type::BaseModel
       extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 
+      attr_reader archived: bool?
+
+      def archived=: (bool) -> bool
+
+      attr_reader locale: String?
+
+      def locale=: (String) -> String
+
       attr_reader page_number: Integer?
 
       def page_number=: (Integer) -> Integer
@@ -17,12 +30,16 @@ module Dodopayments
       def page_size=: (Integer) -> Integer
 
       def initialize: (
+        ?archived: bool,
+        ?locale: String,
         ?page_number: Integer,
         ?page_size: Integer,
         ?request_options: Dodopayments::request_opts
       ) -> void
 
       def to_hash: -> {
+        archived: bool,
+        locale: String,
         page_number: Integer,
         page_size: Integer,
         request_options: Dodopayments::RequestOptions

data/sig/dodopayments/models/addon_retrieve_params.rbs

@@ -1,7 +1,8 @@
 module Dodopayments
   module Models
     type addon_retrieve_params =
-      { id: String } & Dodopayments::Internal::Type::request_parameters
+      { id: String, locale: String }
+      & Dodopayments::Internal::Type::request_parameters
 
     class AddonRetrieveParams < Dodopayments::Internal::Type::BaseModel
       extend Dodopayments::Internal::Type::RequestParameters::Converter
@@ -9,13 +10,19 @@ module Dodopayments
 
       attr_accessor id: String
 
+      attr_reader locale: String?
+
+      def locale=: (String) -> String
+
       def initialize: (
         id: String,
+        ?locale: String,
         ?request_options: Dodopayments::request_opts
       ) -> void
 
       def to_hash: -> {
         id: String,
+        locale: String,
         request_options: Dodopayments::RequestOptions
       }
     end