modern_treasury 0.27.0 → 0.28.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 (207) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +45 -0
  3. data/README.md +4 -4
  4. data/lib/modern_treasury/client.rb +14 -0
  5. data/lib/modern_treasury/internal/transport/base_client.rb +5 -0
  6. data/lib/modern_treasury/models/bulk_request_create_params.rb +65 -190
  7. data/lib/modern_treasury/models/child_legal_entity.rb +121 -3
  8. data/lib/modern_treasury/models/child_legal_entity_create.rb +35 -1
  9. data/lib/modern_treasury/models/connection_legal_entity_create_params.rb +38 -1
  10. data/lib/modern_treasury/models/counterparty_collect_account_params.rb +0 -2
  11. data/lib/modern_treasury/models/counterparty_create_params.rb +38 -10
  12. data/lib/modern_treasury/models/currency.rb +0 -2
  13. data/lib/modern_treasury/models/document.rb +1 -73
  14. data/lib/modern_treasury/models/document_create_params.rb +11 -11
  15. data/lib/modern_treasury/models/document_list_params.rb +11 -11
  16. data/lib/modern_treasury/models/expected_payment.rb +2 -3
  17. data/lib/modern_treasury/models/expected_payment_create_params.rb +2 -3
  18. data/lib/modern_treasury/models/expected_payment_list_params.rb +3 -12
  19. data/lib/modern_treasury/models/expected_payment_type.rb +1 -9
  20. data/lib/modern_treasury/models/expected_payment_update_params.rb +2 -3
  21. data/lib/modern_treasury/models/external_account_create_params.rb +0 -9
  22. data/lib/modern_treasury/models/external_account_verify_params.rb +0 -7
  23. data/lib/modern_treasury/models/external_account_verify_response.rb +0 -7
  24. data/lib/modern_treasury/models/hold_list_params.rb +8 -11
  25. data/lib/modern_treasury/models/identification_create_request.rb +75 -0
  26. data/lib/modern_treasury/models/incoming_payment_detail.rb +3 -9
  27. data/lib/modern_treasury/models/incoming_payment_detail_create_async_params.rb +0 -2
  28. data/lib/modern_treasury/models/incoming_payment_detail_list_params.rb +3 -7
  29. data/lib/modern_treasury/models/internal_account.rb +12 -8
  30. data/lib/modern_treasury/models/internal_account_create_params.rb +35 -30
  31. data/lib/modern_treasury/models/internal_account_list_params.rb +0 -7
  32. data/lib/modern_treasury/models/internal_account_update_account_capability_response.rb +0 -7
  33. data/lib/modern_treasury/models/internal_accounts/balance_report.rb +15 -6
  34. data/lib/modern_treasury/models/internal_accounts/balance_report_create_params.rb +20 -11
  35. data/lib/modern_treasury/models/invoice.rb +6 -6
  36. data/lib/modern_treasury/models/invoice_create_params.rb +3 -4
  37. data/lib/modern_treasury/models/invoice_update_params.rb +3 -4
  38. data/lib/modern_treasury/models/ledger_balance.rb +22 -1
  39. data/lib/modern_treasury/models/ledger_entry.rb +10 -1
  40. data/lib/modern_treasury/models/ledger_entry_create_request.rb +19 -10
  41. data/lib/modern_treasury/models/ledger_transaction_create_partial_post_params.rb +69 -10
  42. data/lib/modern_treasury/models/ledger_transactions/ledger_transaction_version.rb +10 -1
  43. data/lib/modern_treasury/models/legal_entity.rb +121 -3
  44. data/lib/modern_treasury/models/legal_entity_address_create_request.rb +14 -1
  45. data/lib/modern_treasury/models/legal_entity_association.rb +2 -3
  46. data/lib/modern_treasury/models/legal_entity_create_params.rb +34 -1
  47. data/lib/modern_treasury/models/legal_entity_update_params.rb +34 -1
  48. data/lib/modern_treasury/models/legal_entity_update_status_params.rb +46 -0
  49. data/lib/modern_treasury/models/payment_order.rb +6 -9
  50. data/lib/modern_treasury/models/payment_order_create_async_params.rb +4 -14
  51. data/lib/modern_treasury/models/payment_order_create_params.rb +15 -25
  52. data/lib/modern_treasury/models/payment_order_list_params.rb +0 -7
  53. data/lib/modern_treasury/models/payment_order_subtype.rb +2 -3
  54. data/lib/modern_treasury/models/payment_order_type.rb +2 -10
  55. data/lib/modern_treasury/models/payment_order_update_params.rb +4 -14
  56. data/lib/modern_treasury/models/payment_reference.rb +2 -4
  57. data/lib/modern_treasury/models/reconciliation_rule.rb +3 -12
  58. data/lib/modern_treasury/models/return_object.rb +8 -7
  59. data/lib/modern_treasury/models/routing_detail.rb +0 -9
  60. data/lib/modern_treasury/models/routing_detail_create_params.rb +0 -9
  61. data/lib/modern_treasury/models/routing_number_lookup_request.rb +0 -7
  62. data/lib/modern_treasury/models/third_party_verification.rb +2 -0
  63. data/lib/modern_treasury/models/transaction.rb +17 -15
  64. data/lib/modern_treasury/models/transaction_create_params.rb +23 -21
  65. data/lib/modern_treasury/models/validation_validate_routing_number_params.rb +0 -2
  66. data/lib/modern_treasury/models/virtual_account_create_params.rb +0 -9
  67. data/lib/modern_treasury/models.rb +2 -0
  68. data/lib/modern_treasury/resources/bulk_requests.rb +1 -1
  69. data/lib/modern_treasury/resources/expected_payments.rb +3 -3
  70. data/lib/modern_treasury/resources/holds.rb +3 -3
  71. data/lib/modern_treasury/resources/incoming_payment_details.rb +1 -1
  72. data/lib/modern_treasury/resources/internal_accounts.rb +8 -6
  73. data/lib/modern_treasury/resources/invoices.rb +2 -2
  74. data/lib/modern_treasury/resources/legal_entities.rb +33 -2
  75. data/lib/modern_treasury/resources/payment_orders.rb +3 -3
  76. data/lib/modern_treasury/resources/transactions.rb +5 -3
  77. data/lib/modern_treasury/version.rb +1 -1
  78. data/lib/modern_treasury.rb +1 -0
  79. data/rbi/modern_treasury/models/bulk_request_create_params.rbi +104 -462
  80. data/rbi/modern_treasury/models/child_legal_entity.rbi +452 -5
  81. data/rbi/modern_treasury/models/child_legal_entity_create.rbi +68 -0
  82. data/rbi/modern_treasury/models/connection_legal_entity_create_params.rbi +74 -0
  83. data/rbi/modern_treasury/models/counterparty_collect_account_params.rbi +0 -10
  84. data/rbi/modern_treasury/models/counterparty_create_params.rbi +74 -45
  85. data/rbi/modern_treasury/models/currency.rbi +0 -2
  86. data/rbi/modern_treasury/models/document.rbi +0 -87
  87. data/rbi/modern_treasury/models/document_create_params.rbi +22 -22
  88. data/rbi/modern_treasury/models/document_list_params.rbi +22 -22
  89. data/rbi/modern_treasury/models/expected_payment.rbi +2 -4
  90. data/rbi/modern_treasury/models/expected_payment_create_params.rbi +2 -4
  91. data/rbi/modern_treasury/models/expected_payment_list_params.rbi +3 -41
  92. data/rbi/modern_treasury/models/expected_payment_type.rbi +1 -12
  93. data/rbi/modern_treasury/models/expected_payment_update_params.rbi +2 -4
  94. data/rbi/modern_treasury/models/external_account_create_params.rbi +0 -45
  95. data/rbi/modern_treasury/models/external_account_verify_params.rbi +0 -35
  96. data/rbi/modern_treasury/models/external_account_verify_response.rbi +0 -35
  97. data/rbi/modern_treasury/models/hold_list_params.rbi +8 -13
  98. data/rbi/modern_treasury/models/identification_create_request.rbi +375 -0
  99. data/rbi/modern_treasury/models/incoming_payment_detail.rbi +3 -26
  100. data/rbi/modern_treasury/models/incoming_payment_detail_create_async_params.rbi +0 -10
  101. data/rbi/modern_treasury/models/incoming_payment_detail_list_params.rbi +3 -16
  102. data/rbi/modern_treasury/models/internal_account.rbi +14 -35
  103. data/rbi/modern_treasury/models/internal_account_create_params.rbi +47 -59
  104. data/rbi/modern_treasury/models/internal_account_list_params.rbi +0 -35
  105. data/rbi/modern_treasury/models/internal_account_update_account_capability_response.rbi +0 -35
  106. data/rbi/modern_treasury/models/internal_accounts/balance_report.rbi +17 -7
  107. data/rbi/modern_treasury/models/internal_accounts/balance_report_create_params.rbi +31 -15
  108. data/rbi/modern_treasury/models/invoice.rbi +6 -6
  109. data/rbi/modern_treasury/models/invoice_create_params.rbi +4 -6
  110. data/rbi/modern_treasury/models/invoice_update_params.rbi +4 -6
  111. data/rbi/modern_treasury/models/ledger_balance.rbi +21 -3
  112. data/rbi/modern_treasury/models/ledger_entry.rbi +10 -0
  113. data/rbi/modern_treasury/models/ledger_entry_create_request.rbi +26 -10
  114. data/rbi/modern_treasury/models/ledger_transaction_create_partial_post_params.rbi +89 -13
  115. data/rbi/modern_treasury/models/ledger_transactions/ledger_transaction_version.rbi +10 -0
  116. data/rbi/modern_treasury/models/legal_entity.rbi +451 -5
  117. data/rbi/modern_treasury/models/legal_entity_address_create_request.rbi +18 -3
  118. data/rbi/modern_treasury/models/legal_entity_association.rbi +2 -4
  119. data/rbi/modern_treasury/models/legal_entity_create_params.rbi +68 -0
  120. data/rbi/modern_treasury/models/legal_entity_update_params.rbi +68 -0
  121. data/rbi/modern_treasury/models/legal_entity_update_status_params.rbi +96 -0
  122. data/rbi/modern_treasury/models/payment_order.rbi +16 -28
  123. data/rbi/modern_treasury/models/payment_order_create_async_params.rbi +6 -53
  124. data/rbi/modern_treasury/models/payment_order_create_params.rbi +28 -75
  125. data/rbi/modern_treasury/models/payment_order_list_params.rbi +0 -35
  126. data/rbi/modern_treasury/models/payment_order_subtype.rbi +3 -4
  127. data/rbi/modern_treasury/models/payment_order_type.rbi +2 -11
  128. data/rbi/modern_treasury/models/payment_order_update_params.rbi +6 -53
  129. data/rbi/modern_treasury/models/payment_reference.rbi +10 -20
  130. data/rbi/modern_treasury/models/reconciliation_rule.rbi +3 -29
  131. data/rbi/modern_treasury/models/return_object.rbi +19 -25
  132. data/rbi/modern_treasury/models/routing_detail.rbi +0 -42
  133. data/rbi/modern_treasury/models/routing_detail_create_params.rbi +0 -45
  134. data/rbi/modern_treasury/models/routing_number_lookup_request.rbi +0 -35
  135. data/rbi/modern_treasury/models/third_party_verification.rbi +10 -0
  136. data/rbi/modern_treasury/models/transaction.rbi +24 -24
  137. data/rbi/modern_treasury/models/transaction_create_params.rbi +33 -52
  138. data/rbi/modern_treasury/models/validation_validate_routing_number_params.rbi +0 -10
  139. data/rbi/modern_treasury/models/virtual_account_create_params.rbi +0 -45
  140. data/rbi/modern_treasury/models.rbi +3 -0
  141. data/rbi/modern_treasury/resources/bulk_requests.rbi +3 -2
  142. data/rbi/modern_treasury/resources/expected_payments.rbi +3 -6
  143. data/rbi/modern_treasury/resources/holds.rbi +3 -5
  144. data/rbi/modern_treasury/resources/incoming_payment_details.rbi +1 -2
  145. data/rbi/modern_treasury/resources/internal_accounts.rbi +15 -8
  146. data/rbi/modern_treasury/resources/invoices.rbi +4 -6
  147. data/rbi/modern_treasury/resources/legal_entities.rbi +31 -0
  148. data/rbi/modern_treasury/resources/payment_orders.rbi +9 -12
  149. data/rbi/modern_treasury/resources/transactions.rbi +11 -7
  150. data/sig/modern_treasury/models/bulk_request_create_params.rbs +45 -183
  151. data/sig/modern_treasury/models/child_legal_entity.rbs +179 -2
  152. data/sig/modern_treasury/models/child_legal_entity_create.rbs +21 -0
  153. data/sig/modern_treasury/models/connection_legal_entity_create_params.rbs +21 -0
  154. data/sig/modern_treasury/models/counterparty_collect_account_params.rbs +0 -4
  155. data/sig/modern_treasury/models/counterparty_create_params.rbs +21 -18
  156. data/sig/modern_treasury/models/currency.rbs +0 -4
  157. data/sig/modern_treasury/models/document.rbs +0 -57
  158. data/sig/modern_treasury/models/document_create_params.rbs +22 -22
  159. data/sig/modern_treasury/models/document_list_params.rbs +22 -22
  160. data/sig/modern_treasury/models/expected_payment_list_params.rbs +0 -14
  161. data/sig/modern_treasury/models/expected_payment_type.rbs +0 -14
  162. data/sig/modern_treasury/models/external_account_create_params.rbs +0 -18
  163. data/sig/modern_treasury/models/external_account_verify_params.rbs +0 -14
  164. data/sig/modern_treasury/models/external_account_verify_response.rbs +0 -14
  165. data/sig/modern_treasury/models/identification_create_request.rbs +150 -0
  166. data/sig/modern_treasury/models/incoming_payment_detail.rbs +0 -8
  167. data/sig/modern_treasury/models/incoming_payment_detail_create_async_params.rbs +0 -4
  168. data/sig/modern_treasury/models/incoming_payment_detail_list_params.rbs +0 -4
  169. data/sig/modern_treasury/models/internal_account.rbs +5 -14
  170. data/sig/modern_treasury/models/internal_account_create_params.rbs +20 -26
  171. data/sig/modern_treasury/models/internal_account_list_params.rbs +0 -14
  172. data/sig/modern_treasury/models/internal_account_update_account_capability_response.rbs +0 -14
  173. data/sig/modern_treasury/models/internal_accounts/balance_report.rbs +9 -4
  174. data/sig/modern_treasury/models/internal_accounts/balance_report_create_params.rbs +17 -8
  175. data/sig/modern_treasury/models/ledger_balance.rbs +18 -3
  176. data/sig/modern_treasury/models/ledger_entry.rbs +5 -0
  177. data/sig/modern_treasury/models/ledger_entry_create_request.rbs +14 -5
  178. data/sig/modern_treasury/models/ledger_transaction_create_partial_post_params.rbs +42 -8
  179. data/sig/modern_treasury/models/ledger_transactions/ledger_transaction_version.rbs +5 -0
  180. data/sig/modern_treasury/models/legal_entity.rbs +179 -2
  181. data/sig/modern_treasury/models/legal_entity_address_create_request.rbs +10 -3
  182. data/sig/modern_treasury/models/legal_entity_create_params.rbs +21 -0
  183. data/sig/modern_treasury/models/legal_entity_update_params.rbs +21 -0
  184. data/sig/modern_treasury/models/legal_entity_update_status_params.rbs +43 -0
  185. data/sig/modern_treasury/models/payment_order.rbs +4 -8
  186. data/sig/modern_treasury/models/payment_order_create_async_params.rbs +0 -18
  187. data/sig/modern_treasury/models/payment_order_create_params.rbs +22 -40
  188. data/sig/modern_treasury/models/payment_order_list_params.rbs +0 -14
  189. data/sig/modern_treasury/models/payment_order_subtype.rbs +4 -6
  190. data/sig/modern_treasury/models/payment_order_type.rbs +0 -14
  191. data/sig/modern_treasury/models/payment_order_update_params.rbs +0 -18
  192. data/sig/modern_treasury/models/payment_reference.rbs +4 -8
  193. data/sig/modern_treasury/models/reconciliation_rule.rbs +0 -14
  194. data/sig/modern_treasury/models/return_object.rbs +12 -10
  195. data/sig/modern_treasury/models/routing_detail.rbs +0 -18
  196. data/sig/modern_treasury/models/routing_detail_create_params.rbs +0 -18
  197. data/sig/modern_treasury/models/routing_number_lookup_request.rbs +0 -14
  198. data/sig/modern_treasury/models/third_party_verification.rbs +4 -1
  199. data/sig/modern_treasury/models/transaction.rbs +7 -16
  200. data/sig/modern_treasury/models/transaction_create_params.rbs +14 -19
  201. data/sig/modern_treasury/models/validation_validate_routing_number_params.rbs +0 -4
  202. data/sig/modern_treasury/models/virtual_account_create_params.rbs +0 -18
  203. data/sig/modern_treasury/models.rbs +2 -0
  204. data/sig/modern_treasury/resources/internal_accounts.rbs +3 -2
  205. data/sig/modern_treasury/resources/legal_entities.rbs +8 -0
  206. data/sig/modern_treasury/resources/transactions.rbs +2 -1
  207. metadata +5 -2
@@ -108,24 +108,17 @@ module ModernTreasury
108
108
  DK_NETS = :dk_nets
109
109
  EFT = :eft
110
110
  GB_FPS = :gb_fps
111
- HU_ICS = :hu_ics
112
- INTERAC = :interac
113
111
  MASAV = :masav
114
112
  MX_CCEN = :mx_ccen
115
113
  NEFT = :neft
116
114
  NICS = :nics
117
115
  NZ_BECS = :nz_becs
118
116
  PL_ELIXIR = :pl_elixir
119
- PROVXCHANGE = :provxchange
120
- RO_SENT = :ro_sent
121
117
  RTP = :rtp
122
118
  SE_BANKGIROT = :se_bankgirot
123
- SEN = :sen
124
119
  SEPA = :sepa
125
120
  SG_GIRO = :sg_giro
126
121
  SIC = :sic
127
- SIGNET = :signet
128
- SKNBI = :sknbi
129
122
  STABLECOIN = :stablecoin
130
123
  WIRE = :wire
131
124
  ZENGIN = :zengin
@@ -99,24 +99,17 @@ module ModernTreasury
99
99
  DK_NETS = :dk_nets
100
100
  EFT = :eft
101
101
  GB_FPS = :gb_fps
102
- HU_ICS = :hu_ics
103
- INTERAC = :interac
104
102
  MASAV = :masav
105
103
  MX_CCEN = :mx_ccen
106
104
  NEFT = :neft
107
105
  NICS = :nics
108
106
  NZ_BECS = :nz_becs
109
107
  PL_ELIXIR = :pl_elixir
110
- PROVXCHANGE = :provxchange
111
- RO_SENT = :ro_sent
112
108
  RTP = :rtp
113
109
  SE_BANKGIROT = :se_bankgirot
114
- SEN = :sen
115
110
  SEPA = :sepa
116
111
  SG_GIRO = :sg_giro
117
112
  SIC = :sic
118
- SIGNET = :signet
119
- SKNBI = :sknbi
120
113
  STABLECOIN = :stablecoin
121
114
  WIRE = :wire
122
115
  ZENGIN = :zengin
@@ -19,8 +19,8 @@ module ModernTreasury
19
19
  # @!attribute as_of_time
20
20
  # The time (24-hour clock) of the balance report in local time.
21
21
  #
22
- # @return [Time, nil]
23
- required :as_of_time, Time, nil?: true
22
+ # @return [Time]
23
+ required :as_of_time, Time
24
24
 
25
25
  # @!attribute balance_report_type
26
26
  # The specific type of balance report. One of `intraday`, `previous_day`,
@@ -73,7 +73,7 @@ module ModernTreasury
73
73
  #
74
74
  # @param as_of_date [Date] The date of the balance report in local time.
75
75
  #
76
- # @param as_of_time [Time, nil] The time (24-hour clock) of the balance report in local time.
76
+ # @param as_of_time [Time] The time (24-hour clock) of the balance report in local time.
77
77
  #
78
78
  # @param balance_report_type [Symbol, ModernTreasury::Models::InternalAccounts::BalanceReport::BalanceReportType] The specific type of balance report. One of `intraday`, `previous_day`, `real_ti
79
79
  #
@@ -117,6 +117,13 @@ module ModernTreasury
117
117
  # @return [Integer]
118
118
  required :amount, Integer
119
119
 
120
+ # @!attribute amount_string
121
+ # The amount of the balance as a string, preserving full precision for values that
122
+ # may exceed safe integer limits in some languages.
123
+ #
124
+ # @return [String]
125
+ required :amount_string, String
126
+
120
127
  # @!attribute as_of_date
121
128
  # The date on which the balance became true for the account.
122
129
  #
@@ -181,13 +188,13 @@ module ModernTreasury
181
188
  # @!attribute vendor_code_type
182
189
  # The type of `vendor_code` being reported. Can be one of `bai2`, `bankprov`,
183
190
  # `bnk_dev`, `cleartouch`, `currencycloud`, `cross_river`, `dc_bank`, `dwolla`,
184
- # `evolve`, `goldman_sachs`, `iso20022`, `jpmc`, `mx`, `signet`, `silvergate`,
185
- # `swift`, or `us_bank`.
191
+ # `evolve`, `goldman_sachs`, `iso20022`, `jpmc`, `mx`, `silvergate`, `swift`, or
192
+ # `us_bank`.
186
193
  #
187
194
  # @return [String, nil]
188
195
  required :vendor_code_type, String, nil?: true
189
196
 
190
- # @!method initialize(id:, amount:, as_of_date:, as_of_time:, balance_type:, created_at:, currency:, live_mode:, object:, updated_at:, value_date:, vendor_code:, vendor_code_type:)
197
+ # @!method initialize(id:, amount:, amount_string:, as_of_date:, as_of_time:, balance_type:, created_at:, currency:, live_mode:, object:, updated_at:, value_date:, vendor_code:, vendor_code_type:)
191
198
  # Some parameter documentations has been truncated, see
192
199
  # {ModernTreasury::Models::InternalAccounts::BalanceReport::Balance} for more
193
200
  # details.
@@ -196,6 +203,8 @@ module ModernTreasury
196
203
  #
197
204
  # @param amount [Integer] The balance amount.
198
205
  #
206
+ # @param amount_string [String] The amount of the balance as a string, preserving full precision for values that
207
+ #
199
208
  # @param as_of_date [Date, nil] The date on which the balance became true for the account.
200
209
  #
201
210
  # @param as_of_time [Time, nil] The time on which the balance became true for the account.
@@ -72,12 +72,6 @@ module ModernTreasury
72
72
  end
73
73
 
74
74
  class Balance < ModernTreasury::Internal::Type::BaseModel
75
- # @!attribute amount
76
- # The balance amount.
77
- #
78
- # @return [Integer]
79
- required :amount, Integer
80
-
81
75
  # @!attribute balance_type
82
76
  # The specific type of balance reported. One of `opening_ledger`,
83
77
  # `closing_ledger`, `current_ledger`, `opening_available`,
@@ -97,24 +91,39 @@ module ModernTreasury
97
91
  # @!attribute vendor_code_type
98
92
  # The type of `vendor_code` being reported. Can be one of `bai2`, `bankprov`,
99
93
  # `bnk_dev`, `cleartouch`, `currencycloud`, `cross_river`, `dc_bank`, `dwolla`,
100
- # `evolve`, `goldman_sachs`, `iso20022`, `jpmc`, `mx`, `signet`, `silvergate`,
101
- # `swift`, or `us_bank`.
94
+ # `evolve`, `goldman_sachs`, `iso20022`, `jpmc`, `mx`, `silvergate`, `swift`, or
95
+ # `us_bank`.
102
96
  #
103
97
  # @return [String, nil]
104
98
  required :vendor_code_type, String, nil?: true
105
99
 
106
- # @!method initialize(amount:, balance_type:, vendor_code:, vendor_code_type:)
100
+ # @!attribute amount
101
+ # The balance amount.
102
+ #
103
+ # @return [Integer, nil]
104
+ optional :amount, Integer
105
+
106
+ # @!attribute amount_string
107
+ # The amount of the balance as a string, preserving full precision for values that
108
+ # may exceed safe integer limits in some languages.
109
+ #
110
+ # @return [String, nil]
111
+ optional :amount_string, String
112
+
113
+ # @!method initialize(balance_type:, vendor_code:, vendor_code_type:, amount: nil, amount_string: nil)
107
114
  # Some parameter documentations has been truncated, see
108
115
  # {ModernTreasury::Models::InternalAccounts::BalanceReportCreateParams::Balance}
109
116
  # for more details.
110
117
  #
111
- # @param amount [Integer] The balance amount.
112
- #
113
118
  # @param balance_type [Symbol, ModernTreasury::Models::InternalAccounts::BalanceReportCreateParams::Balance::BalanceType] The specific type of balance reported. One of `opening_ledger`, `closing_ledger`
114
119
  #
115
120
  # @param vendor_code [String] The code used by the bank when reporting this specific balance.
116
121
  #
117
122
  # @param vendor_code_type [String, nil] The type of `vendor_code` being reported. Can be one of `bai2`, `bankprov`, `bnk
123
+ #
124
+ # @param amount [Integer] The balance amount.
125
+ #
126
+ # @param amount_string [String] The amount of the balance as a string, preserving full precision for values that
118
127
 
119
128
  # The specific type of balance reported. One of `opening_ledger`,
120
129
  # `closing_ledger`, `current_ledger`, `opening_available`,
@@ -108,7 +108,7 @@ module ModernTreasury
108
108
  required :invoicer_name, String, nil?: true
109
109
 
110
110
  # @!attribute issued_at
111
- # Translation missing: en.openapi.descriptions.invoice.schema.issued_at
111
+ # The time at which the invoice was issued.
112
112
  #
113
113
  # @return [Time, nil]
114
114
  required :issued_at, Time, nil?: true
@@ -168,7 +168,7 @@ module ModernTreasury
168
168
  required :originating_account_id, String
169
169
 
170
170
  # @!attribute paid_at
171
- # Translation missing: en.openapi.descriptions.invoice.schema.paid_at
171
+ # The time at which the invoice was paid.
172
172
  #
173
173
  # @return [Time, nil]
174
174
  required :paid_at, Time, nil?: true
@@ -265,7 +265,7 @@ module ModernTreasury
265
265
  required :virtual_account_id, String, nil?: true
266
266
 
267
267
  # @!attribute voided_at
268
- # Translation missing: en.openapi.descriptions.invoice.schema.voided_at
268
+ # The time at which the invoice was voided.
269
269
  #
270
270
  # @return [Time, nil]
271
271
  required :voided_at, Time, nil?: true
@@ -306,7 +306,7 @@ module ModernTreasury
306
306
  #
307
307
  # @param invoicer_name [String, nil] The name of the issuer for the invoice. Defaults to the name of the Organization
308
308
  #
309
- # @param issued_at [Time, nil] Translation missing: en.openapi.descriptions.invoice.schema.issued_at
309
+ # @param issued_at [Time, nil] The time at which the invoice was issued.
310
310
  #
311
311
  # @param ledger_account_settlement_id [String, nil] The ledger account settlement object linked to the invoice.
312
312
  #
@@ -324,7 +324,7 @@ module ModernTreasury
324
324
  #
325
325
  # @param originating_account_id [String] The ID of the internal account the invoice should be paid to.
326
326
  #
327
- # @param paid_at [Time, nil] Translation missing: en.openapi.descriptions.invoice.schema.paid_at
327
+ # @param paid_at [Time, nil] The time at which the invoice was paid.
328
328
  #
329
329
  # @param payment_effective_date [Date, nil] Date transactions are to be posted to the participants' account. Defaults to the
330
330
  #
@@ -354,7 +354,7 @@ module ModernTreasury
354
354
  #
355
355
  # @param virtual_account_id [String, nil] The ID of the virtual account the invoice should be paid to.
356
356
  #
357
- # @param voided_at [Time, nil] Translation missing: en.openapi.descriptions.invoice.schema.voided_at
357
+ # @param voided_at [Time, nil] The time at which the invoice was voided.
358
358
 
359
359
  # @see ModernTreasury::Models::Invoice#counterparty_billing_address
360
360
  class CounterpartyBillingAddress < ModernTreasury::Internal::Type::BaseModel
@@ -141,9 +141,8 @@ module ModernTreasury
141
141
  optional :payment_method, enum: -> { ModernTreasury::InvoiceCreateParams::PaymentMethod }
142
142
 
143
143
  # @!attribute payment_type
144
- # One of `ach`, `se_bankgirot`, `eft`, `wire`, `check`, `sen`, `book`, `rtp`,
145
- # `sepa`, `bacs`, `au_becs`, `interac`, `neft`, `nics`,
146
- # `nz_national_clearing_code`, `sic`, `signet`, `provexchange`, `zengin`.
144
+ # One of `ach`, `se_bankgirot`, `eft`, `wire`, `check`, `book`, `rtp`, `sepa`,
145
+ # `bacs`, `au_becs`, `neft`, `nics`, `nz_national_clearing_code`, `sic`, `zengin`.
147
146
  #
148
147
  # @return [Symbol, ModernTreasury::Models::PaymentOrderType, nil]
149
148
  optional :payment_type, enum: -> { ModernTreasury::PaymentOrderType }
@@ -221,7 +220,7 @@ module ModernTreasury
221
220
  #
222
221
  # @param payment_method [Symbol, ModernTreasury::Models::InvoiceCreateParams::PaymentMethod] The method by which the invoice can be paid. `ui` will show the embedded payment
223
222
  #
224
- # @param payment_type [Symbol, ModernTreasury::Models::PaymentOrderType] One of `ach`, `se_bankgirot`, `eft`, `wire`, `check`, `sen`, `book`, `rtp`, `sep
223
+ # @param payment_type [Symbol, ModernTreasury::Models::PaymentOrderType] One of `ach`, `se_bankgirot`, `eft`, `wire`, `check`, `book`, `rtp`, `sepa`, `ba
225
224
  #
226
225
  # @param receiving_account_id [String] The receiving account ID. Can be an `external_account`.
227
226
  #
@@ -138,9 +138,8 @@ module ModernTreasury
138
138
  optional :payment_method, enum: -> { ModernTreasury::InvoiceUpdateParams::PaymentMethod }
139
139
 
140
140
  # @!attribute payment_type
141
- # One of `ach`, `se_bankgirot`, `eft`, `wire`, `check`, `sen`, `book`, `rtp`,
142
- # `sepa`, `bacs`, `au_becs`, `interac`, `neft`, `nics`,
143
- # `nz_national_clearing_code`, `sic`, `signet`, `provexchange`, `zengin`.
141
+ # One of `ach`, `se_bankgirot`, `eft`, `wire`, `check`, `book`, `rtp`, `sepa`,
142
+ # `bacs`, `au_becs`, `neft`, `nics`, `nz_national_clearing_code`, `sic`, `zengin`.
144
143
  #
145
144
  # @return [Symbol, ModernTreasury::Models::PaymentOrderType, nil]
146
145
  optional :payment_type, enum: -> { ModernTreasury::PaymentOrderType }
@@ -226,7 +225,7 @@ module ModernTreasury
226
225
  #
227
226
  # @param payment_method [Symbol, ModernTreasury::Models::InvoiceUpdateParams::PaymentMethod] The method by which the invoice can be paid. `ui` will show the embedded payment
228
227
  #
229
- # @param payment_type [Symbol, ModernTreasury::Models::PaymentOrderType] One of `ach`, `se_bankgirot`, `eft`, `wire`, `check`, `sen`, `book`, `rtp`, `sep
228
+ # @param payment_type [Symbol, ModernTreasury::Models::PaymentOrderType] One of `ach`, `se_bankgirot`, `eft`, `wire`, `check`, `book`, `rtp`, `sepa`, `ba
230
229
  #
231
230
  # @param receiving_account_id [String] The receiving account ID. Can be an `external_account`.
232
231
  #
@@ -8,11 +8,21 @@ module ModernTreasury
8
8
  # @return [Integer]
9
9
  required :amount, Integer
10
10
 
11
+ # @!attribute amount_string
12
+ #
13
+ # @return [String]
14
+ required :amount_string, String
15
+
11
16
  # @!attribute credits
12
17
  #
13
18
  # @return [Integer]
14
19
  required :credits, Integer
15
20
 
21
+ # @!attribute credits_string
22
+ #
23
+ # @return [String]
24
+ required :credits_string, String
25
+
16
26
  # @!attribute currency
17
27
  # The currency of the ledger account.
18
28
  #
@@ -30,16 +40,27 @@ module ModernTreasury
30
40
  # @return [Integer]
31
41
  required :debits, Integer
32
42
 
33
- # @!method initialize(amount:, credits:, currency:, currency_exponent:, debits:)
43
+ # @!attribute debits_string
44
+ #
45
+ # @return [String]
46
+ required :debits_string, String
47
+
48
+ # @!method initialize(amount:, amount_string:, credits:, credits_string:, currency:, currency_exponent:, debits:, debits_string:)
34
49
  # @param amount [Integer]
35
50
  #
51
+ # @param amount_string [String]
52
+ #
36
53
  # @param credits [Integer]
37
54
  #
55
+ # @param credits_string [String]
56
+ #
38
57
  # @param currency [String] The currency of the ledger account.
39
58
  #
40
59
  # @param currency_exponent [Integer] The currency exponent of the ledger account.
41
60
  #
42
61
  # @param debits [Integer]
62
+ #
63
+ # @param debits_string [String]
43
64
  end
44
65
  end
45
66
  end
@@ -16,6 +16,13 @@ module ModernTreasury
16
16
  # @return [Integer]
17
17
  required :amount, Integer
18
18
 
19
+ # @!attribute amount_string
20
+ # The amount of the ledger entry as a string, preserving full precision for values
21
+ # that may exceed safe integer limits in some languages.
22
+ #
23
+ # @return [String]
24
+ required :amount_string, String
25
+
19
26
  # @!attribute created_at
20
27
  #
21
28
  # @return [Time]
@@ -118,7 +125,7 @@ module ModernTreasury
118
125
  # @return [Time]
119
126
  required :updated_at, Time
120
127
 
121
- # @!method initialize(id:, amount:, created_at:, direction:, discarded_at:, effective_at:, ledger_account_currency:, ledger_account_currency_exponent:, ledger_account_id:, ledger_account_lock_version:, ledger_transaction_id:, live_mode:, metadata:, object:, resulting_ledger_account_balances:, status:, updated_at:)
128
+ # @!method initialize(id:, amount:, amount_string:, created_at:, direction:, discarded_at:, effective_at:, ledger_account_currency:, ledger_account_currency_exponent:, ledger_account_id:, ledger_account_lock_version:, ledger_transaction_id:, live_mode:, metadata:, object:, resulting_ledger_account_balances:, status:, updated_at:)
122
129
  # Some parameter documentations has been truncated, see
123
130
  # {ModernTreasury::Models::LedgerEntry} for more details.
124
131
  #
@@ -126,6 +133,8 @@ module ModernTreasury
126
133
  #
127
134
  # @param amount [Integer] Value in specified currency's smallest unit. e.g. $10 would be represented as 10
128
135
  #
136
+ # @param amount_string [String] The amount of the ledger entry as a string, preserving full precision for values
137
+ #
129
138
  # @param created_at [Time]
130
139
  #
131
140
  # @param direction [Symbol, ModernTreasury::Models::TransactionDirection] One of `credit`, `debit`. Describes the direction money is flowing in the transa
@@ -3,13 +3,6 @@
3
3
  module ModernTreasury
4
4
  module Models
5
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
6
  # @!attribute direction
14
7
  # One of `credit`, `debit`. Describes the direction money is flowing in the
15
8
  # transaction. A `credit` moves money from your account to someone else's. A
@@ -25,6 +18,20 @@ module ModernTreasury
25
18
  # @return [String]
26
19
  required :ledger_account_id, String
27
20
 
21
+ # @!attribute amount
22
+ # Value in specified currency's smallest unit. e.g. $10 would be represented
23
+ # as 1000. Can be any integer up to 36 digits.
24
+ #
25
+ # @return [Integer, nil]
26
+ optional :amount, Integer
27
+
28
+ # @!attribute amount_string
29
+ # The amount of the ledger entry as a string, preserving full precision for values
30
+ # that may exceed safe integer limits in some languages.
31
+ #
32
+ # @return [String, nil]
33
+ optional :amount_string, String
34
+
28
35
  # @!attribute available_balance_amount
29
36
  # Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
30
37
  # account’s available balance. If any of these conditions would be false after the
@@ -79,16 +86,18 @@ module ModernTreasury
79
86
  # @return [Boolean, nil]
80
87
  optional :show_resulting_ledger_account_balances, ModernTreasury::Internal::Type::Boolean, nil?: true
81
88
 
82
- # @!method initialize(amount:, direction:, ledger_account_id:, available_balance_amount: nil, effective_at: nil, lock_version: nil, metadata: nil, pending_balance_amount: nil, posted_balance_amount: nil, show_resulting_ledger_account_balances: nil)
89
+ # @!method initialize(direction:, ledger_account_id:, amount: nil, amount_string: nil, available_balance_amount: nil, effective_at: nil, lock_version: nil, metadata: nil, pending_balance_amount: nil, posted_balance_amount: nil, show_resulting_ledger_account_balances: nil)
83
90
  # Some parameter documentations has been truncated, see
84
91
  # {ModernTreasury::Models::LedgerEntryCreateRequest} for more details.
85
92
  #
86
- # @param amount [Integer] Value in specified currency's smallest unit. e.g. $10 would be represented as 10
87
- #
88
93
  # @param direction [Symbol, ModernTreasury::Models::TransactionDirection] One of `credit`, `debit`. Describes the direction money is flowing in the transa
89
94
  #
90
95
  # @param ledger_account_id [String] The ledger account that this ledger entry is associated with.
91
96
  #
97
+ # @param amount [Integer] Value in specified currency's smallest unit. e.g. $10 would be represented as 10
98
+ #
99
+ # @param amount_string [String] The amount of the ledger entry as a string, preserving full precision for values
100
+ #
92
101
  # @param available_balance_amount [Hash{Symbol=>Integer}, nil] Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the accou
93
102
  #
94
103
  # @param effective_at [Time] The timestamp (ISO8601 format) at which the ledger transaction happened for repo
@@ -60,13 +60,6 @@ module ModernTreasury
60
60
  # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
61
61
 
62
62
  class PostedLedgerEntry < ModernTreasury::Internal::Type::BaseModel
63
- # @!attribute amount
64
- # Value in specified currency's smallest unit. e.g. $10 would be represented
65
- # as 1000. Can be any integer up to 36 digits.
66
- #
67
- # @return [Integer]
68
- required :amount, Integer
69
-
70
63
  # @!attribute direction
71
64
  # One of `credit`, `debit`. Describes the direction money is flowing in the
72
65
  # transaction. A `credit` moves money from your account to someone else's. A
@@ -83,6 +76,37 @@ module ModernTreasury
83
76
  # @return [String]
84
77
  required :ledger_account_id, String
85
78
 
79
+ # @!attribute amount
80
+ # Value in specified currency's smallest unit. e.g. $10 would be represented
81
+ # as 1000. Can be any integer up to 36 digits.
82
+ #
83
+ # @return [Integer, nil]
84
+ optional :amount, Integer
85
+
86
+ # @!attribute amount_string
87
+ # The amount of the ledger entry as a string, preserving full precision for values
88
+ # that may exceed safe integer limits in some languages.
89
+ #
90
+ # @return [String, nil]
91
+ optional :amount_string, String
92
+
93
+ # @!attribute available_balance_amount
94
+ # Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
95
+ # account’s available balance. If any of these conditions would be false after the
96
+ # transaction is created, the entire call will fail with error code 422.
97
+ #
98
+ # @return [Hash{Symbol=>Integer}, nil]
99
+ optional :available_balance_amount, ModernTreasury::Internal::Type::HashOf[Integer], nil?: true
100
+
101
+ # @!attribute lock_version
102
+ # Lock version of the ledger account. This can be passed when creating a ledger
103
+ # transaction to only succeed if no ledger transactions have posted since the
104
+ # given version. See our post about Designing the Ledgers API with Optimistic
105
+ # Locking for more details.
106
+ #
107
+ # @return [Integer, nil]
108
+ optional :lock_version, Integer, nil?: true
109
+
86
110
  # @!attribute metadata
87
111
  # Additional data represented as key-value pairs. Both the key and value must be
88
112
  # strings.
@@ -90,18 +114,53 @@ module ModernTreasury
90
114
  # @return [Hash{Symbol=>String}, nil]
91
115
  optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
92
116
 
93
- # @!method initialize(amount:, direction:, ledger_account_id:, metadata: nil)
117
+ # @!attribute pending_balance_amount
118
+ # Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
119
+ # account’s pending balance. If any of these conditions would be false after the
120
+ # transaction is created, the entire call will fail with error code 422.
121
+ #
122
+ # @return [Hash{Symbol=>Integer}, nil]
123
+ optional :pending_balance_amount, ModernTreasury::Internal::Type::HashOf[Integer], nil?: true
124
+
125
+ # @!attribute posted_balance_amount
126
+ # Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
127
+ # account’s posted balance. If any of these conditions would be false after the
128
+ # transaction is created, the entire call will fail with error code 422.
129
+ #
130
+ # @return [Hash{Symbol=>Integer}, nil]
131
+ optional :posted_balance_amount, ModernTreasury::Internal::Type::HashOf[Integer], nil?: true
132
+
133
+ # @!attribute show_resulting_ledger_account_balances
134
+ # If true, response will include the balance of the associated ledger account for
135
+ # the entry.
136
+ #
137
+ # @return [Boolean, nil]
138
+ optional :show_resulting_ledger_account_balances, ModernTreasury::Internal::Type::Boolean, nil?: true
139
+
140
+ # @!method initialize(direction:, ledger_account_id:, amount: nil, amount_string: nil, available_balance_amount: nil, lock_version: nil, metadata: nil, pending_balance_amount: nil, posted_balance_amount: nil, show_resulting_ledger_account_balances: nil)
94
141
  # Some parameter documentations has been truncated, see
95
142
  # {ModernTreasury::Models::LedgerTransactionCreatePartialPostParams::PostedLedgerEntry}
96
143
  # for more details.
97
144
  #
98
- # @param amount [Integer] Value in specified currency's smallest unit. e.g. $10 would be represented as 10
99
- #
100
145
  # @param direction [Symbol, ModernTreasury::Models::LedgerTransactionCreatePartialPostParams::PostedLedgerEntry::Direction] One of `credit`, `debit`. Describes the direction money is flowing in the transa
101
146
  #
102
147
  # @param ledger_account_id [String] The ledger account that this ledger entry is associated with.
103
148
  #
149
+ # @param amount [Integer] Value in specified currency's smallest unit. e.g. $10 would be represented as 10
150
+ #
151
+ # @param amount_string [String] The amount of the ledger entry as a string, preserving full precision for values
152
+ #
153
+ # @param available_balance_amount [Hash{Symbol=>Integer}, nil] Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the accou
154
+ #
155
+ # @param lock_version [Integer, nil] Lock version of the ledger account. This can be passed when creating a ledger tr
156
+ #
104
157
  # @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
158
+ #
159
+ # @param pending_balance_amount [Hash{Symbol=>Integer}, nil] Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the accou
160
+ #
161
+ # @param posted_balance_amount [Hash{Symbol=>Integer}, nil] Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the accou
162
+ #
163
+ # @param show_resulting_ledger_account_balances [Boolean, nil] If true, response will include the balance of the associated ledger account for
105
164
 
106
165
  # One of `credit`, `debit`. Describes the direction money is flowing in the
107
166
  # transaction. A `credit` moves money from your account to someone else's. A
@@ -204,6 +204,13 @@ module ModernTreasury
204
204
  # @return [Integer]
205
205
  required :amount, Integer
206
206
 
207
+ # @!attribute amount_string
208
+ # The amount of the ledger entry as a string, preserving full precision for values
209
+ # that may exceed safe integer limits in some languages.
210
+ #
211
+ # @return [String]
212
+ required :amount_string, String
213
+
207
214
  # @!attribute created_at
208
215
  #
209
216
  # @return [Time]
@@ -297,7 +304,7 @@ module ModernTreasury
297
304
  required :status,
298
305
  enum: -> { ModernTreasury::LedgerTransactions::LedgerTransactionVersion::LedgerEntry::Status }
299
306
 
300
- # @!method initialize(id:, amount:, created_at:, direction:, effective_at:, ledger_account_currency:, ledger_account_currency_exponent:, ledger_account_id:, ledger_account_lock_version:, ledger_transaction_id:, live_mode:, metadata:, object:, resulting_ledger_account_balances:, status:)
307
+ # @!method initialize(id:, amount:, amount_string:, created_at:, direction:, effective_at:, ledger_account_currency:, ledger_account_currency_exponent:, ledger_account_id:, ledger_account_lock_version:, ledger_transaction_id:, live_mode:, metadata:, object:, resulting_ledger_account_balances:, status:)
301
308
  # Some parameter documentations has been truncated, see
302
309
  # {ModernTreasury::Models::LedgerTransactions::LedgerTransactionVersion::LedgerEntry}
303
310
  # for more details.
@@ -306,6 +313,8 @@ module ModernTreasury
306
313
  #
307
314
  # @param amount [Integer] Value in specified currency's smallest unit. e.g. $10 would be represented as 10
308
315
  #
316
+ # @param amount_string [String] The amount of the ledger entry as a string, preserving full precision for values
317
+ #
309
318
  # @param created_at [Time]
310
319
  #
311
320
  # @param direction [Symbol, ModernTreasury::Models::TransactionDirection] One of `credit`, `debit`. Describes the direction money is flowing in the transa