modern_treasury 0.0.0 → 0.1.0.pre.alpha.15

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