modern_treasury 0.27.0 → 0.29.0

data/lib/modern_treasury/models/ledger_transaction_create_partial_post_params.rb

@@ -60,13 +60,6 @@ module ModernTreasury
       #   @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
 
       class PostedLedgerEntry < ModernTreasury::Internal::Type::BaseModel
-        # @!attribute amount
-        #   Value in specified currency's smallest unit. e.g. $10 would be represented
-        #   as 1000. Can be any integer up to 36 digits.
-        #
-        #   @return [Integer]
-        required :amount, Integer
-
         # @!attribute direction
         #   One of `credit`, `debit`. Describes the direction money is flowing in the
         #   transaction. A `credit` moves money from your account to someone else's. A
@@ -83,6 +76,37 @@ module ModernTreasury
         #   @return [String]
         required :ledger_account_id, String
 
+        # @!attribute amount
+        #   Value in specified currency's smallest unit. e.g. $10 would be represented
+        #   as 1000. Can be any integer up to 36 digits.
+        #
+        #   @return [Integer, nil]
+        optional :amount, Integer
+
+        # @!attribute amount_string
+        #   The amount of the ledger entry as a string, preserving full precision for values
+        #   that may exceed safe integer limits in some languages.
+        #
+        #   @return [String, nil]
+        optional :amount_string, String
+
+        # @!attribute available_balance_amount
+        #   Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
+        #   account’s available balance. If any of these conditions would be false after the
+        #   transaction is created, the entire call will fail with error code 422.
+        #
+        #   @return [Hash{Symbol=>Integer}, nil]
+        optional :available_balance_amount, ModernTreasury::Internal::Type::HashOf[Integer], nil?: true
+
+        # @!attribute lock_version
+        #   Lock version of the ledger account. This can be passed when creating a ledger
+        #   transaction to only succeed if no ledger transactions have posted since the
+        #   given version. See our post about Designing the Ledgers API with Optimistic
+        #   Locking for more details.
+        #
+        #   @return [Integer, nil]
+        optional :lock_version, Integer, nil?: true
+
         # @!attribute metadata
         #   Additional data represented as key-value pairs. Both the key and value must be
         #   strings.
@@ -90,18 +114,55 @@ module ModernTreasury
         #   @return [Hash{Symbol=>String}, nil]
         optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
 
-        # @!method initialize(amount:, direction:, ledger_account_id:, metadata: nil)
+        # @!attribute pending_balance_amount
+        #   Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
+        #   account’s pending balance. If any of these conditions would be false after the
+        #   transaction is created, the entire call will fail with error code 422.
+        #
+        #   @return [Hash{Symbol=>Integer}, nil]
+        optional :pending_balance_amount, ModernTreasury::Internal::Type::HashOf[Integer], nil?: true
+
+        # @!attribute posted_balance_amount
+        #   Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
+        #   account’s posted balance. If any of these conditions would be false after the
+        #   transaction is created, the entire call will fail with error code 422.
+        #
+        #   @return [Hash{Symbol=>Integer}, nil]
+        optional :posted_balance_amount, ModernTreasury::Internal::Type::HashOf[Integer], nil?: true
+
+        # @!attribute show_resulting_ledger_account_balances
+        #   If true, response will include the balance of the associated ledger account for
+        #   the entry.
+        #
+        #   @return [Boolean, nil]
+        optional :show_resulting_ledger_account_balances, ModernTreasury::Internal::Type::Boolean, nil?: true
+
+        # @!method initialize(direction:, ledger_account_id:, amount: nil, amount_string: nil, available_balance_amount: nil, lock_version: nil, metadata: nil, pending_balance_amount: nil, posted_balance_amount: nil, show_resulting_ledger_account_balances: nil)
         #   Some parameter documentations has been truncated, see
         #   {ModernTreasury::Models::LedgerTransactionCreatePartialPostParams::PostedLedgerEntry}
         #   for more details.
         #
-        #   @param amount [Integer] Value in specified currency's smallest unit. e.g. $10 would be represented as 10
+        #   At least one of "amount" or "amount_string" is required.
         #
         #   @param direction [Symbol, ModernTreasury::Models::LedgerTransactionCreatePartialPostParams::PostedLedgerEntry::Direction] One of `credit`, `debit`. Describes the direction money is flowing in the transa
         #
         #   @param ledger_account_id [String] The ledger account that this ledger entry is associated with.
         #
+        #   @param amount [Integer] Value in specified currency's smallest unit. e.g. $10 would be represented as 10
+        #
+        #   @param amount_string [String] The amount of the ledger entry as a string, preserving full precision for values
+        #
+        #   @param available_balance_amount [Hash{Symbol=>Integer}, nil] Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the accou
+        #
+        #   @param lock_version [Integer, nil] Lock version of the ledger account. This can be passed when creating a ledger tr
+        #
         #   @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
+        #
+        #   @param pending_balance_amount [Hash{Symbol=>Integer}, nil] Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the accou
+        #
+        #   @param posted_balance_amount [Hash{Symbol=>Integer}, nil] Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the accou
+        #
+        #   @param show_resulting_ledger_account_balances [Boolean, nil] If true, response will include the balance of the associated ledger account for
 
         # One of `credit`, `debit`. Describes the direction money is flowing in the
         # transaction. A `credit` moves money from your account to someone else's. A

data/lib/modern_treasury/models/ledger_transactions/ledger_transaction_version.rb

@@ -204,6 +204,13 @@ module ModernTreasury
           #   @return [Integer]
           required :amount, Integer
 
+          # @!attribute amount_string
+          #   The amount of the ledger entry as a string, preserving full precision for values
+          #   that may exceed safe integer limits in some languages.
+          #
+          #   @return [String]
+          required :amount_string, String
+
           # @!attribute created_at
           #
           #   @return [Time]
@@ -297,7 +304,7 @@ module ModernTreasury
           required :status,
                    enum: -> { ModernTreasury::LedgerTransactions::LedgerTransactionVersion::LedgerEntry::Status }
 
-          # @!method initialize(id:, amount:, created_at:, direction:, effective_at:, ledger_account_currency:, ledger_account_currency_exponent:, ledger_account_id:, ledger_account_lock_version:, ledger_transaction_id:, live_mode:, metadata:, object:, resulting_ledger_account_balances:, status:)
+          # @!method initialize(id:, amount:, amount_string:, created_at:, direction:, effective_at:, ledger_account_currency:, ledger_account_currency_exponent:, ledger_account_id:, ledger_account_lock_version:, ledger_transaction_id:, live_mode:, metadata:, object:, resulting_ledger_account_balances:, status:)
           #   Some parameter documentations has been truncated, see
           #   {ModernTreasury::Models::LedgerTransactions::LedgerTransactionVersion::LedgerEntry}
           #   for more details.
@@ -306,6 +313,8 @@ module ModernTreasury
           #
           #   @param amount [Integer] Value in specified currency's smallest unit. e.g. $10 would be represented as 10
           #
+          #   @param amount_string [String] The amount of the ledger entry as a string, preserving full precision for values
+          #
           #   @param created_at [Time]
           #
           #   @param direction [Symbol, ModernTreasury::Models::TransactionDirection] One of `credit`, `debit`. Describes the direction money is flowing in the transa

data/lib/modern_treasury/models/legal_entity.rb

@@ -45,8 +45,8 @@ module ModernTreasury
       required :compliance_details, ModernTreasury::Internal::Type::Unknown, nil?: true
 
       # @!attribute country_of_incorporation
-      #   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).
       #
       #   @return [String, nil]
       required :country_of_incorporation, String, nil?: true
@@ -177,8 +177,8 @@ module ModernTreasury
       required :object, String
 
       # @!attribute operating_jurisdictions
-      #   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"]).
       #
       #   @return [Array<String>]
       required :operating_jurisdictions, ModernTreasury::Internal::Type::ArrayOf[String]
@@ -246,6 +246,12 @@ module ModernTreasury
       #   @return [String, nil]
       required :suffix, String, nil?: true
 
+      # @!attribute terms_of_use
+      #   Acceptance of terms of use by the legal entity.
+      #
+      #   @return [ModernTreasury::Models::LegalEntity::TermsOfUse, nil]
+      required :terms_of_use, -> { ModernTreasury::LegalEntity::TermsOfUse }, nil?: true
+
       # @!attribute third_party_verification
       #   @deprecated
       #
@@ -293,7 +299,7 @@ module ModernTreasury
                -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::LegalEntityAssociation] },
                nil?: true
 
-      # @!method initialize(id:, addresses:, bank_settings:, business_description:, business_name:, citizenship_country:, compliance_details:, country_of_incorporation:, created_at:, date_formed:, date_of_birth:, discarded_at:, documents:, doing_business_as_names:, email:, expected_activity_volume:, external_id:, first_name:, identifications:, industry_classifications:, intended_use:, last_name:, legal_entity_type:, legal_structure:, listed_exchange:, live_mode:, metadata:, middle_name:, object:, operating_jurisdictions:, phone_numbers:, politically_exposed_person:, preferred_name:, prefix:, primary_social_media_sites:, regulators:, risk_rating:, service_provider_legal_entity_id:, status:, suffix:, third_party_verification:, third_party_verifications:, ticker_symbol:, updated_at:, wealth_and_employment_details:, website:, legal_entity_associations: nil)
+      # @!method initialize(id:, addresses:, bank_settings:, business_description:, business_name:, citizenship_country:, compliance_details:, country_of_incorporation:, created_at:, date_formed:, date_of_birth:, discarded_at:, documents:, doing_business_as_names:, email:, expected_activity_volume:, external_id:, first_name:, identifications:, industry_classifications:, intended_use:, last_name:, legal_entity_type:, legal_structure:, listed_exchange:, live_mode:, metadata:, middle_name:, object:, operating_jurisdictions:, phone_numbers:, politically_exposed_person:, preferred_name:, prefix:, primary_social_media_sites:, regulators:, risk_rating:, service_provider_legal_entity_id:, status:, suffix:, terms_of_use:, third_party_verification:, third_party_verifications:, ticker_symbol:, updated_at:, wealth_and_employment_details:, website:, legal_entity_associations: nil)
       #   Some parameter documentations has been truncated, see
       #   {ModernTreasury::Models::LegalEntity} for more details.
       #
@@ -311,7 +317,7 @@ module ModernTreasury
       #
       #   @param compliance_details [Object, nil]
       #
-      #   @param country_of_incorporation [String, nil] The country code where the business is incorporated in the ISO 3166-1 alpha-2 or
+      #   @param country_of_incorporation [String, nil] The country where the business is incorporated, as an ISO 3166-1 alpha-2 country
       #
       #   @param created_at [Time]
       #
@@ -355,7 +361,7 @@ module ModernTreasury
       #
       #   @param object [String]
       #
-      #   @param operating_jurisdictions [Array<String>] A list of countries where the business operates (ISO 3166-1 alpha-2 or alpha-3 c
+      #   @param operating_jurisdictions [Array<String>] A list of countries where the business operates, as ISO 3166-1 alpha-2 country c
       #
       #   @param phone_numbers [Array<ModernTreasury::Models::LegalEntity::PhoneNumber>]
       #
@@ -377,6 +383,8 @@ module ModernTreasury
       #
       #   @param suffix [String, nil] An individual's suffix.
       #
+      #   @param terms_of_use [ModernTreasury::Models::LegalEntity::TermsOfUse, nil] Acceptance of terms of use by the legal entity.
+      #
       #   @param third_party_verification [ModernTreasury::Models::ThirdPartyVerification, nil] Deprecated. Use `third_party_verifications` instead.
       #
       #   @param third_party_verifications [Array<ModernTreasury::Models::ThirdPartyVerification>] A list of third-party verifications run by external vendors.
@@ -438,7 +446,8 @@ module ModernTreasury
         required :live_mode, ModernTreasury::Internal::Type::Boolean
 
         # @!attribute locality
-        #   Locality or City.
+        #   Locality or City. Use the full city name rather than an abbreviation (e.g. San
+        #   Francisco).
         #
         #   @return [String, nil]
         required :locality, String, nil?: true
@@ -454,8 +463,16 @@ module ModernTreasury
         #   @return [String, nil]
         required :postal_code, String, nil?: true
 
+        # @!attribute primary
+        #   Whether this address is the primary address for the legal entity. Optional; when
+        #   omitted it is inferred from the address types.
+        #
+        #   @return [Boolean, nil]
+        required :primary, ModernTreasury::Internal::Type::Boolean, nil?: true
+
         # @!attribute region
-        #   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.
         #
         #   @return [String, nil]
         required :region, String, nil?: true
@@ -465,7 +482,7 @@ module ModernTreasury
         #   @return [Time]
         required :updated_at, Time
 
-        # @!method initialize(id:, address_types:, country:, created_at:, discarded_at:, line1:, line2:, live_mode:, locality:, object:, postal_code:, region:, updated_at:)
+        # @!method initialize(id:, address_types:, country:, created_at:, discarded_at:, line1:, line2:, live_mode:, locality:, object:, postal_code:, primary:, region:, updated_at:)
         #   Some parameter documentations has been truncated, see
         #   {ModernTreasury::Models::LegalEntity::Address} for more details.
         #
@@ -485,13 +502,15 @@ module ModernTreasury
         #
         #   @param live_mode [Boolean] This field will be true if this object exists in the live environment or false i
         #
-        #   @param locality [String, nil] Locality or City.
+        #   @param locality [String, nil] Locality or City. Use the full city name rather than an abbreviation (e.g. San F
         #
         #   @param object [String]
         #
         #   @param postal_code [String, nil] The postal code of the address.
         #
-        #   @param region [String, nil] Region or State.
+        #   @param primary [Boolean, nil] Whether this address is the primary address for the legal entity. Optional; when
+        #
+        #   @param region [String, nil] Region or State. This field is free-form; for US states, we recommend a two-lett
         #
         #   @param updated_at [Time]
 
@@ -499,6 +518,7 @@ module ModernTreasury
           extend ModernTreasury::Internal::Type::Enum
 
           BUSINESS = :business
+          BUSINESS_PHYSICAL = :business_physical
           BUSINESS_REGISTERED = :business_registered
           MAILING = :mailing
           OTHER = :other
@@ -608,27 +628,104 @@ module ModernTreasury
 
           AR_CUIL = :ar_cuil
           AR_CUIT = :ar_cuit
+          AT_ATIN = :at_atin
+          AT_VAT = :at_vat
+          AU_ABN = :au_abn
+          AU_TFN = :au_tfn
+          BE_ENT = :be_ent
+          BE_NRN = :be_nrn
           BR_CNPJ = :br_cnpj
           BR_CPF = :br_cpf
+          CA_BN = :ca_bn
           CA_SIN = :ca_sin
+          CH_AHV = :ch_ahv
+          CH_UID = :ch_uid
           CL_RUN = :cl_run
           CL_RUT = :cl_rut
           CO_CEDULAS = :co_cedulas
           CO_NIT = :co_nit
+          CY_TIN = :cy_tin
+          CZ_ICO = :cz_ico
+          CZ_RC = :cz_rc
+          DE_STID = :de_stid
+          DE_STNR = :de_stnr
+          DE_VAT = :de_vat
+          DK_CPR = :dk_cpr
+          DK_CVR = :dk_cvr
           DRIVERS_LICENSE = :drivers_license
+          EE_IK = :ee_ik
+          EE_RK = :ee_rk
+          ES_NIE = :es_nie
+          ES_NIF = :es_nif
+          FI_HETU = :fi_hetu
+          FI_YTJ = :fi_ytj
+          FR_NIF = :fr_nif
+          FR_SIREN = :fr_siren
+          FR_VAT = :fr_vat
+          GB_NINO = :gb_nino
+          GB_UTR = :gb_utr
+          GB_VAT = :gb_vat
+          GENERIC_INTERNATIONAL = :generic_international
+          GR_VAT = :gr_vat
+          HK_BRN = :hk_brn
+          HK_HKID = :hk_hkid
           HN_ID = :hn_id
           HN_RTN = :hn_rtn
+          HR_OIB = :hr_oib
+          HU_ADJ = :hu_adj
+          HU_ANUM = :hu_anum
           IE_PPS = :ie_pps
+          IE_TRN = :ie_trn
           IN_LEI = :in_lei
+          IS_KNT = :is_knt
+          IT_CF = :it_cf
+          IT_PIVA = :it_piva
+          JP_HB = :jp_hb
+          JP_MN = :jp_mn
           KR_BRN = :kr_brn
           KR_CRN = :kr_crn
           KR_RRN = :kr_rrn
+          LI_PEID = :li_peid
+          LT_AK = :lt_ak
+          LT_JAK = :lt_jak
+          LU_MTC = :lu_mtc
+          LU_VAT = :lu_vat
+          LV_PK = :lv_pk
+          LV_RN = :lv_rn
+          MT_TIN = :mt_tin
+          MT_VAT = :mt_vat
+          MX_CURP = :mx_curp
+          MX_INE = :mx_ine
+          MX_RFC = :mx_rfc
+          NATIONAL_ID = :national_id
+          NL_BSN = :nl_bsn
+          NL_BTW = :nl_btw
+          NL_RSIN = :nl_rsin
+          NO_FDN = :no_fdn
+          NO_MVA = :no_mva
+          NO_ORGNR = :no_orgnr
+          NZ_IRD = :nz_ird
           PASSPORT = :passport
+          PL_NIP = :pl_nip
+          PL_PESEL = :pl_pesel
+          PT_NIF = :pt_nif
+          RO_CNP = :ro_cnp
+          RO_CUI = :ro_cui
           SA_TIN = :sa_tin
           SA_VAT = :sa_vat
+          SE_ORGNR = :se_orgnr
+          SE_PNMR = :se_pnmr
+          SG_FIN = :sg_fin
+          SG_NRIC = :sg_nric
+          SG_UEN = :sg_uen
+          SI_DAV = :si_dav
+          SI_TIN = :si_tin
+          SK_ICO = :sk_ico
+          SK_RC = :sk_rc
           US_EIN = :us_ein
           US_ITIN = :us_itin
           US_SSN = :us_ssn
+          UY_RUT = :uy_rut
           VN_TIN = :vn_tin
 
           # @!method self.values
@@ -644,7 +741,6 @@ module ModernTreasury
 
         BUSINESS = :business
         INDIVIDUAL = :individual
-        JOINT = :joint
 
         # @!method self.values
         #   @return [Array<Symbol>]
@@ -669,14 +765,20 @@ module ModernTreasury
 
       class PhoneNumber < ModernTreasury::Internal::Type::BaseModel
         # @!attribute phone_number
+        #   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.
         #
         #   @return [String, nil]
         optional :phone_number, String
 
         # @!method initialize(phone_number: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {ModernTreasury::Models::LegalEntity::PhoneNumber} for more details.
+        #
         #   A list of phone numbers in E.164 format.
         #
-        #   @param phone_number [String]
+        #   @param phone_number [String] A phone number in E.164 format. This format is strictly validated: include a lea
       end
 
       class Regulator < ModernTreasury::Internal::Type::BaseModel
@@ -739,6 +841,32 @@ module ModernTreasury
         # @!method self.values
         #   @return [Array<Symbol>]
       end
+
+      # @see ModernTreasury::Models::LegalEntity#terms_of_use
+      class TermsOfUse < ModernTreasury::Internal::Type::BaseModel
+        # @!attribute accepted_at
+        #   The ISO 8601 timestamp indicating when the terms of use were accepted.
+        #
+        #   @return [Time, nil]
+        optional :accepted_at, Time
+
+        # @!attribute ip_address
+        #   The IP address from which the terms of use were accepted. Supports both IPv4 and
+        #   IPv6 formats.
+        #
+        #   @return [String, nil]
+        optional :ip_address, String
+
+        # @!method initialize(accepted_at: nil, ip_address: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {ModernTreasury::Models::LegalEntity::TermsOfUse} for more details.
+        #
+        #   Acceptance of terms of use by the legal entity.
+        #
+        #   @param accepted_at [Time] The ISO 8601 timestamp indicating when the terms of use were accepted.
+        #
+        #   @param ip_address [String] The IP address from which the terms of use were accepted. Supports both IPv4 and
+      end
     end
   end
 end

data/lib/modern_treasury/models/legal_entity_address_create_request.rb

@@ -15,7 +15,8 @@ module ModernTreasury
       required :line1, String, nil?: true
 
       # @!attribute locality
-      #   Locality or City.
+      #   Locality or City. Use the full city name rather than an abbreviation (e.g. San
+      #   Francisco).
       #
       #   @return [String, nil]
       required :locality, String, nil?: true
@@ -27,7 +28,8 @@ module ModernTreasury
       required :postal_code, String, nil?: true
 
       # @!attribute region
-      #   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.
       #
       #   @return [String, nil]
       required :region, String, nil?: true
@@ -44,25 +46,38 @@ module ModernTreasury
       #   @return [String, nil]
       optional :line2, String, nil?: true
 
-      # @!method initialize(country:, line1:, locality:, postal_code:, region:, address_types: nil, line2: nil)
+      # @!attribute primary
+      #   Whether this address is the primary address for the legal entity. Optional; when
+      #   omitted it is inferred from the address types.
+      #
+      #   @return [Boolean, nil]
+      optional :primary, ModernTreasury::Internal::Type::Boolean, nil?: true
+
+      # @!method initialize(country:, line1:, locality:, postal_code:, region:, address_types: nil, line2: nil, primary: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {ModernTreasury::Models::LegalEntityAddressCreateRequest} for more details.
+      #
       #   @param country [String, nil] Country code conforms to [ISO 3166-1 alpha-2]
       #
       #   @param line1 [String, nil]
       #
-      #   @param locality [String, nil] Locality or City.
+      #   @param locality [String, nil] Locality or City. Use the full city name rather than an abbreviation (e.g. San F
       #
       #   @param postal_code [String, nil] The postal code of the address.
       #
-      #   @param region [String, nil] Region or State.
+      #   @param region [String, nil] Region or State. This field is free-form; for US states, we recommend a two-lett
       #
       #   @param address_types [Array<Symbol, ModernTreasury::Models::LegalEntityAddressCreateRequest::AddressType>] The types of this address.
       #
       #   @param line2 [String, nil]
+      #
+      #   @param primary [Boolean, nil] Whether this address is the primary address for the legal entity. Optional; when
 
       module AddressType
         extend ModernTreasury::Internal::Type::Enum
 
         BUSINESS = :business
+        BUSINESS_PHYSICAL = :business_physical
         BUSINESS_REGISTERED = :business_registered
         MAILING = :mailing
         OTHER = :other

data/lib/modern_treasury/models/legal_entity_association.rb

@@ -43,8 +43,7 @@ module ModernTreasury
       required :ownership_percentage, Integer, nil?: true
 
       # @!attribute parent_legal_entity_id
-      #   The ID of the parent legal entity. This must be a business or joint legal
-      #   entity.
+      #   The ID of the parent legal entity. This must be a business legal entity.
       #
       #   @return [String]
       required :parent_legal_entity_id, String
@@ -84,7 +83,7 @@ module ModernTreasury
       #
       #   @param ownership_percentage [Integer, nil] The child entity's ownership percentage iff they are a beneficial owner.
       #
-      #   @param parent_legal_entity_id [String] The ID of the parent legal entity. This must be a business or joint legal entity
+      #   @param parent_legal_entity_id [String] The ID of the parent legal entity. This must be a business legal entity.
       #
       #   @param relationship_types [Array<Symbol, ModernTreasury::Models::LegalEntityAssociation::RelationshipType>]
       #

data/lib/modern_treasury/models/legal_entity_create_params.rb

@@ -60,8 +60,8 @@ module ModernTreasury
       optional :connection_id, String, nil?: true
 
       # @!attribute country_of_incorporation
-      #   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).
       #
       #   @return [String, nil]
       optional :country_of_incorporation, String, nil?: true
@@ -179,8 +179,8 @@ module ModernTreasury
       optional :middle_name, String, nil?: true
 
       # @!attribute operating_jurisdictions
-      #   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"]).
       #
       #   @return [Array<String>, nil]
       optional :operating_jurisdictions, ModernTreasury::Internal::Type::ArrayOf[String]
@@ -243,6 +243,12 @@ module ModernTreasury
       #   @return [String, nil]
       optional :suffix, String, nil?: true
 
+      # @!attribute terms_of_use
+      #   Acceptance of terms of use by the legal entity.
+      #
+      #   @return [ModernTreasury::Models::LegalEntityCreateParams::TermsOfUse, nil]
+      optional :terms_of_use, -> { ModernTreasury::LegalEntityCreateParams::TermsOfUse }, nil?: true
+
       # @!attribute third_party_verification
       #   @deprecated
       #
@@ -277,7 +283,7 @@ module ModernTreasury
       #   @return [String, nil]
       optional :website, String, nil?: true
 
-      # @!method initialize(legal_entity_type:, addresses: nil, bank_settings: nil, business_description: nil, business_name: nil, citizenship_country: nil, compliance_details: nil, connection_id: nil, country_of_incorporation: nil, date_formed: nil, date_of_birth: nil, documents: nil, doing_business_as_names: nil, email: nil, expected_activity_volume: nil, external_id: nil, first_name: nil, identifications: nil, industry_classifications: nil, intended_use: nil, last_name: nil, legal_entity_associations: nil, legal_structure: nil, listed_exchange: nil, metadata: nil, middle_name: nil, operating_jurisdictions: nil, phone_numbers: nil, politically_exposed_person: nil, preferred_name: nil, prefix: nil, primary_social_media_sites: nil, regulators: nil, risk_rating: nil, service_provider_legal_entity_id: nil, suffix: nil, third_party_verification: nil, third_party_verifications: nil, ticker_symbol: nil, wealth_and_employment_details: nil, website: nil, request_options: {})
+      # @!method initialize(legal_entity_type:, addresses: nil, bank_settings: nil, business_description: nil, business_name: nil, citizenship_country: nil, compliance_details: nil, connection_id: nil, country_of_incorporation: nil, date_formed: nil, date_of_birth: nil, documents: nil, doing_business_as_names: nil, email: nil, expected_activity_volume: nil, external_id: nil, first_name: nil, identifications: nil, industry_classifications: nil, intended_use: nil, last_name: nil, legal_entity_associations: nil, legal_structure: nil, listed_exchange: nil, metadata: nil, middle_name: nil, operating_jurisdictions: nil, phone_numbers: nil, politically_exposed_person: nil, preferred_name: nil, prefix: nil, primary_social_media_sites: nil, regulators: nil, risk_rating: nil, service_provider_legal_entity_id: nil, suffix: nil, terms_of_use: nil, third_party_verification: nil, third_party_verifications: nil, ticker_symbol: nil, wealth_and_employment_details: nil, website: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {ModernTreasury::Models::LegalEntityCreateParams} for more details.
       #
@@ -297,7 +303,7 @@ module ModernTreasury
       #
       #   @param connection_id [String, nil] The connection ID for the connection the legal entity is associated with. Defaul
       #
-      #   @param country_of_incorporation [String, nil] The country code where the business is incorporated in the ISO 3166-1 alpha-2 or
+      #   @param country_of_incorporation [String, nil] The country where the business is incorporated, as an ISO 3166-1 alpha-2 country
       #
       #   @param date_formed [Date, nil] A business's formation date (YYYY-MM-DD).
       #
@@ -333,7 +339,7 @@ module ModernTreasury
       #
       #   @param middle_name [String, nil] An individual's middle name.
       #
-      #   @param operating_jurisdictions [Array<String>] A list of countries where the business operates (ISO 3166-1 alpha-2 or alpha-3 c
+      #   @param operating_jurisdictions [Array<String>] A list of countries where the business operates, as ISO 3166-1 alpha-2 country c
       #
       #   @param phone_numbers [Array<ModernTreasury::Models::LegalEntityCreateParams::PhoneNumber>]
       #
@@ -353,6 +359,8 @@ module ModernTreasury
       #
       #   @param suffix [String, nil] An individual's suffix.
       #
+      #   @param terms_of_use [ModernTreasury::Models::LegalEntityCreateParams::TermsOfUse, nil] Acceptance of terms of use by the legal entity.
+      #
       #   @param third_party_verification [ModernTreasury::Models::ThirdPartyVerification, nil] Deprecated. Use `third_party_verifications` instead.
       #
       #   @param third_party_verifications [Array<ModernTreasury::Models::ThirdPartyVerification>] A list of third-party verifications run by external vendors.
@@ -438,14 +446,20 @@ module ModernTreasury
 
       class PhoneNumber < ModernTreasury::Internal::Type::BaseModel
         # @!attribute phone_number
+        #   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.
         #
         #   @return [String, nil]
         optional :phone_number, String
 
         # @!method initialize(phone_number: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {ModernTreasury::Models::LegalEntityCreateParams::PhoneNumber} for more details.
+        #
         #   A list of phone numbers in E.164 format.
         #
-        #   @param phone_number [String]
+        #   @param phone_number [String] A phone number in E.164 format. This format is strictly validated: include a lea
       end
 
       class Regulator < ModernTreasury::Internal::Type::BaseModel
@@ -490,6 +504,31 @@ module ModernTreasury
         # @!method self.values
         #   @return [Array<Symbol>]
       end
+
+      class TermsOfUse < ModernTreasury::Internal::Type::BaseModel
+        # @!attribute accepted_at
+        #   The ISO 8601 timestamp indicating when the terms of use were accepted.
+        #
+        #   @return [Time, nil]
+        optional :accepted_at, Time
+
+        # @!attribute ip_address
+        #   The IP address from which the terms of use were accepted. Supports both IPv4 and
+        #   IPv6 formats.
+        #
+        #   @return [String, nil]
+        optional :ip_address, String
+
+        # @!method initialize(accepted_at: nil, ip_address: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {ModernTreasury::Models::LegalEntityCreateParams::TermsOfUse} for more details.
+        #
+        #   Acceptance of terms of use by the legal entity.
+        #
+        #   @param accepted_at [Time] The ISO 8601 timestamp indicating when the terms of use were accepted.
+        #
+        #   @param ip_address [String] The IP address from which the terms of use were accepted. Supports both IPv4 and
+      end
     end
   end
 end