dodopayments 2.34.0 → 2.35.0

data/rbi/dodopayments/models/entitlements/translation_update_params.rbi

@@ -0,0 +1,92 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    module Entitlements
+      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::Entitlements::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 activation message. Only a `license_key` entitlement has it.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :activation_message
+
+        # The translated description.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :description
+
+        # The translated delivery instructions. Only a `digital_files` entitlement has
+        # them.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :instructions
+
+        # The translated name.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :name
+
+        sig do
+          params(
+            id: String,
+            locale: Dodopayments::Locale::OrSymbol,
+            activation_message: T.nilable(String),
+            description: T.nilable(String),
+            instructions: 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 activation message. Only a `license_key` entitlement has it.
+          activation_message: nil,
+          # The translated description.
+          description: nil,
+          # The translated delivery instructions. Only a `digital_files` entitlement has
+          # them.
+          instructions: nil,
+          # The translated name.
+          name: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              locale: Dodopayments::Locale::OrSymbol,
+              activation_message: T.nilable(String),
+              description: T.nilable(String),
+              instructions: T.nilable(String),
+              name: T.nilable(String),
+              request_options: Dodopayments::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/locale.rbi

@@ -0,0 +1,42 @@
+# typed: strong
+
+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
+
+      TaggedSymbol = T.type_alias { T.all(Symbol, Dodopayments::Locale) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      AR = T.let(:ar, Dodopayments::Locale::TaggedSymbol)
+      CA = T.let(:ca, Dodopayments::Locale::TaggedSymbol)
+      ZH = T.let(:zh, Dodopayments::Locale::TaggedSymbol)
+      NL = T.let(:nl, Dodopayments::Locale::TaggedSymbol)
+      EN = T.let(:en, Dodopayments::Locale::TaggedSymbol)
+      FR = T.let(:fr, Dodopayments::Locale::TaggedSymbol)
+      DE = T.let(:de, Dodopayments::Locale::TaggedSymbol)
+      HE = T.let(:he, Dodopayments::Locale::TaggedSymbol)
+      ID = T.let(:id, Dodopayments::Locale::TaggedSymbol)
+      IT = T.let(:it, Dodopayments::Locale::TaggedSymbol)
+      JA = T.let(:ja, Dodopayments::Locale::TaggedSymbol)
+      KA = T.let(:ka, Dodopayments::Locale::TaggedSymbol)
+      KO = T.let(:ko, Dodopayments::Locale::TaggedSymbol)
+      MS = T.let(:ms, Dodopayments::Locale::TaggedSymbol)
+      PL = T.let(:pl, Dodopayments::Locale::TaggedSymbol)
+      PT = T.let(:pt, Dodopayments::Locale::TaggedSymbol)
+      RO = T.let(:ro, Dodopayments::Locale::TaggedSymbol)
+      RU = T.let(:ru, Dodopayments::Locale::TaggedSymbol)
+      ES = T.let(:es, Dodopayments::Locale::TaggedSymbol)
+      SV = T.let(:sv, Dodopayments::Locale::TaggedSymbol)
+      TH = T.let(:th, Dodopayments::Locale::TaggedSymbol)
+      TR = T.let(:tr, Dodopayments::Locale::TaggedSymbol)
+
+      sig { override.returns(T::Array[Dodopayments::Locale::TaggedSymbol]) }
+      def self.values
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/locale_info.rbi

@@ -0,0 +1,54 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class LocaleInfo < Dodopayments::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Dodopayments::LocaleInfo, Dodopayments::Internal::AnyHash)
+        end
+
+      # The code to send in the `locale` parameter.
+      sig { returns(Dodopayments::Locale::TaggedSymbol) }
+      attr_accessor :code
+
+      # The English name of the language.
+      sig { returns(String) }
+      attr_accessor :name
+
+      # The name of the language in that language.
+      sig { returns(String) }
+      attr_accessor :native_name
+
+      # A locale that the checkout and the customer portal can show.
+      sig do
+        params(
+          code: Dodopayments::Locale::OrSymbol,
+          name: String,
+          native_name: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The code to send in the `locale` parameter.
+        code:,
+        # The English name of the language.
+        name:,
+        # The name of the language in that language.
+        native_name:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            code: Dodopayments::Locale::TaggedSymbol,
+            name: String,
+            native_name: String
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/meter_list_params.rbi

@@ -18,6 +18,18 @@ module Dodopayments
       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
@@ -35,6 +47,7 @@ module Dodopayments
       sig do
         params(
           archived: T::Boolean,
+          locale: String,
           page_number: Integer,
           page_size: Integer,
           request_options: Dodopayments::RequestOptions::OrHash
@@ -43,6 +56,13 @@ module Dodopayments
       def self.new(
         # 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
@@ -55,6 +75,7 @@ module Dodopayments
         override.returns(
           {
             archived: T::Boolean,
+            locale: String,
             page_number: Integer,
             page_size: Integer,
             request_options: Dodopayments::RequestOptions

data/rbi/dodopayments/models/meter_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/meter_update_params.rbi

@@ -0,0 +1,70 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class MeterUpdateParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::MeterUpdateParams,
+            Dodopayments::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Description of the meter. Send `null` to remove the description. Omit it to keep
+      # it.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :description
+
+      # Measurement unit
+      sig { returns(T.nilable(String)) }
+      attr_accessor :measurement_unit
+
+      # Name of the meter
+      sig { returns(T.nilable(String)) }
+      attr_accessor :name
+
+      sig do
+        params(
+          id: String,
+          description: T.nilable(String),
+          measurement_unit: T.nilable(String),
+          name: T.nilable(String),
+          request_options: Dodopayments::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        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
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            description: T.nilable(String),
+            measurement_unit: T.nilable(String),
+            name: T.nilable(String),
+            request_options: Dodopayments::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/meters/translation_delete_params.rbi

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

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

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

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

data/rbi/dodopayments/models/misc_list_locales_response.rbi

@@ -0,0 +1,11 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    MiscListLocalesResponse =
+      T.let(
+        Dodopayments::Internal::Type::ArrayOf[Dodopayments::LocaleInfo],
+        Dodopayments::Internal::Type::Converter
+      )
+  end
+end

data/rbi/dodopayments/models/payment.rbi

@@ -248,6 +248,22 @@ module Dodopayments
       sig { returns(T.nilable(Integer)) }
       attr_accessor :tax
 
+      # How the cardholder completed the 3DS authentication. The value is null when the
+      # processor does not report it.
+      sig { returns(T.nilable(Dodopayments::ThreeDSFlow::TaggedSymbol)) }
+      attr_accessor :three_ds_flow
+
+      # The result of the 3DS authentication, as the processor reports it. The value is
+      # null when the processor reports no 3DS data, for example when the payment did
+      # not use 3DS.
+      sig { returns(T.nilable(Dodopayments::ThreeDSStatus::TaggedSymbol)) }
+      attr_accessor :three_ds_status
+
+      # The 3DS protocol version, for example `2.2.0`. The value is null when the
+      # processor does not report it.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :three_ds_version
+
       # Timestamp when the payment was last updated
       sig { returns(T.nilable(Time)) }
       attr_accessor :updated_at
@@ -304,6 +320,9 @@ module Dodopayments
           status: T.nilable(Dodopayments::IntentStatus::OrSymbol),
           subscription_id: T.nilable(String),
           tax: T.nilable(Integer),
+          three_ds_flow: T.nilable(Dodopayments::ThreeDSFlow::OrSymbol),
+          three_ds_status: T.nilable(Dodopayments::ThreeDSStatus::OrSymbol),
+          three_ds_version: T.nilable(String),
           updated_at: T.nilable(Time)
         ).returns(T.attached_class)
       end
@@ -444,6 +463,16 @@ module Dodopayments
         # Amount of tax collected in the currency's smallest unit (e.g. cents for USD, yen
         # for JPY, fils for KWD)
         tax: nil,
+        # How the cardholder completed the 3DS authentication. The value is null when the
+        # processor does not report it.
+        three_ds_flow: nil,
+        # The result of the 3DS authentication, as the processor reports it. The value is
+        # null when the processor reports no 3DS data, for example when the payment did
+        # not use 3DS.
+        three_ds_status: nil,
+        # The 3DS protocol version, for example `2.2.0`. The value is null when the
+        # processor does not report it.
+        three_ds_version: nil,
         # Timestamp when the payment was last updated
         updated_at: nil
       )
@@ -504,6 +533,10 @@ module Dodopayments
             status: T.nilable(Dodopayments::IntentStatus::TaggedSymbol),
             subscription_id: T.nilable(String),
             tax: T.nilable(Integer),
+            three_ds_flow: T.nilable(Dodopayments::ThreeDSFlow::TaggedSymbol),
+            three_ds_status:
+              T.nilable(Dodopayments::ThreeDSStatus::TaggedSymbol),
+            three_ds_version: T.nilable(String),
             updated_at: T.nilable(Time)
           }
         )