modern_treasury 0.1.0.pre.alpha.21 → 0.1.0.pre.alpha.22

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 (167) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +27 -0
  3. data/README.md +1 -1
  4. data/lib/modern_treasury/errors.rb +22 -0
  5. data/lib/modern_treasury/internal/transport/base_client.rb +10 -2
  6. data/lib/modern_treasury/internal/type/array_of.rb +6 -1
  7. data/lib/modern_treasury/internal/type/base_model.rb +77 -23
  8. data/lib/modern_treasury/internal/type/boolean.rb +7 -1
  9. data/lib/modern_treasury/internal/type/converter.rb +42 -34
  10. data/lib/modern_treasury/internal/type/enum.rb +10 -2
  11. data/lib/modern_treasury/internal/type/file_input.rb +6 -1
  12. data/lib/modern_treasury/internal/type/hash_of.rb +6 -1
  13. data/lib/modern_treasury/internal/type/union.rb +12 -7
  14. data/lib/modern_treasury/internal/type/unknown.rb +7 -1
  15. data/lib/modern_treasury/models/bulk_request_create_params.rb +143 -18
  16. data/lib/modern_treasury/models/bulk_result.rb +5 -3
  17. data/lib/modern_treasury/models/counterparty_create_params.rb +1 -0
  18. data/lib/modern_treasury/models/external_account_create_params.rb +1 -0
  19. data/lib/modern_treasury/models/incoming_payment_detail.rb +1 -0
  20. data/lib/modern_treasury/models/internal_account.rb +146 -3
  21. data/lib/modern_treasury/models/internal_account_create_params.rb +138 -1
  22. data/lib/modern_treasury/models/internal_accounts/balance_report_retrieve_params.rb +23 -0
  23. data/lib/modern_treasury/models/invoice.rb +10 -1
  24. data/lib/modern_treasury/models/ledger_account.rb +9 -1
  25. data/lib/modern_treasury/models/ledger_account_category.rb +9 -1
  26. data/lib/modern_treasury/models/ledger_account_category_list_params.rb +8 -1
  27. data/lib/modern_treasury/models/ledger_account_list_params.rb +15 -1
  28. data/lib/modern_treasury/models/payment_order.rb +21 -9
  29. data/lib/modern_treasury/models/payment_order_create_async_params.rb +8 -7
  30. data/lib/modern_treasury/models/payment_order_create_params.rb +8 -7
  31. data/lib/modern_treasury/models/payment_order_list_params.rb +9 -1
  32. data/lib/modern_treasury/models/payment_order_update_params.rb +9 -7
  33. data/lib/modern_treasury/models/payment_reference.rb +4 -1
  34. data/lib/modern_treasury/models/return_create_params.rb +75 -1
  35. data/lib/modern_treasury/models/return_object.rb +80 -2
  36. data/lib/modern_treasury/models/routing_detail.rb +1 -0
  37. data/lib/modern_treasury/models/routing_detail_create_params.rb +1 -0
  38. data/lib/modern_treasury/models/transaction.rb +1 -0
  39. data/lib/modern_treasury/models/transaction_create_params.rb +9 -1
  40. data/lib/modern_treasury/models/transactions/transaction_line_item.rb +9 -1
  41. data/lib/modern_treasury/models/validation_validate_routing_number_params.rb +1 -0
  42. data/lib/modern_treasury/models/virtual_account_create_params.rb +1 -0
  43. data/lib/modern_treasury/models.rb +0 -18
  44. data/lib/modern_treasury/resources/bulk_requests.rb +1 -1
  45. data/lib/modern_treasury/resources/internal_accounts/balance_reports.rb +2 -2
  46. data/lib/modern_treasury/resources/internal_accounts.rb +3 -1
  47. data/lib/modern_treasury/resources/ledger_account_categories.rb +3 -1
  48. data/lib/modern_treasury/resources/ledger_accounts.rb +5 -1
  49. data/lib/modern_treasury/resources/ledger_event_handlers.rb +0 -111
  50. data/lib/modern_treasury/resources/ledgerable_events.rb +0 -51
  51. data/lib/modern_treasury/resources/payment_orders.rb +6 -4
  52. data/lib/modern_treasury/resources/returns.rb +3 -1
  53. data/lib/modern_treasury/resources/transactions.rb +3 -1
  54. data/lib/modern_treasury/version.rb +1 -1
  55. data/lib/modern_treasury.rb +0 -9
  56. data/rbi/modern_treasury/errors.rbi +16 -0
  57. data/rbi/modern_treasury/internal/type/boolean.rbi +2 -0
  58. data/rbi/modern_treasury/internal/type/converter.rbi +15 -15
  59. data/rbi/modern_treasury/internal/type/union.rbi +5 -0
  60. data/rbi/modern_treasury/internal/type/unknown.rbi +2 -0
  61. data/rbi/modern_treasury/models/bulk_request_create_params.rbi +234 -18
  62. data/rbi/modern_treasury/models/bulk_result.rbi +2 -0
  63. data/rbi/modern_treasury/models/counterparty_create_params.rbi +5 -0
  64. data/rbi/modern_treasury/models/external_account_create_params.rbi +5 -0
  65. data/rbi/modern_treasury/models/incoming_payment_detail.rbi +5 -0
  66. data/rbi/modern_treasury/models/internal_account.rbi +328 -5
  67. data/rbi/modern_treasury/models/internal_account_create_params.rbi +333 -0
  68. data/rbi/modern_treasury/models/internal_accounts/balance_report_retrieve_params.rbi +37 -0
  69. data/rbi/modern_treasury/models/invoice.rbi +10 -0
  70. data/rbi/modern_treasury/models/ledger_account.rbi +8 -0
  71. data/rbi/modern_treasury/models/ledger_account_category.rbi +8 -0
  72. data/rbi/modern_treasury/models/ledger_account_category_list_params.rbi +9 -0
  73. data/rbi/modern_treasury/models/ledger_account_list_params.rbi +22 -0
  74. data/rbi/modern_treasury/models/payment_order.rbi +39 -14
  75. data/rbi/modern_treasury/models/payment_order_create_async_params.rbi +14 -9
  76. data/rbi/modern_treasury/models/payment_order_create_params.rbi +14 -9
  77. data/rbi/modern_treasury/models/payment_order_list_params.rbi +14 -0
  78. data/rbi/modern_treasury/models/payment_order_update_params.rbi +19 -9
  79. data/rbi/modern_treasury/models/payment_reference.rbi +20 -5
  80. data/rbi/modern_treasury/models/return_create_params.rbi +114 -0
  81. data/rbi/modern_treasury/models/return_object.rbi +131 -5
  82. data/rbi/modern_treasury/models/routing_detail.rbi +5 -0
  83. data/rbi/modern_treasury/models/routing_detail_create_params.rbi +5 -0
  84. data/rbi/modern_treasury/models/transaction.rbi +5 -0
  85. data/rbi/modern_treasury/models/transaction_create_params.rbi +8 -0
  86. data/rbi/modern_treasury/models/transactions/transaction_line_item.rbi +8 -0
  87. data/rbi/modern_treasury/models/validation_validate_routing_number_params.rbi +5 -0
  88. data/rbi/modern_treasury/models/virtual_account_create_params.rbi +5 -0
  89. data/rbi/modern_treasury/models.rbi +0 -25
  90. data/rbi/modern_treasury/resources/bulk_requests.rbi +1 -0
  91. data/rbi/modern_treasury/resources/internal_accounts/balance_reports.rbi +7 -3
  92. data/rbi/modern_treasury/resources/internal_accounts.rbi +7 -0
  93. data/rbi/modern_treasury/resources/ledger_account_categories.rbi +2 -0
  94. data/rbi/modern_treasury/resources/ledger_accounts.rbi +4 -0
  95. data/rbi/modern_treasury/resources/ledger_event_handlers.rbi +0 -97
  96. data/rbi/modern_treasury/resources/ledgerable_events.rbi +0 -38
  97. data/rbi/modern_treasury/resources/payment_orders.rbi +11 -9
  98. data/rbi/modern_treasury/resources/returns.rbi +6 -0
  99. data/rbi/modern_treasury/resources/transactions.rbi +3 -0
  100. data/sig/modern_treasury/errors.rbs +9 -0
  101. data/sig/modern_treasury/internal/type/converter.rbs +7 -1
  102. data/sig/modern_treasury/models/bulk_request_create_params.rbs +101 -0
  103. data/sig/modern_treasury/models/bulk_result.rbs +1 -0
  104. data/sig/modern_treasury/models/counterparty_create_params.rbs +2 -0
  105. data/sig/modern_treasury/models/external_account_create_params.rbs +2 -0
  106. data/sig/modern_treasury/models/incoming_payment_detail.rbs +2 -0
  107. data/sig/modern_treasury/models/internal_account.rbs +147 -3
  108. data/sig/modern_treasury/models/internal_account_create_params.rbs +143 -0
  109. data/sig/modern_treasury/models/internal_accounts/balance_report_retrieve_params.rbs +10 -0
  110. data/sig/modern_treasury/models/invoice.rbs +5 -0
  111. data/sig/modern_treasury/models/ledger_account.rbs +5 -0
  112. data/sig/modern_treasury/models/ledger_account_category.rbs +5 -0
  113. data/sig/modern_treasury/models/ledger_account_category_list_params.rbs +7 -0
  114. data/sig/modern_treasury/models/ledger_account_list_params.rbs +16 -0
  115. data/sig/modern_treasury/models/payment_order.rbs +15 -2
  116. data/sig/modern_treasury/models/payment_order_create_async_params.rbs +2 -0
  117. data/sig/modern_treasury/models/payment_order_create_params.rbs +2 -0
  118. data/sig/modern_treasury/models/payment_order_list_params.rbs +9 -0
  119. data/sig/modern_treasury/models/payment_order_update_params.rbs +4 -0
  120. data/sig/modern_treasury/models/payment_reference.rbs +8 -2
  121. data/sig/modern_treasury/models/return_create_params.rbs +47 -0
  122. data/sig/modern_treasury/models/return_object.rbs +55 -2
  123. data/sig/modern_treasury/models/routing_detail.rbs +2 -0
  124. data/sig/modern_treasury/models/routing_detail_create_params.rbs +2 -0
  125. data/sig/modern_treasury/models/transaction.rbs +2 -0
  126. data/sig/modern_treasury/models/transaction_create_params.rbs +5 -0
  127. data/sig/modern_treasury/models/transactions/transaction_line_item.rbs +5 -0
  128. data/sig/modern_treasury/models/validation_validate_routing_number_params.rbs +2 -0
  129. data/sig/modern_treasury/models/virtual_account_create_params.rbs +2 -0
  130. data/sig/modern_treasury/models.rbs +0 -18
  131. data/sig/modern_treasury/resources/internal_accounts/balance_reports.rbs +1 -1
  132. data/sig/modern_treasury/resources/internal_accounts.rbs +1 -0
  133. data/sig/modern_treasury/resources/ledger_account_categories.rbs +1 -0
  134. data/sig/modern_treasury/resources/ledger_accounts.rbs +2 -0
  135. data/sig/modern_treasury/resources/ledger_event_handlers.rbs +0 -30
  136. data/sig/modern_treasury/resources/ledgerable_events.rbs +0 -13
  137. data/sig/modern_treasury/resources/payment_orders.rbs +1 -0
  138. data/sig/modern_treasury/resources/returns.rbs +1 -0
  139. data/sig/modern_treasury/resources/transactions.rbs +1 -0
  140. metadata +2 -29
  141. data/lib/modern_treasury/models/ledger_event_handler.rb +0 -222
  142. data/lib/modern_treasury/models/ledger_event_handler_create_params.rb +0 -177
  143. data/lib/modern_treasury/models/ledger_event_handler_delete_params.rb +0 -14
  144. data/lib/modern_treasury/models/ledger_event_handler_list_params.rb +0 -58
  145. data/lib/modern_treasury/models/ledger_event_handler_retrieve_params.rb +0 -14
  146. data/lib/modern_treasury/models/ledger_event_handler_variable.rb +0 -59
  147. data/lib/modern_treasury/models/ledgerable_event.rb +0 -92
  148. data/lib/modern_treasury/models/ledgerable_event_create_params.rb +0 -50
  149. data/lib/modern_treasury/models/ledgerable_event_retrieve_params.rb +0 -14
  150. data/rbi/modern_treasury/models/ledger_event_handler.rbi +0 -322
  151. data/rbi/modern_treasury/models/ledger_event_handler_create_params.rbi +0 -303
  152. data/rbi/modern_treasury/models/ledger_event_handler_delete_params.rbi +0 -32
  153. data/rbi/modern_treasury/models/ledger_event_handler_list_params.rbi +0 -92
  154. data/rbi/modern_treasury/models/ledger_event_handler_retrieve_params.rbi +0 -32
  155. data/rbi/modern_treasury/models/ledger_event_handler_variable.rbi +0 -98
  156. data/rbi/modern_treasury/models/ledgerable_event.rbi +0 -108
  157. data/rbi/modern_treasury/models/ledgerable_event_create_params.rbi +0 -75
  158. data/rbi/modern_treasury/models/ledgerable_event_retrieve_params.rbi +0 -32
  159. data/sig/modern_treasury/models/ledger_event_handler.rbs +0 -149
  160. data/sig/modern_treasury/models/ledger_event_handler_create_params.rbs +0 -127
  161. data/sig/modern_treasury/models/ledger_event_handler_delete_params.rbs +0 -15
  162. data/sig/modern_treasury/models/ledger_event_handler_list_params.rbs +0 -54
  163. data/sig/modern_treasury/models/ledger_event_handler_retrieve_params.rbs +0 -15
  164. data/sig/modern_treasury/models/ledger_event_handler_variable.rbs +0 -36
  165. data/sig/modern_treasury/models/ledgerable_event.rbs +0 -65
  166. data/sig/modern_treasury/models/ledgerable_event_create_params.rbs +0 -43
  167. data/sig/modern_treasury/models/ledgerable_event_retrieve_params.rbs +0 -15
@@ -23,7 +23,7 @@ module ModernTreasury
23
23
  # An array of objects where each object contains the input params for a single
24
24
  # `action_type` request on a `resource_type` resource
25
25
  #
26
- # @return [Array<ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::TransactionCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::ID, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::TransactionUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionUpdateRequestWithID>]
26
+ # @return [Array<ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerAccountCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::TransactionCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::ID, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::TransactionUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionUpdateRequestWithID>]
27
27
  required :resources,
28
28
  -> {
29
29
  ModernTreasury::Internal::Type::ArrayOf[union: ModernTreasury::BulkRequestCreateParams::Resource]
@@ -44,7 +44,7 @@ module ModernTreasury
44
44
  #
45
45
  # @param resource_type [Symbol, ModernTreasury::Models::BulkRequestCreateParams::ResourceType] One of payment_order, expected_payment, or ledger_transaction.
46
46
  #
47
- # @param resources [Array<ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::TransactionCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::ID, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::TransactionUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionUpdateRequestWithID>] An array of objects where each object contains the input params for a single `ac
47
+ # @param resources [Array<ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerAccountCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::TransactionCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::ID, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::TransactionUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionUpdateRequestWithID>] An array of objects where each object contains the input params for a single `ac
48
48
  #
49
49
  # @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
50
50
  #
@@ -87,6 +87,8 @@ module ModernTreasury
87
87
 
88
88
  variant -> { ModernTreasury::BulkRequestCreateParams::Resource::LedgerTransactionCreateRequest }
89
89
 
90
+ variant -> { ModernTreasury::BulkRequestCreateParams::Resource::LedgerAccountCreateRequest }
91
+
90
92
  variant -> { ModernTreasury::BulkRequestCreateParams::Resource::TransactionCreateRequest }
91
93
 
92
94
  variant -> { ModernTreasury::BulkRequestCreateParams::Resource::ID }
@@ -160,9 +162,9 @@ module ModernTreasury
160
162
  optional :accounting_ledger_class_id, String, nil?: true
161
163
 
162
164
  # @!attribute charge_bearer
163
- # The party that will pay the fees for the payment order. Only applies to wire
164
- # payment orders. Can be one of shared, sender, or receiver, which correspond
165
- # respectively with the SWIFT 71A values `SHA`, `OUR`, `BEN`.
165
+ # The party that will pay the fees for the payment order. See
166
+ # https://docs.moderntreasury.com/payments/docs/charge-bearer to understand the
167
+ # differences between the options.
166
168
  #
167
169
  # @return [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::ChargeBearer, nil]
168
170
  optional :charge_bearer,
@@ -413,7 +415,7 @@ module ModernTreasury
413
415
  #
414
416
  # @param accounting_ledger_class_id [String, nil] The ID of one of your accounting ledger classes. Note that these will only be ac
415
417
  #
416
- # @param charge_bearer [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::ChargeBearer, nil] The party that will pay the fees for the payment order. Only applies to wire pay
418
+ # @param charge_bearer [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::ChargeBearer, nil] The party that will pay the fees for the payment order. See https://docs.modernt
417
419
  #
418
420
  # @param currency [Symbol, ModernTreasury::Models::Currency] Defaults to the currency of the originating account.
419
421
  #
@@ -512,9 +514,9 @@ module ModernTreasury
512
514
  # @param class_id [String, nil] The ID of one of the class objects in your accounting system. Class objects trac
513
515
  end
514
516
 
515
- # The party that will pay the fees for the payment order. Only applies to wire
516
- # payment orders. Can be one of shared, sender, or receiver, which correspond
517
- # respectively with the SWIFT 71A values `SHA`, `OUR`, `BEN`.
517
+ # The party that will pay the fees for the payment order. See
518
+ # https://docs.moderntreasury.com/payments/docs/charge-bearer to understand the
519
+ # differences between the options.
518
520
  #
519
521
  # @see ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest#charge_bearer
520
522
  module ChargeBearer
@@ -1282,6 +1284,7 @@ module ModernTreasury
1282
1284
  HK_INTERBANK_CLEARING_CODE = :hk_interbank_clearing_code
1283
1285
  HU_INTERBANK_CLEARING_CODE = :hu_interbank_clearing_code
1284
1286
  ID_SKNBI_CODE = :id_sknbi_code
1287
+ IL_BANK_CODE = :il_bank_code
1285
1288
  IN_IFSC = :in_ifsc
1286
1289
  JP_ZENGIN_CODE = :jp_zengin_code
1287
1290
  MY_BRANCH_CODE = :my_branch_code
@@ -2045,6 +2048,118 @@ module ModernTreasury
2045
2048
  end
2046
2049
  end
2047
2050
 
2051
+ class LedgerAccountCreateRequest < ModernTreasury::Internal::Type::BaseModel
2052
+ # @!attribute currency
2053
+ # The currency of the ledger account.
2054
+ #
2055
+ # @return [String]
2056
+ required :currency, String
2057
+
2058
+ # @!attribute ledger_id
2059
+ # The id of the ledger that this account belongs to.
2060
+ #
2061
+ # @return [String]
2062
+ required :ledger_id, String
2063
+
2064
+ # @!attribute name
2065
+ # The name of the ledger account.
2066
+ #
2067
+ # @return [String]
2068
+ required :name, String
2069
+
2070
+ # @!attribute normal_balance
2071
+ # The normal balance of the ledger account.
2072
+ #
2073
+ # @return [Symbol, ModernTreasury::Models::TransactionDirection]
2074
+ required :normal_balance, enum: -> { ModernTreasury::TransactionDirection }
2075
+
2076
+ # @!attribute currency_exponent
2077
+ # The currency exponent of the ledger account.
2078
+ #
2079
+ # @return [Integer, nil]
2080
+ optional :currency_exponent, Integer, nil?: true
2081
+
2082
+ # @!attribute description
2083
+ # The description of the ledger account.
2084
+ #
2085
+ # @return [String, nil]
2086
+ optional :description, String, nil?: true
2087
+
2088
+ # @!attribute ledger_account_category_ids
2089
+ # The array of ledger account category ids that this ledger account should be a
2090
+ # child of.
2091
+ #
2092
+ # @return [Array<String>, nil]
2093
+ optional :ledger_account_category_ids, ModernTreasury::Internal::Type::ArrayOf[String]
2094
+
2095
+ # @!attribute ledgerable_id
2096
+ # If the ledger account links to another object in Modern Treasury, the id will be
2097
+ # populated here, otherwise null.
2098
+ #
2099
+ # @return [String, nil]
2100
+ optional :ledgerable_id, String
2101
+
2102
+ # @!attribute ledgerable_type
2103
+ # If the ledger account links to another object in Modern Treasury, the type will
2104
+ # be populated here, otherwise null. The value is one of internal_account or
2105
+ # external_account.
2106
+ #
2107
+ # @return [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerAccountCreateRequest::LedgerableType, nil]
2108
+ optional :ledgerable_type,
2109
+ enum: -> {
2110
+ ModernTreasury::BulkRequestCreateParams::Resource::LedgerAccountCreateRequest::LedgerableType
2111
+ }
2112
+
2113
+ # @!attribute metadata
2114
+ # Additional data represented as key-value pairs. Both the key and value must be
2115
+ # strings.
2116
+ #
2117
+ # @return [Hash{Symbol=>String}, nil]
2118
+ optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
2119
+
2120
+ # @!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)
2121
+ # Some parameter documentations has been truncated, see
2122
+ # {ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerAccountCreateRequest}
2123
+ # for more details.
2124
+ #
2125
+ # @param currency [String] The currency of the ledger account.
2126
+ #
2127
+ # @param ledger_id [String] The id of the ledger that this account belongs to.
2128
+ #
2129
+ # @param name [String] The name of the ledger account.
2130
+ #
2131
+ # @param normal_balance [Symbol, ModernTreasury::Models::TransactionDirection] The normal balance of the ledger account.
2132
+ #
2133
+ # @param currency_exponent [Integer, nil] The currency exponent of the ledger account.
2134
+ #
2135
+ # @param description [String, nil] The description of the ledger account.
2136
+ #
2137
+ # @param ledger_account_category_ids [Array<String>] The array of ledger account category ids that this ledger account should be a ch
2138
+ #
2139
+ # @param ledgerable_id [String] If the ledger account links to another object in Modern Treasury, the id will be
2140
+ #
2141
+ # @param ledgerable_type [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerAccountCreateRequest::LedgerableType] If the ledger account links to another object in Modern Treasury, the type will
2142
+ #
2143
+ # @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
2144
+
2145
+ # If the ledger account links to another object in Modern Treasury, the type will
2146
+ # be populated here, otherwise null. The value is one of internal_account or
2147
+ # external_account.
2148
+ #
2149
+ # @see ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerAccountCreateRequest#ledgerable_type
2150
+ module LedgerableType
2151
+ extend ModernTreasury::Internal::Type::Enum
2152
+
2153
+ COUNTERPARTY = :counterparty
2154
+ EXTERNAL_ACCOUNT = :external_account
2155
+ INTERNAL_ACCOUNT = :internal_account
2156
+ VIRTUAL_ACCOUNT = :virtual_account
2157
+
2158
+ # @!method self.values
2159
+ # @return [Array<Symbol>]
2160
+ end
2161
+ end
2162
+
2048
2163
  class TransactionCreateRequest < ModernTreasury::Internal::Type::BaseModel
2049
2164
  # @!attribute amount
2050
2165
  # Value in specified currency's smallest unit. e.g. $10 would be represented
@@ -2111,6 +2226,12 @@ module ModernTreasury
2111
2226
  },
2112
2227
  nil?: true
2113
2228
 
2229
+ # @!attribute vendor_customer_id
2230
+ # An identifier given to this transaction by the bank, often `null`.
2231
+ #
2232
+ # @return [String, nil]
2233
+ optional :vendor_customer_id, String, nil?: true
2234
+
2114
2235
  # @!attribute vendor_description
2115
2236
  # The transaction detail text that often appears in on your bank statement and in
2116
2237
  # your banking portal.
@@ -2118,7 +2239,7 @@ module ModernTreasury
2118
2239
  # @return [String, nil]
2119
2240
  optional :vendor_description, String, nil?: true
2120
2241
 
2121
- # @!method initialize(amount:, as_of_date:, direction:, internal_account_id:, vendor_code:, vendor_code_type:, metadata: nil, posted: nil, type: nil, vendor_description: nil)
2242
+ # @!method initialize(amount:, as_of_date:, direction:, internal_account_id:, vendor_code:, vendor_code_type:, metadata: nil, posted: nil, type: nil, vendor_customer_id: nil, vendor_description: nil)
2122
2243
  # Some parameter documentations has been truncated, see
2123
2244
  # {ModernTreasury::Models::BulkRequestCreateParams::Resource::TransactionCreateRequest}
2124
2245
  # for more details.
@@ -2141,6 +2262,8 @@ module ModernTreasury
2141
2262
  #
2142
2263
  # @param type [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::TransactionCreateRequest::Type, nil] The type of the transaction. Examples could be `card, `ach`, `wire`, `check`, `r
2143
2264
  #
2265
+ # @param vendor_customer_id [String, nil] An identifier given to this transaction by the bank, often `null`.
2266
+ #
2144
2267
  # @param vendor_description [String, nil] The transaction detail text that often appears in on your bank statement and in
2145
2268
 
2146
2269
  # The type of the transaction. Examples could be
@@ -2241,9 +2364,9 @@ module ModernTreasury
2241
2364
  optional :amount, Integer
2242
2365
 
2243
2366
  # @!attribute charge_bearer
2244
- # The party that will pay the fees for the payment order. Only applies to wire
2245
- # payment orders. Can be one of shared, sender, or receiver, which correspond
2246
- # respectively with the SWIFT 71A values `SHA`, `OUR`, `BEN`.
2367
+ # The party that will pay the fees for the payment order. See
2368
+ # https://docs.moderntreasury.com/payments/docs/charge-bearer to understand the
2369
+ # differences between the options.
2247
2370
  #
2248
2371
  # @return [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::ChargeBearer, nil]
2249
2372
  optional :charge_bearer,
@@ -2513,7 +2636,7 @@ module ModernTreasury
2513
2636
  #
2514
2637
  # @param amount [Integer] Value in specified currency's smallest unit. e.g. $10 would be represented as 10
2515
2638
  #
2516
- # @param charge_bearer [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::ChargeBearer, nil] The party that will pay the fees for the payment order. Only applies to wire pay
2639
+ # @param charge_bearer [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::ChargeBearer, nil] The party that will pay the fees for the payment order. See https://docs.modernt
2517
2640
  #
2518
2641
  # @param counterparty_id [String, nil] Required when receiving_account_id is passed the ID of an external account.
2519
2642
  #
@@ -2600,9 +2723,9 @@ module ModernTreasury
2600
2723
  # @param class_id [String, nil] The ID of one of the class objects in your accounting system. Class objects trac
2601
2724
  end
2602
2725
 
2603
- # The party that will pay the fees for the payment order. Only applies to wire
2604
- # payment orders. Can be one of shared, sender, or receiver, which correspond
2605
- # respectively with the SWIFT 71A values `SHA`, `OUR`, `BEN`.
2726
+ # The party that will pay the fees for the payment order. See
2727
+ # https://docs.moderntreasury.com/payments/docs/charge-bearer to understand the
2728
+ # differences between the options.
2606
2729
  #
2607
2730
  # @see ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID#charge_bearer
2608
2731
  module ChargeBearer
@@ -3152,6 +3275,7 @@ module ModernTreasury
3152
3275
  HK_INTERBANK_CLEARING_CODE = :hk_interbank_clearing_code
3153
3276
  HU_INTERBANK_CLEARING_CODE = :hu_interbank_clearing_code
3154
3277
  ID_SKNBI_CODE = :id_sknbi_code
3278
+ IL_BANK_CODE = :il_bank_code
3155
3279
  IN_IFSC = :in_ifsc
3156
3280
  JP_ZENGIN_CODE = :jp_zengin_code
3157
3281
  MY_BRANCH_CODE = :my_branch_code
@@ -3231,6 +3355,7 @@ module ModernTreasury
3231
3355
  RETURNED = :returned
3232
3356
  REVERSED = :reversed
3233
3357
  SENT = :sent
3358
+ STOPPED = :stopped
3234
3359
 
3235
3360
  # @!method self.values
3236
3361
  # @return [Array<Symbol>]
@@ -3674,7 +3799,7 @@ module ModernTreasury
3674
3799
  end
3675
3800
 
3676
3801
  # @!method self.variants
3677
- # @return [Array(ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::TransactionCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::ID, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::TransactionUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionUpdateRequestWithID)]
3802
+ # @return [Array(ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerAccountCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::TransactionCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::ID, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::TransactionUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionUpdateRequestWithID)]
3678
3803
  end
3679
3804
  end
3680
3805
  end
@@ -19,7 +19,7 @@ module ModernTreasury
19
19
  # that is generated by performing the requested action on the provided input
20
20
  # `request_params`.
21
21
  #
22
- # @return [ModernTreasury::Models::PaymentOrder, ModernTreasury::Models::ExpectedPayment, ModernTreasury::Models::LedgerTransaction, ModernTreasury::Models::Transaction, ModernTreasury::Models::BulkResult::Entity::BulkError]
22
+ # @return [ModernTreasury::Models::PaymentOrder, ModernTreasury::Models::ExpectedPayment, ModernTreasury::Models::LedgerTransaction, ModernTreasury::Models::LedgerAccount, ModernTreasury::Models::Transaction, ModernTreasury::Models::BulkResult::Entity::BulkError]
23
23
  required :entity, union: -> { ModernTreasury::BulkResult::Entity }
24
24
 
25
25
  # @!attribute entity_id
@@ -89,7 +89,7 @@ module ModernTreasury
89
89
  #
90
90
  # @param created_at [Time]
91
91
  #
92
- # @param entity [ModernTreasury::Models::PaymentOrder, ModernTreasury::Models::ExpectedPayment, ModernTreasury::Models::LedgerTransaction, ModernTreasury::Models::Transaction, ModernTreasury::Models::BulkResult::Entity::BulkError] An object with type as indicated by `entity_type`. This is the result object tha
92
+ # @param entity [ModernTreasury::Models::PaymentOrder, ModernTreasury::Models::ExpectedPayment, ModernTreasury::Models::LedgerTransaction, ModernTreasury::Models::LedgerAccount, ModernTreasury::Models::Transaction, ModernTreasury::Models::BulkResult::Entity::BulkError] An object with type as indicated by `entity_type`. This is the result object tha
93
93
  #
94
94
  # @param entity_id [String] Unique identifier for the result entity object.
95
95
  #
@@ -123,6 +123,8 @@ module ModernTreasury
123
123
 
124
124
  variant -> { ModernTreasury::LedgerTransaction }
125
125
 
126
+ variant -> { ModernTreasury::LedgerAccount }
127
+
126
128
  variant -> { ModernTreasury::Transaction }
127
129
 
128
130
  variant -> { ModernTreasury::BulkResult::Entity::BulkError }
@@ -203,7 +205,7 @@ module ModernTreasury
203
205
  end
204
206
 
205
207
  # @!method self.variants
206
- # @return [Array(ModernTreasury::Models::PaymentOrder, ModernTreasury::Models::ExpectedPayment, ModernTreasury::Models::LedgerTransaction, ModernTreasury::Models::Transaction, ModernTreasury::Models::BulkResult::Entity::BulkError)]
208
+ # @return [Array(ModernTreasury::Models::PaymentOrder, ModernTreasury::Models::ExpectedPayment, ModernTreasury::Models::LedgerTransaction, ModernTreasury::Models::LedgerAccount, ModernTreasury::Models::Transaction, ModernTreasury::Models::BulkResult::Entity::BulkError)]
207
209
  end
208
210
 
209
211
  # The type of the result entity object. For a successful bulk result, this is the
@@ -548,6 +548,7 @@ module ModernTreasury
548
548
  HK_INTERBANK_CLEARING_CODE = :hk_interbank_clearing_code
549
549
  HU_INTERBANK_CLEARING_CODE = :hu_interbank_clearing_code
550
550
  ID_SKNBI_CODE = :id_sknbi_code
551
+ IL_BANK_CODE = :il_bank_code
551
552
  IN_IFSC = :in_ifsc
552
553
  JP_ZENGIN_CODE = :jp_zengin_code
553
554
  MY_BRANCH_CODE = :my_branch_code
@@ -415,6 +415,7 @@ module ModernTreasury
415
415
  HK_INTERBANK_CLEARING_CODE = :hk_interbank_clearing_code
416
416
  HU_INTERBANK_CLEARING_CODE = :hu_interbank_clearing_code
417
417
  ID_SKNBI_CODE = :id_sknbi_code
418
+ IL_BANK_CODE = :il_bank_code
418
419
  IN_IFSC = :in_ifsc
419
420
  JP_ZENGIN_CODE = :jp_zengin_code
420
421
  MY_BRANCH_CODE = :my_branch_code
@@ -260,6 +260,7 @@ module ModernTreasury
260
260
  HK_INTERBANK_CLEARING_CODE = :hk_interbank_clearing_code
261
261
  HU_INTERBANK_CLEARING_CODE = :hu_interbank_clearing_code
262
262
  ID_SKNBI_CODE = :id_sknbi_code
263
+ IL_BANK_CODE = :il_bank_code
263
264
  IN_IFSC = :in_ifsc
264
265
  JP_ZENGIN_CODE = :jp_zengin_code
265
266
  MX_BANK_IDENTIFIER = :mx_bank_identifier
@@ -9,6 +9,16 @@ module ModernTreasury
9
9
  # @return [String]
10
10
  required :id, String
11
11
 
12
+ # @!attribute account_capabilities
13
+ # An array of AccountCapability objects that list the originating abilities of the
14
+ # internal account and any relevant information for them.
15
+ #
16
+ # @return [Array<ModernTreasury::Models::InternalAccount::AccountCapability>]
17
+ required :account_capabilities,
18
+ -> {
19
+ ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::InternalAccount::AccountCapability]
20
+ }
21
+
12
22
  # @!attribute account_details
13
23
  # An array of account detail objects.
14
24
  #
@@ -52,7 +62,7 @@ module ModernTreasury
52
62
  required :ledger_account_id, String, nil?: true
53
63
 
54
64
  # @!attribute legal_entity_id
55
- # The Legal Entity associated to this account
65
+ # The Legal Entity associated to this account.
56
66
  #
57
67
  # @return [String, nil]
58
68
  required :legal_entity_id, String, nil?: true
@@ -117,12 +127,20 @@ module ModernTreasury
117
127
  # @return [Time]
118
128
  required :updated_at, Time
119
129
 
120
- # @!method initialize(id:, account_details:, account_type:, connection:, counterparty_id:, created_at:, currency:, ledger_account_id:, legal_entity_id:, live_mode:, metadata:, name:, object:, parent_account_id:, party_address:, party_name:, party_type:, routing_details:, updated_at:)
130
+ # @!attribute vendor_id
131
+ # The vendor ID associated with this account.
132
+ #
133
+ # @return [String, nil]
134
+ required :vendor_id, String, nil?: true
135
+
136
+ # @!method initialize(id:, account_capabilities:, account_details:, account_type:, connection:, counterparty_id:, created_at:, currency:, ledger_account_id:, legal_entity_id:, live_mode:, metadata:, name:, object:, parent_account_id:, party_address:, party_name:, party_type:, routing_details:, updated_at:, vendor_id:)
121
137
  # Some parameter documentations has been truncated, see
122
138
  # {ModernTreasury::Models::InternalAccount} for more details.
123
139
  #
124
140
  # @param id [String]
125
141
  #
142
+ # @param account_capabilities [Array<ModernTreasury::Models::InternalAccount::AccountCapability>] An array of AccountCapability objects that list the originating abilities of the
143
+ #
126
144
  # @param account_details [Array<ModernTreasury::Models::AccountDetail>] An array of account detail objects.
127
145
  #
128
146
  # @param account_type [Symbol, ModernTreasury::Models::InternalAccount::AccountType, nil] Can be checking, savings or other.
@@ -137,7 +155,7 @@ module ModernTreasury
137
155
  #
138
156
  # @param ledger_account_id [String, nil] If the internal account links to a ledger account in Modern Treasury, the id of
139
157
  #
140
- # @param legal_entity_id [String, nil] The Legal Entity associated to this account
158
+ # @param legal_entity_id [String, nil] The Legal Entity associated to this account.
141
159
  #
142
160
  # @param live_mode [Boolean] This field will be true if this object exists in the live environment or false i
143
161
  #
@@ -158,6 +176,131 @@ module ModernTreasury
158
176
  # @param routing_details [Array<ModernTreasury::Models::RoutingDetail>] An array of routing detail objects.
159
177
  #
160
178
  # @param updated_at [Time]
179
+ #
180
+ # @param vendor_id [String, nil] The vendor ID associated with this account.
181
+
182
+ class AccountCapability < ModernTreasury::Internal::Type::BaseModel
183
+ # @!attribute id
184
+ #
185
+ # @return [String]
186
+ required :id, String
187
+
188
+ # @!attribute created_at
189
+ #
190
+ # @return [Time]
191
+ required :created_at, Time
192
+
193
+ # @!attribute direction
194
+ # One of `debit` or `credit`. Indicates the direction of money movement this
195
+ # capability is responsible for.
196
+ #
197
+ # @return [Symbol, ModernTreasury::Models::TransactionDirection]
198
+ required :direction, enum: -> { ModernTreasury::TransactionDirection }
199
+
200
+ # @!attribute discarded_at
201
+ #
202
+ # @return [Time, nil]
203
+ required :discarded_at, Time, nil?: true
204
+
205
+ # @!attribute identifier
206
+ # A unique reference assigned by your bank for tracking and recognizing payment
207
+ # files. It is important this is formatted exactly how the bank assigned it.
208
+ #
209
+ # @return [String, nil]
210
+ required :identifier, String, nil?: true
211
+
212
+ # @!attribute live_mode
213
+ # This field will be true if this object exists in the live environment or false
214
+ # if it exists in the test environment.
215
+ #
216
+ # @return [Boolean]
217
+ required :live_mode, ModernTreasury::Internal::Type::Boolean
218
+
219
+ # @!attribute object
220
+ #
221
+ # @return [String]
222
+ required :object, String
223
+
224
+ # @!attribute payment_type
225
+ # Indicates the the type of payment this capability is responsible for
226
+ # originating.
227
+ #
228
+ # @return [Symbol, ModernTreasury::Models::InternalAccount::AccountCapability::PaymentType]
229
+ required :payment_type, enum: -> { ModernTreasury::InternalAccount::AccountCapability::PaymentType }
230
+
231
+ # @!attribute updated_at
232
+ #
233
+ # @return [Time]
234
+ required :updated_at, Time
235
+
236
+ # @!method initialize(id:, created_at:, direction:, discarded_at:, identifier:, live_mode:, object:, payment_type:, updated_at:)
237
+ # Some parameter documentations has been truncated, see
238
+ # {ModernTreasury::Models::InternalAccount::AccountCapability} for more details.
239
+ #
240
+ # @param id [String]
241
+ #
242
+ # @param created_at [Time]
243
+ #
244
+ # @param direction [Symbol, ModernTreasury::Models::TransactionDirection] One of `debit` or `credit`. Indicates the direction of money movement this capab
245
+ #
246
+ # @param discarded_at [Time, nil]
247
+ #
248
+ # @param identifier [String, nil] A unique reference assigned by your bank for tracking and recognizing payment fi
249
+ #
250
+ # @param live_mode [Boolean] This field will be true if this object exists in the live environment or false i
251
+ #
252
+ # @param object [String]
253
+ #
254
+ # @param payment_type [Symbol, ModernTreasury::Models::InternalAccount::AccountCapability::PaymentType] Indicates the the type of payment this capability is responsible for originating
255
+ #
256
+ # @param updated_at [Time]
257
+
258
+ # Indicates the the type of payment this capability is responsible for
259
+ # originating.
260
+ #
261
+ # @see ModernTreasury::Models::InternalAccount::AccountCapability#payment_type
262
+ module PaymentType
263
+ extend ModernTreasury::Internal::Type::Enum
264
+
265
+ ACH = :ach
266
+ AU_BECS = :au_becs
267
+ BACS = :bacs
268
+ BASE = :base
269
+ BOOK = :book
270
+ CARD = :card
271
+ CHATS = :chats
272
+ CHECK = :check
273
+ CROSS_BORDER = :cross_border
274
+ DK_NETS = :dk_nets
275
+ EFT = :eft
276
+ ETHEREUM = :ethereum
277
+ HU_ICS = :hu_ics
278
+ INTERAC = :interac
279
+ MASAV = :masav
280
+ MX_CCEN = :mx_ccen
281
+ NEFT = :neft
282
+ NICS = :nics
283
+ NZ_BECS = :nz_becs
284
+ PL_ELIXIR = :pl_elixir
285
+ POLYGON = :polygon
286
+ PROVXCHANGE = :provxchange
287
+ RO_SENT = :ro_sent
288
+ RTP = :rtp
289
+ SE_BANKGIROT = :se_bankgirot
290
+ SEN = :sen
291
+ SEPA = :sepa
292
+ SG_GIRO = :sg_giro
293
+ SIC = :sic
294
+ SIGNET = :signet
295
+ SKNBI = :sknbi
296
+ SOLANA = :solana
297
+ WIRE = :wire
298
+ ZENGIN = :zengin
299
+
300
+ # @!method self.values
301
+ # @return [Array<Symbol>]
302
+ end
303
+ end
161
304
 
162
305
  # Can be checking, savings or other.
163
306
  #