dodopayments 2.34.0 → 2.35.0

data/lib/dodopayments/models/customer_update_params.rb

@@ -35,7 +35,18 @@ module Dodopayments
       #   @return [String, nil]
       optional :phone_number, String, nil?: true
 
-      # @!method initialize(customer_id:, email: nil, metadata: nil, name: nil, phone_number: nil, request_options: {})
+      # @!attribute preferred_locale
+      #   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.
+      #
+      #   @return [Symbol, Dodopayments::Models::Locale, nil]
+      optional :preferred_locale, enum: -> { Dodopayments::Locale }, nil?: true
+
+      # @!method initialize(customer_id:, email: nil, metadata: nil, name: nil, phone_number: nil, preferred_locale: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::CustomerUpdateParams} for more details.
+      #
       #   @param customer_id [String]
       #
       #   @param email [String, nil]
@@ -46,6 +57,8 @@ module Dodopayments
       #
       #   @param phone_number [String, nil]
       #
+      #   @param preferred_locale [Symbol, Dodopayments::Models::Locale, nil] The language of the customer emails, a code from `GET /locales`. A value replace
+      #
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/dodopayments/models/entitlement_list_params.rb

@@ -13,6 +13,17 @@ module Dodopayments
       #   @return [Symbol, Dodopayments::Models::EntitlementListParams::IntegrationType, nil]
       optional :integration_type, enum: -> { Dodopayments::EntitlementListParams::IntegrationType }
 
+      # @!attribute locale
+      #   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.
+      #
+      #   @return [String, nil]
+      optional :locale, String
+
       # @!attribute page_number
       #   Page number (default 0)
       #
@@ -25,9 +36,14 @@ module Dodopayments
       #   @return [Integer, nil]
       optional :page_size, Integer
 
-      # @!method initialize(integration_type: nil, page_number: nil, page_size: nil, request_options: {})
+      # @!method initialize(integration_type: nil, locale: nil, page_number: nil, page_size: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::EntitlementListParams} for more details.
+      #
       #   @param integration_type [Symbol, Dodopayments::Models::EntitlementListParams::IntegrationType] Filter by integration type
       #
+      #   @param locale [String] Shows the translated name, description and unit of the catalog entities in this
+      #
       #   @param page_number [Integer] Page number (default 0)
       #
       #   @param page_size [Integer] Page size (default 10, max 100)

data/lib/dodopayments/models/entitlement_retrieve_params.rb

@@ -12,8 +12,25 @@ module Dodopayments
       #   @return [String]
       required :id, String
 
-      # @!method initialize(id:, request_options: {})
+      # @!attribute locale
+      #   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.
+      #
+      #   @return [String, nil]
+      optional :locale, String
+
+      # @!method initialize(id:, locale: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::EntitlementRetrieveParams} for more details.
+      #
       #   @param id [String]
+      #
+      #   @param locale [String] Shows the translated name, description and unit of the catalog entities in this
+      #
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/dodopayments/models/entitlements/entitlement_translation.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module Entitlements
+      # @see Dodopayments::Resources::Entitlements::Translations#update
+      class EntitlementTranslation < Dodopayments::Internal::Type::BaseModel
+        # @!attribute locale
+        #   The locale of the translation.
+        #
+        #   @return [Symbol, Dodopayments::Models::Locale]
+        required :locale, enum: -> { Dodopayments::Locale }
+
+        # @!attribute updated_at
+        #   The time of the last change.
+        #
+        #   @return [Time]
+        required :updated_at, Time
+
+        # @!attribute activation_message
+        #   The translated activation message of a `license_key` entitlement.
+        #
+        #   @return [String, nil]
+        optional :activation_message, String, nil?: true
+
+        # @!attribute description
+        #   The translated description. `null` shows that the description has no
+        #   translation.
+        #
+        #   @return [String, nil]
+        optional :description, String, nil?: true
+
+        # @!attribute instructions
+        #   The translated delivery instructions of a `digital_files` entitlement.
+        #
+        #   @return [String, nil]
+        optional :instructions, String, nil?: true
+
+        # @!attribute name
+        #   The translated name. `null` shows that the name has no translation.
+        #
+        #   @return [String, nil]
+        optional :name, String, nil?: true
+
+        # @!method initialize(locale:, updated_at:, activation_message: nil, description: nil, instructions: nil, name: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Dodopayments::Models::Entitlements::EntitlementTranslation} for more details.
+        #
+        #   The translation of an entitlement in one locale.
+        #
+        #   @param locale [Symbol, Dodopayments::Models::Locale] The locale of the translation.
+        #
+        #   @param updated_at [Time] The time of the last change.
+        #
+        #   @param activation_message [String, nil] The translated activation message of a `license_key` entitlement.
+        #
+        #   @param description [String, nil] The translated description. `null` shows that the description has no translation
+        #
+        #   @param instructions [String, nil] The translated delivery instructions of a `digital_files` entitlement.
+        #
+        #   @param name [String, nil] The translated name. `null` shows that the name has no translation.
+      end
+    end
+
+    EntitlementTranslation = Entitlements::EntitlementTranslation
+  end
+end

data/lib/dodopayments/models/entitlements/entitlement_translations_list_response.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module Entitlements
+      # @see Dodopayments::Resources::Entitlements::Translations#list
+      class EntitlementTranslationsListResponse < Dodopayments::Internal::Type::BaseModel
+        # @!attribute items
+        #
+        #   @return [Array<Dodopayments::Models::Entitlements::EntitlementTranslation>]
+        required :items,
+                 -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::Entitlements::EntitlementTranslation] }
+
+        # @!method initialize(items:)
+        #   The translations of an entitlement.
+        #
+        #   @param items [Array<Dodopayments::Models::Entitlements::EntitlementTranslation>]
+      end
+    end
+
+    EntitlementTranslationsListResponse = Entitlements::EntitlementTranslationsListResponse
+  end
+end

data/lib/dodopayments/models/entitlements/translation_delete_params.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module Entitlements
+      # @see Dodopayments::Resources::Entitlements::Translations#delete
+      class TranslationDeleteParams < Dodopayments::Internal::Type::BaseModel
+        extend Dodopayments::Internal::Type::RequestParameters::Converter
+        include Dodopayments::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute locale
+        #   A locale that the checkout and the customer portal can show.
+        #
+        #   The codes are a copy of the checkout locales. `GET /locales` lists them.
+        #
+        #   @return [Symbol, Dodopayments::Models::Locale]
+        required :locale, enum: -> { Dodopayments::Locale }
+
+        # @!method initialize(id:, locale:, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Dodopayments::Models::Entitlements::TranslationDeleteParams} for more details.
+        #
+        #   @param id [String]
+        #
+        #   @param locale [Symbol, Dodopayments::Models::Locale] A locale that the checkout and the customer portal can show.
+        #
+        #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/dodopayments/models/entitlements/translation_list_params.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module Entitlements
+      # @see Dodopayments::Resources::Entitlements::Translations#list
+      class TranslationListParams < Dodopayments::Internal::Type::BaseModel
+        extend Dodopayments::Internal::Type::RequestParameters::Converter
+        include Dodopayments::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute locale
+        #   Returns only these locales, for example `?locale=fr&locale=de`. With no value,
+        #   the response has all the locales.
+        #
+        #   @return [Array<String>, nil]
+        optional :locale, Dodopayments::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(id:, locale: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Dodopayments::Models::Entitlements::TranslationListParams} for more details.
+        #
+        #   @param id [String]
+        #
+        #   @param locale [Array<String>] Returns only these locales, for example `?locale=fr&locale=de`. With no value, t
+        #
+        #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/dodopayments/models/entitlements/translation_update_params.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module Entitlements
+      # @see Dodopayments::Resources::Entitlements::Translations#update
+      class TranslationUpdateParams < Dodopayments::Internal::Type::BaseModel
+        extend Dodopayments::Internal::Type::RequestParameters::Converter
+        include Dodopayments::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute locale
+        #   A locale that the checkout and the customer portal can show.
+        #
+        #   The codes are a copy of the checkout locales. `GET /locales` lists them.
+        #
+        #   @return [Symbol, Dodopayments::Models::Locale]
+        required :locale, enum: -> { Dodopayments::Locale }
+
+        # @!attribute activation_message
+        #   The translated activation message. Only a `license_key` entitlement has it.
+        #
+        #   @return [String, nil]
+        optional :activation_message, String, nil?: true
+
+        # @!attribute description
+        #   The translated description.
+        #
+        #   @return [String, nil]
+        optional :description, String, nil?: true
+
+        # @!attribute instructions
+        #   The translated delivery instructions. Only a `digital_files` entitlement has
+        #   them.
+        #
+        #   @return [String, nil]
+        optional :instructions, String, nil?: true
+
+        # @!attribute name
+        #   The translated name.
+        #
+        #   @return [String, nil]
+        optional :name, String, nil?: true
+
+        # @!method initialize(id:, locale:, activation_message: nil, description: nil, instructions: nil, name: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Dodopayments::Models::Entitlements::TranslationUpdateParams} for more details.
+        #
+        #   @param id [String]
+        #
+        #   @param locale [Symbol, Dodopayments::Models::Locale] A locale that the checkout and the customer portal can show.
+        #
+        #   @param activation_message [String, nil] The translated activation message. Only a `license_key` entitlement has it.
+        #
+        #   @param description [String, nil] The translated description.
+        #
+        #   @param instructions [String, nil] The translated delivery instructions. Only a `digital_files` entitlement has the
+        #
+        #   @param name [String, nil] The translated name.
+        #
+        #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/dodopayments/models/locale.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # A locale that the checkout and the customer portal can show.
+    #
+    # The codes are a copy of the checkout locales. `GET /locales` lists them.
+    module Locale
+      extend Dodopayments::Internal::Type::Enum
+
+      AR = :ar
+      CA = :ca
+      ZH = :zh
+      NL = :nl
+      EN = :en
+      FR = :fr
+      DE = :de
+      HE = :he
+      ID = :id
+      IT = :it
+      JA = :ja
+      KA = :ka
+      KO = :ko
+      MS = :ms
+      PL = :pl
+      PT = :pt
+      RO = :ro
+      RU = :ru
+      ES = :es
+      SV = :sv
+      TH = :th
+      TR = :tr
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/dodopayments/models/locale_info.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    class LocaleInfo < Dodopayments::Internal::Type::BaseModel
+      # @!attribute code
+      #   The code to send in the `locale` parameter.
+      #
+      #   @return [Symbol, Dodopayments::Models::Locale]
+      required :code, enum: -> { Dodopayments::Locale }
+
+      # @!attribute name
+      #   The English name of the language.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute native_name
+      #   The name of the language in that language.
+      #
+      #   @return [String]
+      required :native_name, String
+
+      # @!method initialize(code:, name:, native_name:)
+      #   A locale that the checkout and the customer portal can show.
+      #
+      #   @param code [Symbol, Dodopayments::Models::Locale] The code to send in the `locale` parameter.
+      #
+      #   @param name [String] The English name of the language.
+      #
+      #   @param native_name [String] The name of the language in that language.
+    end
+  end
+end

data/lib/dodopayments/models/meter_list_params.rb

@@ -13,6 +13,17 @@ module Dodopayments
       #   @return [Boolean, nil]
       optional :archived, Dodopayments::Internal::Type::Boolean
 
+      # @!attribute locale
+      #   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.
+      #
+      #   @return [String, nil]
+      optional :locale, String
+
       # @!attribute page_number
       #   Page number default is 0
       #
@@ -25,9 +36,14 @@ module Dodopayments
       #   @return [Integer, nil]
       optional :page_size, Integer
 
-      # @!method initialize(archived: nil, page_number: nil, page_size: nil, request_options: {})
+      # @!method initialize(archived: nil, locale: nil, page_number: nil, page_size: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::MeterListParams} for more details.
+      #
       #   @param archived [Boolean] List archived meters
       #
+      #   @param locale [String] Shows the translated name, description and unit of the catalog entities in this
+      #
       #   @param page_number [Integer] Page number default is 0
       #
       #   @param page_size [Integer] Page size default is 10 max is 100

data/lib/dodopayments/models/meter_retrieve_params.rb

@@ -12,8 +12,25 @@ module Dodopayments
       #   @return [String]
       required :id, String
 
-      # @!method initialize(id:, request_options: {})
+      # @!attribute locale
+      #   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.
+      #
+      #   @return [String, nil]
+      optional :locale, String
+
+      # @!method initialize(id:, locale: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::MeterRetrieveParams} for more details.
+      #
       #   @param id [String]
+      #
+      #   @param locale [String] Shows the translated name, description and unit of the catalog entities in this
+      #
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/dodopayments/models/meter_update_params.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::Meters#update
+    class MeterUpdateParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute description
+      #   Description of the meter. Send `null` to remove the description. Omit it to keep
+      #   it.
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!attribute measurement_unit
+      #   Measurement unit
+      #
+      #   @return [String, nil]
+      optional :measurement_unit, String, nil?: true
+
+      # @!attribute name
+      #   Name of the meter
+      #
+      #   @return [String, nil]
+      optional :name, String, nil?: true
+
+      # @!method initialize(id:, description: nil, measurement_unit: nil, name: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::MeterUpdateParams} for more details.
+      #
+      #   @param id [String]
+      #
+      #   @param description [String, nil] Description of the meter. Send `null` to remove the description. Omit it to keep
+      #
+      #   @param measurement_unit [String, nil] Measurement unit
+      #
+      #   @param name [String, nil] Name of the meter
+      #
+      #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/dodopayments/models/meters/translation_delete_params.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module Meters
+      # @see Dodopayments::Resources::Meters::Translations#delete
+      class TranslationDeleteParams < Dodopayments::Internal::Type::BaseModel
+        extend Dodopayments::Internal::Type::RequestParameters::Converter
+        include Dodopayments::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute locale
+        #   A locale that the checkout and the customer portal can show.
+        #
+        #   The codes are a copy of the checkout locales. `GET /locales` lists them.
+        #
+        #   @return [Symbol, Dodopayments::Models::Locale]
+        required :locale, enum: -> { Dodopayments::Locale }
+
+        # @!method initialize(id:, locale:, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Dodopayments::Models::Meters::TranslationDeleteParams} for more details.
+        #
+        #   @param id [String]
+        #
+        #   @param locale [Symbol, Dodopayments::Models::Locale] A locale that the checkout and the customer portal can show.
+        #
+        #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/dodopayments/models/meters/translation_list_params.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module Meters
+      # @see Dodopayments::Resources::Meters::Translations#list
+      class TranslationListParams < Dodopayments::Internal::Type::BaseModel
+        extend Dodopayments::Internal::Type::RequestParameters::Converter
+        include Dodopayments::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute locale
+        #   Returns only these locales, for example `?locale=fr&locale=de`. With no value,
+        #   the response has all the locales.
+        #
+        #   @return [Array<String>, nil]
+        optional :locale, Dodopayments::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(id:, locale: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Dodopayments::Models::Meters::TranslationListParams} for more details.
+        #
+        #   @param id [String]
+        #
+        #   @param locale [Array<String>] Returns only these locales, for example `?locale=fr&locale=de`. With no value, t
+        #
+        #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/dodopayments/models/meters/translation_update_params.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module Meters
+      # @see Dodopayments::Resources::Meters::Translations#update
+      class TranslationUpdateParams < Dodopayments::Internal::Type::BaseModel
+        extend Dodopayments::Internal::Type::RequestParameters::Converter
+        include Dodopayments::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute locale
+        #   A locale that the checkout and the customer portal can show.
+        #
+        #   The codes are a copy of the checkout locales. `GET /locales` lists them.
+        #
+        #   @return [Symbol, Dodopayments::Models::Locale]
+        required :locale, enum: -> { Dodopayments::Locale }
+
+        # @!attribute description
+        #   The translated description.
+        #
+        #   @return [String, nil]
+        optional :description, String, nil?: true
+
+        # @!attribute name
+        #   The translated name.
+        #
+        #   @return [String, nil]
+        optional :name, String, nil?: true
+
+        # @!method initialize(id:, locale:, description: nil, name: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Dodopayments::Models::Meters::TranslationUpdateParams} for more details.
+        #
+        #   @param id [String]
+        #
+        #   @param locale [Symbol, Dodopayments::Models::Locale] A locale that the checkout and the customer portal can show.
+        #
+        #   @param description [String, nil] The translated description.
+        #
+        #   @param name [String, nil] The translated name.
+        #
+        #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/dodopayments/models/misc_list_locales_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::Misc#list_locales
+    class MiscListLocalesParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/dodopayments/models/misc_list_locales_response.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @type [Dodopayments::Internal::Type::Converter]
+    MiscListLocalesResponse = Dodopayments::Internal::Type::ArrayOf[-> { Dodopayments::LocaleInfo }]
+  end
+end