dodopayments 2.34.0 → 2.36.0

data/rbi/dodopayments/models/products/translation_update_params.rbi

@@ -0,0 +1,74 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    module Products
+      class TranslationUpdateParams < Dodopayments::Internal::Type::BaseModel
+        extend Dodopayments::Internal::Type::RequestParameters::Converter
+        include Dodopayments::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::Products::TranslationUpdateParams,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        # A locale that the checkout and the customer portal can show.
+        #
+        # The codes are a copy of the checkout locales. `GET /locales` lists them.
+        sig { returns(Dodopayments::Locale::OrSymbol) }
+        attr_accessor :locale
+
+        # The translated description.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :description
+
+        # The translated name.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :name
+
+        sig do
+          params(
+            id: String,
+            locale: Dodopayments::Locale::OrSymbol,
+            description: T.nilable(String),
+            name: T.nilable(String),
+            request_options: Dodopayments::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          # 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:,
+          # The translated description.
+          description: nil,
+          # The translated name.
+          name: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              locale: Dodopayments::Locale::OrSymbol,
+              description: T.nilable(String),
+              name: T.nilable(String),
+              request_options: Dodopayments::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/products/translations_list_response.rbi

@@ -0,0 +1,37 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    module Products
+      class TranslationsListResponse < Dodopayments::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::Products::TranslationsListResponse,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T::Array[Dodopayments::Products::Translation]) }
+        attr_accessor :items
+
+        # The translations of a product, an add-on, a product collection or a meter.
+        sig do
+          params(
+            items: T::Array[Dodopayments::Products::Translation::OrHash]
+          ).returns(T.attached_class)
+        end
+        def self.new(items:)
+        end
+
+        sig do
+          override.returns(
+            { items: T::Array[Dodopayments::Products::Translation] }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/refund_create_params.rbi

@@ -18,6 +18,11 @@ module Dodopayments
       sig { returns(String) }
       attr_accessor :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.
+      sig { returns(T.nilable(Dodopayments::Currency::OrSymbol)) }
+      attr_accessor :currency
+
       # Partially Refund an Individual Item
       sig do
         returns(T.nilable(T::Array[Dodopayments::RefundCreateParams::Item]))
@@ -46,6 +51,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],
@@ -56,6 +62,9 @@ module Dodopayments
       def self.new(
         # 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.
@@ -70,6 +79,7 @@ module Dodopayments
         override.returns(
           {
             payment_id: String,
+            currency: T.nilable(Dodopayments::Currency::OrSymbol),
             items: T.nilable(T::Array[Dodopayments::RefundCreateParams::Item]),
             metadata: T::Hash[Symbol, Dodopayments::MetadataItem::Variants],
             reason: T.nilable(String),

data/rbi/dodopayments/models/subscription_list_params.rbi

@@ -49,6 +49,18 @@ module Dodopayments
       sig { params(customer_id: String).void }
       attr_writer :customer_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.
+      sig { returns(T.nilable(String)) }
+      attr_reader :locale
+
+      sig { params(locale: String).void }
+      attr_writer :locale
+
       # Page number default is 0
       sig { returns(T.nilable(Integer)) }
       attr_reader :page_number
@@ -92,6 +104,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,
@@ -110,6 +123,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
@@ -130,6 +150,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,

data/rbi/dodopayments/models/subscription_retrieve_params.rbi

@@ -17,19 +17,43 @@ module Dodopayments
       sig { returns(String) }
       attr_accessor :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.
+      sig { returns(T.nilable(String)) }
+      attr_reader :locale
+
+      sig { params(locale: String).void }
+      attr_writer :locale
+
       sig do
         params(
           subscription_id: String,
+          locale: String,
           request_options: Dodopayments::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(subscription_id:, request_options: {})
+      def self.new(
+        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
 
       sig do
         override.returns(
           {
             subscription_id: String,
+            locale: String,
             request_options: Dodopayments::RequestOptions
           }
         )

data/rbi/dodopayments/models/three_ds_flow.rbi

@@ -0,0 +1,23 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    # How the cardholder completed the 3DS authentication.
+    module ThreeDSFlow
+      extend Dodopayments::Internal::Type::Enum
+
+      TaggedSymbol = T.type_alias { T.all(Symbol, Dodopayments::ThreeDSFlow) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      CHALLENGE = T.let(:challenge, Dodopayments::ThreeDSFlow::TaggedSymbol)
+      FRICTIONLESS =
+        T.let(:frictionless, Dodopayments::ThreeDSFlow::TaggedSymbol)
+
+      sig do
+        override.returns(T::Array[Dodopayments::ThreeDSFlow::TaggedSymbol])
+      end
+      def self.values
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/three_ds_status.rbi

@@ -0,0 +1,31 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    # The result of the 3DS authentication of a card payment, as the processor reports
+    # it.
+    module ThreeDSStatus
+      extend Dodopayments::Internal::Type::Enum
+
+      TaggedSymbol = T.type_alias { T.all(Symbol, Dodopayments::ThreeDSStatus) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      AUTHENTICATED =
+        T.let(:authenticated, Dodopayments::ThreeDSStatus::TaggedSymbol)
+      ATTEMPT_ACKNOWLEDGED =
+        T.let(:attempt_acknowledged, Dodopayments::ThreeDSStatus::TaggedSymbol)
+      EXEMPTED = T.let(:exempted, Dodopayments::ThreeDSStatus::TaggedSymbol)
+      FAILED = T.let(:failed, Dodopayments::ThreeDSStatus::TaggedSymbol)
+      NOT_SUPPORTED =
+        T.let(:not_supported, Dodopayments::ThreeDSStatus::TaggedSymbol)
+      PROCESSING_ERROR =
+        T.let(:processing_error, Dodopayments::ThreeDSStatus::TaggedSymbol)
+
+      sig do
+        override.returns(T::Array[Dodopayments::ThreeDSStatus::TaggedSymbol])
+      end
+      def self.values
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/update_subscription_plan_req.rbi

@@ -135,6 +135,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.
       sig do
         returns(
@@ -252,6 +257,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
@@ -388,6 +398,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.
       module OnPaymentFailure
         extend Dodopayments::Internal::Type::Enum

data/rbi/dodopayments/models.rbi

@@ -13,12 +13,18 @@ module Dodopayments
 
   AddonCreateParams = Dodopayments::Models::AddonCreateParams
 
+  AddonDeleteParams = Dodopayments::Models::AddonDeleteParams
+
   AddonListParams = Dodopayments::Models::AddonListParams
 
   AddonResponse = Dodopayments::Models::AddonResponse
 
   AddonRetrieveParams = Dodopayments::Models::AddonRetrieveParams
 
+  Addons = Dodopayments::Models::Addons
+
+  AddonUnarchiveParams = Dodopayments::Models::AddonUnarchiveParams
+
   AddonUpdateImagesParams = Dodopayments::Models::AddonUpdateImagesParams
 
   AddonUpdateParams = Dodopayments::Models::AddonUpdateParams
@@ -323,6 +329,10 @@ module Dodopayments
 
   LicenseValidateParams = Dodopayments::Models::LicenseValidateParams
 
+  Locale = Dodopayments::Models::Locale
+
+  LocaleInfo = Dodopayments::Models::LocaleInfo
+
   ManualRetry = Dodopayments::Models::ManualRetry
 
   ManualRetryState = Dodopayments::Models::ManualRetryState
@@ -354,8 +364,14 @@ module Dodopayments
 
   MeterRetrieveParams = Dodopayments::Models::MeterRetrieveParams
 
+  Meters = Dodopayments::Models::Meters
+
   MeterUnarchiveParams = Dodopayments::Models::MeterUnarchiveParams
 
+  MeterUpdateParams = Dodopayments::Models::MeterUpdateParams
+
+  MiscListLocalesParams = Dodopayments::Models::MiscListLocalesParams
+
   MiscListSupportedCountriesParams =
     Dodopayments::Models::MiscListSupportedCountriesParams
 
@@ -577,6 +593,10 @@ module Dodopayments
 
   ThemeModeConfig = Dodopayments::Models::ThemeModeConfig
 
+  ThreeDSFlow = Dodopayments::Models::ThreeDSFlow
+
+  ThreeDSStatus = Dodopayments::Models::ThreeDSStatus
+
   TimeInterval = Dodopayments::Models::TimeInterval
 
   UnsafeUnwrapWebhookEvent = Dodopayments::Models::UnsafeUnwrapWebhookEvent

data/rbi/dodopayments/resources/addons/translations.rbi

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

@@ -3,6 +3,9 @@
 module Dodopayments
   module Resources
     class Addons
+      sig { returns(Dodopayments::Resources::Addons::Translations) }
+      attr_reader :translations
+
       sig do
         params(
           currency: Dodopayments::Currency::OrSymbol,
@@ -31,12 +34,20 @@ module Dodopayments
       sig do
         params(
           id: String,
+          locale: String,
           request_options: Dodopayments::RequestOptions::OrHash
         ).returns(Dodopayments::AddonResponse)
       end
       def retrieve(
         # Addon 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
@@ -75,6 +86,8 @@ module Dodopayments
 
       sig do
         params(
+          archived: T::Boolean,
+          locale: String,
           page_number: Integer,
           page_size: Integer,
           request_options: Dodopayments::RequestOptions::OrHash
@@ -85,6 +98,15 @@ module Dodopayments
         )
       end
       def list(
+        # List archived addons. The default is false.
+        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
@@ -93,6 +115,32 @@ module Dodopayments
       )
       end
 
+      sig do
+        params(
+          id: String,
+          request_options: Dodopayments::RequestOptions::OrHash
+        ).void
+      end
+      def delete(
+        # Addon Id
+        id,
+        request_options: {}
+      )
+      end
+
+      sig do
+        params(
+          id: String,
+          request_options: Dodopayments::RequestOptions::OrHash
+        ).void
+      end
+      def unarchive(
+        # Addon Id
+        id,
+        request_options: {}
+      )
+      end
+
       sig do
         params(
           id: String,