modern_treasury 0.1.0.pre.alpha.22 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (307) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +54 -0
  3. data/README.md +1 -1
  4. data/lib/modern_treasury/client.rb +0 -12
  5. data/lib/modern_treasury/internal/transport/base_client.rb +1 -1
  6. data/lib/modern_treasury/internal/type/array_of.rb +1 -0
  7. data/lib/modern_treasury/internal/type/base_model.rb +7 -5
  8. data/lib/modern_treasury/internal/type/converter.rb +27 -0
  9. data/lib/modern_treasury/internal/type/hash_of.rb +1 -0
  10. data/lib/modern_treasury/internal/type/union.rb +9 -7
  11. data/lib/modern_treasury/models/accounting.rb +30 -0
  12. data/lib/modern_treasury/models/address.rb +94 -0
  13. data/lib/modern_treasury/models/address_request.rb +54 -0
  14. data/lib/modern_treasury/models/bulk_request_create_params.rb +144 -1505
  15. data/lib/modern_treasury/models/child_legal_entity_create.rb +275 -0
  16. data/lib/modern_treasury/models/connection_legal_entity_create_params.rb +10 -627
  17. data/lib/modern_treasury/models/contact_detail.rb +81 -0
  18. data/lib/modern_treasury/models/contact_detail_create_request.rb +34 -0
  19. data/lib/modern_treasury/models/counterparty.rb +24 -177
  20. data/lib/modern_treasury/models/counterparty_create_params.rb +37 -838
  21. data/lib/modern_treasury/models/counterparty_list_params.rb +9 -1
  22. data/lib/modern_treasury/models/document.rb +4 -6
  23. data/lib/modern_treasury/models/document_create_params.rb +0 -2
  24. data/lib/modern_treasury/models/document_list_params.rb +4 -6
  25. data/lib/modern_treasury/models/expected_payment.rb +9 -1
  26. data/lib/modern_treasury/models/expected_payment_create_params.rb +12 -230
  27. data/lib/modern_treasury/models/expected_payment_list_params.rb +8 -1
  28. data/lib/modern_treasury/models/expected_payment_update_params.rb +9 -1
  29. data/lib/modern_treasury/models/external_account.rb +15 -177
  30. data/lib/modern_treasury/models/external_account_create_params.rb +18 -210
  31. data/lib/modern_treasury/models/external_account_list_params.rb +9 -1
  32. data/lib/modern_treasury/models/external_account_update_params.rb +3 -52
  33. data/lib/modern_treasury/models/foreign_exchange_quote.rb +3 -73
  34. data/lib/modern_treasury/models/foreign_exchange_rate.rb +71 -0
  35. data/lib/modern_treasury/models/identification_create_request.rb +86 -0
  36. data/lib/modern_treasury/models/internal_account.rb +3 -95
  37. data/lib/modern_treasury/models/internal_account_update_account_capability_params.rb +34 -0
  38. data/lib/modern_treasury/models/internal_account_update_account_capability_response.rb +131 -0
  39. data/lib/modern_treasury/models/invoice.rb +3 -81
  40. data/lib/modern_treasury/models/invoice_create_params.rb +3 -83
  41. data/lib/modern_treasury/models/invoice_update_params.rb +3 -83
  42. data/lib/modern_treasury/models/ledger_account.rb +9 -141
  43. data/lib/modern_treasury/models/ledger_account_balance_monitor.rb +3 -182
  44. data/lib/modern_treasury/models/ledger_account_category.rb +3 -175
  45. data/lib/modern_treasury/models/ledger_account_category_list_params.rb +9 -5
  46. data/lib/modern_treasury/models/ledger_account_category_retrieve_params.rb +4 -2
  47. data/lib/modern_treasury/models/ledger_account_create_params.rb +2 -105
  48. data/lib/modern_treasury/models/ledger_account_create_request.rb +113 -0
  49. data/lib/modern_treasury/models/ledger_account_statement_create_response.rb +6 -360
  50. data/lib/modern_treasury/models/ledger_account_statement_retrieve_response.rb +6 -360
  51. data/lib/modern_treasury/models/ledger_balance.rb +45 -0
  52. data/lib/modern_treasury/models/ledger_balances.rb +38 -0
  53. data/lib/modern_treasury/models/ledger_entry.rb +3 -183
  54. data/lib/modern_treasury/models/ledger_entry_create_request.rb +98 -0
  55. data/lib/modern_treasury/models/ledger_entry_list_params.rb +8 -6
  56. data/lib/modern_treasury/models/ledger_transaction.rb +14 -6
  57. data/lib/modern_treasury/models/ledger_transaction_create_params.rb +2 -212
  58. data/lib/modern_treasury/models/ledger_transaction_create_request.rb +123 -0
  59. data/lib/modern_treasury/models/ledger_transaction_create_reversal_params.rb +0 -1
  60. data/lib/modern_treasury/models/ledger_transaction_list_params.rb +44 -7
  61. data/lib/modern_treasury/models/ledger_transaction_update_params.rb +5 -104
  62. data/lib/modern_treasury/models/ledger_transactions/ledger_transaction_version.rb +15 -193
  63. data/lib/modern_treasury/models/legal_entity_address_create_request.rb +78 -0
  64. data/lib/modern_treasury/models/legal_entity_association.rb +1 -0
  65. data/lib/modern_treasury/models/legal_entity_association_create_params.rb +4 -448
  66. data/lib/modern_treasury/models/legal_entity_create_params.rb +10 -618
  67. data/lib/modern_treasury/models/legal_entity_update_params.rb +6 -165
  68. data/lib/modern_treasury/models/line_item.rb +3 -29
  69. data/lib/modern_treasury/models/payment_action_list_params.rb +2 -0
  70. data/lib/modern_treasury/models/payment_order.rb +13 -102
  71. data/lib/modern_treasury/models/payment_order_create_async_params.rb +24 -477
  72. data/lib/modern_treasury/models/payment_order_create_params.rb +24 -479
  73. data/lib/modern_treasury/models/payment_order_update_params.rb +21 -248
  74. data/lib/modern_treasury/models/payment_orders/reversal.rb +3 -4
  75. data/lib/modern_treasury/models/payment_orders/reversal_create_params.rb +3 -232
  76. data/lib/modern_treasury/models/payment_reference.rb +7 -1
  77. data/lib/modern_treasury/models/return_list_params.rb +5 -6
  78. data/lib/modern_treasury/models/return_object.rb +7 -3
  79. data/lib/modern_treasury/models/routing_detail.rb +3 -93
  80. data/lib/modern_treasury/models/routing_number_lookup_request.rb +3 -55
  81. data/lib/modern_treasury/models/transaction.rb +5 -73
  82. data/lib/modern_treasury/models/transactions/transaction_line_item.rb +0 -1
  83. data/lib/modern_treasury/models/virtual_account_create_params.rb +3 -117
  84. data/lib/modern_treasury/models.rb +31 -6
  85. data/lib/modern_treasury/resources/bulk_requests.rb +1 -1
  86. data/lib/modern_treasury/resources/counterparties.rb +20 -14
  87. data/lib/modern_treasury/resources/expected_payments.rb +10 -4
  88. data/lib/modern_treasury/resources/external_accounts.rb +23 -17
  89. data/lib/modern_treasury/resources/internal_accounts.rb +34 -0
  90. data/lib/modern_treasury/resources/invoices.rb +2 -2
  91. data/lib/modern_treasury/resources/ledger_account_categories.rb +1 -1
  92. data/lib/modern_treasury/resources/ledger_accounts.rb +1 -1
  93. data/lib/modern_treasury/resources/ledger_entries.rb +1 -1
  94. data/lib/modern_treasury/resources/ledger_transactions.rb +5 -5
  95. data/lib/modern_treasury/resources/legal_entities.rb +4 -4
  96. data/lib/modern_treasury/resources/legal_entity_associations.rb +1 -1
  97. data/lib/modern_treasury/resources/payment_orders/reversals.rb +1 -1
  98. data/lib/modern_treasury/resources/payment_orders.rb +5 -5
  99. data/lib/modern_treasury/resources/returns.rb +1 -1
  100. data/lib/modern_treasury/resources/virtual_accounts.rb +1 -1
  101. data/lib/modern_treasury/version.rb +1 -1
  102. data/lib/modern_treasury.rb +16 -6
  103. data/rbi/modern_treasury/client.rbi +0 -9
  104. data/rbi/modern_treasury/internal/transport/base_client.rbi +1 -1
  105. data/rbi/modern_treasury/internal/type/converter.rbi +58 -0
  106. data/rbi/modern_treasury/internal/type/union.rbi +11 -2
  107. data/rbi/modern_treasury/models/accounting.rbi +48 -0
  108. data/rbi/modern_treasury/models/address.rbi +107 -0
  109. data/rbi/modern_treasury/models/address_request.rbi +76 -0
  110. data/rbi/modern_treasury/models/bulk_request_create_params.rbi +701 -3140
  111. data/rbi/modern_treasury/models/child_legal_entity_create.rbi +511 -0
  112. data/rbi/modern_treasury/models/connection_legal_entity_create_params.rbi +17 -1314
  113. data/rbi/modern_treasury/models/contact_detail.rbi +124 -0
  114. data/rbi/modern_treasury/models/contact_detail_create_request.rbi +99 -0
  115. data/rbi/modern_treasury/models/counterparty.rbi +24 -264
  116. data/rbi/modern_treasury/models/counterparty_create_params.rbi +47 -1718
  117. data/rbi/modern_treasury/models/counterparty_list_params.rbi +11 -0
  118. data/rbi/modern_treasury/models/document.rbi +6 -16
  119. data/rbi/modern_treasury/models/document_create_params.rbi +0 -10
  120. data/rbi/modern_treasury/models/document_list_params.rbi +6 -16
  121. data/rbi/modern_treasury/models/expected_payment.rbi +8 -0
  122. data/rbi/modern_treasury/models/expected_payment_create_params.rbi +12 -419
  123. data/rbi/modern_treasury/models/expected_payment_list_params.rbi +9 -0
  124. data/rbi/modern_treasury/models/expected_payment_update_params.rbi +8 -0
  125. data/rbi/modern_treasury/models/external_account.rbi +15 -244
  126. data/rbi/modern_treasury/models/external_account_create_params.rbi +20 -400
  127. data/rbi/modern_treasury/models/external_account_list_params.rbi +11 -0
  128. data/rbi/modern_treasury/models/external_account_update_params.rbi +4 -86
  129. data/rbi/modern_treasury/models/foreign_exchange_quote.rbi +4 -99
  130. data/rbi/modern_treasury/models/foreign_exchange_rate.rbi +96 -0
  131. data/rbi/modern_treasury/models/identification_create_request.rbi +212 -0
  132. data/rbi/modern_treasury/models/internal_account.rbi +4 -115
  133. data/rbi/modern_treasury/models/internal_account_update_account_capability_params.rbi +54 -0
  134. data/rbi/modern_treasury/models/internal_account_update_account_capability_response.rbi +304 -0
  135. data/rbi/modern_treasury/models/invoice.rbi +3 -128
  136. data/rbi/modern_treasury/models/invoice_create_params.rbi +4 -139
  137. data/rbi/modern_treasury/models/invoice_update_params.rbi +4 -139
  138. data/rbi/modern_treasury/models/ledger_account.rbi +12 -218
  139. data/rbi/modern_treasury/models/ledger_account_balance_monitor.rbi +4 -303
  140. data/rbi/modern_treasury/models/ledger_account_category.rbi +4 -301
  141. data/rbi/modern_treasury/models/ledger_account_category_list_params.rbi +14 -7
  142. data/rbi/modern_treasury/models/ledger_account_category_retrieve_params.rbi +6 -3
  143. data/rbi/modern_treasury/models/ledger_account_create_params.rbi +5 -173
  144. data/rbi/modern_treasury/models/ledger_account_create_request.rbi +194 -0
  145. data/rbi/modern_treasury/models/ledger_account_statement_create_response.rbi +8 -612
  146. data/rbi/modern_treasury/models/ledger_account_statement_retrieve_response.rbi +8 -612
  147. data/rbi/modern_treasury/models/ledger_balance.rbi +66 -0
  148. data/rbi/modern_treasury/models/ledger_balances.rbi +75 -0
  149. data/rbi/modern_treasury/models/ledger_entry.rbi +4 -309
  150. data/rbi/modern_treasury/models/ledger_entry_create_request.rbi +137 -0
  151. data/rbi/modern_treasury/models/ledger_entry_list_params.rbi +13 -8
  152. data/rbi/modern_treasury/models/ledger_transaction.rbi +17 -11
  153. data/rbi/modern_treasury/models/ledger_transaction_create_params.rbi +5 -383
  154. data/rbi/modern_treasury/models/ledger_transaction_create_request.rbi +258 -0
  155. data/rbi/modern_treasury/models/ledger_transaction_create_reversal_params.rbi +0 -5
  156. data/rbi/modern_treasury/models/ledger_transaction_list_params.rbi +93 -18
  157. data/rbi/modern_treasury/models/ledger_transaction_update_params.rbi +7 -158
  158. data/rbi/modern_treasury/models/ledger_transactions/ledger_transaction_version.rbi +18 -316
  159. data/rbi/modern_treasury/models/legal_entity_address_create_request.rbi +157 -0
  160. data/rbi/modern_treasury/models/legal_entity_association.rbi +5 -0
  161. data/rbi/modern_treasury/models/legal_entity_association_create_params.rbi +9 -917
  162. data/rbi/modern_treasury/models/legal_entity_create_params.rbi +17 -1297
  163. data/rbi/modern_treasury/models/legal_entity_update_params.rbi +8 -378
  164. data/rbi/modern_treasury/models/line_item.rbi +4 -52
  165. data/rbi/modern_treasury/models/payment_action_list_params.rbi +10 -0
  166. data/rbi/modern_treasury/models/payment_order.rbi +43 -159
  167. data/rbi/modern_treasury/models/payment_order_create_async_params.rbi +28 -882
  168. data/rbi/modern_treasury/models/payment_order_create_params.rbi +28 -887
  169. data/rbi/modern_treasury/models/payment_order_update_params.rbi +24 -460
  170. data/rbi/modern_treasury/models/payment_orders/reversal.rbi +3 -3
  171. data/rbi/modern_treasury/models/payment_orders/reversal_create_params.rbi +4 -415
  172. data/rbi/modern_treasury/models/payment_reference.rbi +35 -5
  173. data/rbi/modern_treasury/models/return_list_params.rbi +6 -11
  174. data/rbi/modern_treasury/models/return_object.rbi +35 -12
  175. data/rbi/modern_treasury/models/routing_detail.rbi +4 -113
  176. data/rbi/modern_treasury/models/routing_number_lookup_request.rbi +4 -87
  177. data/rbi/modern_treasury/models/transaction.rbi +14 -103
  178. data/rbi/modern_treasury/models/transactions/transaction_line_item.rbi +0 -5
  179. data/rbi/modern_treasury/models/virtual_account_create_params.rbi +4 -203
  180. data/rbi/modern_treasury/models.rbi +36 -6
  181. data/rbi/modern_treasury/resources/bulk_requests.rbi +2 -2
  182. data/rbi/modern_treasury/resources/counterparties.rbi +20 -12
  183. data/rbi/modern_treasury/resources/documents.rbi +2 -2
  184. data/rbi/modern_treasury/resources/expected_payments.rbi +9 -1
  185. data/rbi/modern_treasury/resources/external_accounts.rbi +29 -22
  186. data/rbi/modern_treasury/resources/internal_accounts.rbi +24 -0
  187. data/rbi/modern_treasury/resources/invoices.rbi +2 -8
  188. data/rbi/modern_treasury/resources/ledger_account_categories.rbi +7 -3
  189. data/rbi/modern_treasury/resources/ledger_accounts.rbi +1 -1
  190. data/rbi/modern_treasury/resources/ledger_entries.rbi +4 -2
  191. data/rbi/modern_treasury/resources/ledger_transactions.rbi +13 -13
  192. data/rbi/modern_treasury/resources/legal_entities.rbi +4 -8
  193. data/rbi/modern_treasury/resources/legal_entity_associations.rbi +1 -2
  194. data/rbi/modern_treasury/resources/payment_orders/reversals.rbi +1 -1
  195. data/rbi/modern_treasury/resources/payment_orders.rbi +5 -8
  196. data/rbi/modern_treasury/resources/returns.rbi +2 -2
  197. data/rbi/modern_treasury/resources/virtual_accounts.rbi +1 -2
  198. data/sig/modern_treasury/client.rbs +0 -6
  199. data/sig/modern_treasury/internal/transport/base_client.rbs +1 -1
  200. data/sig/modern_treasury/internal/type/converter.rbs +17 -0
  201. data/sig/modern_treasury/internal/type/union.rbs +2 -2
  202. data/sig/modern_treasury/models/accounting.rbs +15 -0
  203. data/sig/modern_treasury/models/address.rbs +70 -0
  204. data/sig/modern_treasury/models/address_request.rbs +45 -0
  205. data/sig/modern_treasury/models/bulk_request_create_params.rbs +88 -1089
  206. data/sig/modern_treasury/models/child_legal_entity_create.rbs +220 -0
  207. data/sig/modern_treasury/models/connection_legal_entity_create_params.rbs +21 -548
  208. data/sig/modern_treasury/models/contact_detail.rbs +67 -0
  209. data/sig/modern_treasury/models/contact_detail_create_request.rbs +43 -0
  210. data/sig/modern_treasury/models/counterparty.rbs +20 -141
  211. data/sig/modern_treasury/models/counterparty_create_params.rbs +49 -737
  212. data/sig/modern_treasury/models/counterparty_list_params.rbs +7 -0
  213. data/sig/modern_treasury/models/document.rbs +0 -4
  214. data/sig/modern_treasury/models/document_create_params.rbs +0 -4
  215. data/sig/modern_treasury/models/document_list_params.rbs +0 -4
  216. data/sig/modern_treasury/models/expected_payment.rbs +5 -0
  217. data/sig/modern_treasury/models/expected_payment_create_params.rbs +11 -173
  218. data/sig/modern_treasury/models/expected_payment_list_params.rbs +7 -0
  219. data/sig/modern_treasury/models/expected_payment_update_params.rbs +5 -0
  220. data/sig/modern_treasury/models/external_account.rbs +13 -139
  221. data/sig/modern_treasury/models/external_account_create_params.rbs +23 -189
  222. data/sig/modern_treasury/models/external_account_list_params.rbs +7 -0
  223. data/sig/modern_treasury/models/external_account_update_params.rbs +6 -48
  224. data/sig/modern_treasury/models/foreign_exchange_quote.rbs +4 -51
  225. data/sig/modern_treasury/models/foreign_exchange_rate.rbs +50 -0
  226. data/sig/modern_treasury/models/identification_create_request.rbs +93 -0
  227. data/sig/modern_treasury/models/internal_account.rbs +4 -71
  228. data/sig/modern_treasury/models/internal_account_update_account_capability_params.rbs +28 -0
  229. data/sig/modern_treasury/models/internal_account_update_account_capability_response.rbs +137 -0
  230. data/sig/modern_treasury/models/invoice.rbs +4 -68
  231. data/sig/modern_treasury/models/invoice_create_params.rbs +6 -70
  232. data/sig/modern_treasury/models/invoice_update_params.rbs +6 -70
  233. data/sig/modern_treasury/models/ledger_account.rbs +12 -123
  234. data/sig/modern_treasury/models/ledger_account_balance_monitor.rbs +4 -142
  235. data/sig/modern_treasury/models/ledger_account_category.rbs +4 -142
  236. data/sig/modern_treasury/models/ledger_account_category_list_params.rbs +5 -5
  237. data/sig/modern_treasury/models/ledger_account_create_params.rbs +4 -84
  238. data/sig/modern_treasury/models/ledger_account_create_request.rbs +89 -0
  239. data/sig/modern_treasury/models/ledger_account_statement_create_response.rbs +8 -284
  240. data/sig/modern_treasury/models/ledger_account_statement_retrieve_response.rbs +8 -284
  241. data/sig/modern_treasury/models/ledger_balance.rbs +40 -0
  242. data/sig/modern_treasury/models/ledger_balances.rbs +30 -0
  243. data/sig/modern_treasury/models/ledger_entry.rbs +4 -142
  244. data/sig/modern_treasury/models/ledger_entry_create_request.rbs +62 -0
  245. data/sig/modern_treasury/models/ledger_entry_list_params.rbs +6 -6
  246. data/sig/modern_treasury/models/ledger_transaction.rbs +5 -2
  247. data/sig/modern_treasury/models/ledger_transaction_create_params.rbs +4 -165
  248. data/sig/modern_treasury/models/ledger_transaction_create_request.rbs +109 -0
  249. data/sig/modern_treasury/models/ledger_transaction_create_reversal_params.rbs +0 -2
  250. data/sig/modern_treasury/models/ledger_transaction_list_params.rbs +21 -5
  251. data/sig/modern_treasury/models/ledger_transaction_update_params.rbs +6 -67
  252. data/sig/modern_treasury/models/ledger_transactions/ledger_transaction_version.rbs +9 -144
  253. data/sig/modern_treasury/models/legal_entity_address_create_request.rbs +68 -0
  254. data/sig/modern_treasury/models/legal_entity_association.rbs +3 -1
  255. data/sig/modern_treasury/models/legal_entity_association_create_params.rbs +9 -380
  256. data/sig/modern_treasury/models/legal_entity_create_params.rbs +21 -548
  257. data/sig/modern_treasury/models/legal_entity_update_params.rbs +12 -168
  258. data/sig/modern_treasury/models/line_item.rbs +4 -16
  259. data/sig/modern_treasury/models/payment_action_list_params.rbs +4 -1
  260. data/sig/modern_treasury/models/payment_order.rbs +22 -69
  261. data/sig/modern_treasury/models/payment_order_create_async_params.rbs +35 -380
  262. data/sig/modern_treasury/models/payment_order_create_params.rbs +35 -384
  263. data/sig/modern_treasury/models/payment_order_update_params.rbs +29 -207
  264. data/sig/modern_treasury/models/payment_orders/reversal.rbs +4 -4
  265. data/sig/modern_treasury/models/payment_orders/reversal_create_params.rbs +6 -173
  266. data/sig/modern_treasury/models/payment_reference.rbs +14 -2
  267. data/sig/modern_treasury/models/return_list_params.rbs +1 -6
  268. data/sig/modern_treasury/models/return_object.rbs +15 -10
  269. data/sig/modern_treasury/models/routing_detail.rbs +4 -71
  270. data/sig/modern_treasury/models/routing_number_lookup_request.rbs +6 -48
  271. data/sig/modern_treasury/models/transaction.rbs +8 -53
  272. data/sig/modern_treasury/models/transactions/transaction_line_item.rbs +0 -2
  273. data/sig/modern_treasury/models/virtual_account_create_params.rbs +6 -95
  274. data/sig/modern_treasury/models.rbs +30 -6
  275. data/sig/modern_treasury/resources/counterparties.rbs +2 -0
  276. data/sig/modern_treasury/resources/expected_payments.rbs +4 -1
  277. data/sig/modern_treasury/resources/external_accounts.rbs +6 -4
  278. data/sig/modern_treasury/resources/internal_accounts.rbs +7 -0
  279. data/sig/modern_treasury/resources/invoices.rbs +2 -2
  280. data/sig/modern_treasury/resources/ledger_account_categories.rbs +1 -1
  281. data/sig/modern_treasury/resources/ledger_accounts.rbs +1 -1
  282. data/sig/modern_treasury/resources/ledger_entries.rbs +1 -1
  283. data/sig/modern_treasury/resources/ledger_transactions.rbs +4 -4
  284. data/sig/modern_treasury/resources/legal_entities.rbs +4 -4
  285. data/sig/modern_treasury/resources/legal_entity_associations.rbs +1 -1
  286. data/sig/modern_treasury/resources/payment_orders/reversals.rbs +1 -1
  287. data/sig/modern_treasury/resources/payment_orders.rbs +5 -5
  288. data/sig/modern_treasury/resources/virtual_accounts.rbs +1 -1
  289. metadata +52 -22
  290. data/lib/modern_treasury/models/paper_item.rb +0 -178
  291. data/lib/modern_treasury/models/paper_item_list_params.rb +0 -56
  292. data/lib/modern_treasury/models/paper_item_retrieve_params.rb +0 -14
  293. data/lib/modern_treasury/resources/ledger_event_handlers.rb +0 -14
  294. data/lib/modern_treasury/resources/ledgerable_events.rb +0 -14
  295. data/lib/modern_treasury/resources/paper_items.rb +0 -68
  296. data/rbi/modern_treasury/models/paper_item.rbi +0 -204
  297. data/rbi/modern_treasury/models/paper_item_list_params.rbi +0 -88
  298. data/rbi/modern_treasury/models/paper_item_retrieve_params.rbi +0 -32
  299. data/rbi/modern_treasury/resources/ledger_event_handlers.rbi +0 -12
  300. data/rbi/modern_treasury/resources/ledgerable_events.rbi +0 -12
  301. data/rbi/modern_treasury/resources/paper_items.rbi +0 -51
  302. data/sig/modern_treasury/models/paper_item.rbs +0 -122
  303. data/sig/modern_treasury/models/paper_item_list_params.rbs +0 -54
  304. data/sig/modern_treasury/models/paper_item_retrieve_params.rbs +0 -15
  305. data/sig/modern_treasury/resources/ledger_event_handlers.rbs +0 -7
  306. data/sig/modern_treasury/resources/ledgerable_events.rbs +0 -7
  307. data/sig/modern_treasury/resources/paper_items.rbs +0 -21
@@ -39,8 +39,8 @@ module ModernTreasury
39
39
 
40
40
  # @!attribute accounting
41
41
  #
42
- # @return [ModernTreasury::Models::PaymentOrderCreateParams::Accounting, nil]
43
- optional :accounting, -> { ModernTreasury::PaymentOrderCreateParams::Accounting }
42
+ # @return [ModernTreasury::Models::Accounting, nil]
43
+ optional :accounting, -> { ModernTreasury::Accounting }
44
44
 
45
45
  # @!attribute accounting_category_id
46
46
  # @deprecated
@@ -135,8 +135,8 @@ module ModernTreasury
135
135
  # creation will fail. The resulting ledger transaction will mirror the status of
136
136
  # the payment order.
137
137
  #
138
- # @return [ModernTreasury::Models::PaymentOrderCreateParams::LedgerTransaction, nil]
139
- optional :ledger_transaction, -> { ModernTreasury::PaymentOrderCreateParams::LedgerTransaction }
138
+ # @return [ModernTreasury::Models::LedgerTransactionCreateRequest, nil]
139
+ optional :ledger_transaction, -> { ModernTreasury::LedgerTransactionCreateRequest }
140
140
 
141
141
  # @!attribute ledger_transaction_id
142
142
  # Either ledger_transaction or ledger_transaction_id can be provided. Only a
@@ -299,7 +299,7 @@ module ModernTreasury
299
299
  #
300
300
  # @param type [Symbol, ModernTreasury::Models::PaymentOrderType] One of `ach`, `se_bankgirot`, `eft`, `wire`, `check`, `sen`, `book`, `rtp`, `sep
301
301
  #
302
- # @param accounting [ModernTreasury::Models::PaymentOrderCreateParams::Accounting]
302
+ # @param accounting [ModernTreasury::Models::Accounting]
303
303
  #
304
304
  # @param accounting_category_id [String, nil] The ID of one of your accounting categories. Note that these will only be access
305
305
  #
@@ -323,7 +323,7 @@ module ModernTreasury
323
323
  #
324
324
  # @param foreign_exchange_indicator [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::ForeignExchangeIndicator, nil] Indicates the type of FX transfer to initiate, can be either `variable_to_fixed`
325
325
  #
326
- # @param ledger_transaction [ModernTreasury::Models::PaymentOrderCreateParams::LedgerTransaction] Specifies a ledger transaction object that will be created with the payment orde
326
+ # @param ledger_transaction [ModernTreasury::Models::LedgerTransactionCreateRequest] Specifies a ledger transaction object that will be created with the payment orde
327
327
  #
328
328
  # @param ledger_transaction_id [String] Either ledger_transaction or ledger_transaction_id can be provided. Only a pendi
329
329
  #
@@ -379,31 +379,6 @@ module ModernTreasury
379
379
  # @return [Array<Symbol>]
380
380
  end
381
381
 
382
- class Accounting < ModernTreasury::Internal::Type::BaseModel
383
- # @!attribute account_id
384
- # The ID of one of your accounting categories. Note that these will only be
385
- # accessible if your accounting system has been connected.
386
- #
387
- # @return [String, nil]
388
- optional :account_id, String, nil?: true
389
-
390
- # @!attribute class_id
391
- # The ID of one of the class objects in your accounting system. Class objects
392
- # track segments of your business independent of client or project. Note that
393
- # these will only be accessible if your accounting system has been connected.
394
- #
395
- # @return [String, nil]
396
- optional :class_id, String, nil?: true
397
-
398
- # @!method initialize(account_id: nil, class_id: nil)
399
- # Some parameter documentations has been truncated, see
400
- # {ModernTreasury::Models::PaymentOrderCreateParams::Accounting} for more details.
401
- #
402
- # @param account_id [String, nil] The ID of one of your accounting categories. Note that these will only be access
403
- #
404
- # @param class_id [String, nil] The ID of one of the class objects in your accounting system. Class objects trac
405
- end
406
-
407
382
  # The party that will pay the fees for the payment order. See
408
383
  # https://docs.moderntreasury.com/payments/docs/charge-bearer to understand the
409
384
  # differences between the options.
@@ -462,11 +437,9 @@ module ModernTreasury
462
437
  INCOMING_PAYMENT_DETAILS = :incoming_payment_details
463
438
  INTERNAL_ACCOUNTS = :internal_accounts
464
439
  ORGANIZATIONS = :organizations
465
- PAPER_ITEMS = :paper_items
466
440
  PAYMENT_ORDERS = :payment_orders
467
441
  TRANSACTIONS = :transactions
468
442
  CONNECTIONS = :connections
469
- CONVERSATIONS = :conversations
470
443
 
471
444
  # @!method self.values
472
445
  # @return [Array<Symbol>]
@@ -498,232 +471,6 @@ module ModernTreasury
498
471
  # @return [Array<Symbol>]
499
472
  end
500
473
 
501
- class LedgerTransaction < ModernTreasury::Internal::Type::BaseModel
502
- # @!attribute ledger_entries
503
- # An array of ledger entry objects.
504
- #
505
- # @return [Array<ModernTreasury::Models::PaymentOrderCreateParams::LedgerTransaction::LedgerEntry>]
506
- required :ledger_entries,
507
- -> {
508
- ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::PaymentOrderCreateParams::LedgerTransaction::LedgerEntry]
509
- }
510
-
511
- # @!attribute description
512
- # An optional description for internal use.
513
- #
514
- # @return [String, nil]
515
- optional :description, String, nil?: true
516
-
517
- # @!attribute effective_at
518
- # The timestamp (ISO8601 format) at which the ledger transaction happened for
519
- # reporting purposes.
520
- #
521
- # @return [Time, nil]
522
- optional :effective_at, Time
523
-
524
- # @!attribute effective_date
525
- # The date (YYYY-MM-DD) on which the ledger transaction happened for reporting
526
- # purposes.
527
- #
528
- # @return [Date, nil]
529
- optional :effective_date, Date
530
-
531
- # @!attribute external_id
532
- # A unique string to represent the ledger transaction. Only one pending or posted
533
- # ledger transaction may have this ID in the ledger.
534
- #
535
- # @return [String, nil]
536
- optional :external_id, String
537
-
538
- # @!attribute ledgerable_id
539
- # If the ledger transaction can be reconciled to another object in Modern
540
- # Treasury, the id will be populated here, otherwise null.
541
- #
542
- # @return [String, nil]
543
- optional :ledgerable_id, String
544
-
545
- # @!attribute ledgerable_type
546
- # If the ledger transaction can be reconciled to another object in Modern
547
- # Treasury, the type will be populated here, otherwise null. This can be one of
548
- # payment_order, incoming_payment_detail, expected_payment, return, paper_item, or
549
- # reversal.
550
- #
551
- # @return [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::LedgerTransaction::LedgerableType, nil]
552
- optional :ledgerable_type,
553
- enum: -> { ModernTreasury::PaymentOrderCreateParams::LedgerTransaction::LedgerableType }
554
-
555
- # @!attribute metadata
556
- # Additional data represented as key-value pairs. Both the key and value must be
557
- # strings.
558
- #
559
- # @return [Hash{Symbol=>String}, nil]
560
- optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
561
-
562
- # @!attribute status
563
- # To post a ledger transaction at creation, use `posted`.
564
- #
565
- # @return [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::LedgerTransaction::Status, nil]
566
- optional :status, enum: -> { ModernTreasury::PaymentOrderCreateParams::LedgerTransaction::Status }
567
-
568
- # @!method initialize(ledger_entries:, description: nil, effective_at: nil, effective_date: nil, external_id: nil, ledgerable_id: nil, ledgerable_type: nil, metadata: nil, status: nil)
569
- # Some parameter documentations has been truncated, see
570
- # {ModernTreasury::Models::PaymentOrderCreateParams::LedgerTransaction} for more
571
- # details.
572
- #
573
- # Specifies a ledger transaction object that will be created with the payment
574
- # order. If the ledger transaction cannot be created, then the payment order
575
- # creation will fail. The resulting ledger transaction will mirror the status of
576
- # the payment order.
577
- #
578
- # @param ledger_entries [Array<ModernTreasury::Models::PaymentOrderCreateParams::LedgerTransaction::LedgerEntry>] An array of ledger entry objects.
579
- #
580
- # @param description [String, nil] An optional description for internal use.
581
- #
582
- # @param effective_at [Time] The timestamp (ISO8601 format) at which the ledger transaction happened for repo
583
- #
584
- # @param effective_date [Date] The date (YYYY-MM-DD) on which the ledger transaction happened for reporting pur
585
- #
586
- # @param external_id [String] A unique string to represent the ledger transaction. Only one pending or posted
587
- #
588
- # @param ledgerable_id [String] If the ledger transaction can be reconciled to another object in Modern Treasury
589
- #
590
- # @param ledgerable_type [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::LedgerTransaction::LedgerableType] If the ledger transaction can be reconciled to another object in Modern Treasury
591
- #
592
- # @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
593
- #
594
- # @param status [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::LedgerTransaction::Status] To post a ledger transaction at creation, use `posted`.
595
-
596
- class LedgerEntry < ModernTreasury::Internal::Type::BaseModel
597
- # @!attribute amount
598
- # Value in specified currency's smallest unit. e.g. $10 would be represented
599
- # as 1000. Can be any integer up to 36 digits.
600
- #
601
- # @return [Integer]
602
- required :amount, Integer
603
-
604
- # @!attribute direction
605
- # One of `credit`, `debit`. Describes the direction money is flowing in the
606
- # transaction. A `credit` moves money from your account to someone else's. A
607
- # `debit` pulls money from someone else's account to your own. Note that wire,
608
- # rtp, and check payments will always be `credit`.
609
- #
610
- # @return [Symbol, ModernTreasury::Models::TransactionDirection]
611
- required :direction, enum: -> { ModernTreasury::TransactionDirection }
612
-
613
- # @!attribute ledger_account_id
614
- # The ledger account that this ledger entry is associated with.
615
- #
616
- # @return [String]
617
- required :ledger_account_id, String
618
-
619
- # @!attribute available_balance_amount
620
- # Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
621
- # account’s available balance. If any of these conditions would be false after the
622
- # transaction is created, the entire call will fail with error code 422.
623
- #
624
- # @return [Hash{Symbol=>Integer}, nil]
625
- optional :available_balance_amount, ModernTreasury::Internal::Type::HashOf[Integer], nil?: true
626
-
627
- # @!attribute lock_version
628
- # Lock version of the ledger account. This can be passed when creating a ledger
629
- # transaction to only succeed if no ledger transactions have posted since the
630
- # given version. See our post about Designing the Ledgers API with Optimistic
631
- # Locking for more details.
632
- #
633
- # @return [Integer, nil]
634
- optional :lock_version, Integer, nil?: true
635
-
636
- # @!attribute metadata
637
- # Additional data represented as key-value pairs. Both the key and value must be
638
- # strings.
639
- #
640
- # @return [Hash{Symbol=>String}, nil]
641
- optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
642
-
643
- # @!attribute pending_balance_amount
644
- # Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
645
- # account’s pending balance. If any of these conditions would be false after the
646
- # transaction is created, the entire call will fail with error code 422.
647
- #
648
- # @return [Hash{Symbol=>Integer}, nil]
649
- optional :pending_balance_amount, ModernTreasury::Internal::Type::HashOf[Integer], nil?: true
650
-
651
- # @!attribute posted_balance_amount
652
- # Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
653
- # account’s posted balance. If any of these conditions would be false after the
654
- # transaction is created, the entire call will fail with error code 422.
655
- #
656
- # @return [Hash{Symbol=>Integer}, nil]
657
- optional :posted_balance_amount, ModernTreasury::Internal::Type::HashOf[Integer], nil?: true
658
-
659
- # @!attribute show_resulting_ledger_account_balances
660
- # If true, response will include the balance of the associated ledger account for
661
- # the entry.
662
- #
663
- # @return [Boolean, nil]
664
- optional :show_resulting_ledger_account_balances,
665
- ModernTreasury::Internal::Type::Boolean,
666
- nil?: true
667
-
668
- # @!method initialize(amount:, direction:, ledger_account_id:, available_balance_amount: nil, lock_version: nil, metadata: nil, pending_balance_amount: nil, posted_balance_amount: nil, show_resulting_ledger_account_balances: nil)
669
- # Some parameter documentations has been truncated, see
670
- # {ModernTreasury::Models::PaymentOrderCreateParams::LedgerTransaction::LedgerEntry}
671
- # for more details.
672
- #
673
- # @param amount [Integer] Value in specified currency's smallest unit. e.g. $10 would be represented as 10
674
- #
675
- # @param direction [Symbol, ModernTreasury::Models::TransactionDirection] One of `credit`, `debit`. Describes the direction money is flowing in the transa
676
- #
677
- # @param ledger_account_id [String] The ledger account that this ledger entry is associated with.
678
- #
679
- # @param available_balance_amount [Hash{Symbol=>Integer}, nil] Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the accou
680
- #
681
- # @param lock_version [Integer, nil] Lock version of the ledger account. This can be passed when creating a ledger tr
682
- #
683
- # @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
684
- #
685
- # @param pending_balance_amount [Hash{Symbol=>Integer}, nil] Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the accou
686
- #
687
- # @param posted_balance_amount [Hash{Symbol=>Integer}, nil] Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the accou
688
- #
689
- # @param show_resulting_ledger_account_balances [Boolean, nil] If true, response will include the balance of the associated ledger account for
690
- end
691
-
692
- # If the ledger transaction can be reconciled to another object in Modern
693
- # Treasury, the type will be populated here, otherwise null. This can be one of
694
- # payment_order, incoming_payment_detail, expected_payment, return, paper_item, or
695
- # reversal.
696
- #
697
- # @see ModernTreasury::Models::PaymentOrderCreateParams::LedgerTransaction#ledgerable_type
698
- module LedgerableType
699
- extend ModernTreasury::Internal::Type::Enum
700
-
701
- EXPECTED_PAYMENT = :expected_payment
702
- INCOMING_PAYMENT_DETAIL = :incoming_payment_detail
703
- PAPER_ITEM = :paper_item
704
- PAYMENT_ORDER = :payment_order
705
- RETURN = :return
706
- REVERSAL = :reversal
707
-
708
- # @!method self.values
709
- # @return [Array<Symbol>]
710
- end
711
-
712
- # To post a ledger transaction at creation, use `posted`.
713
- #
714
- # @see ModernTreasury::Models::PaymentOrderCreateParams::LedgerTransaction#status
715
- module Status
716
- extend ModernTreasury::Internal::Type::Enum
717
-
718
- ARCHIVED = :archived
719
- PENDING = :pending
720
- POSTED = :posted
721
-
722
- # @!method self.values
723
- # @return [Array<Symbol>]
724
- end
725
- end
726
-
727
474
  class LineItem < ModernTreasury::Internal::Type::BaseModel
728
475
  # @!attribute amount
729
476
  # Value in specified currency's smallest unit. e.g. $10 would be represented
@@ -795,11 +542,15 @@ module ModernTreasury
795
542
 
796
543
  # @!attribute contact_details
797
544
  #
798
- # @return [Array<ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount::ContactDetail>, nil]
545
+ # @return [Array<ModernTreasury::Models::ContactDetailCreateRequest>, nil]
799
546
  optional :contact_details,
800
- -> {
801
- ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::PaymentOrderCreateParams::ReceivingAccount::ContactDetail]
802
- }
547
+ -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::ContactDetailCreateRequest] }
548
+
549
+ # @!attribute external_id
550
+ # An optional user-defined 180 character unique identifier.
551
+ #
552
+ # @return [String, nil]
553
+ optional :external_id, String, nil?: true
803
554
 
804
555
  # @!attribute ledger_account
805
556
  # Specifies a ledger account object that will be created with the external
@@ -808,11 +559,8 @@ module ModernTreasury
808
559
  # https://docs.moderntreasury.com/docs/linking-to-other-modern-treasury-objects
809
560
  # for more details.
810
561
  #
811
- # @return [ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount::LedgerAccount, nil]
812
- optional :ledger_account,
813
- -> {
814
- ModernTreasury::PaymentOrderCreateParams::ReceivingAccount::LedgerAccount
815
- }
562
+ # @return [ModernTreasury::Models::LedgerAccountCreateRequest, nil]
563
+ optional :ledger_account, -> { ModernTreasury::LedgerAccountCreateRequest }
816
564
 
817
565
  # @!attribute metadata
818
566
  # Additional data represented as key-value pairs. Both the key and value must be
@@ -831,11 +579,8 @@ module ModernTreasury
831
579
  # @!attribute party_address
832
580
  # Required if receiving wire payments.
833
581
  #
834
- # @return [ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount::PartyAddress, nil]
835
- optional :party_address,
836
- -> {
837
- ModernTreasury::PaymentOrderCreateParams::ReceivingAccount::PartyAddress
838
- }
582
+ # @return [ModernTreasury::Models::AddressRequest, nil]
583
+ optional :party_address, -> { ModernTreasury::AddressRequest }
839
584
 
840
585
  # @!attribute party_identifier
841
586
  #
@@ -871,7 +616,7 @@ module ModernTreasury
871
616
  ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::PaymentOrderCreateParams::ReceivingAccount::RoutingDetail]
872
617
  }
873
618
 
874
- # @!method initialize(account_details: nil, account_type: nil, contact_details: nil, ledger_account: nil, metadata: nil, name: nil, party_address: nil, party_identifier: nil, party_name: nil, party_type: nil, plaid_processor_token: nil, routing_details: nil)
619
+ # @!method initialize(account_details: nil, account_type: nil, contact_details: nil, external_id: nil, ledger_account: nil, metadata: nil, name: nil, party_address: nil, party_identifier: nil, party_name: nil, party_type: nil, plaid_processor_token: nil, routing_details: nil)
875
620
  # Some parameter documentations has been truncated, see
876
621
  # {ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount} for more
877
622
  # details.
@@ -884,15 +629,17 @@ module ModernTreasury
884
629
  #
885
630
  # @param account_type [Symbol, ModernTreasury::Models::ExternalAccountType] Can be `checking`, `savings` or `other`.
886
631
  #
887
- # @param contact_details [Array<ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount::ContactDetail>]
632
+ # @param contact_details [Array<ModernTreasury::Models::ContactDetailCreateRequest>]
633
+ #
634
+ # @param external_id [String, nil] An optional user-defined 180 character unique identifier.
888
635
  #
889
- # @param ledger_account [ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount::LedgerAccount] Specifies a ledger account object that will be created with the external account
636
+ # @param ledger_account [ModernTreasury::Models::LedgerAccountCreateRequest] Specifies a ledger account object that will be created with the external account
890
637
  #
891
638
  # @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
892
639
  #
893
640
  # @param name [String, nil] A nickname for the external account. This is only for internal usage and won't a
894
641
  #
895
- # @param party_address [ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount::PartyAddress] Required if receiving wire payments.
642
+ # @param party_address [ModernTreasury::Models::AddressRequest] Required if receiving wire payments.
896
643
  #
897
644
  # @param party_identifier [String]
898
645
  #
@@ -946,208 +693,6 @@ module ModernTreasury
946
693
  end
947
694
  end
948
695
 
949
- class ContactDetail < ModernTreasury::Internal::Type::BaseModel
950
- # @!attribute contact_identifier
951
- #
952
- # @return [String, nil]
953
- optional :contact_identifier, String
954
-
955
- # @!attribute contact_identifier_type
956
- #
957
- # @return [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount::ContactDetail::ContactIdentifierType, nil]
958
- optional :contact_identifier_type,
959
- enum: -> {
960
- ModernTreasury::PaymentOrderCreateParams::ReceivingAccount::ContactDetail::ContactIdentifierType
961
- }
962
-
963
- # @!method initialize(contact_identifier: nil, contact_identifier_type: nil)
964
- # @param contact_identifier [String]
965
- # @param contact_identifier_type [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount::ContactDetail::ContactIdentifierType]
966
-
967
- # @see ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount::ContactDetail#contact_identifier_type
968
- module ContactIdentifierType
969
- extend ModernTreasury::Internal::Type::Enum
970
-
971
- EMAIL = :email
972
- PHONE_NUMBER = :phone_number
973
- WEBSITE = :website
974
-
975
- # @!method self.values
976
- # @return [Array<Symbol>]
977
- end
978
- end
979
-
980
- # @see ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount#ledger_account
981
- class LedgerAccount < ModernTreasury::Internal::Type::BaseModel
982
- # @!attribute currency
983
- # The currency of the ledger account.
984
- #
985
- # @return [String]
986
- required :currency, String
987
-
988
- # @!attribute ledger_id
989
- # The id of the ledger that this account belongs to.
990
- #
991
- # @return [String]
992
- required :ledger_id, String
993
-
994
- # @!attribute name
995
- # The name of the ledger account.
996
- #
997
- # @return [String]
998
- required :name, String
999
-
1000
- # @!attribute normal_balance
1001
- # The normal balance of the ledger account.
1002
- #
1003
- # @return [Symbol, ModernTreasury::Models::TransactionDirection]
1004
- required :normal_balance, enum: -> { ModernTreasury::TransactionDirection }
1005
-
1006
- # @!attribute currency_exponent
1007
- # The currency exponent of the ledger account.
1008
- #
1009
- # @return [Integer, nil]
1010
- optional :currency_exponent, Integer, nil?: true
1011
-
1012
- # @!attribute description
1013
- # The description of the ledger account.
1014
- #
1015
- # @return [String, nil]
1016
- optional :description, String, nil?: true
1017
-
1018
- # @!attribute ledger_account_category_ids
1019
- # The array of ledger account category ids that this ledger account should be a
1020
- # child of.
1021
- #
1022
- # @return [Array<String>, nil]
1023
- optional :ledger_account_category_ids, ModernTreasury::Internal::Type::ArrayOf[String]
1024
-
1025
- # @!attribute ledgerable_id
1026
- # If the ledger account links to another object in Modern Treasury, the id will be
1027
- # populated here, otherwise null.
1028
- #
1029
- # @return [String, nil]
1030
- optional :ledgerable_id, String
1031
-
1032
- # @!attribute ledgerable_type
1033
- # If the ledger account links to another object in Modern Treasury, the type will
1034
- # be populated here, otherwise null. The value is one of internal_account or
1035
- # external_account.
1036
- #
1037
- # @return [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount::LedgerAccount::LedgerableType, nil]
1038
- optional :ledgerable_type,
1039
- enum: -> {
1040
- ModernTreasury::PaymentOrderCreateParams::ReceivingAccount::LedgerAccount::LedgerableType
1041
- }
1042
-
1043
- # @!attribute metadata
1044
- # Additional data represented as key-value pairs. Both the key and value must be
1045
- # strings.
1046
- #
1047
- # @return [Hash{Symbol=>String}, nil]
1048
- optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
1049
-
1050
- # @!method initialize(currency:, ledger_id:, name:, normal_balance:, currency_exponent: nil, description: nil, ledger_account_category_ids: nil, ledgerable_id: nil, ledgerable_type: nil, metadata: nil)
1051
- # Some parameter documentations has been truncated, see
1052
- # {ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount::LedgerAccount}
1053
- # for more details.
1054
- #
1055
- # Specifies a ledger account object that will be created with the external
1056
- # account. The resulting ledger account is linked to the external account for
1057
- # auto-ledgering Payment objects. See
1058
- # https://docs.moderntreasury.com/docs/linking-to-other-modern-treasury-objects
1059
- # for more details.
1060
- #
1061
- # @param currency [String] The currency of the ledger account.
1062
- #
1063
- # @param ledger_id [String] The id of the ledger that this account belongs to.
1064
- #
1065
- # @param name [String] The name of the ledger account.
1066
- #
1067
- # @param normal_balance [Symbol, ModernTreasury::Models::TransactionDirection] The normal balance of the ledger account.
1068
- #
1069
- # @param currency_exponent [Integer, nil] The currency exponent of the ledger account.
1070
- #
1071
- # @param description [String, nil] The description of the ledger account.
1072
- #
1073
- # @param ledger_account_category_ids [Array<String>] The array of ledger account category ids that this ledger account should be a ch
1074
- #
1075
- # @param ledgerable_id [String] If the ledger account links to another object in Modern Treasury, the id will be
1076
- #
1077
- # @param ledgerable_type [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount::LedgerAccount::LedgerableType] If the ledger account links to another object in Modern Treasury, the type will
1078
- #
1079
- # @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
1080
-
1081
- # If the ledger account links to another object in Modern Treasury, the type will
1082
- # be populated here, otherwise null. The value is one of internal_account or
1083
- # external_account.
1084
- #
1085
- # @see ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount::LedgerAccount#ledgerable_type
1086
- module LedgerableType
1087
- extend ModernTreasury::Internal::Type::Enum
1088
-
1089
- COUNTERPARTY = :counterparty
1090
- EXTERNAL_ACCOUNT = :external_account
1091
- INTERNAL_ACCOUNT = :internal_account
1092
- VIRTUAL_ACCOUNT = :virtual_account
1093
-
1094
- # @!method self.values
1095
- # @return [Array<Symbol>]
1096
- end
1097
- end
1098
-
1099
- # @see ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount#party_address
1100
- class PartyAddress < ModernTreasury::Internal::Type::BaseModel
1101
- # @!attribute country
1102
- # Country code conforms to [ISO 3166-1 alpha-2]
1103
- #
1104
- # @return [String, nil]
1105
- optional :country, String, nil?: true
1106
-
1107
- # @!attribute line1
1108
- #
1109
- # @return [String, nil]
1110
- optional :line1, String, nil?: true
1111
-
1112
- # @!attribute line2
1113
- #
1114
- # @return [String, nil]
1115
- optional :line2, String, nil?: true
1116
-
1117
- # @!attribute locality
1118
- # Locality or City.
1119
- #
1120
- # @return [String, nil]
1121
- optional :locality, String, nil?: true
1122
-
1123
- # @!attribute postal_code
1124
- # The postal code of the address.
1125
- #
1126
- # @return [String, nil]
1127
- optional :postal_code, String, nil?: true
1128
-
1129
- # @!attribute region
1130
- # Region or State.
1131
- #
1132
- # @return [String, nil]
1133
- optional :region, String, nil?: true
1134
-
1135
- # @!method initialize(country: nil, line1: nil, line2: nil, locality: nil, postal_code: nil, region: nil)
1136
- # Required if receiving wire payments.
1137
- #
1138
- # @param country [String, nil] Country code conforms to [ISO 3166-1 alpha-2]
1139
- #
1140
- # @param line1 [String, nil]
1141
- #
1142
- # @param line2 [String, nil]
1143
- #
1144
- # @param locality [String, nil] Locality or City.
1145
- #
1146
- # @param postal_code [String, nil] The postal code of the address.
1147
- #
1148
- # @param region [String, nil] Region or State.
1149
- end
1150
-
1151
696
  # Either `individual` or `business`.
1152
697
  #
1153
698
  # @see ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount#party_type