modern_treasury 0.10.0 → 0.12.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 (173) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +40 -0
  3. data/README.md +10 -1
  4. data/lib/modern_treasury/client.rb +12 -0
  5. data/lib/modern_treasury/internal/transport/pooled_net_requester.rb +12 -10
  6. data/lib/modern_treasury/internal/util.rb +7 -2
  7. data/lib/modern_treasury/models/bulk_request_create_params.rb +146 -2
  8. data/lib/modern_treasury/models/child_legal_entity.rb +609 -0
  9. data/lib/modern_treasury/models/child_legal_entity_create.rb +63 -1
  10. data/lib/modern_treasury/models/connection_legal_entity.rb +2 -0
  11. data/lib/modern_treasury/models/connection_legal_entity_create_params.rb +54 -63
  12. data/lib/modern_treasury/models/connection_legal_entity_list_params.rb +2 -0
  13. data/lib/modern_treasury/models/counterparty_create_params.rb +54 -59
  14. data/lib/modern_treasury/models/expected_payment.rb +69 -1
  15. data/lib/modern_treasury/models/expected_payment_create_params.rb +65 -1
  16. data/lib/modern_treasury/models/expected_payment_update_params.rb +65 -1
  17. data/lib/modern_treasury/models/hold_create_params.rb +74 -0
  18. data/lib/modern_treasury/models/hold_create_response.rb +143 -0
  19. data/lib/modern_treasury/models/hold_list_params.rb +89 -0
  20. data/lib/modern_treasury/models/hold_list_response.rb +143 -0
  21. data/lib/modern_treasury/models/hold_retrieve_params.rb +14 -0
  22. data/lib/modern_treasury/models/hold_retrieve_response.rb +143 -0
  23. data/lib/modern_treasury/models/hold_update_params.rb +40 -0
  24. data/lib/modern_treasury/models/hold_update_response.rb +143 -0
  25. data/lib/modern_treasury/models/incoming_payment_detail.rb +5 -0
  26. data/lib/modern_treasury/models/incoming_payment_detail_create_async_params.rb +5 -0
  27. data/lib/modern_treasury/models/incoming_payment_detail_list_params.rb +5 -0
  28. data/lib/modern_treasury/models/internal_account.rb +10 -1
  29. data/lib/modern_treasury/models/internal_account_request_closure_params.rb +14 -0
  30. data/lib/modern_treasury/models/internal_account_update_params.rb +9 -1
  31. data/lib/modern_treasury/models/invoice.rb +2 -0
  32. data/lib/modern_treasury/models/invoice_create_params.rb +1 -19
  33. data/lib/modern_treasury/models/invoice_update_params.rb +1 -19
  34. data/lib/modern_treasury/models/journal_entry_list_params.rb +38 -0
  35. data/lib/modern_treasury/models/journal_entry_retrieve_params.rb +14 -0
  36. data/lib/modern_treasury/models/journal_report_list_params.rb +14 -0
  37. data/lib/modern_treasury/models/journal_report_retrieve_params.rb +14 -0
  38. data/lib/modern_treasury/models/journal_report_update_params.rb +26 -0
  39. data/lib/modern_treasury/models/ledger_entry.rb +10 -1
  40. data/lib/modern_treasury/models/ledger_entry_create_request.rb +10 -1
  41. data/lib/modern_treasury/models/ledger_transactions/ledger_transaction_version.rb +10 -1
  42. data/lib/modern_treasury/models/legal_entity.rb +61 -11
  43. data/lib/modern_treasury/models/legal_entity_association.rb +3 -559
  44. data/lib/modern_treasury/models/legal_entity_association_inline_create.rb +60 -0
  45. data/lib/modern_treasury/models/legal_entity_create_params.rb +54 -59
  46. data/lib/modern_treasury/models/legal_entity_update_params.rb +51 -1
  47. data/lib/modern_treasury/models/payment_order.rb +5 -1
  48. data/lib/modern_treasury/models/payment_order_subtype.rb +0 -1
  49. data/lib/modern_treasury/models/payment_reference.rb +5 -1
  50. data/lib/modern_treasury/models/return_object.rb +6 -1
  51. data/lib/modern_treasury/models/transaction.rb +2 -1
  52. data/lib/modern_treasury/models.rb +24 -0
  53. data/lib/modern_treasury/resources/expected_payments.rb +18 -2
  54. data/lib/modern_treasury/resources/holds.rb +126 -0
  55. data/lib/modern_treasury/resources/internal_accounts.rb +23 -1
  56. data/lib/modern_treasury/resources/invoices.rb +2 -10
  57. data/lib/modern_treasury/resources/journal_entries.rb +60 -0
  58. data/lib/modern_treasury/resources/journal_reports.rb +78 -0
  59. data/lib/modern_treasury/resources/ledger_accounts.rb +3 -3
  60. data/lib/modern_treasury/resources/ledger_transactions.rb +5 -2
  61. data/lib/modern_treasury/resources/legal_entities.rb +27 -3
  62. data/lib/modern_treasury/version.rb +1 -1
  63. data/lib/modern_treasury.rb +20 -0
  64. data/manifest.yaml +1 -0
  65. data/rbi/modern_treasury/client.rbi +9 -0
  66. data/rbi/modern_treasury/models/bulk_request_create_params.rbi +272 -0
  67. data/rbi/modern_treasury/models/child_legal_entity.rbi +969 -0
  68. data/rbi/modern_treasury/models/child_legal_entity_create.rbi +78 -0
  69. data/rbi/modern_treasury/models/connection_legal_entity.rbi +10 -0
  70. data/rbi/modern_treasury/models/connection_legal_entity_create_params.rbi +61 -135
  71. data/rbi/modern_treasury/models/connection_legal_entity_list_params.rbi +10 -0
  72. data/rbi/modern_treasury/models/counterparty_create_params.rbi +61 -135
  73. data/rbi/modern_treasury/models/expected_payment.rbi +136 -0
  74. data/rbi/modern_treasury/models/expected_payment_create_params.rbi +136 -0
  75. data/rbi/modern_treasury/models/expected_payment_update_params.rbi +136 -0
  76. data/rbi/modern_treasury/models/hold_create_params.rbi +125 -0
  77. data/rbi/modern_treasury/models/hold_create_response.rbi +232 -0
  78. data/rbi/modern_treasury/models/hold_list_params.rbi +150 -0
  79. data/rbi/modern_treasury/models/hold_list_response.rbi +225 -0
  80. data/rbi/modern_treasury/models/hold_retrieve_params.rbi +32 -0
  81. data/rbi/modern_treasury/models/hold_retrieve_response.rbi +234 -0
  82. data/rbi/modern_treasury/models/hold_update_params.rbi +79 -0
  83. data/rbi/modern_treasury/models/hold_update_response.rbi +232 -0
  84. data/rbi/modern_treasury/models/incoming_payment_detail.rbi +25 -0
  85. data/rbi/modern_treasury/models/incoming_payment_detail_create_async_params.rbi +25 -0
  86. data/rbi/modern_treasury/models/incoming_payment_detail_list_params.rbi +25 -0
  87. data/rbi/modern_treasury/models/internal_account.rbi +10 -0
  88. data/rbi/modern_treasury/models/internal_account_request_closure_params.rbi +32 -0
  89. data/rbi/modern_treasury/models/internal_account_update_params.rbi +11 -0
  90. data/rbi/modern_treasury/models/invoice_create_params.rbi +0 -20
  91. data/rbi/modern_treasury/models/invoice_update_params.rbi +0 -20
  92. data/rbi/modern_treasury/models/journal_entry_list_params.rbi +68 -0
  93. data/rbi/modern_treasury/models/journal_entry_retrieve_params.rbi +32 -0
  94. data/rbi/modern_treasury/models/journal_report_list_params.rbi +32 -0
  95. data/rbi/modern_treasury/models/journal_report_retrieve_params.rbi +32 -0
  96. data/rbi/modern_treasury/models/journal_report_update_params.rbi +52 -0
  97. data/rbi/modern_treasury/models/ledger_entry.rbi +10 -0
  98. data/rbi/modern_treasury/models/ledger_entry_create_request.rbi +13 -0
  99. data/rbi/modern_treasury/models/ledger_transactions/ledger_transaction_version.rbi +10 -0
  100. data/rbi/modern_treasury/models/legal_entity.rbi +67 -15
  101. data/rbi/modern_treasury/models/legal_entity_association.rbi +4 -962
  102. data/rbi/modern_treasury/models/legal_entity_association_inline_create.rbi +130 -0
  103. data/rbi/modern_treasury/models/legal_entity_create_params.rbi +61 -134
  104. data/rbi/modern_treasury/models/legal_entity_update_params.rbi +58 -0
  105. data/rbi/modern_treasury/models/payment_order.rbi +22 -2
  106. data/rbi/modern_treasury/models/payment_order_subtype.rbi +0 -1
  107. data/rbi/modern_treasury/models/payment_reference.rbi +22 -2
  108. data/rbi/modern_treasury/models/return_object.rbi +24 -2
  109. data/rbi/modern_treasury/models/transaction.rbi +7 -2
  110. data/rbi/modern_treasury/models.rbi +28 -0
  111. data/rbi/modern_treasury/resources/expected_payments.rbi +44 -0
  112. data/rbi/modern_treasury/resources/holds.rbi +108 -0
  113. data/rbi/modern_treasury/resources/internal_accounts.rbi +17 -0
  114. data/rbi/modern_treasury/resources/invoices.rbi +0 -16
  115. data/rbi/modern_treasury/resources/journal_entries.rbi +46 -0
  116. data/rbi/modern_treasury/resources/journal_reports.rbi +51 -0
  117. data/rbi/modern_treasury/resources/ledger_accounts.rbi +3 -3
  118. data/rbi/modern_treasury/resources/ledger_transactions.rbi +3 -2
  119. data/rbi/modern_treasury/resources/legal_entities.rbi +41 -1
  120. data/sig/modern_treasury/client.rbs +6 -0
  121. data/sig/modern_treasury/models/bulk_request_create_params.rbs +84 -0
  122. data/sig/modern_treasury/models/child_legal_entity.rbs +469 -0
  123. data/sig/modern_treasury/models/child_legal_entity_create.rbs +39 -0
  124. data/sig/modern_treasury/models/connection_legal_entity.rbs +4 -1
  125. data/sig/modern_treasury/models/connection_legal_entity_create_params.rbs +38 -60
  126. data/sig/modern_treasury/models/connection_legal_entity_list_params.rbs +4 -1
  127. data/sig/modern_treasury/models/counterparty_create_params.rbs +38 -60
  128. data/sig/modern_treasury/models/expected_payment.rbs +42 -0
  129. data/sig/modern_treasury/models/expected_payment_create_params.rbs +42 -0
  130. data/sig/modern_treasury/models/expected_payment_update_params.rbs +42 -0
  131. data/sig/modern_treasury/models/hold_create_params.rbs +66 -0
  132. data/sig/modern_treasury/models/hold_create_response.rbs +108 -0
  133. data/sig/modern_treasury/models/hold_list_params.rbs +76 -0
  134. data/sig/modern_treasury/models/hold_list_response.rbs +108 -0
  135. data/sig/modern_treasury/models/hold_retrieve_params.rbs +15 -0
  136. data/sig/modern_treasury/models/hold_retrieve_response.rbs +108 -0
  137. data/sig/modern_treasury/models/hold_update_params.rbs +41 -0
  138. data/sig/modern_treasury/models/hold_update_response.rbs +108 -0
  139. data/sig/modern_treasury/models/incoming_payment_detail.rbs +10 -0
  140. data/sig/modern_treasury/models/incoming_payment_detail_create_async_params.rbs +10 -0
  141. data/sig/modern_treasury/models/incoming_payment_detail_list_params.rbs +10 -0
  142. data/sig/modern_treasury/models/internal_account.rbs +5 -0
  143. data/sig/modern_treasury/models/internal_account_request_closure_params.rbs +15 -0
  144. data/sig/modern_treasury/models/internal_account_update_params.rbs +7 -0
  145. data/sig/modern_treasury/models/invoice_create_params.rbs +0 -10
  146. data/sig/modern_treasury/models/invoice_update_params.rbs +0 -10
  147. data/sig/modern_treasury/models/journal_entry_list_params.rbs +36 -0
  148. data/sig/modern_treasury/models/journal_entry_retrieve_params.rbs +15 -0
  149. data/sig/modern_treasury/models/journal_report_list_params.rbs +15 -0
  150. data/sig/modern_treasury/models/journal_report_retrieve_params.rbs +15 -0
  151. data/sig/modern_treasury/models/journal_report_update_params.rbs +32 -0
  152. data/sig/modern_treasury/models/ledger_entry.rbs +5 -0
  153. data/sig/modern_treasury/models/ledger_entry_create_request.rbs +7 -0
  154. data/sig/modern_treasury/models/ledger_transactions/ledger_transaction_version.rbs +5 -0
  155. data/sig/modern_treasury/models/legal_entity.rbs +38 -8
  156. data/sig/modern_treasury/models/legal_entity_association.rbs +4 -435
  157. data/sig/modern_treasury/models/legal_entity_association_inline_create.rbs +59 -0
  158. data/sig/modern_treasury/models/legal_entity_create_params.rbs +38 -60
  159. data/sig/modern_treasury/models/legal_entity_update_params.rbs +34 -0
  160. data/sig/modern_treasury/models/payment_order.rbs +10 -2
  161. data/sig/modern_treasury/models/payment_order_subtype.rbs +0 -2
  162. data/sig/modern_treasury/models/payment_reference.rbs +10 -2
  163. data/sig/modern_treasury/models/return_object.rbs +12 -2
  164. data/sig/modern_treasury/models/transaction.rbs +4 -2
  165. data/sig/modern_treasury/models.rbs +24 -0
  166. data/sig/modern_treasury/resources/expected_payments.rbs +8 -0
  167. data/sig/modern_treasury/resources/holds.rbs +38 -0
  168. data/sig/modern_treasury/resources/internal_accounts.rbs +6 -0
  169. data/sig/modern_treasury/resources/invoices.rbs +0 -4
  170. data/sig/modern_treasury/resources/journal_entries.rbs +19 -0
  171. data/sig/modern_treasury/resources/journal_reports.rbs +21 -0
  172. data/sig/modern_treasury/resources/legal_entities.rbs +13 -1
  173. metadata +59 -2
@@ -16,6 +16,38 @@ module ModernTreasury
16
16
  # @return [Integer, nil]
17
17
  required :amount_lower_bound, Integer, nil?: true
18
18
 
19
+ # @!attribute amount_reconciled
20
+ # The amount reconciled for this expected payment. Value in specified currency's
21
+ # smallest unit. e.g. $10 would be represented as 1000.
22
+ #
23
+ # @return [Integer, nil]
24
+ required :amount_reconciled, Integer, nil?: true
25
+
26
+ # @!attribute amount_reconciled_direction
27
+ # One of credit or debit. Indicates whether amount_reconciled is a credit or debit
28
+ # amount.
29
+ #
30
+ # @return [Symbol, ModernTreasury::Models::ExpectedPayment::AmountReconciledDirection, nil]
31
+ required :amount_reconciled_direction,
32
+ enum: -> { ModernTreasury::ExpectedPayment::AmountReconciledDirection },
33
+ nil?: true
34
+
35
+ # @!attribute amount_unreconciled
36
+ # The amount that remains unreconciled for this expected payment. Value in
37
+ # specified currency's smallest unit. e.g. $10 would be represented as 1000.
38
+ #
39
+ # @return [Integer, nil]
40
+ required :amount_unreconciled, Integer, nil?: true
41
+
42
+ # @!attribute amount_unreconciled_direction
43
+ # One of credit or debit. Indicates whether amount_unreconciled is a credit or
44
+ # debit amount.
45
+ #
46
+ # @return [Symbol, ModernTreasury::Models::ExpectedPayment::AmountUnreconciledDirection, nil]
47
+ required :amount_unreconciled_direction,
48
+ enum: -> { ModernTreasury::ExpectedPayment::AmountUnreconciledDirection },
49
+ nil?: true
50
+
19
51
  # @!attribute amount_upper_bound
20
52
  # The highest amount this expected payment may be equal to. Value in specified
21
53
  # currency's smallest unit. e.g. $10 would be represented as 1000.
@@ -179,7 +211,7 @@ module ModernTreasury
179
211
  # @return [Time]
180
212
  required :updated_at, Time
181
213
 
182
- # @!method initialize(id:, amount_lower_bound:, amount_upper_bound:, counterparty_id:, created_at:, currency:, date_lower_bound:, date_upper_bound:, description:, direction:, external_id:, internal_account_id:, ledger_transaction_id:, live_mode:, metadata:, object:, reconciliation_filters:, reconciliation_groups:, reconciliation_method:, reconciliation_rule_variables:, remittance_information:, statement_descriptor:, status:, transaction_id:, transaction_line_item_id:, type:, updated_at:)
214
+ # @!method initialize(id:, amount_lower_bound:, amount_reconciled:, amount_reconciled_direction:, amount_unreconciled:, amount_unreconciled_direction:, amount_upper_bound:, counterparty_id:, created_at:, currency:, date_lower_bound:, date_upper_bound:, description:, direction:, external_id:, internal_account_id:, ledger_transaction_id:, live_mode:, metadata:, object:, reconciliation_filters:, reconciliation_groups:, reconciliation_method:, reconciliation_rule_variables:, remittance_information:, statement_descriptor:, status:, transaction_id:, transaction_line_item_id:, type:, updated_at:)
183
215
  # Some parameter documentations has been truncated, see
184
216
  # {ModernTreasury::Models::ExpectedPayment} for more details.
185
217
  #
@@ -187,6 +219,14 @@ module ModernTreasury
187
219
  #
188
220
  # @param amount_lower_bound [Integer, nil] The lowest amount this expected payment may be equal to. Value in specified curr
189
221
  #
222
+ # @param amount_reconciled [Integer, nil] The amount reconciled for this expected payment. Value in specified currency's s
223
+ #
224
+ # @param amount_reconciled_direction [Symbol, ModernTreasury::Models::ExpectedPayment::AmountReconciledDirection, nil] One of credit or debit. Indicates whether amount_reconciled is a credit or debit
225
+ #
226
+ # @param amount_unreconciled [Integer, nil] The amount that remains unreconciled for this expected payment. Value in specifi
227
+ #
228
+ # @param amount_unreconciled_direction [Symbol, ModernTreasury::Models::ExpectedPayment::AmountUnreconciledDirection, nil] One of credit or debit. Indicates whether amount_unreconciled is a credit or deb
229
+ #
190
230
  # @param amount_upper_bound [Integer, nil] The highest amount this expected payment may be equal to. Value in specified cur
191
231
  #
192
232
  # @param counterparty_id [String, nil] The ID of the counterparty you expect for this payment.
@@ -237,6 +277,34 @@ module ModernTreasury
237
277
  #
238
278
  # @param updated_at [Time]
239
279
 
280
+ # One of credit or debit. Indicates whether amount_reconciled is a credit or debit
281
+ # amount.
282
+ #
283
+ # @see ModernTreasury::Models::ExpectedPayment#amount_reconciled_direction
284
+ module AmountReconciledDirection
285
+ extend ModernTreasury::Internal::Type::Enum
286
+
287
+ CREDIT = :credit
288
+ DEBIT = :debit
289
+
290
+ # @!method self.values
291
+ # @return [Array<Symbol>]
292
+ end
293
+
294
+ # One of credit or debit. Indicates whether amount_unreconciled is a credit or
295
+ # debit amount.
296
+ #
297
+ # @see ModernTreasury::Models::ExpectedPayment#amount_unreconciled_direction
298
+ module AmountUnreconciledDirection
299
+ extend ModernTreasury::Internal::Type::Enum
300
+
301
+ CREDIT = :credit
302
+ DEBIT = :debit
303
+
304
+ # @!method self.values
305
+ # @return [Array<Symbol>]
306
+ end
307
+
240
308
  # One of credit or debit. When you are receiving money, use credit. When you are
241
309
  # being charged, use debit.
242
310
  #
@@ -14,6 +14,38 @@ module ModernTreasury
14
14
  # @return [Integer, nil]
15
15
  optional :amount_lower_bound, Integer, nil?: true
16
16
 
17
+ # @!attribute amount_reconciled
18
+ # The amount reconciled for this expected payment. Value in specified currency's
19
+ # smallest unit. e.g. $10 would be represented as 1000.
20
+ #
21
+ # @return [Integer, nil]
22
+ optional :amount_reconciled, Integer, nil?: true
23
+
24
+ # @!attribute amount_reconciled_direction
25
+ # One of credit or debit. Indicates whether amount_reconciled is a credit or debit
26
+ # amount.
27
+ #
28
+ # @return [Symbol, ModernTreasury::Models::ExpectedPaymentCreateParams::AmountReconciledDirection, nil]
29
+ optional :amount_reconciled_direction,
30
+ enum: -> { ModernTreasury::ExpectedPaymentCreateParams::AmountReconciledDirection },
31
+ nil?: true
32
+
33
+ # @!attribute amount_unreconciled
34
+ # The amount that remains unreconciled for this expected payment. Value in
35
+ # specified currency's smallest unit. e.g. $10 would be represented as 1000.
36
+ #
37
+ # @return [Integer, nil]
38
+ optional :amount_unreconciled, Integer, nil?: true
39
+
40
+ # @!attribute amount_unreconciled_direction
41
+ # One of credit or debit. Indicates whether amount_unreconciled is a credit or
42
+ # debit amount.
43
+ #
44
+ # @return [Symbol, ModernTreasury::Models::ExpectedPaymentCreateParams::AmountUnreconciledDirection, nil]
45
+ optional :amount_unreconciled_direction,
46
+ enum: -> { ModernTreasury::ExpectedPaymentCreateParams::AmountUnreconciledDirection },
47
+ nil?: true
48
+
17
49
  # @!attribute amount_upper_bound
18
50
  # The highest amount this expected payment may be equal to. Value in specified
19
51
  # currency's smallest unit. e.g. $10 would be represented as 1000.
@@ -145,12 +177,20 @@ module ModernTreasury
145
177
  # @return [Symbol, ModernTreasury::Models::ExpectedPaymentType, nil]
146
178
  optional :type, enum: -> { ModernTreasury::ExpectedPaymentType }, nil?: true
147
179
 
148
- # @!method initialize(amount_lower_bound: nil, amount_upper_bound: nil, counterparty_id: nil, currency: nil, date_lower_bound: nil, date_upper_bound: nil, description: nil, direction: nil, external_id: nil, internal_account_id: nil, ledger_transaction: nil, ledger_transaction_id: nil, line_items: nil, metadata: nil, reconciliation_filters: nil, reconciliation_groups: nil, reconciliation_rule_variables: nil, remittance_information: nil, statement_descriptor: nil, type: nil, request_options: {})
180
+ # @!method initialize(amount_lower_bound: nil, amount_reconciled: nil, amount_reconciled_direction: nil, amount_unreconciled: nil, amount_unreconciled_direction: nil, amount_upper_bound: nil, counterparty_id: nil, currency: nil, date_lower_bound: nil, date_upper_bound: nil, description: nil, direction: nil, external_id: nil, internal_account_id: nil, ledger_transaction: nil, ledger_transaction_id: nil, line_items: nil, metadata: nil, reconciliation_filters: nil, reconciliation_groups: nil, reconciliation_rule_variables: nil, remittance_information: nil, statement_descriptor: nil, type: nil, request_options: {})
149
181
  # Some parameter documentations has been truncated, see
150
182
  # {ModernTreasury::Models::ExpectedPaymentCreateParams} for more details.
151
183
  #
152
184
  # @param amount_lower_bound [Integer, nil] The lowest amount this expected payment may be equal to. Value in specified curr
153
185
  #
186
+ # @param amount_reconciled [Integer, nil] The amount reconciled for this expected payment. Value in specified currency's s
187
+ #
188
+ # @param amount_reconciled_direction [Symbol, ModernTreasury::Models::ExpectedPaymentCreateParams::AmountReconciledDirection, nil] One of credit or debit. Indicates whether amount_reconciled is a credit or debit
189
+ #
190
+ # @param amount_unreconciled [Integer, nil] The amount that remains unreconciled for this expected payment. Value in specifi
191
+ #
192
+ # @param amount_unreconciled_direction [Symbol, ModernTreasury::Models::ExpectedPaymentCreateParams::AmountUnreconciledDirection, nil] One of credit or debit. Indicates whether amount_unreconciled is a credit or deb
193
+ #
154
194
  # @param amount_upper_bound [Integer, nil] The highest amount this expected payment may be equal to. Value in specified cur
155
195
  #
156
196
  # @param counterparty_id [String, nil] The ID of the counterparty you expect for this payment.
@@ -191,6 +231,30 @@ module ModernTreasury
191
231
  #
192
232
  # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
193
233
 
234
+ # One of credit or debit. Indicates whether amount_reconciled is a credit or debit
235
+ # amount.
236
+ module AmountReconciledDirection
237
+ extend ModernTreasury::Internal::Type::Enum
238
+
239
+ CREDIT = :credit
240
+ DEBIT = :debit
241
+
242
+ # @!method self.values
243
+ # @return [Array<Symbol>]
244
+ end
245
+
246
+ # One of credit or debit. Indicates whether amount_unreconciled is a credit or
247
+ # debit amount.
248
+ module AmountUnreconciledDirection
249
+ extend ModernTreasury::Internal::Type::Enum
250
+
251
+ CREDIT = :credit
252
+ DEBIT = :debit
253
+
254
+ # @!method self.values
255
+ # @return [Array<Symbol>]
256
+ end
257
+
194
258
  # One of credit or debit. When you are receiving money, use credit. When you are
195
259
  # being charged, use debit.
196
260
  module Direction
@@ -14,6 +14,38 @@ module ModernTreasury
14
14
  # @return [Integer, nil]
15
15
  optional :amount_lower_bound, Integer, nil?: true
16
16
 
17
+ # @!attribute amount_reconciled
18
+ # The amount reconciled for this expected payment. Value in specified currency's
19
+ # smallest unit. e.g. $10 would be represented as 1000.
20
+ #
21
+ # @return [Integer, nil]
22
+ optional :amount_reconciled, Integer, nil?: true
23
+
24
+ # @!attribute amount_reconciled_direction
25
+ # One of credit or debit. Indicates whether amount_reconciled is a credit or debit
26
+ # amount.
27
+ #
28
+ # @return [Symbol, ModernTreasury::Models::ExpectedPaymentUpdateParams::AmountReconciledDirection, nil]
29
+ optional :amount_reconciled_direction,
30
+ enum: -> { ModernTreasury::ExpectedPaymentUpdateParams::AmountReconciledDirection },
31
+ nil?: true
32
+
33
+ # @!attribute amount_unreconciled
34
+ # The amount that remains unreconciled for this expected payment. Value in
35
+ # specified currency's smallest unit. e.g. $10 would be represented as 1000.
36
+ #
37
+ # @return [Integer, nil]
38
+ optional :amount_unreconciled, Integer, nil?: true
39
+
40
+ # @!attribute amount_unreconciled_direction
41
+ # One of credit or debit. Indicates whether amount_unreconciled is a credit or
42
+ # debit amount.
43
+ #
44
+ # @return [Symbol, ModernTreasury::Models::ExpectedPaymentUpdateParams::AmountUnreconciledDirection, nil]
45
+ optional :amount_unreconciled_direction,
46
+ enum: -> { ModernTreasury::ExpectedPaymentUpdateParams::AmountUnreconciledDirection },
47
+ nil?: true
48
+
17
49
  # @!attribute amount_upper_bound
18
50
  # The highest amount this expected payment may be equal to. Value in specified
19
51
  # currency's smallest unit. e.g. $10 would be represented as 1000.
@@ -128,12 +160,20 @@ module ModernTreasury
128
160
  # @return [Symbol, ModernTreasury::Models::ExpectedPaymentType, nil]
129
161
  optional :type, enum: -> { ModernTreasury::ExpectedPaymentType }, nil?: true
130
162
 
131
- # @!method initialize(amount_lower_bound: nil, amount_upper_bound: nil, counterparty_id: nil, currency: nil, date_lower_bound: nil, date_upper_bound: nil, description: nil, direction: nil, external_id: nil, internal_account_id: nil, metadata: nil, reconciliation_filters: nil, reconciliation_groups: nil, reconciliation_rule_variables: nil, remittance_information: nil, statement_descriptor: nil, status: nil, type: nil, request_options: {})
163
+ # @!method initialize(amount_lower_bound: nil, amount_reconciled: nil, amount_reconciled_direction: nil, amount_unreconciled: nil, amount_unreconciled_direction: nil, amount_upper_bound: nil, counterparty_id: nil, currency: nil, date_lower_bound: nil, date_upper_bound: nil, description: nil, direction: nil, external_id: nil, internal_account_id: nil, metadata: nil, reconciliation_filters: nil, reconciliation_groups: nil, reconciliation_rule_variables: nil, remittance_information: nil, statement_descriptor: nil, status: nil, type: nil, request_options: {})
132
164
  # Some parameter documentations has been truncated, see
133
165
  # {ModernTreasury::Models::ExpectedPaymentUpdateParams} for more details.
134
166
  #
135
167
  # @param amount_lower_bound [Integer, nil] The lowest amount this expected payment may be equal to. Value in specified curr
136
168
  #
169
+ # @param amount_reconciled [Integer, nil] The amount reconciled for this expected payment. Value in specified currency's s
170
+ #
171
+ # @param amount_reconciled_direction [Symbol, ModernTreasury::Models::ExpectedPaymentUpdateParams::AmountReconciledDirection, nil] One of credit or debit. Indicates whether amount_reconciled is a credit or debit
172
+ #
173
+ # @param amount_unreconciled [Integer, nil] The amount that remains unreconciled for this expected payment. Value in specifi
174
+ #
175
+ # @param amount_unreconciled_direction [Symbol, ModernTreasury::Models::ExpectedPaymentUpdateParams::AmountUnreconciledDirection, nil] One of credit or debit. Indicates whether amount_unreconciled is a credit or deb
176
+ #
137
177
  # @param amount_upper_bound [Integer, nil] The highest amount this expected payment may be equal to. Value in specified cur
138
178
  #
139
179
  # @param counterparty_id [String, nil] The ID of the counterparty you expect for this payment.
@@ -170,6 +210,30 @@ module ModernTreasury
170
210
  #
171
211
  # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
172
212
 
213
+ # One of credit or debit. Indicates whether amount_reconciled is a credit or debit
214
+ # amount.
215
+ module AmountReconciledDirection
216
+ extend ModernTreasury::Internal::Type::Enum
217
+
218
+ CREDIT = :credit
219
+ DEBIT = :debit
220
+
221
+ # @!method self.values
222
+ # @return [Array<Symbol>]
223
+ end
224
+
225
+ # One of credit or debit. Indicates whether amount_unreconciled is a credit or
226
+ # debit amount.
227
+ module AmountUnreconciledDirection
228
+ extend ModernTreasury::Internal::Type::Enum
229
+
230
+ CREDIT = :credit
231
+ DEBIT = :debit
232
+
233
+ # @!method self.values
234
+ # @return [Array<Symbol>]
235
+ end
236
+
173
237
  # One of credit or debit. When you are receiving money, use credit. When you are
174
238
  # being charged, use debit.
175
239
  module Direction
@@ -0,0 +1,74 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ModernTreasury
4
+ module Models
5
+ # @see ModernTreasury::Resources::Holds#create
6
+ class HoldCreateParams < ModernTreasury::Internal::Type::BaseModel
7
+ extend ModernTreasury::Internal::Type::RequestParameters::Converter
8
+ include ModernTreasury::Internal::Type::RequestParameters
9
+
10
+ # @!attribute status
11
+ # The status of the hold
12
+ #
13
+ # @return [Symbol, ModernTreasury::Models::HoldCreateParams::Status]
14
+ required :status, enum: -> { ModernTreasury::HoldCreateParams::Status }
15
+
16
+ # @!attribute target_id
17
+ # The ID of the target to hold
18
+ #
19
+ # @return [String]
20
+ required :target_id, String
21
+
22
+ # @!attribute target_type
23
+ # The type of target to hold
24
+ #
25
+ # @return [Symbol, ModernTreasury::Models::HoldCreateParams::TargetType]
26
+ required :target_type, enum: -> { ModernTreasury::HoldCreateParams::TargetType }
27
+
28
+ # @!attribute metadata
29
+ # Additional metadata for the hold
30
+ #
31
+ # @return [Hash{Symbol=>String}, nil]
32
+ optional :metadata, ModernTreasury::Internal::Type::HashOf[String], nil?: true
33
+
34
+ # @!attribute reason
35
+ # The reason for the hold
36
+ #
37
+ # @return [String, nil]
38
+ optional :reason, String, nil?: true
39
+
40
+ # @!method initialize(status:, target_id:, target_type:, metadata: nil, reason: nil, request_options: {})
41
+ # @param status [Symbol, ModernTreasury::Models::HoldCreateParams::Status] The status of the hold
42
+ #
43
+ # @param target_id [String] The ID of the target to hold
44
+ #
45
+ # @param target_type [Symbol, ModernTreasury::Models::HoldCreateParams::TargetType] The type of target to hold
46
+ #
47
+ # @param metadata [Hash{Symbol=>String}, nil] Additional metadata for the hold
48
+ #
49
+ # @param reason [String, nil] The reason for the hold
50
+ #
51
+ # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
52
+
53
+ # The status of the hold
54
+ module Status
55
+ extend ModernTreasury::Internal::Type::Enum
56
+
57
+ ACTIVE = :active
58
+
59
+ # @!method self.values
60
+ # @return [Array<Symbol>]
61
+ end
62
+
63
+ # The type of target to hold
64
+ module TargetType
65
+ extend ModernTreasury::Internal::Type::Enum
66
+
67
+ PAYMENT_ORDER = :payment_order
68
+
69
+ # @!method self.values
70
+ # @return [Array<Symbol>]
71
+ end
72
+ end
73
+ end
74
+ end
@@ -0,0 +1,143 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ModernTreasury
4
+ module Models
5
+ # @see ModernTreasury::Resources::Holds#create
6
+ class HoldCreateResponse < ModernTreasury::Internal::Type::BaseModel
7
+ # @!attribute id
8
+ #
9
+ # @return [String]
10
+ required :id, String
11
+
12
+ # @!attribute created_at
13
+ #
14
+ # @return [Time]
15
+ required :created_at, Time
16
+
17
+ # @!attribute object
18
+ # The type of object
19
+ #
20
+ # @return [Symbol, ModernTreasury::Models::HoldCreateResponse::Object]
21
+ required :object, enum: -> { ModernTreasury::Models::HoldCreateResponse::Object }
22
+
23
+ # @!attribute status
24
+ # The status of the hold
25
+ #
26
+ # @return [Symbol, ModernTreasury::Models::HoldCreateResponse::Status]
27
+ required :status, enum: -> { ModernTreasury::Models::HoldCreateResponse::Status }
28
+
29
+ # @!attribute target_id
30
+ # The ID of the target being held
31
+ #
32
+ # @return [String]
33
+ required :target_id, String
34
+
35
+ # @!attribute target_type
36
+ # The type of target being held
37
+ #
38
+ # @return [Symbol, ModernTreasury::Models::HoldCreateResponse::TargetType]
39
+ required :target_type, enum: -> { ModernTreasury::Models::HoldCreateResponse::TargetType }
40
+
41
+ # @!attribute updated_at
42
+ #
43
+ # @return [Time]
44
+ required :updated_at, Time
45
+
46
+ # @!attribute live_mode
47
+ # This field will be true if this object exists in the live environment or false
48
+ # if it exists in the test environment.
49
+ #
50
+ # @return [Boolean, nil]
51
+ optional :live_mode, ModernTreasury::Internal::Type::Boolean
52
+
53
+ # @!attribute metadata
54
+ # Additional metadata for the hold
55
+ #
56
+ # @return [Hash{Symbol=>String}, nil]
57
+ optional :metadata, ModernTreasury::Internal::Type::HashOf[String], nil?: true
58
+
59
+ # @!attribute reason
60
+ # The reason for the hold
61
+ #
62
+ # @return [String, nil]
63
+ optional :reason, String, nil?: true
64
+
65
+ # @!attribute resolution
66
+ # The resolution of the hold
67
+ #
68
+ # @return [String, nil]
69
+ optional :resolution, String, nil?: true
70
+
71
+ # @!attribute resolved_at
72
+ # When the hold was resolved
73
+ #
74
+ # @return [Time, nil]
75
+ optional :resolved_at, Time, nil?: true
76
+
77
+ # @!method initialize(id:, created_at:, object:, status:, target_id:, target_type:, updated_at:, live_mode: nil, metadata: nil, reason: nil, resolution: nil, resolved_at: nil)
78
+ # Some parameter documentations has been truncated, see
79
+ # {ModernTreasury::Models::HoldCreateResponse} for more details.
80
+ #
81
+ # @param id [String]
82
+ #
83
+ # @param created_at [Time]
84
+ #
85
+ # @param object [Symbol, ModernTreasury::Models::HoldCreateResponse::Object] The type of object
86
+ #
87
+ # @param status [Symbol, ModernTreasury::Models::HoldCreateResponse::Status] The status of the hold
88
+ #
89
+ # @param target_id [String] The ID of the target being held
90
+ #
91
+ # @param target_type [Symbol, ModernTreasury::Models::HoldCreateResponse::TargetType] The type of target being held
92
+ #
93
+ # @param updated_at [Time]
94
+ #
95
+ # @param live_mode [Boolean] This field will be true if this object exists in the live environment or false i
96
+ #
97
+ # @param metadata [Hash{Symbol=>String}, nil] Additional metadata for the hold
98
+ #
99
+ # @param reason [String, nil] The reason for the hold
100
+ #
101
+ # @param resolution [String, nil] The resolution of the hold
102
+ #
103
+ # @param resolved_at [Time, nil] When the hold was resolved
104
+
105
+ # The type of object
106
+ #
107
+ # @see ModernTreasury::Models::HoldCreateResponse#object
108
+ module Object
109
+ extend ModernTreasury::Internal::Type::Enum
110
+
111
+ HOLD = :hold
112
+
113
+ # @!method self.values
114
+ # @return [Array<Symbol>]
115
+ end
116
+
117
+ # The status of the hold
118
+ #
119
+ # @see ModernTreasury::Models::HoldCreateResponse#status
120
+ module Status
121
+ extend ModernTreasury::Internal::Type::Enum
122
+
123
+ ACTIVE = :active
124
+ RESOLVED = :resolved
125
+
126
+ # @!method self.values
127
+ # @return [Array<Symbol>]
128
+ end
129
+
130
+ # The type of target being held
131
+ #
132
+ # @see ModernTreasury::Models::HoldCreateResponse#target_type
133
+ module TargetType
134
+ extend ModernTreasury::Internal::Type::Enum
135
+
136
+ PAYMENT_ORDER = :payment_order
137
+
138
+ # @!method self.values
139
+ # @return [Array<Symbol>]
140
+ end
141
+ end
142
+ end
143
+ end
@@ -0,0 +1,89 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ModernTreasury
4
+ module Models
5
+ # @see ModernTreasury::Resources::Holds#list
6
+ class HoldListParams < ModernTreasury::Internal::Type::BaseModel
7
+ extend ModernTreasury::Internal::Type::RequestParameters::Converter
8
+ include ModernTreasury::Internal::Type::RequestParameters
9
+
10
+ # @!attribute after_cursor
11
+ #
12
+ # @return [String, nil]
13
+ optional :after_cursor, String, nil?: true
14
+
15
+ # @!attribute metadata
16
+ # For example, if you want to query for records with metadata key `Type` and value
17
+ # `Loan`, the query would be `metadata%5BType%5D=Loan`. This encodes the query
18
+ # parameters.
19
+ #
20
+ # @return [Hash{Symbol=>String}, nil]
21
+ optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
22
+
23
+ # @!attribute per_page
24
+ #
25
+ # @return [Integer, nil]
26
+ optional :per_page, Integer
27
+
28
+ # @!attribute status
29
+ # Translation missing: en.openapi.descriptions.payment_order.query_params.status
30
+ #
31
+ # @return [Symbol, ModernTreasury::Models::HoldListParams::Status, nil]
32
+ optional :status, enum: -> { ModernTreasury::HoldListParams::Status }, nil?: true
33
+
34
+ # @!attribute target_id
35
+ # Translation missing:
36
+ # en.openapi.descriptions.payment_order.query_params.target_id
37
+ #
38
+ # @return [String, nil]
39
+ optional :target_id, String, nil?: true
40
+
41
+ # @!attribute target_type
42
+ # Translation missing:
43
+ # en.openapi.descriptions.payment_order.query_params.target_type
44
+ #
45
+ # @return [Symbol, ModernTreasury::Models::HoldListParams::TargetType, nil]
46
+ optional :target_type, enum: -> { ModernTreasury::HoldListParams::TargetType }, nil?: true
47
+
48
+ # @!method initialize(after_cursor: nil, metadata: nil, per_page: nil, status: nil, target_id: nil, target_type: nil, request_options: {})
49
+ # Some parameter documentations has been truncated, see
50
+ # {ModernTreasury::Models::HoldListParams} for more details.
51
+ #
52
+ # @param after_cursor [String, nil]
53
+ #
54
+ # @param metadata [Hash{Symbol=>String}] For example, if you want to query for records with metadata key `Type` and value
55
+ #
56
+ # @param per_page [Integer]
57
+ #
58
+ # @param status [Symbol, ModernTreasury::Models::HoldListParams::Status, nil] Translation missing: en.openapi.descriptions.payment_order.query_params.status
59
+ #
60
+ # @param target_id [String, nil] Translation missing: en.openapi.descriptions.payment_order.query_params.target_i
61
+ #
62
+ # @param target_type [Symbol, ModernTreasury::Models::HoldListParams::TargetType, nil] Translation missing: en.openapi.descriptions.payment_order.query_params.target_t
63
+ #
64
+ # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
65
+
66
+ # Translation missing: en.openapi.descriptions.payment_order.query_params.status
67
+ module Status
68
+ extend ModernTreasury::Internal::Type::Enum
69
+
70
+ ACTIVE = :active
71
+ RESOLVED = :resolved
72
+
73
+ # @!method self.values
74
+ # @return [Array<Symbol>]
75
+ end
76
+
77
+ # Translation missing:
78
+ # en.openapi.descriptions.payment_order.query_params.target_type
79
+ module TargetType
80
+ extend ModernTreasury::Internal::Type::Enum
81
+
82
+ PAYMENT_ORDER = :payment_order
83
+
84
+ # @!method self.values
85
+ # @return [Array<Symbol>]
86
+ end
87
+ end
88
+ end
89
+ end