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
|
@@ -22,9 +22,8 @@ module ModernTreasury
|
|
|
22
22
|
|
|
23
23
|
# @!attribute contact_details
|
|
24
24
|
#
|
|
25
|
-
# @return [Array<ModernTreasury::Models::
|
|
26
|
-
required :contact_details,
|
|
27
|
-
-> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::ExternalAccount::ContactDetail] }
|
|
25
|
+
# @return [Array<ModernTreasury::Models::ContactDetail>]
|
|
26
|
+
required :contact_details, -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::ContactDetail] }
|
|
28
27
|
|
|
29
28
|
# @!attribute counterparty_id
|
|
30
29
|
#
|
|
@@ -41,6 +40,12 @@ module ModernTreasury
|
|
|
41
40
|
# @return [Time, nil]
|
|
42
41
|
required :discarded_at, Time, nil?: true
|
|
43
42
|
|
|
43
|
+
# @!attribute external_id
|
|
44
|
+
# An optional user-defined 180 character unique identifier.
|
|
45
|
+
#
|
|
46
|
+
# @return [String, nil]
|
|
47
|
+
required :external_id, String, nil?: true
|
|
48
|
+
|
|
44
49
|
# @!attribute ledger_account_id
|
|
45
50
|
# If the external account links to a ledger account in Modern Treasury, the id of
|
|
46
51
|
# the ledger account will be populated here.
|
|
@@ -77,8 +82,8 @@ module ModernTreasury
|
|
|
77
82
|
# @!attribute party_address
|
|
78
83
|
# The address associated with the owner or `null`.
|
|
79
84
|
#
|
|
80
|
-
# @return [ModernTreasury::Models::
|
|
81
|
-
required :party_address, -> { ModernTreasury::
|
|
85
|
+
# @return [ModernTreasury::Models::Address, nil]
|
|
86
|
+
required :party_address, -> { ModernTreasury::Address }, nil?: true
|
|
82
87
|
|
|
83
88
|
# @!attribute party_name
|
|
84
89
|
# The legal name of the entity which owns the account.
|
|
@@ -114,7 +119,7 @@ module ModernTreasury
|
|
|
114
119
|
# @return [Symbol, ModernTreasury::Models::ExternalAccount::VerificationStatus]
|
|
115
120
|
required :verification_status, enum: -> { ModernTreasury::ExternalAccount::VerificationStatus }
|
|
116
121
|
|
|
117
|
-
# @!method initialize(id:, account_details:, account_type:, contact_details:, counterparty_id:, created_at:, discarded_at:, ledger_account_id:, live_mode:, metadata:, name:, object:, party_address:, party_name:, party_type:, routing_details:, updated_at:, verification_source:, verification_status:)
|
|
122
|
+
# @!method initialize(id:, account_details:, account_type:, contact_details:, counterparty_id:, created_at:, discarded_at:, external_id:, ledger_account_id:, live_mode:, metadata:, name:, object:, party_address:, party_name:, party_type:, routing_details:, updated_at:, verification_source:, verification_status:)
|
|
118
123
|
# Some parameter documentations has been truncated, see
|
|
119
124
|
# {ModernTreasury::Models::ExternalAccount} for more details.
|
|
120
125
|
#
|
|
@@ -124,7 +129,7 @@ module ModernTreasury
|
|
|
124
129
|
#
|
|
125
130
|
# @param account_type [Symbol, ModernTreasury::Models::ExternalAccountType] Can be `checking`, `savings` or `other`.
|
|
126
131
|
#
|
|
127
|
-
# @param contact_details [Array<ModernTreasury::Models::
|
|
132
|
+
# @param contact_details [Array<ModernTreasury::Models::ContactDetail>]
|
|
128
133
|
#
|
|
129
134
|
# @param counterparty_id [String, nil]
|
|
130
135
|
#
|
|
@@ -132,6 +137,8 @@ module ModernTreasury
|
|
|
132
137
|
#
|
|
133
138
|
# @param discarded_at [Time, nil]
|
|
134
139
|
#
|
|
140
|
+
# @param external_id [String, nil] An optional user-defined 180 character unique identifier.
|
|
141
|
+
#
|
|
135
142
|
# @param ledger_account_id [String, nil] If the external account links to a ledger account in Modern Treasury, the id of
|
|
136
143
|
#
|
|
137
144
|
# @param live_mode [Boolean] This field will be true if this object exists in the live environment or false i
|
|
@@ -142,7 +149,7 @@ module ModernTreasury
|
|
|
142
149
|
#
|
|
143
150
|
# @param object [String]
|
|
144
151
|
#
|
|
145
|
-
# @param party_address [ModernTreasury::Models::
|
|
152
|
+
# @param party_address [ModernTreasury::Models::Address, nil] The address associated with the owner or `null`.
|
|
146
153
|
#
|
|
147
154
|
# @param party_name [String] The legal name of the entity which owns the account.
|
|
148
155
|
#
|
|
@@ -156,175 +163,6 @@ module ModernTreasury
|
|
|
156
163
|
#
|
|
157
164
|
# @param verification_status [Symbol, ModernTreasury::Models::ExternalAccount::VerificationStatus]
|
|
158
165
|
|
|
159
|
-
class ContactDetail < ModernTreasury::Internal::Type::BaseModel
|
|
160
|
-
# @!attribute id
|
|
161
|
-
#
|
|
162
|
-
# @return [String]
|
|
163
|
-
required :id, String
|
|
164
|
-
|
|
165
|
-
# @!attribute contact_identifier
|
|
166
|
-
#
|
|
167
|
-
# @return [String]
|
|
168
|
-
required :contact_identifier, String
|
|
169
|
-
|
|
170
|
-
# @!attribute contact_identifier_type
|
|
171
|
-
#
|
|
172
|
-
# @return [Symbol, ModernTreasury::Models::ExternalAccount::ContactDetail::ContactIdentifierType]
|
|
173
|
-
required :contact_identifier_type,
|
|
174
|
-
enum: -> { ModernTreasury::ExternalAccount::ContactDetail::ContactIdentifierType }
|
|
175
|
-
|
|
176
|
-
# @!attribute created_at
|
|
177
|
-
#
|
|
178
|
-
# @return [Time]
|
|
179
|
-
required :created_at, Time
|
|
180
|
-
|
|
181
|
-
# @!attribute discarded_at
|
|
182
|
-
#
|
|
183
|
-
# @return [Time, nil]
|
|
184
|
-
required :discarded_at, Time, nil?: true
|
|
185
|
-
|
|
186
|
-
# @!attribute live_mode
|
|
187
|
-
# This field will be true if this object exists in the live environment or false
|
|
188
|
-
# if it exists in the test environment.
|
|
189
|
-
#
|
|
190
|
-
# @return [Boolean]
|
|
191
|
-
required :live_mode, ModernTreasury::Internal::Type::Boolean
|
|
192
|
-
|
|
193
|
-
# @!attribute object
|
|
194
|
-
#
|
|
195
|
-
# @return [String]
|
|
196
|
-
required :object, String
|
|
197
|
-
|
|
198
|
-
# @!attribute updated_at
|
|
199
|
-
#
|
|
200
|
-
# @return [Time]
|
|
201
|
-
required :updated_at, Time
|
|
202
|
-
|
|
203
|
-
# @!method initialize(id:, contact_identifier:, contact_identifier_type:, created_at:, discarded_at:, live_mode:, object:, updated_at:)
|
|
204
|
-
# Some parameter documentations has been truncated, see
|
|
205
|
-
# {ModernTreasury::Models::ExternalAccount::ContactDetail} for more details.
|
|
206
|
-
#
|
|
207
|
-
# @param id [String]
|
|
208
|
-
#
|
|
209
|
-
# @param contact_identifier [String]
|
|
210
|
-
#
|
|
211
|
-
# @param contact_identifier_type [Symbol, ModernTreasury::Models::ExternalAccount::ContactDetail::ContactIdentifierType]
|
|
212
|
-
#
|
|
213
|
-
# @param created_at [Time]
|
|
214
|
-
#
|
|
215
|
-
# @param discarded_at [Time, nil]
|
|
216
|
-
#
|
|
217
|
-
# @param live_mode [Boolean] This field will be true if this object exists in the live environment or false i
|
|
218
|
-
#
|
|
219
|
-
# @param object [String]
|
|
220
|
-
#
|
|
221
|
-
# @param updated_at [Time]
|
|
222
|
-
|
|
223
|
-
# @see ModernTreasury::Models::ExternalAccount::ContactDetail#contact_identifier_type
|
|
224
|
-
module ContactIdentifierType
|
|
225
|
-
extend ModernTreasury::Internal::Type::Enum
|
|
226
|
-
|
|
227
|
-
EMAIL = :email
|
|
228
|
-
PHONE_NUMBER = :phone_number
|
|
229
|
-
WEBSITE = :website
|
|
230
|
-
|
|
231
|
-
# @!method self.values
|
|
232
|
-
# @return [Array<Symbol>]
|
|
233
|
-
end
|
|
234
|
-
end
|
|
235
|
-
|
|
236
|
-
# @see ModernTreasury::Models::ExternalAccount#party_address
|
|
237
|
-
class PartyAddress < ModernTreasury::Internal::Type::BaseModel
|
|
238
|
-
# @!attribute id
|
|
239
|
-
#
|
|
240
|
-
# @return [String]
|
|
241
|
-
required :id, String
|
|
242
|
-
|
|
243
|
-
# @!attribute country
|
|
244
|
-
# Country code conforms to [ISO 3166-1 alpha-2]
|
|
245
|
-
#
|
|
246
|
-
# @return [String, nil]
|
|
247
|
-
required :country, String, nil?: true
|
|
248
|
-
|
|
249
|
-
# @!attribute created_at
|
|
250
|
-
#
|
|
251
|
-
# @return [Time]
|
|
252
|
-
required :created_at, Time
|
|
253
|
-
|
|
254
|
-
# @!attribute line1
|
|
255
|
-
#
|
|
256
|
-
# @return [String, nil]
|
|
257
|
-
required :line1, String, nil?: true
|
|
258
|
-
|
|
259
|
-
# @!attribute line2
|
|
260
|
-
#
|
|
261
|
-
# @return [String, nil]
|
|
262
|
-
required :line2, String, nil?: true
|
|
263
|
-
|
|
264
|
-
# @!attribute live_mode
|
|
265
|
-
# This field will be true if this object exists in the live environment or false
|
|
266
|
-
# if it exists in the test environment.
|
|
267
|
-
#
|
|
268
|
-
# @return [Boolean]
|
|
269
|
-
required :live_mode, ModernTreasury::Internal::Type::Boolean
|
|
270
|
-
|
|
271
|
-
# @!attribute locality
|
|
272
|
-
# Locality or City.
|
|
273
|
-
#
|
|
274
|
-
# @return [String, nil]
|
|
275
|
-
required :locality, String, nil?: true
|
|
276
|
-
|
|
277
|
-
# @!attribute object
|
|
278
|
-
#
|
|
279
|
-
# @return [String]
|
|
280
|
-
required :object, String
|
|
281
|
-
|
|
282
|
-
# @!attribute postal_code
|
|
283
|
-
# The postal code of the address.
|
|
284
|
-
#
|
|
285
|
-
# @return [String, nil]
|
|
286
|
-
required :postal_code, String, nil?: true
|
|
287
|
-
|
|
288
|
-
# @!attribute region
|
|
289
|
-
# Region or State.
|
|
290
|
-
#
|
|
291
|
-
# @return [String, nil]
|
|
292
|
-
required :region, String, nil?: true
|
|
293
|
-
|
|
294
|
-
# @!attribute updated_at
|
|
295
|
-
#
|
|
296
|
-
# @return [Time]
|
|
297
|
-
required :updated_at, Time
|
|
298
|
-
|
|
299
|
-
# @!method initialize(id:, country:, created_at:, line1:, line2:, live_mode:, locality:, object:, postal_code:, region:, updated_at:)
|
|
300
|
-
# Some parameter documentations has been truncated, see
|
|
301
|
-
# {ModernTreasury::Models::ExternalAccount::PartyAddress} for more details.
|
|
302
|
-
#
|
|
303
|
-
# The address associated with the owner or `null`.
|
|
304
|
-
#
|
|
305
|
-
# @param id [String]
|
|
306
|
-
#
|
|
307
|
-
# @param country [String, nil] Country code conforms to [ISO 3166-1 alpha-2]
|
|
308
|
-
#
|
|
309
|
-
# @param created_at [Time]
|
|
310
|
-
#
|
|
311
|
-
# @param line1 [String, nil]
|
|
312
|
-
#
|
|
313
|
-
# @param line2 [String, nil]
|
|
314
|
-
#
|
|
315
|
-
# @param live_mode [Boolean] This field will be true if this object exists in the live environment or false i
|
|
316
|
-
#
|
|
317
|
-
# @param locality [String, nil] Locality or City.
|
|
318
|
-
#
|
|
319
|
-
# @param object [String]
|
|
320
|
-
#
|
|
321
|
-
# @param postal_code [String, nil] The postal code of the address.
|
|
322
|
-
#
|
|
323
|
-
# @param region [String, nil] Region or State.
|
|
324
|
-
#
|
|
325
|
-
# @param updated_at [Time]
|
|
326
|
-
end
|
|
327
|
-
|
|
328
166
|
# Either `individual` or `business`.
|
|
329
167
|
#
|
|
330
168
|
# @see ModernTreasury::Models::ExternalAccount#party_type
|
|
@@ -12,6 +12,12 @@ module ModernTreasury
|
|
|
12
12
|
# @return [String, nil]
|
|
13
13
|
required :counterparty_id, String, nil?: true
|
|
14
14
|
|
|
15
|
+
# @!attribute body_external_id
|
|
16
|
+
# An optional user-defined 180 character unique identifier.
|
|
17
|
+
#
|
|
18
|
+
# @return [String, nil]
|
|
19
|
+
optional :body_external_id, String, api_name: :external_id, nil?: true
|
|
20
|
+
|
|
15
21
|
# @!attribute account_details
|
|
16
22
|
#
|
|
17
23
|
# @return [Array<ModernTreasury::Models::ExternalAccountCreateParams::AccountDetail>, nil]
|
|
@@ -28,11 +34,9 @@ module ModernTreasury
|
|
|
28
34
|
|
|
29
35
|
# @!attribute contact_details
|
|
30
36
|
#
|
|
31
|
-
# @return [Array<ModernTreasury::Models::
|
|
37
|
+
# @return [Array<ModernTreasury::Models::ContactDetailCreateRequest>, nil]
|
|
32
38
|
optional :contact_details,
|
|
33
|
-
-> {
|
|
34
|
-
ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::ExternalAccountCreateParams::ContactDetail]
|
|
35
|
-
}
|
|
39
|
+
-> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::ContactDetailCreateRequest] }
|
|
36
40
|
|
|
37
41
|
# @!attribute ledger_account
|
|
38
42
|
# Specifies a ledger account object that will be created with the external
|
|
@@ -41,8 +45,8 @@ module ModernTreasury
|
|
|
41
45
|
# https://docs.moderntreasury.com/docs/linking-to-other-modern-treasury-objects
|
|
42
46
|
# for more details.
|
|
43
47
|
#
|
|
44
|
-
# @return [ModernTreasury::Models::
|
|
45
|
-
optional :ledger_account, -> { ModernTreasury::
|
|
48
|
+
# @return [ModernTreasury::Models::LedgerAccountCreateRequest, nil]
|
|
49
|
+
optional :ledger_account, -> { ModernTreasury::LedgerAccountCreateRequest }
|
|
46
50
|
|
|
47
51
|
# @!attribute metadata
|
|
48
52
|
# Additional data represented as key-value pairs. Both the key and value must be
|
|
@@ -61,8 +65,8 @@ module ModernTreasury
|
|
|
61
65
|
# @!attribute party_address
|
|
62
66
|
# Required if receiving wire payments.
|
|
63
67
|
#
|
|
64
|
-
# @return [ModernTreasury::Models::
|
|
65
|
-
optional :party_address, -> { ModernTreasury::
|
|
68
|
+
# @return [ModernTreasury::Models::AddressRequest, nil]
|
|
69
|
+
optional :party_address, -> { ModernTreasury::AddressRequest }
|
|
66
70
|
|
|
67
71
|
# @!attribute party_identifier
|
|
68
72
|
#
|
|
@@ -96,25 +100,27 @@ module ModernTreasury
|
|
|
96
100
|
ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::ExternalAccountCreateParams::RoutingDetail]
|
|
97
101
|
}
|
|
98
102
|
|
|
99
|
-
# @!method initialize(counterparty_id:, 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, request_options: {})
|
|
103
|
+
# @!method initialize(counterparty_id:, body_external_id: nil, 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, request_options: {})
|
|
100
104
|
# Some parameter documentations has been truncated, see
|
|
101
105
|
# {ModernTreasury::Models::ExternalAccountCreateParams} for more details.
|
|
102
106
|
#
|
|
103
107
|
# @param counterparty_id [String, nil]
|
|
104
108
|
#
|
|
109
|
+
# @param body_external_id [String, nil] An optional user-defined 180 character unique identifier.
|
|
110
|
+
#
|
|
105
111
|
# @param account_details [Array<ModernTreasury::Models::ExternalAccountCreateParams::AccountDetail>]
|
|
106
112
|
#
|
|
107
113
|
# @param account_type [Symbol, ModernTreasury::Models::ExternalAccountType] Can be `checking`, `savings` or `other`.
|
|
108
114
|
#
|
|
109
|
-
# @param contact_details [Array<ModernTreasury::Models::
|
|
115
|
+
# @param contact_details [Array<ModernTreasury::Models::ContactDetailCreateRequest>]
|
|
110
116
|
#
|
|
111
|
-
# @param ledger_account [ModernTreasury::Models::
|
|
117
|
+
# @param ledger_account [ModernTreasury::Models::LedgerAccountCreateRequest] Specifies a ledger account object that will be created with the external account
|
|
112
118
|
#
|
|
113
119
|
# @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
|
|
114
120
|
#
|
|
115
121
|
# @param name [String, nil] A nickname for the external account. This is only for internal usage and won't a
|
|
116
122
|
#
|
|
117
|
-
# @param party_address [ModernTreasury::Models::
|
|
123
|
+
# @param party_address [ModernTreasury::Models::AddressRequest] Required if receiving wire payments.
|
|
118
124
|
#
|
|
119
125
|
# @param party_identifier [String]
|
|
120
126
|
#
|
|
@@ -168,204 +174,6 @@ module ModernTreasury
|
|
|
168
174
|
end
|
|
169
175
|
end
|
|
170
176
|
|
|
171
|
-
class ContactDetail < ModernTreasury::Internal::Type::BaseModel
|
|
172
|
-
# @!attribute contact_identifier
|
|
173
|
-
#
|
|
174
|
-
# @return [String, nil]
|
|
175
|
-
optional :contact_identifier, String
|
|
176
|
-
|
|
177
|
-
# @!attribute contact_identifier_type
|
|
178
|
-
#
|
|
179
|
-
# @return [Symbol, ModernTreasury::Models::ExternalAccountCreateParams::ContactDetail::ContactIdentifierType, nil]
|
|
180
|
-
optional :contact_identifier_type,
|
|
181
|
-
enum: -> {
|
|
182
|
-
ModernTreasury::ExternalAccountCreateParams::ContactDetail::ContactIdentifierType
|
|
183
|
-
}
|
|
184
|
-
|
|
185
|
-
# @!method initialize(contact_identifier: nil, contact_identifier_type: nil)
|
|
186
|
-
# @param contact_identifier [String]
|
|
187
|
-
# @param contact_identifier_type [Symbol, ModernTreasury::Models::ExternalAccountCreateParams::ContactDetail::ContactIdentifierType]
|
|
188
|
-
|
|
189
|
-
# @see ModernTreasury::Models::ExternalAccountCreateParams::ContactDetail#contact_identifier_type
|
|
190
|
-
module ContactIdentifierType
|
|
191
|
-
extend ModernTreasury::Internal::Type::Enum
|
|
192
|
-
|
|
193
|
-
EMAIL = :email
|
|
194
|
-
PHONE_NUMBER = :phone_number
|
|
195
|
-
WEBSITE = :website
|
|
196
|
-
|
|
197
|
-
# @!method self.values
|
|
198
|
-
# @return [Array<Symbol>]
|
|
199
|
-
end
|
|
200
|
-
end
|
|
201
|
-
|
|
202
|
-
class LedgerAccount < ModernTreasury::Internal::Type::BaseModel
|
|
203
|
-
# @!attribute currency
|
|
204
|
-
# The currency of the ledger account.
|
|
205
|
-
#
|
|
206
|
-
# @return [String]
|
|
207
|
-
required :currency, String
|
|
208
|
-
|
|
209
|
-
# @!attribute ledger_id
|
|
210
|
-
# The id of the ledger that this account belongs to.
|
|
211
|
-
#
|
|
212
|
-
# @return [String]
|
|
213
|
-
required :ledger_id, String
|
|
214
|
-
|
|
215
|
-
# @!attribute name
|
|
216
|
-
# The name of the ledger account.
|
|
217
|
-
#
|
|
218
|
-
# @return [String]
|
|
219
|
-
required :name, String
|
|
220
|
-
|
|
221
|
-
# @!attribute normal_balance
|
|
222
|
-
# The normal balance of the ledger account.
|
|
223
|
-
#
|
|
224
|
-
# @return [Symbol, ModernTreasury::Models::TransactionDirection]
|
|
225
|
-
required :normal_balance, enum: -> { ModernTreasury::TransactionDirection }
|
|
226
|
-
|
|
227
|
-
# @!attribute currency_exponent
|
|
228
|
-
# The currency exponent of the ledger account.
|
|
229
|
-
#
|
|
230
|
-
# @return [Integer, nil]
|
|
231
|
-
optional :currency_exponent, Integer, nil?: true
|
|
232
|
-
|
|
233
|
-
# @!attribute description
|
|
234
|
-
# The description of the ledger account.
|
|
235
|
-
#
|
|
236
|
-
# @return [String, nil]
|
|
237
|
-
optional :description, String, nil?: true
|
|
238
|
-
|
|
239
|
-
# @!attribute ledger_account_category_ids
|
|
240
|
-
# The array of ledger account category ids that this ledger account should be a
|
|
241
|
-
# child of.
|
|
242
|
-
#
|
|
243
|
-
# @return [Array<String>, nil]
|
|
244
|
-
optional :ledger_account_category_ids, ModernTreasury::Internal::Type::ArrayOf[String]
|
|
245
|
-
|
|
246
|
-
# @!attribute ledgerable_id
|
|
247
|
-
# If the ledger account links to another object in Modern Treasury, the id will be
|
|
248
|
-
# populated here, otherwise null.
|
|
249
|
-
#
|
|
250
|
-
# @return [String, nil]
|
|
251
|
-
optional :ledgerable_id, String
|
|
252
|
-
|
|
253
|
-
# @!attribute ledgerable_type
|
|
254
|
-
# If the ledger account links to another object in Modern Treasury, the type will
|
|
255
|
-
# be populated here, otherwise null. The value is one of internal_account or
|
|
256
|
-
# external_account.
|
|
257
|
-
#
|
|
258
|
-
# @return [Symbol, ModernTreasury::Models::ExternalAccountCreateParams::LedgerAccount::LedgerableType, nil]
|
|
259
|
-
optional :ledgerable_type,
|
|
260
|
-
enum: -> { ModernTreasury::ExternalAccountCreateParams::LedgerAccount::LedgerableType }
|
|
261
|
-
|
|
262
|
-
# @!attribute metadata
|
|
263
|
-
# Additional data represented as key-value pairs. Both the key and value must be
|
|
264
|
-
# strings.
|
|
265
|
-
#
|
|
266
|
-
# @return [Hash{Symbol=>String}, nil]
|
|
267
|
-
optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
|
|
268
|
-
|
|
269
|
-
# @!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)
|
|
270
|
-
# Some parameter documentations has been truncated, see
|
|
271
|
-
# {ModernTreasury::Models::ExternalAccountCreateParams::LedgerAccount} for more
|
|
272
|
-
# details.
|
|
273
|
-
#
|
|
274
|
-
# Specifies a ledger account object that will be created with the external
|
|
275
|
-
# account. The resulting ledger account is linked to the external account for
|
|
276
|
-
# auto-ledgering Payment objects. See
|
|
277
|
-
# https://docs.moderntreasury.com/docs/linking-to-other-modern-treasury-objects
|
|
278
|
-
# for more details.
|
|
279
|
-
#
|
|
280
|
-
# @param currency [String] The currency of the ledger account.
|
|
281
|
-
#
|
|
282
|
-
# @param ledger_id [String] The id of the ledger that this account belongs to.
|
|
283
|
-
#
|
|
284
|
-
# @param name [String] The name of the ledger account.
|
|
285
|
-
#
|
|
286
|
-
# @param normal_balance [Symbol, ModernTreasury::Models::TransactionDirection] The normal balance of the ledger account.
|
|
287
|
-
#
|
|
288
|
-
# @param currency_exponent [Integer, nil] The currency exponent of the ledger account.
|
|
289
|
-
#
|
|
290
|
-
# @param description [String, nil] The description of the ledger account.
|
|
291
|
-
#
|
|
292
|
-
# @param ledger_account_category_ids [Array<String>] The array of ledger account category ids that this ledger account should be a ch
|
|
293
|
-
#
|
|
294
|
-
# @param ledgerable_id [String] If the ledger account links to another object in Modern Treasury, the id will be
|
|
295
|
-
#
|
|
296
|
-
# @param ledgerable_type [Symbol, ModernTreasury::Models::ExternalAccountCreateParams::LedgerAccount::LedgerableType] If the ledger account links to another object in Modern Treasury, the type will
|
|
297
|
-
#
|
|
298
|
-
# @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
|
|
299
|
-
|
|
300
|
-
# If the ledger account links to another object in Modern Treasury, the type will
|
|
301
|
-
# be populated here, otherwise null. The value is one of internal_account or
|
|
302
|
-
# external_account.
|
|
303
|
-
#
|
|
304
|
-
# @see ModernTreasury::Models::ExternalAccountCreateParams::LedgerAccount#ledgerable_type
|
|
305
|
-
module LedgerableType
|
|
306
|
-
extend ModernTreasury::Internal::Type::Enum
|
|
307
|
-
|
|
308
|
-
COUNTERPARTY = :counterparty
|
|
309
|
-
EXTERNAL_ACCOUNT = :external_account
|
|
310
|
-
INTERNAL_ACCOUNT = :internal_account
|
|
311
|
-
VIRTUAL_ACCOUNT = :virtual_account
|
|
312
|
-
|
|
313
|
-
# @!method self.values
|
|
314
|
-
# @return [Array<Symbol>]
|
|
315
|
-
end
|
|
316
|
-
end
|
|
317
|
-
|
|
318
|
-
class PartyAddress < ModernTreasury::Internal::Type::BaseModel
|
|
319
|
-
# @!attribute country
|
|
320
|
-
# Country code conforms to [ISO 3166-1 alpha-2]
|
|
321
|
-
#
|
|
322
|
-
# @return [String, nil]
|
|
323
|
-
optional :country, String, nil?: true
|
|
324
|
-
|
|
325
|
-
# @!attribute line1
|
|
326
|
-
#
|
|
327
|
-
# @return [String, nil]
|
|
328
|
-
optional :line1, String, nil?: true
|
|
329
|
-
|
|
330
|
-
# @!attribute line2
|
|
331
|
-
#
|
|
332
|
-
# @return [String, nil]
|
|
333
|
-
optional :line2, String, nil?: true
|
|
334
|
-
|
|
335
|
-
# @!attribute locality
|
|
336
|
-
# Locality or City.
|
|
337
|
-
#
|
|
338
|
-
# @return [String, nil]
|
|
339
|
-
optional :locality, String, nil?: true
|
|
340
|
-
|
|
341
|
-
# @!attribute postal_code
|
|
342
|
-
# The postal code of the address.
|
|
343
|
-
#
|
|
344
|
-
# @return [String, nil]
|
|
345
|
-
optional :postal_code, String, nil?: true
|
|
346
|
-
|
|
347
|
-
# @!attribute region
|
|
348
|
-
# Region or State.
|
|
349
|
-
#
|
|
350
|
-
# @return [String, nil]
|
|
351
|
-
optional :region, String, nil?: true
|
|
352
|
-
|
|
353
|
-
# @!method initialize(country: nil, line1: nil, line2: nil, locality: nil, postal_code: nil, region: nil)
|
|
354
|
-
# Required if receiving wire payments.
|
|
355
|
-
#
|
|
356
|
-
# @param country [String, nil] Country code conforms to [ISO 3166-1 alpha-2]
|
|
357
|
-
#
|
|
358
|
-
# @param line1 [String, nil]
|
|
359
|
-
#
|
|
360
|
-
# @param line2 [String, nil]
|
|
361
|
-
#
|
|
362
|
-
# @param locality [String, nil] Locality or City.
|
|
363
|
-
#
|
|
364
|
-
# @param postal_code [String, nil] The postal code of the address.
|
|
365
|
-
#
|
|
366
|
-
# @param region [String, nil] Region or State.
|
|
367
|
-
end
|
|
368
|
-
|
|
369
177
|
# Either `individual` or `business`.
|
|
370
178
|
module PartyType
|
|
371
179
|
extend ModernTreasury::Internal::Type::Enum
|
|
@@ -17,6 +17,12 @@ module ModernTreasury
|
|
|
17
17
|
# @return [String, nil]
|
|
18
18
|
optional :counterparty_id, String
|
|
19
19
|
|
|
20
|
+
# @!attribute external_id
|
|
21
|
+
# An optional user-defined 180 character unique identifier.
|
|
22
|
+
#
|
|
23
|
+
# @return [String, nil]
|
|
24
|
+
optional :external_id, String
|
|
25
|
+
|
|
20
26
|
# @!attribute metadata
|
|
21
27
|
# For example, if you want to query for records with metadata key `Type` and value
|
|
22
28
|
# `Loan`, the query would be `metadata%5BType%5D=Loan`. This encodes the query
|
|
@@ -36,7 +42,7 @@ module ModernTreasury
|
|
|
36
42
|
# @return [Integer, nil]
|
|
37
43
|
optional :per_page, Integer
|
|
38
44
|
|
|
39
|
-
# @!method initialize(after_cursor: nil, counterparty_id: nil, metadata: nil, party_name: nil, per_page: nil, request_options: {})
|
|
45
|
+
# @!method initialize(after_cursor: nil, counterparty_id: nil, external_id: nil, metadata: nil, party_name: nil, per_page: nil, request_options: {})
|
|
40
46
|
# Some parameter documentations has been truncated, see
|
|
41
47
|
# {ModernTreasury::Models::ExternalAccountListParams} for more details.
|
|
42
48
|
#
|
|
@@ -44,6 +50,8 @@ module ModernTreasury
|
|
|
44
50
|
#
|
|
45
51
|
# @param counterparty_id [String]
|
|
46
52
|
#
|
|
53
|
+
# @param external_id [String] An optional user-defined 180 character unique identifier.
|
|
54
|
+
#
|
|
47
55
|
# @param metadata [Hash{Symbol=>String}] For example, if you want to query for records with metadata key `Type` and value
|
|
48
56
|
#
|
|
49
57
|
# @param party_name [String] Searches the ExternalAccount's party_name AND the Counterparty's party_name
|
|
@@ -34,8 +34,8 @@ module ModernTreasury
|
|
|
34
34
|
|
|
35
35
|
# @!attribute party_address
|
|
36
36
|
#
|
|
37
|
-
# @return [ModernTreasury::Models::
|
|
38
|
-
optional :party_address, -> { ModernTreasury::
|
|
37
|
+
# @return [ModernTreasury::Models::AddressRequest, nil]
|
|
38
|
+
optional :party_address, -> { ModernTreasury::AddressRequest }
|
|
39
39
|
|
|
40
40
|
# @!attribute party_name
|
|
41
41
|
# If this value isn't provided, it will be inherited from the counterparty's name.
|
|
@@ -61,7 +61,7 @@ module ModernTreasury
|
|
|
61
61
|
#
|
|
62
62
|
# @param name [String, nil] A nickname for the external account. This is only for internal usage and won't a
|
|
63
63
|
#
|
|
64
|
-
# @param party_address [ModernTreasury::Models::
|
|
64
|
+
# @param party_address [ModernTreasury::Models::AddressRequest]
|
|
65
65
|
#
|
|
66
66
|
# @param party_name [String] If this value isn't provided, it will be inherited from the counterparty's name.
|
|
67
67
|
#
|
|
@@ -69,55 +69,6 @@ module ModernTreasury
|
|
|
69
69
|
#
|
|
70
70
|
# @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
|
|
71
71
|
|
|
72
|
-
class PartyAddress < ModernTreasury::Internal::Type::BaseModel
|
|
73
|
-
# @!attribute country
|
|
74
|
-
# Country code conforms to [ISO 3166-1 alpha-2]
|
|
75
|
-
#
|
|
76
|
-
# @return [String, nil]
|
|
77
|
-
optional :country, String, nil?: true
|
|
78
|
-
|
|
79
|
-
# @!attribute line1
|
|
80
|
-
#
|
|
81
|
-
# @return [String, nil]
|
|
82
|
-
optional :line1, String, nil?: true
|
|
83
|
-
|
|
84
|
-
# @!attribute line2
|
|
85
|
-
#
|
|
86
|
-
# @return [String, nil]
|
|
87
|
-
optional :line2, String, nil?: true
|
|
88
|
-
|
|
89
|
-
# @!attribute locality
|
|
90
|
-
# Locality or City.
|
|
91
|
-
#
|
|
92
|
-
# @return [String, nil]
|
|
93
|
-
optional :locality, String, nil?: true
|
|
94
|
-
|
|
95
|
-
# @!attribute postal_code
|
|
96
|
-
# The postal code of the address.
|
|
97
|
-
#
|
|
98
|
-
# @return [String, nil]
|
|
99
|
-
optional :postal_code, String, nil?: true
|
|
100
|
-
|
|
101
|
-
# @!attribute region
|
|
102
|
-
# Region or State.
|
|
103
|
-
#
|
|
104
|
-
# @return [String, nil]
|
|
105
|
-
optional :region, String, nil?: true
|
|
106
|
-
|
|
107
|
-
# @!method initialize(country: nil, line1: nil, line2: nil, locality: nil, postal_code: nil, region: nil)
|
|
108
|
-
# @param country [String, nil] Country code conforms to [ISO 3166-1 alpha-2]
|
|
109
|
-
#
|
|
110
|
-
# @param line1 [String, nil]
|
|
111
|
-
#
|
|
112
|
-
# @param line2 [String, nil]
|
|
113
|
-
#
|
|
114
|
-
# @param locality [String, nil] Locality or City.
|
|
115
|
-
#
|
|
116
|
-
# @param postal_code [String, nil] The postal code of the address.
|
|
117
|
-
#
|
|
118
|
-
# @param region [String, nil] Region or State.
|
|
119
|
-
end
|
|
120
|
-
|
|
121
72
|
# Either `individual` or `business`.
|
|
122
73
|
module PartyType
|
|
123
74
|
extend ModernTreasury::Internal::Type::Enum
|