modern_treasury 0.1.0.pre.alpha.22 → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (295) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +38 -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/base_model.rb +4 -4
  7. data/lib/modern_treasury/models/accounting.rb +30 -0
  8. data/lib/modern_treasury/models/address.rb +94 -0
  9. data/lib/modern_treasury/models/address_request.rb +54 -0
  10. data/lib/modern_treasury/models/bulk_request_create_params.rb +144 -1505
  11. data/lib/modern_treasury/models/child_legal_entity_create.rb +275 -0
  12. data/lib/modern_treasury/models/connection_legal_entity_create_params.rb +10 -627
  13. data/lib/modern_treasury/models/contact_detail.rb +81 -0
  14. data/lib/modern_treasury/models/contact_detail_create_request.rb +34 -0
  15. data/lib/modern_treasury/models/counterparty.rb +24 -177
  16. data/lib/modern_treasury/models/counterparty_create_params.rb +37 -838
  17. data/lib/modern_treasury/models/counterparty_list_params.rb +9 -1
  18. data/lib/modern_treasury/models/document.rb +4 -6
  19. data/lib/modern_treasury/models/document_create_params.rb +0 -2
  20. data/lib/modern_treasury/models/document_list_params.rb +4 -6
  21. data/lib/modern_treasury/models/expected_payment.rb +9 -1
  22. data/lib/modern_treasury/models/expected_payment_create_params.rb +12 -230
  23. data/lib/modern_treasury/models/expected_payment_list_params.rb +8 -1
  24. data/lib/modern_treasury/models/expected_payment_update_params.rb +9 -1
  25. data/lib/modern_treasury/models/external_account.rb +15 -177
  26. data/lib/modern_treasury/models/external_account_create_params.rb +18 -210
  27. data/lib/modern_treasury/models/external_account_list_params.rb +9 -1
  28. data/lib/modern_treasury/models/external_account_update_params.rb +3 -52
  29. data/lib/modern_treasury/models/foreign_exchange_quote.rb +3 -73
  30. data/lib/modern_treasury/models/foreign_exchange_rate.rb +71 -0
  31. data/lib/modern_treasury/models/identification_create_request.rb +86 -0
  32. data/lib/modern_treasury/models/internal_account.rb +3 -95
  33. data/lib/modern_treasury/models/internal_account_update_account_capability_params.rb +34 -0
  34. data/lib/modern_treasury/models/internal_account_update_account_capability_response.rb +131 -0
  35. data/lib/modern_treasury/models/invoice.rb +3 -81
  36. data/lib/modern_treasury/models/invoice_create_params.rb +3 -83
  37. data/lib/modern_treasury/models/invoice_update_params.rb +3 -83
  38. data/lib/modern_treasury/models/ledger_account.rb +9 -141
  39. data/lib/modern_treasury/models/ledger_account_balance_monitor.rb +3 -182
  40. data/lib/modern_treasury/models/ledger_account_category.rb +3 -175
  41. data/lib/modern_treasury/models/ledger_account_category_list_params.rb +9 -5
  42. data/lib/modern_treasury/models/ledger_account_category_retrieve_params.rb +4 -2
  43. data/lib/modern_treasury/models/ledger_account_create_params.rb +2 -105
  44. data/lib/modern_treasury/models/ledger_account_create_request.rb +113 -0
  45. data/lib/modern_treasury/models/ledger_account_statement_create_response.rb +6 -360
  46. data/lib/modern_treasury/models/ledger_account_statement_retrieve_response.rb +6 -360
  47. data/lib/modern_treasury/models/ledger_balance.rb +45 -0
  48. data/lib/modern_treasury/models/ledger_balances.rb +38 -0
  49. data/lib/modern_treasury/models/ledger_entry.rb +3 -183
  50. data/lib/modern_treasury/models/ledger_entry_create_request.rb +98 -0
  51. data/lib/modern_treasury/models/ledger_entry_list_params.rb +48 -8
  52. data/lib/modern_treasury/models/ledger_transaction.rb +14 -6
  53. data/lib/modern_treasury/models/ledger_transaction_create_params.rb +2 -212
  54. data/lib/modern_treasury/models/ledger_transaction_create_request.rb +123 -0
  55. data/lib/modern_treasury/models/ledger_transaction_create_reversal_params.rb +0 -1
  56. data/lib/modern_treasury/models/ledger_transaction_list_params.rb +44 -7
  57. data/lib/modern_treasury/models/ledger_transaction_update_params.rb +5 -104
  58. data/lib/modern_treasury/models/ledger_transactions/ledger_transaction_version.rb +15 -193
  59. data/lib/modern_treasury/models/legal_entity_address_create_request.rb +78 -0
  60. data/lib/modern_treasury/models/legal_entity_association.rb +1 -0
  61. data/lib/modern_treasury/models/legal_entity_association_create_params.rb +4 -448
  62. data/lib/modern_treasury/models/legal_entity_create_params.rb +10 -618
  63. data/lib/modern_treasury/models/legal_entity_update_params.rb +6 -165
  64. data/lib/modern_treasury/models/line_item.rb +3 -29
  65. data/lib/modern_treasury/models/payment_action_list_params.rb +1 -0
  66. data/lib/modern_treasury/models/payment_order.rb +13 -102
  67. data/lib/modern_treasury/models/payment_order_create_async_params.rb +24 -477
  68. data/lib/modern_treasury/models/payment_order_create_params.rb +24 -479
  69. data/lib/modern_treasury/models/payment_order_update_params.rb +21 -248
  70. data/lib/modern_treasury/models/payment_orders/reversal_create_params.rb +3 -232
  71. data/lib/modern_treasury/models/payment_reference.rb +7 -1
  72. data/lib/modern_treasury/models/return_list_params.rb +5 -6
  73. data/lib/modern_treasury/models/return_object.rb +7 -3
  74. data/lib/modern_treasury/models/routing_detail.rb +3 -93
  75. data/lib/modern_treasury/models/routing_number_lookup_request.rb +3 -55
  76. data/lib/modern_treasury/models/transaction.rb +5 -73
  77. data/lib/modern_treasury/models/transactions/transaction_line_item.rb +0 -1
  78. data/lib/modern_treasury/models/virtual_account_create_params.rb +3 -117
  79. data/lib/modern_treasury/models.rb +31 -6
  80. data/lib/modern_treasury/resources/bulk_requests.rb +1 -1
  81. data/lib/modern_treasury/resources/counterparties.rb +20 -14
  82. data/lib/modern_treasury/resources/expected_payments.rb +10 -4
  83. data/lib/modern_treasury/resources/external_accounts.rb +23 -17
  84. data/lib/modern_treasury/resources/internal_accounts.rb +34 -0
  85. data/lib/modern_treasury/resources/invoices.rb +2 -2
  86. data/lib/modern_treasury/resources/ledger_account_categories.rb +1 -1
  87. data/lib/modern_treasury/resources/ledger_accounts.rb +1 -1
  88. data/lib/modern_treasury/resources/ledger_entries.rb +1 -1
  89. data/lib/modern_treasury/resources/ledger_transactions.rb +5 -5
  90. data/lib/modern_treasury/resources/legal_entities.rb +4 -4
  91. data/lib/modern_treasury/resources/legal_entity_associations.rb +1 -1
  92. data/lib/modern_treasury/resources/payment_orders/reversals.rb +1 -1
  93. data/lib/modern_treasury/resources/payment_orders.rb +5 -5
  94. data/lib/modern_treasury/resources/returns.rb +1 -1
  95. data/lib/modern_treasury/resources/virtual_accounts.rb +1 -1
  96. data/lib/modern_treasury/version.rb +1 -1
  97. data/lib/modern_treasury.rb +16 -6
  98. data/rbi/modern_treasury/client.rbi +0 -9
  99. data/rbi/modern_treasury/internal/transport/base_client.rbi +1 -1
  100. data/rbi/modern_treasury/models/accounting.rbi +48 -0
  101. data/rbi/modern_treasury/models/address.rbi +107 -0
  102. data/rbi/modern_treasury/models/address_request.rbi +76 -0
  103. data/rbi/modern_treasury/models/bulk_request_create_params.rbi +701 -3140
  104. data/rbi/modern_treasury/models/child_legal_entity_create.rbi +511 -0
  105. data/rbi/modern_treasury/models/connection_legal_entity_create_params.rbi +17 -1314
  106. data/rbi/modern_treasury/models/contact_detail.rbi +124 -0
  107. data/rbi/modern_treasury/models/contact_detail_create_request.rbi +99 -0
  108. data/rbi/modern_treasury/models/counterparty.rbi +24 -264
  109. data/rbi/modern_treasury/models/counterparty_create_params.rbi +47 -1718
  110. data/rbi/modern_treasury/models/counterparty_list_params.rbi +11 -0
  111. data/rbi/modern_treasury/models/document.rbi +6 -16
  112. data/rbi/modern_treasury/models/document_create_params.rbi +0 -10
  113. data/rbi/modern_treasury/models/document_list_params.rbi +6 -16
  114. data/rbi/modern_treasury/models/expected_payment.rbi +8 -0
  115. data/rbi/modern_treasury/models/expected_payment_create_params.rbi +12 -419
  116. data/rbi/modern_treasury/models/expected_payment_list_params.rbi +9 -0
  117. data/rbi/modern_treasury/models/expected_payment_update_params.rbi +8 -0
  118. data/rbi/modern_treasury/models/external_account.rbi +15 -244
  119. data/rbi/modern_treasury/models/external_account_create_params.rbi +20 -400
  120. data/rbi/modern_treasury/models/external_account_list_params.rbi +11 -0
  121. data/rbi/modern_treasury/models/external_account_update_params.rbi +4 -86
  122. data/rbi/modern_treasury/models/foreign_exchange_quote.rbi +4 -99
  123. data/rbi/modern_treasury/models/foreign_exchange_rate.rbi +96 -0
  124. data/rbi/modern_treasury/models/identification_create_request.rbi +212 -0
  125. data/rbi/modern_treasury/models/internal_account.rbi +4 -115
  126. data/rbi/modern_treasury/models/internal_account_update_account_capability_params.rbi +54 -0
  127. data/rbi/modern_treasury/models/internal_account_update_account_capability_response.rbi +304 -0
  128. data/rbi/modern_treasury/models/invoice.rbi +3 -128
  129. data/rbi/modern_treasury/models/invoice_create_params.rbi +4 -139
  130. data/rbi/modern_treasury/models/invoice_update_params.rbi +4 -139
  131. data/rbi/modern_treasury/models/ledger_account.rbi +12 -218
  132. data/rbi/modern_treasury/models/ledger_account_balance_monitor.rbi +4 -303
  133. data/rbi/modern_treasury/models/ledger_account_category.rbi +4 -301
  134. data/rbi/modern_treasury/models/ledger_account_category_list_params.rbi +14 -7
  135. data/rbi/modern_treasury/models/ledger_account_category_retrieve_params.rbi +6 -3
  136. data/rbi/modern_treasury/models/ledger_account_create_params.rbi +5 -173
  137. data/rbi/modern_treasury/models/ledger_account_create_request.rbi +194 -0
  138. data/rbi/modern_treasury/models/ledger_account_statement_create_response.rbi +8 -612
  139. data/rbi/modern_treasury/models/ledger_account_statement_retrieve_response.rbi +8 -612
  140. data/rbi/modern_treasury/models/ledger_balance.rbi +66 -0
  141. data/rbi/modern_treasury/models/ledger_balances.rbi +75 -0
  142. data/rbi/modern_treasury/models/ledger_entry.rbi +4 -309
  143. data/rbi/modern_treasury/models/ledger_entry_create_request.rbi +137 -0
  144. data/rbi/modern_treasury/models/ledger_entry_list_params.rbi +99 -16
  145. data/rbi/modern_treasury/models/ledger_transaction.rbi +17 -11
  146. data/rbi/modern_treasury/models/ledger_transaction_create_params.rbi +5 -383
  147. data/rbi/modern_treasury/models/ledger_transaction_create_request.rbi +258 -0
  148. data/rbi/modern_treasury/models/ledger_transaction_create_reversal_params.rbi +0 -5
  149. data/rbi/modern_treasury/models/ledger_transaction_list_params.rbi +93 -18
  150. data/rbi/modern_treasury/models/ledger_transaction_update_params.rbi +7 -158
  151. data/rbi/modern_treasury/models/ledger_transactions/ledger_transaction_version.rbi +18 -316
  152. data/rbi/modern_treasury/models/legal_entity_address_create_request.rbi +157 -0
  153. data/rbi/modern_treasury/models/legal_entity_association.rbi +5 -0
  154. data/rbi/modern_treasury/models/legal_entity_association_create_params.rbi +9 -917
  155. data/rbi/modern_treasury/models/legal_entity_create_params.rbi +17 -1297
  156. data/rbi/modern_treasury/models/legal_entity_update_params.rbi +8 -378
  157. data/rbi/modern_treasury/models/line_item.rbi +4 -52
  158. data/rbi/modern_treasury/models/payment_action_list_params.rbi +5 -0
  159. data/rbi/modern_treasury/models/payment_order.rbi +43 -159
  160. data/rbi/modern_treasury/models/payment_order_create_async_params.rbi +28 -882
  161. data/rbi/modern_treasury/models/payment_order_create_params.rbi +28 -887
  162. data/rbi/modern_treasury/models/payment_order_update_params.rbi +24 -460
  163. data/rbi/modern_treasury/models/payment_orders/reversal_create_params.rbi +4 -415
  164. data/rbi/modern_treasury/models/payment_reference.rbi +35 -5
  165. data/rbi/modern_treasury/models/return_list_params.rbi +6 -11
  166. data/rbi/modern_treasury/models/return_object.rbi +35 -12
  167. data/rbi/modern_treasury/models/routing_detail.rbi +4 -113
  168. data/rbi/modern_treasury/models/routing_number_lookup_request.rbi +4 -87
  169. data/rbi/modern_treasury/models/transaction.rbi +14 -103
  170. data/rbi/modern_treasury/models/transactions/transaction_line_item.rbi +0 -5
  171. data/rbi/modern_treasury/models/virtual_account_create_params.rbi +4 -203
  172. data/rbi/modern_treasury/models.rbi +36 -6
  173. data/rbi/modern_treasury/resources/bulk_requests.rbi +2 -2
  174. data/rbi/modern_treasury/resources/counterparties.rbi +20 -12
  175. data/rbi/modern_treasury/resources/documents.rbi +2 -2
  176. data/rbi/modern_treasury/resources/expected_payments.rbi +9 -1
  177. data/rbi/modern_treasury/resources/external_accounts.rbi +29 -22
  178. data/rbi/modern_treasury/resources/internal_accounts.rbi +24 -0
  179. data/rbi/modern_treasury/resources/invoices.rbi +2 -8
  180. data/rbi/modern_treasury/resources/ledger_account_categories.rbi +7 -3
  181. data/rbi/modern_treasury/resources/ledger_accounts.rbi +1 -1
  182. data/rbi/modern_treasury/resources/ledger_entries.rbi +9 -2
  183. data/rbi/modern_treasury/resources/ledger_transactions.rbi +13 -13
  184. data/rbi/modern_treasury/resources/legal_entities.rbi +4 -8
  185. data/rbi/modern_treasury/resources/legal_entity_associations.rbi +1 -2
  186. data/rbi/modern_treasury/resources/payment_orders/reversals.rbi +1 -1
  187. data/rbi/modern_treasury/resources/payment_orders.rbi +5 -8
  188. data/rbi/modern_treasury/resources/returns.rbi +2 -2
  189. data/rbi/modern_treasury/resources/virtual_accounts.rbi +1 -2
  190. data/sig/modern_treasury/client.rbs +0 -6
  191. data/sig/modern_treasury/internal/transport/base_client.rbs +1 -1
  192. data/sig/modern_treasury/models/accounting.rbs +15 -0
  193. data/sig/modern_treasury/models/address.rbs +70 -0
  194. data/sig/modern_treasury/models/address_request.rbs +45 -0
  195. data/sig/modern_treasury/models/bulk_request_create_params.rbs +88 -1089
  196. data/sig/modern_treasury/models/child_legal_entity_create.rbs +220 -0
  197. data/sig/modern_treasury/models/connection_legal_entity_create_params.rbs +21 -548
  198. data/sig/modern_treasury/models/contact_detail.rbs +67 -0
  199. data/sig/modern_treasury/models/contact_detail_create_request.rbs +43 -0
  200. data/sig/modern_treasury/models/counterparty.rbs +20 -141
  201. data/sig/modern_treasury/models/counterparty_create_params.rbs +49 -737
  202. data/sig/modern_treasury/models/counterparty_list_params.rbs +7 -0
  203. data/sig/modern_treasury/models/document.rbs +0 -4
  204. data/sig/modern_treasury/models/document_create_params.rbs +0 -4
  205. data/sig/modern_treasury/models/document_list_params.rbs +0 -4
  206. data/sig/modern_treasury/models/expected_payment.rbs +5 -0
  207. data/sig/modern_treasury/models/expected_payment_create_params.rbs +11 -173
  208. data/sig/modern_treasury/models/expected_payment_list_params.rbs +7 -0
  209. data/sig/modern_treasury/models/expected_payment_update_params.rbs +5 -0
  210. data/sig/modern_treasury/models/external_account.rbs +13 -139
  211. data/sig/modern_treasury/models/external_account_create_params.rbs +23 -189
  212. data/sig/modern_treasury/models/external_account_list_params.rbs +7 -0
  213. data/sig/modern_treasury/models/external_account_update_params.rbs +6 -48
  214. data/sig/modern_treasury/models/foreign_exchange_quote.rbs +4 -51
  215. data/sig/modern_treasury/models/foreign_exchange_rate.rbs +50 -0
  216. data/sig/modern_treasury/models/identification_create_request.rbs +93 -0
  217. data/sig/modern_treasury/models/internal_account.rbs +4 -71
  218. data/sig/modern_treasury/models/internal_account_update_account_capability_params.rbs +28 -0
  219. data/sig/modern_treasury/models/internal_account_update_account_capability_response.rbs +137 -0
  220. data/sig/modern_treasury/models/invoice.rbs +4 -68
  221. data/sig/modern_treasury/models/invoice_create_params.rbs +6 -70
  222. data/sig/modern_treasury/models/invoice_update_params.rbs +6 -70
  223. data/sig/modern_treasury/models/ledger_account.rbs +12 -123
  224. data/sig/modern_treasury/models/ledger_account_balance_monitor.rbs +4 -142
  225. data/sig/modern_treasury/models/ledger_account_category.rbs +4 -142
  226. data/sig/modern_treasury/models/ledger_account_category_list_params.rbs +5 -5
  227. data/sig/modern_treasury/models/ledger_account_create_params.rbs +4 -84
  228. data/sig/modern_treasury/models/ledger_account_create_request.rbs +89 -0
  229. data/sig/modern_treasury/models/ledger_account_statement_create_response.rbs +8 -284
  230. data/sig/modern_treasury/models/ledger_account_statement_retrieve_response.rbs +8 -284
  231. data/sig/modern_treasury/models/ledger_balance.rbs +40 -0
  232. data/sig/modern_treasury/models/ledger_balances.rbs +30 -0
  233. data/sig/modern_treasury/models/ledger_entry.rbs +4 -142
  234. data/sig/modern_treasury/models/ledger_entry_create_request.rbs +62 -0
  235. data/sig/modern_treasury/models/ledger_entry_list_params.rbs +21 -3
  236. data/sig/modern_treasury/models/ledger_transaction.rbs +5 -2
  237. data/sig/modern_treasury/models/ledger_transaction_create_params.rbs +4 -165
  238. data/sig/modern_treasury/models/ledger_transaction_create_request.rbs +109 -0
  239. data/sig/modern_treasury/models/ledger_transaction_create_reversal_params.rbs +0 -2
  240. data/sig/modern_treasury/models/ledger_transaction_list_params.rbs +21 -5
  241. data/sig/modern_treasury/models/ledger_transaction_update_params.rbs +6 -67
  242. data/sig/modern_treasury/models/ledger_transactions/ledger_transaction_version.rbs +9 -144
  243. data/sig/modern_treasury/models/legal_entity_address_create_request.rbs +68 -0
  244. data/sig/modern_treasury/models/legal_entity_association.rbs +3 -1
  245. data/sig/modern_treasury/models/legal_entity_association_create_params.rbs +9 -380
  246. data/sig/modern_treasury/models/legal_entity_create_params.rbs +21 -548
  247. data/sig/modern_treasury/models/legal_entity_update_params.rbs +12 -168
  248. data/sig/modern_treasury/models/line_item.rbs +4 -16
  249. data/sig/modern_treasury/models/payment_action_list_params.rbs +2 -1
  250. data/sig/modern_treasury/models/payment_order.rbs +22 -69
  251. data/sig/modern_treasury/models/payment_order_create_async_params.rbs +35 -380
  252. data/sig/modern_treasury/models/payment_order_create_params.rbs +35 -384
  253. data/sig/modern_treasury/models/payment_order_update_params.rbs +29 -207
  254. data/sig/modern_treasury/models/payment_orders/reversal_create_params.rbs +6 -173
  255. data/sig/modern_treasury/models/payment_reference.rbs +14 -2
  256. data/sig/modern_treasury/models/return_list_params.rbs +1 -6
  257. data/sig/modern_treasury/models/return_object.rbs +15 -10
  258. data/sig/modern_treasury/models/routing_detail.rbs +4 -71
  259. data/sig/modern_treasury/models/routing_number_lookup_request.rbs +6 -48
  260. data/sig/modern_treasury/models/transaction.rbs +8 -53
  261. data/sig/modern_treasury/models/transactions/transaction_line_item.rbs +0 -2
  262. data/sig/modern_treasury/models/virtual_account_create_params.rbs +6 -95
  263. data/sig/modern_treasury/models.rbs +30 -6
  264. data/sig/modern_treasury/resources/counterparties.rbs +2 -0
  265. data/sig/modern_treasury/resources/expected_payments.rbs +4 -1
  266. data/sig/modern_treasury/resources/external_accounts.rbs +6 -4
  267. data/sig/modern_treasury/resources/internal_accounts.rbs +7 -0
  268. data/sig/modern_treasury/resources/invoices.rbs +2 -2
  269. data/sig/modern_treasury/resources/ledger_account_categories.rbs +1 -1
  270. data/sig/modern_treasury/resources/ledger_accounts.rbs +1 -1
  271. data/sig/modern_treasury/resources/ledger_transactions.rbs +4 -4
  272. data/sig/modern_treasury/resources/legal_entities.rbs +4 -4
  273. data/sig/modern_treasury/resources/legal_entity_associations.rbs +1 -1
  274. data/sig/modern_treasury/resources/payment_orders/reversals.rbs +1 -1
  275. data/sig/modern_treasury/resources/payment_orders.rbs +5 -5
  276. data/sig/modern_treasury/resources/virtual_accounts.rbs +1 -1
  277. metadata +52 -22
  278. data/lib/modern_treasury/models/paper_item.rb +0 -178
  279. data/lib/modern_treasury/models/paper_item_list_params.rb +0 -56
  280. data/lib/modern_treasury/models/paper_item_retrieve_params.rb +0 -14
  281. data/lib/modern_treasury/resources/ledger_event_handlers.rb +0 -14
  282. data/lib/modern_treasury/resources/ledgerable_events.rb +0 -14
  283. data/lib/modern_treasury/resources/paper_items.rb +0 -68
  284. data/rbi/modern_treasury/models/paper_item.rbi +0 -204
  285. data/rbi/modern_treasury/models/paper_item_list_params.rbi +0 -88
  286. data/rbi/modern_treasury/models/paper_item_retrieve_params.rbi +0 -32
  287. data/rbi/modern_treasury/resources/ledger_event_handlers.rbi +0 -12
  288. data/rbi/modern_treasury/resources/ledgerable_events.rbi +0 -12
  289. data/rbi/modern_treasury/resources/paper_items.rbi +0 -51
  290. data/sig/modern_treasury/models/paper_item.rbs +0 -122
  291. data/sig/modern_treasury/models/paper_item_list_params.rbs +0 -54
  292. data/sig/modern_treasury/models/paper_item_retrieve_params.rbs +0 -15
  293. data/sig/modern_treasury/resources/ledger_event_handlers.rbs +0 -7
  294. data/sig/modern_treasury/resources/ledgerable_events.rbs +0 -7
  295. data/sig/modern_treasury/resources/paper_items.rbs +0 -21
@@ -0,0 +1,98 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ModernTreasury
4
+ module Models
5
+ class LedgerEntryCreateRequest < ModernTreasury::Internal::Type::BaseModel
6
+ # @!attribute amount
7
+ # Value in specified currency's smallest unit. e.g. $10 would be represented
8
+ # as 1000. Can be any integer up to 36 digits.
9
+ #
10
+ # @return [Integer]
11
+ required :amount, Integer
12
+
13
+ # @!attribute direction
14
+ # One of `credit`, `debit`. Describes the direction money is flowing in the
15
+ # transaction. A `credit` moves money from your account to someone else's. A
16
+ # `debit` pulls money from someone else's account to your own. Note that wire,
17
+ # rtp, and check payments will always be `credit`.
18
+ #
19
+ # @return [Symbol, ModernTreasury::Models::TransactionDirection]
20
+ required :direction, enum: -> { ModernTreasury::TransactionDirection }
21
+
22
+ # @!attribute ledger_account_id
23
+ # The ledger account that this ledger entry is associated with.
24
+ #
25
+ # @return [String]
26
+ required :ledger_account_id, String
27
+
28
+ # @!attribute available_balance_amount
29
+ # Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
30
+ # account’s available balance. If any of these conditions would be false after the
31
+ # transaction is created, the entire call will fail with error code 422.
32
+ #
33
+ # @return [Hash{Symbol=>Integer}, nil]
34
+ optional :available_balance_amount, ModernTreasury::Internal::Type::HashOf[Integer], nil?: true
35
+
36
+ # @!attribute lock_version
37
+ # Lock version of the ledger account. This can be passed when creating a ledger
38
+ # transaction to only succeed if no ledger transactions have posted since the
39
+ # given version. See our post about Designing the Ledgers API with Optimistic
40
+ # Locking for more details.
41
+ #
42
+ # @return [Integer, nil]
43
+ optional :lock_version, Integer, nil?: true
44
+
45
+ # @!attribute metadata
46
+ # Additional data represented as key-value pairs. Both the key and value must be
47
+ # strings.
48
+ #
49
+ # @return [Hash{Symbol=>String}, nil]
50
+ optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
51
+
52
+ # @!attribute pending_balance_amount
53
+ # Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
54
+ # account’s pending balance. If any of these conditions would be false after the
55
+ # transaction is created, the entire call will fail with error code 422.
56
+ #
57
+ # @return [Hash{Symbol=>Integer}, nil]
58
+ optional :pending_balance_amount, ModernTreasury::Internal::Type::HashOf[Integer], nil?: true
59
+
60
+ # @!attribute posted_balance_amount
61
+ # Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
62
+ # account’s posted balance. If any of these conditions would be false after the
63
+ # transaction is created, the entire call will fail with error code 422.
64
+ #
65
+ # @return [Hash{Symbol=>Integer}, nil]
66
+ optional :posted_balance_amount, ModernTreasury::Internal::Type::HashOf[Integer], nil?: true
67
+
68
+ # @!attribute show_resulting_ledger_account_balances
69
+ # If true, response will include the balance of the associated ledger account for
70
+ # the entry.
71
+ #
72
+ # @return [Boolean, nil]
73
+ optional :show_resulting_ledger_account_balances, ModernTreasury::Internal::Type::Boolean, nil?: true
74
+
75
+ # @!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)
76
+ # Some parameter documentations has been truncated, see
77
+ # {ModernTreasury::Models::LedgerEntryCreateRequest} for more details.
78
+ #
79
+ # @param amount [Integer] Value in specified currency's smallest unit. e.g. $10 would be represented as 10
80
+ #
81
+ # @param direction [Symbol, ModernTreasury::Models::TransactionDirection] One of `credit`, `debit`. Describes the direction money is flowing in the transa
82
+ #
83
+ # @param ledger_account_id [String] The ledger account that this ledger entry is associated with.
84
+ #
85
+ # @param available_balance_amount [Hash{Symbol=>Integer}, nil] Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the accou
86
+ #
87
+ # @param lock_version [Integer, nil] Lock version of the ledger account. This can be passed when creating a ledger tr
88
+ #
89
+ # @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
90
+ #
91
+ # @param pending_balance_amount [Hash{Symbol=>Integer}, nil] Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the accou
92
+ #
93
+ # @param posted_balance_amount [Hash{Symbol=>Integer}, nil] Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the accou
94
+ #
95
+ # @param show_resulting_ledger_account_balances [Boolean, nil] If true, response will include the balance of the associated ledger account for
96
+ end
97
+ end
98
+ end
@@ -128,10 +128,11 @@ module ModernTreasury
128
128
 
129
129
  # @!attribute status
130
130
  # Get all ledger entries that match the status specified. One of `pending`,
131
- # `posted`, or `archived`.
131
+ # `posted`, or `archived`. For multiple statuses, use
132
+ # `status[]=pending&status[]=posted`.
132
133
  #
133
- # @return [Symbol, ModernTreasury::Models::LedgerEntryListParams::Status, nil]
134
- optional :status, enum: -> { ModernTreasury::LedgerEntryListParams::Status }
134
+ # @return [Symbol, Array<Symbol, ModernTreasury::Models::LedgerEntryListParams::Status::UnionMember1>, ModernTreasury::Models::LedgerEntryListParams::Status, nil]
135
+ optional :status, union: -> { ModernTreasury::LedgerEntryListParams::Status }
135
136
 
136
137
  # @!attribute updated_at
137
138
  # Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the
@@ -181,7 +182,7 @@ module ModernTreasury
181
182
  #
182
183
  # @param show_deleted [Boolean] If true, response will include ledger entries that were deleted. When you update
183
184
  #
184
- # @param status [Symbol, ModernTreasury::Models::LedgerEntryListParams::Status] Get all ledger entries that match the status specified. One of `pending`, `poste
185
+ # @param status [Symbol, Array<Symbol, ModernTreasury::Models::LedgerEntryListParams::Status::UnionMember1>, ModernTreasury::Models::LedgerEntryListParams::Status] Get all ledger entries that match the status specified. One of `pending`, `poste
185
186
  #
186
187
  # @param updated_at [Hash{Symbol=>Time}] Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the pos
187
188
  #
@@ -230,16 +231,55 @@ module ModernTreasury
230
231
  end
231
232
 
232
233
  # Get all ledger entries that match the status specified. One of `pending`,
233
- # `posted`, or `archived`.
234
+ # `posted`, or `archived`. For multiple statuses, use
235
+ # `status[]=pending&status[]=posted`.
234
236
  module Status
235
- extend ModernTreasury::Internal::Type::Enum
237
+ extend ModernTreasury::Internal::Type::Union
238
+
239
+ variant const: -> { ModernTreasury::Models::LedgerEntryListParams::Status::PENDING }
240
+
241
+ variant const: -> { ModernTreasury::Models::LedgerEntryListParams::Status::POSTED }
242
+
243
+ variant const: -> { ModernTreasury::Models::LedgerEntryListParams::Status::ARCHIVED }
244
+
245
+ variant -> { ModernTreasury::Models::LedgerEntryListParams::Status::UnionMember1Array }
246
+
247
+ module UnionMember1
248
+ extend ModernTreasury::Internal::Type::Enum
249
+
250
+ PENDING = :pending
251
+ POSTED = :posted
252
+ ARCHIVED = :archived
253
+
254
+ # @!method self.values
255
+ # @return [Array<Symbol>]
256
+ end
257
+
258
+ # @!method self.variants
259
+ # @return [Array(Symbol, Array<Symbol, ModernTreasury::Models::LedgerEntryListParams::Status::UnionMember1>)]
260
+
261
+ define_sorbet_constant!(:Variants) do
262
+ T.type_alias do
263
+ T.any(
264
+ ModernTreasury::LedgerEntryListParams::Status::TaggedSymbol,
265
+ T::Array[ModernTreasury::LedgerEntryListParams::Status::UnionMember1::TaggedSymbol]
266
+ )
267
+ end
268
+ end
269
+
270
+ # @!group
236
271
 
237
272
  PENDING = :pending
238
273
  POSTED = :posted
239
274
  ARCHIVED = :archived
240
275
 
241
- # @!method self.values
242
- # @return [Array<Symbol>]
276
+ # @!endgroup
277
+
278
+ # @type [ModernTreasury::Internal::Type::Converter]
279
+ UnionMember1Array =
280
+ ModernTreasury::Internal::Type::ArrayOf[enum: -> {
281
+ ModernTreasury::LedgerEntryListParams::Status::UnionMember1
282
+ }]
243
283
  end
244
284
  end
245
285
  end
@@ -9,6 +9,15 @@ module ModernTreasury
9
9
  # @return [String]
10
10
  required :id, String
11
11
 
12
+ # @!attribute archived_reason
13
+ # System-set reason why the ledger transaction was archived; currently only
14
+ # 'balance_lock_failure' for transactions that violated balance constraints. Only
15
+ # populated when archive_on_balance_lock_failure is true and a balance lock
16
+ # violation occurs, otherwise null.
17
+ #
18
+ # @return [String, nil]
19
+ required :archived_reason, String, nil?: true
20
+
12
21
  # @!attribute created_at
13
22
  #
14
23
  # @return [Time]
@@ -63,8 +72,7 @@ module ModernTreasury
63
72
  # @!attribute ledgerable_type
64
73
  # If the ledger transaction can be reconciled to another object in Modern
65
74
  # Treasury, the type will be populated here, otherwise null. This can be one of
66
- # payment_order, incoming_payment_detail, expected_payment, return, paper_item, or
67
- # reversal.
75
+ # payment_order, incoming_payment_detail, expected_payment, return, or reversal.
68
76
  #
69
77
  # @return [Symbol, ModernTreasury::Models::LedgerTransaction::LedgerableType, nil]
70
78
  required :ledgerable_type, enum: -> { ModernTreasury::LedgerTransaction::LedgerableType }, nil?: true
@@ -124,12 +132,14 @@ module ModernTreasury
124
132
  # @return [Time]
125
133
  required :updated_at, Time
126
134
 
127
- # @!method initialize(id:, created_at:, description:, effective_at:, effective_date:, external_id:, ledger_entries:, ledger_id:, ledgerable_id:, ledgerable_type:, live_mode:, metadata:, object:, partially_posts_ledger_transaction_id:, posted_at:, reversed_by_ledger_transaction_id:, reverses_ledger_transaction_id:, status:, updated_at:)
135
+ # @!method initialize(id:, archived_reason:, created_at:, description:, effective_at:, effective_date:, external_id:, ledger_entries:, ledger_id:, ledgerable_id:, ledgerable_type:, live_mode:, metadata:, object:, partially_posts_ledger_transaction_id:, posted_at:, reversed_by_ledger_transaction_id:, reverses_ledger_transaction_id:, status:, updated_at:)
128
136
  # Some parameter documentations has been truncated, see
129
137
  # {ModernTreasury::Models::LedgerTransaction} for more details.
130
138
  #
131
139
  # @param id [String]
132
140
  #
141
+ # @param archived_reason [String, nil] System-set reason why the ledger transaction was archived; currently only 'balan
142
+ #
133
143
  # @param created_at [Time]
134
144
  #
135
145
  # @param description [String, nil] An optional description for internal use.
@@ -168,8 +178,7 @@ module ModernTreasury
168
178
 
169
179
  # If the ledger transaction can be reconciled to another object in Modern
170
180
  # Treasury, the type will be populated here, otherwise null. This can be one of
171
- # payment_order, incoming_payment_detail, expected_payment, return, paper_item, or
172
- # reversal.
181
+ # payment_order, incoming_payment_detail, expected_payment, return, or reversal.
173
182
  #
174
183
  # @see ModernTreasury::Models::LedgerTransaction#ledgerable_type
175
184
  module LedgerableType
@@ -177,7 +186,6 @@ module ModernTreasury
177
186
 
178
187
  EXPECTED_PAYMENT = :expected_payment
179
188
  INCOMING_PAYMENT_DETAIL = :incoming_payment_detail
180
- PAPER_ITEM = :paper_item
181
189
  PAYMENT_ORDER = :payment_order
182
190
  RETURN = :return
183
191
  REVERSAL = :reversal
@@ -3,222 +3,12 @@
3
3
  module ModernTreasury
4
4
  module Models
5
5
  # @see ModernTreasury::Resources::LedgerTransactions#create
6
- class LedgerTransactionCreateParams < ModernTreasury::Internal::Type::BaseModel
6
+ class LedgerTransactionCreateParams < ModernTreasury::Models::LedgerTransactionCreateRequest
7
7
  extend ModernTreasury::Internal::Type::RequestParameters::Converter
8
8
  include ModernTreasury::Internal::Type::RequestParameters
9
9
 
10
- # @!attribute ledger_entries
11
- # An array of ledger entry objects.
12
- #
13
- # @return [Array<ModernTreasury::Models::LedgerTransactionCreateParams::LedgerEntry>]
14
- required :ledger_entries,
15
- -> {
16
- ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::LedgerTransactionCreateParams::LedgerEntry]
17
- }
18
-
19
- # @!attribute description
20
- # An optional description for internal use.
21
- #
22
- # @return [String, nil]
23
- optional :description, String, nil?: true
24
-
25
- # @!attribute effective_at
26
- # The timestamp (ISO8601 format) at which the ledger transaction happened for
27
- # reporting purposes.
28
- #
29
- # @return [Time, nil]
30
- optional :effective_at, Time
31
-
32
- # @!attribute effective_date
33
- # The date (YYYY-MM-DD) on which the ledger transaction happened for reporting
34
- # purposes.
35
- #
36
- # @return [Date, nil]
37
- optional :effective_date, Date
38
-
39
- # @!attribute external_id
40
- # A unique string to represent the ledger transaction. Only one pending or posted
41
- # ledger transaction may have this ID in the ledger.
42
- #
43
- # @return [String, nil]
44
- optional :external_id, String
45
-
46
- # @!attribute ledgerable_id
47
- # If the ledger transaction can be reconciled to another object in Modern
48
- # Treasury, the id will be populated here, otherwise null.
49
- #
50
- # @return [String, nil]
51
- optional :ledgerable_id, String
52
-
53
- # @!attribute ledgerable_type
54
- # If the ledger transaction can be reconciled to another object in Modern
55
- # Treasury, the type will be populated here, otherwise null. This can be one of
56
- # payment_order, incoming_payment_detail, expected_payment, return, paper_item, or
57
- # reversal.
58
- #
59
- # @return [Symbol, ModernTreasury::Models::LedgerTransactionCreateParams::LedgerableType, nil]
60
- optional :ledgerable_type, enum: -> { ModernTreasury::LedgerTransactionCreateParams::LedgerableType }
61
-
62
- # @!attribute metadata
63
- # Additional data represented as key-value pairs. Both the key and value must be
64
- # strings.
65
- #
66
- # @return [Hash{Symbol=>String}, nil]
67
- optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
68
-
69
- # @!attribute status
70
- # To post a ledger transaction at creation, use `posted`.
71
- #
72
- # @return [Symbol, ModernTreasury::Models::LedgerTransactionCreateParams::Status, nil]
73
- optional :status, enum: -> { ModernTreasury::LedgerTransactionCreateParams::Status }
74
-
75
- # @!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, request_options: {})
76
- # Some parameter documentations has been truncated, see
77
- # {ModernTreasury::Models::LedgerTransactionCreateParams} for more details.
78
- #
79
- # @param ledger_entries [Array<ModernTreasury::Models::LedgerTransactionCreateParams::LedgerEntry>] An array of ledger entry objects.
80
- #
81
- # @param description [String, nil] An optional description for internal use.
82
- #
83
- # @param effective_at [Time] The timestamp (ISO8601 format) at which the ledger transaction happened for repo
84
- #
85
- # @param effective_date [Date] The date (YYYY-MM-DD) on which the ledger transaction happened for reporting pur
86
- #
87
- # @param external_id [String] A unique string to represent the ledger transaction. Only one pending or posted
88
- #
89
- # @param ledgerable_id [String] If the ledger transaction can be reconciled to another object in Modern Treasury
90
- #
91
- # @param ledgerable_type [Symbol, ModernTreasury::Models::LedgerTransactionCreateParams::LedgerableType] If the ledger transaction can be reconciled to another object in Modern Treasury
92
- #
93
- # @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
94
- #
95
- # @param status [Symbol, ModernTreasury::Models::LedgerTransactionCreateParams::Status] To post a ledger transaction at creation, use `posted`.
96
- #
10
+ # @!method initialize(request_options: {})
97
11
  # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
98
-
99
- class LedgerEntry < ModernTreasury::Internal::Type::BaseModel
100
- # @!attribute amount
101
- # Value in specified currency's smallest unit. e.g. $10 would be represented
102
- # as 1000. Can be any integer up to 36 digits.
103
- #
104
- # @return [Integer]
105
- required :amount, Integer
106
-
107
- # @!attribute direction
108
- # One of `credit`, `debit`. Describes the direction money is flowing in the
109
- # transaction. A `credit` moves money from your account to someone else's. A
110
- # `debit` pulls money from someone else's account to your own. Note that wire,
111
- # rtp, and check payments will always be `credit`.
112
- #
113
- # @return [Symbol, ModernTreasury::Models::TransactionDirection]
114
- required :direction, enum: -> { ModernTreasury::TransactionDirection }
115
-
116
- # @!attribute ledger_account_id
117
- # The ledger account that this ledger entry is associated with.
118
- #
119
- # @return [String]
120
- required :ledger_account_id, String
121
-
122
- # @!attribute available_balance_amount
123
- # Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
124
- # account’s available balance. If any of these conditions would be false after the
125
- # transaction is created, the entire call will fail with error code 422.
126
- #
127
- # @return [Hash{Symbol=>Integer}, nil]
128
- optional :available_balance_amount, ModernTreasury::Internal::Type::HashOf[Integer], nil?: true
129
-
130
- # @!attribute lock_version
131
- # Lock version of the ledger account. This can be passed when creating a ledger
132
- # transaction to only succeed if no ledger transactions have posted since the
133
- # given version. See our post about Designing the Ledgers API with Optimistic
134
- # Locking for more details.
135
- #
136
- # @return [Integer, nil]
137
- optional :lock_version, Integer, nil?: true
138
-
139
- # @!attribute metadata
140
- # Additional data represented as key-value pairs. Both the key and value must be
141
- # strings.
142
- #
143
- # @return [Hash{Symbol=>String}, nil]
144
- optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
145
-
146
- # @!attribute pending_balance_amount
147
- # Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
148
- # account’s pending balance. If any of these conditions would be false after the
149
- # transaction is created, the entire call will fail with error code 422.
150
- #
151
- # @return [Hash{Symbol=>Integer}, nil]
152
- optional :pending_balance_amount, ModernTreasury::Internal::Type::HashOf[Integer], nil?: true
153
-
154
- # @!attribute posted_balance_amount
155
- # Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
156
- # account’s posted balance. If any of these conditions would be false after the
157
- # transaction is created, the entire call will fail with error code 422.
158
- #
159
- # @return [Hash{Symbol=>Integer}, nil]
160
- optional :posted_balance_amount, ModernTreasury::Internal::Type::HashOf[Integer], nil?: true
161
-
162
- # @!attribute show_resulting_ledger_account_balances
163
- # If true, response will include the balance of the associated ledger account for
164
- # the entry.
165
- #
166
- # @return [Boolean, nil]
167
- optional :show_resulting_ledger_account_balances, ModernTreasury::Internal::Type::Boolean, nil?: true
168
-
169
- # @!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)
170
- # Some parameter documentations has been truncated, see
171
- # {ModernTreasury::Models::LedgerTransactionCreateParams::LedgerEntry} for more
172
- # details.
173
- #
174
- # @param amount [Integer] Value in specified currency's smallest unit. e.g. $10 would be represented as 10
175
- #
176
- # @param direction [Symbol, ModernTreasury::Models::TransactionDirection] One of `credit`, `debit`. Describes the direction money is flowing in the transa
177
- #
178
- # @param ledger_account_id [String] The ledger account that this ledger entry is associated with.
179
- #
180
- # @param available_balance_amount [Hash{Symbol=>Integer}, nil] Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the accou
181
- #
182
- # @param lock_version [Integer, nil] Lock version of the ledger account. This can be passed when creating a ledger tr
183
- #
184
- # @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
185
- #
186
- # @param pending_balance_amount [Hash{Symbol=>Integer}, nil] Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the accou
187
- #
188
- # @param posted_balance_amount [Hash{Symbol=>Integer}, nil] Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the accou
189
- #
190
- # @param show_resulting_ledger_account_balances [Boolean, nil] If true, response will include the balance of the associated ledger account for
191
- end
192
-
193
- # If the ledger transaction can be reconciled to another object in Modern
194
- # Treasury, the type will be populated here, otherwise null. This can be one of
195
- # payment_order, incoming_payment_detail, expected_payment, return, paper_item, or
196
- # reversal.
197
- module LedgerableType
198
- extend ModernTreasury::Internal::Type::Enum
199
-
200
- EXPECTED_PAYMENT = :expected_payment
201
- INCOMING_PAYMENT_DETAIL = :incoming_payment_detail
202
- PAPER_ITEM = :paper_item
203
- PAYMENT_ORDER = :payment_order
204
- RETURN = :return
205
- REVERSAL = :reversal
206
-
207
- # @!method self.values
208
- # @return [Array<Symbol>]
209
- end
210
-
211
- # To post a ledger transaction at creation, use `posted`.
212
- module Status
213
- extend ModernTreasury::Internal::Type::Enum
214
-
215
- ARCHIVED = :archived
216
- PENDING = :pending
217
- POSTED = :posted
218
-
219
- # @!method self.values
220
- # @return [Array<Symbol>]
221
- end
222
12
  end
223
13
  end
224
14
  end
@@ -0,0 +1,123 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ModernTreasury
4
+ module Models
5
+ class LedgerTransactionCreateRequest < ModernTreasury::Internal::Type::BaseModel
6
+ # @!attribute ledger_entries
7
+ # An array of ledger entry objects.
8
+ #
9
+ # @return [Array<ModernTreasury::Models::LedgerEntryCreateRequest>]
10
+ required :ledger_entries,
11
+ -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::LedgerEntryCreateRequest] }
12
+
13
+ # @!attribute description
14
+ # An optional description for internal use.
15
+ #
16
+ # @return [String, nil]
17
+ optional :description, String, nil?: true
18
+
19
+ # @!attribute effective_at
20
+ # The timestamp (ISO8601 format) at which the ledger transaction happened for
21
+ # reporting purposes.
22
+ #
23
+ # @return [Time, nil]
24
+ optional :effective_at, Time
25
+
26
+ # @!attribute effective_date
27
+ # The date (YYYY-MM-DD) on which the ledger transaction happened for reporting
28
+ # purposes.
29
+ #
30
+ # @return [Date, nil]
31
+ optional :effective_date, Date
32
+
33
+ # @!attribute external_id
34
+ # A unique string to represent the ledger transaction. Only one pending or posted
35
+ # ledger transaction may have this ID in the ledger.
36
+ #
37
+ # @return [String, nil]
38
+ optional :external_id, String
39
+
40
+ # @!attribute ledgerable_id
41
+ # If the ledger transaction can be reconciled to another object in Modern
42
+ # Treasury, the id will be populated here, otherwise null.
43
+ #
44
+ # @return [String, nil]
45
+ optional :ledgerable_id, String
46
+
47
+ # @!attribute ledgerable_type
48
+ # If the ledger transaction can be reconciled to another object in Modern
49
+ # Treasury, the type will be populated here, otherwise null. This can be one of
50
+ # payment_order, incoming_payment_detail, expected_payment, return, or reversal.
51
+ #
52
+ # @return [Symbol, ModernTreasury::Models::LedgerTransactionCreateRequest::LedgerableType, nil]
53
+ optional :ledgerable_type, enum: -> { ModernTreasury::LedgerTransactionCreateRequest::LedgerableType }
54
+
55
+ # @!attribute metadata
56
+ # Additional data represented as key-value pairs. Both the key and value must be
57
+ # strings.
58
+ #
59
+ # @return [Hash{Symbol=>String}, nil]
60
+ optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
61
+
62
+ # @!attribute status
63
+ # To post a ledger transaction at creation, use `posted`.
64
+ #
65
+ # @return [Symbol, ModernTreasury::Models::LedgerTransactionCreateRequest::Status, nil]
66
+ optional :status, enum: -> { ModernTreasury::LedgerTransactionCreateRequest::Status }
67
+
68
+ # @!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)
69
+ # Some parameter documentations has been truncated, see
70
+ # {ModernTreasury::Models::LedgerTransactionCreateRequest} for more details.
71
+ #
72
+ # @param ledger_entries [Array<ModernTreasury::Models::LedgerEntryCreateRequest>] An array of ledger entry objects.
73
+ #
74
+ # @param description [String, nil] An optional description for internal use.
75
+ #
76
+ # @param effective_at [Time] The timestamp (ISO8601 format) at which the ledger transaction happened for repo
77
+ #
78
+ # @param effective_date [Date] The date (YYYY-MM-DD) on which the ledger transaction happened for reporting pur
79
+ #
80
+ # @param external_id [String] A unique string to represent the ledger transaction. Only one pending or posted
81
+ #
82
+ # @param ledgerable_id [String] If the ledger transaction can be reconciled to another object in Modern Treasury
83
+ #
84
+ # @param ledgerable_type [Symbol, ModernTreasury::Models::LedgerTransactionCreateRequest::LedgerableType] If the ledger transaction can be reconciled to another object in Modern Treasury
85
+ #
86
+ # @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
87
+ #
88
+ # @param status [Symbol, ModernTreasury::Models::LedgerTransactionCreateRequest::Status] To post a ledger transaction at creation, use `posted`.
89
+
90
+ # If the ledger transaction can be reconciled to another object in Modern
91
+ # Treasury, the type will be populated here, otherwise null. This can be one of
92
+ # payment_order, incoming_payment_detail, expected_payment, return, or reversal.
93
+ #
94
+ # @see ModernTreasury::Models::LedgerTransactionCreateRequest#ledgerable_type
95
+ module LedgerableType
96
+ extend ModernTreasury::Internal::Type::Enum
97
+
98
+ EXPECTED_PAYMENT = :expected_payment
99
+ INCOMING_PAYMENT_DETAIL = :incoming_payment_detail
100
+ PAYMENT_ORDER = :payment_order
101
+ RETURN = :return
102
+ REVERSAL = :reversal
103
+
104
+ # @!method self.values
105
+ # @return [Array<Symbol>]
106
+ end
107
+
108
+ # To post a ledger transaction at creation, use `posted`.
109
+ #
110
+ # @see ModernTreasury::Models::LedgerTransactionCreateRequest#status
111
+ module Status
112
+ extend ModernTreasury::Internal::Type::Enum
113
+
114
+ ARCHIVED = :archived
115
+ PENDING = :pending
116
+ POSTED = :posted
117
+
118
+ # @!method self.values
119
+ # @return [Array<Symbol>]
120
+ end
121
+ end
122
+ end
123
+ end
@@ -85,7 +85,6 @@ module ModernTreasury
85
85
 
86
86
  EXPECTED_PAYMENT = :expected_payment
87
87
  INCOMING_PAYMENT_DETAIL = :incoming_payment_detail
88
- PAPER_ITEM = :paper_item
89
88
  PAYMENT_ORDER = :payment_order
90
89
  RETURN = :return
91
90
  REVERSAL = :reversal