modern_treasury 0.1.0.pre.alpha.16 → 0.1.0.pre.alpha.18
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/.ignore +2 -0
- data/CHANGELOG.md +635 -0
- data/README.md +94 -24
- data/SECURITY.md +27 -0
- data/lib/modern_treasury/client.rb +12 -9
- data/lib/modern_treasury/errors.rb +168 -159
- data/lib/modern_treasury/internal/page.rb +90 -0
- data/lib/modern_treasury/internal/transport/base_client.rb +490 -0
- data/lib/modern_treasury/internal/transport/pooled_net_requester.rb +197 -0
- data/lib/modern_treasury/internal/type/array_of.rb +143 -0
- data/lib/modern_treasury/internal/type/base_model.rb +411 -0
- data/lib/modern_treasury/internal/type/base_page.rb +47 -0
- data/lib/modern_treasury/internal/type/boolean.rb +60 -0
- data/lib/modern_treasury/internal/type/converter.rb +271 -0
- data/lib/modern_treasury/internal/type/enum.rb +125 -0
- data/lib/modern_treasury/internal/type/hash_of.rb +163 -0
- data/lib/modern_treasury/internal/type/io_like.rb +77 -0
- data/lib/modern_treasury/internal/type/request_parameters.rb +49 -0
- data/lib/modern_treasury/internal/type/union.rb +222 -0
- data/lib/modern_treasury/internal/type/unknown.rb +64 -0
- data/lib/modern_treasury/internal/util.rb +782 -0
- data/lib/modern_treasury/internal.rb +12 -0
- data/lib/modern_treasury/models/account_collection_flow.rb +17 -14
- data/lib/modern_treasury/models/account_collection_flow_create_params.rb +8 -7
- data/lib/modern_treasury/models/account_collection_flow_list_params.rb +5 -4
- data/lib/modern_treasury/models/account_collection_flow_retrieve_params.rb +5 -4
- data/lib/modern_treasury/models/account_collection_flow_update_params.rb +8 -7
- data/lib/modern_treasury/models/account_detail.rb +10 -7
- data/lib/modern_treasury/models/account_detail_create_params.rb +9 -8
- data/lib/modern_treasury/models/account_detail_delete_params.rb +6 -5
- data/lib/modern_treasury/models/account_detail_list_params.rb +5 -4
- data/lib/modern_treasury/models/account_detail_retrieve_params.rb +5 -4
- data/lib/modern_treasury/models/accounts_type.rb +1 -1
- data/lib/modern_treasury/models/async_response.rb +2 -2
- data/lib/modern_treasury/models/bank_settings.rb +11 -11
- data/lib/modern_treasury/models/bulk_request.rb +21 -12
- data/lib/modern_treasury/models/bulk_request_create_params.rb +601 -518
- data/lib/modern_treasury/models/bulk_request_list_params.rb +14 -11
- data/lib/modern_treasury/models/bulk_request_retrieve_params.rb +5 -4
- data/lib/modern_treasury/models/bulk_result.rb +41 -30
- data/lib/modern_treasury/models/bulk_result_list_params.rb +16 -13
- data/lib/modern_treasury/models/bulk_result_retrieve_params.rb +5 -4
- data/lib/modern_treasury/models/client_ping_params.rb +5 -4
- data/lib/modern_treasury/models/connection.rb +5 -4
- data/lib/modern_treasury/models/connection_legal_entity.rb +8 -5
- data/lib/modern_treasury/models/connection_legal_entity_create_params.rb +116 -58
- data/lib/modern_treasury/models/connection_legal_entity_list_params.rb +6 -5
- data/lib/modern_treasury/models/connection_legal_entity_retrieve_params.rb +5 -4
- data/lib/modern_treasury/models/connection_legal_entity_update_params.rb +6 -5
- data/lib/modern_treasury/models/connection_list_params.rb +5 -4
- data/lib/modern_treasury/models/counterparty.rb +45 -33
- data/lib/modern_treasury/models/counterparty_collect_account_params.rb +20 -19
- data/lib/modern_treasury/models/counterparty_collect_account_response.rb +8 -7
- data/lib/modern_treasury/models/counterparty_create_params.rb +184 -114
- data/lib/modern_treasury/models/counterparty_delete_params.rb +5 -4
- data/lib/modern_treasury/models/counterparty_list_params.rb +10 -9
- data/lib/modern_treasury/models/counterparty_retrieve_params.rb +5 -4
- data/lib/modern_treasury/models/counterparty_update_params.rb +9 -8
- data/lib/modern_treasury/models/currency.rb +1 -1
- data/lib/modern_treasury/models/document.rb +20 -16
- data/lib/modern_treasury/models/document_create_params.rb +9 -8
- data/lib/modern_treasury/models/document_list_params.rb +10 -9
- data/lib/modern_treasury/models/document_retrieve_params.rb +5 -4
- data/lib/modern_treasury/models/event.rb +6 -5
- data/lib/modern_treasury/models/event_list_params.rb +5 -4
- data/lib/modern_treasury/models/event_retrieve_params.rb +5 -4
- data/lib/modern_treasury/models/expected_payment.rb +33 -26
- data/lib/modern_treasury/models/expected_payment_create_params.rb +82 -75
- data/lib/modern_treasury/models/expected_payment_delete_params.rb +5 -4
- data/lib/modern_treasury/models/expected_payment_list_params.rb +12 -11
- data/lib/modern_treasury/models/expected_payment_retrieve_params.rb +5 -4
- data/lib/modern_treasury/models/expected_payment_type.rb +2 -2
- data/lib/modern_treasury/models/expected_payment_update_params.rb +24 -23
- data/lib/modern_treasury/models/external_account.rb +32 -23
- data/lib/modern_treasury/models/external_account_complete_verification_params.rb +6 -5
- data/lib/modern_treasury/models/external_account_create_params.rb +51 -44
- data/lib/modern_treasury/models/external_account_delete_params.rb +5 -4
- data/lib/modern_treasury/models/external_account_list_params.rb +8 -7
- data/lib/modern_treasury/models/external_account_retrieve_params.rb +5 -4
- data/lib/modern_treasury/models/external_account_type.rb +1 -1
- data/lib/modern_treasury/models/external_account_update_params.rb +11 -10
- data/lib/modern_treasury/models/external_account_verify_params.rb +15 -14
- data/lib/modern_treasury/models/external_account_verify_response.rb +19 -12
- data/lib/modern_treasury/models/foreign_exchange_quote.rb +16 -14
- data/lib/modern_treasury/models/foreign_exchange_quote_create_params.rb +7 -6
- data/lib/modern_treasury/models/foreign_exchange_quote_list_params.rb +8 -7
- data/lib/modern_treasury/models/foreign_exchange_quote_retrieve_params.rb +5 -4
- data/lib/modern_treasury/models/incoming_payment_detail.rb +34 -21
- data/lib/modern_treasury/models/incoming_payment_detail_create_async_params.rb +22 -8
- data/lib/modern_treasury/models/incoming_payment_detail_list_params.rb +21 -16
- data/lib/modern_treasury/models/incoming_payment_detail_retrieve_params.rb +5 -4
- data/lib/modern_treasury/models/incoming_payment_detail_update_params.rb +7 -6
- data/lib/modern_treasury/models/internal_account.rb +23 -15
- data/lib/modern_treasury/models/internal_account_create_params.rb +12 -11
- data/lib/modern_treasury/models/internal_account_list_params.rb +9 -8
- data/lib/modern_treasury/models/internal_account_retrieve_params.rb +5 -4
- data/lib/modern_treasury/models/internal_account_update_params.rb +7 -6
- data/lib/modern_treasury/models/internal_accounts/balance_report.rb +27 -22
- data/lib/modern_treasury/models/internal_accounts/balance_report_create_params.rb +23 -20
- data/lib/modern_treasury/models/internal_accounts/balance_report_delete_params.rb +5 -4
- data/lib/modern_treasury/models/internal_accounts/balance_report_list_params.rb +8 -7
- data/lib/modern_treasury/models/internal_accounts/balance_report_retrieve_params.rb +5 -4
- data/lib/modern_treasury/models/invoice.rb +56 -42
- data/lib/modern_treasury/models/invoice_add_payment_order_params.rb +5 -4
- data/lib/modern_treasury/models/invoice_create_params.rb +64 -62
- data/lib/modern_treasury/models/invoice_list_params.rb +9 -8
- data/lib/modern_treasury/models/invoice_retrieve_params.rb +5 -4
- data/lib/modern_treasury/models/invoice_update_params.rb +63 -61
- data/lib/modern_treasury/models/invoices/invoice_line_item.rb +14 -13
- data/lib/modern_treasury/models/invoices/line_item_create_params.rb +13 -12
- data/lib/modern_treasury/models/invoices/line_item_delete_params.rb +5 -4
- data/lib/modern_treasury/models/invoices/line_item_list_params.rb +5 -4
- data/lib/modern_treasury/models/invoices/line_item_retrieve_params.rb +5 -4
- data/lib/modern_treasury/models/invoices/line_item_update_params.rb +13 -12
- data/lib/modern_treasury/models/ledger.rb +7 -6
- data/lib/modern_treasury/models/ledger_account.rb +43 -36
- data/lib/modern_treasury/models/ledger_account_balance_monitor.rb +40 -33
- data/lib/modern_treasury/models/ledger_account_balance_monitor_create_params.rb +14 -13
- data/lib/modern_treasury/models/ledger_account_balance_monitor_delete_params.rb +5 -4
- data/lib/modern_treasury/models/ledger_account_balance_monitor_list_params.rb +10 -9
- data/lib/modern_treasury/models/ledger_account_balance_monitor_retrieve_params.rb +5 -4
- data/lib/modern_treasury/models/ledger_account_balance_monitor_update_params.rb +7 -6
- data/lib/modern_treasury/models/ledger_account_category.rb +33 -28
- data/lib/modern_treasury/models/ledger_account_category_add_ledger_account_params.rb +5 -4
- data/lib/modern_treasury/models/ledger_account_category_add_nested_category_params.rb +5 -4
- data/lib/modern_treasury/models/ledger_account_category_create_params.rb +9 -8
- data/lib/modern_treasury/models/ledger_account_category_delete_params.rb +5 -4
- data/lib/modern_treasury/models/ledger_account_category_list_params.rb +17 -16
- data/lib/modern_treasury/models/ledger_account_category_remove_ledger_account_params.rb +5 -4
- data/lib/modern_treasury/models/ledger_account_category_remove_nested_category_params.rb +5 -4
- data/lib/modern_treasury/models/ledger_account_category_retrieve_params.rb +11 -10
- data/lib/modern_treasury/models/ledger_account_category_update_params.rb +7 -6
- data/lib/modern_treasury/models/ledger_account_create_params.rb +15 -14
- data/lib/modern_treasury/models/ledger_account_delete_params.rb +5 -4
- data/lib/modern_treasury/models/ledger_account_list_params.rb +40 -39
- data/lib/modern_treasury/models/ledger_account_retrieve_params.rb +17 -16
- data/lib/modern_treasury/models/ledger_account_settlement.rb +16 -13
- data/lib/modern_treasury/models/ledger_account_settlement_create_params.rb +19 -18
- data/lib/modern_treasury/models/ledger_account_settlement_list_params.rb +16 -15
- data/lib/modern_treasury/models/ledger_account_settlement_retrieve_params.rb +5 -4
- data/lib/modern_treasury/models/ledger_account_settlement_update_params.rb +10 -9
- data/lib/modern_treasury/models/ledger_account_settlements/account_entry_delete_params.rb +9 -8
- data/lib/modern_treasury/models/ledger_account_settlements/account_entry_update_params.rb +7 -6
- data/lib/modern_treasury/models/ledger_account_statement_create_params.rb +10 -9
- data/lib/modern_treasury/models/ledger_account_statement_create_response.rb +62 -53
- data/lib/modern_treasury/models/ledger_account_statement_retrieve_params.rb +5 -4
- data/lib/modern_treasury/models/ledger_account_statement_retrieve_response.rb +62 -53
- data/lib/modern_treasury/models/ledger_account_update_params.rb +7 -6
- data/lib/modern_treasury/models/ledger_create_params.rb +7 -6
- data/lib/modern_treasury/models/ledger_delete_params.rb +5 -4
- data/lib/modern_treasury/models/ledger_entry.rb +49 -42
- data/lib/modern_treasury/models/ledger_entry_list_params.rb +43 -40
- data/lib/modern_treasury/models/ledger_entry_retrieve_params.rb +7 -6
- data/lib/modern_treasury/models/ledger_entry_update_params.rb +7 -6
- data/lib/modern_treasury/models/ledger_event_handler.rb +21 -15
- data/lib/modern_treasury/models/ledger_event_handler_create_params.rb +16 -15
- data/lib/modern_treasury/models/ledger_event_handler_delete_params.rb +5 -4
- data/lib/modern_treasury/models/ledger_event_handler_list_params.rb +11 -10
- data/lib/modern_treasury/models/ledger_event_handler_retrieve_params.rb +5 -4
- data/lib/modern_treasury/models/ledger_event_handler_variable.rb +7 -5
- data/lib/modern_treasury/models/ledger_list_params.rb +13 -12
- data/lib/modern_treasury/models/ledger_retrieve_params.rb +5 -4
- data/lib/modern_treasury/models/ledger_transaction.rb +26 -20
- data/lib/modern_treasury/models/ledger_transaction_create_params.rb +42 -41
- data/lib/modern_treasury/models/ledger_transaction_create_partial_post_params.rb +26 -23
- data/lib/modern_treasury/models/ledger_transaction_create_reversal_params.rb +17 -16
- data/lib/modern_treasury/models/ledger_transaction_list_params.rb +34 -31
- data/lib/modern_treasury/models/ledger_transaction_retrieve_params.rb +5 -4
- data/lib/modern_treasury/models/ledger_transaction_update_params.rb +40 -39
- data/lib/modern_treasury/models/ledger_transactions/ledger_transaction_version.rb +72 -61
- data/lib/modern_treasury/models/ledger_transactions/version_list_params.rb +12 -11
- data/lib/modern_treasury/models/ledger_update_params.rb +7 -6
- data/lib/modern_treasury/models/ledgerable_event.rb +9 -7
- data/lib/modern_treasury/models/ledgerable_event_create_params.rb +8 -7
- data/lib/modern_treasury/models/ledgerable_event_retrieve_params.rb +5 -4
- data/lib/modern_treasury/models/legal_entity.rb +56 -29
- data/lib/modern_treasury/models/legal_entity_association.rb +61 -35
- data/lib/modern_treasury/models/legal_entity_association_create_params.rb +58 -29
- data/lib/modern_treasury/models/legal_entity_compliance_detail.rb +109 -0
- data/lib/modern_treasury/models/legal_entity_create_params.rb +104 -52
- data/lib/modern_treasury/models/legal_entity_industry_classification.rb +107 -0
- data/lib/modern_treasury/models/legal_entity_list_params.rb +9 -8
- data/lib/modern_treasury/models/legal_entity_retrieve_params.rb +5 -4
- data/lib/modern_treasury/models/legal_entity_update_params.rb +46 -23
- data/lib/modern_treasury/models/line_item.rb +20 -16
- data/lib/modern_treasury/models/line_item_list_params.rb +6 -5
- data/lib/modern_treasury/models/line_item_retrieve_params.rb +6 -5
- data/lib/modern_treasury/models/line_item_update_params.rb +8 -7
- data/lib/modern_treasury/models/paper_item.rb +10 -7
- data/lib/modern_treasury/models/paper_item_list_params.rb +6 -5
- data/lib/modern_treasury/models/paper_item_retrieve_params.rb +5 -4
- data/lib/modern_treasury/models/payment_flow.rb +37 -28
- data/lib/modern_treasury/models/payment_flow_create_params.rb +12 -11
- data/lib/modern_treasury/models/payment_flow_list_params.rb +5 -4
- data/lib/modern_treasury/models/payment_flow_retrieve_params.rb +5 -4
- data/lib/modern_treasury/models/payment_flow_update_params.rb +8 -7
- data/lib/modern_treasury/models/payment_order.rb +121 -97
- data/lib/modern_treasury/models/payment_order_create_async_params.rb +191 -174
- data/lib/modern_treasury/models/payment_order_create_params.rb +200 -182
- data/lib/modern_treasury/models/payment_order_list_params.rb +15 -14
- data/lib/modern_treasury/models/payment_order_retrieve_params.rb +5 -4
- data/lib/modern_treasury/models/payment_order_subtype.rb +4 -4
- data/lib/modern_treasury/models/payment_order_type.rb +3 -3
- data/lib/modern_treasury/models/payment_order_update_params.rb +148 -137
- data/lib/modern_treasury/models/payment_orders/reversal.rb +15 -9
- data/lib/modern_treasury/models/payment_orders/reversal_create_params.rb +61 -54
- data/lib/modern_treasury/models/payment_orders/reversal_list_params.rb +5 -4
- data/lib/modern_treasury/models/payment_orders/reversal_retrieve_params.rb +5 -4
- data/lib/modern_treasury/models/payment_reference.rb +17 -9
- data/lib/modern_treasury/models/payment_reference_list_params.rb +9 -8
- data/lib/modern_treasury/models/payment_reference_retireve_params.rb +5 -4
- data/lib/modern_treasury/models/payment_reference_retrieve_params.rb +5 -4
- data/lib/modern_treasury/models/ping_response.rb +3 -2
- data/lib/modern_treasury/models/reconciliation_rule.rb +15 -11
- data/lib/modern_treasury/models/return_create_params.rb +33 -24
- data/lib/modern_treasury/models/return_list_params.rb +10 -9
- data/lib/modern_treasury/models/return_object.rb +60 -36
- data/lib/modern_treasury/models/return_retrieve_params.rb +5 -4
- data/lib/modern_treasury/models/routing_detail.rb +22 -16
- data/lib/modern_treasury/models/routing_detail_create_params.rb +14 -13
- data/lib/modern_treasury/models/routing_detail_delete_params.rb +6 -5
- data/lib/modern_treasury/models/routing_detail_list_params.rb +5 -4
- data/lib/modern_treasury/models/routing_detail_retrieve_params.rb +5 -4
- data/lib/modern_treasury/models/routing_number_lookup_request.rb +22 -17
- data/lib/modern_treasury/models/transaction.rb +47 -40
- data/lib/modern_treasury/models/transaction_create_params.rb +17 -16
- data/lib/modern_treasury/models/transaction_delete_params.rb +5 -4
- data/lib/modern_treasury/models/transaction_direction.rb +1 -1
- data/lib/modern_treasury/models/transaction_list_params.rb +13 -12
- data/lib/modern_treasury/models/transaction_retrieve_params.rb +5 -4
- data/lib/modern_treasury/models/transaction_update_params.rb +7 -6
- data/lib/modern_treasury/models/transactions/line_item_create_params.rb +6 -5
- data/lib/modern_treasury/models/transactions/line_item_delete_params.rb +5 -4
- data/lib/modern_treasury/models/transactions/line_item_list_params.rb +7 -6
- data/lib/modern_treasury/models/transactions/line_item_retrieve_params.rb +5 -4
- data/lib/modern_treasury/models/transactions/transaction_line_item.rb +23 -18
- data/lib/modern_treasury/models/validation_validate_routing_number_params.rb +12 -11
- data/lib/modern_treasury/models/virtual_account.rb +17 -14
- data/lib/modern_treasury/models/virtual_account_create_params.rb +52 -43
- data/lib/modern_treasury/models/virtual_account_delete_params.rb +5 -4
- data/lib/modern_treasury/models/virtual_account_list_params.rb +8 -7
- data/lib/modern_treasury/models/virtual_account_retrieve_params.rb +5 -4
- data/lib/modern_treasury/models/virtual_account_update_params.rb +6 -5
- data/lib/modern_treasury/models/wealth_and_employment_details.rb +22 -10
- data/lib/modern_treasury/request_options.rb +12 -44
- data/lib/modern_treasury/resources/account_collection_flows.rb +33 -36
- data/lib/modern_treasury/resources/account_details.rb +37 -42
- data/lib/modern_treasury/resources/bulk_requests.rb +27 -34
- data/lib/modern_treasury/resources/bulk_results.rb +20 -25
- data/lib/modern_treasury/resources/connection_legal_entities.rb +32 -33
- data/lib/modern_treasury/resources/connections.rb +11 -11
- data/lib/modern_treasury/resources/counterparties.rb +65 -104
- data/lib/modern_treasury/resources/documents.rb +25 -28
- data/lib/modern_treasury/resources/events.rb +20 -22
- data/lib/modern_treasury/resources/expected_payments.rb +77 -144
- data/lib/modern_treasury/resources/external_accounts.rb +73 -108
- data/lib/modern_treasury/resources/foreign_exchange_quotes.rb +32 -44
- data/lib/modern_treasury/resources/incoming_payment_details.rb +42 -61
- data/lib/modern_treasury/resources/internal_accounts/balance_reports.rb +37 -45
- data/lib/modern_treasury/resources/internal_accounts.rb +46 -65
- data/lib/modern_treasury/resources/invoices/line_items.rb +53 -79
- data/lib/modern_treasury/resources/invoices.rb +93 -194
- data/lib/modern_treasury/resources/ledger_account_balance_monitors.rb +40 -47
- data/lib/modern_treasury/resources/ledger_account_categories.rb +80 -104
- data/lib/modern_treasury/resources/ledger_account_settlements/account_entries.rb +16 -16
- data/lib/modern_treasury/resources/ledger_account_settlements.rb +45 -76
- data/lib/modern_treasury/resources/ledger_account_statements.rb +17 -21
- data/lib/modern_treasury/resources/ledger_accounts.rb +61 -106
- data/lib/modern_treasury/resources/ledger_entries.rb +44 -82
- data/lib/modern_treasury/resources/ledger_event_handlers.rb +35 -44
- data/lib/modern_treasury/resources/ledger_transactions/versions.rb +13 -20
- data/lib/modern_treasury/resources/ledger_transactions.rb +85 -160
- data/lib/modern_treasury/resources/ledgerable_events.rb +16 -16
- data/lib/modern_treasury/resources/ledgers.rb +40 -49
- data/lib/modern_treasury/resources/legal_entities.rb +80 -123
- data/lib/modern_treasury/resources/legal_entity_associations.rb +12 -15
- data/lib/modern_treasury/resources/line_items.rb +29 -33
- data/lib/modern_treasury/resources/paper_items.rb +18 -19
- data/lib/modern_treasury/resources/payment_flows.rb +38 -51
- data/lib/modern_treasury/resources/payment_orders/reversals.rb +27 -33
- data/lib/modern_treasury/resources/payment_orders.rb +154 -430
- data/lib/modern_treasury/resources/payment_references.rb +18 -20
- data/lib/modern_treasury/resources/returns.rb +30 -41
- data/lib/modern_treasury/resources/routing_details.rb +38 -46
- data/lib/modern_treasury/resources/transactions/line_items.rb +31 -32
- data/lib/modern_treasury/resources/transactions.rb +58 -89
- data/lib/modern_treasury/resources/validations.rb +9 -10
- data/lib/modern_treasury/resources/virtual_accounts.rb +49 -68
- data/lib/modern_treasury/version.rb +1 -1
- data/lib/modern_treasury.rb +34 -22
- data/manifest.yaml +1 -0
- data/rbi/lib/modern_treasury/client.rbi +12 -12
- data/rbi/lib/modern_treasury/errors.rbi +120 -121
- data/rbi/lib/modern_treasury/internal/page.rbi +30 -0
- data/rbi/lib/modern_treasury/internal/transport/base_client.rbi +199 -0
- data/rbi/lib/modern_treasury/internal/transport/pooled_net_requester.rbi +60 -0
- data/rbi/lib/modern_treasury/internal/type/array_of.rbi +85 -0
- data/rbi/lib/modern_treasury/internal/type/base_model.rbi +203 -0
- data/rbi/lib/modern_treasury/internal/type/base_page.rbi +36 -0
- data/rbi/lib/modern_treasury/internal/type/boolean.rbi +47 -0
- data/rbi/lib/modern_treasury/internal/type/converter.rbi +120 -0
- data/rbi/lib/modern_treasury/internal/type/enum.rbi +69 -0
- data/rbi/lib/modern_treasury/internal/type/hash_of.rbi +85 -0
- data/rbi/lib/modern_treasury/internal/type/io_like.rbi +46 -0
- data/rbi/lib/modern_treasury/internal/type/request_parameters.rbi +21 -0
- data/rbi/lib/modern_treasury/internal/type/union.rbi +77 -0
- data/rbi/lib/modern_treasury/internal/type/unknown.rbi +40 -0
- data/rbi/lib/modern_treasury/internal/util.rbi +300 -0
- data/rbi/lib/modern_treasury/internal.rbi +12 -0
- data/rbi/lib/modern_treasury/models/account_collection_flow.rbi +18 -24
- data/rbi/lib/modern_treasury/models/account_collection_flow_create_params.rbi +15 -12
- data/rbi/lib/modern_treasury/models/account_collection_flow_list_params.rbi +6 -9
- data/rbi/lib/modern_treasury/models/account_collection_flow_retrieve_params.rbi +6 -8
- data/rbi/lib/modern_treasury/models/account_collection_flow_update_params.rbi +11 -14
- data/rbi/lib/modern_treasury/models/account_detail.rbi +9 -13
- data/rbi/lib/modern_treasury/models/account_detail_create_params.rbi +14 -18
- data/rbi/lib/modern_treasury/models/account_detail_delete_params.rbi +9 -12
- data/rbi/lib/modern_treasury/models/account_detail_list_params.rbi +6 -8
- data/rbi/lib/modern_treasury/models/account_detail_retrieve_params.rbi +6 -8
- data/rbi/lib/modern_treasury/models/accounts_type.rbi +3 -4
- data/rbi/lib/modern_treasury/models/async_response.rbi +3 -5
- data/rbi/lib/modern_treasury/models/bank_settings.rbi +8 -11
- data/rbi/lib/modern_treasury/models/bulk_request.rbi +21 -23
- data/rbi/lib/modern_treasury/models/bulk_request_create_params.rbi +771 -837
- data/rbi/lib/modern_treasury/models/bulk_request_list_params.rbi +23 -25
- data/rbi/lib/modern_treasury/models/bulk_request_retrieve_params.rbi +6 -8
- data/rbi/lib/modern_treasury/models/bulk_result.rbi +48 -49
- data/rbi/lib/modern_treasury/models/bulk_result_list_params.rbi +24 -27
- data/rbi/lib/modern_treasury/models/bulk_result_retrieve_params.rbi +6 -8
- data/rbi/lib/modern_treasury/models/client_ping_params.rbi +6 -8
- data/rbi/lib/modern_treasury/models/connection.rbi +4 -7
- data/rbi/lib/modern_treasury/models/connection_legal_entity.rbi +7 -11
- data/rbi/lib/modern_treasury/models/connection_legal_entity_create_params.rbi +219 -174
- data/rbi/lib/modern_treasury/models/connection_legal_entity_list_params.rbi +9 -13
- data/rbi/lib/modern_treasury/models/connection_legal_entity_retrieve_params.rbi +6 -8
- data/rbi/lib/modern_treasury/models/connection_legal_entity_update_params.rbi +9 -12
- data/rbi/lib/modern_treasury/models/connection_list_params.rbi +12 -7
- data/rbi/lib/modern_treasury/models/counterparty.rbi +45 -61
- data/rbi/lib/modern_treasury/models/counterparty_collect_account_params.rbi +21 -24
- data/rbi/lib/modern_treasury/models/counterparty_collect_account_response.rbi +7 -9
- data/rbi/lib/modern_treasury/models/counterparty_create_params.rbi +334 -299
- data/rbi/lib/modern_treasury/models/counterparty_delete_params.rbi +6 -8
- data/rbi/lib/modern_treasury/models/counterparty_list_params.rbi +10 -13
- data/rbi/lib/modern_treasury/models/counterparty_retrieve_params.rbi +6 -8
- data/rbi/lib/modern_treasury/models/counterparty_update_params.rbi +8 -11
- data/rbi/lib/modern_treasury/models/currency.rbi +3 -4
- data/rbi/lib/modern_treasury/models/document.rbi +21 -30
- data/rbi/lib/modern_treasury/models/document_create_params.rbi +12 -15
- data/rbi/lib/modern_treasury/models/document_list_params.rbi +19 -15
- data/rbi/lib/modern_treasury/models/document_retrieve_params.rbi +6 -8
- data/rbi/lib/modern_treasury/models/event.rbi +15 -5
- data/rbi/lib/modern_treasury/models/event_list_params.rbi +6 -9
- data/rbi/lib/modern_treasury/models/event_retrieve_params.rbi +6 -8
- data/rbi/lib/modern_treasury/models/expected_payment.rbi +30 -35
- data/rbi/lib/modern_treasury/models/expected_payment_create_params.rbi +82 -94
- data/rbi/lib/modern_treasury/models/expected_payment_delete_params.rbi +6 -8
- data/rbi/lib/modern_treasury/models/expected_payment_list_params.rbi +16 -21
- data/rbi/lib/modern_treasury/models/expected_payment_retrieve_params.rbi +6 -8
- data/rbi/lib/modern_treasury/models/expected_payment_type.rbi +5 -5
- data/rbi/lib/modern_treasury/models/expected_payment_update_params.rbi +26 -31
- data/rbi/lib/modern_treasury/models/external_account.rbi +38 -45
- data/rbi/lib/modern_treasury/models/external_account_complete_verification_params.rbi +6 -8
- data/rbi/lib/modern_treasury/models/external_account_create_params.rbi +109 -82
- data/rbi/lib/modern_treasury/models/external_account_delete_params.rbi +6 -8
- data/rbi/lib/modern_treasury/models/external_account_list_params.rbi +8 -11
- data/rbi/lib/modern_treasury/models/external_account_retrieve_params.rbi +6 -8
- data/rbi/lib/modern_treasury/models/external_account_type.rbi +4 -4
- data/rbi/lib/modern_treasury/models/external_account_update_params.rbi +22 -22
- data/rbi/lib/modern_treasury/models/external_account_verify_params.rbi +22 -28
- data/rbi/lib/modern_treasury/models/external_account_verify_response.rbi +22 -26
- data/rbi/lib/modern_treasury/models/foreign_exchange_quote.rbi +30 -20
- data/rbi/lib/modern_treasury/models/foreign_exchange_quote_create_params.rbi +8 -11
- data/rbi/lib/modern_treasury/models/foreign_exchange_quote_list_params.rbi +8 -11
- data/rbi/lib/modern_treasury/models/foreign_exchange_quote_retrieve_params.rbi +6 -8
- data/rbi/lib/modern_treasury/models/incoming_payment_detail.rbi +45 -36
- data/rbi/lib/modern_treasury/models/incoming_payment_detail_create_async_params.rbi +37 -20
- data/rbi/lib/modern_treasury/models/incoming_payment_detail_list_params.rbi +25 -26
- data/rbi/lib/modern_treasury/models/incoming_payment_detail_retrieve_params.rbi +6 -8
- data/rbi/lib/modern_treasury/models/incoming_payment_detail_update_params.rbi +7 -9
- data/rbi/lib/modern_treasury/models/internal_account.rbi +22 -30
- data/rbi/lib/modern_treasury/models/internal_account_create_params.rbi +23 -23
- data/rbi/lib/modern_treasury/models/internal_account_list_params.rbi +11 -15
- data/rbi/lib/modern_treasury/models/internal_account_retrieve_params.rbi +6 -8
- data/rbi/lib/modern_treasury/models/internal_account_update_params.rbi +7 -10
- data/rbi/lib/modern_treasury/models/internal_accounts/balance_report.rbi +38 -34
- data/rbi/lib/modern_treasury/models/internal_accounts/balance_report_create_params.rbi +30 -34
- data/rbi/lib/modern_treasury/models/internal_accounts/balance_report_delete_params.rbi +6 -8
- data/rbi/lib/modern_treasury/models/internal_accounts/balance_report_list_params.rbi +17 -12
- data/rbi/lib/modern_treasury/models/internal_accounts/balance_report_retrieve_params.rbi +6 -8
- data/rbi/lib/modern_treasury/models/invoice.rbi +56 -70
- data/rbi/lib/modern_treasury/models/invoice_add_payment_order_params.rbi +6 -11
- data/rbi/lib/modern_treasury/models/invoice_create_params.rbi +72 -88
- data/rbi/lib/modern_treasury/models/invoice_list_params.rbi +11 -15
- data/rbi/lib/modern_treasury/models/invoice_retrieve_params.rbi +6 -8
- data/rbi/lib/modern_treasury/models/invoice_update_params.rbi +72 -88
- data/rbi/lib/modern_treasury/models/invoices/invoice_line_item.rbi +12 -15
- data/rbi/lib/modern_treasury/models/invoices/line_item_create_params.rbi +13 -16
- data/rbi/lib/modern_treasury/models/invoices/line_item_delete_params.rbi +6 -8
- data/rbi/lib/modern_treasury/models/invoices/line_item_list_params.rbi +6 -8
- data/rbi/lib/modern_treasury/models/invoices/line_item_retrieve_params.rbi +6 -8
- data/rbi/lib/modern_treasury/models/invoices/line_item_update_params.rbi +13 -16
- data/rbi/lib/modern_treasury/models/ledger.rbi +15 -6
- data/rbi/lib/modern_treasury/models/ledger_account.rbi +57 -62
- data/rbi/lib/modern_treasury/models/ledger_account_balance_monitor.rbi +55 -64
- data/rbi/lib/modern_treasury/models/ledger_account_balance_monitor_create_params.rbi +23 -20
- data/rbi/lib/modern_treasury/models/ledger_account_balance_monitor_delete_params.rbi +6 -8
- data/rbi/lib/modern_treasury/models/ledger_account_balance_monitor_list_params.rbi +16 -10
- data/rbi/lib/modern_treasury/models/ledger_account_balance_monitor_retrieve_params.rbi +6 -8
- data/rbi/lib/modern_treasury/models/ledger_account_balance_monitor_update_params.rbi +7 -9
- data/rbi/lib/modern_treasury/models/ledger_account_category.rbi +39 -50
- data/rbi/lib/modern_treasury/models/ledger_account_category_add_ledger_account_params.rbi +6 -11
- data/rbi/lib/modern_treasury/models/ledger_account_category_add_nested_category_params.rbi +6 -11
- data/rbi/lib/modern_treasury/models/ledger_account_category_create_params.rbi +8 -11
- data/rbi/lib/modern_treasury/models/ledger_account_category_delete_params.rbi +6 -8
- data/rbi/lib/modern_treasury/models/ledger_account_category_list_params.rbi +25 -24
- data/rbi/lib/modern_treasury/models/ledger_account_category_remove_ledger_account_params.rbi +6 -11
- data/rbi/lib/modern_treasury/models/ledger_account_category_remove_nested_category_params.rbi +6 -11
- data/rbi/lib/modern_treasury/models/ledger_account_category_retrieve_params.rbi +15 -19
- data/rbi/lib/modern_treasury/models/ledger_account_category_update_params.rbi +7 -9
- data/rbi/lib/modern_treasury/models/ledger_account_create_params.rbi +16 -20
- data/rbi/lib/modern_treasury/models/ledger_account_delete_params.rbi +6 -8
- data/rbi/lib/modern_treasury/models/ledger_account_list_params.rbi +59 -58
- data/rbi/lib/modern_treasury/models/ledger_account_retrieve_params.rbi +21 -26
- data/rbi/lib/modern_treasury/models/ledger_account_settlement.rbi +14 -18
- data/rbi/lib/modern_treasury/models/ledger_account_settlement_create_params.rbi +19 -23
- data/rbi/lib/modern_treasury/models/ledger_account_settlement_list_params.rbi +13 -16
- data/rbi/lib/modern_treasury/models/ledger_account_settlement_retrieve_params.rbi +6 -8
- data/rbi/lib/modern_treasury/models/ledger_account_settlement_update_params.rbi +12 -15
- data/rbi/lib/modern_treasury/models/ledger_account_settlements/account_entry_delete_params.rbi +13 -17
- data/rbi/lib/modern_treasury/models/ledger_account_settlements/account_entry_update_params.rbi +7 -9
- data/rbi/lib/modern_treasury/models/ledger_account_statement_create_params.rbi +10 -13
- data/rbi/lib/modern_treasury/models/ledger_account_statement_create_response.rbi +76 -95
- data/rbi/lib/modern_treasury/models/ledger_account_statement_retrieve_params.rbi +6 -8
- data/rbi/lib/modern_treasury/models/ledger_account_statement_retrieve_response.rbi +76 -95
- data/rbi/lib/modern_treasury/models/ledger_account_update_params.rbi +7 -9
- data/rbi/lib/modern_treasury/models/ledger_create_params.rbi +7 -9
- data/rbi/lib/modern_treasury/models/ledger_delete_params.rbi +6 -8
- data/rbi/lib/modern_treasury/models/ledger_entry.rbi +62 -67
- data/rbi/lib/modern_treasury/models/ledger_entry_list_params.rbi +43 -51
- data/rbi/lib/modern_treasury/models/ledger_entry_retrieve_params.rbi +7 -9
- data/rbi/lib/modern_treasury/models/ledger_entry_update_params.rbi +7 -9
- data/rbi/lib/modern_treasury/models/ledger_event_handler.rbi +28 -33
- data/rbi/lib/modern_treasury/models/ledger_event_handler_create_params.rbi +32 -35
- data/rbi/lib/modern_treasury/models/ledger_event_handler_delete_params.rbi +6 -8
- data/rbi/lib/modern_treasury/models/ledger_event_handler_list_params.rbi +17 -11
- data/rbi/lib/modern_treasury/models/ledger_event_handler_retrieve_params.rbi +6 -8
- data/rbi/lib/modern_treasury/models/ledger_event_handler_variable.rbi +9 -13
- data/rbi/lib/modern_treasury/models/ledger_list_params.rbi +18 -12
- data/rbi/lib/modern_treasury/models/ledger_retrieve_params.rbi +6 -8
- data/rbi/lib/modern_treasury/models/ledger_transaction.rbi +23 -28
- data/rbi/lib/modern_treasury/models/ledger_transaction_create_params.rbi +47 -50
- data/rbi/lib/modern_treasury/models/ledger_transaction_create_partial_post_params.rbi +36 -33
- data/rbi/lib/modern_treasury/models/ledger_transaction_create_reversal_params.rbi +27 -26
- data/rbi/lib/modern_treasury/models/ledger_transaction_list_params.rbi +53 -48
- data/rbi/lib/modern_treasury/models/ledger_transaction_retrieve_params.rbi +6 -8
- data/rbi/lib/modern_treasury/models/ledger_transaction_update_params.rbi +51 -49
- data/rbi/lib/modern_treasury/models/ledger_transactions/ledger_transaction_version.rbi +86 -95
- data/rbi/lib/modern_treasury/models/ledger_transactions/version_list_params.rbi +11 -14
- data/rbi/lib/modern_treasury/models/ledger_update_params.rbi +7 -9
- data/rbi/lib/modern_treasury/models/ledgerable_event.rbi +5 -8
- data/rbi/lib/modern_treasury/models/ledgerable_event_create_params.rbi +7 -9
- data/rbi/lib/modern_treasury/models/ledgerable_event_retrieve_params.rbi +6 -8
- data/rbi/lib/modern_treasury/models/legal_entity.rbi +73 -54
- data/rbi/lib/modern_treasury/models/legal_entity_association.rbi +94 -72
- data/rbi/lib/modern_treasury/models/legal_entity_association_create_params.rbi +110 -87
- data/rbi/lib/modern_treasury/models/legal_entity_compliance_detail.rbi +103 -0
- data/rbi/lib/modern_treasury/models/legal_entity_create_params.rbi +183 -144
- data/rbi/lib/modern_treasury/models/legal_entity_industry_classification.rbi +136 -0
- data/rbi/lib/modern_treasury/models/legal_entity_list_params.rbi +11 -15
- data/rbi/lib/modern_treasury/models/legal_entity_retrieve_params.rbi +6 -8
- data/rbi/lib/modern_treasury/models/legal_entity_update_params.rbi +74 -52
- data/rbi/lib/modern_treasury/models/line_item.rbi +24 -26
- data/rbi/lib/modern_treasury/models/line_item_list_params.rbi +9 -12
- data/rbi/lib/modern_treasury/models/line_item_retrieve_params.rbi +9 -12
- data/rbi/lib/modern_treasury/models/line_item_update_params.rbi +10 -13
- data/rbi/lib/modern_treasury/models/paper_item.rbi +10 -13
- data/rbi/lib/modern_treasury/models/paper_item_list_params.rbi +7 -10
- data/rbi/lib/modern_treasury/models/paper_item_retrieve_params.rbi +6 -8
- data/rbi/lib/modern_treasury/models/payment_flow.rbi +37 -42
- data/rbi/lib/modern_treasury/models/payment_flow_create_params.rbi +15 -19
- data/rbi/lib/modern_treasury/models/payment_flow_list_params.rbi +6 -9
- data/rbi/lib/modern_treasury/models/payment_flow_retrieve_params.rbi +6 -8
- data/rbi/lib/modern_treasury/models/payment_flow_update_params.rbi +11 -14
- data/rbi/lib/modern_treasury/models/payment_order.rbi +162 -132
- data/rbi/lib/modern_treasury/models/payment_order_create_async_params.rbi +243 -267
- data/rbi/lib/modern_treasury/models/payment_order_create_params.rbi +285 -285
- data/rbi/lib/modern_treasury/models/payment_order_list_params.rbi +21 -27
- data/rbi/lib/modern_treasury/models/payment_order_retrieve_params.rbi +6 -8
- data/rbi/lib/modern_treasury/models/payment_order_subtype.rbi +7 -7
- data/rbi/lib/modern_treasury/models/payment_order_type.rbi +5 -6
- data/rbi/lib/modern_treasury/models/payment_order_update_params.rbi +216 -225
- data/rbi/lib/modern_treasury/models/payment_orders/reversal.rbi +11 -16
- data/rbi/lib/modern_treasury/models/payment_orders/reversal_create_params.rbi +63 -72
- data/rbi/lib/modern_treasury/models/payment_orders/reversal_list_params.rbi +6 -8
- data/rbi/lib/modern_treasury/models/payment_orders/reversal_retrieve_params.rbi +6 -8
- data/rbi/lib/modern_treasury/models/payment_reference.rbi +25 -18
- data/rbi/lib/modern_treasury/models/payment_reference_list_params.rbi +12 -16
- data/rbi/lib/modern_treasury/models/payment_reference_retireve_params.rbi +6 -8
- data/rbi/lib/modern_treasury/models/payment_reference_retrieve_params.rbi +6 -8
- data/rbi/lib/modern_treasury/models/ping_response.rbi +3 -5
- data/rbi/lib/modern_treasury/models/reconciliation_rule.rbi +16 -20
- data/rbi/lib/modern_treasury/models/return_create_params.rbi +38 -35
- data/rbi/lib/modern_treasury/models/return_list_params.rbi +13 -17
- data/rbi/lib/modern_treasury/models/return_object.rbi +91 -61
- data/rbi/lib/modern_treasury/models/return_retrieve_params.rbi +6 -8
- data/rbi/lib/modern_treasury/models/routing_detail.rbi +22 -30
- data/rbi/lib/modern_treasury/models/routing_detail_create_params.rbi +27 -25
- data/rbi/lib/modern_treasury/models/routing_detail_delete_params.rbi +9 -12
- data/rbi/lib/modern_treasury/models/routing_detail_list_params.rbi +6 -8
- data/rbi/lib/modern_treasury/models/routing_detail_retrieve_params.rbi +6 -8
- data/rbi/lib/modern_treasury/models/routing_number_lookup_request.rbi +34 -30
- data/rbi/lib/modern_treasury/models/transaction.rbi +56 -48
- data/rbi/lib/modern_treasury/models/transaction_create_params.rbi +18 -22
- data/rbi/lib/modern_treasury/models/transaction_delete_params.rbi +6 -8
- data/rbi/lib/modern_treasury/models/transaction_direction.rbi +4 -4
- data/rbi/lib/modern_treasury/models/transaction_list_params.rbi +12 -15
- data/rbi/lib/modern_treasury/models/transaction_retrieve_params.rbi +6 -8
- data/rbi/lib/modern_treasury/models/transaction_update_params.rbi +7 -9
- data/rbi/lib/modern_treasury/models/transactions/line_item_create_params.rbi +7 -9
- data/rbi/lib/modern_treasury/models/transactions/line_item_delete_params.rbi +6 -8
- data/rbi/lib/modern_treasury/models/transactions/line_item_list_params.rbi +16 -11
- data/rbi/lib/modern_treasury/models/transactions/line_item_retrieve_params.rbi +6 -8
- data/rbi/lib/modern_treasury/models/transactions/transaction_line_item.rbi +27 -26
- data/rbi/lib/modern_treasury/models/validation_validate_routing_number_params.rbi +15 -17
- data/rbi/lib/modern_treasury/models/virtual_account.rbi +13 -16
- data/rbi/lib/modern_treasury/models/virtual_account_create_params.rbi +83 -67
- data/rbi/lib/modern_treasury/models/virtual_account_delete_params.rbi +6 -8
- data/rbi/lib/modern_treasury/models/virtual_account_list_params.rbi +8 -11
- data/rbi/lib/modern_treasury/models/virtual_account_retrieve_params.rbi +6 -8
- data/rbi/lib/modern_treasury/models/virtual_account_update_params.rbi +12 -7
- data/rbi/lib/modern_treasury/models/wealth_and_employment_details.rbi +22 -31
- data/rbi/lib/modern_treasury/request_options.rbi +11 -28
- data/rbi/lib/modern_treasury/resources/account_collection_flows.rbi +12 -20
- data/rbi/lib/modern_treasury/resources/account_details.rbi +12 -20
- data/rbi/lib/modern_treasury/resources/bulk_requests.rbi +25 -31
- data/rbi/lib/modern_treasury/resources/bulk_results.rbi +10 -14
- data/rbi/lib/modern_treasury/resources/connection_legal_entities.rbi +12 -20
- data/rbi/lib/modern_treasury/resources/connections.rbi +5 -7
- data/rbi/lib/modern_treasury/resources/counterparties.rbi +38 -50
- data/rbi/lib/modern_treasury/resources/documents.rbi +12 -18
- data/rbi/lib/modern_treasury/resources/events.rbi +7 -11
- data/rbi/lib/modern_treasury/resources/expected_payments.rbi +47 -57
- data/rbi/lib/modern_treasury/resources/external_accounts.rbi +62 -52
- data/rbi/lib/modern_treasury/resources/foreign_exchange_quotes.rbi +13 -19
- data/rbi/lib/modern_treasury/resources/incoming_payment_details.rbi +25 -29
- data/rbi/lib/modern_treasury/resources/internal_accounts/balance_reports.rbi +39 -27
- data/rbi/lib/modern_treasury/resources/internal_accounts.rbi +20 -25
- data/rbi/lib/modern_treasury/resources/invoices/line_items.rbi +52 -37
- data/rbi/lib/modern_treasury/resources/invoices.rbi +71 -81
- data/rbi/lib/modern_treasury/resources/ledger_account_balance_monitors.rbi +19 -29
- data/rbi/lib/modern_treasury/resources/ledger_account_categories.rbi +37 -52
- data/rbi/lib/modern_treasury/resources/ledger_account_settlements/account_entries.rbi +19 -13
- data/rbi/lib/modern_treasury/resources/ledger_account_settlements.rbi +29 -37
- data/rbi/lib/modern_treasury/resources/ledger_account_statements.rbi +10 -14
- data/rbi/lib/modern_treasury/resources/ledger_accounts.rbi +47 -54
- data/rbi/lib/modern_treasury/resources/ledger_entries.rbi +32 -38
- data/rbi/lib/modern_treasury/resources/ledger_event_handlers.rbi +22 -27
- data/rbi/lib/modern_treasury/resources/ledger_transactions/versions.rbi +17 -12
- data/rbi/lib/modern_treasury/resources/ledger_transactions.rbi +71 -73
- data/rbi/lib/modern_treasury/resources/ledgerable_events.rbi +7 -11
- data/rbi/lib/modern_treasury/resources/ledgers.rbi +20 -30
- data/rbi/lib/modern_treasury/resources/legal_entities.rbi +39 -37
- data/rbi/lib/modern_treasury/resources/legal_entity_associations.rbi +6 -8
- data/rbi/lib/modern_treasury/resources/line_items.rbi +10 -16
- data/rbi/lib/modern_treasury/resources/paper_items.rbi +8 -12
- data/rbi/lib/modern_treasury/resources/payment_flows.rbi +17 -25
- data/rbi/lib/modern_treasury/resources/payment_orders/reversals.rbi +30 -21
- data/rbi/lib/modern_treasury/resources/payment_orders.rbi +201 -198
- data/rbi/lib/modern_treasury/resources/payment_references.rbi +9 -13
- data/rbi/lib/modern_treasury/resources/returns.rbi +19 -22
- data/rbi/lib/modern_treasury/resources/routing_details.rbi +14 -22
- data/rbi/lib/modern_treasury/resources/transactions/line_items.rbi +31 -17
- data/rbi/lib/modern_treasury/resources/transactions.rbi +28 -38
- data/rbi/lib/modern_treasury/resources/validations.rbi +8 -10
- data/rbi/lib/modern_treasury/resources/virtual_accounts.rbi +38 -35
- data/rbi/lib/modern_treasury/version.rbi +1 -1
- data/sig/modern_treasury/client.rbs +2 -2
- data/sig/modern_treasury/errors.rbs +98 -96
- data/sig/modern_treasury/internal/page.rbs +19 -0
- data/sig/modern_treasury/internal/transport/base_client.rbs +110 -0
- data/sig/modern_treasury/internal/transport/pooled_net_requester.rbs +41 -0
- data/sig/modern_treasury/internal/type/array_of.rbs +43 -0
- data/sig/modern_treasury/internal/type/base_model.rbs +86 -0
- data/sig/modern_treasury/internal/type/base_page.rbs +24 -0
- data/sig/modern_treasury/internal/type/boolean.rbs +23 -0
- data/sig/modern_treasury/internal/type/converter.rbs +54 -0
- data/sig/modern_treasury/internal/type/enum.rbs +29 -0
- data/sig/modern_treasury/internal/type/hash_of.rbs +43 -0
- data/sig/modern_treasury/internal/type/io_like.rbs +23 -0
- data/sig/modern_treasury/internal/type/request_parameters.rbs +16 -0
- data/sig/modern_treasury/internal/type/union.rbs +47 -0
- data/sig/modern_treasury/internal/type/unknown.rbs +23 -0
- data/sig/modern_treasury/internal/util.rbs +156 -0
- data/sig/modern_treasury/internal.rbs +5 -0
- data/sig/modern_treasury/models/account_collection_flow.rbs +4 -4
- data/sig/modern_treasury/models/account_collection_flow_create_params.rbs +5 -5
- data/sig/modern_treasury/models/account_collection_flow_list_params.rbs +4 -4
- data/sig/modern_treasury/models/account_collection_flow_retrieve_params.rbs +4 -4
- data/sig/modern_treasury/models/account_collection_flow_update_params.rbs +5 -5
- data/sig/modern_treasury/models/account_detail.rbs +2 -2
- data/sig/modern_treasury/models/account_detail_create_params.rbs +6 -6
- data/sig/modern_treasury/models/account_detail_delete_params.rbs +5 -5
- data/sig/modern_treasury/models/account_detail_list_params.rbs +4 -4
- data/sig/modern_treasury/models/account_detail_retrieve_params.rbs +4 -4
- data/sig/modern_treasury/models/accounts_type.rbs +1 -1
- data/sig/modern_treasury/models/async_response.rbs +1 -1
- data/sig/modern_treasury/models/bank_settings.rbs +1 -1
- data/sig/modern_treasury/models/bulk_request.rbs +13 -6
- data/sig/modern_treasury/models/bulk_request_create_params.rbs +83 -76
- data/sig/modern_treasury/models/bulk_request_list_params.rbs +16 -9
- data/sig/modern_treasury/models/bulk_request_retrieve_params.rbs +4 -4
- data/sig/modern_treasury/models/bulk_result.rbs +13 -9
- data/sig/modern_treasury/models/bulk_result_list_params.rbs +13 -9
- data/sig/modern_treasury/models/bulk_result_retrieve_params.rbs +5 -4
- data/sig/modern_treasury/models/client_ping_params.rbs +5 -4
- data/sig/modern_treasury/models/connection.rbs +1 -1
- data/sig/modern_treasury/models/connection_legal_entity.rbs +2 -2
- data/sig/modern_treasury/models/connection_legal_entity_create_params.rbs +48 -24
- data/sig/modern_treasury/models/connection_legal_entity_list_params.rbs +5 -5
- data/sig/modern_treasury/models/connection_legal_entity_retrieve_params.rbs +4 -4
- data/sig/modern_treasury/models/connection_legal_entity_update_params.rbs +5 -5
- data/sig/modern_treasury/models/connection_list_params.rbs +4 -4
- data/sig/modern_treasury/models/counterparty.rbs +9 -9
- data/sig/modern_treasury/models/counterparty_collect_account_params.rbs +7 -7
- data/sig/modern_treasury/models/counterparty_collect_account_response.rbs +1 -1
- data/sig/modern_treasury/models/counterparty_create_params.rbs +64 -40
- data/sig/modern_treasury/models/counterparty_delete_params.rbs +5 -4
- data/sig/modern_treasury/models/counterparty_list_params.rbs +4 -4
- data/sig/modern_treasury/models/counterparty_retrieve_params.rbs +4 -4
- data/sig/modern_treasury/models/counterparty_update_params.rbs +4 -4
- data/sig/modern_treasury/models/currency.rbs +1 -1
- data/sig/modern_treasury/models/document.rbs +4 -4
- data/sig/modern_treasury/models/document_create_params.rbs +8 -8
- data/sig/modern_treasury/models/document_list_params.rbs +5 -5
- data/sig/modern_treasury/models/document_retrieve_params.rbs +5 -4
- data/sig/modern_treasury/models/event.rbs +1 -1
- data/sig/modern_treasury/models/event_list_params.rbs +4 -4
- data/sig/modern_treasury/models/event_retrieve_params.rbs +5 -4
- data/sig/modern_treasury/models/expected_payment.rbs +4 -4
- data/sig/modern_treasury/models/expected_payment_create_params.rbs +10 -10
- data/sig/modern_treasury/models/expected_payment_delete_params.rbs +4 -4
- data/sig/modern_treasury/models/expected_payment_list_params.rbs +6 -6
- data/sig/modern_treasury/models/expected_payment_retrieve_params.rbs +4 -4
- data/sig/modern_treasury/models/expected_payment_type.rbs +1 -1
- data/sig/modern_treasury/models/expected_payment_update_params.rbs +6 -6
- data/sig/modern_treasury/models/external_account.rbs +7 -7
- data/sig/modern_treasury/models/external_account_complete_verification_params.rbs +5 -4
- data/sig/modern_treasury/models/external_account_create_params.rbs +15 -15
- data/sig/modern_treasury/models/external_account_delete_params.rbs +4 -4
- data/sig/modern_treasury/models/external_account_list_params.rbs +4 -4
- data/sig/modern_treasury/models/external_account_retrieve_params.rbs +4 -4
- data/sig/modern_treasury/models/external_account_type.rbs +1 -1
- data/sig/modern_treasury/models/external_account_update_params.rbs +6 -6
- data/sig/modern_treasury/models/external_account_verify_params.rbs +7 -7
- data/sig/modern_treasury/models/external_account_verify_response.rbs +5 -5
- data/sig/modern_treasury/models/foreign_exchange_quote.rbs +2 -2
- data/sig/modern_treasury/models/foreign_exchange_quote_create_params.rbs +4 -4
- data/sig/modern_treasury/models/foreign_exchange_quote_list_params.rbs +4 -4
- data/sig/modern_treasury/models/foreign_exchange_quote_retrieve_params.rbs +4 -4
- data/sig/modern_treasury/models/incoming_payment_detail.rbs +22 -6
- data/sig/modern_treasury/models/incoming_payment_detail_create_async_params.rbs +27 -7
- data/sig/modern_treasury/models/incoming_payment_detail_list_params.rbs +23 -7
- data/sig/modern_treasury/models/incoming_payment_detail_retrieve_params.rbs +4 -4
- data/sig/modern_treasury/models/incoming_payment_detail_update_params.rbs +5 -4
- data/sig/modern_treasury/models/internal_account.rbs +4 -4
- data/sig/modern_treasury/models/internal_account_create_params.rbs +6 -6
- data/sig/modern_treasury/models/internal_account_list_params.rbs +5 -5
- data/sig/modern_treasury/models/internal_account_retrieve_params.rbs +4 -4
- data/sig/modern_treasury/models/internal_account_update_params.rbs +4 -4
- data/sig/modern_treasury/models/internal_accounts/balance_report.rbs +4 -4
- data/sig/modern_treasury/models/internal_accounts/balance_report_create_params.rbs +7 -7
- data/sig/modern_treasury/models/internal_accounts/balance_report_delete_params.rbs +5 -4
- data/sig/modern_treasury/models/internal_accounts/balance_report_list_params.rbs +5 -5
- data/sig/modern_treasury/models/internal_accounts/balance_report_retrieve_params.rbs +5 -4
- data/sig/modern_treasury/models/invoice.rbs +9 -9
- data/sig/modern_treasury/models/invoice_add_payment_order_params.rbs +4 -4
- data/sig/modern_treasury/models/invoice_create_params.rbs +11 -11
- data/sig/modern_treasury/models/invoice_list_params.rbs +5 -5
- data/sig/modern_treasury/models/invoice_retrieve_params.rbs +5 -4
- data/sig/modern_treasury/models/invoice_update_params.rbs +11 -11
- data/sig/modern_treasury/models/invoices/invoice_line_item.rbs +1 -1
- data/sig/modern_treasury/models/invoices/line_item_create_params.rbs +4 -4
- data/sig/modern_treasury/models/invoices/line_item_delete_params.rbs +5 -4
- data/sig/modern_treasury/models/invoices/line_item_list_params.rbs +4 -4
- data/sig/modern_treasury/models/invoices/line_item_retrieve_params.rbs +5 -4
- data/sig/modern_treasury/models/invoices/line_item_update_params.rbs +4 -4
- data/sig/modern_treasury/models/ledger.rbs +1 -1
- data/sig/modern_treasury/models/ledger_account.rbs +6 -6
- data/sig/modern_treasury/models/ledger_account_balance_monitor.rbs +7 -7
- data/sig/modern_treasury/models/ledger_account_balance_monitor_create_params.rbs +5 -5
- data/sig/modern_treasury/models/ledger_account_balance_monitor_delete_params.rbs +4 -4
- data/sig/modern_treasury/models/ledger_account_balance_monitor_list_params.rbs +4 -4
- data/sig/modern_treasury/models/ledger_account_balance_monitor_retrieve_params.rbs +4 -4
- data/sig/modern_treasury/models/ledger_account_balance_monitor_update_params.rbs +4 -4
- data/sig/modern_treasury/models/ledger_account_category.rbs +5 -5
- data/sig/modern_treasury/models/ledger_account_category_add_ledger_account_params.rbs +4 -4
- data/sig/modern_treasury/models/ledger_account_category_add_nested_category_params.rbs +4 -4
- data/sig/modern_treasury/models/ledger_account_category_create_params.rbs +4 -4
- data/sig/modern_treasury/models/ledger_account_category_delete_params.rbs +4 -4
- data/sig/modern_treasury/models/ledger_account_category_list_params.rbs +5 -5
- data/sig/modern_treasury/models/ledger_account_category_remove_ledger_account_params.rbs +4 -4
- data/sig/modern_treasury/models/ledger_account_category_remove_nested_category_params.rbs +4 -4
- data/sig/modern_treasury/models/ledger_account_category_retrieve_params.rbs +5 -5
- data/sig/modern_treasury/models/ledger_account_category_update_params.rbs +4 -4
- data/sig/modern_treasury/models/ledger_account_create_params.rbs +5 -5
- data/sig/modern_treasury/models/ledger_account_delete_params.rbs +4 -4
- data/sig/modern_treasury/models/ledger_account_list_params.rbs +8 -8
- data/sig/modern_treasury/models/ledger_account_retrieve_params.rbs +5 -5
- data/sig/modern_treasury/models/ledger_account_settlement.rbs +2 -2
- data/sig/modern_treasury/models/ledger_account_settlement_create_params.rbs +5 -5
- data/sig/modern_treasury/models/ledger_account_settlement_list_params.rbs +4 -4
- data/sig/modern_treasury/models/ledger_account_settlement_retrieve_params.rbs +4 -4
- data/sig/modern_treasury/models/ledger_account_settlement_update_params.rbs +5 -5
- data/sig/modern_treasury/models/ledger_account_settlements/account_entry_delete_params.rbs +7 -6
- data/sig/modern_treasury/models/ledger_account_settlements/account_entry_update_params.rbs +4 -4
- data/sig/modern_treasury/models/ledger_account_statement_create_params.rbs +4 -4
- data/sig/modern_treasury/models/ledger_account_statement_create_response.rbs +9 -9
- data/sig/modern_treasury/models/ledger_account_statement_retrieve_params.rbs +4 -4
- data/sig/modern_treasury/models/ledger_account_statement_retrieve_response.rbs +9 -9
- data/sig/modern_treasury/models/ledger_account_update_params.rbs +4 -4
- data/sig/modern_treasury/models/ledger_create_params.rbs +4 -4
- data/sig/modern_treasury/models/ledger_delete_params.rbs +5 -4
- data/sig/modern_treasury/models/ledger_entry.rbs +6 -6
- data/sig/modern_treasury/models/ledger_entry_list_params.rbs +8 -8
- data/sig/modern_treasury/models/ledger_entry_retrieve_params.rbs +5 -4
- data/sig/modern_treasury/models/ledger_entry_update_params.rbs +5 -4
- data/sig/modern_treasury/models/ledger_event_handler.rbs +4 -4
- data/sig/modern_treasury/models/ledger_event_handler_create_params.rbs +7 -7
- data/sig/modern_treasury/models/ledger_event_handler_delete_params.rbs +4 -4
- data/sig/modern_treasury/models/ledger_event_handler_list_params.rbs +4 -4
- data/sig/modern_treasury/models/ledger_event_handler_retrieve_params.rbs +4 -4
- data/sig/modern_treasury/models/ledger_event_handler_variable.rbs +2 -2
- data/sig/modern_treasury/models/ledger_list_params.rbs +4 -4
- data/sig/modern_treasury/models/ledger_retrieve_params.rbs +5 -4
- data/sig/modern_treasury/models/ledger_transaction.rbs +3 -3
- data/sig/modern_treasury/models/ledger_transaction_create_params.rbs +7 -7
- data/sig/modern_treasury/models/ledger_transaction_create_partial_post_params.rbs +6 -6
- data/sig/modern_treasury/models/ledger_transaction_create_reversal_params.rbs +6 -6
- data/sig/modern_treasury/models/ledger_transaction_list_params.rbs +9 -9
- data/sig/modern_treasury/models/ledger_transaction_retrieve_params.rbs +4 -4
- data/sig/modern_treasury/models/ledger_transaction_update_params.rbs +7 -7
- data/sig/modern_treasury/models/ledger_transactions/ledger_transaction_version.rbs +9 -9
- data/sig/modern_treasury/models/ledger_transactions/version_list_params.rbs +4 -4
- data/sig/modern_treasury/models/ledger_update_params.rbs +4 -4
- data/sig/modern_treasury/models/ledgerable_event.rbs +1 -1
- data/sig/modern_treasury/models/ledgerable_event_create_params.rbs +4 -4
- data/sig/modern_treasury/models/ledgerable_event_retrieve_params.rbs +4 -4
- data/sig/modern_treasury/models/legal_entity.rbs +17 -9
- data/sig/modern_treasury/models/legal_entity_association.rbs +19 -11
- data/sig/modern_treasury/models/legal_entity_association_create_params.rbs +26 -14
- data/sig/modern_treasury/models/legal_entity_compliance_detail.rbs +62 -0
- data/sig/modern_treasury/models/legal_entity_create_params.rbs +47 -23
- data/sig/modern_treasury/models/legal_entity_industry_classification.rbs +85 -0
- data/sig/modern_treasury/models/legal_entity_list_params.rbs +5 -5
- data/sig/modern_treasury/models/legal_entity_retrieve_params.rbs +4 -4
- data/sig/modern_treasury/models/legal_entity_update_params.rbs +23 -11
- data/sig/modern_treasury/models/line_item.rbs +3 -3
- data/sig/modern_treasury/models/line_item_list_params.rbs +5 -5
- data/sig/modern_treasury/models/line_item_retrieve_params.rbs +5 -5
- data/sig/modern_treasury/models/line_item_update_params.rbs +5 -5
- data/sig/modern_treasury/models/paper_item.rbs +2 -2
- data/sig/modern_treasury/models/paper_item_list_params.rbs +4 -4
- data/sig/modern_treasury/models/paper_item_retrieve_params.rbs +5 -4
- data/sig/modern_treasury/models/payment_flow.rbs +5 -5
- data/sig/modern_treasury/models/payment_flow_create_params.rbs +5 -5
- data/sig/modern_treasury/models/payment_flow_list_params.rbs +4 -4
- data/sig/modern_treasury/models/payment_flow_retrieve_params.rbs +4 -4
- data/sig/modern_treasury/models/payment_flow_update_params.rbs +5 -5
- data/sig/modern_treasury/models/payment_order.rbs +19 -13
- data/sig/modern_treasury/models/payment_order_create_async_params.rbs +27 -27
- data/sig/modern_treasury/models/payment_order_create_params.rbs +32 -32
- data/sig/modern_treasury/models/payment_order_list_params.rbs +7 -7
- data/sig/modern_treasury/models/payment_order_retrieve_params.rbs +4 -4
- data/sig/modern_treasury/models/payment_order_subtype.rbs +1 -1
- data/sig/modern_treasury/models/payment_order_type.rbs +1 -1
- data/sig/modern_treasury/models/payment_order_update_params.rbs +24 -24
- data/sig/modern_treasury/models/payment_orders/reversal.rbs +3 -3
- data/sig/modern_treasury/models/payment_orders/reversal_create_params.rbs +9 -9
- data/sig/modern_treasury/models/payment_orders/reversal_list_params.rbs +4 -4
- data/sig/modern_treasury/models/payment_orders/reversal_retrieve_params.rbs +5 -4
- data/sig/modern_treasury/models/payment_reference.rbs +9 -3
- data/sig/modern_treasury/models/payment_reference_list_params.rbs +5 -5
- data/sig/modern_treasury/models/payment_reference_retireve_params.rbs +4 -4
- data/sig/modern_treasury/models/payment_reference_retrieve_params.rbs +4 -4
- data/sig/modern_treasury/models/ping_response.rbs +1 -1
- data/sig/modern_treasury/models/reconciliation_rule.rbs +3 -3
- data/sig/modern_treasury/models/return_create_params.rbs +23 -19
- data/sig/modern_treasury/models/return_list_params.rbs +5 -5
- data/sig/modern_treasury/models/return_object.rbs +33 -23
- data/sig/modern_treasury/models/return_retrieve_params.rbs +5 -4
- data/sig/modern_treasury/models/routing_detail.rbs +4 -4
- data/sig/modern_treasury/models/routing_detail_create_params.rbs +7 -7
- data/sig/modern_treasury/models/routing_detail_delete_params.rbs +5 -5
- data/sig/modern_treasury/models/routing_detail_list_params.rbs +4 -4
- data/sig/modern_treasury/models/routing_detail_retrieve_params.rbs +4 -4
- data/sig/modern_treasury/models/routing_number_lookup_request.rbs +6 -4
- data/sig/modern_treasury/models/transaction.rbs +6 -4
- data/sig/modern_treasury/models/transaction_create_params.rbs +5 -5
- data/sig/modern_treasury/models/transaction_delete_params.rbs +5 -4
- data/sig/modern_treasury/models/transaction_direction.rbs +1 -1
- data/sig/modern_treasury/models/transaction_list_params.rbs +4 -4
- data/sig/modern_treasury/models/transaction_retrieve_params.rbs +5 -4
- data/sig/modern_treasury/models/transaction_update_params.rbs +5 -4
- data/sig/modern_treasury/models/transactions/line_item_create_params.rbs +4 -4
- data/sig/modern_treasury/models/transactions/line_item_delete_params.rbs +5 -4
- data/sig/modern_treasury/models/transactions/line_item_list_params.rbs +5 -5
- data/sig/modern_treasury/models/transactions/line_item_retrieve_params.rbs +5 -4
- data/sig/modern_treasury/models/transactions/transaction_line_item.rbs +3 -3
- data/sig/modern_treasury/models/validation_validate_routing_number_params.rbs +5 -5
- data/sig/modern_treasury/models/virtual_account.rbs +1 -1
- data/sig/modern_treasury/models/virtual_account_create_params.rbs +11 -11
- data/sig/modern_treasury/models/virtual_account_delete_params.rbs +4 -4
- data/sig/modern_treasury/models/virtual_account_list_params.rbs +4 -4
- data/sig/modern_treasury/models/virtual_account_retrieve_params.rbs +4 -4
- data/sig/modern_treasury/models/virtual_account_update_params.rbs +4 -4
- data/sig/modern_treasury/models/wealth_and_employment_details.rbs +7 -7
- data/sig/modern_treasury/request_options.rbs +1 -11
- data/sig/modern_treasury/resources/account_collection_flows.rbs +1 -1
- data/sig/modern_treasury/resources/account_details.rbs +1 -1
- data/sig/modern_treasury/resources/bulk_requests.rbs +1 -1
- data/sig/modern_treasury/resources/bulk_results.rbs +1 -1
- data/sig/modern_treasury/resources/connection_legal_entities.rbs +1 -1
- data/sig/modern_treasury/resources/connections.rbs +1 -1
- data/sig/modern_treasury/resources/counterparties.rbs +1 -1
- data/sig/modern_treasury/resources/documents.rbs +2 -2
- data/sig/modern_treasury/resources/events.rbs +1 -1
- data/sig/modern_treasury/resources/expected_payments.rbs +1 -1
- data/sig/modern_treasury/resources/external_accounts.rbs +1 -1
- data/sig/modern_treasury/resources/foreign_exchange_quotes.rbs +1 -1
- data/sig/modern_treasury/resources/incoming_payment_details.rbs +2 -1
- data/sig/modern_treasury/resources/internal_accounts/balance_reports.rbs +1 -1
- data/sig/modern_treasury/resources/internal_accounts.rbs +1 -1
- data/sig/modern_treasury/resources/invoices/line_items.rbs +1 -1
- data/sig/modern_treasury/resources/invoices.rbs +1 -1
- data/sig/modern_treasury/resources/ledger_account_balance_monitors.rbs +1 -1
- data/sig/modern_treasury/resources/ledger_account_categories.rbs +1 -1
- data/sig/modern_treasury/resources/ledger_account_settlements/account_entries.rbs +1 -1
- data/sig/modern_treasury/resources/ledger_account_settlements.rbs +1 -1
- data/sig/modern_treasury/resources/ledger_accounts.rbs +1 -1
- data/sig/modern_treasury/resources/ledger_entries.rbs +1 -1
- data/sig/modern_treasury/resources/ledger_event_handlers.rbs +1 -1
- data/sig/modern_treasury/resources/ledger_transactions/versions.rbs +1 -1
- data/sig/modern_treasury/resources/ledger_transactions.rbs +1 -1
- data/sig/modern_treasury/resources/ledgers.rbs +1 -1
- data/sig/modern_treasury/resources/legal_entities.rbs +5 -1
- data/sig/modern_treasury/resources/line_items.rbs +1 -1
- data/sig/modern_treasury/resources/paper_items.rbs +1 -1
- data/sig/modern_treasury/resources/payment_flows.rbs +1 -1
- data/sig/modern_treasury/resources/payment_orders/reversals.rbs +1 -1
- data/sig/modern_treasury/resources/payment_orders.rbs +1 -1
- data/sig/modern_treasury/resources/payment_references.rbs +1 -1
- data/sig/modern_treasury/resources/returns.rbs +2 -1
- data/sig/modern_treasury/resources/routing_details.rbs +1 -1
- data/sig/modern_treasury/resources/transactions/line_items.rbs +1 -1
- data/sig/modern_treasury/resources/transactions.rbs +1 -1
- data/sig/modern_treasury/resources/virtual_accounts.rbs +1 -1
- data/sig/modern_treasury/version.rbs +1 -1
- metadata +59 -23
- data/lib/modern_treasury/base_client.rb +0 -457
- data/lib/modern_treasury/base_model.rb +0 -1211
- data/lib/modern_treasury/base_page.rb +0 -59
- data/lib/modern_treasury/extern.rb +0 -7
- data/lib/modern_treasury/page.rb +0 -92
- data/lib/modern_treasury/pooled_net_requester.rb +0 -180
- data/lib/modern_treasury/util.rb +0 -728
- data/rbi/lib/modern_treasury/base_client.rbi +0 -197
- data/rbi/lib/modern_treasury/base_model.rbi +0 -645
- data/rbi/lib/modern_treasury/base_page.rbi +0 -36
- data/rbi/lib/modern_treasury/extern.rbi +0 -7
- data/rbi/lib/modern_treasury/page.rbi +0 -31
- data/rbi/lib/modern_treasury/pooled_net_requester.rbi +0 -62
- data/rbi/lib/modern_treasury/util.rbi +0 -281
- data/sig/modern_treasury/base_client.rbs +0 -108
- data/sig/modern_treasury/base_model.rbs +0 -262
- data/sig/modern_treasury/base_page.rbs +0 -20
- data/sig/modern_treasury/extern.rbs +0 -4
- data/sig/modern_treasury/page.rbs +0 -17
- data/sig/modern_treasury/pooled_net_requester.rbs +0 -37
- data/sig/modern_treasury/util.rbs +0 -136
@@ -2,10 +2,11 @@
|
|
2
2
|
|
3
3
|
module ModernTreasury
|
4
4
|
module Models
|
5
|
-
|
5
|
+
# @see ModernTreasury::Resources::BulkRequests#create
|
6
|
+
class BulkRequestCreateParams < ModernTreasury::Internal::Type::BaseModel
|
6
7
|
# @!parse
|
7
|
-
# extend ModernTreasury::RequestParameters::Converter
|
8
|
-
include ModernTreasury::RequestParameters
|
8
|
+
# extend ModernTreasury::Internal::Type::RequestParameters::Converter
|
9
|
+
include ModernTreasury::Internal::Type::RequestParameters
|
9
10
|
|
10
11
|
# @!attribute action_type
|
11
12
|
# One of create, or update.
|
@@ -21,18 +22,18 @@ module ModernTreasury
|
|
21
22
|
|
22
23
|
# @!attribute resources
|
23
24
|
# An array of objects where each object contains the input params for a single
|
24
|
-
#
|
25
|
+
# `action_type` request on a `resource_type` resource
|
25
26
|
#
|
26
27
|
# @return [Array<ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::TransactionCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::ID, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::TransactionUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionUpdateRequestWithID>]
|
27
28
|
required :resources,
|
28
|
-
-> { ModernTreasury::ArrayOf[union: ModernTreasury::Models::BulkRequestCreateParams::Resource] }
|
29
|
+
-> { ModernTreasury::Internal::Type::ArrayOf[union: ModernTreasury::Models::BulkRequestCreateParams::Resource] }
|
29
30
|
|
30
31
|
# @!attribute [r] metadata
|
31
32
|
# Additional data represented as key-value pairs. Both the key and value must be
|
32
|
-
#
|
33
|
+
# strings.
|
33
34
|
#
|
34
35
|
# @return [Hash{Symbol=>String}, nil]
|
35
|
-
optional :metadata, ModernTreasury::HashOf[String]
|
36
|
+
optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
|
36
37
|
|
37
38
|
# @!parse
|
38
39
|
# # @return [Hash{Symbol=>String}]
|
@@ -47,11 +48,11 @@ module ModernTreasury
|
|
47
48
|
# #
|
48
49
|
# def initialize(action_type:, resource_type:, resources:, metadata: nil, request_options: {}, **) = super
|
49
50
|
|
50
|
-
# def initialize: (Hash | ModernTreasury::BaseModel) -> void
|
51
|
+
# def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
|
51
52
|
|
52
53
|
# One of create, or update.
|
53
54
|
module ActionType
|
54
|
-
extend ModernTreasury::Enum
|
55
|
+
extend ModernTreasury::Internal::Type::Enum
|
55
56
|
|
56
57
|
CREATE = :create
|
57
58
|
UPDATE = :update
|
@@ -66,12 +67,14 @@ module ModernTreasury
|
|
66
67
|
|
67
68
|
# One of payment_order, expected_payment, or ledger_transaction.
|
68
69
|
module ResourceType
|
69
|
-
extend ModernTreasury::Enum
|
70
|
+
extend ModernTreasury::Internal::Type::Enum
|
70
71
|
|
71
72
|
PAYMENT_ORDER = :payment_order
|
73
|
+
LEDGER_ACCOUNT = :ledger_account
|
72
74
|
LEDGER_TRANSACTION = :ledger_transaction
|
73
|
-
TRANSACTION = :transaction
|
74
75
|
EXPECTED_PAYMENT = :expected_payment
|
76
|
+
TRANSACTION = :transaction
|
77
|
+
ENTITY_LINK = :entity_link
|
75
78
|
|
76
79
|
finalize!
|
77
80
|
|
@@ -81,7 +84,7 @@ module ModernTreasury
|
|
81
84
|
end
|
82
85
|
|
83
86
|
module Resource
|
84
|
-
extend ModernTreasury::Union
|
87
|
+
extend ModernTreasury::Internal::Type::Union
|
85
88
|
|
86
89
|
variant -> { ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest }
|
87
90
|
|
@@ -101,19 +104,19 @@ module ModernTreasury
|
|
101
104
|
|
102
105
|
variant -> { ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionUpdateRequestWithID }
|
103
106
|
|
104
|
-
class PaymentOrderAsyncCreateRequest < ModernTreasury::BaseModel
|
107
|
+
class PaymentOrderAsyncCreateRequest < ModernTreasury::Internal::Type::BaseModel
|
105
108
|
# @!attribute amount
|
106
109
|
# Value in specified currency's smallest unit. e.g. $10 would be represented as
|
107
|
-
#
|
110
|
+
# 1000 (cents). For RTP, the maximum amount allowed by the network is $100,000.
|
108
111
|
#
|
109
112
|
# @return [Integer]
|
110
113
|
required :amount, Integer
|
111
114
|
|
112
115
|
# @!attribute direction
|
113
116
|
# One of `credit`, `debit`. Describes the direction money is flowing in the
|
114
|
-
#
|
115
|
-
#
|
116
|
-
#
|
117
|
+
# transaction. A `credit` moves money from your account to someone else's. A
|
118
|
+
# `debit` pulls money from someone else's account to your own. Note that wire,
|
119
|
+
# rtp, and check payments will always be `credit`.
|
117
120
|
#
|
118
121
|
# @return [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::Direction]
|
119
122
|
required :direction,
|
@@ -127,8 +130,8 @@ module ModernTreasury
|
|
127
130
|
|
128
131
|
# @!attribute type
|
129
132
|
# One of `ach`, `se_bankgirot`, `eft`, `wire`, `check`, `sen`, `book`, `rtp`,
|
130
|
-
#
|
131
|
-
#
|
133
|
+
# `sepa`, `bacs`, `au_becs`, `interac`, `neft`, `nics`,
|
134
|
+
# `nz_national_clearing_code`, `sic`, `signet`, `provexchange`, `zengin`.
|
132
135
|
#
|
133
136
|
# @return [Symbol, ModernTreasury::Models::PaymentOrderType]
|
134
137
|
required :type, enum: -> { ModernTreasury::Models::PaymentOrderType }
|
@@ -145,22 +148,22 @@ module ModernTreasury
|
|
145
148
|
|
146
149
|
# @!attribute accounting_category_id
|
147
150
|
# The ID of one of your accounting categories. Note that these will only be
|
148
|
-
#
|
151
|
+
# accessible if your accounting system has been connected.
|
149
152
|
#
|
150
153
|
# @return [String, nil]
|
151
154
|
optional :accounting_category_id, String, nil?: true
|
152
155
|
|
153
156
|
# @!attribute accounting_ledger_class_id
|
154
157
|
# The ID of one of your accounting ledger classes. Note that these will only be
|
155
|
-
#
|
158
|
+
# accessible if your accounting system has been connected.
|
156
159
|
#
|
157
160
|
# @return [String, nil]
|
158
161
|
optional :accounting_ledger_class_id, String, nil?: true
|
159
162
|
|
160
163
|
# @!attribute charge_bearer
|
161
164
|
# The party that will pay the fees for the payment order. Only applies to wire
|
162
|
-
#
|
163
|
-
#
|
165
|
+
# payment orders. Can be one of shared, sender, or receiver, which correspond
|
166
|
+
# respectively with the SWIFT 71A values `SHA`, `OUR`, `BEN`.
|
164
167
|
#
|
165
168
|
# @return [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::ChargeBearer, nil]
|
166
169
|
optional :charge_bearer,
|
@@ -185,8 +188,8 @@ module ModernTreasury
|
|
185
188
|
|
186
189
|
# @!attribute [r] effective_date
|
187
190
|
# Date transactions are to be posted to the participants' account. Defaults to the
|
188
|
-
#
|
189
|
-
#
|
191
|
+
# current business day or the next business day if the current day is a bank
|
192
|
+
# holiday or weekend. Format: yyyy-mm-dd.
|
190
193
|
#
|
191
194
|
# @return [Date, nil]
|
192
195
|
optional :effective_date, Date
|
@@ -203,8 +206,8 @@ module ModernTreasury
|
|
203
206
|
|
204
207
|
# @!attribute [r] fallback_type
|
205
208
|
# A payment type to fallback to if the original type is not valid for the
|
206
|
-
#
|
207
|
-
#
|
209
|
+
# receiving account. Currently, this only supports falling back from RTP to ACH
|
210
|
+
# (type=rtp and fallback_type=ach)
|
208
211
|
#
|
209
212
|
# @return [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::FallbackType, nil]
|
210
213
|
optional :fallback_type,
|
@@ -216,15 +219,15 @@ module ModernTreasury
|
|
216
219
|
|
217
220
|
# @!attribute foreign_exchange_contract
|
218
221
|
# If present, indicates a specific foreign exchange contract number that has been
|
219
|
-
#
|
222
|
+
# generated by your financial institution.
|
220
223
|
#
|
221
224
|
# @return [String, nil]
|
222
225
|
optional :foreign_exchange_contract, String, nil?: true
|
223
226
|
|
224
227
|
# @!attribute foreign_exchange_indicator
|
225
228
|
# Indicates the type of FX transfer to initiate, can be either
|
226
|
-
#
|
227
|
-
#
|
229
|
+
# `variable_to_fixed`, `fixed_to_variable`, or `null` if the payment order
|
230
|
+
# currency matches the originating account currency.
|
228
231
|
#
|
229
232
|
# @return [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::ForeignExchangeIndicator, nil]
|
230
233
|
optional :foreign_exchange_indicator,
|
@@ -233,9 +236,9 @@ module ModernTreasury
|
|
233
236
|
|
234
237
|
# @!attribute [r] ledger_transaction
|
235
238
|
# Specifies a ledger transaction object that will be created with the payment
|
236
|
-
#
|
237
|
-
#
|
238
|
-
#
|
239
|
+
# order. If the ledger transaction cannot be created, then the payment order
|
240
|
+
# creation will fail. The resulting ledger transaction will mirror the status of
|
241
|
+
# the payment order.
|
239
242
|
#
|
240
243
|
# @return [ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::LedgerTransaction, nil]
|
241
244
|
optional :ledger_transaction,
|
@@ -247,9 +250,9 @@ module ModernTreasury
|
|
247
250
|
|
248
251
|
# @!attribute [r] ledger_transaction_id
|
249
252
|
# Either ledger_transaction or ledger_transaction_id can be provided. Only a
|
250
|
-
#
|
251
|
-
#
|
252
|
-
#
|
253
|
+
# pending ledger transaction can be attached upon payment order creation. Once the
|
254
|
+
# payment order is created, the status of the ledger transaction tracks the
|
255
|
+
# payment order automatically.
|
253
256
|
#
|
254
257
|
# @return [String, nil]
|
255
258
|
optional :ledger_transaction_id, String
|
@@ -263,7 +266,7 @@ module ModernTreasury
|
|
263
266
|
#
|
264
267
|
# @return [Array<ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::LineItem>, nil]
|
265
268
|
optional :line_items,
|
266
|
-
-> { ModernTreasury::ArrayOf[ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::LineItem] }
|
269
|
+
-> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::LineItem] }
|
267
270
|
|
268
271
|
# @!parse
|
269
272
|
# # @return [Array<ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::LineItem>]
|
@@ -271,10 +274,10 @@ module ModernTreasury
|
|
271
274
|
|
272
275
|
# @!attribute [r] metadata
|
273
276
|
# Additional data represented as key-value pairs. Both the key and value must be
|
274
|
-
#
|
277
|
+
# strings.
|
275
278
|
#
|
276
279
|
# @return [Hash{Symbol=>String}, nil]
|
277
|
-
optional :metadata, ModernTreasury::HashOf[String]
|
280
|
+
optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
|
278
281
|
|
279
282
|
# @!parse
|
280
283
|
# # @return [Hash{Symbol=>String}]
|
@@ -282,10 +285,10 @@ module ModernTreasury
|
|
282
285
|
|
283
286
|
# @!attribute [r] nsf_protected
|
284
287
|
# A boolean to determine if NSF Protection is enabled for this payment order. Note
|
285
|
-
#
|
288
|
+
# that this setting must also be turned on in your organization settings page.
|
286
289
|
#
|
287
290
|
# @return [Boolean, nil]
|
288
|
-
optional :nsf_protected, ModernTreasury::
|
291
|
+
optional :nsf_protected, ModernTreasury::Internal::Type::Boolean
|
289
292
|
|
290
293
|
# @!parse
|
291
294
|
# # @return [Boolean]
|
@@ -293,17 +296,17 @@ module ModernTreasury
|
|
293
296
|
|
294
297
|
# @!attribute originating_party_name
|
295
298
|
# If present, this will replace your default company name on receiver's bank
|
296
|
-
#
|
297
|
-
#
|
298
|
-
#
|
299
|
+
# statement. This field can only be used for ACH payments currently. For ACH, only
|
300
|
+
# the first 16 characters of this string will be used. Any additional characters
|
301
|
+
# will be truncated.
|
299
302
|
#
|
300
303
|
# @return [String, nil]
|
301
304
|
optional :originating_party_name, String, nil?: true
|
302
305
|
|
303
306
|
# @!attribute [r] priority
|
304
307
|
# Either `normal` or `high`. For ACH and EFT payments, `high` represents a
|
305
|
-
#
|
306
|
-
#
|
308
|
+
# same-day ACH or EFT transfer, respectively. For check payments, `high` can mean
|
309
|
+
# an overnight check rather than standard mail.
|
307
310
|
#
|
308
311
|
# @return [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::Priority, nil]
|
309
312
|
optional :priority,
|
@@ -315,26 +318,26 @@ module ModernTreasury
|
|
315
318
|
|
316
319
|
# @!attribute process_after
|
317
320
|
# If present, Modern Treasury will not process the payment until after this time.
|
318
|
-
#
|
319
|
-
#
|
320
|
-
#
|
321
|
-
#
|
321
|
+
# If `process_after` is past the cutoff for `effective_date`, `process_after` will
|
322
|
+
# take precedence and `effective_date` will automatically update to reflect the
|
323
|
+
# earliest possible sending date after `process_after`. Format is ISO8601
|
324
|
+
# timestamp.
|
322
325
|
#
|
323
326
|
# @return [Time, nil]
|
324
327
|
optional :process_after, Time, nil?: true
|
325
328
|
|
326
329
|
# @!attribute purpose
|
327
330
|
# For `wire`, this is usually the purpose which is transmitted via the
|
328
|
-
#
|
329
|
-
#
|
331
|
+
# "InstrForDbtrAgt" field in the ISO20022 file. For `eft`, this field is the 3
|
332
|
+
# digit CPA Code that will be attached to the payment.
|
330
333
|
#
|
331
334
|
# @return [String, nil]
|
332
335
|
optional :purpose, String, nil?: true
|
333
336
|
|
334
337
|
# @!attribute [r] receiving_account
|
335
338
|
# Either `receiving_account` or `receiving_account_id` must be present. When using
|
336
|
-
#
|
337
|
-
#
|
339
|
+
# `receiving_account_id`, you may pass the id of an external account or an
|
340
|
+
# internal account.
|
338
341
|
#
|
339
342
|
# @return [ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::ReceivingAccount, nil]
|
340
343
|
optional :receiving_account,
|
@@ -346,8 +349,8 @@ module ModernTreasury
|
|
346
349
|
|
347
350
|
# @!attribute [r] receiving_account_id
|
348
351
|
# Either `receiving_account` or `receiving_account_id` must be present. When using
|
349
|
-
#
|
350
|
-
#
|
352
|
+
# `receiving_account_id`, you may pass the id of an external account or an
|
353
|
+
# internal account.
|
351
354
|
#
|
352
355
|
# @return [String, nil]
|
353
356
|
optional :receiving_account_id, String
|
@@ -358,45 +361,45 @@ module ModernTreasury
|
|
358
361
|
|
359
362
|
# @!attribute remittance_information
|
360
363
|
# For `ach`, this field will be passed through on an addenda record. For `wire`
|
361
|
-
#
|
362
|
-
#
|
364
|
+
# payments the field will be passed through as the "Originator to Beneficiary
|
365
|
+
# Information", also known as OBI or Fedwire tag 6000.
|
363
366
|
#
|
364
367
|
# @return [String, nil]
|
365
368
|
optional :remittance_information, String, nil?: true
|
366
369
|
|
367
370
|
# @!attribute send_remittance_advice
|
368
371
|
# Send an email to the counterparty when the payment order is sent to the bank. If
|
369
|
-
#
|
372
|
+
# `null`, `send_remittance_advice` on the Counterparty is used.
|
370
373
|
#
|
371
374
|
# @return [Boolean, nil]
|
372
|
-
optional :send_remittance_advice, ModernTreasury::
|
375
|
+
optional :send_remittance_advice, ModernTreasury::Internal::Type::Boolean, nil?: true
|
373
376
|
|
374
377
|
# @!attribute statement_descriptor
|
375
378
|
# An optional descriptor which will appear in the receiver's statement. For
|
376
|
-
#
|
377
|
-
#
|
378
|
-
#
|
379
|
-
#
|
380
|
-
#
|
379
|
+
# `check` payments this field will be used as the memo line. For `ach` the maximum
|
380
|
+
# length is 10 characters. Note that for ACH payments, the name on your bank
|
381
|
+
# account will be included automatically by the bank, so you can use the
|
382
|
+
# characters for other useful information. For `eft` the maximum length is 15
|
383
|
+
# characters.
|
381
384
|
#
|
382
385
|
# @return [String, nil]
|
383
386
|
optional :statement_descriptor, String, nil?: true
|
384
387
|
|
385
388
|
# @!attribute subtype
|
386
389
|
# An additional layer of classification for the type of payment order you are
|
387
|
-
#
|
388
|
-
#
|
389
|
-
#
|
390
|
+
# doing. This field is only used for `ach` payment orders currently. For `ach`
|
391
|
+
# payment orders, the `subtype` represents the SEC code. We currently support
|
392
|
+
# `CCD`, `PPD`, `IAT`, `CTX`, `WEB`, `CIE`, and `TEL`.
|
390
393
|
#
|
391
394
|
# @return [Symbol, ModernTreasury::Models::PaymentOrderSubtype, nil]
|
392
395
|
optional :subtype, enum: -> { ModernTreasury::Models::PaymentOrderSubtype }, nil?: true
|
393
396
|
|
394
397
|
# @!attribute [r] transaction_monitoring_enabled
|
395
398
|
# A flag that determines whether a payment order should go through transaction
|
396
|
-
#
|
399
|
+
# monitoring.
|
397
400
|
#
|
398
401
|
# @return [Boolean, nil]
|
399
|
-
optional :transaction_monitoring_enabled, ModernTreasury::
|
402
|
+
optional :transaction_monitoring_enabled, ModernTreasury::Internal::Type::Boolean
|
400
403
|
|
401
404
|
# @!parse
|
402
405
|
# # @return [Boolean]
|
@@ -504,14 +507,16 @@ module ModernTreasury
|
|
504
507
|
# super
|
505
508
|
# end
|
506
509
|
|
507
|
-
# def initialize: (Hash | ModernTreasury::BaseModel) -> void
|
510
|
+
# def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
|
508
511
|
|
509
512
|
# One of `credit`, `debit`. Describes the direction money is flowing in the
|
510
|
-
#
|
511
|
-
#
|
512
|
-
#
|
513
|
+
# transaction. A `credit` moves money from your account to someone else's. A
|
514
|
+
# `debit` pulls money from someone else's account to your own. Note that wire,
|
515
|
+
# rtp, and check payments will always be `credit`.
|
516
|
+
#
|
517
|
+
# @see ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest#direction
|
513
518
|
module Direction
|
514
|
-
extend ModernTreasury::Enum
|
519
|
+
extend ModernTreasury::Internal::Type::Enum
|
515
520
|
|
516
521
|
CREDIT = :credit
|
517
522
|
DEBIT = :debit
|
@@ -523,18 +528,19 @@ module ModernTreasury
|
|
523
528
|
# def self.values; end
|
524
529
|
end
|
525
530
|
|
526
|
-
|
531
|
+
# @see ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest#accounting
|
532
|
+
class Accounting < ModernTreasury::Internal::Type::BaseModel
|
527
533
|
# @!attribute account_id
|
528
534
|
# The ID of one of your accounting categories. Note that these will only be
|
529
|
-
#
|
535
|
+
# accessible if your accounting system has been connected.
|
530
536
|
#
|
531
537
|
# @return [String, nil]
|
532
538
|
optional :account_id, String, nil?: true
|
533
539
|
|
534
540
|
# @!attribute class_id
|
535
541
|
# The ID of one of the class objects in your accounting system. Class objects
|
536
|
-
#
|
537
|
-
#
|
542
|
+
# track segments of your business independent of client or project. Note that
|
543
|
+
# these will only be accessible if your accounting system has been connected.
|
538
544
|
#
|
539
545
|
# @return [String, nil]
|
540
546
|
optional :class_id, String, nil?: true
|
@@ -545,14 +551,16 @@ module ModernTreasury
|
|
545
551
|
# #
|
546
552
|
# def initialize(account_id: nil, class_id: nil, **) = super
|
547
553
|
|
548
|
-
# def initialize: (Hash | ModernTreasury::BaseModel) -> void
|
554
|
+
# def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
|
549
555
|
end
|
550
556
|
|
551
557
|
# The party that will pay the fees for the payment order. Only applies to wire
|
552
|
-
#
|
553
|
-
#
|
558
|
+
# payment orders. Can be one of shared, sender, or receiver, which correspond
|
559
|
+
# respectively with the SWIFT 71A values `SHA`, `OUR`, `BEN`.
|
560
|
+
#
|
561
|
+
# @see ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest#charge_bearer
|
554
562
|
module ChargeBearer
|
555
|
-
extend ModernTreasury::Enum
|
563
|
+
extend ModernTreasury::Internal::Type::Enum
|
556
564
|
|
557
565
|
SHARED = :shared
|
558
566
|
SENDER = :sender
|
@@ -566,10 +574,12 @@ module ModernTreasury
|
|
566
574
|
end
|
567
575
|
|
568
576
|
# A payment type to fallback to if the original type is not valid for the
|
569
|
-
#
|
570
|
-
#
|
577
|
+
# receiving account. Currently, this only supports falling back from RTP to ACH
|
578
|
+
# (type=rtp and fallback_type=ach)
|
579
|
+
#
|
580
|
+
# @see ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest#fallback_type
|
571
581
|
module FallbackType
|
572
|
-
extend ModernTreasury::Enum
|
582
|
+
extend ModernTreasury::Internal::Type::Enum
|
573
583
|
|
574
584
|
ACH = :ach
|
575
585
|
|
@@ -581,10 +591,12 @@ module ModernTreasury
|
|
581
591
|
end
|
582
592
|
|
583
593
|
# Indicates the type of FX transfer to initiate, can be either
|
584
|
-
#
|
585
|
-
#
|
594
|
+
# `variable_to_fixed`, `fixed_to_variable`, or `null` if the payment order
|
595
|
+
# currency matches the originating account currency.
|
596
|
+
#
|
597
|
+
# @see ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest#foreign_exchange_indicator
|
586
598
|
module ForeignExchangeIndicator
|
587
|
-
extend ModernTreasury::Enum
|
599
|
+
extend ModernTreasury::Internal::Type::Enum
|
588
600
|
|
589
601
|
FIXED_TO_VARIABLE = :fixed_to_variable
|
590
602
|
VARIABLE_TO_FIXED = :variable_to_fixed
|
@@ -596,15 +608,16 @@ module ModernTreasury
|
|
596
608
|
# def self.values; end
|
597
609
|
end
|
598
610
|
|
599
|
-
|
611
|
+
# @see ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest#ledger_transaction
|
612
|
+
class LedgerTransaction < ModernTreasury::Internal::Type::BaseModel
|
600
613
|
# @!attribute ledger_entries
|
601
614
|
# An array of ledger entry objects.
|
602
615
|
#
|
603
616
|
# @return [Array<ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::LedgerTransaction::LedgerEntry>]
|
604
617
|
required :ledger_entries,
|
605
618
|
-> do
|
606
|
-
ModernTreasury::ArrayOf[
|
607
|
-
|
619
|
+
ModernTreasury::Internal::Type::ArrayOf[
|
620
|
+
ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::LedgerTransaction::LedgerEntry
|
608
621
|
]
|
609
622
|
end
|
610
623
|
|
@@ -616,7 +629,7 @@ module ModernTreasury
|
|
616
629
|
|
617
630
|
# @!attribute [r] effective_at
|
618
631
|
# The timestamp (ISO8601 format) at which the ledger transaction happened for
|
619
|
-
#
|
632
|
+
# reporting purposes.
|
620
633
|
#
|
621
634
|
# @return [Time, nil]
|
622
635
|
optional :effective_at, Time
|
@@ -627,7 +640,7 @@ module ModernTreasury
|
|
627
640
|
|
628
641
|
# @!attribute [r] effective_date
|
629
642
|
# The date (YYYY-MM-DD) on which the ledger transaction happened for reporting
|
630
|
-
#
|
643
|
+
# purposes.
|
631
644
|
#
|
632
645
|
# @return [Date, nil]
|
633
646
|
optional :effective_date, Date
|
@@ -638,7 +651,7 @@ module ModernTreasury
|
|
638
651
|
|
639
652
|
# @!attribute [r] external_id
|
640
653
|
# A unique string to represent the ledger transaction. Only one pending or posted
|
641
|
-
#
|
654
|
+
# ledger transaction may have this ID in the ledger.
|
642
655
|
#
|
643
656
|
# @return [String, nil]
|
644
657
|
optional :external_id, String
|
@@ -649,7 +662,7 @@ module ModernTreasury
|
|
649
662
|
|
650
663
|
# @!attribute [r] ledgerable_id
|
651
664
|
# If the ledger transaction can be reconciled to another object in Modern
|
652
|
-
#
|
665
|
+
# Treasury, the id will be populated here, otherwise null.
|
653
666
|
#
|
654
667
|
# @return [String, nil]
|
655
668
|
optional :ledgerable_id, String
|
@@ -660,9 +673,9 @@ module ModernTreasury
|
|
660
673
|
|
661
674
|
# @!attribute [r] ledgerable_type
|
662
675
|
# If the ledger transaction can be reconciled to another object in Modern
|
663
|
-
#
|
664
|
-
#
|
665
|
-
#
|
676
|
+
# Treasury, the type will be populated here, otherwise null. This can be one of
|
677
|
+
# payment_order, incoming_payment_detail, expected_payment, return, paper_item, or
|
678
|
+
# reversal.
|
666
679
|
#
|
667
680
|
# @return [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::LedgerTransaction::LedgerableType, nil]
|
668
681
|
optional :ledgerable_type,
|
@@ -674,10 +687,10 @@ module ModernTreasury
|
|
674
687
|
|
675
688
|
# @!attribute [r] metadata
|
676
689
|
# Additional data represented as key-value pairs. Both the key and value must be
|
677
|
-
#
|
690
|
+
# strings.
|
678
691
|
#
|
679
692
|
# @return [Hash{Symbol=>String}, nil]
|
680
|
-
optional :metadata, ModernTreasury::HashOf[String]
|
693
|
+
optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
|
681
694
|
|
682
695
|
# @!parse
|
683
696
|
# # @return [Hash{Symbol=>String}]
|
@@ -696,9 +709,9 @@ module ModernTreasury
|
|
696
709
|
|
697
710
|
# @!parse
|
698
711
|
# # Specifies a ledger transaction object that will be created with the payment
|
699
|
-
# #
|
700
|
-
# #
|
701
|
-
# #
|
712
|
+
# # order. If the ledger transaction cannot be created, then the payment order
|
713
|
+
# # creation will fail. The resulting ledger transaction will mirror the status of
|
714
|
+
# # the payment order.
|
702
715
|
# #
|
703
716
|
# # @param ledger_entries [Array<ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::LedgerTransaction::LedgerEntry>]
|
704
717
|
# # @param description [String, nil]
|
@@ -725,21 +738,21 @@ module ModernTreasury
|
|
725
738
|
# super
|
726
739
|
# end
|
727
740
|
|
728
|
-
# def initialize: (Hash | ModernTreasury::BaseModel) -> void
|
741
|
+
# def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
|
729
742
|
|
730
|
-
class LedgerEntry < ModernTreasury::BaseModel
|
743
|
+
class LedgerEntry < ModernTreasury::Internal::Type::BaseModel
|
731
744
|
# @!attribute amount
|
732
745
|
# Value in specified currency's smallest unit. e.g. $10 would be represented
|
733
|
-
#
|
746
|
+
# as 1000. Can be any integer up to 36 digits.
|
734
747
|
#
|
735
748
|
# @return [Integer]
|
736
749
|
required :amount, Integer
|
737
750
|
|
738
751
|
# @!attribute direction
|
739
752
|
# One of `credit`, `debit`. Describes the direction money is flowing in the
|
740
|
-
#
|
741
|
-
#
|
742
|
-
#
|
753
|
+
# transaction. A `credit` moves money from your account to someone else's. A
|
754
|
+
# `debit` pulls money from someone else's account to your own. Note that wire,
|
755
|
+
# rtp, and check payments will always be `credit`.
|
743
756
|
#
|
744
757
|
# @return [Symbol, ModernTreasury::Models::TransactionDirection]
|
745
758
|
required :direction, enum: -> { ModernTreasury::Models::TransactionDirection }
|
@@ -752,27 +765,27 @@ module ModernTreasury
|
|
752
765
|
|
753
766
|
# @!attribute available_balance_amount
|
754
767
|
# Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
|
755
|
-
#
|
756
|
-
#
|
768
|
+
# account’s available balance. If any of these conditions would be false after the
|
769
|
+
# transaction is created, the entire call will fail with error code 422.
|
757
770
|
#
|
758
771
|
# @return [Hash{Symbol=>Integer}, nil]
|
759
|
-
optional :available_balance_amount, ModernTreasury::HashOf[Integer], nil?: true
|
772
|
+
optional :available_balance_amount, ModernTreasury::Internal::Type::HashOf[Integer], nil?: true
|
760
773
|
|
761
774
|
# @!attribute lock_version
|
762
775
|
# Lock version of the ledger account. This can be passed when creating a ledger
|
763
|
-
#
|
764
|
-
#
|
765
|
-
#
|
776
|
+
# transaction to only succeed if no ledger transactions have posted since the
|
777
|
+
# given version. See our post about Designing the Ledgers API with Optimistic
|
778
|
+
# Locking for more details.
|
766
779
|
#
|
767
780
|
# @return [Integer, nil]
|
768
781
|
optional :lock_version, Integer, nil?: true
|
769
782
|
|
770
783
|
# @!attribute [r] metadata
|
771
784
|
# Additional data represented as key-value pairs. Both the key and value must be
|
772
|
-
#
|
785
|
+
# strings.
|
773
786
|
#
|
774
787
|
# @return [Hash{Symbol=>String}, nil]
|
775
|
-
optional :metadata, ModernTreasury::HashOf[String]
|
788
|
+
optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
|
776
789
|
|
777
790
|
# @!parse
|
778
791
|
# # @return [Hash{Symbol=>String}]
|
@@ -780,26 +793,28 @@ module ModernTreasury
|
|
780
793
|
|
781
794
|
# @!attribute pending_balance_amount
|
782
795
|
# Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
|
783
|
-
#
|
784
|
-
#
|
796
|
+
# account’s pending balance. If any of these conditions would be false after the
|
797
|
+
# transaction is created, the entire call will fail with error code 422.
|
785
798
|
#
|
786
799
|
# @return [Hash{Symbol=>Integer}, nil]
|
787
|
-
optional :pending_balance_amount, ModernTreasury::HashOf[Integer], nil?: true
|
800
|
+
optional :pending_balance_amount, ModernTreasury::Internal::Type::HashOf[Integer], nil?: true
|
788
801
|
|
789
802
|
# @!attribute posted_balance_amount
|
790
803
|
# Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
|
791
|
-
#
|
792
|
-
#
|
804
|
+
# account’s posted balance. If any of these conditions would be false after the
|
805
|
+
# transaction is created, the entire call will fail with error code 422.
|
793
806
|
#
|
794
807
|
# @return [Hash{Symbol=>Integer}, nil]
|
795
|
-
optional :posted_balance_amount, ModernTreasury::HashOf[Integer], nil?: true
|
808
|
+
optional :posted_balance_amount, ModernTreasury::Internal::Type::HashOf[Integer], nil?: true
|
796
809
|
|
797
810
|
# @!attribute show_resulting_ledger_account_balances
|
798
811
|
# If true, response will include the balance of the associated ledger account for
|
799
|
-
#
|
812
|
+
# the entry.
|
800
813
|
#
|
801
814
|
# @return [Boolean, nil]
|
802
|
-
optional :show_resulting_ledger_account_balances,
|
815
|
+
optional :show_resulting_ledger_account_balances,
|
816
|
+
ModernTreasury::Internal::Type::Boolean,
|
817
|
+
nil?: true
|
803
818
|
|
804
819
|
# @!parse
|
805
820
|
# # @param amount [Integer]
|
@@ -827,15 +842,17 @@ module ModernTreasury
|
|
827
842
|
# super
|
828
843
|
# end
|
829
844
|
|
830
|
-
# def initialize: (Hash | ModernTreasury::BaseModel) -> void
|
845
|
+
# def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
|
831
846
|
end
|
832
847
|
|
833
848
|
# If the ledger transaction can be reconciled to another object in Modern
|
834
|
-
#
|
835
|
-
#
|
836
|
-
#
|
849
|
+
# Treasury, the type will be populated here, otherwise null. This can be one of
|
850
|
+
# payment_order, incoming_payment_detail, expected_payment, return, paper_item, or
|
851
|
+
# reversal.
|
852
|
+
#
|
853
|
+
# @see ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::LedgerTransaction#ledgerable_type
|
837
854
|
module LedgerableType
|
838
|
-
extend ModernTreasury::Enum
|
855
|
+
extend ModernTreasury::Internal::Type::Enum
|
839
856
|
|
840
857
|
EXPECTED_PAYMENT = :expected_payment
|
841
858
|
INCOMING_PAYMENT_DETAIL = :incoming_payment_detail
|
@@ -852,8 +869,10 @@ module ModernTreasury
|
|
852
869
|
end
|
853
870
|
|
854
871
|
# To post a ledger transaction at creation, use `posted`.
|
872
|
+
#
|
873
|
+
# @see ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::LedgerTransaction#status
|
855
874
|
module Status
|
856
|
-
extend ModernTreasury::Enum
|
875
|
+
extend ModernTreasury::Internal::Type::Enum
|
857
876
|
|
858
877
|
ARCHIVED = :archived
|
859
878
|
PENDING = :pending
|
@@ -867,17 +886,17 @@ module ModernTreasury
|
|
867
886
|
end
|
868
887
|
end
|
869
888
|
|
870
|
-
class LineItem < ModernTreasury::BaseModel
|
889
|
+
class LineItem < ModernTreasury::Internal::Type::BaseModel
|
871
890
|
# @!attribute amount
|
872
891
|
# Value in specified currency's smallest unit. e.g. $10 would be represented
|
873
|
-
#
|
892
|
+
# as 1000.
|
874
893
|
#
|
875
894
|
# @return [Integer]
|
876
895
|
required :amount, Integer
|
877
896
|
|
878
897
|
# @!attribute accounting_category_id
|
879
898
|
# The ID of one of your accounting categories. Note that these will only be
|
880
|
-
#
|
899
|
+
# accessible if your accounting system has been connected.
|
881
900
|
#
|
882
901
|
# @return [String, nil]
|
883
902
|
optional :accounting_category_id, String, nil?: true
|
@@ -890,10 +909,10 @@ module ModernTreasury
|
|
890
909
|
|
891
910
|
# @!attribute [r] metadata
|
892
911
|
# Additional data represented as key-value pairs. Both the key and value must be
|
893
|
-
#
|
912
|
+
# strings.
|
894
913
|
#
|
895
914
|
# @return [Hash{Symbol=>String}, nil]
|
896
|
-
optional :metadata, ModernTreasury::HashOf[String]
|
915
|
+
optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
|
897
916
|
|
898
917
|
# @!parse
|
899
918
|
# # @return [Hash{Symbol=>String}]
|
@@ -907,14 +926,16 @@ module ModernTreasury
|
|
907
926
|
# #
|
908
927
|
# def initialize(amount:, accounting_category_id: nil, description: nil, metadata: nil, **) = super
|
909
928
|
|
910
|
-
# def initialize: (Hash | ModernTreasury::BaseModel) -> void
|
929
|
+
# def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
|
911
930
|
end
|
912
931
|
|
913
932
|
# Either `normal` or `high`. For ACH and EFT payments, `high` represents a
|
914
|
-
#
|
915
|
-
#
|
933
|
+
# same-day ACH or EFT transfer, respectively. For check payments, `high` can mean
|
934
|
+
# an overnight check rather than standard mail.
|
935
|
+
#
|
936
|
+
# @see ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest#priority
|
916
937
|
module Priority
|
917
|
-
extend ModernTreasury::Enum
|
938
|
+
extend ModernTreasury::Internal::Type::Enum
|
918
939
|
|
919
940
|
HIGH = :high
|
920
941
|
NORMAL = :normal
|
@@ -926,14 +947,15 @@ module ModernTreasury
|
|
926
947
|
# def self.values; end
|
927
948
|
end
|
928
949
|
|
929
|
-
|
950
|
+
# @see ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest#receiving_account
|
951
|
+
class ReceivingAccount < ModernTreasury::Internal::Type::BaseModel
|
930
952
|
# @!attribute [r] account_details
|
931
953
|
#
|
932
954
|
# @return [Array<ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::ReceivingAccount::AccountDetail>, nil]
|
933
955
|
optional :account_details,
|
934
956
|
-> do
|
935
|
-
ModernTreasury::ArrayOf[
|
936
|
-
|
957
|
+
ModernTreasury::Internal::Type::ArrayOf[
|
958
|
+
ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::ReceivingAccount::AccountDetail
|
937
959
|
]
|
938
960
|
end
|
939
961
|
|
@@ -956,8 +978,8 @@ module ModernTreasury
|
|
956
978
|
# @return [Array<ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::ReceivingAccount::ContactDetail>, nil]
|
957
979
|
optional :contact_details,
|
958
980
|
-> do
|
959
|
-
ModernTreasury::ArrayOf[
|
960
|
-
|
981
|
+
ModernTreasury::Internal::Type::ArrayOf[
|
982
|
+
ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::ReceivingAccount::ContactDetail
|
961
983
|
]
|
962
984
|
end
|
963
985
|
|
@@ -967,10 +989,10 @@ module ModernTreasury
|
|
967
989
|
|
968
990
|
# @!attribute [r] ledger_account
|
969
991
|
# Specifies a ledger account object that will be created with the external
|
970
|
-
#
|
971
|
-
#
|
972
|
-
#
|
973
|
-
#
|
992
|
+
# account. The resulting ledger account is linked to the external account for
|
993
|
+
# auto-ledgering Payment objects. See
|
994
|
+
# https://docs.moderntreasury.com/docs/linking-to-other-modern-treasury-objects
|
995
|
+
# for more details.
|
974
996
|
#
|
975
997
|
# @return [ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::ReceivingAccount::LedgerAccount, nil]
|
976
998
|
optional :ledger_account,
|
@@ -982,10 +1004,10 @@ module ModernTreasury
|
|
982
1004
|
|
983
1005
|
# @!attribute [r] metadata
|
984
1006
|
# Additional data represented as key-value pairs. Both the key and value must be
|
985
|
-
#
|
1007
|
+
# strings.
|
986
1008
|
#
|
987
1009
|
# @return [Hash{Symbol=>String}, nil]
|
988
|
-
optional :metadata, ModernTreasury::HashOf[String]
|
1010
|
+
optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
|
989
1011
|
|
990
1012
|
# @!parse
|
991
1013
|
# # @return [Hash{Symbol=>String}]
|
@@ -993,7 +1015,7 @@ module ModernTreasury
|
|
993
1015
|
|
994
1016
|
# @!attribute name
|
995
1017
|
# A nickname for the external account. This is only for internal usage and won't
|
996
|
-
#
|
1018
|
+
# affect any payments
|
997
1019
|
#
|
998
1020
|
# @return [String, nil]
|
999
1021
|
optional :name, String, nil?: true
|
@@ -1038,7 +1060,7 @@ module ModernTreasury
|
|
1038
1060
|
|
1039
1061
|
# @!attribute [r] plaid_processor_token
|
1040
1062
|
# If you've enabled the Modern Treasury + Plaid integration in your Plaid account,
|
1041
|
-
#
|
1063
|
+
# you can pass the processor token in this field.
|
1042
1064
|
#
|
1043
1065
|
# @return [String, nil]
|
1044
1066
|
optional :plaid_processor_token, String
|
@@ -1052,8 +1074,8 @@ module ModernTreasury
|
|
1052
1074
|
# @return [Array<ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::ReceivingAccount::RoutingDetail>, nil]
|
1053
1075
|
optional :routing_details,
|
1054
1076
|
-> do
|
1055
|
-
ModernTreasury::ArrayOf[
|
1056
|
-
|
1077
|
+
ModernTreasury::Internal::Type::ArrayOf[
|
1078
|
+
ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::ReceivingAccount::RoutingDetail
|
1057
1079
|
]
|
1058
1080
|
end
|
1059
1081
|
|
@@ -1063,8 +1085,8 @@ module ModernTreasury
|
|
1063
1085
|
|
1064
1086
|
# @!parse
|
1065
1087
|
# # Either `receiving_account` or `receiving_account_id` must be present. When using
|
1066
|
-
# #
|
1067
|
-
# #
|
1088
|
+
# # `receiving_account_id`, you may pass the id of an external account or an
|
1089
|
+
# # internal account.
|
1068
1090
|
# #
|
1069
1091
|
# # @param account_details [Array<ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::ReceivingAccount::AccountDetail>]
|
1070
1092
|
# # @param account_type [Symbol, ModernTreasury::Models::ExternalAccountType]
|
@@ -1097,9 +1119,9 @@ module ModernTreasury
|
|
1097
1119
|
# super
|
1098
1120
|
# end
|
1099
1121
|
|
1100
|
-
# def initialize: (Hash | ModernTreasury::BaseModel) -> void
|
1122
|
+
# def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
|
1101
1123
|
|
1102
|
-
class AccountDetail < ModernTreasury::BaseModel
|
1124
|
+
class AccountDetail < ModernTreasury::Internal::Type::BaseModel
|
1103
1125
|
# @!attribute account_number
|
1104
1126
|
#
|
1105
1127
|
# @return [String]
|
@@ -1121,10 +1143,11 @@ module ModernTreasury
|
|
1121
1143
|
# #
|
1122
1144
|
# def initialize(account_number:, account_number_type: nil, **) = super
|
1123
1145
|
|
1124
|
-
# def initialize: (Hash | ModernTreasury::BaseModel) -> void
|
1146
|
+
# def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
|
1125
1147
|
|
1148
|
+
# @see ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::ReceivingAccount::AccountDetail#account_number_type
|
1126
1149
|
module AccountNumberType
|
1127
|
-
extend ModernTreasury::Enum
|
1150
|
+
extend ModernTreasury::Internal::Type::Enum
|
1128
1151
|
|
1129
1152
|
AU_NUMBER = :au_number
|
1130
1153
|
CLABE = :clabe
|
@@ -1145,7 +1168,7 @@ module ModernTreasury
|
|
1145
1168
|
end
|
1146
1169
|
end
|
1147
1170
|
|
1148
|
-
class ContactDetail < ModernTreasury::BaseModel
|
1171
|
+
class ContactDetail < ModernTreasury::Internal::Type::BaseModel
|
1149
1172
|
# @!attribute [r] contact_identifier
|
1150
1173
|
#
|
1151
1174
|
# @return [String, nil]
|
@@ -1171,10 +1194,11 @@ module ModernTreasury
|
|
1171
1194
|
# #
|
1172
1195
|
# def initialize(contact_identifier: nil, contact_identifier_type: nil, **) = super
|
1173
1196
|
|
1174
|
-
# def initialize: (Hash | ModernTreasury::BaseModel) -> void
|
1197
|
+
# def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
|
1175
1198
|
|
1199
|
+
# @see ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::ReceivingAccount::ContactDetail#contact_identifier_type
|
1176
1200
|
module ContactIdentifierType
|
1177
|
-
extend ModernTreasury::Enum
|
1201
|
+
extend ModernTreasury::Internal::Type::Enum
|
1178
1202
|
|
1179
1203
|
EMAIL = :email
|
1180
1204
|
PHONE_NUMBER = :phone_number
|
@@ -1188,7 +1212,8 @@ module ModernTreasury
|
|
1188
1212
|
end
|
1189
1213
|
end
|
1190
1214
|
|
1191
|
-
|
1215
|
+
# @see ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::ReceivingAccount#ledger_account
|
1216
|
+
class LedgerAccount < ModernTreasury::Internal::Type::BaseModel
|
1192
1217
|
# @!attribute currency
|
1193
1218
|
# The currency of the ledger account.
|
1194
1219
|
#
|
@@ -1227,10 +1252,10 @@ module ModernTreasury
|
|
1227
1252
|
|
1228
1253
|
# @!attribute [r] ledger_account_category_ids
|
1229
1254
|
# The array of ledger account category ids that this ledger account should be a
|
1230
|
-
#
|
1255
|
+
# child of.
|
1231
1256
|
#
|
1232
1257
|
# @return [Array<String>, nil]
|
1233
|
-
optional :ledger_account_category_ids, ModernTreasury::ArrayOf[String]
|
1258
|
+
optional :ledger_account_category_ids, ModernTreasury::Internal::Type::ArrayOf[String]
|
1234
1259
|
|
1235
1260
|
# @!parse
|
1236
1261
|
# # @return [Array<String>]
|
@@ -1238,7 +1263,7 @@ module ModernTreasury
|
|
1238
1263
|
|
1239
1264
|
# @!attribute [r] ledgerable_id
|
1240
1265
|
# If the ledger account links to another object in Modern Treasury, the id will be
|
1241
|
-
#
|
1266
|
+
# populated here, otherwise null.
|
1242
1267
|
#
|
1243
1268
|
# @return [String, nil]
|
1244
1269
|
optional :ledgerable_id, String
|
@@ -1249,8 +1274,8 @@ module ModernTreasury
|
|
1249
1274
|
|
1250
1275
|
# @!attribute [r] ledgerable_type
|
1251
1276
|
# If the ledger account links to another object in Modern Treasury, the type will
|
1252
|
-
#
|
1253
|
-
#
|
1277
|
+
# be populated here, otherwise null. The value is one of internal_account or
|
1278
|
+
# external_account.
|
1254
1279
|
#
|
1255
1280
|
# @return [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::ReceivingAccount::LedgerAccount::LedgerableType, nil]
|
1256
1281
|
optional :ledgerable_type,
|
@@ -1262,10 +1287,10 @@ module ModernTreasury
|
|
1262
1287
|
|
1263
1288
|
# @!attribute [r] metadata
|
1264
1289
|
# Additional data represented as key-value pairs. Both the key and value must be
|
1265
|
-
#
|
1290
|
+
# strings.
|
1266
1291
|
#
|
1267
1292
|
# @return [Hash{Symbol=>String}, nil]
|
1268
|
-
optional :metadata, ModernTreasury::HashOf[String]
|
1293
|
+
optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
|
1269
1294
|
|
1270
1295
|
# @!parse
|
1271
1296
|
# # @return [Hash{Symbol=>String}]
|
@@ -1273,10 +1298,10 @@ module ModernTreasury
|
|
1273
1298
|
|
1274
1299
|
# @!parse
|
1275
1300
|
# # Specifies a ledger account object that will be created with the external
|
1276
|
-
# #
|
1277
|
-
# #
|
1278
|
-
# #
|
1279
|
-
# #
|
1301
|
+
# # account. The resulting ledger account is linked to the external account for
|
1302
|
+
# # auto-ledgering Payment objects. See
|
1303
|
+
# # https://docs.moderntreasury.com/docs/linking-to-other-modern-treasury-objects
|
1304
|
+
# # for more details.
|
1280
1305
|
# #
|
1281
1306
|
# # @param currency [String]
|
1282
1307
|
# # @param ledger_id [String]
|
@@ -1305,13 +1330,15 @@ module ModernTreasury
|
|
1305
1330
|
# super
|
1306
1331
|
# end
|
1307
1332
|
|
1308
|
-
# def initialize: (Hash | ModernTreasury::BaseModel) -> void
|
1333
|
+
# def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
|
1309
1334
|
|
1310
1335
|
# If the ledger account links to another object in Modern Treasury, the type will
|
1311
|
-
#
|
1312
|
-
#
|
1336
|
+
# be populated here, otherwise null. The value is one of internal_account or
|
1337
|
+
# external_account.
|
1338
|
+
#
|
1339
|
+
# @see ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::ReceivingAccount::LedgerAccount#ledgerable_type
|
1313
1340
|
module LedgerableType
|
1314
|
-
extend ModernTreasury::Enum
|
1341
|
+
extend ModernTreasury::Internal::Type::Enum
|
1315
1342
|
|
1316
1343
|
COUNTERPARTY = :counterparty
|
1317
1344
|
EXTERNAL_ACCOUNT = :external_account
|
@@ -1326,7 +1353,8 @@ module ModernTreasury
|
|
1326
1353
|
end
|
1327
1354
|
end
|
1328
1355
|
|
1329
|
-
|
1356
|
+
# @see ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::ReceivingAccount#party_address
|
1357
|
+
class PartyAddress < ModernTreasury::Internal::Type::BaseModel
|
1330
1358
|
# @!attribute country
|
1331
1359
|
# Country code conforms to [ISO 3166-1 alpha-2]
|
1332
1360
|
#
|
@@ -1373,12 +1401,14 @@ module ModernTreasury
|
|
1373
1401
|
# #
|
1374
1402
|
# def initialize(country: nil, line1: nil, line2: nil, locality: nil, postal_code: nil, region: nil, **) = super
|
1375
1403
|
|
1376
|
-
# def initialize: (Hash | ModernTreasury::BaseModel) -> void
|
1404
|
+
# def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
|
1377
1405
|
end
|
1378
1406
|
|
1379
1407
|
# Either `individual` or `business`.
|
1408
|
+
#
|
1409
|
+
# @see ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::ReceivingAccount#party_type
|
1380
1410
|
module PartyType
|
1381
|
-
extend ModernTreasury::Enum
|
1411
|
+
extend ModernTreasury::Internal::Type::Enum
|
1382
1412
|
|
1383
1413
|
BUSINESS = :business
|
1384
1414
|
INDIVIDUAL = :individual
|
@@ -1390,7 +1420,7 @@ module ModernTreasury
|
|
1390
1420
|
# def self.values; end
|
1391
1421
|
end
|
1392
1422
|
|
1393
|
-
class RoutingDetail < ModernTreasury::BaseModel
|
1423
|
+
class RoutingDetail < ModernTreasury::Internal::Type::BaseModel
|
1394
1424
|
# @!attribute routing_number
|
1395
1425
|
#
|
1396
1426
|
# @return [String]
|
@@ -1419,10 +1449,11 @@ module ModernTreasury
|
|
1419
1449
|
# #
|
1420
1450
|
# def initialize(routing_number:, routing_number_type:, payment_type: nil, **) = super
|
1421
1451
|
|
1422
|
-
# def initialize: (Hash | ModernTreasury::BaseModel) -> void
|
1452
|
+
# def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
|
1423
1453
|
|
1454
|
+
# @see ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::ReceivingAccount::RoutingDetail#routing_number_type
|
1424
1455
|
module RoutingNumberType
|
1425
|
-
extend ModernTreasury::Enum
|
1456
|
+
extend ModernTreasury::Internal::Type::Enum
|
1426
1457
|
|
1427
1458
|
ABA = :aba
|
1428
1459
|
AU_BSB = :au_bsb
|
@@ -1453,8 +1484,9 @@ module ModernTreasury
|
|
1453
1484
|
# def self.values; end
|
1454
1485
|
end
|
1455
1486
|
|
1487
|
+
# @see ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::ReceivingAccount::RoutingDetail#payment_type
|
1456
1488
|
module PaymentType
|
1457
|
-
extend ModernTreasury::Enum
|
1489
|
+
extend ModernTreasury::Internal::Type::Enum
|
1458
1490
|
|
1459
1491
|
ACH = :ach
|
1460
1492
|
AU_BECS = :au_becs
|
@@ -1497,17 +1529,17 @@ module ModernTreasury
|
|
1497
1529
|
end
|
1498
1530
|
end
|
1499
1531
|
|
1500
|
-
class ExpectedPaymentCreateRequest < ModernTreasury::BaseModel
|
1532
|
+
class ExpectedPaymentCreateRequest < ModernTreasury::Internal::Type::BaseModel
|
1501
1533
|
# @!attribute amount_lower_bound
|
1502
1534
|
# The lowest amount this expected payment may be equal to. Value in specified
|
1503
|
-
#
|
1535
|
+
# currency's smallest unit. e.g. $10 would be represented as 1000.
|
1504
1536
|
#
|
1505
1537
|
# @return [Integer, nil]
|
1506
1538
|
optional :amount_lower_bound, Integer, nil?: true
|
1507
1539
|
|
1508
1540
|
# @!attribute amount_upper_bound
|
1509
1541
|
# The highest amount this expected payment may be equal to. Value in specified
|
1510
|
-
#
|
1542
|
+
# currency's smallest unit. e.g. $10 would be represented as 1000.
|
1511
1543
|
#
|
1512
1544
|
# @return [Integer, nil]
|
1513
1545
|
optional :amount_upper_bound, Integer, nil?: true
|
@@ -1544,7 +1576,7 @@ module ModernTreasury
|
|
1544
1576
|
|
1545
1577
|
# @!attribute direction
|
1546
1578
|
# One of credit or debit. When you are receiving money, use credit. When you are
|
1547
|
-
#
|
1579
|
+
# being charged, use debit.
|
1548
1580
|
#
|
1549
1581
|
# @return [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::Direction, nil]
|
1550
1582
|
optional :direction,
|
@@ -1559,9 +1591,9 @@ module ModernTreasury
|
|
1559
1591
|
|
1560
1592
|
# @!attribute [r] ledger_transaction
|
1561
1593
|
# Specifies a ledger transaction object that will be created with the expected
|
1562
|
-
#
|
1563
|
-
#
|
1564
|
-
#
|
1594
|
+
# payment. If the ledger transaction cannot be created, then the expected payment
|
1595
|
+
# creation will fail. The resulting ledger transaction will mirror the status of
|
1596
|
+
# the expected payment.
|
1565
1597
|
#
|
1566
1598
|
# @return [ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::LedgerTransaction, nil]
|
1567
1599
|
optional :ledger_transaction,
|
@@ -1573,9 +1605,9 @@ module ModernTreasury
|
|
1573
1605
|
|
1574
1606
|
# @!attribute [r] ledger_transaction_id
|
1575
1607
|
# Either ledger_transaction or ledger_transaction_id can be provided. Only a
|
1576
|
-
#
|
1577
|
-
#
|
1578
|
-
#
|
1608
|
+
# pending ledger transaction can be attached upon expected payment creation. Once
|
1609
|
+
# the expected payment is created, the status of the ledger transaction tracks the
|
1610
|
+
# expected payment automatically.
|
1579
1611
|
#
|
1580
1612
|
# @return [String, nil]
|
1581
1613
|
optional :ledger_transaction_id, String
|
@@ -1588,7 +1620,7 @@ module ModernTreasury
|
|
1588
1620
|
#
|
1589
1621
|
# @return [Array<ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::LineItem>, nil]
|
1590
1622
|
optional :line_items,
|
1591
|
-
-> { ModernTreasury::ArrayOf[ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::LineItem] }
|
1623
|
+
-> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::LineItem] }
|
1592
1624
|
|
1593
1625
|
# @!parse
|
1594
1626
|
# # @return [Array<ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::LineItem>]
|
@@ -1596,10 +1628,10 @@ module ModernTreasury
|
|
1596
1628
|
|
1597
1629
|
# @!attribute [r] metadata
|
1598
1630
|
# Additional data represented as key-value pairs. Both the key and value must be
|
1599
|
-
#
|
1631
|
+
# strings.
|
1600
1632
|
#
|
1601
1633
|
# @return [Hash{Symbol=>String}, nil]
|
1602
|
-
optional :metadata, ModernTreasury::HashOf[String]
|
1634
|
+
optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
|
1603
1635
|
|
1604
1636
|
# @!parse
|
1605
1637
|
# # @return [Hash{Symbol=>String}]
|
@@ -1609,42 +1641,42 @@ module ModernTreasury
|
|
1609
1641
|
# The reconciliation filters you have for this payment.
|
1610
1642
|
#
|
1611
1643
|
# @return [Object, nil]
|
1612
|
-
optional :reconciliation_filters, ModernTreasury::Unknown, nil?: true
|
1644
|
+
optional :reconciliation_filters, ModernTreasury::Internal::Type::Unknown, nil?: true
|
1613
1645
|
|
1614
1646
|
# @!attribute reconciliation_groups
|
1615
1647
|
# The reconciliation groups you have for this payment.
|
1616
1648
|
#
|
1617
1649
|
# @return [Object, nil]
|
1618
|
-
optional :reconciliation_groups, ModernTreasury::Unknown, nil?: true
|
1650
|
+
optional :reconciliation_groups, ModernTreasury::Internal::Type::Unknown, nil?: true
|
1619
1651
|
|
1620
1652
|
# @!attribute reconciliation_rule_variables
|
1621
1653
|
# An array of reconciliation rule variables for this payment.
|
1622
1654
|
#
|
1623
1655
|
# @return [Array<ModernTreasury::Models::ReconciliationRule>, nil]
|
1624
1656
|
optional :reconciliation_rule_variables,
|
1625
|
-
-> { ModernTreasury::ArrayOf[ModernTreasury::Models::ReconciliationRule] },
|
1657
|
+
-> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::ReconciliationRule] },
|
1626
1658
|
nil?: true
|
1627
1659
|
|
1628
1660
|
# @!attribute remittance_information
|
1629
1661
|
# For `ach`, this field will be passed through on an addenda record. For `wire`
|
1630
|
-
#
|
1631
|
-
#
|
1662
|
+
# payments the field will be passed through as the "Originator to Beneficiary
|
1663
|
+
# Information", also known as OBI or Fedwire tag 6000.
|
1632
1664
|
#
|
1633
1665
|
# @return [String, nil]
|
1634
1666
|
optional :remittance_information, String, nil?: true
|
1635
1667
|
|
1636
1668
|
# @!attribute statement_descriptor
|
1637
1669
|
# The statement description you expect to see on the transaction. For ACH
|
1638
|
-
#
|
1639
|
-
#
|
1640
|
-
#
|
1670
|
+
# payments, this will be the full line item passed from the bank. For wire
|
1671
|
+
# payments, this will be the OBI field on the wire. For check payments, this will
|
1672
|
+
# be the memo field.
|
1641
1673
|
#
|
1642
1674
|
# @return [String, nil]
|
1643
1675
|
optional :statement_descriptor, String, nil?: true
|
1644
1676
|
|
1645
1677
|
# @!attribute type
|
1646
1678
|
# One of: ach, au_becs, bacs, book, check, eft, interac, provxchange, rtp, sen,
|
1647
|
-
#
|
1679
|
+
# sepa, signet, wire.
|
1648
1680
|
#
|
1649
1681
|
# @return [Symbol, ModernTreasury::Models::ExpectedPaymentType, nil]
|
1650
1682
|
optional :type, enum: -> { ModernTreasury::Models::ExpectedPaymentType }, nil?: true
|
@@ -1695,12 +1727,14 @@ module ModernTreasury
|
|
1695
1727
|
# super
|
1696
1728
|
# end
|
1697
1729
|
|
1698
|
-
# def initialize: (Hash | ModernTreasury::BaseModel) -> void
|
1730
|
+
# def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
|
1699
1731
|
|
1700
1732
|
# One of credit or debit. When you are receiving money, use credit. When you are
|
1701
|
-
#
|
1733
|
+
# being charged, use debit.
|
1734
|
+
#
|
1735
|
+
# @see ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest#direction
|
1702
1736
|
module Direction
|
1703
|
-
extend ModernTreasury::Enum
|
1737
|
+
extend ModernTreasury::Internal::Type::Enum
|
1704
1738
|
|
1705
1739
|
CREDIT = :credit
|
1706
1740
|
DEBIT = :debit
|
@@ -1712,15 +1746,16 @@ module ModernTreasury
|
|
1712
1746
|
# def self.values; end
|
1713
1747
|
end
|
1714
1748
|
|
1715
|
-
|
1749
|
+
# @see ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest#ledger_transaction
|
1750
|
+
class LedgerTransaction < ModernTreasury::Internal::Type::BaseModel
|
1716
1751
|
# @!attribute ledger_entries
|
1717
1752
|
# An array of ledger entry objects.
|
1718
1753
|
#
|
1719
1754
|
# @return [Array<ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::LedgerTransaction::LedgerEntry>]
|
1720
1755
|
required :ledger_entries,
|
1721
1756
|
-> do
|
1722
|
-
ModernTreasury::ArrayOf[
|
1723
|
-
|
1757
|
+
ModernTreasury::Internal::Type::ArrayOf[
|
1758
|
+
ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::LedgerTransaction::LedgerEntry
|
1724
1759
|
]
|
1725
1760
|
end
|
1726
1761
|
|
@@ -1732,7 +1767,7 @@ module ModernTreasury
|
|
1732
1767
|
|
1733
1768
|
# @!attribute [r] effective_at
|
1734
1769
|
# The timestamp (ISO8601 format) at which the ledger transaction happened for
|
1735
|
-
#
|
1770
|
+
# reporting purposes.
|
1736
1771
|
#
|
1737
1772
|
# @return [Time, nil]
|
1738
1773
|
optional :effective_at, Time
|
@@ -1743,7 +1778,7 @@ module ModernTreasury
|
|
1743
1778
|
|
1744
1779
|
# @!attribute [r] effective_date
|
1745
1780
|
# The date (YYYY-MM-DD) on which the ledger transaction happened for reporting
|
1746
|
-
#
|
1781
|
+
# purposes.
|
1747
1782
|
#
|
1748
1783
|
# @return [Date, nil]
|
1749
1784
|
optional :effective_date, Date
|
@@ -1754,7 +1789,7 @@ module ModernTreasury
|
|
1754
1789
|
|
1755
1790
|
# @!attribute [r] external_id
|
1756
1791
|
# A unique string to represent the ledger transaction. Only one pending or posted
|
1757
|
-
#
|
1792
|
+
# ledger transaction may have this ID in the ledger.
|
1758
1793
|
#
|
1759
1794
|
# @return [String, nil]
|
1760
1795
|
optional :external_id, String
|
@@ -1765,7 +1800,7 @@ module ModernTreasury
|
|
1765
1800
|
|
1766
1801
|
# @!attribute [r] ledgerable_id
|
1767
1802
|
# If the ledger transaction can be reconciled to another object in Modern
|
1768
|
-
#
|
1803
|
+
# Treasury, the id will be populated here, otherwise null.
|
1769
1804
|
#
|
1770
1805
|
# @return [String, nil]
|
1771
1806
|
optional :ledgerable_id, String
|
@@ -1776,9 +1811,9 @@ module ModernTreasury
|
|
1776
1811
|
|
1777
1812
|
# @!attribute [r] ledgerable_type
|
1778
1813
|
# If the ledger transaction can be reconciled to another object in Modern
|
1779
|
-
#
|
1780
|
-
#
|
1781
|
-
#
|
1814
|
+
# Treasury, the type will be populated here, otherwise null. This can be one of
|
1815
|
+
# payment_order, incoming_payment_detail, expected_payment, return, paper_item, or
|
1816
|
+
# reversal.
|
1782
1817
|
#
|
1783
1818
|
# @return [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::LedgerTransaction::LedgerableType, nil]
|
1784
1819
|
optional :ledgerable_type,
|
@@ -1790,10 +1825,10 @@ module ModernTreasury
|
|
1790
1825
|
|
1791
1826
|
# @!attribute [r] metadata
|
1792
1827
|
# Additional data represented as key-value pairs. Both the key and value must be
|
1793
|
-
#
|
1828
|
+
# strings.
|
1794
1829
|
#
|
1795
1830
|
# @return [Hash{Symbol=>String}, nil]
|
1796
|
-
optional :metadata, ModernTreasury::HashOf[String]
|
1831
|
+
optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
|
1797
1832
|
|
1798
1833
|
# @!parse
|
1799
1834
|
# # @return [Hash{Symbol=>String}]
|
@@ -1812,9 +1847,9 @@ module ModernTreasury
|
|
1812
1847
|
|
1813
1848
|
# @!parse
|
1814
1849
|
# # Specifies a ledger transaction object that will be created with the expected
|
1815
|
-
# #
|
1816
|
-
# #
|
1817
|
-
# #
|
1850
|
+
# # payment. If the ledger transaction cannot be created, then the expected payment
|
1851
|
+
# # creation will fail. The resulting ledger transaction will mirror the status of
|
1852
|
+
# # the expected payment.
|
1818
1853
|
# #
|
1819
1854
|
# # @param ledger_entries [Array<ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::LedgerTransaction::LedgerEntry>]
|
1820
1855
|
# # @param description [String, nil]
|
@@ -1841,21 +1876,21 @@ module ModernTreasury
|
|
1841
1876
|
# super
|
1842
1877
|
# end
|
1843
1878
|
|
1844
|
-
# def initialize: (Hash | ModernTreasury::BaseModel) -> void
|
1879
|
+
# def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
|
1845
1880
|
|
1846
|
-
class LedgerEntry < ModernTreasury::BaseModel
|
1881
|
+
class LedgerEntry < ModernTreasury::Internal::Type::BaseModel
|
1847
1882
|
# @!attribute amount
|
1848
1883
|
# Value in specified currency's smallest unit. e.g. $10 would be represented
|
1849
|
-
#
|
1884
|
+
# as 1000. Can be any integer up to 36 digits.
|
1850
1885
|
#
|
1851
1886
|
# @return [Integer]
|
1852
1887
|
required :amount, Integer
|
1853
1888
|
|
1854
1889
|
# @!attribute direction
|
1855
1890
|
# One of `credit`, `debit`. Describes the direction money is flowing in the
|
1856
|
-
#
|
1857
|
-
#
|
1858
|
-
#
|
1891
|
+
# transaction. A `credit` moves money from your account to someone else's. A
|
1892
|
+
# `debit` pulls money from someone else's account to your own. Note that wire,
|
1893
|
+
# rtp, and check payments will always be `credit`.
|
1859
1894
|
#
|
1860
1895
|
# @return [Symbol, ModernTreasury::Models::TransactionDirection]
|
1861
1896
|
required :direction, enum: -> { ModernTreasury::Models::TransactionDirection }
|
@@ -1868,27 +1903,27 @@ module ModernTreasury
|
|
1868
1903
|
|
1869
1904
|
# @!attribute available_balance_amount
|
1870
1905
|
# Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
|
1871
|
-
#
|
1872
|
-
#
|
1906
|
+
# account’s available balance. If any of these conditions would be false after the
|
1907
|
+
# transaction is created, the entire call will fail with error code 422.
|
1873
1908
|
#
|
1874
1909
|
# @return [Hash{Symbol=>Integer}, nil]
|
1875
|
-
optional :available_balance_amount, ModernTreasury::HashOf[Integer], nil?: true
|
1910
|
+
optional :available_balance_amount, ModernTreasury::Internal::Type::HashOf[Integer], nil?: true
|
1876
1911
|
|
1877
1912
|
# @!attribute lock_version
|
1878
1913
|
# Lock version of the ledger account. This can be passed when creating a ledger
|
1879
|
-
#
|
1880
|
-
#
|
1881
|
-
#
|
1914
|
+
# transaction to only succeed if no ledger transactions have posted since the
|
1915
|
+
# given version. See our post about Designing the Ledgers API with Optimistic
|
1916
|
+
# Locking for more details.
|
1882
1917
|
#
|
1883
1918
|
# @return [Integer, nil]
|
1884
1919
|
optional :lock_version, Integer, nil?: true
|
1885
1920
|
|
1886
1921
|
# @!attribute [r] metadata
|
1887
1922
|
# Additional data represented as key-value pairs. Both the key and value must be
|
1888
|
-
#
|
1923
|
+
# strings.
|
1889
1924
|
#
|
1890
1925
|
# @return [Hash{Symbol=>String}, nil]
|
1891
|
-
optional :metadata, ModernTreasury::HashOf[String]
|
1926
|
+
optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
|
1892
1927
|
|
1893
1928
|
# @!parse
|
1894
1929
|
# # @return [Hash{Symbol=>String}]
|
@@ -1896,26 +1931,28 @@ module ModernTreasury
|
|
1896
1931
|
|
1897
1932
|
# @!attribute pending_balance_amount
|
1898
1933
|
# Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
|
1899
|
-
#
|
1900
|
-
#
|
1934
|
+
# account’s pending balance. If any of these conditions would be false after the
|
1935
|
+
# transaction is created, the entire call will fail with error code 422.
|
1901
1936
|
#
|
1902
1937
|
# @return [Hash{Symbol=>Integer}, nil]
|
1903
|
-
optional :pending_balance_amount, ModernTreasury::HashOf[Integer], nil?: true
|
1938
|
+
optional :pending_balance_amount, ModernTreasury::Internal::Type::HashOf[Integer], nil?: true
|
1904
1939
|
|
1905
1940
|
# @!attribute posted_balance_amount
|
1906
1941
|
# Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
|
1907
|
-
#
|
1908
|
-
#
|
1942
|
+
# account’s posted balance. If any of these conditions would be false after the
|
1943
|
+
# transaction is created, the entire call will fail with error code 422.
|
1909
1944
|
#
|
1910
1945
|
# @return [Hash{Symbol=>Integer}, nil]
|
1911
|
-
optional :posted_balance_amount, ModernTreasury::HashOf[Integer], nil?: true
|
1946
|
+
optional :posted_balance_amount, ModernTreasury::Internal::Type::HashOf[Integer], nil?: true
|
1912
1947
|
|
1913
1948
|
# @!attribute show_resulting_ledger_account_balances
|
1914
1949
|
# If true, response will include the balance of the associated ledger account for
|
1915
|
-
#
|
1950
|
+
# the entry.
|
1916
1951
|
#
|
1917
1952
|
# @return [Boolean, nil]
|
1918
|
-
optional :show_resulting_ledger_account_balances,
|
1953
|
+
optional :show_resulting_ledger_account_balances,
|
1954
|
+
ModernTreasury::Internal::Type::Boolean,
|
1955
|
+
nil?: true
|
1919
1956
|
|
1920
1957
|
# @!parse
|
1921
1958
|
# # @param amount [Integer]
|
@@ -1943,15 +1980,17 @@ module ModernTreasury
|
|
1943
1980
|
# super
|
1944
1981
|
# end
|
1945
1982
|
|
1946
|
-
# def initialize: (Hash | ModernTreasury::BaseModel) -> void
|
1983
|
+
# def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
|
1947
1984
|
end
|
1948
1985
|
|
1949
1986
|
# If the ledger transaction can be reconciled to another object in Modern
|
1950
|
-
#
|
1951
|
-
#
|
1952
|
-
#
|
1987
|
+
# Treasury, the type will be populated here, otherwise null. This can be one of
|
1988
|
+
# payment_order, incoming_payment_detail, expected_payment, return, paper_item, or
|
1989
|
+
# reversal.
|
1990
|
+
#
|
1991
|
+
# @see ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::LedgerTransaction#ledgerable_type
|
1953
1992
|
module LedgerableType
|
1954
|
-
extend ModernTreasury::Enum
|
1993
|
+
extend ModernTreasury::Internal::Type::Enum
|
1955
1994
|
|
1956
1995
|
EXPECTED_PAYMENT = :expected_payment
|
1957
1996
|
INCOMING_PAYMENT_DETAIL = :incoming_payment_detail
|
@@ -1968,8 +2007,10 @@ module ModernTreasury
|
|
1968
2007
|
end
|
1969
2008
|
|
1970
2009
|
# To post a ledger transaction at creation, use `posted`.
|
2010
|
+
#
|
2011
|
+
# @see ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::LedgerTransaction#status
|
1971
2012
|
module Status
|
1972
|
-
extend ModernTreasury::Enum
|
2013
|
+
extend ModernTreasury::Internal::Type::Enum
|
1973
2014
|
|
1974
2015
|
ARCHIVED = :archived
|
1975
2016
|
PENDING = :pending
|
@@ -1983,17 +2024,17 @@ module ModernTreasury
|
|
1983
2024
|
end
|
1984
2025
|
end
|
1985
2026
|
|
1986
|
-
class LineItem < ModernTreasury::BaseModel
|
2027
|
+
class LineItem < ModernTreasury::Internal::Type::BaseModel
|
1987
2028
|
# @!attribute amount
|
1988
2029
|
# Value in specified currency's smallest unit. e.g. $10 would be represented
|
1989
|
-
#
|
2030
|
+
# as 1000.
|
1990
2031
|
#
|
1991
2032
|
# @return [Integer]
|
1992
2033
|
required :amount, Integer
|
1993
2034
|
|
1994
2035
|
# @!attribute accounting_category_id
|
1995
2036
|
# The ID of one of your accounting categories. Note that these will only be
|
1996
|
-
#
|
2037
|
+
# accessible if your accounting system has been connected.
|
1997
2038
|
#
|
1998
2039
|
# @return [String, nil]
|
1999
2040
|
optional :accounting_category_id, String, nil?: true
|
@@ -2006,10 +2047,10 @@ module ModernTreasury
|
|
2006
2047
|
|
2007
2048
|
# @!attribute [r] metadata
|
2008
2049
|
# Additional data represented as key-value pairs. Both the key and value must be
|
2009
|
-
#
|
2050
|
+
# strings.
|
2010
2051
|
#
|
2011
2052
|
# @return [Hash{Symbol=>String}, nil]
|
2012
|
-
optional :metadata, ModernTreasury::HashOf[String]
|
2053
|
+
optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
|
2013
2054
|
|
2014
2055
|
# @!parse
|
2015
2056
|
# # @return [Hash{Symbol=>String}]
|
@@ -2023,17 +2064,17 @@ module ModernTreasury
|
|
2023
2064
|
# #
|
2024
2065
|
# def initialize(amount:, accounting_category_id: nil, description: nil, metadata: nil, **) = super
|
2025
2066
|
|
2026
|
-
# def initialize: (Hash | ModernTreasury::BaseModel) -> void
|
2067
|
+
# def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
|
2027
2068
|
end
|
2028
2069
|
end
|
2029
2070
|
|
2030
|
-
class LedgerTransactionCreateRequest < ModernTreasury::BaseModel
|
2071
|
+
class LedgerTransactionCreateRequest < ModernTreasury::Internal::Type::BaseModel
|
2031
2072
|
# @!attribute ledger_entries
|
2032
2073
|
# An array of ledger entry objects.
|
2033
2074
|
#
|
2034
2075
|
# @return [Array<ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionCreateRequest::LedgerEntry>]
|
2035
2076
|
required :ledger_entries,
|
2036
|
-
-> { ModernTreasury::ArrayOf[ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionCreateRequest::LedgerEntry] }
|
2077
|
+
-> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionCreateRequest::LedgerEntry] }
|
2037
2078
|
|
2038
2079
|
# @!attribute description
|
2039
2080
|
# An optional description for internal use.
|
@@ -2043,7 +2084,7 @@ module ModernTreasury
|
|
2043
2084
|
|
2044
2085
|
# @!attribute [r] effective_at
|
2045
2086
|
# The timestamp (ISO8601 format) at which the ledger transaction happened for
|
2046
|
-
#
|
2087
|
+
# reporting purposes.
|
2047
2088
|
#
|
2048
2089
|
# @return [Time, nil]
|
2049
2090
|
optional :effective_at, Time
|
@@ -2054,7 +2095,7 @@ module ModernTreasury
|
|
2054
2095
|
|
2055
2096
|
# @!attribute [r] effective_date
|
2056
2097
|
# The date (YYYY-MM-DD) on which the ledger transaction happened for reporting
|
2057
|
-
#
|
2098
|
+
# purposes.
|
2058
2099
|
#
|
2059
2100
|
# @return [Date, nil]
|
2060
2101
|
optional :effective_date, Date
|
@@ -2065,7 +2106,7 @@ module ModernTreasury
|
|
2065
2106
|
|
2066
2107
|
# @!attribute [r] external_id
|
2067
2108
|
# A unique string to represent the ledger transaction. Only one pending or posted
|
2068
|
-
#
|
2109
|
+
# ledger transaction may have this ID in the ledger.
|
2069
2110
|
#
|
2070
2111
|
# @return [String, nil]
|
2071
2112
|
optional :external_id, String
|
@@ -2076,7 +2117,7 @@ module ModernTreasury
|
|
2076
2117
|
|
2077
2118
|
# @!attribute [r] ledgerable_id
|
2078
2119
|
# If the ledger transaction can be reconciled to another object in Modern
|
2079
|
-
#
|
2120
|
+
# Treasury, the id will be populated here, otherwise null.
|
2080
2121
|
#
|
2081
2122
|
# @return [String, nil]
|
2082
2123
|
optional :ledgerable_id, String
|
@@ -2087,9 +2128,9 @@ module ModernTreasury
|
|
2087
2128
|
|
2088
2129
|
# @!attribute [r] ledgerable_type
|
2089
2130
|
# If the ledger transaction can be reconciled to another object in Modern
|
2090
|
-
#
|
2091
|
-
#
|
2092
|
-
#
|
2131
|
+
# Treasury, the type will be populated here, otherwise null. This can be one of
|
2132
|
+
# payment_order, incoming_payment_detail, expected_payment, return, paper_item, or
|
2133
|
+
# reversal.
|
2093
2134
|
#
|
2094
2135
|
# @return [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionCreateRequest::LedgerableType, nil]
|
2095
2136
|
optional :ledgerable_type,
|
@@ -2101,10 +2142,10 @@ module ModernTreasury
|
|
2101
2142
|
|
2102
2143
|
# @!attribute [r] metadata
|
2103
2144
|
# Additional data represented as key-value pairs. Both the key and value must be
|
2104
|
-
#
|
2145
|
+
# strings.
|
2105
2146
|
#
|
2106
2147
|
# @return [Hash{Symbol=>String}, nil]
|
2107
|
-
optional :metadata, ModernTreasury::HashOf[String]
|
2148
|
+
optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
|
2108
2149
|
|
2109
2150
|
# @!parse
|
2110
2151
|
# # @return [Hash{Symbol=>String}]
|
@@ -2147,21 +2188,21 @@ module ModernTreasury
|
|
2147
2188
|
# super
|
2148
2189
|
# end
|
2149
2190
|
|
2150
|
-
# def initialize: (Hash | ModernTreasury::BaseModel) -> void
|
2191
|
+
# def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
|
2151
2192
|
|
2152
|
-
class LedgerEntry < ModernTreasury::BaseModel
|
2193
|
+
class LedgerEntry < ModernTreasury::Internal::Type::BaseModel
|
2153
2194
|
# @!attribute amount
|
2154
2195
|
# Value in specified currency's smallest unit. e.g. $10 would be represented
|
2155
|
-
#
|
2196
|
+
# as 1000. Can be any integer up to 36 digits.
|
2156
2197
|
#
|
2157
2198
|
# @return [Integer]
|
2158
2199
|
required :amount, Integer
|
2159
2200
|
|
2160
2201
|
# @!attribute direction
|
2161
2202
|
# One of `credit`, `debit`. Describes the direction money is flowing in the
|
2162
|
-
#
|
2163
|
-
#
|
2164
|
-
#
|
2203
|
+
# transaction. A `credit` moves money from your account to someone else's. A
|
2204
|
+
# `debit` pulls money from someone else's account to your own. Note that wire,
|
2205
|
+
# rtp, and check payments will always be `credit`.
|
2165
2206
|
#
|
2166
2207
|
# @return [Symbol, ModernTreasury::Models::TransactionDirection]
|
2167
2208
|
required :direction, enum: -> { ModernTreasury::Models::TransactionDirection }
|
@@ -2174,27 +2215,27 @@ module ModernTreasury
|
|
2174
2215
|
|
2175
2216
|
# @!attribute available_balance_amount
|
2176
2217
|
# Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
|
2177
|
-
#
|
2178
|
-
#
|
2218
|
+
# account’s available balance. If any of these conditions would be false after the
|
2219
|
+
# transaction is created, the entire call will fail with error code 422.
|
2179
2220
|
#
|
2180
2221
|
# @return [Hash{Symbol=>Integer}, nil]
|
2181
|
-
optional :available_balance_amount, ModernTreasury::HashOf[Integer], nil?: true
|
2222
|
+
optional :available_balance_amount, ModernTreasury::Internal::Type::HashOf[Integer], nil?: true
|
2182
2223
|
|
2183
2224
|
# @!attribute lock_version
|
2184
2225
|
# Lock version of the ledger account. This can be passed when creating a ledger
|
2185
|
-
#
|
2186
|
-
#
|
2187
|
-
#
|
2226
|
+
# transaction to only succeed if no ledger transactions have posted since the
|
2227
|
+
# given version. See our post about Designing the Ledgers API with Optimistic
|
2228
|
+
# Locking for more details.
|
2188
2229
|
#
|
2189
2230
|
# @return [Integer, nil]
|
2190
2231
|
optional :lock_version, Integer, nil?: true
|
2191
2232
|
|
2192
2233
|
# @!attribute [r] metadata
|
2193
2234
|
# Additional data represented as key-value pairs. Both the key and value must be
|
2194
|
-
#
|
2235
|
+
# strings.
|
2195
2236
|
#
|
2196
2237
|
# @return [Hash{Symbol=>String}, nil]
|
2197
|
-
optional :metadata, ModernTreasury::HashOf[String]
|
2238
|
+
optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
|
2198
2239
|
|
2199
2240
|
# @!parse
|
2200
2241
|
# # @return [Hash{Symbol=>String}]
|
@@ -2202,26 +2243,28 @@ module ModernTreasury
|
|
2202
2243
|
|
2203
2244
|
# @!attribute pending_balance_amount
|
2204
2245
|
# Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
|
2205
|
-
#
|
2206
|
-
#
|
2246
|
+
# account’s pending balance. If any of these conditions would be false after the
|
2247
|
+
# transaction is created, the entire call will fail with error code 422.
|
2207
2248
|
#
|
2208
2249
|
# @return [Hash{Symbol=>Integer}, nil]
|
2209
|
-
optional :pending_balance_amount, ModernTreasury::HashOf[Integer], nil?: true
|
2250
|
+
optional :pending_balance_amount, ModernTreasury::Internal::Type::HashOf[Integer], nil?: true
|
2210
2251
|
|
2211
2252
|
# @!attribute posted_balance_amount
|
2212
2253
|
# Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
|
2213
|
-
#
|
2214
|
-
#
|
2254
|
+
# account’s posted balance. If any of these conditions would be false after the
|
2255
|
+
# transaction is created, the entire call will fail with error code 422.
|
2215
2256
|
#
|
2216
2257
|
# @return [Hash{Symbol=>Integer}, nil]
|
2217
|
-
optional :posted_balance_amount, ModernTreasury::HashOf[Integer], nil?: true
|
2258
|
+
optional :posted_balance_amount, ModernTreasury::Internal::Type::HashOf[Integer], nil?: true
|
2218
2259
|
|
2219
2260
|
# @!attribute show_resulting_ledger_account_balances
|
2220
2261
|
# If true, response will include the balance of the associated ledger account for
|
2221
|
-
#
|
2262
|
+
# the entry.
|
2222
2263
|
#
|
2223
2264
|
# @return [Boolean, nil]
|
2224
|
-
optional :show_resulting_ledger_account_balances,
|
2265
|
+
optional :show_resulting_ledger_account_balances,
|
2266
|
+
ModernTreasury::Internal::Type::Boolean,
|
2267
|
+
nil?: true
|
2225
2268
|
|
2226
2269
|
# @!parse
|
2227
2270
|
# # @param amount [Integer]
|
@@ -2249,15 +2292,17 @@ module ModernTreasury
|
|
2249
2292
|
# super
|
2250
2293
|
# end
|
2251
2294
|
|
2252
|
-
# def initialize: (Hash | ModernTreasury::BaseModel) -> void
|
2295
|
+
# def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
|
2253
2296
|
end
|
2254
2297
|
|
2255
2298
|
# If the ledger transaction can be reconciled to another object in Modern
|
2256
|
-
#
|
2257
|
-
#
|
2258
|
-
#
|
2299
|
+
# Treasury, the type will be populated here, otherwise null. This can be one of
|
2300
|
+
# payment_order, incoming_payment_detail, expected_payment, return, paper_item, or
|
2301
|
+
# reversal.
|
2302
|
+
#
|
2303
|
+
# @see ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionCreateRequest#ledgerable_type
|
2259
2304
|
module LedgerableType
|
2260
|
-
extend ModernTreasury::Enum
|
2305
|
+
extend ModernTreasury::Internal::Type::Enum
|
2261
2306
|
|
2262
2307
|
EXPECTED_PAYMENT = :expected_payment
|
2263
2308
|
INCOMING_PAYMENT_DETAIL = :incoming_payment_detail
|
@@ -2274,8 +2319,10 @@ module ModernTreasury
|
|
2274
2319
|
end
|
2275
2320
|
|
2276
2321
|
# To post a ledger transaction at creation, use `posted`.
|
2322
|
+
#
|
2323
|
+
# @see ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionCreateRequest#status
|
2277
2324
|
module Status
|
2278
|
-
extend ModernTreasury::Enum
|
2325
|
+
extend ModernTreasury::Internal::Type::Enum
|
2279
2326
|
|
2280
2327
|
ARCHIVED = :archived
|
2281
2328
|
PENDING = :pending
|
@@ -2289,10 +2336,10 @@ module ModernTreasury
|
|
2289
2336
|
end
|
2290
2337
|
end
|
2291
2338
|
|
2292
|
-
class TransactionCreateRequest < ModernTreasury::BaseModel
|
2339
|
+
class TransactionCreateRequest < ModernTreasury::Internal::Type::BaseModel
|
2293
2340
|
# @!attribute amount
|
2294
2341
|
# Value in specified currency's smallest unit. e.g. $10 would be represented
|
2295
|
-
#
|
2342
|
+
# as 1000.
|
2296
2343
|
#
|
2297
2344
|
# @return [Integer]
|
2298
2345
|
required :amount, Integer
|
@@ -2317,26 +2364,26 @@ module ModernTreasury
|
|
2317
2364
|
|
2318
2365
|
# @!attribute vendor_code
|
2319
2366
|
# When applicable, the bank-given code that determines the transaction's category.
|
2320
|
-
#
|
2367
|
+
# For most banks this is the BAI2/BTRS transaction code.
|
2321
2368
|
#
|
2322
2369
|
# @return [String, nil]
|
2323
2370
|
required :vendor_code, String, nil?: true
|
2324
2371
|
|
2325
2372
|
# @!attribute vendor_code_type
|
2326
2373
|
# The type of `vendor_code` being reported. Can be one of `bai2`, `bankprov`,
|
2327
|
-
#
|
2328
|
-
#
|
2329
|
-
#
|
2374
|
+
# `bnk_dev`, `cleartouch`, `currencycloud`, `cross_river`, `dc_bank`, `dwolla`,
|
2375
|
+
# `evolve`, `goldman_sachs`, `iso20022`, `jpmc`, `mx`, `signet`, `silvergate`,
|
2376
|
+
# `swift`, `us_bank`, or others.
|
2330
2377
|
#
|
2331
2378
|
# @return [String, nil]
|
2332
2379
|
required :vendor_code_type, String, nil?: true
|
2333
2380
|
|
2334
2381
|
# @!attribute [r] metadata
|
2335
2382
|
# Additional data represented as key-value pairs. Both the key and value must be
|
2336
|
-
#
|
2383
|
+
# strings.
|
2337
2384
|
#
|
2338
2385
|
# @return [Hash{Symbol=>String}, nil]
|
2339
|
-
optional :metadata, ModernTreasury::HashOf[String]
|
2386
|
+
optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
|
2340
2387
|
|
2341
2388
|
# @!parse
|
2342
2389
|
# # @return [Hash{Symbol=>String}]
|
@@ -2346,7 +2393,7 @@ module ModernTreasury
|
|
2346
2393
|
# This field will be `true` if the transaction has posted to the account.
|
2347
2394
|
#
|
2348
2395
|
# @return [Boolean, nil]
|
2349
|
-
optional :posted, ModernTreasury::
|
2396
|
+
optional :posted, ModernTreasury::Internal::Type::Boolean
|
2350
2397
|
|
2351
2398
|
# @!parse
|
2352
2399
|
# # @return [Boolean]
|
@@ -2354,7 +2401,7 @@ module ModernTreasury
|
|
2354
2401
|
|
2355
2402
|
# @!attribute type
|
2356
2403
|
# The type of the transaction. Examples could be
|
2357
|
-
#
|
2404
|
+
# `card, `ach`, `wire`, `check`, `rtp`, `book`, or `sen`.
|
2358
2405
|
#
|
2359
2406
|
# @return [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::TransactionCreateRequest::Type, nil]
|
2360
2407
|
optional :type,
|
@@ -2363,7 +2410,7 @@ module ModernTreasury
|
|
2363
2410
|
|
2364
2411
|
# @!attribute vendor_description
|
2365
2412
|
# The transaction detail text that often appears in on your bank statement and in
|
2366
|
-
#
|
2413
|
+
# your banking portal.
|
2367
2414
|
#
|
2368
2415
|
# @return [String, nil]
|
2369
2416
|
optional :vendor_description, String, nil?: true
|
@@ -2396,12 +2443,14 @@ module ModernTreasury
|
|
2396
2443
|
# super
|
2397
2444
|
# end
|
2398
2445
|
|
2399
|
-
# def initialize: (Hash | ModernTreasury::BaseModel) -> void
|
2446
|
+
# def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
|
2400
2447
|
|
2401
2448
|
# The type of the transaction. Examples could be
|
2402
|
-
#
|
2449
|
+
# `card, `ach`, `wire`, `check`, `rtp`, `book`, or `sen`.
|
2450
|
+
#
|
2451
|
+
# @see ModernTreasury::Models::BulkRequestCreateParams::Resource::TransactionCreateRequest#type
|
2403
2452
|
module Type
|
2404
|
-
extend ModernTreasury::Enum
|
2453
|
+
extend ModernTreasury::Internal::Type::Enum
|
2405
2454
|
|
2406
2455
|
ACH = :ach
|
2407
2456
|
AU_BECS = :au_becs
|
@@ -2443,7 +2492,7 @@ module ModernTreasury
|
|
2443
2492
|
end
|
2444
2493
|
end
|
2445
2494
|
|
2446
|
-
class ID < ModernTreasury::BaseModel
|
2495
|
+
class ID < ModernTreasury::Internal::Type::BaseModel
|
2447
2496
|
# @!attribute [r] id
|
2448
2497
|
#
|
2449
2498
|
# @return [String, nil]
|
@@ -2458,10 +2507,10 @@ module ModernTreasury
|
|
2458
2507
|
# #
|
2459
2508
|
# def initialize(id: nil, **) = super
|
2460
2509
|
|
2461
|
-
# def initialize: (Hash | ModernTreasury::BaseModel) -> void
|
2510
|
+
# def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
|
2462
2511
|
end
|
2463
2512
|
|
2464
|
-
class PaymentOrderUpdateRequestWithID < ModernTreasury::BaseModel
|
2513
|
+
class PaymentOrderUpdateRequestWithID < ModernTreasury::Internal::Type::BaseModel
|
2465
2514
|
# @!attribute [r] id
|
2466
2515
|
#
|
2467
2516
|
# @return [String, nil]
|
@@ -2483,21 +2532,21 @@ module ModernTreasury
|
|
2483
2532
|
|
2484
2533
|
# @!attribute accounting_category_id
|
2485
2534
|
# The ID of one of your accounting categories. Note that these will only be
|
2486
|
-
#
|
2535
|
+
# accessible if your accounting system has been connected.
|
2487
2536
|
#
|
2488
2537
|
# @return [String, nil]
|
2489
2538
|
optional :accounting_category_id, String, nil?: true
|
2490
2539
|
|
2491
2540
|
# @!attribute accounting_ledger_class_id
|
2492
2541
|
# The ID of one of your accounting ledger classes. Note that these will only be
|
2493
|
-
#
|
2542
|
+
# accessible if your accounting system has been connected.
|
2494
2543
|
#
|
2495
2544
|
# @return [String, nil]
|
2496
2545
|
optional :accounting_ledger_class_id, String, nil?: true
|
2497
2546
|
|
2498
2547
|
# @!attribute [r] amount
|
2499
2548
|
# Value in specified currency's smallest unit. e.g. $10 would be represented as
|
2500
|
-
#
|
2549
|
+
# 1000 (cents). For RTP, the maximum amount allowed by the network is $100,000.
|
2501
2550
|
#
|
2502
2551
|
# @return [Integer, nil]
|
2503
2552
|
optional :amount, Integer
|
@@ -2508,8 +2557,8 @@ module ModernTreasury
|
|
2508
2557
|
|
2509
2558
|
# @!attribute charge_bearer
|
2510
2559
|
# The party that will pay the fees for the payment order. Only applies to wire
|
2511
|
-
#
|
2512
|
-
#
|
2560
|
+
# payment orders. Can be one of shared, sender, or receiver, which correspond
|
2561
|
+
# respectively with the SWIFT 71A values `SHA`, `OUR`, `BEN`.
|
2513
2562
|
#
|
2514
2563
|
# @return [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::ChargeBearer, nil]
|
2515
2564
|
optional :charge_bearer,
|
@@ -2540,9 +2589,9 @@ module ModernTreasury
|
|
2540
2589
|
|
2541
2590
|
# @!attribute [r] direction
|
2542
2591
|
# One of `credit`, `debit`. Describes the direction money is flowing in the
|
2543
|
-
#
|
2544
|
-
#
|
2545
|
-
#
|
2592
|
+
# transaction. A `credit` moves money from your account to someone else's. A
|
2593
|
+
# `debit` pulls money from someone else's account to your own. Note that wire,
|
2594
|
+
# rtp, and check payments will always be `credit`.
|
2546
2595
|
#
|
2547
2596
|
# @return [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::Direction, nil]
|
2548
2597
|
optional :direction,
|
@@ -2554,8 +2603,8 @@ module ModernTreasury
|
|
2554
2603
|
|
2555
2604
|
# @!attribute [r] effective_date
|
2556
2605
|
# Date transactions are to be posted to the participants' account. Defaults to the
|
2557
|
-
#
|
2558
|
-
#
|
2606
|
+
# current business day or the next business day if the current day is a bank
|
2607
|
+
# holiday or weekend. Format: yyyy-mm-dd.
|
2559
2608
|
#
|
2560
2609
|
# @return [Date, nil]
|
2561
2610
|
optional :effective_date, Date
|
@@ -2572,8 +2621,8 @@ module ModernTreasury
|
|
2572
2621
|
|
2573
2622
|
# @!attribute [r] fallback_type
|
2574
2623
|
# A payment type to fallback to if the original type is not valid for the
|
2575
|
-
#
|
2576
|
-
#
|
2624
|
+
# receiving account. Currently, this only supports falling back from RTP to ACH
|
2625
|
+
# (type=rtp and fallback_type=ach)
|
2577
2626
|
#
|
2578
2627
|
# @return [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::FallbackType, nil]
|
2579
2628
|
optional :fallback_type,
|
@@ -2585,15 +2634,15 @@ module ModernTreasury
|
|
2585
2634
|
|
2586
2635
|
# @!attribute foreign_exchange_contract
|
2587
2636
|
# If present, indicates a specific foreign exchange contract number that has been
|
2588
|
-
#
|
2637
|
+
# generated by your financial institution.
|
2589
2638
|
#
|
2590
2639
|
# @return [String, nil]
|
2591
2640
|
optional :foreign_exchange_contract, String, nil?: true
|
2592
2641
|
|
2593
2642
|
# @!attribute foreign_exchange_indicator
|
2594
2643
|
# Indicates the type of FX transfer to initiate, can be either
|
2595
|
-
#
|
2596
|
-
#
|
2644
|
+
# `variable_to_fixed`, `fixed_to_variable`, or `null` if the payment order
|
2645
|
+
# currency matches the originating account currency.
|
2597
2646
|
#
|
2598
2647
|
# @return [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::ForeignExchangeIndicator, nil]
|
2599
2648
|
optional :foreign_exchange_indicator,
|
@@ -2605,7 +2654,7 @@ module ModernTreasury
|
|
2605
2654
|
#
|
2606
2655
|
# @return [Array<ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::LineItem>, nil]
|
2607
2656
|
optional :line_items,
|
2608
|
-
-> { ModernTreasury::ArrayOf[ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::LineItem] }
|
2657
|
+
-> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::LineItem] }
|
2609
2658
|
|
2610
2659
|
# @!parse
|
2611
2660
|
# # @return [Array<ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::LineItem>]
|
@@ -2613,10 +2662,10 @@ module ModernTreasury
|
|
2613
2662
|
|
2614
2663
|
# @!attribute [r] metadata
|
2615
2664
|
# Additional data represented as key-value pairs. Both the key and value must be
|
2616
|
-
#
|
2665
|
+
# strings.
|
2617
2666
|
#
|
2618
2667
|
# @return [Hash{Symbol=>String}, nil]
|
2619
|
-
optional :metadata, ModernTreasury::HashOf[String]
|
2668
|
+
optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
|
2620
2669
|
|
2621
2670
|
# @!parse
|
2622
2671
|
# # @return [Hash{Symbol=>String}]
|
@@ -2624,10 +2673,10 @@ module ModernTreasury
|
|
2624
2673
|
|
2625
2674
|
# @!attribute [r] nsf_protected
|
2626
2675
|
# A boolean to determine if NSF Protection is enabled for this payment order. Note
|
2627
|
-
#
|
2676
|
+
# that this setting must also be turned on in your organization settings page.
|
2628
2677
|
#
|
2629
2678
|
# @return [Boolean, nil]
|
2630
|
-
optional :nsf_protected, ModernTreasury::
|
2679
|
+
optional :nsf_protected, ModernTreasury::Internal::Type::Boolean
|
2631
2680
|
|
2632
2681
|
# @!parse
|
2633
2682
|
# # @return [Boolean]
|
@@ -2645,17 +2694,17 @@ module ModernTreasury
|
|
2645
2694
|
|
2646
2695
|
# @!attribute originating_party_name
|
2647
2696
|
# If present, this will replace your default company name on receiver's bank
|
2648
|
-
#
|
2649
|
-
#
|
2650
|
-
#
|
2697
|
+
# statement. This field can only be used for ACH payments currently. For ACH, only
|
2698
|
+
# the first 16 characters of this string will be used. Any additional characters
|
2699
|
+
# will be truncated.
|
2651
2700
|
#
|
2652
2701
|
# @return [String, nil]
|
2653
2702
|
optional :originating_party_name, String, nil?: true
|
2654
2703
|
|
2655
2704
|
# @!attribute [r] priority
|
2656
2705
|
# Either `normal` or `high`. For ACH and EFT payments, `high` represents a
|
2657
|
-
#
|
2658
|
-
#
|
2706
|
+
# same-day ACH or EFT transfer, respectively. For check payments, `high` can mean
|
2707
|
+
# an overnight check rather than standard mail.
|
2659
2708
|
#
|
2660
2709
|
# @return [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::Priority, nil]
|
2661
2710
|
optional :priority,
|
@@ -2667,26 +2716,26 @@ module ModernTreasury
|
|
2667
2716
|
|
2668
2717
|
# @!attribute process_after
|
2669
2718
|
# If present, Modern Treasury will not process the payment until after this time.
|
2670
|
-
#
|
2671
|
-
#
|
2672
|
-
#
|
2673
|
-
#
|
2719
|
+
# If `process_after` is past the cutoff for `effective_date`, `process_after` will
|
2720
|
+
# take precedence and `effective_date` will automatically update to reflect the
|
2721
|
+
# earliest possible sending date after `process_after`. Format is ISO8601
|
2722
|
+
# timestamp.
|
2674
2723
|
#
|
2675
2724
|
# @return [Time, nil]
|
2676
2725
|
optional :process_after, Time, nil?: true
|
2677
2726
|
|
2678
2727
|
# @!attribute purpose
|
2679
2728
|
# For `wire`, this is usually the purpose which is transmitted via the
|
2680
|
-
#
|
2681
|
-
#
|
2729
|
+
# "InstrForDbtrAgt" field in the ISO20022 file. For `eft`, this field is the 3
|
2730
|
+
# digit CPA Code that will be attached to the payment.
|
2682
2731
|
#
|
2683
2732
|
# @return [String, nil]
|
2684
2733
|
optional :purpose, String, nil?: true
|
2685
2734
|
|
2686
2735
|
# @!attribute [r] receiving_account
|
2687
2736
|
# Either `receiving_account` or `receiving_account_id` must be present. When using
|
2688
|
-
#
|
2689
|
-
#
|
2737
|
+
# `receiving_account_id`, you may pass the id of an external account or an
|
2738
|
+
# internal account.
|
2690
2739
|
#
|
2691
2740
|
# @return [ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::ReceivingAccount, nil]
|
2692
2741
|
optional :receiving_account,
|
@@ -2698,8 +2747,8 @@ module ModernTreasury
|
|
2698
2747
|
|
2699
2748
|
# @!attribute [r] receiving_account_id
|
2700
2749
|
# Either `receiving_account` or `receiving_account_id` must be present. When using
|
2701
|
-
#
|
2702
|
-
#
|
2750
|
+
# `receiving_account_id`, you may pass the id of an external account or an
|
2751
|
+
# internal account.
|
2703
2752
|
#
|
2704
2753
|
# @return [String, nil]
|
2705
2754
|
optional :receiving_account_id, String
|
@@ -2710,34 +2759,34 @@ module ModernTreasury
|
|
2710
2759
|
|
2711
2760
|
# @!attribute remittance_information
|
2712
2761
|
# For `ach`, this field will be passed through on an addenda record. For `wire`
|
2713
|
-
#
|
2714
|
-
#
|
2762
|
+
# payments the field will be passed through as the "Originator to Beneficiary
|
2763
|
+
# Information", also known as OBI or Fedwire tag 6000.
|
2715
2764
|
#
|
2716
2765
|
# @return [String, nil]
|
2717
2766
|
optional :remittance_information, String, nil?: true
|
2718
2767
|
|
2719
2768
|
# @!attribute send_remittance_advice
|
2720
2769
|
# Send an email to the counterparty when the payment order is sent to the bank. If
|
2721
|
-
#
|
2770
|
+
# `null`, `send_remittance_advice` on the Counterparty is used.
|
2722
2771
|
#
|
2723
2772
|
# @return [Boolean, nil]
|
2724
|
-
optional :send_remittance_advice, ModernTreasury::
|
2773
|
+
optional :send_remittance_advice, ModernTreasury::Internal::Type::Boolean, nil?: true
|
2725
2774
|
|
2726
2775
|
# @!attribute statement_descriptor
|
2727
2776
|
# An optional descriptor which will appear in the receiver's statement. For
|
2728
|
-
#
|
2729
|
-
#
|
2730
|
-
#
|
2731
|
-
#
|
2732
|
-
#
|
2777
|
+
# `check` payments this field will be used as the memo line. For `ach` the maximum
|
2778
|
+
# length is 10 characters. Note that for ACH payments, the name on your bank
|
2779
|
+
# account will be included automatically by the bank, so you can use the
|
2780
|
+
# characters for other useful information. For `eft` the maximum length is 15
|
2781
|
+
# characters.
|
2733
2782
|
#
|
2734
2783
|
# @return [String, nil]
|
2735
2784
|
optional :statement_descriptor, String, nil?: true
|
2736
2785
|
|
2737
2786
|
# @!attribute [r] status
|
2738
2787
|
# To cancel a payment order, use `cancelled`. To redraft a returned payment order,
|
2739
|
-
#
|
2740
|
-
#
|
2788
|
+
# use `approved`. To undo approval on a denied or approved payment order, use
|
2789
|
+
# `needs_approval`.
|
2741
2790
|
#
|
2742
2791
|
# @return [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::Status, nil]
|
2743
2792
|
optional :status,
|
@@ -2749,17 +2798,17 @@ module ModernTreasury
|
|
2749
2798
|
|
2750
2799
|
# @!attribute subtype
|
2751
2800
|
# An additional layer of classification for the type of payment order you are
|
2752
|
-
#
|
2753
|
-
#
|
2754
|
-
#
|
2801
|
+
# doing. This field is only used for `ach` payment orders currently. For `ach`
|
2802
|
+
# payment orders, the `subtype` represents the SEC code. We currently support
|
2803
|
+
# `CCD`, `PPD`, `IAT`, `CTX`, `WEB`, `CIE`, and `TEL`.
|
2755
2804
|
#
|
2756
2805
|
# @return [Symbol, ModernTreasury::Models::PaymentOrderSubtype, nil]
|
2757
2806
|
optional :subtype, enum: -> { ModernTreasury::Models::PaymentOrderSubtype }, nil?: true
|
2758
2807
|
|
2759
2808
|
# @!attribute [r] type
|
2760
2809
|
# One of `ach`, `se_bankgirot`, `eft`, `wire`, `check`, `sen`, `book`, `rtp`,
|
2761
|
-
#
|
2762
|
-
#
|
2810
|
+
# `sepa`, `bacs`, `au_becs`, `interac`, `neft`, `nics`,
|
2811
|
+
# `nz_national_clearing_code`, `sic`, `signet`, `provexchange`, `zengin`.
|
2763
2812
|
#
|
2764
2813
|
# @return [Symbol, ModernTreasury::Models::PaymentOrderType, nil]
|
2765
2814
|
optional :type, enum: -> { ModernTreasury::Models::PaymentOrderType }
|
@@ -2770,32 +2819,32 @@ module ModernTreasury
|
|
2770
2819
|
|
2771
2820
|
# @!attribute ultimate_originating_party_identifier
|
2772
2821
|
# This represents the identifier by which the person is known to the receiver when
|
2773
|
-
#
|
2774
|
-
#
|
2822
|
+
# using the CIE subtype for ACH payments. Only the first 22 characters of this
|
2823
|
+
# string will be used. Any additional characters will be truncated.
|
2775
2824
|
#
|
2776
2825
|
# @return [String, nil]
|
2777
2826
|
optional :ultimate_originating_party_identifier, String, nil?: true
|
2778
2827
|
|
2779
2828
|
# @!attribute ultimate_originating_party_name
|
2780
2829
|
# This represents the name of the person that the payment is on behalf of when
|
2781
|
-
#
|
2782
|
-
#
|
2830
|
+
# using the CIE subtype for ACH payments. Only the first 15 characters of this
|
2831
|
+
# string will be used. Any additional characters will be truncated.
|
2783
2832
|
#
|
2784
2833
|
# @return [String, nil]
|
2785
2834
|
optional :ultimate_originating_party_name, String, nil?: true
|
2786
2835
|
|
2787
2836
|
# @!attribute ultimate_receiving_party_identifier
|
2788
2837
|
# This represents the name of the merchant that the payment is being sent to when
|
2789
|
-
#
|
2790
|
-
#
|
2838
|
+
# using the CIE subtype for ACH payments. Only the first 22 characters of this
|
2839
|
+
# string will be used. Any additional characters will be truncated.
|
2791
2840
|
#
|
2792
2841
|
# @return [String, nil]
|
2793
2842
|
optional :ultimate_receiving_party_identifier, String, nil?: true
|
2794
2843
|
|
2795
2844
|
# @!attribute ultimate_receiving_party_name
|
2796
2845
|
# This represents the identifier by which the merchant is known to the person
|
2797
|
-
#
|
2798
|
-
#
|
2846
|
+
# initiating an ACH payment with CIE subtype. Only the first 15 characters of this
|
2847
|
+
# string will be used. Any additional characters will be truncated.
|
2799
2848
|
#
|
2800
2849
|
# @return [String, nil]
|
2801
2850
|
optional :ultimate_receiving_party_name, String, nil?: true
|
@@ -2878,20 +2927,21 @@ module ModernTreasury
|
|
2878
2927
|
# super
|
2879
2928
|
# end
|
2880
2929
|
|
2881
|
-
# def initialize: (Hash | ModernTreasury::BaseModel) -> void
|
2930
|
+
# def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
|
2882
2931
|
|
2883
|
-
|
2932
|
+
# @see ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID#accounting
|
2933
|
+
class Accounting < ModernTreasury::Internal::Type::BaseModel
|
2884
2934
|
# @!attribute account_id
|
2885
2935
|
# The ID of one of your accounting categories. Note that these will only be
|
2886
|
-
#
|
2936
|
+
# accessible if your accounting system has been connected.
|
2887
2937
|
#
|
2888
2938
|
# @return [String, nil]
|
2889
2939
|
optional :account_id, String, nil?: true
|
2890
2940
|
|
2891
2941
|
# @!attribute class_id
|
2892
2942
|
# The ID of one of the class objects in your accounting system. Class objects
|
2893
|
-
#
|
2894
|
-
#
|
2943
|
+
# track segments of your business independent of client or project. Note that
|
2944
|
+
# these will only be accessible if your accounting system has been connected.
|
2895
2945
|
#
|
2896
2946
|
# @return [String, nil]
|
2897
2947
|
optional :class_id, String, nil?: true
|
@@ -2902,14 +2952,16 @@ module ModernTreasury
|
|
2902
2952
|
# #
|
2903
2953
|
# def initialize(account_id: nil, class_id: nil, **) = super
|
2904
2954
|
|
2905
|
-
# def initialize: (Hash | ModernTreasury::BaseModel) -> void
|
2955
|
+
# def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
|
2906
2956
|
end
|
2907
2957
|
|
2908
2958
|
# The party that will pay the fees for the payment order. Only applies to wire
|
2909
|
-
#
|
2910
|
-
#
|
2959
|
+
# payment orders. Can be one of shared, sender, or receiver, which correspond
|
2960
|
+
# respectively with the SWIFT 71A values `SHA`, `OUR`, `BEN`.
|
2961
|
+
#
|
2962
|
+
# @see ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID#charge_bearer
|
2911
2963
|
module ChargeBearer
|
2912
|
-
extend ModernTreasury::Enum
|
2964
|
+
extend ModernTreasury::Internal::Type::Enum
|
2913
2965
|
|
2914
2966
|
SHARED = :shared
|
2915
2967
|
SENDER = :sender
|
@@ -2923,11 +2975,13 @@ module ModernTreasury
|
|
2923
2975
|
end
|
2924
2976
|
|
2925
2977
|
# One of `credit`, `debit`. Describes the direction money is flowing in the
|
2926
|
-
#
|
2927
|
-
#
|
2928
|
-
#
|
2978
|
+
# transaction. A `credit` moves money from your account to someone else's. A
|
2979
|
+
# `debit` pulls money from someone else's account to your own. Note that wire,
|
2980
|
+
# rtp, and check payments will always be `credit`.
|
2981
|
+
#
|
2982
|
+
# @see ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID#direction
|
2929
2983
|
module Direction
|
2930
|
-
extend ModernTreasury::Enum
|
2984
|
+
extend ModernTreasury::Internal::Type::Enum
|
2931
2985
|
|
2932
2986
|
CREDIT = :credit
|
2933
2987
|
DEBIT = :debit
|
@@ -2940,10 +2994,12 @@ module ModernTreasury
|
|
2940
2994
|
end
|
2941
2995
|
|
2942
2996
|
# A payment type to fallback to if the original type is not valid for the
|
2943
|
-
#
|
2944
|
-
#
|
2997
|
+
# receiving account. Currently, this only supports falling back from RTP to ACH
|
2998
|
+
# (type=rtp and fallback_type=ach)
|
2999
|
+
#
|
3000
|
+
# @see ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID#fallback_type
|
2945
3001
|
module FallbackType
|
2946
|
-
extend ModernTreasury::Enum
|
3002
|
+
extend ModernTreasury::Internal::Type::Enum
|
2947
3003
|
|
2948
3004
|
ACH = :ach
|
2949
3005
|
|
@@ -2955,10 +3011,12 @@ module ModernTreasury
|
|
2955
3011
|
end
|
2956
3012
|
|
2957
3013
|
# Indicates the type of FX transfer to initiate, can be either
|
2958
|
-
#
|
2959
|
-
#
|
3014
|
+
# `variable_to_fixed`, `fixed_to_variable`, or `null` if the payment order
|
3015
|
+
# currency matches the originating account currency.
|
3016
|
+
#
|
3017
|
+
# @see ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID#foreign_exchange_indicator
|
2960
3018
|
module ForeignExchangeIndicator
|
2961
|
-
extend ModernTreasury::Enum
|
3019
|
+
extend ModernTreasury::Internal::Type::Enum
|
2962
3020
|
|
2963
3021
|
FIXED_TO_VARIABLE = :fixed_to_variable
|
2964
3022
|
VARIABLE_TO_FIXED = :variable_to_fixed
|
@@ -2970,17 +3028,17 @@ module ModernTreasury
|
|
2970
3028
|
# def self.values; end
|
2971
3029
|
end
|
2972
3030
|
|
2973
|
-
class LineItem < ModernTreasury::BaseModel
|
3031
|
+
class LineItem < ModernTreasury::Internal::Type::BaseModel
|
2974
3032
|
# @!attribute amount
|
2975
3033
|
# Value in specified currency's smallest unit. e.g. $10 would be represented
|
2976
|
-
#
|
3034
|
+
# as 1000.
|
2977
3035
|
#
|
2978
3036
|
# @return [Integer]
|
2979
3037
|
required :amount, Integer
|
2980
3038
|
|
2981
3039
|
# @!attribute accounting_category_id
|
2982
3040
|
# The ID of one of your accounting categories. Note that these will only be
|
2983
|
-
#
|
3041
|
+
# accessible if your accounting system has been connected.
|
2984
3042
|
#
|
2985
3043
|
# @return [String, nil]
|
2986
3044
|
optional :accounting_category_id, String, nil?: true
|
@@ -2993,10 +3051,10 @@ module ModernTreasury
|
|
2993
3051
|
|
2994
3052
|
# @!attribute [r] metadata
|
2995
3053
|
# Additional data represented as key-value pairs. Both the key and value must be
|
2996
|
-
#
|
3054
|
+
# strings.
|
2997
3055
|
#
|
2998
3056
|
# @return [Hash{Symbol=>String}, nil]
|
2999
|
-
optional :metadata, ModernTreasury::HashOf[String]
|
3057
|
+
optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
|
3000
3058
|
|
3001
3059
|
# @!parse
|
3002
3060
|
# # @return [Hash{Symbol=>String}]
|
@@ -3010,14 +3068,16 @@ module ModernTreasury
|
|
3010
3068
|
# #
|
3011
3069
|
# def initialize(amount:, accounting_category_id: nil, description: nil, metadata: nil, **) = super
|
3012
3070
|
|
3013
|
-
# def initialize: (Hash | ModernTreasury::BaseModel) -> void
|
3071
|
+
# def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
|
3014
3072
|
end
|
3015
3073
|
|
3016
3074
|
# Either `normal` or `high`. For ACH and EFT payments, `high` represents a
|
3017
|
-
#
|
3018
|
-
#
|
3075
|
+
# same-day ACH or EFT transfer, respectively. For check payments, `high` can mean
|
3076
|
+
# an overnight check rather than standard mail.
|
3077
|
+
#
|
3078
|
+
# @see ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID#priority
|
3019
3079
|
module Priority
|
3020
|
-
extend ModernTreasury::Enum
|
3080
|
+
extend ModernTreasury::Internal::Type::Enum
|
3021
3081
|
|
3022
3082
|
HIGH = :high
|
3023
3083
|
NORMAL = :normal
|
@@ -3029,14 +3089,15 @@ module ModernTreasury
|
|
3029
3089
|
# def self.values; end
|
3030
3090
|
end
|
3031
3091
|
|
3032
|
-
|
3092
|
+
# @see ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID#receiving_account
|
3093
|
+
class ReceivingAccount < ModernTreasury::Internal::Type::BaseModel
|
3033
3094
|
# @!attribute [r] account_details
|
3034
3095
|
#
|
3035
3096
|
# @return [Array<ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::ReceivingAccount::AccountDetail>, nil]
|
3036
3097
|
optional :account_details,
|
3037
3098
|
-> do
|
3038
|
-
ModernTreasury::ArrayOf[
|
3039
|
-
|
3099
|
+
ModernTreasury::Internal::Type::ArrayOf[
|
3100
|
+
ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::ReceivingAccount::AccountDetail
|
3040
3101
|
]
|
3041
3102
|
end
|
3042
3103
|
|
@@ -3059,8 +3120,8 @@ module ModernTreasury
|
|
3059
3120
|
# @return [Array<ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::ReceivingAccount::ContactDetail>, nil]
|
3060
3121
|
optional :contact_details,
|
3061
3122
|
-> do
|
3062
|
-
ModernTreasury::ArrayOf[
|
3063
|
-
|
3123
|
+
ModernTreasury::Internal::Type::ArrayOf[
|
3124
|
+
ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::ReceivingAccount::ContactDetail
|
3064
3125
|
]
|
3065
3126
|
end
|
3066
3127
|
|
@@ -3070,10 +3131,10 @@ module ModernTreasury
|
|
3070
3131
|
|
3071
3132
|
# @!attribute [r] ledger_account
|
3072
3133
|
# Specifies a ledger account object that will be created with the external
|
3073
|
-
#
|
3074
|
-
#
|
3075
|
-
#
|
3076
|
-
#
|
3134
|
+
# account. The resulting ledger account is linked to the external account for
|
3135
|
+
# auto-ledgering Payment objects. See
|
3136
|
+
# https://docs.moderntreasury.com/docs/linking-to-other-modern-treasury-objects
|
3137
|
+
# for more details.
|
3077
3138
|
#
|
3078
3139
|
# @return [ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::ReceivingAccount::LedgerAccount, nil]
|
3079
3140
|
optional :ledger_account,
|
@@ -3085,10 +3146,10 @@ module ModernTreasury
|
|
3085
3146
|
|
3086
3147
|
# @!attribute [r] metadata
|
3087
3148
|
# Additional data represented as key-value pairs. Both the key and value must be
|
3088
|
-
#
|
3149
|
+
# strings.
|
3089
3150
|
#
|
3090
3151
|
# @return [Hash{Symbol=>String}, nil]
|
3091
|
-
optional :metadata, ModernTreasury::HashOf[String]
|
3152
|
+
optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
|
3092
3153
|
|
3093
3154
|
# @!parse
|
3094
3155
|
# # @return [Hash{Symbol=>String}]
|
@@ -3096,7 +3157,7 @@ module ModernTreasury
|
|
3096
3157
|
|
3097
3158
|
# @!attribute name
|
3098
3159
|
# A nickname for the external account. This is only for internal usage and won't
|
3099
|
-
#
|
3160
|
+
# affect any payments
|
3100
3161
|
#
|
3101
3162
|
# @return [String, nil]
|
3102
3163
|
optional :name, String, nil?: true
|
@@ -3141,7 +3202,7 @@ module ModernTreasury
|
|
3141
3202
|
|
3142
3203
|
# @!attribute [r] plaid_processor_token
|
3143
3204
|
# If you've enabled the Modern Treasury + Plaid integration in your Plaid account,
|
3144
|
-
#
|
3205
|
+
# you can pass the processor token in this field.
|
3145
3206
|
#
|
3146
3207
|
# @return [String, nil]
|
3147
3208
|
optional :plaid_processor_token, String
|
@@ -3155,8 +3216,8 @@ module ModernTreasury
|
|
3155
3216
|
# @return [Array<ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::ReceivingAccount::RoutingDetail>, nil]
|
3156
3217
|
optional :routing_details,
|
3157
3218
|
-> do
|
3158
|
-
ModernTreasury::ArrayOf[
|
3159
|
-
|
3219
|
+
ModernTreasury::Internal::Type::ArrayOf[
|
3220
|
+
ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::ReceivingAccount::RoutingDetail
|
3160
3221
|
]
|
3161
3222
|
end
|
3162
3223
|
|
@@ -3166,8 +3227,8 @@ module ModernTreasury
|
|
3166
3227
|
|
3167
3228
|
# @!parse
|
3168
3229
|
# # Either `receiving_account` or `receiving_account_id` must be present. When using
|
3169
|
-
# #
|
3170
|
-
# #
|
3230
|
+
# # `receiving_account_id`, you may pass the id of an external account or an
|
3231
|
+
# # internal account.
|
3171
3232
|
# #
|
3172
3233
|
# # @param account_details [Array<ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::ReceivingAccount::AccountDetail>]
|
3173
3234
|
# # @param account_type [Symbol, ModernTreasury::Models::ExternalAccountType]
|
@@ -3200,9 +3261,9 @@ module ModernTreasury
|
|
3200
3261
|
# super
|
3201
3262
|
# end
|
3202
3263
|
|
3203
|
-
# def initialize: (Hash | ModernTreasury::BaseModel) -> void
|
3264
|
+
# def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
|
3204
3265
|
|
3205
|
-
class AccountDetail < ModernTreasury::BaseModel
|
3266
|
+
class AccountDetail < ModernTreasury::Internal::Type::BaseModel
|
3206
3267
|
# @!attribute account_number
|
3207
3268
|
#
|
3208
3269
|
# @return [String]
|
@@ -3224,10 +3285,11 @@ module ModernTreasury
|
|
3224
3285
|
# #
|
3225
3286
|
# def initialize(account_number:, account_number_type: nil, **) = super
|
3226
3287
|
|
3227
|
-
# def initialize: (Hash | ModernTreasury::BaseModel) -> void
|
3288
|
+
# def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
|
3228
3289
|
|
3290
|
+
# @see ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::ReceivingAccount::AccountDetail#account_number_type
|
3229
3291
|
module AccountNumberType
|
3230
|
-
extend ModernTreasury::Enum
|
3292
|
+
extend ModernTreasury::Internal::Type::Enum
|
3231
3293
|
|
3232
3294
|
AU_NUMBER = :au_number
|
3233
3295
|
CLABE = :clabe
|
@@ -3248,7 +3310,7 @@ module ModernTreasury
|
|
3248
3310
|
end
|
3249
3311
|
end
|
3250
3312
|
|
3251
|
-
class ContactDetail < ModernTreasury::BaseModel
|
3313
|
+
class ContactDetail < ModernTreasury::Internal::Type::BaseModel
|
3252
3314
|
# @!attribute [r] contact_identifier
|
3253
3315
|
#
|
3254
3316
|
# @return [String, nil]
|
@@ -3274,10 +3336,11 @@ module ModernTreasury
|
|
3274
3336
|
# #
|
3275
3337
|
# def initialize(contact_identifier: nil, contact_identifier_type: nil, **) = super
|
3276
3338
|
|
3277
|
-
# def initialize: (Hash | ModernTreasury::BaseModel) -> void
|
3339
|
+
# def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
|
3278
3340
|
|
3341
|
+
# @see ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::ReceivingAccount::ContactDetail#contact_identifier_type
|
3279
3342
|
module ContactIdentifierType
|
3280
|
-
extend ModernTreasury::Enum
|
3343
|
+
extend ModernTreasury::Internal::Type::Enum
|
3281
3344
|
|
3282
3345
|
EMAIL = :email
|
3283
3346
|
PHONE_NUMBER = :phone_number
|
@@ -3291,7 +3354,8 @@ module ModernTreasury
|
|
3291
3354
|
end
|
3292
3355
|
end
|
3293
3356
|
|
3294
|
-
|
3357
|
+
# @see ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::ReceivingAccount#ledger_account
|
3358
|
+
class LedgerAccount < ModernTreasury::Internal::Type::BaseModel
|
3295
3359
|
# @!attribute currency
|
3296
3360
|
# The currency of the ledger account.
|
3297
3361
|
#
|
@@ -3330,10 +3394,10 @@ module ModernTreasury
|
|
3330
3394
|
|
3331
3395
|
# @!attribute [r] ledger_account_category_ids
|
3332
3396
|
# The array of ledger account category ids that this ledger account should be a
|
3333
|
-
#
|
3397
|
+
# child of.
|
3334
3398
|
#
|
3335
3399
|
# @return [Array<String>, nil]
|
3336
|
-
optional :ledger_account_category_ids, ModernTreasury::ArrayOf[String]
|
3400
|
+
optional :ledger_account_category_ids, ModernTreasury::Internal::Type::ArrayOf[String]
|
3337
3401
|
|
3338
3402
|
# @!parse
|
3339
3403
|
# # @return [Array<String>]
|
@@ -3341,7 +3405,7 @@ module ModernTreasury
|
|
3341
3405
|
|
3342
3406
|
# @!attribute [r] ledgerable_id
|
3343
3407
|
# If the ledger account links to another object in Modern Treasury, the id will be
|
3344
|
-
#
|
3408
|
+
# populated here, otherwise null.
|
3345
3409
|
#
|
3346
3410
|
# @return [String, nil]
|
3347
3411
|
optional :ledgerable_id, String
|
@@ -3352,8 +3416,8 @@ module ModernTreasury
|
|
3352
3416
|
|
3353
3417
|
# @!attribute [r] ledgerable_type
|
3354
3418
|
# If the ledger account links to another object in Modern Treasury, the type will
|
3355
|
-
#
|
3356
|
-
#
|
3419
|
+
# be populated here, otherwise null. The value is one of internal_account or
|
3420
|
+
# external_account.
|
3357
3421
|
#
|
3358
3422
|
# @return [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::ReceivingAccount::LedgerAccount::LedgerableType, nil]
|
3359
3423
|
optional :ledgerable_type,
|
@@ -3365,10 +3429,10 @@ module ModernTreasury
|
|
3365
3429
|
|
3366
3430
|
# @!attribute [r] metadata
|
3367
3431
|
# Additional data represented as key-value pairs. Both the key and value must be
|
3368
|
-
#
|
3432
|
+
# strings.
|
3369
3433
|
#
|
3370
3434
|
# @return [Hash{Symbol=>String}, nil]
|
3371
|
-
optional :metadata, ModernTreasury::HashOf[String]
|
3435
|
+
optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
|
3372
3436
|
|
3373
3437
|
# @!parse
|
3374
3438
|
# # @return [Hash{Symbol=>String}]
|
@@ -3376,10 +3440,10 @@ module ModernTreasury
|
|
3376
3440
|
|
3377
3441
|
# @!parse
|
3378
3442
|
# # Specifies a ledger account object that will be created with the external
|
3379
|
-
# #
|
3380
|
-
# #
|
3381
|
-
# #
|
3382
|
-
# #
|
3443
|
+
# # account. The resulting ledger account is linked to the external account for
|
3444
|
+
# # auto-ledgering Payment objects. See
|
3445
|
+
# # https://docs.moderntreasury.com/docs/linking-to-other-modern-treasury-objects
|
3446
|
+
# # for more details.
|
3383
3447
|
# #
|
3384
3448
|
# # @param currency [String]
|
3385
3449
|
# # @param ledger_id [String]
|
@@ -3408,13 +3472,15 @@ module ModernTreasury
|
|
3408
3472
|
# super
|
3409
3473
|
# end
|
3410
3474
|
|
3411
|
-
# def initialize: (Hash | ModernTreasury::BaseModel) -> void
|
3475
|
+
# def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
|
3412
3476
|
|
3413
3477
|
# If the ledger account links to another object in Modern Treasury, the type will
|
3414
|
-
#
|
3415
|
-
#
|
3478
|
+
# be populated here, otherwise null. The value is one of internal_account or
|
3479
|
+
# external_account.
|
3480
|
+
#
|
3481
|
+
# @see ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::ReceivingAccount::LedgerAccount#ledgerable_type
|
3416
3482
|
module LedgerableType
|
3417
|
-
extend ModernTreasury::Enum
|
3483
|
+
extend ModernTreasury::Internal::Type::Enum
|
3418
3484
|
|
3419
3485
|
COUNTERPARTY = :counterparty
|
3420
3486
|
EXTERNAL_ACCOUNT = :external_account
|
@@ -3429,7 +3495,8 @@ module ModernTreasury
|
|
3429
3495
|
end
|
3430
3496
|
end
|
3431
3497
|
|
3432
|
-
|
3498
|
+
# @see ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::ReceivingAccount#party_address
|
3499
|
+
class PartyAddress < ModernTreasury::Internal::Type::BaseModel
|
3433
3500
|
# @!attribute country
|
3434
3501
|
# Country code conforms to [ISO 3166-1 alpha-2]
|
3435
3502
|
#
|
@@ -3476,12 +3543,14 @@ module ModernTreasury
|
|
3476
3543
|
# #
|
3477
3544
|
# def initialize(country: nil, line1: nil, line2: nil, locality: nil, postal_code: nil, region: nil, **) = super
|
3478
3545
|
|
3479
|
-
# def initialize: (Hash | ModernTreasury::BaseModel) -> void
|
3546
|
+
# def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
|
3480
3547
|
end
|
3481
3548
|
|
3482
3549
|
# Either `individual` or `business`.
|
3550
|
+
#
|
3551
|
+
# @see ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::ReceivingAccount#party_type
|
3483
3552
|
module PartyType
|
3484
|
-
extend ModernTreasury::Enum
|
3553
|
+
extend ModernTreasury::Internal::Type::Enum
|
3485
3554
|
|
3486
3555
|
BUSINESS = :business
|
3487
3556
|
INDIVIDUAL = :individual
|
@@ -3493,7 +3562,7 @@ module ModernTreasury
|
|
3493
3562
|
# def self.values; end
|
3494
3563
|
end
|
3495
3564
|
|
3496
|
-
class RoutingDetail < ModernTreasury::BaseModel
|
3565
|
+
class RoutingDetail < ModernTreasury::Internal::Type::BaseModel
|
3497
3566
|
# @!attribute routing_number
|
3498
3567
|
#
|
3499
3568
|
# @return [String]
|
@@ -3522,10 +3591,11 @@ module ModernTreasury
|
|
3522
3591
|
# #
|
3523
3592
|
# def initialize(routing_number:, routing_number_type:, payment_type: nil, **) = super
|
3524
3593
|
|
3525
|
-
# def initialize: (Hash | ModernTreasury::BaseModel) -> void
|
3594
|
+
# def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
|
3526
3595
|
|
3596
|
+
# @see ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::ReceivingAccount::RoutingDetail#routing_number_type
|
3527
3597
|
module RoutingNumberType
|
3528
|
-
extend ModernTreasury::Enum
|
3598
|
+
extend ModernTreasury::Internal::Type::Enum
|
3529
3599
|
|
3530
3600
|
ABA = :aba
|
3531
3601
|
AU_BSB = :au_bsb
|
@@ -3556,8 +3626,9 @@ module ModernTreasury
|
|
3556
3626
|
# def self.values; end
|
3557
3627
|
end
|
3558
3628
|
|
3629
|
+
# @see ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::ReceivingAccount::RoutingDetail#payment_type
|
3559
3630
|
module PaymentType
|
3560
|
-
extend ModernTreasury::Enum
|
3631
|
+
extend ModernTreasury::Internal::Type::Enum
|
3561
3632
|
|
3562
3633
|
ACH = :ach
|
3563
3634
|
AU_BECS = :au_becs
|
@@ -3600,10 +3671,12 @@ module ModernTreasury
|
|
3600
3671
|
end
|
3601
3672
|
|
3602
3673
|
# To cancel a payment order, use `cancelled`. To redraft a returned payment order,
|
3603
|
-
#
|
3604
|
-
#
|
3674
|
+
# use `approved`. To undo approval on a denied or approved payment order, use
|
3675
|
+
# `needs_approval`.
|
3676
|
+
#
|
3677
|
+
# @see ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID#status
|
3605
3678
|
module Status
|
3606
|
-
extend ModernTreasury::Enum
|
3679
|
+
extend ModernTreasury::Internal::Type::Enum
|
3607
3680
|
|
3608
3681
|
APPROVED = :approved
|
3609
3682
|
CANCELLED = :cancelled
|
@@ -3625,7 +3698,7 @@ module ModernTreasury
|
|
3625
3698
|
end
|
3626
3699
|
end
|
3627
3700
|
|
3628
|
-
class ExpectedPaymentUpdateRequestWithID < ModernTreasury::BaseModel
|
3701
|
+
class ExpectedPaymentUpdateRequestWithID < ModernTreasury::Internal::Type::BaseModel
|
3629
3702
|
# @!attribute [r] id
|
3630
3703
|
#
|
3631
3704
|
# @return [String, nil]
|
@@ -3637,14 +3710,14 @@ module ModernTreasury
|
|
3637
3710
|
|
3638
3711
|
# @!attribute amount_lower_bound
|
3639
3712
|
# The lowest amount this expected payment may be equal to. Value in specified
|
3640
|
-
#
|
3713
|
+
# currency's smallest unit. e.g. $10 would be represented as 1000.
|
3641
3714
|
#
|
3642
3715
|
# @return [Integer, nil]
|
3643
3716
|
optional :amount_lower_bound, Integer, nil?: true
|
3644
3717
|
|
3645
3718
|
# @!attribute amount_upper_bound
|
3646
3719
|
# The highest amount this expected payment may be equal to. Value in specified
|
3647
|
-
#
|
3720
|
+
# currency's smallest unit. e.g. $10 would be represented as 1000.
|
3648
3721
|
#
|
3649
3722
|
# @return [Integer, nil]
|
3650
3723
|
optional :amount_upper_bound, Integer, nil?: true
|
@@ -3681,7 +3754,7 @@ module ModernTreasury
|
|
3681
3754
|
|
3682
3755
|
# @!attribute direction
|
3683
3756
|
# One of credit or debit. When you are receiving money, use credit. When you are
|
3684
|
-
#
|
3757
|
+
# being charged, use debit.
|
3685
3758
|
#
|
3686
3759
|
# @return [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentUpdateRequestWithID::Direction, nil]
|
3687
3760
|
optional :direction,
|
@@ -3696,10 +3769,10 @@ module ModernTreasury
|
|
3696
3769
|
|
3697
3770
|
# @!attribute [r] metadata
|
3698
3771
|
# Additional data represented as key-value pairs. Both the key and value must be
|
3699
|
-
#
|
3772
|
+
# strings.
|
3700
3773
|
#
|
3701
3774
|
# @return [Hash{Symbol=>String}, nil]
|
3702
|
-
optional :metadata, ModernTreasury::HashOf[String]
|
3775
|
+
optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
|
3703
3776
|
|
3704
3777
|
# @!parse
|
3705
3778
|
# # @return [Hash{Symbol=>String}]
|
@@ -3709,42 +3782,42 @@ module ModernTreasury
|
|
3709
3782
|
# The reconciliation filters you have for this payment.
|
3710
3783
|
#
|
3711
3784
|
# @return [Object, nil]
|
3712
|
-
optional :reconciliation_filters, ModernTreasury::Unknown, nil?: true
|
3785
|
+
optional :reconciliation_filters, ModernTreasury::Internal::Type::Unknown, nil?: true
|
3713
3786
|
|
3714
3787
|
# @!attribute reconciliation_groups
|
3715
3788
|
# The reconciliation groups you have for this payment.
|
3716
3789
|
#
|
3717
3790
|
# @return [Object, nil]
|
3718
|
-
optional :reconciliation_groups, ModernTreasury::Unknown, nil?: true
|
3791
|
+
optional :reconciliation_groups, ModernTreasury::Internal::Type::Unknown, nil?: true
|
3719
3792
|
|
3720
3793
|
# @!attribute reconciliation_rule_variables
|
3721
3794
|
# An array of reconciliation rule variables for this payment.
|
3722
3795
|
#
|
3723
3796
|
# @return [Array<ModernTreasury::Models::ReconciliationRule>, nil]
|
3724
3797
|
optional :reconciliation_rule_variables,
|
3725
|
-
-> { ModernTreasury::ArrayOf[ModernTreasury::Models::ReconciliationRule] },
|
3798
|
+
-> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::ReconciliationRule] },
|
3726
3799
|
nil?: true
|
3727
3800
|
|
3728
3801
|
# @!attribute remittance_information
|
3729
3802
|
# For `ach`, this field will be passed through on an addenda record. For `wire`
|
3730
|
-
#
|
3731
|
-
#
|
3803
|
+
# payments the field will be passed through as the "Originator to Beneficiary
|
3804
|
+
# Information", also known as OBI or Fedwire tag 6000.
|
3732
3805
|
#
|
3733
3806
|
# @return [String, nil]
|
3734
3807
|
optional :remittance_information, String, nil?: true
|
3735
3808
|
|
3736
3809
|
# @!attribute statement_descriptor
|
3737
3810
|
# The statement description you expect to see on the transaction. For ACH
|
3738
|
-
#
|
3739
|
-
#
|
3740
|
-
#
|
3811
|
+
# payments, this will be the full line item passed from the bank. For wire
|
3812
|
+
# payments, this will be the OBI field on the wire. For check payments, this will
|
3813
|
+
# be the memo field.
|
3741
3814
|
#
|
3742
3815
|
# @return [String, nil]
|
3743
3816
|
optional :statement_descriptor, String, nil?: true
|
3744
3817
|
|
3745
3818
|
# @!attribute status
|
3746
3819
|
# The Expected Payment's status can be updated from partially_reconciled to
|
3747
|
-
#
|
3820
|
+
# reconciled.
|
3748
3821
|
#
|
3749
3822
|
# @return [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentUpdateRequestWithID::Status, nil]
|
3750
3823
|
optional :status,
|
@@ -3753,7 +3826,7 @@ module ModernTreasury
|
|
3753
3826
|
|
3754
3827
|
# @!attribute type
|
3755
3828
|
# One of: ach, au_becs, bacs, book, check, eft, interac, provxchange, rtp, sen,
|
3756
|
-
#
|
3829
|
+
# sepa, signet, wire.
|
3757
3830
|
#
|
3758
3831
|
# @return [Symbol, ModernTreasury::Models::ExpectedPaymentType, nil]
|
3759
3832
|
optional :type, enum: -> { ModernTreasury::Models::ExpectedPaymentType }, nil?: true
|
@@ -3802,12 +3875,14 @@ module ModernTreasury
|
|
3802
3875
|
# super
|
3803
3876
|
# end
|
3804
3877
|
|
3805
|
-
# def initialize: (Hash | ModernTreasury::BaseModel) -> void
|
3878
|
+
# def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
|
3806
3879
|
|
3807
3880
|
# One of credit or debit. When you are receiving money, use credit. When you are
|
3808
|
-
#
|
3881
|
+
# being charged, use debit.
|
3882
|
+
#
|
3883
|
+
# @see ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentUpdateRequestWithID#direction
|
3809
3884
|
module Direction
|
3810
|
-
extend ModernTreasury::Enum
|
3885
|
+
extend ModernTreasury::Internal::Type::Enum
|
3811
3886
|
|
3812
3887
|
CREDIT = :credit
|
3813
3888
|
DEBIT = :debit
|
@@ -3820,9 +3895,11 @@ module ModernTreasury
|
|
3820
3895
|
end
|
3821
3896
|
|
3822
3897
|
# The Expected Payment's status can be updated from partially_reconciled to
|
3823
|
-
#
|
3898
|
+
# reconciled.
|
3899
|
+
#
|
3900
|
+
# @see ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentUpdateRequestWithID#status
|
3824
3901
|
module Status
|
3825
|
-
extend ModernTreasury::Enum
|
3902
|
+
extend ModernTreasury::Internal::Type::Enum
|
3826
3903
|
|
3827
3904
|
RECONCILED = :reconciled
|
3828
3905
|
|
@@ -3834,7 +3911,7 @@ module ModernTreasury
|
|
3834
3911
|
end
|
3835
3912
|
end
|
3836
3913
|
|
3837
|
-
class TransactionUpdateRequestWithID < ModernTreasury::BaseModel
|
3914
|
+
class TransactionUpdateRequestWithID < ModernTreasury::Internal::Type::BaseModel
|
3838
3915
|
# @!attribute [r] id
|
3839
3916
|
#
|
3840
3917
|
# @return [String, nil]
|
@@ -3846,10 +3923,10 @@ module ModernTreasury
|
|
3846
3923
|
|
3847
3924
|
# @!attribute [r] metadata
|
3848
3925
|
# Additional data in the form of key-value pairs. Pairs can be removed by passing
|
3849
|
-
#
|
3926
|
+
# an empty string or `null` as the value.
|
3850
3927
|
#
|
3851
3928
|
# @return [Hash{Symbol=>String}, nil]
|
3852
|
-
optional :metadata, ModernTreasury::HashOf[String]
|
3929
|
+
optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
|
3853
3930
|
|
3854
3931
|
# @!parse
|
3855
3932
|
# # @return [Hash{Symbol=>String}]
|
@@ -3861,10 +3938,10 @@ module ModernTreasury
|
|
3861
3938
|
# #
|
3862
3939
|
# def initialize(id: nil, metadata: nil, **) = super
|
3863
3940
|
|
3864
|
-
# def initialize: (Hash | ModernTreasury::BaseModel) -> void
|
3941
|
+
# def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
|
3865
3942
|
end
|
3866
3943
|
|
3867
|
-
class LedgerTransactionUpdateRequestWithID < ModernTreasury::BaseModel
|
3944
|
+
class LedgerTransactionUpdateRequestWithID < ModernTreasury::Internal::Type::BaseModel
|
3868
3945
|
# @!attribute [r] id
|
3869
3946
|
#
|
3870
3947
|
# @return [String, nil]
|
@@ -3882,7 +3959,7 @@ module ModernTreasury
|
|
3882
3959
|
|
3883
3960
|
# @!attribute [r] effective_at
|
3884
3961
|
# The timestamp (ISO8601 format) at which the ledger transaction happened for
|
3885
|
-
#
|
3962
|
+
# reporting purposes.
|
3886
3963
|
#
|
3887
3964
|
# @return [Time, nil]
|
3888
3965
|
optional :effective_at, Time
|
@@ -3897,8 +3974,8 @@ module ModernTreasury
|
|
3897
3974
|
# @return [Array<ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionUpdateRequestWithID::LedgerEntry>, nil]
|
3898
3975
|
optional :ledger_entries,
|
3899
3976
|
-> do
|
3900
|
-
ModernTreasury::ArrayOf[
|
3901
|
-
|
3977
|
+
ModernTreasury::Internal::Type::ArrayOf[
|
3978
|
+
ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionUpdateRequestWithID::LedgerEntry
|
3902
3979
|
]
|
3903
3980
|
end
|
3904
3981
|
|
@@ -3908,7 +3985,7 @@ module ModernTreasury
|
|
3908
3985
|
|
3909
3986
|
# @!attribute [r] ledgerable_id
|
3910
3987
|
# If the ledger transaction can be reconciled to another object in Modern
|
3911
|
-
#
|
3988
|
+
# Treasury, the id will be populated here, otherwise null.
|
3912
3989
|
#
|
3913
3990
|
# @return [String, nil]
|
3914
3991
|
optional :ledgerable_id, String
|
@@ -3919,9 +3996,9 @@ module ModernTreasury
|
|
3919
3996
|
|
3920
3997
|
# @!attribute [r] ledgerable_type
|
3921
3998
|
# If the ledger transaction can be reconciled to another object in Modern
|
3922
|
-
#
|
3923
|
-
#
|
3924
|
-
#
|
3999
|
+
# Treasury, the type will be populated here, otherwise null. This can be one of
|
4000
|
+
# payment_order, incoming_payment_detail, expected_payment, return, paper_item, or
|
4001
|
+
# reversal.
|
3925
4002
|
#
|
3926
4003
|
# @return [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionUpdateRequestWithID::LedgerableType, nil]
|
3927
4004
|
optional :ledgerable_type,
|
@@ -3933,10 +4010,10 @@ module ModernTreasury
|
|
3933
4010
|
|
3934
4011
|
# @!attribute [r] metadata
|
3935
4012
|
# Additional data represented as key-value pairs. Both the key and value must be
|
3936
|
-
#
|
4013
|
+
# strings.
|
3937
4014
|
#
|
3938
4015
|
# @return [Hash{Symbol=>String}, nil]
|
3939
|
-
optional :metadata, ModernTreasury::HashOf[String]
|
4016
|
+
optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
|
3940
4017
|
|
3941
4018
|
# @!parse
|
3942
4019
|
# # @return [Hash{Symbol=>String}]
|
@@ -3977,21 +4054,21 @@ module ModernTreasury
|
|
3977
4054
|
# super
|
3978
4055
|
# end
|
3979
4056
|
|
3980
|
-
# def initialize: (Hash | ModernTreasury::BaseModel) -> void
|
4057
|
+
# def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
|
3981
4058
|
|
3982
|
-
class LedgerEntry < ModernTreasury::BaseModel
|
4059
|
+
class LedgerEntry < ModernTreasury::Internal::Type::BaseModel
|
3983
4060
|
# @!attribute amount
|
3984
4061
|
# Value in specified currency's smallest unit. e.g. $10 would be represented
|
3985
|
-
#
|
4062
|
+
# as 1000. Can be any integer up to 36 digits.
|
3986
4063
|
#
|
3987
4064
|
# @return [Integer]
|
3988
4065
|
required :amount, Integer
|
3989
4066
|
|
3990
4067
|
# @!attribute direction
|
3991
4068
|
# One of `credit`, `debit`. Describes the direction money is flowing in the
|
3992
|
-
#
|
3993
|
-
#
|
3994
|
-
#
|
4069
|
+
# transaction. A `credit` moves money from your account to someone else's. A
|
4070
|
+
# `debit` pulls money from someone else's account to your own. Note that wire,
|
4071
|
+
# rtp, and check payments will always be `credit`.
|
3995
4072
|
#
|
3996
4073
|
# @return [Symbol, ModernTreasury::Models::TransactionDirection]
|
3997
4074
|
required :direction, enum: -> { ModernTreasury::Models::TransactionDirection }
|
@@ -4004,27 +4081,27 @@ module ModernTreasury
|
|
4004
4081
|
|
4005
4082
|
# @!attribute available_balance_amount
|
4006
4083
|
# Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
|
4007
|
-
#
|
4008
|
-
#
|
4084
|
+
# account’s available balance. If any of these conditions would be false after the
|
4085
|
+
# transaction is created, the entire call will fail with error code 422.
|
4009
4086
|
#
|
4010
4087
|
# @return [Hash{Symbol=>Integer}, nil]
|
4011
|
-
optional :available_balance_amount, ModernTreasury::HashOf[Integer], nil?: true
|
4088
|
+
optional :available_balance_amount, ModernTreasury::Internal::Type::HashOf[Integer], nil?: true
|
4012
4089
|
|
4013
4090
|
# @!attribute lock_version
|
4014
4091
|
# Lock version of the ledger account. This can be passed when creating a ledger
|
4015
|
-
#
|
4016
|
-
#
|
4017
|
-
#
|
4092
|
+
# transaction to only succeed if no ledger transactions have posted since the
|
4093
|
+
# given version. See our post about Designing the Ledgers API with Optimistic
|
4094
|
+
# Locking for more details.
|
4018
4095
|
#
|
4019
4096
|
# @return [Integer, nil]
|
4020
4097
|
optional :lock_version, Integer, nil?: true
|
4021
4098
|
|
4022
4099
|
# @!attribute [r] metadata
|
4023
4100
|
# Additional data represented as key-value pairs. Both the key and value must be
|
4024
|
-
#
|
4101
|
+
# strings.
|
4025
4102
|
#
|
4026
4103
|
# @return [Hash{Symbol=>String}, nil]
|
4027
|
-
optional :metadata, ModernTreasury::HashOf[String]
|
4104
|
+
optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
|
4028
4105
|
|
4029
4106
|
# @!parse
|
4030
4107
|
# # @return [Hash{Symbol=>String}]
|
@@ -4032,26 +4109,28 @@ module ModernTreasury
|
|
4032
4109
|
|
4033
4110
|
# @!attribute pending_balance_amount
|
4034
4111
|
# Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
|
4035
|
-
#
|
4036
|
-
#
|
4112
|
+
# account’s pending balance. If any of these conditions would be false after the
|
4113
|
+
# transaction is created, the entire call will fail with error code 422.
|
4037
4114
|
#
|
4038
4115
|
# @return [Hash{Symbol=>Integer}, nil]
|
4039
|
-
optional :pending_balance_amount, ModernTreasury::HashOf[Integer], nil?: true
|
4116
|
+
optional :pending_balance_amount, ModernTreasury::Internal::Type::HashOf[Integer], nil?: true
|
4040
4117
|
|
4041
4118
|
# @!attribute posted_balance_amount
|
4042
4119
|
# Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
|
4043
|
-
#
|
4044
|
-
#
|
4120
|
+
# account’s posted balance. If any of these conditions would be false after the
|
4121
|
+
# transaction is created, the entire call will fail with error code 422.
|
4045
4122
|
#
|
4046
4123
|
# @return [Hash{Symbol=>Integer}, nil]
|
4047
|
-
optional :posted_balance_amount, ModernTreasury::HashOf[Integer], nil?: true
|
4124
|
+
optional :posted_balance_amount, ModernTreasury::Internal::Type::HashOf[Integer], nil?: true
|
4048
4125
|
|
4049
4126
|
# @!attribute show_resulting_ledger_account_balances
|
4050
4127
|
# If true, response will include the balance of the associated ledger account for
|
4051
|
-
#
|
4128
|
+
# the entry.
|
4052
4129
|
#
|
4053
4130
|
# @return [Boolean, nil]
|
4054
|
-
optional :show_resulting_ledger_account_balances,
|
4131
|
+
optional :show_resulting_ledger_account_balances,
|
4132
|
+
ModernTreasury::Internal::Type::Boolean,
|
4133
|
+
nil?: true
|
4055
4134
|
|
4056
4135
|
# @!parse
|
4057
4136
|
# # @param amount [Integer]
|
@@ -4079,15 +4158,17 @@ module ModernTreasury
|
|
4079
4158
|
# super
|
4080
4159
|
# end
|
4081
4160
|
|
4082
|
-
# def initialize: (Hash | ModernTreasury::BaseModel) -> void
|
4161
|
+
# def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
|
4083
4162
|
end
|
4084
4163
|
|
4085
4164
|
# If the ledger transaction can be reconciled to another object in Modern
|
4086
|
-
#
|
4087
|
-
#
|
4088
|
-
#
|
4165
|
+
# Treasury, the type will be populated here, otherwise null. This can be one of
|
4166
|
+
# payment_order, incoming_payment_detail, expected_payment, return, paper_item, or
|
4167
|
+
# reversal.
|
4168
|
+
#
|
4169
|
+
# @see ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionUpdateRequestWithID#ledgerable_type
|
4089
4170
|
module LedgerableType
|
4090
|
-
extend ModernTreasury::Enum
|
4171
|
+
extend ModernTreasury::Internal::Type::Enum
|
4091
4172
|
|
4092
4173
|
EXPECTED_PAYMENT = :expected_payment
|
4093
4174
|
INCOMING_PAYMENT_DETAIL = :incoming_payment_detail
|
@@ -4104,8 +4185,10 @@ module ModernTreasury
|
|
4104
4185
|
end
|
4105
4186
|
|
4106
4187
|
# To post a ledger transaction at creation, use `posted`.
|
4188
|
+
#
|
4189
|
+
# @see ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionUpdateRequestWithID#status
|
4107
4190
|
module Status
|
4108
|
-
extend ModernTreasury::Enum
|
4191
|
+
extend ModernTreasury::Internal::Type::Enum
|
4109
4192
|
|
4110
4193
|
ARCHIVED = :archived
|
4111
4194
|
PENDING = :pending
|