modern_treasury 0.28.0 → 0.29.0

data/rbi/modern_treasury/models/legal_entity.rbi

@@ -41,8 +41,8 @@ module ModernTreasury
       sig { returns(T.nilable(T.anything)) }
       attr_accessor :compliance_details
 
-      # 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
 
@@ -135,8 +135,8 @@ module ModernTreasury
       sig { returns(String) }
       attr_accessor :object
 
-      # 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::Array[String]) }
       attr_accessor :operating_jurisdictions
 
@@ -325,8 +325,8 @@ module ModernTreasury
         # The country of citizenship for an individual.
         citizenship_country:,
         compliance_details:,
-        # 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:,
         created_at:,
         # A business's formation date (YYYY-MM-DD).
@@ -367,8 +367,8 @@ module ModernTreasury
         # An individual's middle name.
         middle_name:,
         object:,
-        # 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:,
         phone_numbers:,
         # Whether the individual is a politically exposed person.
@@ -520,7 +520,8 @@ module ModernTreasury
         sig { returns(T::Boolean) }
         attr_accessor :live_mode
 
-        # Locality or City.
+        # Locality or City. Use the full city name rather than an abbreviation (e.g. San
+        # Francisco).
         sig { returns(T.nilable(String)) }
         attr_accessor :locality
 
@@ -536,7 +537,8 @@ module ModernTreasury
         sig { returns(T.nilable(T::Boolean)) }
         attr_accessor :primary
 
-        # 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(T.nilable(String)) }
         attr_accessor :region
 
@@ -577,7 +579,8 @@ module ModernTreasury
           # This field will be true if this object exists in the live environment or false
           # if it exists in the test environment.
           live_mode:,
-          # Locality or City.
+          # Locality or City. Use the full city name rather than an abbreviation (e.g. San
+          # Francisco).
           locality:,
           object:,
           # The postal code of the address.
@@ -585,7 +588,8 @@ module ModernTreasury
           # Whether this address is the primary address for the legal entity. Optional; when
           # omitted it is inferred from the address types.
           primary:,
-          # 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:,
           updated_at:
         )
@@ -1003,6 +1007,16 @@ module ModernTreasury
               :gr_vat,
               ModernTreasury::LegalEntity::Identification::IDType::TaggedSymbol
             )
+          HK_BRN =
+            T.let(
+              :hk_brn,
+              ModernTreasury::LegalEntity::Identification::IDType::TaggedSymbol
+            )
+          HK_HKID =
+            T.let(
+              :hk_hkid,
+              ModernTreasury::LegalEntity::Identification::IDType::TaggedSymbol
+            )
           HN_ID =
             T.let(
               :hn_id,
@@ -1392,6 +1406,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
 
@@ -1400,7 +1417,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/legal_entity_address_create_request.rbi

@@ -18,7 +18,8 @@ module ModernTreasury
       sig { returns(T.nilable(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(T.nilable(String)) }
       attr_accessor :locality
 
@@ -26,7 +27,8 @@ module ModernTreasury
       sig { returns(T.nilable(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(T.nilable(String)) }
       attr_accessor :region
 
@@ -79,11 +81,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:,
         # The types of this address.
         address_types: nil,

data/rbi/modern_treasury/models/legal_entity_create_params.rbi

@@ -72,8 +72,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
 
@@ -200,8 +200,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
 
@@ -436,8 +436,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,
@@ -474,8 +474,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.
@@ -802,6 +802,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
 
@@ -810,7 +813,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/legal_entity_update_params.rbi

@@ -56,8 +56,8 @@ module ModernTreasury
       sig { returns(T.nilable(String)) }
       attr_accessor :citizenship_country
 
-      # 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
 
@@ -157,8 +157,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
 
@@ -374,8 +374,8 @@ module ModernTreasury
         business_name: nil,
         # The country of citizenship for an individual.
         citizenship_country: 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,
@@ -407,8 +407,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.
@@ -571,6 +571,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
 
@@ -579,7 +582,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/legal_entity_wealth_employment_detail.rbi

@@ -32,7 +32,8 @@ module ModernTreasury
       sig { returns(T.nilable(String)) }
       attr_accessor :employer_name
 
-      # The state in which the employer is located.
+      # The state in which the employer is located. This field is free-form text; for US
+      # states, we recommend a two-letter abbreviation (e.g. CA).
       sig { returns(T.nilable(String)) }
       attr_accessor :employer_state
 
@@ -165,7 +166,8 @@ module ModernTreasury
         employer_country:,
         # The name of the employer.
         employer_name:,
-        # The state in which the employer is located.
+        # The state in which the employer is located. This field is free-form text; for US
+        # states, we recommend a two-letter abbreviation (e.g. CA).
         employer_state:,
         # The employment status of the individual.
         employment_status:,

data/rbi/modern_treasury/models/payment_order_create_async_params.rbi

@@ -371,10 +371,10 @@ module ModernTreasury
 
       # Additional vendor specific fields for this payment. Data must be represented as
       # key-value pairs.
-      sig { returns(T.nilable(T.anything)) }
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
       attr_reader :vendor_attributes
 
-      sig { params(vendor_attributes: T.anything).void }
+      sig { params(vendor_attributes: T::Hash[Symbol, T.anything]).void }
       attr_writer :vendor_attributes
 
       sig do
@@ -437,7 +437,7 @@ module ModernTreasury
           ultimate_originating_party_name: T.nilable(String),
           ultimate_receiving_party_identifier: T.nilable(String),
           ultimate_receiving_party_name: T.nilable(String),
-          vendor_attributes: T.anything,
+          vendor_attributes: T::Hash[Symbol, T.anything],
           request_options: ModernTreasury::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -636,7 +636,7 @@ module ModernTreasury
             ultimate_originating_party_name: T.nilable(String),
             ultimate_receiving_party_identifier: T.nilable(String),
             ultimate_receiving_party_name: T.nilable(String),
-            vendor_attributes: T.anything,
+            vendor_attributes: T::Hash[Symbol, T.anything],
             request_options: ModernTreasury::RequestOptions
           }
         )
@@ -1781,7 +1781,8 @@ module ModernTreasury
         sig { params(line2: String).void }
         attr_writer :line2
 
-        # Locality or City.
+        # Locality or City. Use the full city name rather than an abbreviation (e.g. San
+        # Francisco).
         sig { returns(T.nilable(String)) }
         attr_reader :locality
 
@@ -1795,7 +1796,8 @@ module ModernTreasury
         sig { params(postal_code: String).void }
         attr_writer :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(T.nilable(String)) }
         attr_reader :region
 
@@ -1818,11 +1820,13 @@ module ModernTreasury
           country: nil,
           line1: nil,
           line2: nil,
-          # Locality or City.
+          # Locality or City. Use the full city name rather than an abbreviation (e.g. San
+          # Francisco).
           locality: nil,
           # The postal code of the address.
           postal_code: nil,
-          # 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: nil
         )
         end

data/rbi/modern_treasury/models/payment_order_create_params.rbi

@@ -381,10 +381,10 @@ module ModernTreasury
 
       # Additional vendor specific fields for this payment. Data must be represented as
       # key-value pairs.
-      sig { returns(T.nilable(T.anything)) }
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
       attr_reader :vendor_attributes
 
-      sig { params(vendor_attributes: T.anything).void }
+      sig { params(vendor_attributes: T::Hash[Symbol, T.anything]).void }
       attr_writer :vendor_attributes
 
       sig do
@@ -451,7 +451,7 @@ module ModernTreasury
           ultimate_originating_party_name: T.nilable(String),
           ultimate_receiving_party_identifier: T.nilable(String),
           ultimate_receiving_party_name: T.nilable(String),
-          vendor_attributes: T.anything,
+          vendor_attributes: T::Hash[Symbol, T.anything],
           request_options: ModernTreasury::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -654,7 +654,7 @@ module ModernTreasury
             ultimate_originating_party_name: T.nilable(String),
             ultimate_receiving_party_identifier: T.nilable(String),
             ultimate_receiving_party_name: T.nilable(String),
-            vendor_attributes: T.anything,
+            vendor_attributes: T::Hash[Symbol, T.anything],
             request_options: ModernTreasury::RequestOptions
           }
         )
@@ -1949,7 +1949,8 @@ module ModernTreasury
         sig { params(line2: String).void }
         attr_writer :line2
 
-        # Locality or City.
+        # Locality or City. Use the full city name rather than an abbreviation (e.g. San
+        # Francisco).
         sig { returns(T.nilable(String)) }
         attr_reader :locality
 
@@ -1963,7 +1964,8 @@ module ModernTreasury
         sig { params(postal_code: String).void }
         attr_writer :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(T.nilable(String)) }
         attr_reader :region
 
@@ -1986,11 +1988,13 @@ module ModernTreasury
           country: nil,
           line1: nil,
           line2: nil,
-          # Locality or City.
+          # Locality or City. Use the full city name rather than an abbreviation (e.g. San
+          # Francisco).
           locality: nil,
           # The postal code of the address.
           postal_code: nil,
-          # 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: nil
         )
         end

data/rbi/modern_treasury/models/wealth_and_employment_details.rbi

@@ -32,7 +32,8 @@ module ModernTreasury
       sig { returns(T.nilable(String)) }
       attr_accessor :employer_name
 
-      # The state in which the employer is located.
+      # The state in which the employer is located. This field is free-form text; for US
+      # states, we recommend a two-letter abbreviation (e.g. CA).
       sig { returns(T.nilable(String)) }
       attr_accessor :employer_state
 
@@ -165,7 +166,8 @@ module ModernTreasury
         employer_country:,
         # The name of the employer.
         employer_name:,
-        # The state in which the employer is located.
+        # The state in which the employer is located. This field is free-form text; for US
+        # states, we recommend a two-letter abbreviation (e.g. CA).
         employer_state:,
         # The employment status of the individual.
         employment_status:,

data/rbi/modern_treasury/models.rbi

@@ -401,9 +401,6 @@ module ModernTreasury
 
   LegalEntityUpdateParams = ModernTreasury::Models::LegalEntityUpdateParams
 
-  LegalEntityUpdateStatusParams =
-    ModernTreasury::Models::LegalEntityUpdateStatusParams
-
   LegalEntityWealthEmploymentDetail =
     ModernTreasury::Models::LegalEntityWealthEmploymentDetail
 

data/rbi/modern_treasury/resources/bulk_requests.rbi

@@ -17,7 +17,7 @@ module ModernTreasury
                 ModernTreasury::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::OrHash,
                 ModernTreasury::LedgerTransactionCreateRequest::OrHash,
                 ModernTreasury::LedgerAccountCreateRequest::OrHash,
-                T.anything,
+                ModernTreasury::BulkRequestCreateParams::Resource::TransactionCreateRequest::OrHash,
                 ModernTreasury::BulkRequestCreateParams::Resource::ID::OrHash,
                 ModernTreasury::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::OrHash,
                 ModernTreasury::BulkRequestCreateParams::Resource::ExpectedPaymentUpdateRequestWithID::OrHash,

data/rbi/modern_treasury/resources/internal_accounts.rbi

@@ -30,6 +30,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(ModernTreasury::InternalAccount)
@@ -69,6 +73,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,

data/rbi/modern_treasury/resources/legal_entities.rbi

@@ -3,7 +3,7 @@
 module ModernTreasury
   module Resources
     class LegalEntities
-      # create legal_entity
+      # Create a legal entity. All country fields use ISO 3166-1 alpha-2 (e.g. US).
       sig do
         params(
           legal_entity_type:
@@ -103,8 +103,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,
@@ -141,8 +141,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.
@@ -272,8 +272,8 @@ module ModernTreasury
         business_name: nil,
         # The country of citizenship for an individual.
         citizenship_country: 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,
@@ -305,8 +305,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.
@@ -370,25 +370,6 @@ module ModernTreasury
       )
       end
 
-      # Update Legal Entity Status (sandbox only)
-      sig do
-        params(
-          id: String,
-          status:
-            ModernTreasury::LegalEntityUpdateStatusParams::Status::OrSymbol,
-          request_options: ModernTreasury::RequestOptions::OrHash
-        ).returns(ModernTreasury::LegalEntity)
-      end
-      def update_status(
-        # Legal entity ID
-        id,
-        # The target status for the legal entity. One of `active`, `suspended`, or
-        # `denied`. Valid transitions depend on the current status.
-        status:,
-        request_options: {}
-      )
-      end
-
       # @api private
       sig { params(client: ModernTreasury::Client).returns(T.attached_class) }
       def self.new(client:)

data/rbi/modern_treasury/resources/payment_orders.rbi

@@ -71,7 +71,7 @@ module ModernTreasury
           ultimate_originating_party_name: T.nilable(String),
           ultimate_receiving_party_identifier: T.nilable(String),
           ultimate_receiving_party_name: T.nilable(String),
-          vendor_attributes: T.anything,
+          vendor_attributes: T::Hash[Symbol, T.anything],
           request_options: ModernTreasury::RequestOptions::OrHash
         ).returns(ModernTreasury::PaymentOrder)
       end
@@ -536,7 +536,7 @@ module ModernTreasury
           ultimate_originating_party_name: T.nilable(String),
           ultimate_receiving_party_identifier: T.nilable(String),
           ultimate_receiving_party_name: T.nilable(String),
-          vendor_attributes: T.anything,
+          vendor_attributes: T::Hash[Symbol, T.anything],
           request_options: ModernTreasury::RequestOptions::OrHash
         ).returns(ModernTreasury::AsyncResponse)
       end