dodopayments 2.34.0 → 2.35.0

data/rbi/dodopayments/models/addon_list_params.rbi

@@ -11,6 +11,25 @@ module Dodopayments
           T.any(Dodopayments::AddonListParams, Dodopayments::Internal::AnyHash)
         end
 
+      # List archived addons. The default is false.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :archived
+
+      sig { params(archived: T::Boolean).void }
+      attr_writer :archived
+
+      # 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
@@ -27,12 +46,23 @@ module Dodopayments
 
       sig do
         params(
+          archived: T::Boolean,
+          locale: String,
           page_number: Integer,
           page_size: Integer,
           request_options: Dodopayments::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
+        # 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
@@ -44,6 +74,8 @@ module Dodopayments
       sig do
         override.returns(
           {
+            archived: T::Boolean,
+            locale: String,
             page_number: Integer,
             page_size: Integer,
             request_options: Dodopayments::RequestOptions

data/rbi/dodopayments/models/addon_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/addon_unarchive_params.rbi

@@ -0,0 +1,38 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class AddonUnarchiveParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::AddonUnarchiveParams,
+            Dodopayments::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      sig do
+        params(
+          id: String,
+          request_options: Dodopayments::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(id:, request_options: {})
+      end
+
+      sig do
+        override.returns(
+          { id: String, request_options: Dodopayments::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/addons/translation_delete_params.rbi

@@ -0,0 +1,58 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    module Addons
+      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::Addons::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/addons/translation_list_params.rbi

@@ -0,0 +1,59 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    module Addons
+      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::Addons::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/addons/translation_update_params.rbi

@@ -0,0 +1,74 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    module Addons
+      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::Addons::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/balance_ledger_entry.rbi

@@ -283,6 +283,11 @@ module Dodopayments
             :scheme_fee,
             Dodopayments::BalanceLedgerEntry::EventType::TaggedSymbol
           )
+        OPENING_BALANCE =
+          T.let(
+            :opening_balance,
+            Dodopayments::BalanceLedgerEntry::EventType::TaggedSymbol
+          )
 
         sig do
           override.returns(

data/rbi/dodopayments/models/balance_retrieve_ledger_params.rbi

@@ -1075,6 +1075,11 @@ module Dodopayments
             :scheme_fee,
             Dodopayments::BalanceRetrieveLedgerParams::EventType::TaggedSymbol
           )
+        OPENING_BALANCE =
+          T.let(
+            :opening_balance,
+            Dodopayments::BalanceRetrieveLedgerParams::EventType::TaggedSymbol
+          )
 
         sig do
           override.returns(

data/rbi/dodopayments/models/checkout_session_preview_params.rbi

@@ -14,16 +14,40 @@ module Dodopayments
           )
         end
 
+      # 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(request_options: Dodopayments::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          locale: String,
+          request_options: Dodopayments::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(
+        # 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({ request_options: Dodopayments::RequestOptions })
+        override.returns(
+          { locale: String, request_options: Dodopayments::RequestOptions }
+        )
       end
       def to_hash
       end

data/rbi/dodopayments/models/create_new_customer.rbi

@@ -29,12 +29,20 @@ 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 stored language of the customer, also for an existing customer.
+      # Send a value only to change that language on purpose. With no value, the stored
+      # language stays.
+      sig { returns(T.nilable(Dodopayments::Locale::OrSymbol)) }
+      attr_accessor :preferred_locale
+
       sig do
         params(
           email: String,
           name: String,
           create_new_customer: T::Boolean,
-          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(
@@ -44,7 +52,12 @@ module Dodopayments
         # used if exists. When true, a new customer object is always created False by
         # default
         create_new_customer: nil,
-        phone_number: nil
+        phone_number: nil,
+        # The language of the customer emails, a code from `GET /locales`. A value
+        # replaces the stored language of the customer, also for an existing customer.
+        # Send a value only to change that language on purpose. With no value, the stored
+        # language stays.
+        preferred_locale: nil
       )
       end
 
@@ -54,7 +67,8 @@ module Dodopayments
             email: String,
             name: String,
             create_new_customer: T::Boolean,
-            phone_number: T.nilable(String)
+            phone_number: T.nilable(String),
+            preferred_locale: T.nilable(Dodopayments::Locale::OrSymbol)
           }
         )
       end

data/rbi/dodopayments/models/credit_entitlement_list_params.rbi

@@ -21,6 +21,18 @@ module Dodopayments
       sig { params(deleted: T::Boolean).void }
       attr_writer :deleted
 
+      # 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
@@ -38,6 +50,7 @@ module Dodopayments
       sig do
         params(
           deleted: T::Boolean,
+          locale: String,
           page_number: Integer,
           page_size: Integer,
           request_options: Dodopayments::RequestOptions::OrHash
@@ -46,6 +59,13 @@ module Dodopayments
       def self.new(
         # List deleted credit entitlements
         deleted: nil,
+        # Shows the translated name, description and unit of the catalog entities in this
+        # locale. The value must be a code from `GET /locales`, for example `fr`. A field
+        # with no translation, an unknown code, or no code shows the base text.
+        #
+        # Do not send a text from a localized response back in a create or update request.
+        # The base text then changes to the translated text.
+        locale: nil,
         # Page number default is 0
         page_number: nil,
         # Page size default is 10 max is 100
@@ -58,6 +78,7 @@ module Dodopayments
         override.returns(
           {
             deleted: T::Boolean,
+            locale: String,
             page_number: Integer,
             page_size: Integer,
             request_options: Dodopayments::RequestOptions

data/rbi/dodopayments/models/credit_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/credit_entitlements/credit_entitlement_translation.rbi

@@ -0,0 +1,70 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    CreditEntitlementTranslation =
+      CreditEntitlements::CreditEntitlementTranslation
+
+    module CreditEntitlements
+      class CreditEntitlementTranslation < Dodopayments::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::CreditEntitlements::CreditEntitlementTranslation,
+              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 name. `null` shows that the name has no translation.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :name
+
+        # The translated unit. `null` shows that the unit has no translation.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :unit
+
+        # The translation of a credit entitlement in one locale.
+        sig do
+          params(
+            locale: Dodopayments::Locale::OrSymbol,
+            updated_at: Time,
+            name: T.nilable(String),
+            unit: 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 name. `null` shows that the name has no translation.
+          name: nil,
+          # The translated unit. `null` shows that the unit has no translation.
+          unit: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              locale: Dodopayments::Locale::TaggedSymbol,
+              updated_at: Time,
+              name: T.nilable(String),
+              unit: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/credit_entitlements/credit_entitlement_translations_list_response.rbi

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