modern_treasury 0.28.0 → 0.29.0

data/lib/modern_treasury/models/counterparty_create_params.rb

@@ -474,8 +474,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
@@ -593,8 +593,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]
@@ -722,7 +722,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).
         #
@@ -758,7 +758,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::CounterpartyCreateParams::LegalEntity::PhoneNumber>]
         #
@@ -868,14 +868,21 @@ 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::CounterpartyCreateParams::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

data/lib/modern_treasury/models/identification_create_request.rb

@@ -105,6 +105,8 @@ module ModernTreasury
         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

data/lib/modern_treasury/models/internal_account_create_params.rb

@@ -94,6 +94,13 @@ module ModernTreasury
       #   @return [String, nil]
       optional :party_name, String, nil?: true
 
+      # @!attribute requested_account_number_types
+      #   An array of account number types requested for provisioning.
+      #
+      #   @return [Array<Symbol, ModernTreasury::Models::InternalAccountCreateParams::RequestedAccountNumberType>, nil]
+      optional :requested_account_number_types,
+               -> { ModernTreasury::Internal::Type::ArrayOf[enum: ModernTreasury::InternalAccountCreateParams::RequestedAccountNumberType] }
+
       # @!attribute vendor_attributes
       #   A hash of vendor specific attributes that will be used when creating the account
       #   at the vendor specified by the given connection.
@@ -101,7 +108,7 @@ module ModernTreasury
       #   @return [Hash{Symbol=>String}, nil]
       optional :vendor_attributes, ModernTreasury::Internal::Type::HashOf[String]
 
-      # @!method initialize(currency:, name:, account_capabilities: nil, account_type: nil, connection_id: nil, counterparty_id: nil, debitable: nil, external_id: nil, legal_entity_id: nil, metadata: nil, parent_account_id: nil, party_address: nil, party_name: nil, vendor_attributes: nil, request_options: {})
+      # @!method initialize(currency:, name:, account_capabilities: nil, account_type: nil, connection_id: nil, counterparty_id: nil, debitable: nil, external_id: nil, legal_entity_id: nil, metadata: nil, parent_account_id: nil, party_address: nil, party_name: nil, requested_account_number_types: nil, vendor_attributes: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {ModernTreasury::Models::InternalAccountCreateParams} for more details.
       #
@@ -131,6 +138,8 @@ module ModernTreasury
       #
       #   @param party_name [String, nil] The legal name of the entity which owns the account.
       #
+      #   @param requested_account_number_types [Array<Symbol, ModernTreasury::Models::InternalAccountCreateParams::RequestedAccountNumberType>] An array of account number types requested for provisioning.
+      #
       #   @param vendor_attributes [Hash{Symbol=>String}] A hash of vendor specific attributes that will be used when creating the account
       #
       #   @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
@@ -302,7 +311,8 @@ module ModernTreasury
         required :line1, String
 
         # @!attribute locality
-        #   Locality or City.
+        #   Locality or City. Use the full city name rather than an abbreviation (e.g. San
+        #   Francisco).
         #
         #   @return [String]
         required :locality, String
@@ -314,7 +324,8 @@ module ModernTreasury
         required :postal_code, String
 
         # @!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]
         required :region, String
@@ -325,20 +336,36 @@ module ModernTreasury
         optional :line2, String
 
         # @!method initialize(country:, line1:, locality:, postal_code:, region:, line2: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {ModernTreasury::Models::InternalAccountCreateParams::PartyAddress} for more
+        #   details.
+        #
         #   The address associated with the owner or null.
         #
         #   @param country [String] Country code conforms to [ISO 3166-1 alpha-2]
         #
         #   @param line1 [String]
         #
-        #   @param locality [String] Locality or City.
+        #   @param locality [String] Locality or City. Use the full city name rather than an abbreviation (e.g. San F
         #
         #   @param postal_code [String] The postal code of the address.
         #
-        #   @param region [String] Region or State.
+        #   @param region [String] Region or State. This field is free-form; for US states, we recommend a two-lett
         #
         #   @param line2 [String]
       end
+
+      module RequestedAccountNumberType
+        extend ModernTreasury::Internal::Type::Enum
+
+        ETHEREUM_ADDRESS = :ethereum_address
+        SOLANA_ADDRESS = :solana_address
+        POLYGON_ADDRESS = :polygon_address
+        BASE_ADDRESS = :base_address
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
     end
   end
 end

data/lib/modern_treasury/models/internal_accounts/balance_report_create_params.rb

@@ -115,6 +115,8 @@ module ModernTreasury
           #   {ModernTreasury::Models::InternalAccounts::BalanceReportCreateParams::Balance}
           #   for more details.
           #
+          #   At least one of "amount" or "amount_string" is required.
+          #
           #   @param balance_type [Symbol, ModernTreasury::Models::InternalAccounts::BalanceReportCreateParams::Balance::BalanceType] The specific type of balance reported. One of `opening_ledger`, `closing_ledger`
           #
           #   @param vendor_code [String] The code used by the bank when reporting this specific balance.

data/lib/modern_treasury/models/invoice.rb

@@ -370,7 +370,8 @@ module ModernTreasury
         required :line1, String
 
         # @!attribute locality
-        #   Locality or City.
+        #   Locality or City. Use the full city name rather than an abbreviation (e.g. San
+        #   Francisco).
         #
         #   @return [String]
         required :locality, String
@@ -382,7 +383,8 @@ module ModernTreasury
         required :postal_code, String
 
         # @!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]
         required :region, String
@@ -393,17 +395,20 @@ module ModernTreasury
         optional :line2, String
 
         # @!method initialize(country:, line1:, locality:, postal_code:, region:, line2: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {ModernTreasury::Models::Invoice::CounterpartyBillingAddress} for more details.
+        #
         #   The counterparty's billing address.
         #
         #   @param country [String] Country code conforms to [ISO 3166-1 alpha-2]
         #
         #   @param line1 [String]
         #
-        #   @param locality [String] Locality or City.
+        #   @param locality [String] Locality or City. Use the full city name rather than an abbreviation (e.g. San F
         #
         #   @param postal_code [String] The postal code of the address.
         #
-        #   @param region [String] Region or State.
+        #   @param region [String] Region or State. This field is free-form; for US states, we recommend a two-lett
         #
         #   @param line2 [String]
       end
@@ -422,7 +427,8 @@ module ModernTreasury
         required :line1, String
 
         # @!attribute locality
-        #   Locality or City.
+        #   Locality or City. Use the full city name rather than an abbreviation (e.g. San
+        #   Francisco).
         #
         #   @return [String]
         required :locality, String
@@ -434,7 +440,8 @@ module ModernTreasury
         required :postal_code, String
 
         # @!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]
         required :region, String
@@ -445,17 +452,20 @@ module ModernTreasury
         optional :line2, String
 
         # @!method initialize(country:, line1:, locality:, postal_code:, region:, line2: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {ModernTreasury::Models::Invoice::CounterpartyShippingAddress} for more details.
+        #
         #   The counterparty's shipping address where physical goods should be delivered.
         #
         #   @param country [String] Country code conforms to [ISO 3166-1 alpha-2]
         #
         #   @param line1 [String]
         #
-        #   @param locality [String] Locality or City.
+        #   @param locality [String] Locality or City. Use the full city name rather than an abbreviation (e.g. San F
         #
         #   @param postal_code [String] The postal code of the address.
         #
-        #   @param region [String] Region or State.
+        #   @param region [String] Region or State. This field is free-form; for US states, we recommend a two-lett
         #
         #   @param line2 [String]
       end
@@ -474,7 +484,8 @@ module ModernTreasury
         required :line1, String
 
         # @!attribute locality
-        #   Locality or City.
+        #   Locality or City. Use the full city name rather than an abbreviation (e.g. San
+        #   Francisco).
         #
         #   @return [String]
         required :locality, String
@@ -486,7 +497,8 @@ module ModernTreasury
         required :postal_code, String
 
         # @!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]
         required :region, String
@@ -497,17 +509,20 @@ module ModernTreasury
         optional :line2, String
 
         # @!method initialize(country:, line1:, locality:, postal_code:, region:, line2: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {ModernTreasury::Models::Invoice::InvoicerAddress} for more details.
+        #
         #   The invoice issuer's business address.
         #
         #   @param country [String] Country code conforms to [ISO 3166-1 alpha-2]
         #
         #   @param line1 [String]
         #
-        #   @param locality [String] Locality or City.
+        #   @param locality [String] Locality or City. Use the full city name rather than an abbreviation (e.g. San F
         #
         #   @param postal_code [String] The postal code of the address.
         #
-        #   @param region [String] Region or State.
+        #   @param region [String] Region or State. This field is free-form; for US states, we recommend a two-lett
         #
         #   @param line2 [String]
       end

data/lib/modern_treasury/models/invoice_create_params.rb

@@ -247,7 +247,8 @@ module ModernTreasury
         required :line1, String
 
         # @!attribute locality
-        #   Locality or City.
+        #   Locality or City. Use the full city name rather than an abbreviation (e.g. San
+        #   Francisco).
         #
         #   @return [String]
         required :locality, String
@@ -259,7 +260,8 @@ module ModernTreasury
         required :postal_code, String
 
         # @!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]
         required :region, String
@@ -270,17 +272,21 @@ module ModernTreasury
         optional :line2, String
 
         # @!method initialize(country:, line1:, locality:, postal_code:, region:, line2: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {ModernTreasury::Models::InvoiceCreateParams::CounterpartyBillingAddress} for
+        #   more details.
+        #
         #   The counterparty's billing address.
         #
         #   @param country [String] Country code conforms to [ISO 3166-1 alpha-2]
         #
         #   @param line1 [String]
         #
-        #   @param locality [String] Locality or City.
+        #   @param locality [String] Locality or City. Use the full city name rather than an abbreviation (e.g. San F
         #
         #   @param postal_code [String] The postal code of the address.
         #
-        #   @param region [String] Region or State.
+        #   @param region [String] Region or State. This field is free-form; for US states, we recommend a two-lett
         #
         #   @param line2 [String]
       end
@@ -298,7 +304,8 @@ module ModernTreasury
         required :line1, String
 
         # @!attribute locality
-        #   Locality or City.
+        #   Locality or City. Use the full city name rather than an abbreviation (e.g. San
+        #   Francisco).
         #
         #   @return [String]
         required :locality, String
@@ -310,7 +317,8 @@ module ModernTreasury
         required :postal_code, String
 
         # @!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]
         required :region, String
@@ -321,17 +329,21 @@ module ModernTreasury
         optional :line2, String
 
         # @!method initialize(country:, line1:, locality:, postal_code:, region:, line2: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {ModernTreasury::Models::InvoiceCreateParams::CounterpartyShippingAddress} for
+        #   more details.
+        #
         #   The counterparty's shipping address where physical goods should be delivered.
         #
         #   @param country [String] Country code conforms to [ISO 3166-1 alpha-2]
         #
         #   @param line1 [String]
         #
-        #   @param locality [String] Locality or City.
+        #   @param locality [String] Locality or City. Use the full city name rather than an abbreviation (e.g. San F
         #
         #   @param postal_code [String] The postal code of the address.
         #
-        #   @param region [String] Region or State.
+        #   @param region [String] Region or State. This field is free-form; for US states, we recommend a two-lett
         #
         #   @param line2 [String]
       end
@@ -418,7 +430,8 @@ module ModernTreasury
         required :line1, String
 
         # @!attribute locality
-        #   Locality or City.
+        #   Locality or City. Use the full city name rather than an abbreviation (e.g. San
+        #   Francisco).
         #
         #   @return [String]
         required :locality, String
@@ -430,7 +443,8 @@ module ModernTreasury
         required :postal_code, String
 
         # @!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]
         required :region, String
@@ -441,17 +455,20 @@ module ModernTreasury
         optional :line2, String
 
         # @!method initialize(country:, line1:, locality:, postal_code:, region:, line2: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {ModernTreasury::Models::InvoiceCreateParams::InvoicerAddress} for more details.
+        #
         #   The invoice issuer's business address.
         #
         #   @param country [String] Country code conforms to [ISO 3166-1 alpha-2]
         #
         #   @param line1 [String]
         #
-        #   @param locality [String] Locality or City.
+        #   @param locality [String] Locality or City. Use the full city name rather than an abbreviation (e.g. San F
         #
         #   @param postal_code [String] The postal code of the address.
         #
-        #   @param region [String] Region or State.
+        #   @param region [String] Region or State. This field is free-form; for US states, we recommend a two-lett
         #
         #   @param line2 [String]
       end

data/lib/modern_treasury/models/invoice_update_params.rb

@@ -254,7 +254,8 @@ module ModernTreasury
         required :line1, String
 
         # @!attribute locality
-        #   Locality or City.
+        #   Locality or City. Use the full city name rather than an abbreviation (e.g. San
+        #   Francisco).
         #
         #   @return [String]
         required :locality, String
@@ -266,7 +267,8 @@ module ModernTreasury
         required :postal_code, String
 
         # @!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]
         required :region, String
@@ -277,17 +279,21 @@ module ModernTreasury
         optional :line2, String
 
         # @!method initialize(country:, line1:, locality:, postal_code:, region:, line2: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {ModernTreasury::Models::InvoiceUpdateParams::CounterpartyBillingAddress} for
+        #   more details.
+        #
         #   The counterparty's billing address.
         #
         #   @param country [String] Country code conforms to [ISO 3166-1 alpha-2]
         #
         #   @param line1 [String]
         #
-        #   @param locality [String] Locality or City.
+        #   @param locality [String] Locality or City. Use the full city name rather than an abbreviation (e.g. San F
         #
         #   @param postal_code [String] The postal code of the address.
         #
-        #   @param region [String] Region or State.
+        #   @param region [String] Region or State. This field is free-form; for US states, we recommend a two-lett
         #
         #   @param line2 [String]
       end
@@ -305,7 +311,8 @@ module ModernTreasury
         required :line1, String
 
         # @!attribute locality
-        #   Locality or City.
+        #   Locality or City. Use the full city name rather than an abbreviation (e.g. San
+        #   Francisco).
         #
         #   @return [String]
         required :locality, String
@@ -317,7 +324,8 @@ module ModernTreasury
         required :postal_code, String
 
         # @!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]
         required :region, String
@@ -328,17 +336,21 @@ module ModernTreasury
         optional :line2, String
 
         # @!method initialize(country:, line1:, locality:, postal_code:, region:, line2: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {ModernTreasury::Models::InvoiceUpdateParams::CounterpartyShippingAddress} for
+        #   more details.
+        #
         #   The counterparty's shipping address where physical goods should be delivered.
         #
         #   @param country [String] Country code conforms to [ISO 3166-1 alpha-2]
         #
         #   @param line1 [String]
         #
-        #   @param locality [String] Locality or City.
+        #   @param locality [String] Locality or City. Use the full city name rather than an abbreviation (e.g. San F
         #
         #   @param postal_code [String] The postal code of the address.
         #
-        #   @param region [String] Region or State.
+        #   @param region [String] Region or State. This field is free-form; for US states, we recommend a two-lett
         #
         #   @param line2 [String]
       end
@@ -425,7 +437,8 @@ module ModernTreasury
         required :line1, String
 
         # @!attribute locality
-        #   Locality or City.
+        #   Locality or City. Use the full city name rather than an abbreviation (e.g. San
+        #   Francisco).
         #
         #   @return [String]
         required :locality, String
@@ -437,7 +450,8 @@ module ModernTreasury
         required :postal_code, String
 
         # @!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]
         required :region, String
@@ -448,17 +462,20 @@ module ModernTreasury
         optional :line2, String
 
         # @!method initialize(country:, line1:, locality:, postal_code:, region:, line2: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {ModernTreasury::Models::InvoiceUpdateParams::InvoicerAddress} for more details.
+        #
         #   The invoice issuer's business address.
         #
         #   @param country [String] Country code conforms to [ISO 3166-1 alpha-2]
         #
         #   @param line1 [String]
         #
-        #   @param locality [String] Locality or City.
+        #   @param locality [String] Locality or City. Use the full city name rather than an abbreviation (e.g. San F
         #
         #   @param postal_code [String] The postal code of the address.
         #
-        #   @param region [String] Region or State.
+        #   @param region [String] Region or State. This field is free-form; for US states, we recommend a two-lett
         #
         #   @param line2 [String]
       end

data/lib/modern_treasury/models/ledger_entry_create_request.rb

@@ -90,6 +90,8 @@ module ModernTreasury
       #   Some parameter documentations has been truncated, see
       #   {ModernTreasury::Models::LedgerEntryCreateRequest} for more details.
       #
+      #   At least one of "amount" or "amount_string" is required.
+      #
       #   @param direction [Symbol, ModernTreasury::Models::TransactionDirection] 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.

data/lib/modern_treasury/models/ledger_transaction_create_partial_post_params.rb

@@ -142,6 +142,8 @@ module ModernTreasury
         #   {ModernTreasury::Models::LedgerTransactionCreatePartialPostParams::PostedLedgerEntry}
         #   for more details.
         #
+        #   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.