dodopayments 2.34.0 → 2.35.0

data/rbi/dodopayments/models/credit_entitlements/translation_delete_params.rbi

@@ -0,0 +1,58 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    module CreditEntitlements
+      class TranslationDeleteParams < Dodopayments::Internal::Type::BaseModel
+        extend Dodopayments::Internal::Type::RequestParameters::Converter
+        include Dodopayments::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::CreditEntitlements::TranslationDeleteParams,
+              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
+
+        sig do
+          params(
+            id: String,
+            locale: Dodopayments::Locale::OrSymbol,
+            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:,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              locale: Dodopayments::Locale::OrSymbol,
+              request_options: Dodopayments::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/credit_entitlements/translation_list_params.rbi

@@ -0,0 +1,59 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    module CreditEntitlements
+      class TranslationListParams < Dodopayments::Internal::Type::BaseModel
+        extend Dodopayments::Internal::Type::RequestParameters::Converter
+        include Dodopayments::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::CreditEntitlements::TranslationListParams,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        # Returns only these locales, for example `?locale=fr&locale=de`. With no value,
+        # the response has all the locales.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :locale
+
+        sig { params(locale: T::Array[String]).void }
+        attr_writer :locale
+
+        sig do
+          params(
+            id: String,
+            locale: T::Array[String],
+            request_options: Dodopayments::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          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
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              locale: T::Array[String],
+              request_options: Dodopayments::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/credit_entitlements/translation_update_params.rbi

@@ -0,0 +1,74 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    module CreditEntitlements
+      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::CreditEntitlements::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 name.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :name
+
+        # The translated unit.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :unit
+
+        sig do
+          params(
+            id: String,
+            locale: Dodopayments::Locale::OrSymbol,
+            name: T.nilable(String),
+            unit: 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 name.
+          name: nil,
+          # The translated unit.
+          unit: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              locale: Dodopayments::Locale::OrSymbol,
+              name: T.nilable(String),
+              unit: T.nilable(String),
+              request_options: Dodopayments::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/customer.rbi

@@ -51,6 +51,10 @@ module Dodopayments
       sig { returns(T.nilable(String)) }
       attr_accessor :phone_number
 
+      # The language of the customer emails. `null` gives English.
+      sig { returns(T.nilable(Dodopayments::Locale::TaggedSymbol)) }
+      attr_accessor :preferred_locale
+
       sig do
         params(
           business_id: String,
@@ -61,7 +65,8 @@ module Dodopayments
           blocked_at: T.nilable(Time),
           blocklist_entry_id: T.nilable(String),
           metadata: T::Hash[Symbol, Dodopayments::MetadataItem::Variants],
-          phone_number: T.nilable(String)
+          phone_number: T.nilable(String),
+          preferred_locale: T.nilable(Dodopayments::Locale::OrSymbol)
         ).returns(T.attached_class)
       end
       def self.new(
@@ -78,7 +83,9 @@ module Dodopayments
         blocklist_entry_id: nil,
         # Additional metadata for the customer
         metadata: nil,
-        phone_number: nil
+        phone_number: nil,
+        # The language of the customer emails. `null` gives English.
+        preferred_locale: nil
       )
       end
 
@@ -93,7 +100,8 @@ module Dodopayments
             blocked_at: T.nilable(Time),
             blocklist_entry_id: T.nilable(String),
             metadata: T::Hash[Symbol, Dodopayments::MetadataItem::Variants],
-            phone_number: T.nilable(String)
+            phone_number: T.nilable(String),
+            preferred_locale: T.nilable(Dodopayments::Locale::TaggedSymbol)
           }
         )
       end

data/rbi/dodopayments/models/customer_create_params.rbi

@@ -38,12 +38,19 @@ module Dodopayments
       sig { returns(T.nilable(String)) }
       attr_accessor :phone_number
 
+      # 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.
+      sig { returns(T.nilable(Dodopayments::Locale::OrSymbol)) }
+      attr_accessor :preferred_locale
+
       sig do
         params(
           email: String,
           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(T.attached_class)
       end
@@ -53,6 +60,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
@@ -64,6 +75,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
           }
         )

data/rbi/dodopayments/models/customer_update_params.rbi

@@ -34,6 +34,12 @@ module Dodopayments
       sig { returns(T.nilable(String)) }
       attr_accessor :phone_number
 
+      # 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.
+      sig { returns(T.nilable(Dodopayments::Locale::OrSymbol)) }
+      attr_accessor :preferred_locale
+
       sig do
         params(
           customer_id: String,
@@ -42,6 +48,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(T.attached_class)
       end
@@ -52,6 +59,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
@@ -65,6 +76,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
           }
         )

data/rbi/dodopayments/models/entitlement_list_params.rbi

@@ -32,6 +32,18 @@ module Dodopayments
       end
       attr_writer :integration_type
 
+      # 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 0)
       sig { returns(T.nilable(Integer)) }
       attr_reader :page_number
@@ -50,6 +62,7 @@ module Dodopayments
         params(
           integration_type:
             Dodopayments::EntitlementListParams::IntegrationType::OrSymbol,
+          locale: String,
           page_number: Integer,
           page_size: Integer,
           request_options: Dodopayments::RequestOptions::OrHash
@@ -58,6 +71,13 @@ module Dodopayments
       def self.new(
         # 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)
@@ -71,6 +91,7 @@ module Dodopayments
           {
             integration_type:
               Dodopayments::EntitlementListParams::IntegrationType::OrSymbol,
+            locale: String,
             page_number: Integer,
             page_size: Integer,
             request_options: Dodopayments::RequestOptions

data/rbi/dodopayments/models/entitlement_retrieve_params.rbi

@@ -17,18 +17,45 @@ module Dodopayments
       sig { returns(String) }
       attr_accessor :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(
           id: String,
+          locale: String,
           request_options: Dodopayments::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(id:, request_options: {})
+      def self.new(
+        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(
-          { id: String, request_options: Dodopayments::RequestOptions }
+          {
+            id: String,
+            locale: String,
+            request_options: Dodopayments::RequestOptions
+          }
         )
       end
       def to_hash

data/rbi/dodopayments/models/entitlements/entitlement_translation.rbi

@@ -0,0 +1,87 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    EntitlementTranslation = Entitlements::EntitlementTranslation
+
+    module Entitlements
+      class EntitlementTranslation < Dodopayments::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::Entitlements::EntitlementTranslation,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
+        # The locale of the translation.
+        sig { returns(Dodopayments::Locale::TaggedSymbol) }
+        attr_accessor :locale
+
+        # The time of the last change.
+        sig { returns(Time) }
+        attr_accessor :updated_at
+
+        # The translated activation message of a `license_key` entitlement.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :activation_message
+
+        # The translated description. `null` shows that the description has no
+        # translation.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :description
+
+        # The translated delivery instructions of a `digital_files` entitlement.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :instructions
+
+        # The translated name. `null` shows that the name has no translation.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :name
+
+        # The translation of an entitlement in one locale.
+        sig do
+          params(
+            locale: Dodopayments::Locale::OrSymbol,
+            updated_at: Time,
+            activation_message: T.nilable(String),
+            description: T.nilable(String),
+            instructions: T.nilable(String),
+            name: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The locale of the translation.
+          locale:,
+          # The time of the last change.
+          updated_at:,
+          # The translated activation message of a `license_key` entitlement.
+          activation_message: nil,
+          # The translated description. `null` shows that the description has no
+          # translation.
+          description: nil,
+          # The translated delivery instructions of a `digital_files` entitlement.
+          instructions: nil,
+          # The translated name. `null` shows that the name has no translation.
+          name: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              locale: Dodopayments::Locale::TaggedSymbol,
+              updated_at: Time,
+              activation_message: T.nilable(String),
+              description: T.nilable(String),
+              instructions: T.nilable(String),
+              name: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/entitlements/entitlement_translations_list_response.rbi

@@ -0,0 +1,48 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    EntitlementTranslationsListResponse =
+      Entitlements::EntitlementTranslationsListResponse
+
+    module Entitlements
+      class EntitlementTranslationsListResponse < Dodopayments::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::Entitlements::EntitlementTranslationsListResponse,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
+        sig do
+          returns(T::Array[Dodopayments::Entitlements::EntitlementTranslation])
+        end
+        attr_accessor :items
+
+        # The translations of an entitlement.
+        sig do
+          params(
+            items:
+              T::Array[
+                Dodopayments::Entitlements::EntitlementTranslation::OrHash
+              ]
+          ).returns(T.attached_class)
+        end
+        def self.new(items:)
+        end
+
+        sig do
+          override.returns(
+            {
+              items:
+                T::Array[Dodopayments::Entitlements::EntitlementTranslation]
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/entitlements/translation_delete_params.rbi

@@ -0,0 +1,58 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    module Entitlements
+      class TranslationDeleteParams < Dodopayments::Internal::Type::BaseModel
+        extend Dodopayments::Internal::Type::RequestParameters::Converter
+        include Dodopayments::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::Entitlements::TranslationDeleteParams,
+              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
+
+        sig do
+          params(
+            id: String,
+            locale: Dodopayments::Locale::OrSymbol,
+            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:,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              locale: Dodopayments::Locale::OrSymbol,
+              request_options: Dodopayments::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/entitlements/translation_list_params.rbi

@@ -0,0 +1,59 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    module Entitlements
+      class TranslationListParams < Dodopayments::Internal::Type::BaseModel
+        extend Dodopayments::Internal::Type::RequestParameters::Converter
+        include Dodopayments::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::Entitlements::TranslationListParams,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        # Returns only these locales, for example `?locale=fr&locale=de`. With no value,
+        # the response has all the locales.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :locale
+
+        sig { params(locale: T::Array[String]).void }
+        attr_writer :locale
+
+        sig do
+          params(
+            id: String,
+            locale: T::Array[String],
+            request_options: Dodopayments::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          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
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              locale: T::Array[String],
+              request_options: Dodopayments::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end