modern_treasury 0.1.0.pre.alpha.22 → 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +38 -0
- data/README.md +1 -1
- data/lib/modern_treasury/client.rb +0 -12
- data/lib/modern_treasury/internal/transport/base_client.rb +1 -1
- data/lib/modern_treasury/internal/type/base_model.rb +4 -4
- data/lib/modern_treasury/models/accounting.rb +30 -0
- data/lib/modern_treasury/models/address.rb +94 -0
- data/lib/modern_treasury/models/address_request.rb +54 -0
- data/lib/modern_treasury/models/bulk_request_create_params.rb +144 -1505
- data/lib/modern_treasury/models/child_legal_entity_create.rb +275 -0
- data/lib/modern_treasury/models/connection_legal_entity_create_params.rb +10 -627
- data/lib/modern_treasury/models/contact_detail.rb +81 -0
- data/lib/modern_treasury/models/contact_detail_create_request.rb +34 -0
- data/lib/modern_treasury/models/counterparty.rb +24 -177
- data/lib/modern_treasury/models/counterparty_create_params.rb +37 -838
- data/lib/modern_treasury/models/counterparty_list_params.rb +9 -1
- data/lib/modern_treasury/models/document.rb +4 -6
- data/lib/modern_treasury/models/document_create_params.rb +0 -2
- data/lib/modern_treasury/models/document_list_params.rb +4 -6
- data/lib/modern_treasury/models/expected_payment.rb +9 -1
- data/lib/modern_treasury/models/expected_payment_create_params.rb +12 -230
- data/lib/modern_treasury/models/expected_payment_list_params.rb +8 -1
- data/lib/modern_treasury/models/expected_payment_update_params.rb +9 -1
- data/lib/modern_treasury/models/external_account.rb +15 -177
- data/lib/modern_treasury/models/external_account_create_params.rb +18 -210
- data/lib/modern_treasury/models/external_account_list_params.rb +9 -1
- data/lib/modern_treasury/models/external_account_update_params.rb +3 -52
- data/lib/modern_treasury/models/foreign_exchange_quote.rb +3 -73
- data/lib/modern_treasury/models/foreign_exchange_rate.rb +71 -0
- data/lib/modern_treasury/models/identification_create_request.rb +86 -0
- data/lib/modern_treasury/models/internal_account.rb +3 -95
- data/lib/modern_treasury/models/internal_account_update_account_capability_params.rb +34 -0
- data/lib/modern_treasury/models/internal_account_update_account_capability_response.rb +131 -0
- data/lib/modern_treasury/models/invoice.rb +3 -81
- data/lib/modern_treasury/models/invoice_create_params.rb +3 -83
- data/lib/modern_treasury/models/invoice_update_params.rb +3 -83
- data/lib/modern_treasury/models/ledger_account.rb +9 -141
- data/lib/modern_treasury/models/ledger_account_balance_monitor.rb +3 -182
- data/lib/modern_treasury/models/ledger_account_category.rb +3 -175
- data/lib/modern_treasury/models/ledger_account_category_list_params.rb +9 -5
- data/lib/modern_treasury/models/ledger_account_category_retrieve_params.rb +4 -2
- data/lib/modern_treasury/models/ledger_account_create_params.rb +2 -105
- data/lib/modern_treasury/models/ledger_account_create_request.rb +113 -0
- data/lib/modern_treasury/models/ledger_account_statement_create_response.rb +6 -360
- data/lib/modern_treasury/models/ledger_account_statement_retrieve_response.rb +6 -360
- data/lib/modern_treasury/models/ledger_balance.rb +45 -0
- data/lib/modern_treasury/models/ledger_balances.rb +38 -0
- data/lib/modern_treasury/models/ledger_entry.rb +3 -183
- data/lib/modern_treasury/models/ledger_entry_create_request.rb +98 -0
- data/lib/modern_treasury/models/ledger_entry_list_params.rb +48 -8
- data/lib/modern_treasury/models/ledger_transaction.rb +14 -6
- data/lib/modern_treasury/models/ledger_transaction_create_params.rb +2 -212
- data/lib/modern_treasury/models/ledger_transaction_create_request.rb +123 -0
- data/lib/modern_treasury/models/ledger_transaction_create_reversal_params.rb +0 -1
- data/lib/modern_treasury/models/ledger_transaction_list_params.rb +44 -7
- data/lib/modern_treasury/models/ledger_transaction_update_params.rb +5 -104
- data/lib/modern_treasury/models/ledger_transactions/ledger_transaction_version.rb +15 -193
- data/lib/modern_treasury/models/legal_entity_address_create_request.rb +78 -0
- data/lib/modern_treasury/models/legal_entity_association.rb +1 -0
- data/lib/modern_treasury/models/legal_entity_association_create_params.rb +4 -448
- data/lib/modern_treasury/models/legal_entity_create_params.rb +10 -618
- data/lib/modern_treasury/models/legal_entity_update_params.rb +6 -165
- data/lib/modern_treasury/models/line_item.rb +3 -29
- data/lib/modern_treasury/models/payment_action_list_params.rb +1 -0
- data/lib/modern_treasury/models/payment_order.rb +13 -102
- data/lib/modern_treasury/models/payment_order_create_async_params.rb +24 -477
- data/lib/modern_treasury/models/payment_order_create_params.rb +24 -479
- data/lib/modern_treasury/models/payment_order_update_params.rb +21 -248
- data/lib/modern_treasury/models/payment_orders/reversal_create_params.rb +3 -232
- data/lib/modern_treasury/models/payment_reference.rb +7 -1
- data/lib/modern_treasury/models/return_list_params.rb +5 -6
- data/lib/modern_treasury/models/return_object.rb +7 -3
- data/lib/modern_treasury/models/routing_detail.rb +3 -93
- data/lib/modern_treasury/models/routing_number_lookup_request.rb +3 -55
- data/lib/modern_treasury/models/transaction.rb +5 -73
- data/lib/modern_treasury/models/transactions/transaction_line_item.rb +0 -1
- data/lib/modern_treasury/models/virtual_account_create_params.rb +3 -117
- data/lib/modern_treasury/models.rb +31 -6
- data/lib/modern_treasury/resources/bulk_requests.rb +1 -1
- data/lib/modern_treasury/resources/counterparties.rb +20 -14
- data/lib/modern_treasury/resources/expected_payments.rb +10 -4
- data/lib/modern_treasury/resources/external_accounts.rb +23 -17
- data/lib/modern_treasury/resources/internal_accounts.rb +34 -0
- data/lib/modern_treasury/resources/invoices.rb +2 -2
- data/lib/modern_treasury/resources/ledger_account_categories.rb +1 -1
- data/lib/modern_treasury/resources/ledger_accounts.rb +1 -1
- data/lib/modern_treasury/resources/ledger_entries.rb +1 -1
- data/lib/modern_treasury/resources/ledger_transactions.rb +5 -5
- data/lib/modern_treasury/resources/legal_entities.rb +4 -4
- data/lib/modern_treasury/resources/legal_entity_associations.rb +1 -1
- data/lib/modern_treasury/resources/payment_orders/reversals.rb +1 -1
- data/lib/modern_treasury/resources/payment_orders.rb +5 -5
- data/lib/modern_treasury/resources/returns.rb +1 -1
- data/lib/modern_treasury/resources/virtual_accounts.rb +1 -1
- data/lib/modern_treasury/version.rb +1 -1
- data/lib/modern_treasury.rb +16 -6
- data/rbi/modern_treasury/client.rbi +0 -9
- data/rbi/modern_treasury/internal/transport/base_client.rbi +1 -1
- data/rbi/modern_treasury/models/accounting.rbi +48 -0
- data/rbi/modern_treasury/models/address.rbi +107 -0
- data/rbi/modern_treasury/models/address_request.rbi +76 -0
- data/rbi/modern_treasury/models/bulk_request_create_params.rbi +701 -3140
- data/rbi/modern_treasury/models/child_legal_entity_create.rbi +511 -0
- data/rbi/modern_treasury/models/connection_legal_entity_create_params.rbi +17 -1314
- data/rbi/modern_treasury/models/contact_detail.rbi +124 -0
- data/rbi/modern_treasury/models/contact_detail_create_request.rbi +99 -0
- data/rbi/modern_treasury/models/counterparty.rbi +24 -264
- data/rbi/modern_treasury/models/counterparty_create_params.rbi +47 -1718
- data/rbi/modern_treasury/models/counterparty_list_params.rbi +11 -0
- data/rbi/modern_treasury/models/document.rbi +6 -16
- data/rbi/modern_treasury/models/document_create_params.rbi +0 -10
- data/rbi/modern_treasury/models/document_list_params.rbi +6 -16
- data/rbi/modern_treasury/models/expected_payment.rbi +8 -0
- data/rbi/modern_treasury/models/expected_payment_create_params.rbi +12 -419
- data/rbi/modern_treasury/models/expected_payment_list_params.rbi +9 -0
- data/rbi/modern_treasury/models/expected_payment_update_params.rbi +8 -0
- data/rbi/modern_treasury/models/external_account.rbi +15 -244
- data/rbi/modern_treasury/models/external_account_create_params.rbi +20 -400
- data/rbi/modern_treasury/models/external_account_list_params.rbi +11 -0
- data/rbi/modern_treasury/models/external_account_update_params.rbi +4 -86
- data/rbi/modern_treasury/models/foreign_exchange_quote.rbi +4 -99
- data/rbi/modern_treasury/models/foreign_exchange_rate.rbi +96 -0
- data/rbi/modern_treasury/models/identification_create_request.rbi +212 -0
- data/rbi/modern_treasury/models/internal_account.rbi +4 -115
- data/rbi/modern_treasury/models/internal_account_update_account_capability_params.rbi +54 -0
- data/rbi/modern_treasury/models/internal_account_update_account_capability_response.rbi +304 -0
- data/rbi/modern_treasury/models/invoice.rbi +3 -128
- data/rbi/modern_treasury/models/invoice_create_params.rbi +4 -139
- data/rbi/modern_treasury/models/invoice_update_params.rbi +4 -139
- data/rbi/modern_treasury/models/ledger_account.rbi +12 -218
- data/rbi/modern_treasury/models/ledger_account_balance_monitor.rbi +4 -303
- data/rbi/modern_treasury/models/ledger_account_category.rbi +4 -301
- data/rbi/modern_treasury/models/ledger_account_category_list_params.rbi +14 -7
- data/rbi/modern_treasury/models/ledger_account_category_retrieve_params.rbi +6 -3
- data/rbi/modern_treasury/models/ledger_account_create_params.rbi +5 -173
- data/rbi/modern_treasury/models/ledger_account_create_request.rbi +194 -0
- data/rbi/modern_treasury/models/ledger_account_statement_create_response.rbi +8 -612
- data/rbi/modern_treasury/models/ledger_account_statement_retrieve_response.rbi +8 -612
- data/rbi/modern_treasury/models/ledger_balance.rbi +66 -0
- data/rbi/modern_treasury/models/ledger_balances.rbi +75 -0
- data/rbi/modern_treasury/models/ledger_entry.rbi +4 -309
- data/rbi/modern_treasury/models/ledger_entry_create_request.rbi +137 -0
- data/rbi/modern_treasury/models/ledger_entry_list_params.rbi +99 -16
- data/rbi/modern_treasury/models/ledger_transaction.rbi +17 -11
- data/rbi/modern_treasury/models/ledger_transaction_create_params.rbi +5 -383
- data/rbi/modern_treasury/models/ledger_transaction_create_request.rbi +258 -0
- data/rbi/modern_treasury/models/ledger_transaction_create_reversal_params.rbi +0 -5
- data/rbi/modern_treasury/models/ledger_transaction_list_params.rbi +93 -18
- data/rbi/modern_treasury/models/ledger_transaction_update_params.rbi +7 -158
- data/rbi/modern_treasury/models/ledger_transactions/ledger_transaction_version.rbi +18 -316
- data/rbi/modern_treasury/models/legal_entity_address_create_request.rbi +157 -0
- data/rbi/modern_treasury/models/legal_entity_association.rbi +5 -0
- data/rbi/modern_treasury/models/legal_entity_association_create_params.rbi +9 -917
- data/rbi/modern_treasury/models/legal_entity_create_params.rbi +17 -1297
- data/rbi/modern_treasury/models/legal_entity_update_params.rbi +8 -378
- data/rbi/modern_treasury/models/line_item.rbi +4 -52
- data/rbi/modern_treasury/models/payment_action_list_params.rbi +5 -0
- data/rbi/modern_treasury/models/payment_order.rbi +43 -159
- data/rbi/modern_treasury/models/payment_order_create_async_params.rbi +28 -882
- data/rbi/modern_treasury/models/payment_order_create_params.rbi +28 -887
- data/rbi/modern_treasury/models/payment_order_update_params.rbi +24 -460
- data/rbi/modern_treasury/models/payment_orders/reversal_create_params.rbi +4 -415
- data/rbi/modern_treasury/models/payment_reference.rbi +35 -5
- data/rbi/modern_treasury/models/return_list_params.rbi +6 -11
- data/rbi/modern_treasury/models/return_object.rbi +35 -12
- data/rbi/modern_treasury/models/routing_detail.rbi +4 -113
- data/rbi/modern_treasury/models/routing_number_lookup_request.rbi +4 -87
- data/rbi/modern_treasury/models/transaction.rbi +14 -103
- data/rbi/modern_treasury/models/transactions/transaction_line_item.rbi +0 -5
- data/rbi/modern_treasury/models/virtual_account_create_params.rbi +4 -203
- data/rbi/modern_treasury/models.rbi +36 -6
- data/rbi/modern_treasury/resources/bulk_requests.rbi +2 -2
- data/rbi/modern_treasury/resources/counterparties.rbi +20 -12
- data/rbi/modern_treasury/resources/documents.rbi +2 -2
- data/rbi/modern_treasury/resources/expected_payments.rbi +9 -1
- data/rbi/modern_treasury/resources/external_accounts.rbi +29 -22
- data/rbi/modern_treasury/resources/internal_accounts.rbi +24 -0
- data/rbi/modern_treasury/resources/invoices.rbi +2 -8
- data/rbi/modern_treasury/resources/ledger_account_categories.rbi +7 -3
- data/rbi/modern_treasury/resources/ledger_accounts.rbi +1 -1
- data/rbi/modern_treasury/resources/ledger_entries.rbi +9 -2
- data/rbi/modern_treasury/resources/ledger_transactions.rbi +13 -13
- data/rbi/modern_treasury/resources/legal_entities.rbi +4 -8
- data/rbi/modern_treasury/resources/legal_entity_associations.rbi +1 -2
- data/rbi/modern_treasury/resources/payment_orders/reversals.rbi +1 -1
- data/rbi/modern_treasury/resources/payment_orders.rbi +5 -8
- data/rbi/modern_treasury/resources/returns.rbi +2 -2
- data/rbi/modern_treasury/resources/virtual_accounts.rbi +1 -2
- data/sig/modern_treasury/client.rbs +0 -6
- data/sig/modern_treasury/internal/transport/base_client.rbs +1 -1
- data/sig/modern_treasury/models/accounting.rbs +15 -0
- data/sig/modern_treasury/models/address.rbs +70 -0
- data/sig/modern_treasury/models/address_request.rbs +45 -0
- data/sig/modern_treasury/models/bulk_request_create_params.rbs +88 -1089
- data/sig/modern_treasury/models/child_legal_entity_create.rbs +220 -0
- data/sig/modern_treasury/models/connection_legal_entity_create_params.rbs +21 -548
- data/sig/modern_treasury/models/contact_detail.rbs +67 -0
- data/sig/modern_treasury/models/contact_detail_create_request.rbs +43 -0
- data/sig/modern_treasury/models/counterparty.rbs +20 -141
- data/sig/modern_treasury/models/counterparty_create_params.rbs +49 -737
- data/sig/modern_treasury/models/counterparty_list_params.rbs +7 -0
- data/sig/modern_treasury/models/document.rbs +0 -4
- data/sig/modern_treasury/models/document_create_params.rbs +0 -4
- data/sig/modern_treasury/models/document_list_params.rbs +0 -4
- data/sig/modern_treasury/models/expected_payment.rbs +5 -0
- data/sig/modern_treasury/models/expected_payment_create_params.rbs +11 -173
- data/sig/modern_treasury/models/expected_payment_list_params.rbs +7 -0
- data/sig/modern_treasury/models/expected_payment_update_params.rbs +5 -0
- data/sig/modern_treasury/models/external_account.rbs +13 -139
- data/sig/modern_treasury/models/external_account_create_params.rbs +23 -189
- data/sig/modern_treasury/models/external_account_list_params.rbs +7 -0
- data/sig/modern_treasury/models/external_account_update_params.rbs +6 -48
- data/sig/modern_treasury/models/foreign_exchange_quote.rbs +4 -51
- data/sig/modern_treasury/models/foreign_exchange_rate.rbs +50 -0
- data/sig/modern_treasury/models/identification_create_request.rbs +93 -0
- data/sig/modern_treasury/models/internal_account.rbs +4 -71
- data/sig/modern_treasury/models/internal_account_update_account_capability_params.rbs +28 -0
- data/sig/modern_treasury/models/internal_account_update_account_capability_response.rbs +137 -0
- data/sig/modern_treasury/models/invoice.rbs +4 -68
- data/sig/modern_treasury/models/invoice_create_params.rbs +6 -70
- data/sig/modern_treasury/models/invoice_update_params.rbs +6 -70
- data/sig/modern_treasury/models/ledger_account.rbs +12 -123
- data/sig/modern_treasury/models/ledger_account_balance_monitor.rbs +4 -142
- data/sig/modern_treasury/models/ledger_account_category.rbs +4 -142
- data/sig/modern_treasury/models/ledger_account_category_list_params.rbs +5 -5
- data/sig/modern_treasury/models/ledger_account_create_params.rbs +4 -84
- data/sig/modern_treasury/models/ledger_account_create_request.rbs +89 -0
- data/sig/modern_treasury/models/ledger_account_statement_create_response.rbs +8 -284
- data/sig/modern_treasury/models/ledger_account_statement_retrieve_response.rbs +8 -284
- data/sig/modern_treasury/models/ledger_balance.rbs +40 -0
- data/sig/modern_treasury/models/ledger_balances.rbs +30 -0
- data/sig/modern_treasury/models/ledger_entry.rbs +4 -142
- data/sig/modern_treasury/models/ledger_entry_create_request.rbs +62 -0
- data/sig/modern_treasury/models/ledger_entry_list_params.rbs +21 -3
- data/sig/modern_treasury/models/ledger_transaction.rbs +5 -2
- data/sig/modern_treasury/models/ledger_transaction_create_params.rbs +4 -165
- data/sig/modern_treasury/models/ledger_transaction_create_request.rbs +109 -0
- data/sig/modern_treasury/models/ledger_transaction_create_reversal_params.rbs +0 -2
- data/sig/modern_treasury/models/ledger_transaction_list_params.rbs +21 -5
- data/sig/modern_treasury/models/ledger_transaction_update_params.rbs +6 -67
- data/sig/modern_treasury/models/ledger_transactions/ledger_transaction_version.rbs +9 -144
- data/sig/modern_treasury/models/legal_entity_address_create_request.rbs +68 -0
- data/sig/modern_treasury/models/legal_entity_association.rbs +3 -1
- data/sig/modern_treasury/models/legal_entity_association_create_params.rbs +9 -380
- data/sig/modern_treasury/models/legal_entity_create_params.rbs +21 -548
- data/sig/modern_treasury/models/legal_entity_update_params.rbs +12 -168
- data/sig/modern_treasury/models/line_item.rbs +4 -16
- data/sig/modern_treasury/models/payment_action_list_params.rbs +2 -1
- data/sig/modern_treasury/models/payment_order.rbs +22 -69
- data/sig/modern_treasury/models/payment_order_create_async_params.rbs +35 -380
- data/sig/modern_treasury/models/payment_order_create_params.rbs +35 -384
- data/sig/modern_treasury/models/payment_order_update_params.rbs +29 -207
- data/sig/modern_treasury/models/payment_orders/reversal_create_params.rbs +6 -173
- data/sig/modern_treasury/models/payment_reference.rbs +14 -2
- data/sig/modern_treasury/models/return_list_params.rbs +1 -6
- data/sig/modern_treasury/models/return_object.rbs +15 -10
- data/sig/modern_treasury/models/routing_detail.rbs +4 -71
- data/sig/modern_treasury/models/routing_number_lookup_request.rbs +6 -48
- data/sig/modern_treasury/models/transaction.rbs +8 -53
- data/sig/modern_treasury/models/transactions/transaction_line_item.rbs +0 -2
- data/sig/modern_treasury/models/virtual_account_create_params.rbs +6 -95
- data/sig/modern_treasury/models.rbs +30 -6
- data/sig/modern_treasury/resources/counterparties.rbs +2 -0
- data/sig/modern_treasury/resources/expected_payments.rbs +4 -1
- data/sig/modern_treasury/resources/external_accounts.rbs +6 -4
- data/sig/modern_treasury/resources/internal_accounts.rbs +7 -0
- data/sig/modern_treasury/resources/invoices.rbs +2 -2
- data/sig/modern_treasury/resources/ledger_account_categories.rbs +1 -1
- data/sig/modern_treasury/resources/ledger_accounts.rbs +1 -1
- data/sig/modern_treasury/resources/ledger_transactions.rbs +4 -4
- data/sig/modern_treasury/resources/legal_entities.rbs +4 -4
- data/sig/modern_treasury/resources/legal_entity_associations.rbs +1 -1
- data/sig/modern_treasury/resources/payment_orders/reversals.rbs +1 -1
- data/sig/modern_treasury/resources/payment_orders.rbs +5 -5
- data/sig/modern_treasury/resources/virtual_accounts.rbs +1 -1
- metadata +52 -22
- data/lib/modern_treasury/models/paper_item.rb +0 -178
- data/lib/modern_treasury/models/paper_item_list_params.rb +0 -56
- data/lib/modern_treasury/models/paper_item_retrieve_params.rb +0 -14
- data/lib/modern_treasury/resources/ledger_event_handlers.rb +0 -14
- data/lib/modern_treasury/resources/ledgerable_events.rb +0 -14
- data/lib/modern_treasury/resources/paper_items.rb +0 -68
- data/rbi/modern_treasury/models/paper_item.rbi +0 -204
- data/rbi/modern_treasury/models/paper_item_list_params.rbi +0 -88
- data/rbi/modern_treasury/models/paper_item_retrieve_params.rbi +0 -32
- data/rbi/modern_treasury/resources/ledger_event_handlers.rbi +0 -12
- data/rbi/modern_treasury/resources/ledgerable_events.rbi +0 -12
- data/rbi/modern_treasury/resources/paper_items.rbi +0 -51
- data/sig/modern_treasury/models/paper_item.rbs +0 -122
- data/sig/modern_treasury/models/paper_item_list_params.rbs +0 -54
- data/sig/modern_treasury/models/paper_item_retrieve_params.rbs +0 -15
- data/sig/modern_treasury/resources/ledger_event_handlers.rbs +0 -7
- data/sig/modern_treasury/resources/ledgerable_events.rbs +0 -7
- data/sig/modern_treasury/resources/paper_items.rbs +0 -21
|
@@ -13,6 +13,12 @@ module ModernTreasury
|
|
|
13
13
|
# @return [String, nil]
|
|
14
14
|
required :name, String, nil?: true
|
|
15
15
|
|
|
16
|
+
# @!attribute body_external_id
|
|
17
|
+
# An optional user-defined 180 character unique identifier.
|
|
18
|
+
#
|
|
19
|
+
# @return [String, nil]
|
|
20
|
+
optional :body_external_id, String, api_name: :external_id, nil?: true
|
|
21
|
+
|
|
16
22
|
# @!attribute accounting
|
|
17
23
|
#
|
|
18
24
|
# @return [ModernTreasury::Models::CounterpartyCreateParams::Accounting, nil]
|
|
@@ -79,12 +85,14 @@ module ModernTreasury
|
|
|
79
85
|
# @return [Symbol, ModernTreasury::Models::CounterpartyCreateParams::VerificationStatus, nil]
|
|
80
86
|
optional :verification_status, enum: -> { ModernTreasury::CounterpartyCreateParams::VerificationStatus }
|
|
81
87
|
|
|
82
|
-
# @!method initialize(name:, accounting: nil, accounts: nil, email: nil, ledger_type: nil, legal_entity: nil, legal_entity_id: nil, metadata: nil, send_remittance_advice: nil, taxpayer_identifier: nil, verification_status: nil, request_options: {})
|
|
88
|
+
# @!method initialize(name:, body_external_id: nil, accounting: nil, accounts: nil, email: nil, ledger_type: nil, legal_entity: nil, legal_entity_id: nil, metadata: nil, send_remittance_advice: nil, taxpayer_identifier: nil, verification_status: nil, request_options: {})
|
|
83
89
|
# Some parameter documentations has been truncated, see
|
|
84
90
|
# {ModernTreasury::Models::CounterpartyCreateParams} for more details.
|
|
85
91
|
#
|
|
86
92
|
# @param name [String, nil] A human friendly name for this counterparty.
|
|
87
93
|
#
|
|
94
|
+
# @param body_external_id [String, nil] An optional user-defined 180 character unique identifier.
|
|
95
|
+
#
|
|
88
96
|
# @param accounting [ModernTreasury::Models::CounterpartyCreateParams::Accounting]
|
|
89
97
|
#
|
|
90
98
|
# @param accounts [Array<ModernTreasury::Models::CounterpartyCreateParams::Account>] The accounts for this counterparty.
|
|
@@ -153,11 +161,15 @@ module ModernTreasury
|
|
|
153
161
|
|
|
154
162
|
# @!attribute contact_details
|
|
155
163
|
#
|
|
156
|
-
# @return [Array<ModernTreasury::Models::
|
|
164
|
+
# @return [Array<ModernTreasury::Models::ContactDetailCreateRequest>, nil]
|
|
157
165
|
optional :contact_details,
|
|
158
|
-
-> {
|
|
159
|
-
|
|
160
|
-
|
|
166
|
+
-> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::ContactDetailCreateRequest] }
|
|
167
|
+
|
|
168
|
+
# @!attribute external_id
|
|
169
|
+
# An optional user-defined 180 character unique identifier.
|
|
170
|
+
#
|
|
171
|
+
# @return [String, nil]
|
|
172
|
+
optional :external_id, String, nil?: true
|
|
161
173
|
|
|
162
174
|
# @!attribute ledger_account
|
|
163
175
|
# Specifies a ledger account object that will be created with the external
|
|
@@ -166,8 +178,8 @@ module ModernTreasury
|
|
|
166
178
|
# https://docs.moderntreasury.com/docs/linking-to-other-modern-treasury-objects
|
|
167
179
|
# for more details.
|
|
168
180
|
#
|
|
169
|
-
# @return [ModernTreasury::Models::
|
|
170
|
-
optional :ledger_account, -> { ModernTreasury::
|
|
181
|
+
# @return [ModernTreasury::Models::LedgerAccountCreateRequest, nil]
|
|
182
|
+
optional :ledger_account, -> { ModernTreasury::LedgerAccountCreateRequest }
|
|
171
183
|
|
|
172
184
|
# @!attribute metadata
|
|
173
185
|
# Additional data represented as key-value pairs. Both the key and value must be
|
|
@@ -186,8 +198,8 @@ module ModernTreasury
|
|
|
186
198
|
# @!attribute party_address
|
|
187
199
|
# Required if receiving wire payments.
|
|
188
200
|
#
|
|
189
|
-
# @return [ModernTreasury::Models::
|
|
190
|
-
optional :party_address, -> { ModernTreasury::
|
|
201
|
+
# @return [ModernTreasury::Models::AddressRequest, nil]
|
|
202
|
+
optional :party_address, -> { ModernTreasury::AddressRequest }
|
|
191
203
|
|
|
192
204
|
# @!attribute party_identifier
|
|
193
205
|
#
|
|
@@ -223,7 +235,7 @@ module ModernTreasury
|
|
|
223
235
|
ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::CounterpartyCreateParams::Account::RoutingDetail]
|
|
224
236
|
}
|
|
225
237
|
|
|
226
|
-
# @!method initialize(account_details: nil, account_type: nil, contact_details: nil, ledger_account: nil, metadata: nil, name: nil, party_address: nil, party_identifier: nil, party_name: nil, party_type: nil, plaid_processor_token: nil, routing_details: nil)
|
|
238
|
+
# @!method initialize(account_details: nil, account_type: nil, contact_details: nil, external_id: nil, ledger_account: nil, metadata: nil, name: nil, party_address: nil, party_identifier: nil, party_name: nil, party_type: nil, plaid_processor_token: nil, routing_details: nil)
|
|
227
239
|
# Some parameter documentations has been truncated, see
|
|
228
240
|
# {ModernTreasury::Models::CounterpartyCreateParams::Account} for more details.
|
|
229
241
|
#
|
|
@@ -231,15 +243,17 @@ module ModernTreasury
|
|
|
231
243
|
#
|
|
232
244
|
# @param account_type [Symbol, ModernTreasury::Models::ExternalAccountType] Can be `checking`, `savings` or `other`.
|
|
233
245
|
#
|
|
234
|
-
# @param contact_details [Array<ModernTreasury::Models::
|
|
246
|
+
# @param contact_details [Array<ModernTreasury::Models::ContactDetailCreateRequest>]
|
|
235
247
|
#
|
|
236
|
-
# @param
|
|
248
|
+
# @param external_id [String, nil] An optional user-defined 180 character unique identifier.
|
|
249
|
+
#
|
|
250
|
+
# @param ledger_account [ModernTreasury::Models::LedgerAccountCreateRequest] Specifies a ledger account object that will be created with the external account
|
|
237
251
|
#
|
|
238
252
|
# @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
|
|
239
253
|
#
|
|
240
254
|
# @param name [String, nil] A nickname for the external account. This is only for internal usage and won't a
|
|
241
255
|
#
|
|
242
|
-
# @param party_address [ModernTreasury::Models::
|
|
256
|
+
# @param party_address [ModernTreasury::Models::AddressRequest] Required if receiving wire payments.
|
|
243
257
|
#
|
|
244
258
|
# @param party_identifier [String]
|
|
245
259
|
#
|
|
@@ -293,208 +307,6 @@ module ModernTreasury
|
|
|
293
307
|
end
|
|
294
308
|
end
|
|
295
309
|
|
|
296
|
-
class ContactDetail < ModernTreasury::Internal::Type::BaseModel
|
|
297
|
-
# @!attribute contact_identifier
|
|
298
|
-
#
|
|
299
|
-
# @return [String, nil]
|
|
300
|
-
optional :contact_identifier, String
|
|
301
|
-
|
|
302
|
-
# @!attribute contact_identifier_type
|
|
303
|
-
#
|
|
304
|
-
# @return [Symbol, ModernTreasury::Models::CounterpartyCreateParams::Account::ContactDetail::ContactIdentifierType, nil]
|
|
305
|
-
optional :contact_identifier_type,
|
|
306
|
-
enum: -> {
|
|
307
|
-
ModernTreasury::CounterpartyCreateParams::Account::ContactDetail::ContactIdentifierType
|
|
308
|
-
}
|
|
309
|
-
|
|
310
|
-
# @!method initialize(contact_identifier: nil, contact_identifier_type: nil)
|
|
311
|
-
# @param contact_identifier [String]
|
|
312
|
-
# @param contact_identifier_type [Symbol, ModernTreasury::Models::CounterpartyCreateParams::Account::ContactDetail::ContactIdentifierType]
|
|
313
|
-
|
|
314
|
-
# @see ModernTreasury::Models::CounterpartyCreateParams::Account::ContactDetail#contact_identifier_type
|
|
315
|
-
module ContactIdentifierType
|
|
316
|
-
extend ModernTreasury::Internal::Type::Enum
|
|
317
|
-
|
|
318
|
-
EMAIL = :email
|
|
319
|
-
PHONE_NUMBER = :phone_number
|
|
320
|
-
WEBSITE = :website
|
|
321
|
-
|
|
322
|
-
# @!method self.values
|
|
323
|
-
# @return [Array<Symbol>]
|
|
324
|
-
end
|
|
325
|
-
end
|
|
326
|
-
|
|
327
|
-
# @see ModernTreasury::Models::CounterpartyCreateParams::Account#ledger_account
|
|
328
|
-
class LedgerAccount < ModernTreasury::Internal::Type::BaseModel
|
|
329
|
-
# @!attribute currency
|
|
330
|
-
# The currency of the ledger account.
|
|
331
|
-
#
|
|
332
|
-
# @return [String]
|
|
333
|
-
required :currency, String
|
|
334
|
-
|
|
335
|
-
# @!attribute ledger_id
|
|
336
|
-
# The id of the ledger that this account belongs to.
|
|
337
|
-
#
|
|
338
|
-
# @return [String]
|
|
339
|
-
required :ledger_id, String
|
|
340
|
-
|
|
341
|
-
# @!attribute name
|
|
342
|
-
# The name of the ledger account.
|
|
343
|
-
#
|
|
344
|
-
# @return [String]
|
|
345
|
-
required :name, String
|
|
346
|
-
|
|
347
|
-
# @!attribute normal_balance
|
|
348
|
-
# The normal balance of the ledger account.
|
|
349
|
-
#
|
|
350
|
-
# @return [Symbol, ModernTreasury::Models::TransactionDirection]
|
|
351
|
-
required :normal_balance, enum: -> { ModernTreasury::TransactionDirection }
|
|
352
|
-
|
|
353
|
-
# @!attribute currency_exponent
|
|
354
|
-
# The currency exponent of the ledger account.
|
|
355
|
-
#
|
|
356
|
-
# @return [Integer, nil]
|
|
357
|
-
optional :currency_exponent, Integer, nil?: true
|
|
358
|
-
|
|
359
|
-
# @!attribute description
|
|
360
|
-
# The description of the ledger account.
|
|
361
|
-
#
|
|
362
|
-
# @return [String, nil]
|
|
363
|
-
optional :description, String, nil?: true
|
|
364
|
-
|
|
365
|
-
# @!attribute ledger_account_category_ids
|
|
366
|
-
# The array of ledger account category ids that this ledger account should be a
|
|
367
|
-
# child of.
|
|
368
|
-
#
|
|
369
|
-
# @return [Array<String>, nil]
|
|
370
|
-
optional :ledger_account_category_ids, ModernTreasury::Internal::Type::ArrayOf[String]
|
|
371
|
-
|
|
372
|
-
# @!attribute ledgerable_id
|
|
373
|
-
# If the ledger account links to another object in Modern Treasury, the id will be
|
|
374
|
-
# populated here, otherwise null.
|
|
375
|
-
#
|
|
376
|
-
# @return [String, nil]
|
|
377
|
-
optional :ledgerable_id, String
|
|
378
|
-
|
|
379
|
-
# @!attribute ledgerable_type
|
|
380
|
-
# If the ledger account links to another object in Modern Treasury, the type will
|
|
381
|
-
# be populated here, otherwise null. The value is one of internal_account or
|
|
382
|
-
# external_account.
|
|
383
|
-
#
|
|
384
|
-
# @return [Symbol, ModernTreasury::Models::CounterpartyCreateParams::Account::LedgerAccount::LedgerableType, nil]
|
|
385
|
-
optional :ledgerable_type,
|
|
386
|
-
enum: -> {
|
|
387
|
-
ModernTreasury::CounterpartyCreateParams::Account::LedgerAccount::LedgerableType
|
|
388
|
-
}
|
|
389
|
-
|
|
390
|
-
# @!attribute metadata
|
|
391
|
-
# Additional data represented as key-value pairs. Both the key and value must be
|
|
392
|
-
# strings.
|
|
393
|
-
#
|
|
394
|
-
# @return [Hash{Symbol=>String}, nil]
|
|
395
|
-
optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
|
|
396
|
-
|
|
397
|
-
# @!method initialize(currency:, ledger_id:, name:, normal_balance:, currency_exponent: nil, description: nil, ledger_account_category_ids: nil, ledgerable_id: nil, ledgerable_type: nil, metadata: nil)
|
|
398
|
-
# Some parameter documentations has been truncated, see
|
|
399
|
-
# {ModernTreasury::Models::CounterpartyCreateParams::Account::LedgerAccount} for
|
|
400
|
-
# more details.
|
|
401
|
-
#
|
|
402
|
-
# Specifies a ledger account object that will be created with the external
|
|
403
|
-
# account. The resulting ledger account is linked to the external account for
|
|
404
|
-
# auto-ledgering Payment objects. See
|
|
405
|
-
# https://docs.moderntreasury.com/docs/linking-to-other-modern-treasury-objects
|
|
406
|
-
# for more details.
|
|
407
|
-
#
|
|
408
|
-
# @param currency [String] The currency of the ledger account.
|
|
409
|
-
#
|
|
410
|
-
# @param ledger_id [String] The id of the ledger that this account belongs to.
|
|
411
|
-
#
|
|
412
|
-
# @param name [String] The name of the ledger account.
|
|
413
|
-
#
|
|
414
|
-
# @param normal_balance [Symbol, ModernTreasury::Models::TransactionDirection] The normal balance of the ledger account.
|
|
415
|
-
#
|
|
416
|
-
# @param currency_exponent [Integer, nil] The currency exponent of the ledger account.
|
|
417
|
-
#
|
|
418
|
-
# @param description [String, nil] The description of the ledger account.
|
|
419
|
-
#
|
|
420
|
-
# @param ledger_account_category_ids [Array<String>] The array of ledger account category ids that this ledger account should be a ch
|
|
421
|
-
#
|
|
422
|
-
# @param ledgerable_id [String] If the ledger account links to another object in Modern Treasury, the id will be
|
|
423
|
-
#
|
|
424
|
-
# @param ledgerable_type [Symbol, ModernTreasury::Models::CounterpartyCreateParams::Account::LedgerAccount::LedgerableType] If the ledger account links to another object in Modern Treasury, the type will
|
|
425
|
-
#
|
|
426
|
-
# @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
|
|
427
|
-
|
|
428
|
-
# If the ledger account links to another object in Modern Treasury, the type will
|
|
429
|
-
# be populated here, otherwise null. The value is one of internal_account or
|
|
430
|
-
# external_account.
|
|
431
|
-
#
|
|
432
|
-
# @see ModernTreasury::Models::CounterpartyCreateParams::Account::LedgerAccount#ledgerable_type
|
|
433
|
-
module LedgerableType
|
|
434
|
-
extend ModernTreasury::Internal::Type::Enum
|
|
435
|
-
|
|
436
|
-
COUNTERPARTY = :counterparty
|
|
437
|
-
EXTERNAL_ACCOUNT = :external_account
|
|
438
|
-
INTERNAL_ACCOUNT = :internal_account
|
|
439
|
-
VIRTUAL_ACCOUNT = :virtual_account
|
|
440
|
-
|
|
441
|
-
# @!method self.values
|
|
442
|
-
# @return [Array<Symbol>]
|
|
443
|
-
end
|
|
444
|
-
end
|
|
445
|
-
|
|
446
|
-
# @see ModernTreasury::Models::CounterpartyCreateParams::Account#party_address
|
|
447
|
-
class PartyAddress < ModernTreasury::Internal::Type::BaseModel
|
|
448
|
-
# @!attribute country
|
|
449
|
-
# Country code conforms to [ISO 3166-1 alpha-2]
|
|
450
|
-
#
|
|
451
|
-
# @return [String, nil]
|
|
452
|
-
optional :country, String, nil?: true
|
|
453
|
-
|
|
454
|
-
# @!attribute line1
|
|
455
|
-
#
|
|
456
|
-
# @return [String, nil]
|
|
457
|
-
optional :line1, String, nil?: true
|
|
458
|
-
|
|
459
|
-
# @!attribute line2
|
|
460
|
-
#
|
|
461
|
-
# @return [String, nil]
|
|
462
|
-
optional :line2, String, nil?: true
|
|
463
|
-
|
|
464
|
-
# @!attribute locality
|
|
465
|
-
# Locality or City.
|
|
466
|
-
#
|
|
467
|
-
# @return [String, nil]
|
|
468
|
-
optional :locality, String, nil?: true
|
|
469
|
-
|
|
470
|
-
# @!attribute postal_code
|
|
471
|
-
# The postal code of the address.
|
|
472
|
-
#
|
|
473
|
-
# @return [String, nil]
|
|
474
|
-
optional :postal_code, String, nil?: true
|
|
475
|
-
|
|
476
|
-
# @!attribute region
|
|
477
|
-
# Region or State.
|
|
478
|
-
#
|
|
479
|
-
# @return [String, nil]
|
|
480
|
-
optional :region, String, nil?: true
|
|
481
|
-
|
|
482
|
-
# @!method initialize(country: nil, line1: nil, line2: nil, locality: nil, postal_code: nil, region: nil)
|
|
483
|
-
# Required if receiving wire payments.
|
|
484
|
-
#
|
|
485
|
-
# @param country [String, nil] Country code conforms to [ISO 3166-1 alpha-2]
|
|
486
|
-
#
|
|
487
|
-
# @param line1 [String, nil]
|
|
488
|
-
#
|
|
489
|
-
# @param line2 [String, nil]
|
|
490
|
-
#
|
|
491
|
-
# @param locality [String, nil] Locality or City.
|
|
492
|
-
#
|
|
493
|
-
# @param postal_code [String, nil] The postal code of the address.
|
|
494
|
-
#
|
|
495
|
-
# @param region [String, nil] Region or State.
|
|
496
|
-
end
|
|
497
|
-
|
|
498
310
|
# Either `individual` or `business`.
|
|
499
311
|
#
|
|
500
312
|
# @see ModernTreasury::Models::CounterpartyCreateParams::Account#party_type
|
|
@@ -634,10 +446,10 @@ module ModernTreasury
|
|
|
634
446
|
# @!attribute addresses
|
|
635
447
|
# A list of addresses for the entity.
|
|
636
448
|
#
|
|
637
|
-
# @return [Array<ModernTreasury::Models::
|
|
449
|
+
# @return [Array<ModernTreasury::Models::LegalEntityAddressCreateRequest>, nil]
|
|
638
450
|
optional :addresses,
|
|
639
451
|
-> {
|
|
640
|
-
ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::
|
|
452
|
+
ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::LegalEntityAddressCreateRequest]
|
|
641
453
|
}
|
|
642
454
|
|
|
643
455
|
# @!attribute bank_settings
|
|
@@ -694,11 +506,9 @@ module ModernTreasury
|
|
|
694
506
|
# @!attribute identifications
|
|
695
507
|
# A list of identifications for the legal entity.
|
|
696
508
|
#
|
|
697
|
-
# @return [Array<ModernTreasury::Models::
|
|
509
|
+
# @return [Array<ModernTreasury::Models::IdentificationCreateRequest>, nil]
|
|
698
510
|
optional :identifications,
|
|
699
|
-
-> {
|
|
700
|
-
ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::CounterpartyCreateParams::LegalEntity::Identification]
|
|
701
|
-
}
|
|
511
|
+
-> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::IdentificationCreateRequest] }
|
|
702
512
|
|
|
703
513
|
# @!attribute industry_classifications
|
|
704
514
|
# A list of industry classifications for the legal entity.
|
|
@@ -804,7 +614,7 @@ module ModernTreasury
|
|
|
804
614
|
#
|
|
805
615
|
# @param legal_entity_type [Symbol, ModernTreasury::Models::CounterpartyCreateParams::LegalEntity::LegalEntityType] The type of legal entity.
|
|
806
616
|
#
|
|
807
|
-
# @param addresses [Array<ModernTreasury::Models::
|
|
617
|
+
# @param addresses [Array<ModernTreasury::Models::LegalEntityAddressCreateRequest>] A list of addresses for the entity.
|
|
808
618
|
#
|
|
809
619
|
# @param bank_settings [ModernTreasury::Models::BankSettings, nil]
|
|
810
620
|
#
|
|
@@ -824,7 +634,7 @@ module ModernTreasury
|
|
|
824
634
|
#
|
|
825
635
|
# @param first_name [String, nil] An individual's first name.
|
|
826
636
|
#
|
|
827
|
-
# @param identifications [Array<ModernTreasury::Models::
|
|
637
|
+
# @param identifications [Array<ModernTreasury::Models::IdentificationCreateRequest>] A list of identifications for the legal entity.
|
|
828
638
|
#
|
|
829
639
|
# @param industry_classifications [Array<ModernTreasury::Models::LegalEntityIndustryClassification>] A list of industry classifications for the legal entity.
|
|
830
640
|
#
|
|
@@ -867,162 +677,6 @@ module ModernTreasury
|
|
|
867
677
|
# @return [Array<Symbol>]
|
|
868
678
|
end
|
|
869
679
|
|
|
870
|
-
class Address < ModernTreasury::Internal::Type::BaseModel
|
|
871
|
-
# @!attribute country
|
|
872
|
-
# Country code conforms to [ISO 3166-1 alpha-2]
|
|
873
|
-
#
|
|
874
|
-
# @return [String, nil]
|
|
875
|
-
required :country, String, nil?: true
|
|
876
|
-
|
|
877
|
-
# @!attribute line1
|
|
878
|
-
#
|
|
879
|
-
# @return [String, nil]
|
|
880
|
-
required :line1, String, nil?: true
|
|
881
|
-
|
|
882
|
-
# @!attribute locality
|
|
883
|
-
# Locality or City.
|
|
884
|
-
#
|
|
885
|
-
# @return [String, nil]
|
|
886
|
-
required :locality, String, nil?: true
|
|
887
|
-
|
|
888
|
-
# @!attribute postal_code
|
|
889
|
-
# The postal code of the address.
|
|
890
|
-
#
|
|
891
|
-
# @return [String, nil]
|
|
892
|
-
required :postal_code, String, nil?: true
|
|
893
|
-
|
|
894
|
-
# @!attribute region
|
|
895
|
-
# Region or State.
|
|
896
|
-
#
|
|
897
|
-
# @return [String, nil]
|
|
898
|
-
required :region, String, nil?: true
|
|
899
|
-
|
|
900
|
-
# @!attribute address_types
|
|
901
|
-
# The types of this address.
|
|
902
|
-
#
|
|
903
|
-
# @return [Array<Symbol, ModernTreasury::Models::CounterpartyCreateParams::LegalEntity::Address::AddressType>, nil]
|
|
904
|
-
optional :address_types,
|
|
905
|
-
-> {
|
|
906
|
-
ModernTreasury::Internal::Type::ArrayOf[enum: ModernTreasury::CounterpartyCreateParams::LegalEntity::Address::AddressType]
|
|
907
|
-
}
|
|
908
|
-
|
|
909
|
-
# @!attribute line2
|
|
910
|
-
#
|
|
911
|
-
# @return [String, nil]
|
|
912
|
-
optional :line2, String, nil?: true
|
|
913
|
-
|
|
914
|
-
# @!method initialize(country:, line1:, locality:, postal_code:, region:, address_types: nil, line2: nil)
|
|
915
|
-
# @param country [String, nil] Country code conforms to [ISO 3166-1 alpha-2]
|
|
916
|
-
#
|
|
917
|
-
# @param line1 [String, nil]
|
|
918
|
-
#
|
|
919
|
-
# @param locality [String, nil] Locality or City.
|
|
920
|
-
#
|
|
921
|
-
# @param postal_code [String, nil] The postal code of the address.
|
|
922
|
-
#
|
|
923
|
-
# @param region [String, nil] Region or State.
|
|
924
|
-
#
|
|
925
|
-
# @param address_types [Array<Symbol, ModernTreasury::Models::CounterpartyCreateParams::LegalEntity::Address::AddressType>] The types of this address.
|
|
926
|
-
#
|
|
927
|
-
# @param line2 [String, nil]
|
|
928
|
-
|
|
929
|
-
module AddressType
|
|
930
|
-
extend ModernTreasury::Internal::Type::Enum
|
|
931
|
-
|
|
932
|
-
BUSINESS = :business
|
|
933
|
-
MAILING = :mailing
|
|
934
|
-
OTHER = :other
|
|
935
|
-
PO_BOX = :po_box
|
|
936
|
-
RESIDENTIAL = :residential
|
|
937
|
-
|
|
938
|
-
# @!method self.values
|
|
939
|
-
# @return [Array<Symbol>]
|
|
940
|
-
end
|
|
941
|
-
end
|
|
942
|
-
|
|
943
|
-
class Identification < ModernTreasury::Internal::Type::BaseModel
|
|
944
|
-
# @!attribute id_number
|
|
945
|
-
# The ID number of identification document.
|
|
946
|
-
#
|
|
947
|
-
# @return [String]
|
|
948
|
-
required :id_number, String
|
|
949
|
-
|
|
950
|
-
# @!attribute id_type
|
|
951
|
-
# The type of ID number.
|
|
952
|
-
#
|
|
953
|
-
# @return [Symbol, ModernTreasury::Models::CounterpartyCreateParams::LegalEntity::Identification::IDType]
|
|
954
|
-
required :id_type,
|
|
955
|
-
enum: -> { ModernTreasury::CounterpartyCreateParams::LegalEntity::Identification::IDType }
|
|
956
|
-
|
|
957
|
-
# @!attribute expiration_date
|
|
958
|
-
# The date when the Identification is no longer considered valid by the issuing
|
|
959
|
-
# authority.
|
|
960
|
-
#
|
|
961
|
-
# @return [Date, nil]
|
|
962
|
-
optional :expiration_date, Date, nil?: true
|
|
963
|
-
|
|
964
|
-
# @!attribute issuing_country
|
|
965
|
-
# The ISO 3166-1 alpha-2 country code of the country that issued the
|
|
966
|
-
# identification
|
|
967
|
-
#
|
|
968
|
-
# @return [String, nil]
|
|
969
|
-
optional :issuing_country, String, nil?: true
|
|
970
|
-
|
|
971
|
-
# @!attribute issuing_region
|
|
972
|
-
# The region in which the identifcation was issued.
|
|
973
|
-
#
|
|
974
|
-
# @return [String, nil]
|
|
975
|
-
optional :issuing_region, String, nil?: true
|
|
976
|
-
|
|
977
|
-
# @!method initialize(id_number:, id_type:, expiration_date: nil, issuing_country: nil, issuing_region: nil)
|
|
978
|
-
# Some parameter documentations has been truncated, see
|
|
979
|
-
# {ModernTreasury::Models::CounterpartyCreateParams::LegalEntity::Identification}
|
|
980
|
-
# for more details.
|
|
981
|
-
#
|
|
982
|
-
# @param id_number [String] The ID number of identification document.
|
|
983
|
-
#
|
|
984
|
-
# @param id_type [Symbol, ModernTreasury::Models::CounterpartyCreateParams::LegalEntity::Identification::IDType] The type of ID number.
|
|
985
|
-
#
|
|
986
|
-
# @param expiration_date [Date, nil] The date when the Identification is no longer considered valid by the issuing au
|
|
987
|
-
#
|
|
988
|
-
# @param issuing_country [String, nil] The ISO 3166-1 alpha-2 country code of the country that issued the identificatio
|
|
989
|
-
#
|
|
990
|
-
# @param issuing_region [String, nil] The region in which the identifcation was issued.
|
|
991
|
-
|
|
992
|
-
# The type of ID number.
|
|
993
|
-
#
|
|
994
|
-
# @see ModernTreasury::Models::CounterpartyCreateParams::LegalEntity::Identification#id_type
|
|
995
|
-
module IDType
|
|
996
|
-
extend ModernTreasury::Internal::Type::Enum
|
|
997
|
-
|
|
998
|
-
AR_CUIL = :ar_cuil
|
|
999
|
-
AR_CUIT = :ar_cuit
|
|
1000
|
-
BR_CNPJ = :br_cnpj
|
|
1001
|
-
BR_CPF = :br_cpf
|
|
1002
|
-
CL_RUN = :cl_run
|
|
1003
|
-
CL_RUT = :cl_rut
|
|
1004
|
-
CO_CEDULAS = :co_cedulas
|
|
1005
|
-
CO_NIT = :co_nit
|
|
1006
|
-
DRIVERS_LICENSE = :drivers_license
|
|
1007
|
-
HN_ID = :hn_id
|
|
1008
|
-
HN_RTN = :hn_rtn
|
|
1009
|
-
IN_LEI = :in_lei
|
|
1010
|
-
KR_BRN = :kr_brn
|
|
1011
|
-
KR_CRN = :kr_crn
|
|
1012
|
-
KR_RRN = :kr_rrn
|
|
1013
|
-
PASSPORT = :passport
|
|
1014
|
-
SA_TIN = :sa_tin
|
|
1015
|
-
SA_VAT = :sa_vat
|
|
1016
|
-
US_EIN = :us_ein
|
|
1017
|
-
US_ITIN = :us_itin
|
|
1018
|
-
US_SSN = :us_ssn
|
|
1019
|
-
VN_TIN = :vn_tin
|
|
1020
|
-
|
|
1021
|
-
# @!method self.values
|
|
1022
|
-
# @return [Array<Symbol>]
|
|
1023
|
-
end
|
|
1024
|
-
end
|
|
1025
|
-
|
|
1026
680
|
class LegalEntityAssociation < ModernTreasury::Internal::Type::BaseModel
|
|
1027
681
|
# @!attribute relationship_types
|
|
1028
682
|
#
|
|
@@ -1035,11 +689,8 @@ module ModernTreasury
|
|
|
1035
689
|
# @!attribute child_legal_entity
|
|
1036
690
|
# The child legal entity.
|
|
1037
691
|
#
|
|
1038
|
-
# @return [ModernTreasury::Models::
|
|
1039
|
-
optional :child_legal_entity,
|
|
1040
|
-
-> {
|
|
1041
|
-
ModernTreasury::CounterpartyCreateParams::LegalEntity::LegalEntityAssociation::ChildLegalEntity
|
|
1042
|
-
}
|
|
692
|
+
# @return [ModernTreasury::Models::ChildLegalEntityCreate, nil]
|
|
693
|
+
optional :child_legal_entity, -> { ModernTreasury::ChildLegalEntityCreate }
|
|
1043
694
|
|
|
1044
695
|
# @!attribute child_legal_entity_id
|
|
1045
696
|
# The ID of the child legal entity.
|
|
@@ -1062,7 +713,7 @@ module ModernTreasury
|
|
|
1062
713
|
# @!method initialize(relationship_types:, child_legal_entity: nil, child_legal_entity_id: nil, ownership_percentage: nil, title: nil)
|
|
1063
714
|
# @param relationship_types [Array<Symbol, ModernTreasury::Models::CounterpartyCreateParams::LegalEntity::LegalEntityAssociation::RelationshipType>]
|
|
1064
715
|
#
|
|
1065
|
-
# @param child_legal_entity [ModernTreasury::Models::
|
|
716
|
+
# @param child_legal_entity [ModernTreasury::Models::ChildLegalEntityCreate] The child legal entity.
|
|
1066
717
|
#
|
|
1067
718
|
# @param child_legal_entity_id [String] The ID of the child legal entity.
|
|
1068
719
|
#
|
|
@@ -1074,465 +725,13 @@ module ModernTreasury
|
|
|
1074
725
|
module RelationshipType
|
|
1075
726
|
extend ModernTreasury::Internal::Type::Enum
|
|
1076
727
|
|
|
728
|
+
AUTHORIZED_SIGNER = :authorized_signer
|
|
1077
729
|
BENEFICIAL_OWNER = :beneficial_owner
|
|
1078
730
|
CONTROL_PERSON = :control_person
|
|
1079
731
|
|
|
1080
732
|
# @!method self.values
|
|
1081
733
|
# @return [Array<Symbol>]
|
|
1082
734
|
end
|
|
1083
|
-
|
|
1084
|
-
# @see ModernTreasury::Models::CounterpartyCreateParams::LegalEntity::LegalEntityAssociation#child_legal_entity
|
|
1085
|
-
class ChildLegalEntity < ModernTreasury::Internal::Type::BaseModel
|
|
1086
|
-
# @!attribute addresses
|
|
1087
|
-
# A list of addresses for the entity.
|
|
1088
|
-
#
|
|
1089
|
-
# @return [Array<ModernTreasury::Models::CounterpartyCreateParams::LegalEntity::LegalEntityAssociation::ChildLegalEntity::Address>, nil]
|
|
1090
|
-
optional :addresses,
|
|
1091
|
-
-> {
|
|
1092
|
-
ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::CounterpartyCreateParams::LegalEntity::LegalEntityAssociation::ChildLegalEntity::Address]
|
|
1093
|
-
}
|
|
1094
|
-
|
|
1095
|
-
# @!attribute bank_settings
|
|
1096
|
-
#
|
|
1097
|
-
# @return [ModernTreasury::Models::BankSettings, nil]
|
|
1098
|
-
optional :bank_settings, -> { ModernTreasury::BankSettings }, nil?: true
|
|
1099
|
-
|
|
1100
|
-
# @!attribute business_name
|
|
1101
|
-
# The business's legal business name.
|
|
1102
|
-
#
|
|
1103
|
-
# @return [String, nil]
|
|
1104
|
-
optional :business_name, String, nil?: true
|
|
1105
|
-
|
|
1106
|
-
# @!attribute citizenship_country
|
|
1107
|
-
# The country of citizenship for an individual.
|
|
1108
|
-
#
|
|
1109
|
-
# @return [String, nil]
|
|
1110
|
-
optional :citizenship_country, String, nil?: true
|
|
1111
|
-
|
|
1112
|
-
# @!attribute compliance_details
|
|
1113
|
-
#
|
|
1114
|
-
# @return [ModernTreasury::Models::LegalEntityComplianceDetail, nil]
|
|
1115
|
-
optional :compliance_details, -> { ModernTreasury::LegalEntityComplianceDetail }, nil?: true
|
|
1116
|
-
|
|
1117
|
-
# @!attribute date_formed
|
|
1118
|
-
# A business's formation date (YYYY-MM-DD).
|
|
1119
|
-
#
|
|
1120
|
-
# @return [Date, nil]
|
|
1121
|
-
optional :date_formed, Date, nil?: true
|
|
1122
|
-
|
|
1123
|
-
# @!attribute date_of_birth
|
|
1124
|
-
# An individual's date of birth (YYYY-MM-DD).
|
|
1125
|
-
#
|
|
1126
|
-
# @return [Date, nil]
|
|
1127
|
-
optional :date_of_birth, Date, nil?: true
|
|
1128
|
-
|
|
1129
|
-
# @!attribute doing_business_as_names
|
|
1130
|
-
#
|
|
1131
|
-
# @return [Array<String>, nil]
|
|
1132
|
-
optional :doing_business_as_names, ModernTreasury::Internal::Type::ArrayOf[String]
|
|
1133
|
-
|
|
1134
|
-
# @!attribute email
|
|
1135
|
-
# The entity's primary email.
|
|
1136
|
-
#
|
|
1137
|
-
# @return [String, nil]
|
|
1138
|
-
optional :email, String, nil?: true
|
|
1139
|
-
|
|
1140
|
-
# @!attribute first_name
|
|
1141
|
-
# An individual's first name.
|
|
1142
|
-
#
|
|
1143
|
-
# @return [String, nil]
|
|
1144
|
-
optional :first_name, String, nil?: true
|
|
1145
|
-
|
|
1146
|
-
# @!attribute identifications
|
|
1147
|
-
# A list of identifications for the legal entity.
|
|
1148
|
-
#
|
|
1149
|
-
# @return [Array<ModernTreasury::Models::CounterpartyCreateParams::LegalEntity::LegalEntityAssociation::ChildLegalEntity::Identification>, nil]
|
|
1150
|
-
optional :identifications,
|
|
1151
|
-
-> do
|
|
1152
|
-
ModernTreasury::Internal::Type::ArrayOf[
|
|
1153
|
-
ModernTreasury::CounterpartyCreateParams::LegalEntity::LegalEntityAssociation::ChildLegalEntity::Identification
|
|
1154
|
-
]
|
|
1155
|
-
end
|
|
1156
|
-
|
|
1157
|
-
# @!attribute industry_classifications
|
|
1158
|
-
# A list of industry classifications for the legal entity.
|
|
1159
|
-
#
|
|
1160
|
-
# @return [Array<ModernTreasury::Models::LegalEntityIndustryClassification>, nil]
|
|
1161
|
-
optional :industry_classifications,
|
|
1162
|
-
-> {
|
|
1163
|
-
ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::LegalEntityIndustryClassification]
|
|
1164
|
-
}
|
|
1165
|
-
|
|
1166
|
-
# @!attribute last_name
|
|
1167
|
-
# An individual's last name.
|
|
1168
|
-
#
|
|
1169
|
-
# @return [String, nil]
|
|
1170
|
-
optional :last_name, String, nil?: true
|
|
1171
|
-
|
|
1172
|
-
# @!attribute legal_entity_type
|
|
1173
|
-
# The type of legal entity.
|
|
1174
|
-
#
|
|
1175
|
-
# @return [Symbol, ModernTreasury::Models::CounterpartyCreateParams::LegalEntity::LegalEntityAssociation::ChildLegalEntity::LegalEntityType, nil]
|
|
1176
|
-
optional :legal_entity_type,
|
|
1177
|
-
enum: -> {
|
|
1178
|
-
ModernTreasury::CounterpartyCreateParams::LegalEntity::LegalEntityAssociation::ChildLegalEntity::LegalEntityType
|
|
1179
|
-
}
|
|
1180
|
-
|
|
1181
|
-
# @!attribute legal_structure
|
|
1182
|
-
# The business's legal structure.
|
|
1183
|
-
#
|
|
1184
|
-
# @return [Symbol, ModernTreasury::Models::CounterpartyCreateParams::LegalEntity::LegalEntityAssociation::ChildLegalEntity::LegalStructure, nil]
|
|
1185
|
-
optional :legal_structure,
|
|
1186
|
-
enum: -> {
|
|
1187
|
-
ModernTreasury::CounterpartyCreateParams::LegalEntity::LegalEntityAssociation::ChildLegalEntity::LegalStructure
|
|
1188
|
-
},
|
|
1189
|
-
nil?: true
|
|
1190
|
-
|
|
1191
|
-
# @!attribute metadata
|
|
1192
|
-
# Additional data represented as key-value pairs. Both the key and value must be
|
|
1193
|
-
# strings.
|
|
1194
|
-
#
|
|
1195
|
-
# @return [Hash{Symbol=>String}, nil]
|
|
1196
|
-
optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
|
|
1197
|
-
|
|
1198
|
-
# @!attribute middle_name
|
|
1199
|
-
# An individual's middle name.
|
|
1200
|
-
#
|
|
1201
|
-
# @return [String, nil]
|
|
1202
|
-
optional :middle_name, String, nil?: true
|
|
1203
|
-
|
|
1204
|
-
# @!attribute phone_numbers
|
|
1205
|
-
#
|
|
1206
|
-
# @return [Array<ModernTreasury::Models::CounterpartyCreateParams::LegalEntity::LegalEntityAssociation::ChildLegalEntity::PhoneNumber>, nil]
|
|
1207
|
-
optional :phone_numbers,
|
|
1208
|
-
-> do
|
|
1209
|
-
ModernTreasury::Internal::Type::ArrayOf[
|
|
1210
|
-
ModernTreasury::CounterpartyCreateParams::LegalEntity::LegalEntityAssociation::ChildLegalEntity::PhoneNumber
|
|
1211
|
-
]
|
|
1212
|
-
end
|
|
1213
|
-
|
|
1214
|
-
# @!attribute politically_exposed_person
|
|
1215
|
-
# Whether the individual is a politically exposed person.
|
|
1216
|
-
#
|
|
1217
|
-
# @return [Boolean, nil]
|
|
1218
|
-
optional :politically_exposed_person, ModernTreasury::Internal::Type::Boolean, nil?: true
|
|
1219
|
-
|
|
1220
|
-
# @!attribute preferred_name
|
|
1221
|
-
# An individual's preferred name.
|
|
1222
|
-
#
|
|
1223
|
-
# @return [String, nil]
|
|
1224
|
-
optional :preferred_name, String, nil?: true
|
|
1225
|
-
|
|
1226
|
-
# @!attribute prefix
|
|
1227
|
-
# An individual's prefix.
|
|
1228
|
-
#
|
|
1229
|
-
# @return [String, nil]
|
|
1230
|
-
optional :prefix, String, nil?: true
|
|
1231
|
-
|
|
1232
|
-
# @!attribute risk_rating
|
|
1233
|
-
# The risk rating of the legal entity. One of low, medium, high.
|
|
1234
|
-
#
|
|
1235
|
-
# @return [Symbol, ModernTreasury::Models::CounterpartyCreateParams::LegalEntity::LegalEntityAssociation::ChildLegalEntity::RiskRating, nil]
|
|
1236
|
-
optional :risk_rating,
|
|
1237
|
-
enum: -> {
|
|
1238
|
-
ModernTreasury::CounterpartyCreateParams::LegalEntity::LegalEntityAssociation::ChildLegalEntity::RiskRating
|
|
1239
|
-
},
|
|
1240
|
-
nil?: true
|
|
1241
|
-
|
|
1242
|
-
# @!attribute suffix
|
|
1243
|
-
# An individual's suffix.
|
|
1244
|
-
#
|
|
1245
|
-
# @return [String, nil]
|
|
1246
|
-
optional :suffix, String, nil?: true
|
|
1247
|
-
|
|
1248
|
-
# @!attribute wealth_and_employment_details
|
|
1249
|
-
#
|
|
1250
|
-
# @return [ModernTreasury::Models::WealthAndEmploymentDetails, nil]
|
|
1251
|
-
optional :wealth_and_employment_details,
|
|
1252
|
-
-> {
|
|
1253
|
-
ModernTreasury::WealthAndEmploymentDetails
|
|
1254
|
-
},
|
|
1255
|
-
nil?: true
|
|
1256
|
-
|
|
1257
|
-
# @!attribute website
|
|
1258
|
-
# The entity's primary website URL.
|
|
1259
|
-
#
|
|
1260
|
-
# @return [String, nil]
|
|
1261
|
-
optional :website, String, nil?: true
|
|
1262
|
-
|
|
1263
|
-
# @!method initialize(addresses: nil, bank_settings: nil, business_name: nil, citizenship_country: nil, compliance_details: nil, date_formed: nil, date_of_birth: nil, doing_business_as_names: nil, email: nil, first_name: nil, identifications: nil, industry_classifications: nil, last_name: nil, legal_entity_type: nil, legal_structure: nil, metadata: nil, middle_name: nil, phone_numbers: nil, politically_exposed_person: nil, preferred_name: nil, prefix: nil, risk_rating: nil, suffix: nil, wealth_and_employment_details: nil, website: nil)
|
|
1264
|
-
# Some parameter documentations has been truncated, see
|
|
1265
|
-
# {ModernTreasury::Models::CounterpartyCreateParams::LegalEntity::LegalEntityAssociation::ChildLegalEntity}
|
|
1266
|
-
# for more details.
|
|
1267
|
-
#
|
|
1268
|
-
# The child legal entity.
|
|
1269
|
-
#
|
|
1270
|
-
# @param addresses [Array<ModernTreasury::Models::CounterpartyCreateParams::LegalEntity::LegalEntityAssociation::ChildLegalEntity::Address>] A list of addresses for the entity.
|
|
1271
|
-
#
|
|
1272
|
-
# @param bank_settings [ModernTreasury::Models::BankSettings, nil]
|
|
1273
|
-
#
|
|
1274
|
-
# @param business_name [String, nil] The business's legal business name.
|
|
1275
|
-
#
|
|
1276
|
-
# @param citizenship_country [String, nil] The country of citizenship for an individual.
|
|
1277
|
-
#
|
|
1278
|
-
# @param compliance_details [ModernTreasury::Models::LegalEntityComplianceDetail, nil]
|
|
1279
|
-
#
|
|
1280
|
-
# @param date_formed [Date, nil] A business's formation date (YYYY-MM-DD).
|
|
1281
|
-
#
|
|
1282
|
-
# @param date_of_birth [Date, nil] An individual's date of birth (YYYY-MM-DD).
|
|
1283
|
-
#
|
|
1284
|
-
# @param doing_business_as_names [Array<String>]
|
|
1285
|
-
#
|
|
1286
|
-
# @param email [String, nil] The entity's primary email.
|
|
1287
|
-
#
|
|
1288
|
-
# @param first_name [String, nil] An individual's first name.
|
|
1289
|
-
#
|
|
1290
|
-
# @param identifications [Array<ModernTreasury::Models::CounterpartyCreateParams::LegalEntity::LegalEntityAssociation::ChildLegalEntity::Identification>] A list of identifications for the legal entity.
|
|
1291
|
-
#
|
|
1292
|
-
# @param industry_classifications [Array<ModernTreasury::Models::LegalEntityIndustryClassification>] A list of industry classifications for the legal entity.
|
|
1293
|
-
#
|
|
1294
|
-
# @param last_name [String, nil] An individual's last name.
|
|
1295
|
-
#
|
|
1296
|
-
# @param legal_entity_type [Symbol, ModernTreasury::Models::CounterpartyCreateParams::LegalEntity::LegalEntityAssociation::ChildLegalEntity::LegalEntityType] The type of legal entity.
|
|
1297
|
-
#
|
|
1298
|
-
# @param legal_structure [Symbol, ModernTreasury::Models::CounterpartyCreateParams::LegalEntity::LegalEntityAssociation::ChildLegalEntity::LegalStructure, nil] The business's legal structure.
|
|
1299
|
-
#
|
|
1300
|
-
# @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
|
|
1301
|
-
#
|
|
1302
|
-
# @param middle_name [String, nil] An individual's middle name.
|
|
1303
|
-
#
|
|
1304
|
-
# @param phone_numbers [Array<ModernTreasury::Models::CounterpartyCreateParams::LegalEntity::LegalEntityAssociation::ChildLegalEntity::PhoneNumber>]
|
|
1305
|
-
#
|
|
1306
|
-
# @param politically_exposed_person [Boolean, nil] Whether the individual is a politically exposed person.
|
|
1307
|
-
#
|
|
1308
|
-
# @param preferred_name [String, nil] An individual's preferred name.
|
|
1309
|
-
#
|
|
1310
|
-
# @param prefix [String, nil] An individual's prefix.
|
|
1311
|
-
#
|
|
1312
|
-
# @param risk_rating [Symbol, ModernTreasury::Models::CounterpartyCreateParams::LegalEntity::LegalEntityAssociation::ChildLegalEntity::RiskRating, nil] The risk rating of the legal entity. One of low, medium, high.
|
|
1313
|
-
#
|
|
1314
|
-
# @param suffix [String, nil] An individual's suffix.
|
|
1315
|
-
#
|
|
1316
|
-
# @param wealth_and_employment_details [ModernTreasury::Models::WealthAndEmploymentDetails, nil]
|
|
1317
|
-
#
|
|
1318
|
-
# @param website [String, nil] The entity's primary website URL.
|
|
1319
|
-
|
|
1320
|
-
class Address < ModernTreasury::Internal::Type::BaseModel
|
|
1321
|
-
# @!attribute country
|
|
1322
|
-
# Country code conforms to [ISO 3166-1 alpha-2]
|
|
1323
|
-
#
|
|
1324
|
-
# @return [String, nil]
|
|
1325
|
-
required :country, String, nil?: true
|
|
1326
|
-
|
|
1327
|
-
# @!attribute line1
|
|
1328
|
-
#
|
|
1329
|
-
# @return [String, nil]
|
|
1330
|
-
required :line1, String, nil?: true
|
|
1331
|
-
|
|
1332
|
-
# @!attribute locality
|
|
1333
|
-
# Locality or City.
|
|
1334
|
-
#
|
|
1335
|
-
# @return [String, nil]
|
|
1336
|
-
required :locality, String, nil?: true
|
|
1337
|
-
|
|
1338
|
-
# @!attribute postal_code
|
|
1339
|
-
# The postal code of the address.
|
|
1340
|
-
#
|
|
1341
|
-
# @return [String, nil]
|
|
1342
|
-
required :postal_code, String, nil?: true
|
|
1343
|
-
|
|
1344
|
-
# @!attribute region
|
|
1345
|
-
# Region or State.
|
|
1346
|
-
#
|
|
1347
|
-
# @return [String, nil]
|
|
1348
|
-
required :region, String, nil?: true
|
|
1349
|
-
|
|
1350
|
-
# @!attribute address_types
|
|
1351
|
-
# The types of this address.
|
|
1352
|
-
#
|
|
1353
|
-
# @return [Array<Symbol, ModernTreasury::Models::CounterpartyCreateParams::LegalEntity::LegalEntityAssociation::ChildLegalEntity::Address::AddressType>, nil]
|
|
1354
|
-
optional :address_types,
|
|
1355
|
-
-> do
|
|
1356
|
-
ModernTreasury::Internal::Type::ArrayOf[
|
|
1357
|
-
enum: ModernTreasury::CounterpartyCreateParams::LegalEntity::LegalEntityAssociation::ChildLegalEntity::Address::AddressType
|
|
1358
|
-
]
|
|
1359
|
-
end
|
|
1360
|
-
|
|
1361
|
-
# @!attribute line2
|
|
1362
|
-
#
|
|
1363
|
-
# @return [String, nil]
|
|
1364
|
-
optional :line2, String, nil?: true
|
|
1365
|
-
|
|
1366
|
-
# @!method initialize(country:, line1:, locality:, postal_code:, region:, address_types: nil, line2: nil)
|
|
1367
|
-
# @param country [String, nil] Country code conforms to [ISO 3166-1 alpha-2]
|
|
1368
|
-
#
|
|
1369
|
-
# @param line1 [String, nil]
|
|
1370
|
-
#
|
|
1371
|
-
# @param locality [String, nil] Locality or City.
|
|
1372
|
-
#
|
|
1373
|
-
# @param postal_code [String, nil] The postal code of the address.
|
|
1374
|
-
#
|
|
1375
|
-
# @param region [String, nil] Region or State.
|
|
1376
|
-
#
|
|
1377
|
-
# @param address_types [Array<Symbol, ModernTreasury::Models::CounterpartyCreateParams::LegalEntity::LegalEntityAssociation::ChildLegalEntity::Address::AddressType>] The types of this address.
|
|
1378
|
-
#
|
|
1379
|
-
# @param line2 [String, nil]
|
|
1380
|
-
|
|
1381
|
-
module AddressType
|
|
1382
|
-
extend ModernTreasury::Internal::Type::Enum
|
|
1383
|
-
|
|
1384
|
-
BUSINESS = :business
|
|
1385
|
-
MAILING = :mailing
|
|
1386
|
-
OTHER = :other
|
|
1387
|
-
PO_BOX = :po_box
|
|
1388
|
-
RESIDENTIAL = :residential
|
|
1389
|
-
|
|
1390
|
-
# @!method self.values
|
|
1391
|
-
# @return [Array<Symbol>]
|
|
1392
|
-
end
|
|
1393
|
-
end
|
|
1394
|
-
|
|
1395
|
-
class Identification < ModernTreasury::Internal::Type::BaseModel
|
|
1396
|
-
# @!attribute id_number
|
|
1397
|
-
# The ID number of identification document.
|
|
1398
|
-
#
|
|
1399
|
-
# @return [String]
|
|
1400
|
-
required :id_number, String
|
|
1401
|
-
|
|
1402
|
-
# @!attribute id_type
|
|
1403
|
-
# The type of ID number.
|
|
1404
|
-
#
|
|
1405
|
-
# @return [Symbol, ModernTreasury::Models::CounterpartyCreateParams::LegalEntity::LegalEntityAssociation::ChildLegalEntity::Identification::IDType]
|
|
1406
|
-
required :id_type,
|
|
1407
|
-
enum: -> {
|
|
1408
|
-
ModernTreasury::CounterpartyCreateParams::LegalEntity::LegalEntityAssociation::ChildLegalEntity::Identification::IDType
|
|
1409
|
-
}
|
|
1410
|
-
|
|
1411
|
-
# @!attribute expiration_date
|
|
1412
|
-
# The date when the Identification is no longer considered valid by the issuing
|
|
1413
|
-
# authority.
|
|
1414
|
-
#
|
|
1415
|
-
# @return [Date, nil]
|
|
1416
|
-
optional :expiration_date, Date, nil?: true
|
|
1417
|
-
|
|
1418
|
-
# @!attribute issuing_country
|
|
1419
|
-
# The ISO 3166-1 alpha-2 country code of the country that issued the
|
|
1420
|
-
# identification
|
|
1421
|
-
#
|
|
1422
|
-
# @return [String, nil]
|
|
1423
|
-
optional :issuing_country, String, nil?: true
|
|
1424
|
-
|
|
1425
|
-
# @!attribute issuing_region
|
|
1426
|
-
# The region in which the identifcation was issued.
|
|
1427
|
-
#
|
|
1428
|
-
# @return [String, nil]
|
|
1429
|
-
optional :issuing_region, String, nil?: true
|
|
1430
|
-
|
|
1431
|
-
# @!method initialize(id_number:, id_type:, expiration_date: nil, issuing_country: nil, issuing_region: nil)
|
|
1432
|
-
# Some parameter documentations has been truncated, see
|
|
1433
|
-
# {ModernTreasury::Models::CounterpartyCreateParams::LegalEntity::LegalEntityAssociation::ChildLegalEntity::Identification}
|
|
1434
|
-
# for more details.
|
|
1435
|
-
#
|
|
1436
|
-
# @param id_number [String] The ID number of identification document.
|
|
1437
|
-
#
|
|
1438
|
-
# @param id_type [Symbol, ModernTreasury::Models::CounterpartyCreateParams::LegalEntity::LegalEntityAssociation::ChildLegalEntity::Identification::IDType] The type of ID number.
|
|
1439
|
-
#
|
|
1440
|
-
# @param expiration_date [Date, nil] The date when the Identification is no longer considered valid by the issuing au
|
|
1441
|
-
#
|
|
1442
|
-
# @param issuing_country [String, nil] The ISO 3166-1 alpha-2 country code of the country that issued the identificatio
|
|
1443
|
-
#
|
|
1444
|
-
# @param issuing_region [String, nil] The region in which the identifcation was issued.
|
|
1445
|
-
|
|
1446
|
-
# The type of ID number.
|
|
1447
|
-
#
|
|
1448
|
-
# @see ModernTreasury::Models::CounterpartyCreateParams::LegalEntity::LegalEntityAssociation::ChildLegalEntity::Identification#id_type
|
|
1449
|
-
module IDType
|
|
1450
|
-
extend ModernTreasury::Internal::Type::Enum
|
|
1451
|
-
|
|
1452
|
-
AR_CUIL = :ar_cuil
|
|
1453
|
-
AR_CUIT = :ar_cuit
|
|
1454
|
-
BR_CNPJ = :br_cnpj
|
|
1455
|
-
BR_CPF = :br_cpf
|
|
1456
|
-
CL_RUN = :cl_run
|
|
1457
|
-
CL_RUT = :cl_rut
|
|
1458
|
-
CO_CEDULAS = :co_cedulas
|
|
1459
|
-
CO_NIT = :co_nit
|
|
1460
|
-
DRIVERS_LICENSE = :drivers_license
|
|
1461
|
-
HN_ID = :hn_id
|
|
1462
|
-
HN_RTN = :hn_rtn
|
|
1463
|
-
IN_LEI = :in_lei
|
|
1464
|
-
KR_BRN = :kr_brn
|
|
1465
|
-
KR_CRN = :kr_crn
|
|
1466
|
-
KR_RRN = :kr_rrn
|
|
1467
|
-
PASSPORT = :passport
|
|
1468
|
-
SA_TIN = :sa_tin
|
|
1469
|
-
SA_VAT = :sa_vat
|
|
1470
|
-
US_EIN = :us_ein
|
|
1471
|
-
US_ITIN = :us_itin
|
|
1472
|
-
US_SSN = :us_ssn
|
|
1473
|
-
VN_TIN = :vn_tin
|
|
1474
|
-
|
|
1475
|
-
# @!method self.values
|
|
1476
|
-
# @return [Array<Symbol>]
|
|
1477
|
-
end
|
|
1478
|
-
end
|
|
1479
|
-
|
|
1480
|
-
# The type of legal entity.
|
|
1481
|
-
#
|
|
1482
|
-
# @see ModernTreasury::Models::CounterpartyCreateParams::LegalEntity::LegalEntityAssociation::ChildLegalEntity#legal_entity_type
|
|
1483
|
-
module LegalEntityType
|
|
1484
|
-
extend ModernTreasury::Internal::Type::Enum
|
|
1485
|
-
|
|
1486
|
-
BUSINESS = :business
|
|
1487
|
-
INDIVIDUAL = :individual
|
|
1488
|
-
|
|
1489
|
-
# @!method self.values
|
|
1490
|
-
# @return [Array<Symbol>]
|
|
1491
|
-
end
|
|
1492
|
-
|
|
1493
|
-
# The business's legal structure.
|
|
1494
|
-
#
|
|
1495
|
-
# @see ModernTreasury::Models::CounterpartyCreateParams::LegalEntity::LegalEntityAssociation::ChildLegalEntity#legal_structure
|
|
1496
|
-
module LegalStructure
|
|
1497
|
-
extend ModernTreasury::Internal::Type::Enum
|
|
1498
|
-
|
|
1499
|
-
CORPORATION = :corporation
|
|
1500
|
-
LLC = :llc
|
|
1501
|
-
NON_PROFIT = :non_profit
|
|
1502
|
-
PARTNERSHIP = :partnership
|
|
1503
|
-
SOLE_PROPRIETORSHIP = :sole_proprietorship
|
|
1504
|
-
TRUST = :trust
|
|
1505
|
-
|
|
1506
|
-
# @!method self.values
|
|
1507
|
-
# @return [Array<Symbol>]
|
|
1508
|
-
end
|
|
1509
|
-
|
|
1510
|
-
class PhoneNumber < ModernTreasury::Internal::Type::BaseModel
|
|
1511
|
-
# @!attribute phone_number
|
|
1512
|
-
#
|
|
1513
|
-
# @return [String, nil]
|
|
1514
|
-
optional :phone_number, String
|
|
1515
|
-
|
|
1516
|
-
# @!method initialize(phone_number: nil)
|
|
1517
|
-
# A list of phone numbers in E.164 format.
|
|
1518
|
-
#
|
|
1519
|
-
# @param phone_number [String]
|
|
1520
|
-
end
|
|
1521
|
-
|
|
1522
|
-
# The risk rating of the legal entity. One of low, medium, high.
|
|
1523
|
-
#
|
|
1524
|
-
# @see ModernTreasury::Models::CounterpartyCreateParams::LegalEntity::LegalEntityAssociation::ChildLegalEntity#risk_rating
|
|
1525
|
-
module RiskRating
|
|
1526
|
-
extend ModernTreasury::Internal::Type::Enum
|
|
1527
|
-
|
|
1528
|
-
LOW = :low
|
|
1529
|
-
MEDIUM = :medium
|
|
1530
|
-
HIGH = :high
|
|
1531
|
-
|
|
1532
|
-
# @!method self.values
|
|
1533
|
-
# @return [Array<Symbol>]
|
|
1534
|
-
end
|
|
1535
|
-
end
|
|
1536
735
|
end
|
|
1537
736
|
|
|
1538
737
|
# The business's legal structure.
|