modern_treasury 0.0.0 → 0.1.0.pre.alpha.16
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/README.md +168 -0
- data/lib/modern_treasury/base_client.rb +457 -0
- data/lib/modern_treasury/base_model.rb +1211 -0
- data/lib/modern_treasury/base_page.rb +59 -0
- data/lib/modern_treasury/client.rb +250 -0
- data/lib/modern_treasury/errors.rb +183 -0
- data/lib/modern_treasury/extern.rb +7 -0
- data/lib/modern_treasury/models/account_collection_flow.rb +199 -0
- data/lib/modern_treasury/models/account_collection_flow_create_params.rb +72 -0
- data/lib/modern_treasury/models/account_collection_flow_list_params.rb +85 -0
- data/lib/modern_treasury/models/account_collection_flow_retrieve_params.rb +18 -0
- data/lib/modern_treasury/models/account_collection_flow_update_params.rb +40 -0
- data/lib/modern_treasury/models/account_detail.rb +113 -0
- data/lib/modern_treasury/models/account_detail_create_params.rb +79 -0
- data/lib/modern_treasury/models/account_detail_delete_params.rb +42 -0
- data/lib/modern_treasury/models/account_detail_list_params.rb +40 -0
- data/lib/modern_treasury/models/account_detail_retrieve_params.rb +30 -0
- data/lib/modern_treasury/models/accounts_type.rb +18 -0
- data/lib/modern_treasury/models/async_response.rb +25 -0
- data/lib/modern_treasury/models/bank_settings.rb +97 -0
- data/lib/modern_treasury/models/bulk_request.rb +159 -0
- data/lib/modern_treasury/models/bulk_request_create_params.rb +4128 -0
- data/lib/modern_treasury/models/bulk_request_list_params.rb +137 -0
- data/lib/modern_treasury/models/bulk_request_retrieve_params.rb +18 -0
- data/lib/modern_treasury/models/bulk_result.rb +272 -0
- data/lib/modern_treasury/models/bulk_result_list_params.rb +151 -0
- data/lib/modern_treasury/models/bulk_result_retrieve_params.rb +18 -0
- data/lib/modern_treasury/models/client_ping_params.rb +18 -0
- data/lib/modern_treasury/models/connection.rb +85 -0
- data/lib/modern_treasury/models/connection_legal_entity.rb +109 -0
- data/lib/modern_treasury/models/connection_legal_entity_create_params.rb +1024 -0
- data/lib/modern_treasury/models/connection_legal_entity_list_params.rb +89 -0
- data/lib/modern_treasury/models/connection_legal_entity_retrieve_params.rb +18 -0
- data/lib/modern_treasury/models/connection_legal_entity_update_params.rb +42 -0
- data/lib/modern_treasury/models/connection_list_params.rb +56 -0
- data/lib/modern_treasury/models/counterparty.rb +561 -0
- data/lib/modern_treasury/models/counterparty_collect_account_params.rb +110 -0
- data/lib/modern_treasury/models/counterparty_collect_account_response.rb +38 -0
- data/lib/modern_treasury/models/counterparty_create_params.rb +1737 -0
- data/lib/modern_treasury/models/counterparty_delete_params.rb +18 -0
- data/lib/modern_treasury/models/counterparty_list_params.rb +117 -0
- data/lib/modern_treasury/models/counterparty_retrieve_params.rb +18 -0
- data/lib/modern_treasury/models/counterparty_update_params.rb +93 -0
- data/lib/modern_treasury/models/currency.rb +206 -0
- data/lib/modern_treasury/models/document.rb +247 -0
- data/lib/modern_treasury/models/document_create_params.rb +71 -0
- data/lib/modern_treasury/models/document_list_params.rb +84 -0
- data/lib/modern_treasury/models/document_retrieve_params.rb +18 -0
- data/lib/modern_treasury/models/event.rb +94 -0
- data/lib/modern_treasury/models/event_list_params.rb +98 -0
- data/lib/modern_treasury/models/event_retrieve_params.rb +18 -0
- data/lib/modern_treasury/models/expected_payment.rb +285 -0
- data/lib/modern_treasury/models/expected_payment_create_params.rb +537 -0
- data/lib/modern_treasury/models/expected_payment_delete_params.rb +18 -0
- data/lib/modern_treasury/models/expected_payment_list_params.rb +199 -0
- data/lib/modern_treasury/models/expected_payment_retrieve_params.rb +18 -0
- data/lib/modern_treasury/models/expected_payment_type.rb +48 -0
- data/lib/modern_treasury/models/expected_payment_update_params.rb +207 -0
- data/lib/modern_treasury/models/external_account.rb +389 -0
- data/lib/modern_treasury/models/external_account_complete_verification_params.rb +28 -0
- data/lib/modern_treasury/models/external_account_create_params.rb +570 -0
- data/lib/modern_treasury/models/external_account_delete_params.rb +18 -0
- data/lib/modern_treasury/models/external_account_list_params.rb +78 -0
- data/lib/modern_treasury/models/external_account_retrieve_params.rb +18 -0
- data/lib/modern_treasury/models/external_account_type.rb +25 -0
- data/lib/modern_treasury/models/external_account_update_params.rb +159 -0
- data/lib/modern_treasury/models/external_account_verify_params.rb +151 -0
- data/lib/modern_treasury/models/external_account_verify_response.rb +186 -0
- data/lib/modern_treasury/models/foreign_exchange_quote.rb +180 -0
- data/lib/modern_treasury/models/foreign_exchange_quote_create_params.rb +89 -0
- data/lib/modern_treasury/models/foreign_exchange_quote_list_params.rb +127 -0
- data/lib/modern_treasury/models/foreign_exchange_quote_retrieve_params.rb +18 -0
- data/lib/modern_treasury/models/incoming_payment_detail.rb +320 -0
- data/lib/modern_treasury/models/incoming_payment_detail_create_async_params.rb +141 -0
- data/lib/modern_treasury/models/incoming_payment_detail_list_params.rb +170 -0
- data/lib/modern_treasury/models/incoming_payment_detail_retrieve_params.rb +18 -0
- data/lib/modern_treasury/models/incoming_payment_detail_update_params.rb +30 -0
- data/lib/modern_treasury/models/internal_account.rb +299 -0
- data/lib/modern_treasury/models/internal_account_create_params.rb +186 -0
- data/lib/modern_treasury/models/internal_account_list_params.rb +157 -0
- data/lib/modern_treasury/models/internal_account_retrieve_params.rb +18 -0
- data/lib/modern_treasury/models/internal_account_update_params.rb +84 -0
- data/lib/modern_treasury/models/internal_accounts/balance_report.rb +260 -0
- data/lib/modern_treasury/models/internal_accounts/balance_report_create_params.rb +135 -0
- data/lib/modern_treasury/models/internal_accounts/balance_report_delete_params.rb +26 -0
- data/lib/modern_treasury/models/internal_accounts/balance_report_list_params.rb +77 -0
- data/lib/modern_treasury/models/internal_accounts/balance_report_retrieve_params.rb +26 -0
- data/lib/modern_treasury/models/invoice.rb +624 -0
- data/lib/modern_treasury/models/invoice_add_payment_order_params.rb +24 -0
- data/lib/modern_treasury/models/invoice_create_params.rb +649 -0
- data/lib/modern_treasury/models/invoice_list_params.rb +163 -0
- data/lib/modern_treasury/models/invoice_retrieve_params.rb +18 -0
- data/lib/modern_treasury/models/invoice_update_params.rb +665 -0
- data/lib/modern_treasury/models/invoices/invoice_line_item.rb +130 -0
- data/lib/modern_treasury/models/invoices/line_item_create_params.rb +108 -0
- data/lib/modern_treasury/models/invoices/line_item_delete_params.rb +26 -0
- data/lib/modern_treasury/models/invoices/line_item_list_params.rb +36 -0
- data/lib/modern_treasury/models/invoices/line_item_retrieve_params.rb +26 -0
- data/lib/modern_treasury/models/invoices/line_item_update_params.rb +123 -0
- data/lib/modern_treasury/models/ledger.rb +73 -0
- data/lib/modern_treasury/models/ledger_account.rb +351 -0
- data/lib/modern_treasury/models/ledger_account_balance_monitor.rb +337 -0
- data/lib/modern_treasury/models/ledger_account_balance_monitor_create_params.rb +92 -0
- data/lib/modern_treasury/models/ledger_account_balance_monitor_delete_params.rb +18 -0
- data/lib/modern_treasury/models/ledger_account_balance_monitor_list_params.rb +70 -0
- data/lib/modern_treasury/models/ledger_account_balance_monitor_retrieve_params.rb +18 -0
- data/lib/modern_treasury/models/ledger_account_balance_monitor_update_params.rb +41 -0
- data/lib/modern_treasury/models/ledger_account_category.rb +282 -0
- data/lib/modern_treasury/models/ledger_account_category_add_ledger_account_params.rb +24 -0
- data/lib/modern_treasury/models/ledger_account_category_add_nested_category_params.rb +24 -0
- data/lib/modern_treasury/models/ledger_account_category_create_params.rb +97 -0
- data/lib/modern_treasury/models/ledger_account_category_delete_params.rb +18 -0
- data/lib/modern_treasury/models/ledger_account_category_list_params.rb +162 -0
- data/lib/modern_treasury/models/ledger_account_category_remove_ledger_account_params.rb +24 -0
- data/lib/modern_treasury/models/ledger_account_category_remove_nested_category_params.rb +24 -0
- data/lib/modern_treasury/models/ledger_account_category_retrieve_params.rb +63 -0
- data/lib/modern_treasury/models/ledger_account_category_update_params.rb +48 -0
- data/lib/modern_treasury/models/ledger_account_create_params.rb +142 -0
- data/lib/modern_treasury/models/ledger_account_delete_params.rb +18 -0
- data/lib/modern_treasury/models/ledger_account_list_params.rb +467 -0
- data/lib/modern_treasury/models/ledger_account_retrieve_params.rb +108 -0
- data/lib/modern_treasury/models/ledger_account_settlement.rb +175 -0
- data/lib/modern_treasury/models/ledger_account_settlement_create_params.rb +117 -0
- data/lib/modern_treasury/models/ledger_account_settlement_list_params.rb +140 -0
- data/lib/modern_treasury/models/ledger_account_settlement_retrieve_params.rb +18 -0
- data/lib/modern_treasury/models/ledger_account_settlement_update_params.rb +64 -0
- data/lib/modern_treasury/models/ledger_account_settlements/account_entry_delete_params.rb +28 -0
- data/lib/modern_treasury/models/ledger_account_settlements/account_entry_update_params.rb +28 -0
- data/lib/modern_treasury/models/ledger_account_statement_create_params.rb +71 -0
- data/lib/modern_treasury/models/ledger_account_statement_create_response.rb +488 -0
- data/lib/modern_treasury/models/ledger_account_statement_retrieve_params.rb +18 -0
- data/lib/modern_treasury/models/ledger_account_statement_retrieve_response.rb +488 -0
- data/lib/modern_treasury/models/ledger_account_update_params.rb +48 -0
- data/lib/modern_treasury/models/ledger_create_params.rb +44 -0
- data/lib/modern_treasury/models/ledger_delete_params.rb +18 -0
- data/lib/modern_treasury/models/ledger_entry.rb +346 -0
- data/lib/modern_treasury/models/ledger_entry_list_params.rb +347 -0
- data/lib/modern_treasury/models/ledger_entry_retrieve_params.rb +30 -0
- data/lib/modern_treasury/models/ledger_entry_update_params.rb +30 -0
- data/lib/modern_treasury/models/ledger_event_handler.rb +218 -0
- data/lib/modern_treasury/models/ledger_event_handler_create_params.rb +185 -0
- data/lib/modern_treasury/models/ledger_event_handler_delete_params.rb +18 -0
- data/lib/modern_treasury/models/ledger_event_handler_list_params.rb +70 -0
- data/lib/modern_treasury/models/ledger_event_handler_retrieve_params.rb +18 -0
- data/lib/modern_treasury/models/ledger_event_handler_variable.rb +58 -0
- data/lib/modern_treasury/models/ledger_list_params.rb +72 -0
- data/lib/modern_treasury/models/ledger_retrieve_params.rb +18 -0
- data/lib/modern_treasury/models/ledger_transaction.rb +213 -0
- data/lib/modern_treasury/models/ledger_transaction_create_params.rb +272 -0
- data/lib/modern_treasury/models/ledger_transaction_create_partial_post_params.rb +127 -0
- data/lib/modern_treasury/models/ledger_transaction_create_reversal_params.rb +146 -0
- data/lib/modern_treasury/models/ledger_transaction_list_params.rb +339 -0
- data/lib/modern_treasury/models/ledger_transaction_retrieve_params.rb +18 -0
- data/lib/modern_treasury/models/ledger_transaction_update_params.rb +250 -0
- data/lib/modern_treasury/models/ledger_transactions/ledger_transaction_version.rb +555 -0
- data/lib/modern_treasury/models/ledger_transactions/version_list_params.rb +96 -0
- data/lib/modern_treasury/models/ledger_update_params.rb +48 -0
- data/lib/modern_treasury/models/ledgerable_event.rb +96 -0
- data/lib/modern_treasury/models/ledgerable_event_create_params.rb +51 -0
- data/lib/modern_treasury/models/ledgerable_event_retrieve_params.rb +18 -0
- data/lib/modern_treasury/models/legal_entity.rb +544 -0
- data/lib/modern_treasury/models/legal_entity_association.rb +655 -0
- data/lib/modern_treasury/models/legal_entity_association_create_params.rb +531 -0
- data/lib/modern_treasury/models/legal_entity_create_params.rb +964 -0
- data/lib/modern_treasury/models/legal_entity_list_params.rb +90 -0
- data/lib/modern_treasury/models/legal_entity_retrieve_params.rb +18 -0
- data/lib/modern_treasury/models/legal_entity_update_params.rb +417 -0
- data/lib/modern_treasury/models/line_item.rb +161 -0
- data/lib/modern_treasury/models/line_item_list_params.rb +53 -0
- data/lib/modern_treasury/models/line_item_retrieve_params.rb +43 -0
- data/lib/modern_treasury/models/line_item_update_params.rb +55 -0
- data/lib/modern_treasury/models/paper_item.rb +175 -0
- data/lib/modern_treasury/models/paper_item_list_params.rb +78 -0
- data/lib/modern_treasury/models/paper_item_retrieve_params.rb +18 -0
- data/lib/modern_treasury/models/payment_flow.rb +293 -0
- data/lib/modern_treasury/models/payment_flow_create_params.rb +95 -0
- data/lib/modern_treasury/models/payment_flow_list_params.rb +107 -0
- data/lib/modern_treasury/models/payment_flow_retrieve_params.rb +18 -0
- data/lib/modern_treasury/models/payment_flow_update_params.rb +40 -0
- data/lib/modern_treasury/models/payment_order.rb +824 -0
- data/lib/modern_treasury/models/payment_order_create_async_params.rb +1387 -0
- data/lib/modern_treasury/models/payment_order_create_params.rb +1460 -0
- data/lib/modern_treasury/models/payment_order_list_params.rb +299 -0
- data/lib/modern_treasury/models/payment_order_retrieve_params.rb +18 -0
- data/lib/modern_treasury/models/payment_order_subtype.rb +49 -0
- data/lib/modern_treasury/models/payment_order_type.rb +49 -0
- data/lib/modern_treasury/models/payment_order_update_params.rb +1146 -0
- data/lib/modern_treasury/models/payment_orders/reversal.rb +139 -0
- data/lib/modern_treasury/models/payment_orders/reversal_create_params.rb +340 -0
- data/lib/modern_treasury/models/payment_orders/reversal_list_params.rb +36 -0
- data/lib/modern_treasury/models/payment_orders/reversal_retrieve_params.rb +26 -0
- data/lib/modern_treasury/models/payment_reference.rb +189 -0
- data/lib/modern_treasury/models/payment_reference_list_params.rb +96 -0
- data/lib/modern_treasury/models/payment_reference_retireve_params.rb +18 -0
- data/lib/modern_treasury/models/payment_reference_retrieve_params.rb +18 -0
- data/lib/modern_treasury/models/ping_response.rb +19 -0
- data/lib/modern_treasury/models/reconciliation_rule.rb +163 -0
- data/lib/modern_treasury/models/return_create_params.rb +154 -0
- data/lib/modern_treasury/models/return_list_params.rb +110 -0
- data/lib/modern_treasury/models/return_object.rb +485 -0
- data/lib/modern_treasury/models/return_retrieve_params.rb +18 -0
- data/lib/modern_treasury/models/routing_detail.rb +276 -0
- data/lib/modern_treasury/models/routing_detail_create_params.rb +141 -0
- data/lib/modern_treasury/models/routing_detail_delete_params.rb +42 -0
- data/lib/modern_treasury/models/routing_detail_list_params.rb +40 -0
- data/lib/modern_treasury/models/routing_detail_retrieve_params.rb +30 -0
- data/lib/modern_treasury/models/routing_number_lookup_request.rb +211 -0
- data/lib/modern_treasury/models/transaction.rb +383 -0
- data/lib/modern_treasury/models/transaction_create_params.rb +163 -0
- data/lib/modern_treasury/models/transaction_delete_params.rb +18 -0
- data/lib/modern_treasury/models/transaction_direction.rb +18 -0
- data/lib/modern_treasury/models/transaction_list_params.rb +186 -0
- data/lib/modern_treasury/models/transaction_retrieve_params.rb +18 -0
- data/lib/modern_treasury/models/transaction_update_params.rb +30 -0
- data/lib/modern_treasury/models/transactions/line_item_create_params.rb +42 -0
- data/lib/modern_treasury/models/transactions/line_item_delete_params.rb +20 -0
- data/lib/modern_treasury/models/transactions/line_item_list_params.rb +75 -0
- data/lib/modern_treasury/models/transactions/line_item_retrieve_params.rb +20 -0
- data/lib/modern_treasury/models/transactions/transaction_line_item.rb +182 -0
- data/lib/modern_treasury/models/validation_validate_routing_number_params.rb +72 -0
- data/lib/modern_treasury/models/virtual_account.rb +148 -0
- data/lib/modern_treasury/models/virtual_account_create_params.rb +444 -0
- data/lib/modern_treasury/models/virtual_account_delete_params.rb +18 -0
- data/lib/modern_treasury/models/virtual_account_list_params.rb +77 -0
- data/lib/modern_treasury/models/virtual_account_retrieve_params.rb +18 -0
- data/lib/modern_treasury/models/virtual_account_update_params.rb +55 -0
- data/lib/modern_treasury/models/wealth_and_employment_details.rb +324 -0
- data/lib/modern_treasury/page.rb +92 -0
- data/lib/modern_treasury/pooled_net_requester.rb +180 -0
- data/lib/modern_treasury/request_options.rb +108 -0
- data/lib/modern_treasury/resources/account_collection_flows.rb +108 -0
- data/lib/modern_treasury/resources/account_details.rb +136 -0
- data/lib/modern_treasury/resources/bulk_requests.rb +91 -0
- data/lib/modern_treasury/resources/bulk_results.rb +66 -0
- data/lib/modern_treasury/resources/connection_legal_entities.rb +105 -0
- data/lib/modern_treasury/resources/connections.rb +39 -0
- data/lib/modern_treasury/resources/counterparties.rb +203 -0
- data/lib/modern_treasury/resources/documents.rb +86 -0
- data/lib/modern_treasury/resources/events.rb +63 -0
- data/lib/modern_treasury/resources/expected_payments.rb +227 -0
- data/lib/modern_treasury/resources/external_accounts.rb +222 -0
- data/lib/modern_treasury/resources/foreign_exchange_quotes.rb +101 -0
- data/lib/modern_treasury/resources/incoming_payment_details.rb +133 -0
- data/lib/modern_treasury/resources/internal_accounts/balance_reports.rb +128 -0
- data/lib/modern_treasury/resources/internal_accounts.rb +140 -0
- data/lib/modern_treasury/resources/invoices/line_items.rb +177 -0
- data/lib/modern_treasury/resources/invoices.rb +286 -0
- data/lib/modern_treasury/resources/ledger_account_balance_monitors.rb +132 -0
- data/lib/modern_treasury/resources/ledger_account_categories.rb +266 -0
- data/lib/modern_treasury/resources/ledger_account_settlements/account_entries.rb +62 -0
- data/lib/modern_treasury/resources/ledger_account_settlements.rb +152 -0
- data/lib/modern_treasury/resources/ledger_account_statements.rb +62 -0
- data/lib/modern_treasury/resources/ledger_accounts.rb +189 -0
- data/lib/modern_treasury/resources/ledger_entries.rb +137 -0
- data/lib/modern_treasury/resources/ledger_event_handlers.rb +114 -0
- data/lib/modern_treasury/resources/ledger_transactions/versions.rb +50 -0
- data/lib/modern_treasury/resources/ledger_transactions.rb +262 -0
- data/lib/modern_treasury/resources/ledgerable_events.rb +57 -0
- data/lib/modern_treasury/resources/ledgers.rb +134 -0
- data/lib/modern_treasury/resources/legal_entities.rb +193 -0
- data/lib/modern_treasury/resources/legal_entity_associations.rb +43 -0
- data/lib/modern_treasury/resources/line_items.rb +109 -0
- data/lib/modern_treasury/resources/paper_items.rb +60 -0
- data/lib/modern_treasury/resources/payment_flows.rb +123 -0
- data/lib/modern_treasury/resources/payment_orders/reversals.rb +95 -0
- data/lib/modern_treasury/resources/payment_orders.rb +517 -0
- data/lib/modern_treasury/resources/payment_references.rb +66 -0
- data/lib/modern_treasury/resources/returns.rb +98 -0
- data/lib/modern_treasury/resources/routing_details.rb +140 -0
- data/lib/modern_treasury/resources/transactions/line_items.rb +104 -0
- data/lib/modern_treasury/resources/transactions.rb +174 -0
- data/lib/modern_treasury/resources/validations.rb +38 -0
- data/lib/modern_treasury/resources/virtual_accounts.rb +152 -0
- data/lib/modern_treasury/util.rb +728 -0
- data/lib/modern_treasury/version.rb +5 -0
- data/lib/modern_treasury.rb +310 -0
- data/manifest.yaml +14 -0
- data/rbi/lib/modern_treasury/base_client.rbi +197 -0
- data/rbi/lib/modern_treasury/base_model.rbi +645 -0
- data/rbi/lib/modern_treasury/base_page.rbi +36 -0
- data/rbi/lib/modern_treasury/client.rbi +174 -0
- data/rbi/lib/modern_treasury/errors.rbi +144 -0
- data/rbi/lib/modern_treasury/extern.rbi +7 -0
- data/rbi/lib/modern_treasury/models/account_collection_flow.rbi +203 -0
- data/rbi/lib/modern_treasury/models/account_collection_flow_create_params.rbi +114 -0
- data/rbi/lib/modern_treasury/models/account_collection_flow_list_params.rbi +83 -0
- data/rbi/lib/modern_treasury/models/account_collection_flow_retrieve_params.rbi +21 -0
- data/rbi/lib/modern_treasury/models/account_collection_flow_update_params.rbi +57 -0
- data/rbi/lib/modern_treasury/models/account_detail.rbi +115 -0
- data/rbi/lib/modern_treasury/models/account_detail_create_params.rbi +107 -0
- data/rbi/lib/modern_treasury/models/account_detail_delete_params.rbi +56 -0
- data/rbi/lib/modern_treasury/models/account_detail_list_params.rbi +48 -0
- data/rbi/lib/modern_treasury/models/account_detail_retrieve_params.rbi +40 -0
- data/rbi/lib/modern_treasury/models/accounts_type.rbi +19 -0
- data/rbi/lib/modern_treasury/models/async_response.rbi +21 -0
- data/rbi/lib/modern_treasury/models/bank_settings.rbi +96 -0
- data/rbi/lib/modern_treasury/models/bulk_request.rbi +162 -0
- data/rbi/lib/modern_treasury/models/bulk_request_create_params.rbi +6311 -0
- data/rbi/lib/modern_treasury/models/bulk_request_list_params.rbi +146 -0
- data/rbi/lib/modern_treasury/models/bulk_request_retrieve_params.rbi +21 -0
- data/rbi/lib/modern_treasury/models/bulk_result.rbi +286 -0
- data/rbi/lib/modern_treasury/models/bulk_result_list_params.rbi +157 -0
- data/rbi/lib/modern_treasury/models/bulk_result_retrieve_params.rbi +21 -0
- data/rbi/lib/modern_treasury/models/client_ping_params.rbi +21 -0
- data/rbi/lib/modern_treasury/models/connection.rbi +85 -0
- data/rbi/lib/modern_treasury/models/connection_legal_entity.rbi +110 -0
- data/rbi/lib/modern_treasury/models/connection_legal_entity_create_params.rbi +1752 -0
- data/rbi/lib/modern_treasury/models/connection_legal_entity_list_params.rbi +94 -0
- data/rbi/lib/modern_treasury/models/connection_legal_entity_retrieve_params.rbi +21 -0
- data/rbi/lib/modern_treasury/models/connection_legal_entity_update_params.rbi +58 -0
- data/rbi/lib/modern_treasury/models/connection_list_params.rbi +61 -0
- data/rbi/lib/modern_treasury/models/counterparty.rbi +607 -0
- data/rbi/lib/modern_treasury/models/counterparty_collect_account_params.rbi +161 -0
- data/rbi/lib/modern_treasury/models/counterparty_collect_account_response.rbi +31 -0
- data/rbi/lib/modern_treasury/models/counterparty_create_params.rbi +2867 -0
- data/rbi/lib/modern_treasury/models/counterparty_delete_params.rbi +21 -0
- data/rbi/lib/modern_treasury/models/counterparty_list_params.rbi +111 -0
- data/rbi/lib/modern_treasury/models/counterparty_retrieve_params.rbi +21 -0
- data/rbi/lib/modern_treasury/models/counterparty_update_params.rbi +91 -0
- data/rbi/lib/modern_treasury/models/currency.rbi +207 -0
- data/rbi/lib/modern_treasury/models/document.rbi +243 -0
- data/rbi/lib/modern_treasury/models/document_create_params.rbi +95 -0
- data/rbi/lib/modern_treasury/models/document_list_params.rbi +105 -0
- data/rbi/lib/modern_treasury/models/document_retrieve_params.rbi +21 -0
- data/rbi/lib/modern_treasury/models/event.rbi +82 -0
- data/rbi/lib/modern_treasury/models/event_list_params.rbi +94 -0
- data/rbi/lib/modern_treasury/models/event_retrieve_params.rbi +21 -0
- data/rbi/lib/modern_treasury/models/expected_payment.rbi +272 -0
- data/rbi/lib/modern_treasury/models/expected_payment_create_params.rbi +616 -0
- data/rbi/lib/modern_treasury/models/expected_payment_delete_params.rbi +21 -0
- data/rbi/lib/modern_treasury/models/expected_payment_list_params.rbi +197 -0
- data/rbi/lib/modern_treasury/models/expected_payment_retrieve_params.rbi +21 -0
- data/rbi/lib/modern_treasury/models/expected_payment_type.rbi +49 -0
- data/rbi/lib/modern_treasury/models/expected_payment_update_params.rbi +201 -0
- data/rbi/lib/modern_treasury/models/external_account.rbi +410 -0
- data/rbi/lib/modern_treasury/models/external_account_complete_verification_params.rbi +30 -0
- data/rbi/lib/modern_treasury/models/external_account_create_params.rbi +959 -0
- data/rbi/lib/modern_treasury/models/external_account_delete_params.rbi +21 -0
- data/rbi/lib/modern_treasury/models/external_account_list_params.rbi +78 -0
- data/rbi/lib/modern_treasury/models/external_account_retrieve_params.rbi +21 -0
- data/rbi/lib/modern_treasury/models/external_account_type.rbi +26 -0
- data/rbi/lib/modern_treasury/models/external_account_update_params.rbi +170 -0
- data/rbi/lib/modern_treasury/models/external_account_verify_params.rbi +167 -0
- data/rbi/lib/modern_treasury/models/external_account_verify_response.rbi +395 -0
- data/rbi/lib/modern_treasury/models/foreign_exchange_quote.rbi +188 -0
- data/rbi/lib/modern_treasury/models/foreign_exchange_quote_create_params.rbi +88 -0
- data/rbi/lib/modern_treasury/models/foreign_exchange_quote_list_params.rbi +119 -0
- data/rbi/lib/modern_treasury/models/foreign_exchange_quote_retrieve_params.rbi +21 -0
- data/rbi/lib/modern_treasury/models/incoming_payment_detail.rbi +427 -0
- data/rbi/lib/modern_treasury/models/incoming_payment_detail_create_async_params.rbi +153 -0
- data/rbi/lib/modern_treasury/models/incoming_payment_detail_list_params.rbi +170 -0
- data/rbi/lib/modern_treasury/models/incoming_payment_detail_retrieve_params.rbi +21 -0
- data/rbi/lib/modern_treasury/models/incoming_payment_detail_update_params.rbi +34 -0
- data/rbi/lib/modern_treasury/models/internal_account.rbi +302 -0
- data/rbi/lib/modern_treasury/models/internal_account_create_params.rbi +193 -0
- data/rbi/lib/modern_treasury/models/internal_account_list_params.rbi +158 -0
- data/rbi/lib/modern_treasury/models/internal_account_retrieve_params.rbi +21 -0
- data/rbi/lib/modern_treasury/models/internal_account_update_params.rbi +83 -0
- data/rbi/lib/modern_treasury/models/internal_accounts/balance_report.rbi +311 -0
- data/rbi/lib/modern_treasury/models/internal_accounts/balance_report_create_params.rbi +235 -0
- data/rbi/lib/modern_treasury/models/internal_accounts/balance_report_delete_params.rbi +31 -0
- data/rbi/lib/modern_treasury/models/internal_accounts/balance_report_list_params.rbi +119 -0
- data/rbi/lib/modern_treasury/models/internal_accounts/balance_report_retrieve_params.rbi +31 -0
- data/rbi/lib/modern_treasury/models/invoice.rbi +648 -0
- data/rbi/lib/modern_treasury/models/invoice_add_payment_order_params.rbi +30 -0
- data/rbi/lib/modern_treasury/models/invoice_create_params.rbi +707 -0
- data/rbi/lib/modern_treasury/models/invoice_list_params.rbi +154 -0
- data/rbi/lib/modern_treasury/models/invoice_retrieve_params.rbi +21 -0
- data/rbi/lib/modern_treasury/models/invoice_update_params.rbi +719 -0
- data/rbi/lib/modern_treasury/models/invoices/invoice_line_item.rbi +126 -0
- data/rbi/lib/modern_treasury/models/invoices/line_item_create_params.rbi +105 -0
- data/rbi/lib/modern_treasury/models/invoices/line_item_delete_params.rbi +29 -0
- data/rbi/lib/modern_treasury/models/invoices/line_item_list_params.rbi +45 -0
- data/rbi/lib/modern_treasury/models/invoices/line_item_retrieve_params.rbi +29 -0
- data/rbi/lib/modern_treasury/models/invoices/line_item_update_params.rbi +117 -0
- data/rbi/lib/modern_treasury/models/ledger.rbi +76 -0
- data/rbi/lib/modern_treasury/models/ledger_account.rbi +401 -0
- data/rbi/lib/modern_treasury/models/ledger_account_balance_monitor.rbi +447 -0
- data/rbi/lib/modern_treasury/models/ledger_account_balance_monitor_create_params.rbi +103 -0
- data/rbi/lib/modern_treasury/models/ledger_account_balance_monitor_delete_params.rbi +21 -0
- data/rbi/lib/modern_treasury/models/ledger_account_balance_monitor_list_params.rbi +73 -0
- data/rbi/lib/modern_treasury/models/ledger_account_balance_monitor_retrieve_params.rbi +21 -0
- data/rbi/lib/modern_treasury/models/ledger_account_balance_monitor_update_params.rbi +49 -0
- data/rbi/lib/modern_treasury/models/ledger_account_category.rbi +354 -0
- data/rbi/lib/modern_treasury/models/ledger_account_category_add_ledger_account_params.rbi +30 -0
- data/rbi/lib/modern_treasury/models/ledger_account_category_add_nested_category_params.rbi +30 -0
- data/rbi/lib/modern_treasury/models/ledger_account_category_create_params.rbi +96 -0
- data/rbi/lib/modern_treasury/models/ledger_account_category_delete_params.rbi +21 -0
- data/rbi/lib/modern_treasury/models/ledger_account_category_list_params.rbi +154 -0
- data/rbi/lib/modern_treasury/models/ledger_account_category_remove_ledger_account_params.rbi +30 -0
- data/rbi/lib/modern_treasury/models/ledger_account_category_remove_nested_category_params.rbi +30 -0
- data/rbi/lib/modern_treasury/models/ledger_account_category_retrieve_params.rbi +77 -0
- data/rbi/lib/modern_treasury/models/ledger_account_category_update_params.rbi +55 -0
- data/rbi/lib/modern_treasury/models/ledger_account_create_params.rbi +146 -0
- data/rbi/lib/modern_treasury/models/ledger_account_delete_params.rbi +21 -0
- data/rbi/lib/modern_treasury/models/ledger_account_list_params.rbi +454 -0
- data/rbi/lib/modern_treasury/models/ledger_account_retrieve_params.rbi +121 -0
- data/rbi/lib/modern_treasury/models/ledger_account_settlement.rbi +169 -0
- data/rbi/lib/modern_treasury/models/ledger_account_settlement_create_params.rbi +123 -0
- data/rbi/lib/modern_treasury/models/ledger_account_settlement_list_params.rbi +130 -0
- data/rbi/lib/modern_treasury/models/ledger_account_settlement_retrieve_params.rbi +21 -0
- data/rbi/lib/modern_treasury/models/ledger_account_settlement_update_params.rbi +79 -0
- data/rbi/lib/modern_treasury/models/ledger_account_settlements/account_entry_delete_params.rbi +39 -0
- data/rbi/lib/modern_treasury/models/ledger_account_settlements/account_entry_update_params.rbi +37 -0
- data/rbi/lib/modern_treasury/models/ledger_account_statement_create_params.rbi +74 -0
- data/rbi/lib/modern_treasury/models/ledger_account_statement_create_response.rbi +638 -0
- data/rbi/lib/modern_treasury/models/ledger_account_statement_retrieve_params.rbi +21 -0
- data/rbi/lib/modern_treasury/models/ledger_account_statement_retrieve_response.rbi +638 -0
- data/rbi/lib/modern_treasury/models/ledger_account_update_params.rbi +55 -0
- data/rbi/lib/modern_treasury/models/ledger_create_params.rbi +52 -0
- data/rbi/lib/modern_treasury/models/ledger_delete_params.rbi +21 -0
- data/rbi/lib/modern_treasury/models/ledger_entry.rbi +415 -0
- data/rbi/lib/modern_treasury/models/ledger_entry_list_params.rbi +342 -0
- data/rbi/lib/modern_treasury/models/ledger_entry_retrieve_params.rbi +32 -0
- data/rbi/lib/modern_treasury/models/ledger_entry_update_params.rbi +34 -0
- data/rbi/lib/modern_treasury/models/ledger_event_handler.rbi +231 -0
- data/rbi/lib/modern_treasury/models/ledger_event_handler_create_params.rbi +210 -0
- data/rbi/lib/modern_treasury/models/ledger_event_handler_delete_params.rbi +21 -0
- data/rbi/lib/modern_treasury/models/ledger_event_handler_list_params.rbi +73 -0
- data/rbi/lib/modern_treasury/models/ledger_event_handler_retrieve_params.rbi +21 -0
- data/rbi/lib/modern_treasury/models/ledger_event_handler_variable.rbi +59 -0
- data/rbi/lib/modern_treasury/models/ledger_list_params.rbi +75 -0
- data/rbi/lib/modern_treasury/models/ledger_retrieve_params.rbi +21 -0
- data/rbi/lib/modern_treasury/models/ledger_transaction.rbi +208 -0
- data/rbi/lib/modern_treasury/models/ledger_transaction_create_params.rbi +286 -0
- data/rbi/lib/modern_treasury/models/ledger_transaction_create_partial_post_params.rbi +171 -0
- data/rbi/lib/modern_treasury/models/ledger_transaction_create_reversal_params.rbi +191 -0
- data/rbi/lib/modern_treasury/models/ledger_transaction_list_params.rbi +360 -0
- data/rbi/lib/modern_treasury/models/ledger_transaction_retrieve_params.rbi +21 -0
- data/rbi/lib/modern_treasury/models/ledger_transaction_update_params.rbi +272 -0
- data/rbi/lib/modern_treasury/models/ledger_transactions/ledger_transaction_version.rbi +731 -0
- data/rbi/lib/modern_treasury/models/ledger_transactions/version_list_params.rbi +94 -0
- data/rbi/lib/modern_treasury/models/ledger_update_params.rbi +55 -0
- data/rbi/lib/modern_treasury/models/ledgerable_event.rbi +94 -0
- data/rbi/lib/modern_treasury/models/ledgerable_event_create_params.rbi +58 -0
- data/rbi/lib/modern_treasury/models/ledgerable_event_retrieve_params.rbi +21 -0
- data/rbi/lib/modern_treasury/models/legal_entity.rbi +543 -0
- data/rbi/lib/modern_treasury/models/legal_entity_association.rbi +879 -0
- data/rbi/lib/modern_treasury/models/legal_entity_association_create_params.rbi +892 -0
- data/rbi/lib/modern_treasury/models/legal_entity_create_params.rbi +1421 -0
- data/rbi/lib/modern_treasury/models/legal_entity_list_params.rbi +94 -0
- data/rbi/lib/modern_treasury/models/legal_entity_retrieve_params.rbi +21 -0
- data/rbi/lib/modern_treasury/models/legal_entity_update_params.rbi +487 -0
- data/rbi/lib/modern_treasury/models/line_item.rbi +158 -0
- data/rbi/lib/modern_treasury/models/line_item_list_params.rbi +65 -0
- data/rbi/lib/modern_treasury/models/line_item_retrieve_params.rbi +58 -0
- data/rbi/lib/modern_treasury/models/line_item_update_params.rbi +68 -0
- data/rbi/lib/modern_treasury/models/paper_item.rbi +167 -0
- data/rbi/lib/modern_treasury/models/paper_item_list_params.rbi +78 -0
- data/rbi/lib/modern_treasury/models/paper_item_retrieve_params.rbi +21 -0
- data/rbi/lib/modern_treasury/models/payment_flow.rbi +285 -0
- data/rbi/lib/modern_treasury/models/payment_flow_create_params.rbi +99 -0
- data/rbi/lib/modern_treasury/models/payment_flow_list_params.rbi +101 -0
- data/rbi/lib/modern_treasury/models/payment_flow_retrieve_params.rbi +21 -0
- data/rbi/lib/modern_treasury/models/payment_flow_update_params.rbi +53 -0
- data/rbi/lib/modern_treasury/models/payment_order.rbi +1115 -0
- data/rbi/lib/modern_treasury/models/payment_order_create_async_params.rbi +2008 -0
- data/rbi/lib/modern_treasury/models/payment_order_create_params.rbi +2083 -0
- data/rbi/lib/modern_treasury/models/payment_order_list_params.rbi +282 -0
- data/rbi/lib/modern_treasury/models/payment_order_retrieve_params.rbi +21 -0
- data/rbi/lib/modern_treasury/models/payment_order_subtype.rbi +50 -0
- data/rbi/lib/modern_treasury/models/payment_order_type.rbi +50 -0
- data/rbi/lib/modern_treasury/models/payment_order_update_params.rbi +1651 -0
- data/rbi/lib/modern_treasury/models/payment_orders/reversal.rbi +145 -0
- data/rbi/lib/modern_treasury/models/payment_orders/reversal_create_params.rbi +465 -0
- data/rbi/lib/modern_treasury/models/payment_orders/reversal_list_params.rbi +45 -0
- data/rbi/lib/modern_treasury/models/payment_orders/reversal_retrieve_params.rbi +29 -0
- data/rbi/lib/modern_treasury/models/payment_reference.rbi +371 -0
- data/rbi/lib/modern_treasury/models/payment_reference_list_params.rbi +109 -0
- data/rbi/lib/modern_treasury/models/payment_reference_retireve_params.rbi +21 -0
- data/rbi/lib/modern_treasury/models/payment_reference_retrieve_params.rbi +21 -0
- data/rbi/lib/modern_treasury/models/ping_response.rbi +18 -0
- data/rbi/lib/modern_treasury/models/reconciliation_rule.rbi +164 -0
- data/rbi/lib/modern_treasury/models/return_create_params.rbi +161 -0
- data/rbi/lib/modern_treasury/models/return_list_params.rbi +112 -0
- data/rbi/lib/modern_treasury/models/return_object.rbi +769 -0
- data/rbi/lib/modern_treasury/models/return_retrieve_params.rbi +21 -0
- data/rbi/lib/modern_treasury/models/routing_detail.rbi +297 -0
- data/rbi/lib/modern_treasury/models/routing_detail_create_params.rbi +207 -0
- data/rbi/lib/modern_treasury/models/routing_detail_delete_params.rbi +56 -0
- data/rbi/lib/modern_treasury/models/routing_detail_list_params.rbi +48 -0
- data/rbi/lib/modern_treasury/models/routing_detail_retrieve_params.rbi +40 -0
- data/rbi/lib/modern_treasury/models/routing_number_lookup_request.rbi +291 -0
- data/rbi/lib/modern_treasury/models/transaction.rbi +380 -0
- data/rbi/lib/modern_treasury/models/transaction_create_params.rbi +162 -0
- data/rbi/lib/modern_treasury/models/transaction_delete_params.rbi +21 -0
- data/rbi/lib/modern_treasury/models/transaction_direction.rbi +19 -0
- data/rbi/lib/modern_treasury/models/transaction_list_params.rbi +168 -0
- data/rbi/lib/modern_treasury/models/transaction_retrieve_params.rbi +21 -0
- data/rbi/lib/modern_treasury/models/transaction_update_params.rbi +34 -0
- data/rbi/lib/modern_treasury/models/transactions/line_item_create_params.rbi +51 -0
- data/rbi/lib/modern_treasury/models/transactions/line_item_delete_params.rbi +23 -0
- data/rbi/lib/modern_treasury/models/transactions/line_item_list_params.rbi +84 -0
- data/rbi/lib/modern_treasury/models/transactions/line_item_retrieve_params.rbi +23 -0
- data/rbi/lib/modern_treasury/models/transactions/transaction_line_item.rbi +212 -0
- data/rbi/lib/modern_treasury/models/validation_validate_routing_number_params.rbi +178 -0
- data/rbi/lib/modern_treasury/models/virtual_account.rbi +141 -0
- data/rbi/lib/modern_treasury/models/virtual_account_create_params.rbi +753 -0
- data/rbi/lib/modern_treasury/models/virtual_account_delete_params.rbi +21 -0
- data/rbi/lib/modern_treasury/models/virtual_account_list_params.rbi +77 -0
- data/rbi/lib/modern_treasury/models/virtual_account_retrieve_params.rbi +21 -0
- data/rbi/lib/modern_treasury/models/virtual_account_update_params.rbi +60 -0
- data/rbi/lib/modern_treasury/models/wealth_and_employment_details.rbi +410 -0
- data/rbi/lib/modern_treasury/page.rbi +31 -0
- data/rbi/lib/modern_treasury/pooled_net_requester.rbi +62 -0
- data/rbi/lib/modern_treasury/request_options.rbi +63 -0
- data/rbi/lib/modern_treasury/resources/account_collection_flows.rbi +88 -0
- data/rbi/lib/modern_treasury/resources/account_details.rbi +100 -0
- data/rbi/lib/modern_treasury/resources/bulk_requests.rbi +95 -0
- data/rbi/lib/modern_treasury/resources/bulk_results.rbi +60 -0
- data/rbi/lib/modern_treasury/resources/connection_legal_entities.rbi +90 -0
- data/rbi/lib/modern_treasury/resources/connections.rbi +33 -0
- data/rbi/lib/modern_treasury/resources/counterparties.rbi +198 -0
- data/rbi/lib/modern_treasury/resources/documents.rbi +72 -0
- data/rbi/lib/modern_treasury/resources/events.rbi +54 -0
- data/rbi/lib/modern_treasury/resources/expected_payments.rbi +248 -0
- data/rbi/lib/modern_treasury/resources/external_accounts.rbi +212 -0
- data/rbi/lib/modern_treasury/resources/foreign_exchange_quotes.rbi +97 -0
- data/rbi/lib/modern_treasury/resources/incoming_payment_details.rbi +127 -0
- data/rbi/lib/modern_treasury/resources/internal_accounts/balance_reports.rbi +106 -0
- data/rbi/lib/modern_treasury/resources/internal_accounts.rbi +137 -0
- data/rbi/lib/modern_treasury/resources/invoices/line_items.rbi +157 -0
- data/rbi/lib/modern_treasury/resources/invoices.rbi +338 -0
- data/rbi/lib/modern_treasury/resources/ledger_account_balance_monitors.rbi +119 -0
- data/rbi/lib/modern_treasury/resources/ledger_account_categories.rbi +227 -0
- data/rbi/lib/modern_treasury/resources/ledger_account_settlements/account_entries.rbi +51 -0
- data/rbi/lib/modern_treasury/resources/ledger_account_settlements.rbi +143 -0
- data/rbi/lib/modern_treasury/resources/ledger_account_statements.rbi +57 -0
- data/rbi/lib/modern_treasury/resources/ledger_accounts.rbi +191 -0
- data/rbi/lib/modern_treasury/resources/ledger_entries.rbi +135 -0
- data/rbi/lib/modern_treasury/resources/ledger_event_handlers.rbi +107 -0
- data/rbi/lib/modern_treasury/resources/ledger_transactions/versions.rbi +46 -0
- data/rbi/lib/modern_treasury/resources/ledger_transactions.rbi +268 -0
- data/rbi/lib/modern_treasury/resources/ledgerable_events.rbi +51 -0
- data/rbi/lib/modern_treasury/resources/ledgers.rbi +118 -0
- data/rbi/lib/modern_treasury/resources/legal_entities.rbi +217 -0
- data/rbi/lib/modern_treasury/resources/legal_entity_associations.rbi +44 -0
- data/rbi/lib/modern_treasury/resources/line_items.rbi +81 -0
- data/rbi/lib/modern_treasury/resources/paper_items.rbi +52 -0
- data/rbi/lib/modern_treasury/resources/payment_flows.rbi +108 -0
- data/rbi/lib/modern_treasury/resources/payment_orders/reversals.rbi +82 -0
- data/rbi/lib/modern_treasury/resources/payment_orders.rbi +601 -0
- data/rbi/lib/modern_treasury/resources/payment_references.rbi +53 -0
- data/rbi/lib/modern_treasury/resources/returns.rbi +91 -0
- data/rbi/lib/modern_treasury/resources/routing_details.rbi +105 -0
- data/rbi/lib/modern_treasury/resources/transactions/line_items.rbi +87 -0
- data/rbi/lib/modern_treasury/resources/transactions.rbi +166 -0
- data/rbi/lib/modern_treasury/resources/validations.rbi +33 -0
- data/rbi/lib/modern_treasury/resources/virtual_accounts.rbi +139 -0
- data/rbi/lib/modern_treasury/util.rbi +281 -0
- data/rbi/lib/modern_treasury/version.rbi +5 -0
- data/sig/modern_treasury/base_client.rbs +108 -0
- data/sig/modern_treasury/base_model.rbs +262 -0
- data/sig/modern_treasury/base_page.rbs +20 -0
- data/sig/modern_treasury/client.rbs +106 -0
- data/sig/modern_treasury/errors.rbs +99 -0
- data/sig/modern_treasury/extern.rbs +4 -0
- data/sig/modern_treasury/models/account_collection_flow.rbs +147 -0
- data/sig/modern_treasury/models/account_collection_flow_create_params.rbs +80 -0
- data/sig/modern_treasury/models/account_collection_flow_list_params.rbs +53 -0
- data/sig/modern_treasury/models/account_collection_flow_retrieve_params.rbs +15 -0
- data/sig/modern_treasury/models/account_collection_flow_update_params.rbs +33 -0
- data/sig/modern_treasury/models/account_detail.rbs +81 -0
- data/sig/modern_treasury/models/account_detail_create_params.rbs +74 -0
- data/sig/modern_treasury/models/account_detail_delete_params.rbs +37 -0
- data/sig/modern_treasury/models/account_detail_list_params.rbs +33 -0
- data/sig/modern_treasury/models/account_detail_retrieve_params.rbs +27 -0
- data/sig/modern_treasury/models/accounts_type.rbs +14 -0
- data/sig/modern_treasury/models/async_response.rbs +15 -0
- data/sig/modern_treasury/models/bank_settings.rbs +54 -0
- data/sig/modern_treasury/models/bulk_request.rbs +100 -0
- data/sig/modern_treasury/models/bulk_request_create_params.rbs +2594 -0
- data/sig/modern_treasury/models/bulk_request_list_params.rbs +97 -0
- data/sig/modern_treasury/models/bulk_request_retrieve_params.rbs +15 -0
- data/sig/modern_treasury/models/bulk_result.rbs +176 -0
- data/sig/modern_treasury/models/bulk_result_list_params.rbs +106 -0
- data/sig/modern_treasury/models/bulk_result_retrieve_params.rbs +14 -0
- data/sig/modern_treasury/models/client_ping_params.rbs +14 -0
- data/sig/modern_treasury/models/connection.rbs +50 -0
- data/sig/modern_treasury/models/connection_legal_entity.rbs +67 -0
- data/sig/modern_treasury/models/connection_legal_entity_create_params.rbs +711 -0
- data/sig/modern_treasury/models/connection_legal_entity_list_params.rbs +62 -0
- data/sig/modern_treasury/models/connection_legal_entity_retrieve_params.rbs +15 -0
- data/sig/modern_treasury/models/connection_legal_entity_update_params.rbs +37 -0
- data/sig/modern_treasury/models/connection_list_params.rbs +41 -0
- data/sig/modern_treasury/models/counterparty.rbs +343 -0
- data/sig/modern_treasury/models/counterparty_collect_account_params.rbs +110 -0
- data/sig/modern_treasury/models/counterparty_collect_account_response.rbs +18 -0
- data/sig/modern_treasury/models/counterparty_create_params.rbs +1265 -0
- data/sig/modern_treasury/models/counterparty_delete_params.rbs +14 -0
- data/sig/modern_treasury/models/counterparty_list_params.rbs +65 -0
- data/sig/modern_treasury/models/counterparty_retrieve_params.rbs +15 -0
- data/sig/modern_treasury/models/counterparty_update_params.rbs +53 -0
- data/sig/modern_treasury/models/currency.rbs +390 -0
- data/sig/modern_treasury/models/document.rbs +162 -0
- data/sig/modern_treasury/models/document_create_params.rbs +70 -0
- data/sig/modern_treasury/models/document_list_params.rbs +76 -0
- data/sig/modern_treasury/models/document_retrieve_params.rbs +14 -0
- data/sig/modern_treasury/models/event.rbs +54 -0
- data/sig/modern_treasury/models/event_list_params.rbs +59 -0
- data/sig/modern_treasury/models/event_retrieve_params.rbs +14 -0
- data/sig/modern_treasury/models/expected_payment.rbs +154 -0
- data/sig/modern_treasury/models/expected_payment_create_params.rbs +294 -0
- data/sig/modern_treasury/models/expected_payment_delete_params.rbs +15 -0
- data/sig/modern_treasury/models/expected_payment_list_params.rbs +166 -0
- data/sig/modern_treasury/models/expected_payment_retrieve_params.rbs +15 -0
- data/sig/modern_treasury/models/expected_payment_type.rbs +72 -0
- data/sig/modern_treasury/models/expected_payment_update_params.rbs +110 -0
- data/sig/modern_treasury/models/external_account.rbs +235 -0
- data/sig/modern_treasury/models/external_account_complete_verification_params.rbs +22 -0
- data/sig/modern_treasury/models/external_account_create_params.rbs +463 -0
- data/sig/modern_treasury/models/external_account_delete_params.rbs +15 -0
- data/sig/modern_treasury/models/external_account_list_params.rbs +47 -0
- data/sig/modern_treasury/models/external_account_retrieve_params.rbs +15 -0
- data/sig/modern_treasury/models/external_account_type.rbs +28 -0
- data/sig/modern_treasury/models/external_account_update_params.rbs +105 -0
- data/sig/modern_treasury/models/external_account_verify_params.rbs +141 -0
- data/sig/modern_treasury/models/external_account_verify_response.rbs +157 -0
- data/sig/modern_treasury/models/foreign_exchange_quote.rbs +103 -0
- data/sig/modern_treasury/models/foreign_exchange_quote_create_params.rbs +53 -0
- data/sig/modern_treasury/models/foreign_exchange_quote_list_params.rbs +71 -0
- data/sig/modern_treasury/models/foreign_exchange_quote_retrieve_params.rbs +15 -0
- data/sig/modern_treasury/models/incoming_payment_detail.rbs +225 -0
- data/sig/modern_treasury/models/incoming_payment_detail_create_async_params.rbs +93 -0
- data/sig/modern_treasury/models/incoming_payment_detail_list_params.rbs +108 -0
- data/sig/modern_treasury/models/incoming_payment_detail_retrieve_params.rbs +15 -0
- data/sig/modern_treasury/models/incoming_payment_detail_update_params.rbs +22 -0
- data/sig/modern_treasury/models/internal_account.rbs +181 -0
- data/sig/modern_treasury/models/internal_account_create_params.rbs +115 -0
- data/sig/modern_treasury/models/internal_account_list_params.rbs +140 -0
- data/sig/modern_treasury/models/internal_account_retrieve_params.rbs +15 -0
- data/sig/modern_treasury/models/internal_account_update_params.rbs +49 -0
- data/sig/modern_treasury/models/internal_accounts/balance_report.rbs +160 -0
- data/sig/modern_treasury/models/internal_accounts/balance_report_create_params.rbs +105 -0
- data/sig/modern_treasury/models/internal_accounts/balance_report_delete_params.rbs +22 -0
- data/sig/modern_treasury/models/internal_accounts/balance_report_list_params.rbs +59 -0
- data/sig/modern_treasury/models/internal_accounts/balance_report_retrieve_params.rbs +22 -0
- data/sig/modern_treasury/models/invoice.rbs +367 -0
- data/sig/modern_treasury/models/invoice_add_payment_order_params.rbs +20 -0
- data/sig/modern_treasury/models/invoice_create_params.rbs +370 -0
- data/sig/modern_treasury/models/invoice_list_params.rbs +101 -0
- data/sig/modern_treasury/models/invoice_retrieve_params.rbs +14 -0
- data/sig/modern_treasury/models/invoice_update_params.rbs +378 -0
- data/sig/modern_treasury/models/invoices/invoice_line_item.rbs +70 -0
- data/sig/modern_treasury/models/invoices/line_item_create_params.rbs +59 -0
- data/sig/modern_treasury/models/invoices/line_item_delete_params.rbs +22 -0
- data/sig/modern_treasury/models/invoices/line_item_list_params.rbs +28 -0
- data/sig/modern_treasury/models/invoices/line_item_retrieve_params.rbs +22 -0
- data/sig/modern_treasury/models/invoices/line_item_update_params.rbs +67 -0
- data/sig/modern_treasury/models/ledger.rbs +50 -0
- data/sig/modern_treasury/models/ledger_account.rbs +212 -0
- data/sig/modern_treasury/models/ledger_account_balance_monitor.rbs +215 -0
- data/sig/modern_treasury/models/ledger_account_balance_monitor_create_params.rbs +57 -0
- data/sig/modern_treasury/models/ledger_account_balance_monitor_delete_params.rbs +15 -0
- data/sig/modern_treasury/models/ledger_account_balance_monitor_list_params.rbs +47 -0
- data/sig/modern_treasury/models/ledger_account_balance_monitor_retrieve_params.rbs +15 -0
- data/sig/modern_treasury/models/ledger_account_balance_monitor_update_params.rbs +28 -0
- data/sig/modern_treasury/models/ledger_account_category.rbs +178 -0
- data/sig/modern_treasury/models/ledger_account_category_add_ledger_account_params.rbs +20 -0
- data/sig/modern_treasury/models/ledger_account_category_add_nested_category_params.rbs +20 -0
- data/sig/modern_treasury/models/ledger_account_category_create_params.rbs +55 -0
- data/sig/modern_treasury/models/ledger_account_category_delete_params.rbs +15 -0
- data/sig/modern_treasury/models/ledger_account_category_list_params.rbs +91 -0
- data/sig/modern_treasury/models/ledger_account_category_remove_ledger_account_params.rbs +20 -0
- data/sig/modern_treasury/models/ledger_account_category_remove_nested_category_params.rbs +20 -0
- data/sig/modern_treasury/models/ledger_account_category_retrieve_params.rbs +43 -0
- data/sig/modern_treasury/models/ledger_account_category_update_params.rbs +31 -0
- data/sig/modern_treasury/models/ledger_account_create_params.rbs +83 -0
- data/sig/modern_treasury/models/ledger_account_delete_params.rbs +15 -0
- data/sig/modern_treasury/models/ledger_account_list_params.rbs +285 -0
- data/sig/modern_treasury/models/ledger_account_retrieve_params.rbs +68 -0
- data/sig/modern_treasury/models/ledger_account_settlement.rbs +98 -0
- data/sig/modern_treasury/models/ledger_account_settlement_create_params.rbs +64 -0
- data/sig/modern_treasury/models/ledger_account_settlement_list_params.rbs +77 -0
- data/sig/modern_treasury/models/ledger_account_settlement_retrieve_params.rbs +15 -0
- data/sig/modern_treasury/models/ledger_account_settlement_update_params.rbs +48 -0
- data/sig/modern_treasury/models/ledger_account_settlements/account_entry_delete_params.rbs +22 -0
- data/sig/modern_treasury/models/ledger_account_settlements/account_entry_update_params.rbs +23 -0
- data/sig/modern_treasury/models/ledger_account_statement_create_params.rbs +41 -0
- data/sig/modern_treasury/models/ledger_account_statement_create_response.rbs +306 -0
- data/sig/modern_treasury/models/ledger_account_statement_retrieve_params.rbs +15 -0
- data/sig/modern_treasury/models/ledger_account_statement_retrieve_response.rbs +306 -0
- data/sig/modern_treasury/models/ledger_account_update_params.rbs +31 -0
- data/sig/modern_treasury/models/ledger_create_params.rbs +29 -0
- data/sig/modern_treasury/models/ledger_delete_params.rbs +14 -0
- data/sig/modern_treasury/models/ledger_entry.rbs +206 -0
- data/sig/modern_treasury/models/ledger_entry_list_params.rbs +206 -0
- data/sig/modern_treasury/models/ledger_entry_retrieve_params.rbs +22 -0
- data/sig/modern_treasury/models/ledger_entry_update_params.rbs +22 -0
- data/sig/modern_treasury/models/ledger_event_handler.rbs +126 -0
- data/sig/modern_treasury/models/ledger_event_handler_create_params.rbs +109 -0
- data/sig/modern_treasury/models/ledger_event_handler_delete_params.rbs +15 -0
- data/sig/modern_treasury/models/ledger_event_handler_list_params.rbs +47 -0
- data/sig/modern_treasury/models/ledger_event_handler_retrieve_params.rbs +15 -0
- data/sig/modern_treasury/models/ledger_event_handler_variable.rbs +36 -0
- data/sig/modern_treasury/models/ledger_list_params.rbs +47 -0
- data/sig/modern_treasury/models/ledger_retrieve_params.rbs +14 -0
- data/sig/modern_treasury/models/ledger_transaction.rbs +123 -0
- data/sig/modern_treasury/models/ledger_transaction_create_params.rbs +155 -0
- data/sig/modern_treasury/models/ledger_transaction_create_partial_post_params.rbs +81 -0
- data/sig/modern_treasury/models/ledger_transaction_create_reversal_params.rbs +96 -0
- data/sig/modern_treasury/models/ledger_transaction_list_params.rbs +219 -0
- data/sig/modern_treasury/models/ledger_transaction_retrieve_params.rbs +15 -0
- data/sig/modern_treasury/models/ledger_transaction_update_params.rbs +147 -0
- data/sig/modern_treasury/models/ledger_transactions/ledger_transaction_version.rbs +326 -0
- data/sig/modern_treasury/models/ledger_transactions/version_list_params.rbs +55 -0
- data/sig/modern_treasury/models/ledger_update_params.rbs +31 -0
- data/sig/modern_treasury/models/ledgerable_event.rbs +54 -0
- data/sig/modern_treasury/models/ledgerable_event_create_params.rbs +37 -0
- data/sig/modern_treasury/models/ledgerable_event_retrieve_params.rbs +15 -0
- data/sig/modern_treasury/models/legal_entity.rbs +363 -0
- data/sig/modern_treasury/models/legal_entity_association.rbs +425 -0
- data/sig/modern_treasury/models/legal_entity_association_create_params.rbs +371 -0
- data/sig/modern_treasury/models/legal_entity_create_params.rbs +678 -0
- data/sig/modern_treasury/models/legal_entity_list_params.rbs +60 -0
- data/sig/modern_treasury/models/legal_entity_retrieve_params.rbs +15 -0
- data/sig/modern_treasury/models/legal_entity_update_params.rbs +300 -0
- data/sig/modern_treasury/models/line_item.rbs +89 -0
- data/sig/modern_treasury/models/line_item_list_params.rbs +44 -0
- data/sig/modern_treasury/models/line_item_retrieve_params.rbs +38 -0
- data/sig/modern_treasury/models/line_item_update_params.rbs +44 -0
- data/sig/modern_treasury/models/paper_item.rbs +98 -0
- data/sig/modern_treasury/models/paper_item_list_params.rbs +47 -0
- data/sig/modern_treasury/models/paper_item_retrieve_params.rbs +14 -0
- data/sig/modern_treasury/models/payment_flow.rbs +165 -0
- data/sig/modern_treasury/models/payment_flow_create_params.rbs +56 -0
- data/sig/modern_treasury/models/payment_flow_list_params.rbs +65 -0
- data/sig/modern_treasury/models/payment_flow_retrieve_params.rbs +15 -0
- data/sig/modern_treasury/models/payment_flow_update_params.rbs +31 -0
- data/sig/modern_treasury/models/payment_order.rbs +564 -0
- data/sig/modern_treasury/models/payment_order_create_async_params.rbs +893 -0
- data/sig/modern_treasury/models/payment_order_create_params.rbs +963 -0
- data/sig/modern_treasury/models/payment_order_list_params.rbs +238 -0
- data/sig/modern_treasury/models/payment_order_retrieve_params.rbs +15 -0
- data/sig/modern_treasury/models/payment_order_subtype.rbs +70 -0
- data/sig/modern_treasury/models/payment_order_type.rbs +72 -0
- data/sig/modern_treasury/models/payment_order_update_params.rbs +781 -0
- data/sig/modern_treasury/models/payment_orders/reversal.rbs +95 -0
- data/sig/modern_treasury/models/payment_orders/reversal_create_params.rbs +205 -0
- data/sig/modern_treasury/models/payment_orders/reversal_list_params.rbs +28 -0
- data/sig/modern_treasury/models/payment_orders/reversal_retrieve_params.rbs +22 -0
- data/sig/modern_treasury/models/payment_reference.rbs +213 -0
- data/sig/modern_treasury/models/payment_reference_list_params.rbs +61 -0
- data/sig/modern_treasury/models/payment_reference_retireve_params.rbs +15 -0
- data/sig/modern_treasury/models/payment_reference_retrieve_params.rbs +15 -0
- data/sig/modern_treasury/models/ping_response.rbs +13 -0
- data/sig/modern_treasury/models/reconciliation_rule.rbs +138 -0
- data/sig/modern_treasury/models/return_create_params.rbs +168 -0
- data/sig/modern_treasury/models/return_list_params.rbs +74 -0
- data/sig/modern_treasury/models/return_object.rbs +492 -0
- data/sig/modern_treasury/models/return_retrieve_params.rbs +14 -0
- data/sig/modern_treasury/models/routing_detail.rbs +233 -0
- data/sig/modern_treasury/models/routing_detail_create_params.rbs +165 -0
- data/sig/modern_treasury/models/routing_detail_delete_params.rbs +37 -0
- data/sig/modern_treasury/models/routing_detail_list_params.rbs +33 -0
- data/sig/modern_treasury/models/routing_detail_retrieve_params.rbs +27 -0
- data/sig/modern_treasury/models/routing_number_lookup_request.rbs +185 -0
- data/sig/modern_treasury/models/transaction.rbs +281 -0
- data/sig/modern_treasury/models/transaction_create_params.rbs +134 -0
- data/sig/modern_treasury/models/transaction_delete_params.rbs +14 -0
- data/sig/modern_treasury/models/transaction_direction.rbs +14 -0
- data/sig/modern_treasury/models/transaction_list_params.rbs +101 -0
- data/sig/modern_treasury/models/transaction_retrieve_params.rbs +14 -0
- data/sig/modern_treasury/models/transaction_update_params.rbs +22 -0
- data/sig/modern_treasury/models/transactions/line_item_create_params.rbs +29 -0
- data/sig/modern_treasury/models/transactions/line_item_delete_params.rbs +16 -0
- data/sig/modern_treasury/models/transactions/line_item_list_params.rbs +58 -0
- data/sig/modern_treasury/models/transactions/line_item_retrieve_params.rbs +16 -0
- data/sig/modern_treasury/models/transactions/transaction_line_item.rbs +110 -0
- data/sig/modern_treasury/models/validation_validate_routing_number_params.rbs +78 -0
- data/sig/modern_treasury/models/virtual_account.rbs +78 -0
- data/sig/modern_treasury/models/virtual_account_create_params.rbs +354 -0
- data/sig/modern_treasury/models/virtual_account_delete_params.rbs +15 -0
- data/sig/modern_treasury/models/virtual_account_list_params.rbs +47 -0
- data/sig/modern_treasury/models/virtual_account_retrieve_params.rbs +15 -0
- data/sig/modern_treasury/models/virtual_account_update_params.rbs +41 -0
- data/sig/modern_treasury/models/wealth_and_employment_details.rbs +306 -0
- data/sig/modern_treasury/page.rbs +17 -0
- data/sig/modern_treasury/pooled_net_requester.rbs +37 -0
- data/sig/modern_treasury/request_options.rbs +46 -0
- data/sig/modern_treasury/resources/account_collection_flows.rbs +35 -0
- data/sig/modern_treasury/resources/account_details.rbs +37 -0
- data/sig/modern_treasury/resources/bulk_requests.rbs +30 -0
- data/sig/modern_treasury/resources/bulk_results.rbs +23 -0
- data/sig/modern_treasury/resources/connection_legal_entities.rbs +34 -0
- data/sig/modern_treasury/resources/connections.rbs +15 -0
- data/sig/modern_treasury/resources/counterparties.rbs +64 -0
- data/sig/modern_treasury/resources/documents.rbs +28 -0
- data/sig/modern_treasury/resources/events.rbs +23 -0
- data/sig/modern_treasury/resources/expected_payments.rbs +76 -0
- data/sig/modern_treasury/resources/external_accounts.rbs +71 -0
- data/sig/modern_treasury/resources/foreign_exchange_quotes.rbs +35 -0
- data/sig/modern_treasury/resources/incoming_payment_details.rbs +43 -0
- data/sig/modern_treasury/resources/internal_accounts/balance_reports.rbs +39 -0
- data/sig/modern_treasury/resources/internal_accounts.rbs +49 -0
- data/sig/modern_treasury/resources/invoices/line_items.rbs +53 -0
- data/sig/modern_treasury/resources/invoices.rbs +94 -0
- data/sig/modern_treasury/resources/ledger_account_balance_monitors.rbs +41 -0
- data/sig/modern_treasury/resources/ledger_account_categories.rbs +76 -0
- data/sig/modern_treasury/resources/ledger_account_settlements/account_entries.rbs +21 -0
- data/sig/modern_treasury/resources/ledger_account_settlements.rbs +48 -0
- data/sig/modern_treasury/resources/ledger_account_statements.rbs +21 -0
- data/sig/modern_treasury/resources/ledger_accounts.rbs +58 -0
- data/sig/modern_treasury/resources/ledger_entries.rbs +43 -0
- data/sig/modern_treasury/resources/ledger_event_handlers.rbs +37 -0
- data/sig/modern_treasury/resources/ledger_transactions/versions.rbs +19 -0
- data/sig/modern_treasury/resources/ledger_transactions.rbs +83 -0
- data/sig/modern_treasury/resources/ledgerable_events.rbs +20 -0
- data/sig/modern_treasury/resources/ledgers.rbs +41 -0
- data/sig/modern_treasury/resources/legal_entities.rbs +76 -0
- data/sig/modern_treasury/resources/legal_entity_associations.rbs +17 -0
- data/sig/modern_treasury/resources/line_items.rbs +30 -0
- data/sig/modern_treasury/resources/paper_items.rbs +21 -0
- data/sig/modern_treasury/resources/payment_flows.rbs +40 -0
- data/sig/modern_treasury/resources/payment_orders/reversals.rbs +30 -0
- data/sig/modern_treasury/resources/payment_orders.rbs +153 -0
- data/sig/modern_treasury/resources/payment_references.rbs +23 -0
- data/sig/modern_treasury/resources/returns.rbs +32 -0
- data/sig/modern_treasury/resources/routing_details.rbs +38 -0
- data/sig/modern_treasury/resources/transactions/line_items.rbs +35 -0
- data/sig/modern_treasury/resources/transactions.rbs +57 -0
- data/sig/modern_treasury/resources/validations.rbs +13 -0
- data/sig/modern_treasury/resources/virtual_accounts.rbs +49 -0
- data/sig/modern_treasury/util.rbs +136 -0
- data/sig/modern_treasury/version.rbs +3 -0
- metadata +861 -20
@@ -0,0 +1,1460 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module ModernTreasury
|
4
|
+
module Models
|
5
|
+
class PaymentOrderCreateParams < ModernTreasury::BaseModel
|
6
|
+
# @!parse
|
7
|
+
# extend ModernTreasury::RequestParameters::Converter
|
8
|
+
include ModernTreasury::RequestParameters
|
9
|
+
|
10
|
+
# @!attribute amount
|
11
|
+
# Value in specified currency's smallest unit. e.g. $10 would be represented as
|
12
|
+
# 1000 (cents). For RTP, the maximum amount allowed by the network is $100,000.
|
13
|
+
#
|
14
|
+
# @return [Integer]
|
15
|
+
required :amount, Integer
|
16
|
+
|
17
|
+
# @!attribute direction
|
18
|
+
# One of `credit`, `debit`. Describes the direction money is flowing in the
|
19
|
+
# transaction. A `credit` moves money from your account to someone else's. A
|
20
|
+
# `debit` pulls money from someone else's account to your own. Note that wire,
|
21
|
+
# rtp, and check payments will always be `credit`.
|
22
|
+
#
|
23
|
+
# @return [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::Direction]
|
24
|
+
required :direction, enum: -> { ModernTreasury::Models::PaymentOrderCreateParams::Direction }
|
25
|
+
|
26
|
+
# @!attribute originating_account_id
|
27
|
+
# The ID of one of your organization's internal accounts.
|
28
|
+
#
|
29
|
+
# @return [String]
|
30
|
+
required :originating_account_id, String
|
31
|
+
|
32
|
+
# @!attribute type
|
33
|
+
# One of `ach`, `se_bankgirot`, `eft`, `wire`, `check`, `sen`, `book`, `rtp`,
|
34
|
+
# `sepa`, `bacs`, `au_becs`, `interac`, `neft`, `nics`,
|
35
|
+
# `nz_national_clearing_code`, `sic`, `signet`, `provexchange`, `zengin`.
|
36
|
+
#
|
37
|
+
# @return [Symbol, ModernTreasury::Models::PaymentOrderType]
|
38
|
+
required :type, enum: -> { ModernTreasury::Models::PaymentOrderType }
|
39
|
+
|
40
|
+
# @!attribute [r] accounting
|
41
|
+
#
|
42
|
+
# @return [ModernTreasury::Models::PaymentOrderCreateParams::Accounting, nil]
|
43
|
+
optional :accounting, -> { ModernTreasury::Models::PaymentOrderCreateParams::Accounting }
|
44
|
+
|
45
|
+
# @!parse
|
46
|
+
# # @return [ModernTreasury::Models::PaymentOrderCreateParams::Accounting]
|
47
|
+
# attr_writer :accounting
|
48
|
+
|
49
|
+
# @!attribute accounting_category_id
|
50
|
+
# The ID of one of your accounting categories. Note that these will only be
|
51
|
+
# accessible if your accounting system has been connected.
|
52
|
+
#
|
53
|
+
# @return [String, nil]
|
54
|
+
optional :accounting_category_id, String, nil?: true
|
55
|
+
|
56
|
+
# @!attribute accounting_ledger_class_id
|
57
|
+
# The ID of one of your accounting ledger classes. Note that these will only be
|
58
|
+
# accessible if your accounting system has been connected.
|
59
|
+
#
|
60
|
+
# @return [String, nil]
|
61
|
+
optional :accounting_ledger_class_id, String, nil?: true
|
62
|
+
|
63
|
+
# @!attribute charge_bearer
|
64
|
+
# The party that will pay the fees for the payment order. Only applies to wire
|
65
|
+
# payment orders. Can be one of shared, sender, or receiver, which correspond
|
66
|
+
# respectively with the SWIFT 71A values `SHA`, `OUR`, `BEN`.
|
67
|
+
#
|
68
|
+
# @return [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::ChargeBearer, nil]
|
69
|
+
optional :charge_bearer,
|
70
|
+
enum: -> { ModernTreasury::Models::PaymentOrderCreateParams::ChargeBearer },
|
71
|
+
nil?: true
|
72
|
+
|
73
|
+
# @!attribute [r] currency
|
74
|
+
# Defaults to the currency of the originating account.
|
75
|
+
#
|
76
|
+
# @return [Symbol, ModernTreasury::Models::Currency, nil]
|
77
|
+
optional :currency, enum: -> { ModernTreasury::Models::Currency }
|
78
|
+
|
79
|
+
# @!parse
|
80
|
+
# # @return [Symbol, ModernTreasury::Models::Currency]
|
81
|
+
# attr_writer :currency
|
82
|
+
|
83
|
+
# @!attribute description
|
84
|
+
# An optional description for internal use.
|
85
|
+
#
|
86
|
+
# @return [String, nil]
|
87
|
+
optional :description, String, nil?: true
|
88
|
+
|
89
|
+
# @!attribute [r] documents
|
90
|
+
# An array of documents to be attached to the payment order. Note that if you
|
91
|
+
# attach documents, the request's content type must be `multipart/form-data`.
|
92
|
+
#
|
93
|
+
# @return [Array<ModernTreasury::Models::PaymentOrderCreateParams::Document>, nil]
|
94
|
+
optional :documents,
|
95
|
+
-> { ModernTreasury::ArrayOf[ModernTreasury::Models::PaymentOrderCreateParams::Document] }
|
96
|
+
|
97
|
+
# @!parse
|
98
|
+
# # @return [Array<ModernTreasury::Models::PaymentOrderCreateParams::Document>]
|
99
|
+
# attr_writer :documents
|
100
|
+
|
101
|
+
# @!attribute [r] effective_date
|
102
|
+
# Date transactions are to be posted to the participants' account. Defaults to the
|
103
|
+
# current business day or the next business day if the current day is a bank
|
104
|
+
# holiday or weekend. Format: yyyy-mm-dd.
|
105
|
+
#
|
106
|
+
# @return [Date, nil]
|
107
|
+
optional :effective_date, Date
|
108
|
+
|
109
|
+
# @!parse
|
110
|
+
# # @return [Date]
|
111
|
+
# attr_writer :effective_date
|
112
|
+
|
113
|
+
# @!attribute expires_at
|
114
|
+
# RFP payments require an expires_at. This value must be past the effective_date.
|
115
|
+
#
|
116
|
+
# @return [Time, nil]
|
117
|
+
optional :expires_at, Time, nil?: true
|
118
|
+
|
119
|
+
# @!attribute [r] fallback_type
|
120
|
+
# A payment type to fallback to if the original type is not valid for the
|
121
|
+
# receiving account. Currently, this only supports falling back from RTP to ACH
|
122
|
+
# (type=rtp and fallback_type=ach)
|
123
|
+
#
|
124
|
+
# @return [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::FallbackType, nil]
|
125
|
+
optional :fallback_type, enum: -> { ModernTreasury::Models::PaymentOrderCreateParams::FallbackType }
|
126
|
+
|
127
|
+
# @!parse
|
128
|
+
# # @return [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::FallbackType]
|
129
|
+
# attr_writer :fallback_type
|
130
|
+
|
131
|
+
# @!attribute foreign_exchange_contract
|
132
|
+
# If present, indicates a specific foreign exchange contract number that has been
|
133
|
+
# generated by your financial institution.
|
134
|
+
#
|
135
|
+
# @return [String, nil]
|
136
|
+
optional :foreign_exchange_contract, String, nil?: true
|
137
|
+
|
138
|
+
# @!attribute foreign_exchange_indicator
|
139
|
+
# Indicates the type of FX transfer to initiate, can be either
|
140
|
+
# `variable_to_fixed`, `fixed_to_variable`, or `null` if the payment order
|
141
|
+
# currency matches the originating account currency.
|
142
|
+
#
|
143
|
+
# @return [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::ForeignExchangeIndicator, nil]
|
144
|
+
optional :foreign_exchange_indicator,
|
145
|
+
enum: -> { ModernTreasury::Models::PaymentOrderCreateParams::ForeignExchangeIndicator },
|
146
|
+
nil?: true
|
147
|
+
|
148
|
+
# @!attribute [r] ledger_transaction
|
149
|
+
# Specifies a ledger transaction object that will be created with the payment
|
150
|
+
# order. If the ledger transaction cannot be created, then the payment order
|
151
|
+
# creation will fail. The resulting ledger transaction will mirror the status of
|
152
|
+
# the payment order.
|
153
|
+
#
|
154
|
+
# @return [ModernTreasury::Models::PaymentOrderCreateParams::LedgerTransaction, nil]
|
155
|
+
optional :ledger_transaction, -> { ModernTreasury::Models::PaymentOrderCreateParams::LedgerTransaction }
|
156
|
+
|
157
|
+
# @!parse
|
158
|
+
# # @return [ModernTreasury::Models::PaymentOrderCreateParams::LedgerTransaction]
|
159
|
+
# attr_writer :ledger_transaction
|
160
|
+
|
161
|
+
# @!attribute [r] ledger_transaction_id
|
162
|
+
# Either ledger_transaction or ledger_transaction_id can be provided. Only a
|
163
|
+
# pending ledger transaction can be attached upon payment order creation. Once the
|
164
|
+
# payment order is created, the status of the ledger transaction tracks the
|
165
|
+
# payment order automatically.
|
166
|
+
#
|
167
|
+
# @return [String, nil]
|
168
|
+
optional :ledger_transaction_id, String
|
169
|
+
|
170
|
+
# @!parse
|
171
|
+
# # @return [String]
|
172
|
+
# attr_writer :ledger_transaction_id
|
173
|
+
|
174
|
+
# @!attribute [r] line_items
|
175
|
+
# An array of line items that must sum up to the amount of the payment order.
|
176
|
+
#
|
177
|
+
# @return [Array<ModernTreasury::Models::PaymentOrderCreateParams::LineItem>, nil]
|
178
|
+
optional :line_items,
|
179
|
+
-> { ModernTreasury::ArrayOf[ModernTreasury::Models::PaymentOrderCreateParams::LineItem] }
|
180
|
+
|
181
|
+
# @!parse
|
182
|
+
# # @return [Array<ModernTreasury::Models::PaymentOrderCreateParams::LineItem>]
|
183
|
+
# attr_writer :line_items
|
184
|
+
|
185
|
+
# @!attribute [r] metadata
|
186
|
+
# Additional data represented as key-value pairs. Both the key and value must be
|
187
|
+
# strings.
|
188
|
+
#
|
189
|
+
# @return [Hash{Symbol=>String}, nil]
|
190
|
+
optional :metadata, ModernTreasury::HashOf[String]
|
191
|
+
|
192
|
+
# @!parse
|
193
|
+
# # @return [Hash{Symbol=>String}]
|
194
|
+
# attr_writer :metadata
|
195
|
+
|
196
|
+
# @!attribute [r] nsf_protected
|
197
|
+
# A boolean to determine if NSF Protection is enabled for this payment order. Note
|
198
|
+
# that this setting must also be turned on in your organization settings page.
|
199
|
+
#
|
200
|
+
# @return [Boolean, nil]
|
201
|
+
optional :nsf_protected, ModernTreasury::BooleanModel
|
202
|
+
|
203
|
+
# @!parse
|
204
|
+
# # @return [Boolean]
|
205
|
+
# attr_writer :nsf_protected
|
206
|
+
|
207
|
+
# @!attribute originating_party_name
|
208
|
+
# If present, this will replace your default company name on receiver's bank
|
209
|
+
# statement. This field can only be used for ACH payments currently. For ACH, only
|
210
|
+
# the first 16 characters of this string will be used. Any additional characters
|
211
|
+
# will be truncated.
|
212
|
+
#
|
213
|
+
# @return [String, nil]
|
214
|
+
optional :originating_party_name, String, nil?: true
|
215
|
+
|
216
|
+
# @!attribute [r] priority
|
217
|
+
# Either `normal` or `high`. For ACH and EFT payments, `high` represents a
|
218
|
+
# same-day ACH or EFT transfer, respectively. For check payments, `high` can mean
|
219
|
+
# an overnight check rather than standard mail.
|
220
|
+
#
|
221
|
+
# @return [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::Priority, nil]
|
222
|
+
optional :priority, enum: -> { ModernTreasury::Models::PaymentOrderCreateParams::Priority }
|
223
|
+
|
224
|
+
# @!parse
|
225
|
+
# # @return [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::Priority]
|
226
|
+
# attr_writer :priority
|
227
|
+
|
228
|
+
# @!attribute process_after
|
229
|
+
# If present, Modern Treasury will not process the payment until after this time.
|
230
|
+
# If `process_after` is past the cutoff for `effective_date`, `process_after` will
|
231
|
+
# take precedence and `effective_date` will automatically update to reflect the
|
232
|
+
# earliest possible sending date after `process_after`. Format is ISO8601
|
233
|
+
# timestamp.
|
234
|
+
#
|
235
|
+
# @return [Time, nil]
|
236
|
+
optional :process_after, Time, nil?: true
|
237
|
+
|
238
|
+
# @!attribute purpose
|
239
|
+
# For `wire`, this is usually the purpose which is transmitted via the
|
240
|
+
# "InstrForDbtrAgt" field in the ISO20022 file. For `eft`, this field is the 3
|
241
|
+
# digit CPA Code that will be attached to the payment.
|
242
|
+
#
|
243
|
+
# @return [String, nil]
|
244
|
+
optional :purpose, String, nil?: true
|
245
|
+
|
246
|
+
# @!attribute [r] receiving_account
|
247
|
+
# Either `receiving_account` or `receiving_account_id` must be present. When using
|
248
|
+
# `receiving_account_id`, you may pass the id of an external account or an
|
249
|
+
# internal account.
|
250
|
+
#
|
251
|
+
# @return [ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount, nil]
|
252
|
+
optional :receiving_account, -> { ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount }
|
253
|
+
|
254
|
+
# @!parse
|
255
|
+
# # @return [ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount]
|
256
|
+
# attr_writer :receiving_account
|
257
|
+
|
258
|
+
# @!attribute [r] receiving_account_id
|
259
|
+
# Either `receiving_account` or `receiving_account_id` must be present. When using
|
260
|
+
# `receiving_account_id`, you may pass the id of an external account or an
|
261
|
+
# internal account.
|
262
|
+
#
|
263
|
+
# @return [String, nil]
|
264
|
+
optional :receiving_account_id, String
|
265
|
+
|
266
|
+
# @!parse
|
267
|
+
# # @return [String]
|
268
|
+
# attr_writer :receiving_account_id
|
269
|
+
|
270
|
+
# @!attribute remittance_information
|
271
|
+
# For `ach`, this field will be passed through on an addenda record. For `wire`
|
272
|
+
# payments the field will be passed through as the "Originator to Beneficiary
|
273
|
+
# Information", also known as OBI or Fedwire tag 6000.
|
274
|
+
#
|
275
|
+
# @return [String, nil]
|
276
|
+
optional :remittance_information, String, nil?: true
|
277
|
+
|
278
|
+
# @!attribute send_remittance_advice
|
279
|
+
# Send an email to the counterparty when the payment order is sent to the bank. If
|
280
|
+
# `null`, `send_remittance_advice` on the Counterparty is used.
|
281
|
+
#
|
282
|
+
# @return [Boolean, nil]
|
283
|
+
optional :send_remittance_advice, ModernTreasury::BooleanModel, nil?: true
|
284
|
+
|
285
|
+
# @!attribute statement_descriptor
|
286
|
+
# An optional descriptor which will appear in the receiver's statement. For
|
287
|
+
# `check` payments this field will be used as the memo line. For `ach` the maximum
|
288
|
+
# length is 10 characters. Note that for ACH payments, the name on your bank
|
289
|
+
# account will be included automatically by the bank, so you can use the
|
290
|
+
# characters for other useful information. For `eft` the maximum length is 15
|
291
|
+
# characters.
|
292
|
+
#
|
293
|
+
# @return [String, nil]
|
294
|
+
optional :statement_descriptor, String, nil?: true
|
295
|
+
|
296
|
+
# @!attribute subtype
|
297
|
+
# An additional layer of classification for the type of payment order you are
|
298
|
+
# doing. This field is only used for `ach` payment orders currently. For `ach`
|
299
|
+
# payment orders, the `subtype` represents the SEC code. We currently support
|
300
|
+
# `CCD`, `PPD`, `IAT`, `CTX`, `WEB`, `CIE`, and `TEL`.
|
301
|
+
#
|
302
|
+
# @return [Symbol, ModernTreasury::Models::PaymentOrderSubtype, nil]
|
303
|
+
optional :subtype, enum: -> { ModernTreasury::Models::PaymentOrderSubtype }, nil?: true
|
304
|
+
|
305
|
+
# @!attribute [r] transaction_monitoring_enabled
|
306
|
+
# A flag that determines whether a payment order should go through transaction
|
307
|
+
# monitoring.
|
308
|
+
#
|
309
|
+
# @return [Boolean, nil]
|
310
|
+
optional :transaction_monitoring_enabled, ModernTreasury::BooleanModel
|
311
|
+
|
312
|
+
# @!parse
|
313
|
+
# # @return [Boolean]
|
314
|
+
# attr_writer :transaction_monitoring_enabled
|
315
|
+
|
316
|
+
# @!attribute ultimate_originating_party_identifier
|
317
|
+
# Identifier of the ultimate originator of the payment order.
|
318
|
+
#
|
319
|
+
# @return [String, nil]
|
320
|
+
optional :ultimate_originating_party_identifier, String, nil?: true
|
321
|
+
|
322
|
+
# @!attribute ultimate_originating_party_name
|
323
|
+
# Name of the ultimate originator of the payment order.
|
324
|
+
#
|
325
|
+
# @return [String, nil]
|
326
|
+
optional :ultimate_originating_party_name, String, nil?: true
|
327
|
+
|
328
|
+
# @!attribute ultimate_receiving_party_identifier
|
329
|
+
# Identifier of the ultimate funds recipient.
|
330
|
+
#
|
331
|
+
# @return [String, nil]
|
332
|
+
optional :ultimate_receiving_party_identifier, String, nil?: true
|
333
|
+
|
334
|
+
# @!attribute ultimate_receiving_party_name
|
335
|
+
# Name of the ultimate funds recipient.
|
336
|
+
#
|
337
|
+
# @return [String, nil]
|
338
|
+
optional :ultimate_receiving_party_name, String, nil?: true
|
339
|
+
|
340
|
+
# @!parse
|
341
|
+
# # @param amount [Integer]
|
342
|
+
# # @param direction [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::Direction]
|
343
|
+
# # @param originating_account_id [String]
|
344
|
+
# # @param type [Symbol, ModernTreasury::Models::PaymentOrderType]
|
345
|
+
# # @param accounting [ModernTreasury::Models::PaymentOrderCreateParams::Accounting]
|
346
|
+
# # @param accounting_category_id [String, nil]
|
347
|
+
# # @param accounting_ledger_class_id [String, nil]
|
348
|
+
# # @param charge_bearer [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::ChargeBearer, nil]
|
349
|
+
# # @param currency [Symbol, ModernTreasury::Models::Currency]
|
350
|
+
# # @param description [String, nil]
|
351
|
+
# # @param documents [Array<ModernTreasury::Models::PaymentOrderCreateParams::Document>]
|
352
|
+
# # @param effective_date [Date]
|
353
|
+
# # @param expires_at [Time, nil]
|
354
|
+
# # @param fallback_type [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::FallbackType]
|
355
|
+
# # @param foreign_exchange_contract [String, nil]
|
356
|
+
# # @param foreign_exchange_indicator [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::ForeignExchangeIndicator, nil]
|
357
|
+
# # @param ledger_transaction [ModernTreasury::Models::PaymentOrderCreateParams::LedgerTransaction]
|
358
|
+
# # @param ledger_transaction_id [String]
|
359
|
+
# # @param line_items [Array<ModernTreasury::Models::PaymentOrderCreateParams::LineItem>]
|
360
|
+
# # @param metadata [Hash{Symbol=>String}]
|
361
|
+
# # @param nsf_protected [Boolean]
|
362
|
+
# # @param originating_party_name [String, nil]
|
363
|
+
# # @param priority [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::Priority]
|
364
|
+
# # @param process_after [Time, nil]
|
365
|
+
# # @param purpose [String, nil]
|
366
|
+
# # @param receiving_account [ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount]
|
367
|
+
# # @param receiving_account_id [String]
|
368
|
+
# # @param remittance_information [String, nil]
|
369
|
+
# # @param send_remittance_advice [Boolean, nil]
|
370
|
+
# # @param statement_descriptor [String, nil]
|
371
|
+
# # @param subtype [Symbol, ModernTreasury::Models::PaymentOrderSubtype, nil]
|
372
|
+
# # @param transaction_monitoring_enabled [Boolean]
|
373
|
+
# # @param ultimate_originating_party_identifier [String, nil]
|
374
|
+
# # @param ultimate_originating_party_name [String, nil]
|
375
|
+
# # @param ultimate_receiving_party_identifier [String, nil]
|
376
|
+
# # @param ultimate_receiving_party_name [String, nil]
|
377
|
+
# # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
|
378
|
+
# #
|
379
|
+
# def initialize(
|
380
|
+
# amount:,
|
381
|
+
# direction:,
|
382
|
+
# originating_account_id:,
|
383
|
+
# type:,
|
384
|
+
# accounting: nil,
|
385
|
+
# accounting_category_id: nil,
|
386
|
+
# accounting_ledger_class_id: nil,
|
387
|
+
# charge_bearer: nil,
|
388
|
+
# currency: nil,
|
389
|
+
# description: nil,
|
390
|
+
# documents: nil,
|
391
|
+
# effective_date: nil,
|
392
|
+
# expires_at: nil,
|
393
|
+
# fallback_type: nil,
|
394
|
+
# foreign_exchange_contract: nil,
|
395
|
+
# foreign_exchange_indicator: nil,
|
396
|
+
# ledger_transaction: nil,
|
397
|
+
# ledger_transaction_id: nil,
|
398
|
+
# line_items: nil,
|
399
|
+
# metadata: nil,
|
400
|
+
# nsf_protected: nil,
|
401
|
+
# originating_party_name: nil,
|
402
|
+
# priority: nil,
|
403
|
+
# process_after: nil,
|
404
|
+
# purpose: nil,
|
405
|
+
# receiving_account: nil,
|
406
|
+
# receiving_account_id: nil,
|
407
|
+
# remittance_information: nil,
|
408
|
+
# send_remittance_advice: nil,
|
409
|
+
# statement_descriptor: nil,
|
410
|
+
# subtype: nil,
|
411
|
+
# transaction_monitoring_enabled: nil,
|
412
|
+
# ultimate_originating_party_identifier: nil,
|
413
|
+
# ultimate_originating_party_name: nil,
|
414
|
+
# ultimate_receiving_party_identifier: nil,
|
415
|
+
# ultimate_receiving_party_name: nil,
|
416
|
+
# request_options: {},
|
417
|
+
# **
|
418
|
+
# )
|
419
|
+
# super
|
420
|
+
# end
|
421
|
+
|
422
|
+
# def initialize: (Hash | ModernTreasury::BaseModel) -> void
|
423
|
+
|
424
|
+
# One of `credit`, `debit`. Describes the direction money is flowing in the
|
425
|
+
# transaction. A `credit` moves money from your account to someone else's. A
|
426
|
+
# `debit` pulls money from someone else's account to your own. Note that wire,
|
427
|
+
# rtp, and check payments will always be `credit`.
|
428
|
+
module Direction
|
429
|
+
extend ModernTreasury::Enum
|
430
|
+
|
431
|
+
CREDIT = :credit
|
432
|
+
DEBIT = :debit
|
433
|
+
|
434
|
+
finalize!
|
435
|
+
|
436
|
+
# @!parse
|
437
|
+
# # @return [Array<Symbol>]
|
438
|
+
# def self.values; end
|
439
|
+
end
|
440
|
+
|
441
|
+
class Accounting < ModernTreasury::BaseModel
|
442
|
+
# @!attribute account_id
|
443
|
+
# The ID of one of your accounting categories. Note that these will only be
|
444
|
+
# accessible if your accounting system has been connected.
|
445
|
+
#
|
446
|
+
# @return [String, nil]
|
447
|
+
optional :account_id, String, nil?: true
|
448
|
+
|
449
|
+
# @!attribute class_id
|
450
|
+
# The ID of one of the class objects in your accounting system. Class objects
|
451
|
+
# track segments of your business independent of client or project. Note that
|
452
|
+
# these will only be accessible if your accounting system has been connected.
|
453
|
+
#
|
454
|
+
# @return [String, nil]
|
455
|
+
optional :class_id, String, nil?: true
|
456
|
+
|
457
|
+
# @!parse
|
458
|
+
# # @param account_id [String, nil]
|
459
|
+
# # @param class_id [String, nil]
|
460
|
+
# #
|
461
|
+
# def initialize(account_id: nil, class_id: nil, **) = super
|
462
|
+
|
463
|
+
# def initialize: (Hash | ModernTreasury::BaseModel) -> void
|
464
|
+
end
|
465
|
+
|
466
|
+
# The party that will pay the fees for the payment order. Only applies to wire
|
467
|
+
# payment orders. Can be one of shared, sender, or receiver, which correspond
|
468
|
+
# respectively with the SWIFT 71A values `SHA`, `OUR`, `BEN`.
|
469
|
+
module ChargeBearer
|
470
|
+
extend ModernTreasury::Enum
|
471
|
+
|
472
|
+
SHARED = :shared
|
473
|
+
SENDER = :sender
|
474
|
+
RECEIVER = :receiver
|
475
|
+
|
476
|
+
finalize!
|
477
|
+
|
478
|
+
# @!parse
|
479
|
+
# # @return [Array<Symbol>]
|
480
|
+
# def self.values; end
|
481
|
+
end
|
482
|
+
|
483
|
+
class Document < ModernTreasury::BaseModel
|
484
|
+
# @!attribute documentable_id
|
485
|
+
# The unique identifier for the associated object.
|
486
|
+
#
|
487
|
+
# @return [String]
|
488
|
+
required :documentable_id, String
|
489
|
+
|
490
|
+
# @!attribute documentable_type
|
491
|
+
#
|
492
|
+
# @return [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::Document::DocumentableType]
|
493
|
+
required :documentable_type,
|
494
|
+
enum: -> { ModernTreasury::Models::PaymentOrderCreateParams::Document::DocumentableType }
|
495
|
+
|
496
|
+
# @!attribute file
|
497
|
+
#
|
498
|
+
# @return [IO, StringIO]
|
499
|
+
required :file, IO
|
500
|
+
|
501
|
+
# @!attribute [r] document_type
|
502
|
+
# A category given to the document, can be `null`.
|
503
|
+
#
|
504
|
+
# @return [String, nil]
|
505
|
+
optional :document_type, String
|
506
|
+
|
507
|
+
# @!parse
|
508
|
+
# # @return [String]
|
509
|
+
# attr_writer :document_type
|
510
|
+
|
511
|
+
# @!parse
|
512
|
+
# # @param documentable_id [String]
|
513
|
+
# # @param documentable_type [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::Document::DocumentableType]
|
514
|
+
# # @param file [IO, StringIO]
|
515
|
+
# # @param document_type [String]
|
516
|
+
# #
|
517
|
+
# def initialize(documentable_id:, documentable_type:, file:, document_type: nil, **) = super
|
518
|
+
|
519
|
+
# def initialize: (Hash | ModernTreasury::BaseModel) -> void
|
520
|
+
|
521
|
+
module DocumentableType
|
522
|
+
extend ModernTreasury::Enum
|
523
|
+
|
524
|
+
CASES = :cases
|
525
|
+
COUNTERPARTIES = :counterparties
|
526
|
+
EXPECTED_PAYMENTS = :expected_payments
|
527
|
+
EXTERNAL_ACCOUNTS = :external_accounts
|
528
|
+
INCOMING_PAYMENT_DETAILS = :incoming_payment_details
|
529
|
+
INTERNAL_ACCOUNTS = :internal_accounts
|
530
|
+
ORGANIZATIONS = :organizations
|
531
|
+
PAPER_ITEMS = :paper_items
|
532
|
+
PAYMENT_ORDERS = :payment_orders
|
533
|
+
TRANSACTIONS = :transactions
|
534
|
+
DECISIONS = :decisions
|
535
|
+
CONNECTIONS = :connections
|
536
|
+
|
537
|
+
finalize!
|
538
|
+
|
539
|
+
# @!parse
|
540
|
+
# # @return [Array<Symbol>]
|
541
|
+
# def self.values; end
|
542
|
+
end
|
543
|
+
end
|
544
|
+
|
545
|
+
# A payment type to fallback to if the original type is not valid for the
|
546
|
+
# receiving account. Currently, this only supports falling back from RTP to ACH
|
547
|
+
# (type=rtp and fallback_type=ach)
|
548
|
+
module FallbackType
|
549
|
+
extend ModernTreasury::Enum
|
550
|
+
|
551
|
+
ACH = :ach
|
552
|
+
|
553
|
+
finalize!
|
554
|
+
|
555
|
+
# @!parse
|
556
|
+
# # @return [Array<Symbol>]
|
557
|
+
# def self.values; end
|
558
|
+
end
|
559
|
+
|
560
|
+
# Indicates the type of FX transfer to initiate, can be either
|
561
|
+
# `variable_to_fixed`, `fixed_to_variable`, or `null` if the payment order
|
562
|
+
# currency matches the originating account currency.
|
563
|
+
module ForeignExchangeIndicator
|
564
|
+
extend ModernTreasury::Enum
|
565
|
+
|
566
|
+
FIXED_TO_VARIABLE = :fixed_to_variable
|
567
|
+
VARIABLE_TO_FIXED = :variable_to_fixed
|
568
|
+
|
569
|
+
finalize!
|
570
|
+
|
571
|
+
# @!parse
|
572
|
+
# # @return [Array<Symbol>]
|
573
|
+
# def self.values; end
|
574
|
+
end
|
575
|
+
|
576
|
+
class LedgerTransaction < ModernTreasury::BaseModel
|
577
|
+
# @!attribute ledger_entries
|
578
|
+
# An array of ledger entry objects.
|
579
|
+
#
|
580
|
+
# @return [Array<ModernTreasury::Models::PaymentOrderCreateParams::LedgerTransaction::LedgerEntry>]
|
581
|
+
required :ledger_entries,
|
582
|
+
-> { ModernTreasury::ArrayOf[ModernTreasury::Models::PaymentOrderCreateParams::LedgerTransaction::LedgerEntry] }
|
583
|
+
|
584
|
+
# @!attribute description
|
585
|
+
# An optional description for internal use.
|
586
|
+
#
|
587
|
+
# @return [String, nil]
|
588
|
+
optional :description, String, nil?: true
|
589
|
+
|
590
|
+
# @!attribute [r] effective_at
|
591
|
+
# The timestamp (ISO8601 format) at which the ledger transaction happened for
|
592
|
+
# reporting purposes.
|
593
|
+
#
|
594
|
+
# @return [Time, nil]
|
595
|
+
optional :effective_at, Time
|
596
|
+
|
597
|
+
# @!parse
|
598
|
+
# # @return [Time]
|
599
|
+
# attr_writer :effective_at
|
600
|
+
|
601
|
+
# @!attribute [r] effective_date
|
602
|
+
# The date (YYYY-MM-DD) on which the ledger transaction happened for reporting
|
603
|
+
# purposes.
|
604
|
+
#
|
605
|
+
# @return [Date, nil]
|
606
|
+
optional :effective_date, Date
|
607
|
+
|
608
|
+
# @!parse
|
609
|
+
# # @return [Date]
|
610
|
+
# attr_writer :effective_date
|
611
|
+
|
612
|
+
# @!attribute [r] external_id
|
613
|
+
# A unique string to represent the ledger transaction. Only one pending or posted
|
614
|
+
# ledger transaction may have this ID in the ledger.
|
615
|
+
#
|
616
|
+
# @return [String, nil]
|
617
|
+
optional :external_id, String
|
618
|
+
|
619
|
+
# @!parse
|
620
|
+
# # @return [String]
|
621
|
+
# attr_writer :external_id
|
622
|
+
|
623
|
+
# @!attribute [r] ledgerable_id
|
624
|
+
# If the ledger transaction can be reconciled to another object in Modern
|
625
|
+
# Treasury, the id will be populated here, otherwise null.
|
626
|
+
#
|
627
|
+
# @return [String, nil]
|
628
|
+
optional :ledgerable_id, String
|
629
|
+
|
630
|
+
# @!parse
|
631
|
+
# # @return [String]
|
632
|
+
# attr_writer :ledgerable_id
|
633
|
+
|
634
|
+
# @!attribute [r] ledgerable_type
|
635
|
+
# If the ledger transaction can be reconciled to another object in Modern
|
636
|
+
# Treasury, the type will be populated here, otherwise null. This can be one of
|
637
|
+
# payment_order, incoming_payment_detail, expected_payment, return, paper_item, or
|
638
|
+
# reversal.
|
639
|
+
#
|
640
|
+
# @return [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::LedgerTransaction::LedgerableType, nil]
|
641
|
+
optional :ledgerable_type,
|
642
|
+
enum: -> { ModernTreasury::Models::PaymentOrderCreateParams::LedgerTransaction::LedgerableType }
|
643
|
+
|
644
|
+
# @!parse
|
645
|
+
# # @return [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::LedgerTransaction::LedgerableType]
|
646
|
+
# attr_writer :ledgerable_type
|
647
|
+
|
648
|
+
# @!attribute [r] metadata
|
649
|
+
# Additional data represented as key-value pairs. Both the key and value must be
|
650
|
+
# strings.
|
651
|
+
#
|
652
|
+
# @return [Hash{Symbol=>String}, nil]
|
653
|
+
optional :metadata, ModernTreasury::HashOf[String]
|
654
|
+
|
655
|
+
# @!parse
|
656
|
+
# # @return [Hash{Symbol=>String}]
|
657
|
+
# attr_writer :metadata
|
658
|
+
|
659
|
+
# @!attribute [r] status
|
660
|
+
# To post a ledger transaction at creation, use `posted`.
|
661
|
+
#
|
662
|
+
# @return [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::LedgerTransaction::Status, nil]
|
663
|
+
optional :status, enum: -> { ModernTreasury::Models::PaymentOrderCreateParams::LedgerTransaction::Status }
|
664
|
+
|
665
|
+
# @!parse
|
666
|
+
# # @return [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::LedgerTransaction::Status]
|
667
|
+
# attr_writer :status
|
668
|
+
|
669
|
+
# @!parse
|
670
|
+
# # Specifies a ledger transaction object that will be created with the payment
|
671
|
+
# # order. If the ledger transaction cannot be created, then the payment order
|
672
|
+
# # creation will fail. The resulting ledger transaction will mirror the status of
|
673
|
+
# # the payment order.
|
674
|
+
# #
|
675
|
+
# # @param ledger_entries [Array<ModernTreasury::Models::PaymentOrderCreateParams::LedgerTransaction::LedgerEntry>]
|
676
|
+
# # @param description [String, nil]
|
677
|
+
# # @param effective_at [Time]
|
678
|
+
# # @param effective_date [Date]
|
679
|
+
# # @param external_id [String]
|
680
|
+
# # @param ledgerable_id [String]
|
681
|
+
# # @param ledgerable_type [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::LedgerTransaction::LedgerableType]
|
682
|
+
# # @param metadata [Hash{Symbol=>String}]
|
683
|
+
# # @param status [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::LedgerTransaction::Status]
|
684
|
+
# #
|
685
|
+
# def initialize(
|
686
|
+
# ledger_entries:,
|
687
|
+
# description: nil,
|
688
|
+
# effective_at: nil,
|
689
|
+
# effective_date: nil,
|
690
|
+
# external_id: nil,
|
691
|
+
# ledgerable_id: nil,
|
692
|
+
# ledgerable_type: nil,
|
693
|
+
# metadata: nil,
|
694
|
+
# status: nil,
|
695
|
+
# **
|
696
|
+
# )
|
697
|
+
# super
|
698
|
+
# end
|
699
|
+
|
700
|
+
# def initialize: (Hash | ModernTreasury::BaseModel) -> void
|
701
|
+
|
702
|
+
class LedgerEntry < ModernTreasury::BaseModel
|
703
|
+
# @!attribute amount
|
704
|
+
# Value in specified currency's smallest unit. e.g. $10 would be represented
|
705
|
+
# as 1000. Can be any integer up to 36 digits.
|
706
|
+
#
|
707
|
+
# @return [Integer]
|
708
|
+
required :amount, Integer
|
709
|
+
|
710
|
+
# @!attribute direction
|
711
|
+
# One of `credit`, `debit`. Describes the direction money is flowing in the
|
712
|
+
# transaction. A `credit` moves money from your account to someone else's. A
|
713
|
+
# `debit` pulls money from someone else's account to your own. Note that wire,
|
714
|
+
# rtp, and check payments will always be `credit`.
|
715
|
+
#
|
716
|
+
# @return [Symbol, ModernTreasury::Models::TransactionDirection]
|
717
|
+
required :direction, enum: -> { ModernTreasury::Models::TransactionDirection }
|
718
|
+
|
719
|
+
# @!attribute ledger_account_id
|
720
|
+
# The ledger account that this ledger entry is associated with.
|
721
|
+
#
|
722
|
+
# @return [String]
|
723
|
+
required :ledger_account_id, String
|
724
|
+
|
725
|
+
# @!attribute available_balance_amount
|
726
|
+
# Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
|
727
|
+
# account’s available balance. If any of these conditions would be false after the
|
728
|
+
# transaction is created, the entire call will fail with error code 422.
|
729
|
+
#
|
730
|
+
# @return [Hash{Symbol=>Integer}, nil]
|
731
|
+
optional :available_balance_amount, ModernTreasury::HashOf[Integer], nil?: true
|
732
|
+
|
733
|
+
# @!attribute lock_version
|
734
|
+
# Lock version of the ledger account. This can be passed when creating a ledger
|
735
|
+
# transaction to only succeed if no ledger transactions have posted since the
|
736
|
+
# given version. See our post about Designing the Ledgers API with Optimistic
|
737
|
+
# Locking for more details.
|
738
|
+
#
|
739
|
+
# @return [Integer, nil]
|
740
|
+
optional :lock_version, Integer, nil?: true
|
741
|
+
|
742
|
+
# @!attribute [r] metadata
|
743
|
+
# Additional data represented as key-value pairs. Both the key and value must be
|
744
|
+
# strings.
|
745
|
+
#
|
746
|
+
# @return [Hash{Symbol=>String}, nil]
|
747
|
+
optional :metadata, ModernTreasury::HashOf[String]
|
748
|
+
|
749
|
+
# @!parse
|
750
|
+
# # @return [Hash{Symbol=>String}]
|
751
|
+
# attr_writer :metadata
|
752
|
+
|
753
|
+
# @!attribute pending_balance_amount
|
754
|
+
# Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
|
755
|
+
# account’s pending balance. If any of these conditions would be false after the
|
756
|
+
# transaction is created, the entire call will fail with error code 422.
|
757
|
+
#
|
758
|
+
# @return [Hash{Symbol=>Integer}, nil]
|
759
|
+
optional :pending_balance_amount, ModernTreasury::HashOf[Integer], nil?: true
|
760
|
+
|
761
|
+
# @!attribute posted_balance_amount
|
762
|
+
# Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
|
763
|
+
# account’s posted balance. If any of these conditions would be false after the
|
764
|
+
# transaction is created, the entire call will fail with error code 422.
|
765
|
+
#
|
766
|
+
# @return [Hash{Symbol=>Integer}, nil]
|
767
|
+
optional :posted_balance_amount, ModernTreasury::HashOf[Integer], nil?: true
|
768
|
+
|
769
|
+
# @!attribute show_resulting_ledger_account_balances
|
770
|
+
# If true, response will include the balance of the associated ledger account for
|
771
|
+
# the entry.
|
772
|
+
#
|
773
|
+
# @return [Boolean, nil]
|
774
|
+
optional :show_resulting_ledger_account_balances, ModernTreasury::BooleanModel, nil?: true
|
775
|
+
|
776
|
+
# @!parse
|
777
|
+
# # @param amount [Integer]
|
778
|
+
# # @param direction [Symbol, ModernTreasury::Models::TransactionDirection]
|
779
|
+
# # @param ledger_account_id [String]
|
780
|
+
# # @param available_balance_amount [Hash{Symbol=>Integer}, nil]
|
781
|
+
# # @param lock_version [Integer, nil]
|
782
|
+
# # @param metadata [Hash{Symbol=>String}]
|
783
|
+
# # @param pending_balance_amount [Hash{Symbol=>Integer}, nil]
|
784
|
+
# # @param posted_balance_amount [Hash{Symbol=>Integer}, nil]
|
785
|
+
# # @param show_resulting_ledger_account_balances [Boolean, nil]
|
786
|
+
# #
|
787
|
+
# def initialize(
|
788
|
+
# amount:,
|
789
|
+
# direction:,
|
790
|
+
# ledger_account_id:,
|
791
|
+
# available_balance_amount: nil,
|
792
|
+
# lock_version: nil,
|
793
|
+
# metadata: nil,
|
794
|
+
# pending_balance_amount: nil,
|
795
|
+
# posted_balance_amount: nil,
|
796
|
+
# show_resulting_ledger_account_balances: nil,
|
797
|
+
# **
|
798
|
+
# )
|
799
|
+
# super
|
800
|
+
# end
|
801
|
+
|
802
|
+
# def initialize: (Hash | ModernTreasury::BaseModel) -> void
|
803
|
+
end
|
804
|
+
|
805
|
+
# If the ledger transaction can be reconciled to another object in Modern
|
806
|
+
# Treasury, the type will be populated here, otherwise null. This can be one of
|
807
|
+
# payment_order, incoming_payment_detail, expected_payment, return, paper_item, or
|
808
|
+
# reversal.
|
809
|
+
module LedgerableType
|
810
|
+
extend ModernTreasury::Enum
|
811
|
+
|
812
|
+
EXPECTED_PAYMENT = :expected_payment
|
813
|
+
INCOMING_PAYMENT_DETAIL = :incoming_payment_detail
|
814
|
+
PAPER_ITEM = :paper_item
|
815
|
+
PAYMENT_ORDER = :payment_order
|
816
|
+
RETURN = :return
|
817
|
+
REVERSAL = :reversal
|
818
|
+
|
819
|
+
finalize!
|
820
|
+
|
821
|
+
# @!parse
|
822
|
+
# # @return [Array<Symbol>]
|
823
|
+
# def self.values; end
|
824
|
+
end
|
825
|
+
|
826
|
+
# To post a ledger transaction at creation, use `posted`.
|
827
|
+
module Status
|
828
|
+
extend ModernTreasury::Enum
|
829
|
+
|
830
|
+
ARCHIVED = :archived
|
831
|
+
PENDING = :pending
|
832
|
+
POSTED = :posted
|
833
|
+
|
834
|
+
finalize!
|
835
|
+
|
836
|
+
# @!parse
|
837
|
+
# # @return [Array<Symbol>]
|
838
|
+
# def self.values; end
|
839
|
+
end
|
840
|
+
end
|
841
|
+
|
842
|
+
class LineItem < ModernTreasury::BaseModel
|
843
|
+
# @!attribute amount
|
844
|
+
# Value in specified currency's smallest unit. e.g. $10 would be represented
|
845
|
+
# as 1000.
|
846
|
+
#
|
847
|
+
# @return [Integer]
|
848
|
+
required :amount, Integer
|
849
|
+
|
850
|
+
# @!attribute accounting_category_id
|
851
|
+
# The ID of one of your accounting categories. Note that these will only be
|
852
|
+
# accessible if your accounting system has been connected.
|
853
|
+
#
|
854
|
+
# @return [String, nil]
|
855
|
+
optional :accounting_category_id, String, nil?: true
|
856
|
+
|
857
|
+
# @!attribute description
|
858
|
+
# A free-form description of the line item.
|
859
|
+
#
|
860
|
+
# @return [String, nil]
|
861
|
+
optional :description, String, nil?: true
|
862
|
+
|
863
|
+
# @!attribute [r] metadata
|
864
|
+
# Additional data represented as key-value pairs. Both the key and value must be
|
865
|
+
# strings.
|
866
|
+
#
|
867
|
+
# @return [Hash{Symbol=>String}, nil]
|
868
|
+
optional :metadata, ModernTreasury::HashOf[String]
|
869
|
+
|
870
|
+
# @!parse
|
871
|
+
# # @return [Hash{Symbol=>String}]
|
872
|
+
# attr_writer :metadata
|
873
|
+
|
874
|
+
# @!parse
|
875
|
+
# # @param amount [Integer]
|
876
|
+
# # @param accounting_category_id [String, nil]
|
877
|
+
# # @param description [String, nil]
|
878
|
+
# # @param metadata [Hash{Symbol=>String}]
|
879
|
+
# #
|
880
|
+
# def initialize(amount:, accounting_category_id: nil, description: nil, metadata: nil, **) = super
|
881
|
+
|
882
|
+
# def initialize: (Hash | ModernTreasury::BaseModel) -> void
|
883
|
+
end
|
884
|
+
|
885
|
+
# Either `normal` or `high`. For ACH and EFT payments, `high` represents a
|
886
|
+
# same-day ACH or EFT transfer, respectively. For check payments, `high` can mean
|
887
|
+
# an overnight check rather than standard mail.
|
888
|
+
module Priority
|
889
|
+
extend ModernTreasury::Enum
|
890
|
+
|
891
|
+
HIGH = :high
|
892
|
+
NORMAL = :normal
|
893
|
+
|
894
|
+
finalize!
|
895
|
+
|
896
|
+
# @!parse
|
897
|
+
# # @return [Array<Symbol>]
|
898
|
+
# def self.values; end
|
899
|
+
end
|
900
|
+
|
901
|
+
class ReceivingAccount < ModernTreasury::BaseModel
|
902
|
+
# @!attribute [r] account_details
|
903
|
+
#
|
904
|
+
# @return [Array<ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount::AccountDetail>, nil]
|
905
|
+
optional :account_details,
|
906
|
+
-> { ModernTreasury::ArrayOf[ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount::AccountDetail] }
|
907
|
+
|
908
|
+
# @!parse
|
909
|
+
# # @return [Array<ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount::AccountDetail>]
|
910
|
+
# attr_writer :account_details
|
911
|
+
|
912
|
+
# @!attribute [r] account_type
|
913
|
+
# Can be `checking`, `savings` or `other`.
|
914
|
+
#
|
915
|
+
# @return [Symbol, ModernTreasury::Models::ExternalAccountType, nil]
|
916
|
+
optional :account_type, enum: -> { ModernTreasury::Models::ExternalAccountType }
|
917
|
+
|
918
|
+
# @!parse
|
919
|
+
# # @return [Symbol, ModernTreasury::Models::ExternalAccountType]
|
920
|
+
# attr_writer :account_type
|
921
|
+
|
922
|
+
# @!attribute [r] contact_details
|
923
|
+
#
|
924
|
+
# @return [Array<ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount::ContactDetail>, nil]
|
925
|
+
optional :contact_details,
|
926
|
+
-> { ModernTreasury::ArrayOf[ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount::ContactDetail] }
|
927
|
+
|
928
|
+
# @!parse
|
929
|
+
# # @return [Array<ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount::ContactDetail>]
|
930
|
+
# attr_writer :contact_details
|
931
|
+
|
932
|
+
# @!attribute [r] ledger_account
|
933
|
+
# Specifies a ledger account object that will be created with the external
|
934
|
+
# account. The resulting ledger account is linked to the external account for
|
935
|
+
# auto-ledgering Payment objects. See
|
936
|
+
# https://docs.moderntreasury.com/docs/linking-to-other-modern-treasury-objects
|
937
|
+
# for more details.
|
938
|
+
#
|
939
|
+
# @return [ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount::LedgerAccount, nil]
|
940
|
+
optional :ledger_account,
|
941
|
+
-> { ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount::LedgerAccount }
|
942
|
+
|
943
|
+
# @!parse
|
944
|
+
# # @return [ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount::LedgerAccount]
|
945
|
+
# attr_writer :ledger_account
|
946
|
+
|
947
|
+
# @!attribute [r] metadata
|
948
|
+
# Additional data represented as key-value pairs. Both the key and value must be
|
949
|
+
# strings.
|
950
|
+
#
|
951
|
+
# @return [Hash{Symbol=>String}, nil]
|
952
|
+
optional :metadata, ModernTreasury::HashOf[String]
|
953
|
+
|
954
|
+
# @!parse
|
955
|
+
# # @return [Hash{Symbol=>String}]
|
956
|
+
# attr_writer :metadata
|
957
|
+
|
958
|
+
# @!attribute name
|
959
|
+
# A nickname for the external account. This is only for internal usage and won't
|
960
|
+
# affect any payments
|
961
|
+
#
|
962
|
+
# @return [String, nil]
|
963
|
+
optional :name, String, nil?: true
|
964
|
+
|
965
|
+
# @!attribute [r] party_address
|
966
|
+
# Required if receiving wire payments.
|
967
|
+
#
|
968
|
+
# @return [ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount::PartyAddress, nil]
|
969
|
+
optional :party_address,
|
970
|
+
-> { ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount::PartyAddress }
|
971
|
+
|
972
|
+
# @!parse
|
973
|
+
# # @return [ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount::PartyAddress]
|
974
|
+
# attr_writer :party_address
|
975
|
+
|
976
|
+
# @!attribute [r] party_identifier
|
977
|
+
#
|
978
|
+
# @return [String, nil]
|
979
|
+
optional :party_identifier, String
|
980
|
+
|
981
|
+
# @!parse
|
982
|
+
# # @return [String]
|
983
|
+
# attr_writer :party_identifier
|
984
|
+
|
985
|
+
# @!attribute [r] party_name
|
986
|
+
# If this value isn't provided, it will be inherited from the counterparty's name.
|
987
|
+
#
|
988
|
+
# @return [String, nil]
|
989
|
+
optional :party_name, String
|
990
|
+
|
991
|
+
# @!parse
|
992
|
+
# # @return [String]
|
993
|
+
# attr_writer :party_name
|
994
|
+
|
995
|
+
# @!attribute party_type
|
996
|
+
# Either `individual` or `business`.
|
997
|
+
#
|
998
|
+
# @return [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount::PartyType, nil]
|
999
|
+
optional :party_type,
|
1000
|
+
enum: -> { ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount::PartyType },
|
1001
|
+
nil?: true
|
1002
|
+
|
1003
|
+
# @!attribute [r] plaid_processor_token
|
1004
|
+
# If you've enabled the Modern Treasury + Plaid integration in your Plaid account,
|
1005
|
+
# you can pass the processor token in this field.
|
1006
|
+
#
|
1007
|
+
# @return [String, nil]
|
1008
|
+
optional :plaid_processor_token, String
|
1009
|
+
|
1010
|
+
# @!parse
|
1011
|
+
# # @return [String]
|
1012
|
+
# attr_writer :plaid_processor_token
|
1013
|
+
|
1014
|
+
# @!attribute [r] routing_details
|
1015
|
+
#
|
1016
|
+
# @return [Array<ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount::RoutingDetail>, nil]
|
1017
|
+
optional :routing_details,
|
1018
|
+
-> { ModernTreasury::ArrayOf[ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount::RoutingDetail] }
|
1019
|
+
|
1020
|
+
# @!parse
|
1021
|
+
# # @return [Array<ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount::RoutingDetail>]
|
1022
|
+
# attr_writer :routing_details
|
1023
|
+
|
1024
|
+
# @!parse
|
1025
|
+
# # Either `receiving_account` or `receiving_account_id` must be present. When using
|
1026
|
+
# # `receiving_account_id`, you may pass the id of an external account or an
|
1027
|
+
# # internal account.
|
1028
|
+
# #
|
1029
|
+
# # @param account_details [Array<ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount::AccountDetail>]
|
1030
|
+
# # @param account_type [Symbol, ModernTreasury::Models::ExternalAccountType]
|
1031
|
+
# # @param contact_details [Array<ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount::ContactDetail>]
|
1032
|
+
# # @param ledger_account [ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount::LedgerAccount]
|
1033
|
+
# # @param metadata [Hash{Symbol=>String}]
|
1034
|
+
# # @param name [String, nil]
|
1035
|
+
# # @param party_address [ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount::PartyAddress]
|
1036
|
+
# # @param party_identifier [String]
|
1037
|
+
# # @param party_name [String]
|
1038
|
+
# # @param party_type [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount::PartyType, nil]
|
1039
|
+
# # @param plaid_processor_token [String]
|
1040
|
+
# # @param routing_details [Array<ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount::RoutingDetail>]
|
1041
|
+
# #
|
1042
|
+
# def initialize(
|
1043
|
+
# account_details: nil,
|
1044
|
+
# account_type: nil,
|
1045
|
+
# contact_details: nil,
|
1046
|
+
# ledger_account: nil,
|
1047
|
+
# metadata: nil,
|
1048
|
+
# name: nil,
|
1049
|
+
# party_address: nil,
|
1050
|
+
# party_identifier: nil,
|
1051
|
+
# party_name: nil,
|
1052
|
+
# party_type: nil,
|
1053
|
+
# plaid_processor_token: nil,
|
1054
|
+
# routing_details: nil,
|
1055
|
+
# **
|
1056
|
+
# )
|
1057
|
+
# super
|
1058
|
+
# end
|
1059
|
+
|
1060
|
+
# def initialize: (Hash | ModernTreasury::BaseModel) -> void
|
1061
|
+
|
1062
|
+
class AccountDetail < ModernTreasury::BaseModel
|
1063
|
+
# @!attribute account_number
|
1064
|
+
#
|
1065
|
+
# @return [String]
|
1066
|
+
required :account_number, String
|
1067
|
+
|
1068
|
+
# @!attribute [r] account_number_type
|
1069
|
+
#
|
1070
|
+
# @return [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount::AccountDetail::AccountNumberType, nil]
|
1071
|
+
optional :account_number_type,
|
1072
|
+
enum: -> { ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount::AccountDetail::AccountNumberType }
|
1073
|
+
|
1074
|
+
# @!parse
|
1075
|
+
# # @return [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount::AccountDetail::AccountNumberType]
|
1076
|
+
# attr_writer :account_number_type
|
1077
|
+
|
1078
|
+
# @!parse
|
1079
|
+
# # @param account_number [String]
|
1080
|
+
# # @param account_number_type [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount::AccountDetail::AccountNumberType]
|
1081
|
+
# #
|
1082
|
+
# def initialize(account_number:, account_number_type: nil, **) = super
|
1083
|
+
|
1084
|
+
# def initialize: (Hash | ModernTreasury::BaseModel) -> void
|
1085
|
+
|
1086
|
+
module AccountNumberType
|
1087
|
+
extend ModernTreasury::Enum
|
1088
|
+
|
1089
|
+
AU_NUMBER = :au_number
|
1090
|
+
CLABE = :clabe
|
1091
|
+
HK_NUMBER = :hk_number
|
1092
|
+
IBAN = :iban
|
1093
|
+
ID_NUMBER = :id_number
|
1094
|
+
NZ_NUMBER = :nz_number
|
1095
|
+
OTHER = :other
|
1096
|
+
PAN = :pan
|
1097
|
+
SG_NUMBER = :sg_number
|
1098
|
+
WALLET_ADDRESS = :wallet_address
|
1099
|
+
|
1100
|
+
finalize!
|
1101
|
+
|
1102
|
+
# @!parse
|
1103
|
+
# # @return [Array<Symbol>]
|
1104
|
+
# def self.values; end
|
1105
|
+
end
|
1106
|
+
end
|
1107
|
+
|
1108
|
+
class ContactDetail < ModernTreasury::BaseModel
|
1109
|
+
# @!attribute [r] contact_identifier
|
1110
|
+
#
|
1111
|
+
# @return [String, nil]
|
1112
|
+
optional :contact_identifier, String
|
1113
|
+
|
1114
|
+
# @!parse
|
1115
|
+
# # @return [String]
|
1116
|
+
# attr_writer :contact_identifier
|
1117
|
+
|
1118
|
+
# @!attribute [r] contact_identifier_type
|
1119
|
+
#
|
1120
|
+
# @return [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount::ContactDetail::ContactIdentifierType, nil]
|
1121
|
+
optional :contact_identifier_type,
|
1122
|
+
enum: -> { ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount::ContactDetail::ContactIdentifierType }
|
1123
|
+
|
1124
|
+
# @!parse
|
1125
|
+
# # @return [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount::ContactDetail::ContactIdentifierType]
|
1126
|
+
# attr_writer :contact_identifier_type
|
1127
|
+
|
1128
|
+
# @!parse
|
1129
|
+
# # @param contact_identifier [String]
|
1130
|
+
# # @param contact_identifier_type [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount::ContactDetail::ContactIdentifierType]
|
1131
|
+
# #
|
1132
|
+
# def initialize(contact_identifier: nil, contact_identifier_type: nil, **) = super
|
1133
|
+
|
1134
|
+
# def initialize: (Hash | ModernTreasury::BaseModel) -> void
|
1135
|
+
|
1136
|
+
module ContactIdentifierType
|
1137
|
+
extend ModernTreasury::Enum
|
1138
|
+
|
1139
|
+
EMAIL = :email
|
1140
|
+
PHONE_NUMBER = :phone_number
|
1141
|
+
WEBSITE = :website
|
1142
|
+
|
1143
|
+
finalize!
|
1144
|
+
|
1145
|
+
# @!parse
|
1146
|
+
# # @return [Array<Symbol>]
|
1147
|
+
# def self.values; end
|
1148
|
+
end
|
1149
|
+
end
|
1150
|
+
|
1151
|
+
class LedgerAccount < ModernTreasury::BaseModel
|
1152
|
+
# @!attribute currency
|
1153
|
+
# The currency of the ledger account.
|
1154
|
+
#
|
1155
|
+
# @return [String]
|
1156
|
+
required :currency, String
|
1157
|
+
|
1158
|
+
# @!attribute ledger_id
|
1159
|
+
# The id of the ledger that this account belongs to.
|
1160
|
+
#
|
1161
|
+
# @return [String]
|
1162
|
+
required :ledger_id, String
|
1163
|
+
|
1164
|
+
# @!attribute name
|
1165
|
+
# The name of the ledger account.
|
1166
|
+
#
|
1167
|
+
# @return [String]
|
1168
|
+
required :name, String
|
1169
|
+
|
1170
|
+
# @!attribute normal_balance
|
1171
|
+
# The normal balance of the ledger account.
|
1172
|
+
#
|
1173
|
+
# @return [Symbol, ModernTreasury::Models::TransactionDirection]
|
1174
|
+
required :normal_balance, enum: -> { ModernTreasury::Models::TransactionDirection }
|
1175
|
+
|
1176
|
+
# @!attribute currency_exponent
|
1177
|
+
# The currency exponent of the ledger account.
|
1178
|
+
#
|
1179
|
+
# @return [Integer, nil]
|
1180
|
+
optional :currency_exponent, Integer, nil?: true
|
1181
|
+
|
1182
|
+
# @!attribute description
|
1183
|
+
# The description of the ledger account.
|
1184
|
+
#
|
1185
|
+
# @return [String, nil]
|
1186
|
+
optional :description, String, nil?: true
|
1187
|
+
|
1188
|
+
# @!attribute [r] ledger_account_category_ids
|
1189
|
+
# The array of ledger account category ids that this ledger account should be a
|
1190
|
+
# child of.
|
1191
|
+
#
|
1192
|
+
# @return [Array<String>, nil]
|
1193
|
+
optional :ledger_account_category_ids, ModernTreasury::ArrayOf[String]
|
1194
|
+
|
1195
|
+
# @!parse
|
1196
|
+
# # @return [Array<String>]
|
1197
|
+
# attr_writer :ledger_account_category_ids
|
1198
|
+
|
1199
|
+
# @!attribute [r] ledgerable_id
|
1200
|
+
# If the ledger account links to another object in Modern Treasury, the id will be
|
1201
|
+
# populated here, otherwise null.
|
1202
|
+
#
|
1203
|
+
# @return [String, nil]
|
1204
|
+
optional :ledgerable_id, String
|
1205
|
+
|
1206
|
+
# @!parse
|
1207
|
+
# # @return [String]
|
1208
|
+
# attr_writer :ledgerable_id
|
1209
|
+
|
1210
|
+
# @!attribute [r] ledgerable_type
|
1211
|
+
# If the ledger account links to another object in Modern Treasury, the type will
|
1212
|
+
# be populated here, otherwise null. The value is one of internal_account or
|
1213
|
+
# external_account.
|
1214
|
+
#
|
1215
|
+
# @return [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount::LedgerAccount::LedgerableType, nil]
|
1216
|
+
optional :ledgerable_type,
|
1217
|
+
enum: -> { ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount::LedgerAccount::LedgerableType }
|
1218
|
+
|
1219
|
+
# @!parse
|
1220
|
+
# # @return [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount::LedgerAccount::LedgerableType]
|
1221
|
+
# attr_writer :ledgerable_type
|
1222
|
+
|
1223
|
+
# @!attribute [r] metadata
|
1224
|
+
# Additional data represented as key-value pairs. Both the key and value must be
|
1225
|
+
# strings.
|
1226
|
+
#
|
1227
|
+
# @return [Hash{Symbol=>String}, nil]
|
1228
|
+
optional :metadata, ModernTreasury::HashOf[String]
|
1229
|
+
|
1230
|
+
# @!parse
|
1231
|
+
# # @return [Hash{Symbol=>String}]
|
1232
|
+
# attr_writer :metadata
|
1233
|
+
|
1234
|
+
# @!parse
|
1235
|
+
# # Specifies a ledger account object that will be created with the external
|
1236
|
+
# # account. The resulting ledger account is linked to the external account for
|
1237
|
+
# # auto-ledgering Payment objects. See
|
1238
|
+
# # https://docs.moderntreasury.com/docs/linking-to-other-modern-treasury-objects
|
1239
|
+
# # for more details.
|
1240
|
+
# #
|
1241
|
+
# # @param currency [String]
|
1242
|
+
# # @param ledger_id [String]
|
1243
|
+
# # @param name [String]
|
1244
|
+
# # @param normal_balance [Symbol, ModernTreasury::Models::TransactionDirection]
|
1245
|
+
# # @param currency_exponent [Integer, nil]
|
1246
|
+
# # @param description [String, nil]
|
1247
|
+
# # @param ledger_account_category_ids [Array<String>]
|
1248
|
+
# # @param ledgerable_id [String]
|
1249
|
+
# # @param ledgerable_type [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount::LedgerAccount::LedgerableType]
|
1250
|
+
# # @param metadata [Hash{Symbol=>String}]
|
1251
|
+
# #
|
1252
|
+
# def initialize(
|
1253
|
+
# currency:,
|
1254
|
+
# ledger_id:,
|
1255
|
+
# name:,
|
1256
|
+
# normal_balance:,
|
1257
|
+
# currency_exponent: nil,
|
1258
|
+
# description: nil,
|
1259
|
+
# ledger_account_category_ids: nil,
|
1260
|
+
# ledgerable_id: nil,
|
1261
|
+
# ledgerable_type: nil,
|
1262
|
+
# metadata: nil,
|
1263
|
+
# **
|
1264
|
+
# )
|
1265
|
+
# super
|
1266
|
+
# end
|
1267
|
+
|
1268
|
+
# def initialize: (Hash | ModernTreasury::BaseModel) -> void
|
1269
|
+
|
1270
|
+
# If the ledger account links to another object in Modern Treasury, the type will
|
1271
|
+
# be populated here, otherwise null. The value is one of internal_account or
|
1272
|
+
# external_account.
|
1273
|
+
module LedgerableType
|
1274
|
+
extend ModernTreasury::Enum
|
1275
|
+
|
1276
|
+
COUNTERPARTY = :counterparty
|
1277
|
+
EXTERNAL_ACCOUNT = :external_account
|
1278
|
+
INTERNAL_ACCOUNT = :internal_account
|
1279
|
+
VIRTUAL_ACCOUNT = :virtual_account
|
1280
|
+
|
1281
|
+
finalize!
|
1282
|
+
|
1283
|
+
# @!parse
|
1284
|
+
# # @return [Array<Symbol>]
|
1285
|
+
# def self.values; end
|
1286
|
+
end
|
1287
|
+
end
|
1288
|
+
|
1289
|
+
class PartyAddress < ModernTreasury::BaseModel
|
1290
|
+
# @!attribute country
|
1291
|
+
# Country code conforms to [ISO 3166-1 alpha-2]
|
1292
|
+
#
|
1293
|
+
# @return [String, nil]
|
1294
|
+
optional :country, String, nil?: true
|
1295
|
+
|
1296
|
+
# @!attribute line1
|
1297
|
+
#
|
1298
|
+
# @return [String, nil]
|
1299
|
+
optional :line1, String, nil?: true
|
1300
|
+
|
1301
|
+
# @!attribute line2
|
1302
|
+
#
|
1303
|
+
# @return [String, nil]
|
1304
|
+
optional :line2, String, nil?: true
|
1305
|
+
|
1306
|
+
# @!attribute locality
|
1307
|
+
# Locality or City.
|
1308
|
+
#
|
1309
|
+
# @return [String, nil]
|
1310
|
+
optional :locality, String, nil?: true
|
1311
|
+
|
1312
|
+
# @!attribute postal_code
|
1313
|
+
# The postal code of the address.
|
1314
|
+
#
|
1315
|
+
# @return [String, nil]
|
1316
|
+
optional :postal_code, String, nil?: true
|
1317
|
+
|
1318
|
+
# @!attribute region
|
1319
|
+
# Region or State.
|
1320
|
+
#
|
1321
|
+
# @return [String, nil]
|
1322
|
+
optional :region, String, nil?: true
|
1323
|
+
|
1324
|
+
# @!parse
|
1325
|
+
# # Required if receiving wire payments.
|
1326
|
+
# #
|
1327
|
+
# # @param country [String, nil]
|
1328
|
+
# # @param line1 [String, nil]
|
1329
|
+
# # @param line2 [String, nil]
|
1330
|
+
# # @param locality [String, nil]
|
1331
|
+
# # @param postal_code [String, nil]
|
1332
|
+
# # @param region [String, nil]
|
1333
|
+
# #
|
1334
|
+
# def initialize(country: nil, line1: nil, line2: nil, locality: nil, postal_code: nil, region: nil, **) = super
|
1335
|
+
|
1336
|
+
# def initialize: (Hash | ModernTreasury::BaseModel) -> void
|
1337
|
+
end
|
1338
|
+
|
1339
|
+
# Either `individual` or `business`.
|
1340
|
+
module PartyType
|
1341
|
+
extend ModernTreasury::Enum
|
1342
|
+
|
1343
|
+
BUSINESS = :business
|
1344
|
+
INDIVIDUAL = :individual
|
1345
|
+
|
1346
|
+
finalize!
|
1347
|
+
|
1348
|
+
# @!parse
|
1349
|
+
# # @return [Array<Symbol>]
|
1350
|
+
# def self.values; end
|
1351
|
+
end
|
1352
|
+
|
1353
|
+
class RoutingDetail < ModernTreasury::BaseModel
|
1354
|
+
# @!attribute routing_number
|
1355
|
+
#
|
1356
|
+
# @return [String]
|
1357
|
+
required :routing_number, String
|
1358
|
+
|
1359
|
+
# @!attribute routing_number_type
|
1360
|
+
#
|
1361
|
+
# @return [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount::RoutingDetail::RoutingNumberType]
|
1362
|
+
required :routing_number_type,
|
1363
|
+
enum: -> { ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount::RoutingDetail::RoutingNumberType }
|
1364
|
+
|
1365
|
+
# @!attribute [r] payment_type
|
1366
|
+
#
|
1367
|
+
# @return [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount::RoutingDetail::PaymentType, nil]
|
1368
|
+
optional :payment_type,
|
1369
|
+
enum: -> { ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount::RoutingDetail::PaymentType }
|
1370
|
+
|
1371
|
+
# @!parse
|
1372
|
+
# # @return [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount::RoutingDetail::PaymentType]
|
1373
|
+
# attr_writer :payment_type
|
1374
|
+
|
1375
|
+
# @!parse
|
1376
|
+
# # @param routing_number [String]
|
1377
|
+
# # @param routing_number_type [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount::RoutingDetail::RoutingNumberType]
|
1378
|
+
# # @param payment_type [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount::RoutingDetail::PaymentType]
|
1379
|
+
# #
|
1380
|
+
# def initialize(routing_number:, routing_number_type:, payment_type: nil, **) = super
|
1381
|
+
|
1382
|
+
# def initialize: (Hash | ModernTreasury::BaseModel) -> void
|
1383
|
+
|
1384
|
+
module RoutingNumberType
|
1385
|
+
extend ModernTreasury::Enum
|
1386
|
+
|
1387
|
+
ABA = :aba
|
1388
|
+
AU_BSB = :au_bsb
|
1389
|
+
BR_CODIGO = :br_codigo
|
1390
|
+
CA_CPA = :ca_cpa
|
1391
|
+
CHIPS = :chips
|
1392
|
+
CNAPS = :cnaps
|
1393
|
+
DK_INTERBANK_CLEARING_CODE = :dk_interbank_clearing_code
|
1394
|
+
GB_SORT_CODE = :gb_sort_code
|
1395
|
+
HK_INTERBANK_CLEARING_CODE = :hk_interbank_clearing_code
|
1396
|
+
HU_INTERBANK_CLEARING_CODE = :hu_interbank_clearing_code
|
1397
|
+
ID_SKNBI_CODE = :id_sknbi_code
|
1398
|
+
IN_IFSC = :in_ifsc
|
1399
|
+
JP_ZENGIN_CODE = :jp_zengin_code
|
1400
|
+
MY_BRANCH_CODE = :my_branch_code
|
1401
|
+
MX_BANK_IDENTIFIER = :mx_bank_identifier
|
1402
|
+
NZ_NATIONAL_CLEARING_CODE = :nz_national_clearing_code
|
1403
|
+
PL_NATIONAL_CLEARING_CODE = :pl_national_clearing_code
|
1404
|
+
SE_BANKGIRO_CLEARING_CODE = :se_bankgiro_clearing_code
|
1405
|
+
SG_INTERBANK_CLEARING_CODE = :sg_interbank_clearing_code
|
1406
|
+
SWIFT = :swift
|
1407
|
+
ZA_NATIONAL_CLEARING_CODE = :za_national_clearing_code
|
1408
|
+
|
1409
|
+
finalize!
|
1410
|
+
|
1411
|
+
# @!parse
|
1412
|
+
# # @return [Array<Symbol>]
|
1413
|
+
# def self.values; end
|
1414
|
+
end
|
1415
|
+
|
1416
|
+
module PaymentType
|
1417
|
+
extend ModernTreasury::Enum
|
1418
|
+
|
1419
|
+
ACH = :ach
|
1420
|
+
AU_BECS = :au_becs
|
1421
|
+
BACS = :bacs
|
1422
|
+
BOOK = :book
|
1423
|
+
CARD = :card
|
1424
|
+
CHATS = :chats
|
1425
|
+
CHECK = :check
|
1426
|
+
CROSS_BORDER = :cross_border
|
1427
|
+
DK_NETS = :dk_nets
|
1428
|
+
EFT = :eft
|
1429
|
+
HU_ICS = :hu_ics
|
1430
|
+
INTERAC = :interac
|
1431
|
+
MASAV = :masav
|
1432
|
+
MX_CCEN = :mx_ccen
|
1433
|
+
NEFT = :neft
|
1434
|
+
NICS = :nics
|
1435
|
+
NZ_BECS = :nz_becs
|
1436
|
+
PL_ELIXIR = :pl_elixir
|
1437
|
+
PROVXCHANGE = :provxchange
|
1438
|
+
RO_SENT = :ro_sent
|
1439
|
+
RTP = :rtp
|
1440
|
+
SE_BANKGIROT = :se_bankgirot
|
1441
|
+
SEN = :sen
|
1442
|
+
SEPA = :sepa
|
1443
|
+
SG_GIRO = :sg_giro
|
1444
|
+
SIC = :sic
|
1445
|
+
SIGNET = :signet
|
1446
|
+
SKNBI = :sknbi
|
1447
|
+
WIRE = :wire
|
1448
|
+
ZENGIN = :zengin
|
1449
|
+
|
1450
|
+
finalize!
|
1451
|
+
|
1452
|
+
# @!parse
|
1453
|
+
# # @return [Array<Symbol>]
|
1454
|
+
# def self.values; end
|
1455
|
+
end
|
1456
|
+
end
|
1457
|
+
end
|
1458
|
+
end
|
1459
|
+
end
|
1460
|
+
end
|