modern_treasury 0.28.0 → 0.29.0

data/rbi/modern_treasury/models/connection_legal_entity_create_params.rbi

@@ -136,8 +136,8 @@ module ModernTreasury
         sig { returns(T.nilable(String)) }
         attr_accessor :connection_id
 
-        # The country code where the business is incorporated in the ISO 3166-1 alpha-2 or
-        # alpha-3 formats.
+        # The country where the business is incorporated, as an ISO 3166-1 alpha-2 country
+        # code (e.g. US).
         sig { returns(T.nilable(String)) }
         attr_accessor :country_of_incorporation
 
@@ -292,8 +292,8 @@ module ModernTreasury
         sig { returns(T.nilable(String)) }
         attr_accessor :middle_name
 
-        # A list of countries where the business operates (ISO 3166-1 alpha-2 or alpha-3
-        # codes).
+        # A list of countries where the business operates, as ISO 3166-1 alpha-2 country
+        # codes (e.g. ["US", "CA"]).
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :operating_jurisdictions
 
@@ -540,8 +540,8 @@ module ModernTreasury
           # in a value of null to prevent the connection from being associated with the
           # legal entity.
           connection_id: nil,
-          # The country code where the business is incorporated in the ISO 3166-1 alpha-2 or
-          # alpha-3 formats.
+          # The country where the business is incorporated, as an ISO 3166-1 alpha-2 country
+          # code (e.g. US).
           country_of_incorporation: nil,
           # A business's formation date (YYYY-MM-DD).
           date_formed: nil,
@@ -580,8 +580,8 @@ module ModernTreasury
           metadata: nil,
           # An individual's middle name.
           middle_name: nil,
-          # A list of countries where the business operates (ISO 3166-1 alpha-2 or alpha-3
-          # codes).
+          # A list of countries where the business operates, as ISO 3166-1 alpha-2 country
+          # codes (e.g. ["US", "CA"]).
           operating_jurisdictions: nil,
           phone_numbers: nil,
           # Whether the individual is a politically exposed person.
@@ -914,6 +914,9 @@ module ModernTreasury
               )
             end
 
+          # A phone number in E.164 format. This format is strictly validated: include a
+          # leading + and country code, followed by digits only (no spaces or dashes), e.g.
+          # +12025551234.
           sig { returns(T.nilable(String)) }
           attr_reader :phone_number
 
@@ -922,7 +925,12 @@ module ModernTreasury
 
           # A list of phone numbers in E.164 format.
           sig { params(phone_number: String).returns(T.attached_class) }
-          def self.new(phone_number: nil)
+          def self.new(
+            # A phone number in E.164 format. This format is strictly validated: include a
+            # leading + and country code, followed by digits only (no spaces or dashes), e.g.
+            # +12025551234.
+            phone_number: nil
+          )
           end
 
           sig { override.returns({ phone_number: String }) }

data/rbi/modern_treasury/models/counterparty_create_params.rbi

@@ -1153,8 +1153,8 @@ module ModernTreasury
         sig { returns(T.nilable(String)) }
         attr_accessor :connection_id
 
-        # The country code where the business is incorporated in the ISO 3166-1 alpha-2 or
-        # alpha-3 formats.
+        # The country where the business is incorporated, as an ISO 3166-1 alpha-2 country
+        # code (e.g. US).
         sig { returns(T.nilable(String)) }
         attr_accessor :country_of_incorporation
 
@@ -1291,8 +1291,8 @@ module ModernTreasury
         sig { returns(T.nilable(String)) }
         attr_accessor :middle_name
 
-        # A list of countries where the business operates (ISO 3166-1 alpha-2 or alpha-3
-        # codes).
+        # A list of countries where the business operates, as ISO 3166-1 alpha-2 country
+        # codes (e.g. ["US", "CA"]).
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :operating_jurisdictions
 
@@ -1540,8 +1540,8 @@ module ModernTreasury
           # in a value of null to prevent the connection from being associated with the
           # legal entity.
           connection_id: nil,
-          # The country code where the business is incorporated in the ISO 3166-1 alpha-2 or
-          # alpha-3 formats.
+          # The country where the business is incorporated, as an ISO 3166-1 alpha-2 country
+          # code (e.g. US).
           country_of_incorporation: nil,
           # A business's formation date (YYYY-MM-DD).
           date_formed: nil,
@@ -1578,8 +1578,8 @@ module ModernTreasury
           metadata: nil,
           # An individual's middle name.
           middle_name: nil,
-          # A list of countries where the business operates (ISO 3166-1 alpha-2 or alpha-3
-          # codes).
+          # A list of countries where the business operates, as ISO 3166-1 alpha-2 country
+          # codes (e.g. ["US", "CA"]).
           operating_jurisdictions: nil,
           phone_numbers: nil,
           # Whether the individual is a politically exposed person.
@@ -1912,6 +1912,9 @@ module ModernTreasury
               )
             end
 
+          # A phone number in E.164 format. This format is strictly validated: include a
+          # leading + and country code, followed by digits only (no spaces or dashes), e.g.
+          # +12025551234.
           sig { returns(T.nilable(String)) }
           attr_reader :phone_number
 
@@ -1920,7 +1923,12 @@ module ModernTreasury
 
           # A list of phone numbers in E.164 format.
           sig { params(phone_number: String).returns(T.attached_class) }
-          def self.new(phone_number: nil)
+          def self.new(
+            # A phone number in E.164 format. This format is strictly validated: include a
+            # leading + and country code, followed by digits only (no spaces or dashes), e.g.
+            # +12025551234.
+            phone_number: nil
+          )
           end
 
           sig { override.returns({ phone_number: String }) }

data/rbi/modern_treasury/models/identification_create_request.rbi

@@ -319,6 +319,16 @@ module ModernTreasury
             :gr_vat,
             ModernTreasury::IdentificationCreateRequest::IDType::TaggedSymbol
           )
+        HK_BRN =
+          T.let(
+            :hk_brn,
+            ModernTreasury::IdentificationCreateRequest::IDType::TaggedSymbol
+          )
+        HK_HKID =
+          T.let(
+            :hk_hkid,
+            ModernTreasury::IdentificationCreateRequest::IDType::TaggedSymbol
+          )
         HN_ID =
           T.let(
             :hn_id,

data/rbi/modern_treasury/models/internal_account_create_params.rbi

@@ -135,6 +135,28 @@ module ModernTreasury
       sig { returns(T.nilable(String)) }
       attr_accessor :party_name
 
+      # An array of account number types requested for provisioning.
+      sig do
+        returns(
+          T.nilable(
+            T::Array[
+              ModernTreasury::InternalAccountCreateParams::RequestedAccountNumberType::OrSymbol
+            ]
+          )
+        )
+      end
+      attr_reader :requested_account_number_types
+
+      sig do
+        params(
+          requested_account_number_types:
+            T::Array[
+              ModernTreasury::InternalAccountCreateParams::RequestedAccountNumberType::OrSymbol
+            ]
+        ).void
+      end
+      attr_writer :requested_account_number_types
+
       # A hash of vendor specific attributes that will be used when creating the account
       # at the vendor specified by the given connection.
       sig { returns(T.nilable(T::Hash[Symbol, String])) }
@@ -164,6 +186,10 @@ module ModernTreasury
           party_address:
             ModernTreasury::InternalAccountCreateParams::PartyAddress::OrHash,
           party_name: T.nilable(String),
+          requested_account_number_types:
+            T::Array[
+              ModernTreasury::InternalAccountCreateParams::RequestedAccountNumberType::OrSymbol
+            ],
           vendor_attributes: T::Hash[Symbol, String],
           request_options: ModernTreasury::RequestOptions::OrHash
         ).returns(T.attached_class)
@@ -203,6 +229,8 @@ module ModernTreasury
         party_address: nil,
         # The legal name of the entity which owns the account.
         party_name: nil,
+        # An array of account number types requested for provisioning.
+        requested_account_number_types: nil,
         # A hash of vendor specific attributes that will be used when creating the account
         # at the vendor specified by the given connection.
         vendor_attributes: nil,
@@ -232,6 +260,10 @@ module ModernTreasury
             party_address:
               ModernTreasury::InternalAccountCreateParams::PartyAddress,
             party_name: T.nilable(String),
+            requested_account_number_types:
+              T::Array[
+                ModernTreasury::InternalAccountCreateParams::RequestedAccountNumberType::OrSymbol
+              ],
             vendor_attributes: T::Hash[Symbol, String],
             request_options: ModernTreasury::RequestOptions
           }
@@ -653,7 +685,8 @@ module ModernTreasury
         sig { returns(String) }
         attr_accessor :line1
 
-        # Locality or City.
+        # Locality or City. Use the full city name rather than an abbreviation (e.g. San
+        # Francisco).
         sig { returns(String) }
         attr_accessor :locality
 
@@ -661,7 +694,8 @@ module ModernTreasury
         sig { returns(String) }
         attr_accessor :postal_code
 
-        # Region or State.
+        # Region or State. This field is free-form; for US states, we recommend a
+        # two-letter code (e.g. CA). Full state names are also accepted.
         sig { returns(String) }
         attr_accessor :region
 
@@ -686,11 +720,13 @@ module ModernTreasury
           # Country code conforms to [ISO 3166-1 alpha-2]
           country:,
           line1:,
-          # Locality or City.
+          # Locality or City. Use the full city name rather than an abbreviation (e.g. San
+          # Francisco).
           locality:,
           # The postal code of the address.
           postal_code:,
-          # Region or State.
+          # Region or State. This field is free-form; for US states, we recommend a
+          # two-letter code (e.g. CA). Full state names are also accepted.
           region:,
           line2: nil
         )
@@ -711,6 +747,50 @@ module ModernTreasury
         def to_hash
         end
       end
+
+      module RequestedAccountNumberType
+        extend ModernTreasury::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              ModernTreasury::InternalAccountCreateParams::RequestedAccountNumberType
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ETHEREUM_ADDRESS =
+          T.let(
+            :ethereum_address,
+            ModernTreasury::InternalAccountCreateParams::RequestedAccountNumberType::TaggedSymbol
+          )
+        SOLANA_ADDRESS =
+          T.let(
+            :solana_address,
+            ModernTreasury::InternalAccountCreateParams::RequestedAccountNumberType::TaggedSymbol
+          )
+        POLYGON_ADDRESS =
+          T.let(
+            :polygon_address,
+            ModernTreasury::InternalAccountCreateParams::RequestedAccountNumberType::TaggedSymbol
+          )
+        BASE_ADDRESS =
+          T.let(
+            :base_address,
+            ModernTreasury::InternalAccountCreateParams::RequestedAccountNumberType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ModernTreasury::InternalAccountCreateParams::RequestedAccountNumberType::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end

data/rbi/modern_treasury/models/internal_accounts/balance_report_create_params.rbi

@@ -185,6 +185,7 @@ module ModernTreasury
           sig { params(amount_string: String).void }
           attr_writer :amount_string
 
+          # At least one of "amount" or "amount_string" is required.
           sig do
             params(
               balance_type:

data/rbi/modern_treasury/models/invoice.rbi

@@ -445,7 +445,8 @@ module ModernTreasury
         sig { returns(String) }
         attr_accessor :line1
 
-        # Locality or City.
+        # Locality or City. Use the full city name rather than an abbreviation (e.g. San
+        # Francisco).
         sig { returns(String) }
         attr_accessor :locality
 
@@ -453,7 +454,8 @@ module ModernTreasury
         sig { returns(String) }
         attr_accessor :postal_code
 
-        # Region or State.
+        # Region or State. This field is free-form; for US states, we recommend a
+        # two-letter code (e.g. CA). Full state names are also accepted.
         sig { returns(String) }
         attr_accessor :region
 
@@ -478,11 +480,13 @@ module ModernTreasury
           # Country code conforms to [ISO 3166-1 alpha-2]
           country:,
           line1:,
-          # Locality or City.
+          # Locality or City. Use the full city name rather than an abbreviation (e.g. San
+          # Francisco).
           locality:,
           # The postal code of the address.
           postal_code:,
-          # Region or State.
+          # Region or State. This field is free-form; for US states, we recommend a
+          # two-letter code (e.g. CA). Full state names are also accepted.
           region:,
           line2: nil
         )
@@ -520,7 +524,8 @@ module ModernTreasury
         sig { returns(String) }
         attr_accessor :line1
 
-        # Locality or City.
+        # Locality or City. Use the full city name rather than an abbreviation (e.g. San
+        # Francisco).
         sig { returns(String) }
         attr_accessor :locality
 
@@ -528,7 +533,8 @@ module ModernTreasury
         sig { returns(String) }
         attr_accessor :postal_code
 
-        # Region or State.
+        # Region or State. This field is free-form; for US states, we recommend a
+        # two-letter code (e.g. CA). Full state names are also accepted.
         sig { returns(String) }
         attr_accessor :region
 
@@ -553,11 +559,13 @@ module ModernTreasury
           # Country code conforms to [ISO 3166-1 alpha-2]
           country:,
           line1:,
-          # Locality or City.
+          # Locality or City. Use the full city name rather than an abbreviation (e.g. San
+          # Francisco).
           locality:,
           # The postal code of the address.
           postal_code:,
-          # Region or State.
+          # Region or State. This field is free-form; for US states, we recommend a
+          # two-letter code (e.g. CA). Full state names are also accepted.
           region:,
           line2: nil
         )
@@ -595,7 +603,8 @@ module ModernTreasury
         sig { returns(String) }
         attr_accessor :line1
 
-        # Locality or City.
+        # Locality or City. Use the full city name rather than an abbreviation (e.g. San
+        # Francisco).
         sig { returns(String) }
         attr_accessor :locality
 
@@ -603,7 +612,8 @@ module ModernTreasury
         sig { returns(String) }
         attr_accessor :postal_code
 
-        # Region or State.
+        # Region or State. This field is free-form; for US states, we recommend a
+        # two-letter code (e.g. CA). Full state names are also accepted.
         sig { returns(String) }
         attr_accessor :region
 
@@ -628,11 +638,13 @@ module ModernTreasury
           # Country code conforms to [ISO 3166-1 alpha-2]
           country:,
           line1:,
-          # Locality or City.
+          # Locality or City. Use the full city name rather than an abbreviation (e.g. San
+          # Francisco).
           locality:,
           # The postal code of the address.
           postal_code:,
-          # Region or State.
+          # Region or State. This field is free-form; for US states, we recommend a
+          # two-letter code (e.g. CA). Full state names are also accepted.
           region:,
           line2: nil
         )

data/rbi/modern_treasury/models/invoice_create_params.rbi

@@ -401,7 +401,8 @@ module ModernTreasury
         sig { returns(String) }
         attr_accessor :line1
 
-        # Locality or City.
+        # Locality or City. Use the full city name rather than an abbreviation (e.g. San
+        # Francisco).
         sig { returns(String) }
         attr_accessor :locality
 
@@ -409,7 +410,8 @@ module ModernTreasury
         sig { returns(String) }
         attr_accessor :postal_code
 
-        # Region or State.
+        # Region or State. This field is free-form; for US states, we recommend a
+        # two-letter code (e.g. CA). Full state names are also accepted.
         sig { returns(String) }
         attr_accessor :region
 
@@ -434,11 +436,13 @@ module ModernTreasury
           # Country code conforms to [ISO 3166-1 alpha-2]
           country:,
           line1:,
-          # Locality or City.
+          # Locality or City. Use the full city name rather than an abbreviation (e.g. San
+          # Francisco).
           locality:,
           # The postal code of the address.
           postal_code:,
-          # Region or State.
+          # Region or State. This field is free-form; for US states, we recommend a
+          # two-letter code (e.g. CA). Full state names are also accepted.
           region:,
           line2: nil
         )
@@ -476,7 +480,8 @@ module ModernTreasury
         sig { returns(String) }
         attr_accessor :line1
 
-        # Locality or City.
+        # Locality or City. Use the full city name rather than an abbreviation (e.g. San
+        # Francisco).
         sig { returns(String) }
         attr_accessor :locality
 
@@ -484,7 +489,8 @@ module ModernTreasury
         sig { returns(String) }
         attr_accessor :postal_code
 
-        # Region or State.
+        # Region or State. This field is free-form; for US states, we recommend a
+        # two-letter code (e.g. CA). Full state names are also accepted.
         sig { returns(String) }
         attr_accessor :region
 
@@ -509,11 +515,13 @@ module ModernTreasury
           # Country code conforms to [ISO 3166-1 alpha-2]
           country:,
           line1:,
-          # Locality or City.
+          # Locality or City. Use the full city name rather than an abbreviation (e.g. San
+          # Francisco).
           locality:,
           # The postal code of the address.
           postal_code:,
-          # Region or State.
+          # Region or State. This field is free-form; for US states, we recommend a
+          # two-letter code (e.g. CA). Full state names are also accepted.
           region:,
           line2: nil
         )
@@ -663,7 +671,8 @@ module ModernTreasury
         sig { returns(String) }
         attr_accessor :line1
 
-        # Locality or City.
+        # Locality or City. Use the full city name rather than an abbreviation (e.g. San
+        # Francisco).
         sig { returns(String) }
         attr_accessor :locality
 
@@ -671,7 +680,8 @@ module ModernTreasury
         sig { returns(String) }
         attr_accessor :postal_code
 
-        # Region or State.
+        # Region or State. This field is free-form; for US states, we recommend a
+        # two-letter code (e.g. CA). Full state names are also accepted.
         sig { returns(String) }
         attr_accessor :region
 
@@ -696,11 +706,13 @@ module ModernTreasury
           # Country code conforms to [ISO 3166-1 alpha-2]
           country:,
           line1:,
-          # Locality or City.
+          # Locality or City. Use the full city name rather than an abbreviation (e.g. San
+          # Francisco).
           locality:,
           # The postal code of the address.
           postal_code:,
-          # Region or State.
+          # Region or State. This field is free-form; for US states, we recommend a
+          # two-letter code (e.g. CA). Full state names are also accepted.
           region:,
           line2: nil
         )

data/rbi/modern_treasury/models/invoice_update_params.rbi

@@ -419,7 +419,8 @@ module ModernTreasury
         sig { returns(String) }
         attr_accessor :line1
 
-        # Locality or City.
+        # Locality or City. Use the full city name rather than an abbreviation (e.g. San
+        # Francisco).
         sig { returns(String) }
         attr_accessor :locality
 
@@ -427,7 +428,8 @@ module ModernTreasury
         sig { returns(String) }
         attr_accessor :postal_code
 
-        # Region or State.
+        # Region or State. This field is free-form; for US states, we recommend a
+        # two-letter code (e.g. CA). Full state names are also accepted.
         sig { returns(String) }
         attr_accessor :region
 
@@ -452,11 +454,13 @@ module ModernTreasury
           # Country code conforms to [ISO 3166-1 alpha-2]
           country:,
           line1:,
-          # Locality or City.
+          # Locality or City. Use the full city name rather than an abbreviation (e.g. San
+          # Francisco).
           locality:,
           # The postal code of the address.
           postal_code:,
-          # Region or State.
+          # Region or State. This field is free-form; for US states, we recommend a
+          # two-letter code (e.g. CA). Full state names are also accepted.
           region:,
           line2: nil
         )
@@ -494,7 +498,8 @@ module ModernTreasury
         sig { returns(String) }
         attr_accessor :line1
 
-        # Locality or City.
+        # Locality or City. Use the full city name rather than an abbreviation (e.g. San
+        # Francisco).
         sig { returns(String) }
         attr_accessor :locality
 
@@ -502,7 +507,8 @@ module ModernTreasury
         sig { returns(String) }
         attr_accessor :postal_code
 
-        # Region or State.
+        # Region or State. This field is free-form; for US states, we recommend a
+        # two-letter code (e.g. CA). Full state names are also accepted.
         sig { returns(String) }
         attr_accessor :region
 
@@ -527,11 +533,13 @@ module ModernTreasury
           # Country code conforms to [ISO 3166-1 alpha-2]
           country:,
           line1:,
-          # Locality or City.
+          # Locality or City. Use the full city name rather than an abbreviation (e.g. San
+          # Francisco).
           locality:,
           # The postal code of the address.
           postal_code:,
-          # Region or State.
+          # Region or State. This field is free-form; for US states, we recommend a
+          # two-letter code (e.g. CA). Full state names are also accepted.
           region:,
           line2: nil
         )
@@ -681,7 +689,8 @@ module ModernTreasury
         sig { returns(String) }
         attr_accessor :line1
 
-        # Locality or City.
+        # Locality or City. Use the full city name rather than an abbreviation (e.g. San
+        # Francisco).
         sig { returns(String) }
         attr_accessor :locality
 
@@ -689,7 +698,8 @@ module ModernTreasury
         sig { returns(String) }
         attr_accessor :postal_code
 
-        # Region or State.
+        # Region or State. This field is free-form; for US states, we recommend a
+        # two-letter code (e.g. CA). Full state names are also accepted.
         sig { returns(String) }
         attr_accessor :region
 
@@ -714,11 +724,13 @@ module ModernTreasury
           # Country code conforms to [ISO 3166-1 alpha-2]
           country:,
           line1:,
-          # Locality or City.
+          # Locality or City. Use the full city name rather than an abbreviation (e.g. San
+          # Francisco).
           locality:,
           # The postal code of the address.
           postal_code:,
-          # Region or State.
+          # Region or State. This field is free-form; for US states, we recommend a
+          # two-letter code (e.g. CA). Full state names are also accepted.
           region:,
           line2: nil
         )

data/rbi/modern_treasury/models/ledger_entry_create_request.rbi

@@ -84,6 +84,7 @@ module ModernTreasury
       sig { returns(T.nilable(T::Boolean)) }
       attr_accessor :show_resulting_ledger_account_balances
 
+      # At least one of "amount" or "amount_string" is required.
       sig do
         params(
           direction: ModernTreasury::TransactionDirection::OrSymbol,

data/rbi/modern_treasury/models/ledger_transaction_create_partial_post_params.rbi

@@ -181,6 +181,7 @@ module ModernTreasury
         sig { returns(T.nilable(T::Boolean)) }
         attr_accessor :show_resulting_ledger_account_balances
 
+        # At least one of "amount" or "amount_string" is required.
         sig do
           params(
             direction: