modern_treasury 0.30.0 → 0.32.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 (145) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +35 -0
  3. data/README.md +1 -1
  4. data/lib/modern_treasury/models/account_detail.rb +9 -6
  5. data/lib/modern_treasury/models/account_detail_create_params.rb +9 -6
  6. data/lib/modern_treasury/models/bulk_request_create_params.rb +30 -10
  7. data/lib/modern_treasury/models/child_legal_entity.rb +8 -7
  8. data/lib/modern_treasury/models/child_legal_entity_create.rb +2 -2
  9. data/lib/modern_treasury/models/connection_legal_entity_create_params.rb +2 -2
  10. data/lib/modern_treasury/models/counterparty_create_params.rb +27 -4
  11. data/lib/modern_treasury/models/document.rb +7 -9
  12. data/lib/modern_treasury/models/document_create_params.rb +0 -2
  13. data/lib/modern_treasury/models/document_list_params.rb +7 -9
  14. data/lib/modern_treasury/models/expected_payment.rb +3 -4
  15. data/lib/modern_treasury/models/expected_payment_create_params.rb +2 -3
  16. data/lib/modern_treasury/models/expected_payment_update_params.rb +2 -3
  17. data/lib/modern_treasury/models/external_account_create_params.rb +2 -1
  18. data/lib/modern_treasury/models/identification.rb +109 -0
  19. data/lib/modern_treasury/models/identification_create_params.rb +109 -0
  20. data/lib/modern_treasury/models/identification_create_request.rb +109 -0
  21. data/lib/modern_treasury/models/identification_update_params.rb +109 -0
  22. data/lib/modern_treasury/models/incoming_payment_detail.rb +2 -1
  23. data/lib/modern_treasury/models/incoming_payment_detail_create_async_params.rb +3 -14
  24. data/lib/modern_treasury/models/internal_account.rb +10 -1
  25. data/lib/modern_treasury/models/internal_account_create_params.rb +13 -1
  26. data/lib/modern_treasury/models/ledger_account.rb +0 -1
  27. data/lib/modern_treasury/models/ledger_account_create_request.rb +0 -1
  28. data/lib/modern_treasury/models/legal_entity.rb +8 -7
  29. data/lib/modern_treasury/models/legal_entity_address_create_request.rb +18 -18
  30. data/lib/modern_treasury/models/legal_entity_create_params.rb +23 -3
  31. data/lib/modern_treasury/models/legal_entity_list_params.rb +1 -0
  32. data/lib/modern_treasury/models/legal_entity_update_params.rb +25 -3
  33. data/lib/modern_treasury/models/payment_order.rb +12 -2
  34. data/lib/modern_treasury/models/payment_order_create_async_params.rb +13 -2
  35. data/lib/modern_treasury/models/payment_order_create_params.rb +13 -4
  36. data/lib/modern_treasury/models/payment_order_subtype.rb +3 -0
  37. data/lib/modern_treasury/models/payment_order_update_params.rb +13 -2
  38. data/lib/modern_treasury/models/payment_reference.rb +1 -1
  39. data/lib/modern_treasury/models/return_object.rb +1 -1
  40. data/lib/modern_treasury/models/third_party_verification.rb +1 -0
  41. data/lib/modern_treasury/models/virtual_account.rb +9 -1
  42. data/lib/modern_treasury/models/virtual_account_create_params.rb +18 -7
  43. data/lib/modern_treasury/models/virtual_account_list_params.rb +9 -1
  44. data/lib/modern_treasury/resources/account_details.rb +1 -1
  45. data/lib/modern_treasury/resources/documents.rb +1 -1
  46. data/lib/modern_treasury/resources/expected_payments.rb +2 -2
  47. data/lib/modern_treasury/resources/incoming_payment_details.rb +1 -1
  48. data/lib/modern_treasury/resources/internal_accounts.rb +7 -2
  49. data/lib/modern_treasury/resources/legal_entities.rb +8 -4
  50. data/lib/modern_treasury/resources/payment_orders.rb +9 -3
  51. data/lib/modern_treasury/resources/virtual_accounts.rb +6 -2
  52. data/lib/modern_treasury/version.rb +1 -1
  53. data/rbi/modern_treasury/models/account_detail.rbi +19 -11
  54. data/rbi/modern_treasury/models/account_detail_create_params.rbi +19 -11
  55. data/rbi/modern_treasury/models/bulk_request_create_params.rbi +66 -16
  56. data/rbi/modern_treasury/models/child_legal_entity.rbi +10 -8
  57. data/rbi/modern_treasury/models/child_legal_entity_create.rbi +2 -2
  58. data/rbi/modern_treasury/models/connection_legal_entity_create_params.rbi +2 -2
  59. data/rbi/modern_treasury/models/counterparty_create_params.rbi +69 -7
  60. data/rbi/modern_treasury/models/document.rbi +9 -19
  61. data/rbi/modern_treasury/models/document_create_params.rbi +0 -10
  62. data/rbi/modern_treasury/models/document_list_params.rbi +9 -19
  63. data/rbi/modern_treasury/models/expected_payment.rbi +3 -3
  64. data/rbi/modern_treasury/models/expected_payment_create_params.rbi +11 -3
  65. data/rbi/modern_treasury/models/expected_payment_update_params.rbi +11 -3
  66. data/rbi/modern_treasury/models/external_account_create_params.rbi +10 -5
  67. data/rbi/modern_treasury/models/identification.rbi +224 -0
  68. data/rbi/modern_treasury/models/identification_create_params.rbi +545 -0
  69. data/rbi/modern_treasury/models/identification_create_request.rbi +545 -0
  70. data/rbi/modern_treasury/models/identification_update_params.rbi +545 -0
  71. data/rbi/modern_treasury/models/incoming_payment_detail.rbi +10 -5
  72. data/rbi/modern_treasury/models/incoming_payment_detail_create_async_params.rbi +4 -50
  73. data/rbi/modern_treasury/models/internal_account.rbi +10 -0
  74. data/rbi/modern_treasury/models/internal_account_create_params.rbi +22 -0
  75. data/rbi/modern_treasury/models/ledger_account.rbi +0 -5
  76. data/rbi/modern_treasury/models/ledger_account_create_request.rbi +0 -5
  77. data/rbi/modern_treasury/models/legal_entity.rbi +9 -8
  78. data/rbi/modern_treasury/models/legal_entity_address_create_request.rbi +21 -21
  79. data/rbi/modern_treasury/models/legal_entity_create_params.rbi +51 -2
  80. data/rbi/modern_treasury/models/legal_entity_list_params.rbi +5 -0
  81. data/rbi/modern_treasury/models/legal_entity_update_params.rbi +54 -2
  82. data/rbi/modern_treasury/models/payment_order.rbi +17 -5
  83. data/rbi/modern_treasury/models/payment_order_create_async_params.rbi +22 -5
  84. data/rbi/modern_treasury/models/payment_order_create_params.rbi +22 -15
  85. data/rbi/modern_treasury/models/payment_order_subtype.rbi +9 -0
  86. data/rbi/modern_treasury/models/payment_order_update_params.rbi +22 -5
  87. data/rbi/modern_treasury/models/payment_reference.rbi +5 -5
  88. data/rbi/modern_treasury/models/return_object.rbi +5 -5
  89. data/rbi/modern_treasury/models/third_party_verification.rbi +5 -0
  90. data/rbi/modern_treasury/models/virtual_account.rbi +8 -0
  91. data/rbi/modern_treasury/models/virtual_account_create_params.rbi +27 -11
  92. data/rbi/modern_treasury/models/virtual_account_list_params.rbi +11 -0
  93. data/rbi/modern_treasury/resources/account_details.rbi +3 -2
  94. data/rbi/modern_treasury/resources/documents.rbi +3 -3
  95. data/rbi/modern_treasury/resources/expected_payments.rbi +2 -2
  96. data/rbi/modern_treasury/resources/incoming_payment_details.rbi +1 -2
  97. data/rbi/modern_treasury/resources/internal_accounts.rbi +7 -1
  98. data/rbi/modern_treasury/resources/legal_entities.rbi +11 -2
  99. data/rbi/modern_treasury/resources/payment_orders.rbi +15 -0
  100. data/rbi/modern_treasury/resources/virtual_accounts.rbi +6 -0
  101. data/sig/modern_treasury/models/account_detail.rbs +5 -3
  102. data/sig/modern_treasury/models/account_detail_create_params.rbs +5 -3
  103. data/sig/modern_treasury/models/bulk_request_create_params.rbs +36 -14
  104. data/sig/modern_treasury/models/child_legal_entity.rbs +2 -1
  105. data/sig/modern_treasury/models/counterparty_create_params.rbs +24 -3
  106. data/sig/modern_treasury/models/document.rbs +0 -4
  107. data/sig/modern_treasury/models/document_create_params.rbs +0 -4
  108. data/sig/modern_treasury/models/document_list_params.rbs +0 -4
  109. data/sig/modern_treasury/models/expected_payment.rbs +4 -4
  110. data/sig/modern_treasury/models/expected_payment_create_params.rbs +8 -4
  111. data/sig/modern_treasury/models/expected_payment_update_params.rbs +8 -4
  112. data/sig/modern_treasury/models/external_account_create_params.rbs +5 -3
  113. data/sig/modern_treasury/models/identification.rbs +219 -1
  114. data/sig/modern_treasury/models/identification_create_params.rbs +219 -1
  115. data/sig/modern_treasury/models/identification_create_request.rbs +219 -1
  116. data/sig/modern_treasury/models/identification_update_params.rbs +219 -1
  117. data/sig/modern_treasury/models/incoming_payment_detail.rbs +5 -3
  118. data/sig/modern_treasury/models/incoming_payment_detail_create_async_params.rbs +6 -17
  119. data/sig/modern_treasury/models/internal_account.rbs +5 -0
  120. data/sig/modern_treasury/models/internal_account_create_params.rbs +13 -1
  121. data/sig/modern_treasury/models/ledger_account.rbs +1 -2
  122. data/sig/modern_treasury/models/ledger_account_create_request.rbs +1 -2
  123. data/sig/modern_treasury/models/legal_entity.rbs +2 -1
  124. data/sig/modern_treasury/models/legal_entity_address_create_request.rbs +13 -13
  125. data/sig/modern_treasury/models/legal_entity_create_params.rbs +19 -0
  126. data/sig/modern_treasury/models/legal_entity_list_params.rbs +2 -1
  127. data/sig/modern_treasury/models/legal_entity_update_params.rbs +19 -0
  128. data/sig/modern_treasury/models/payment_order.rbs +7 -2
  129. data/sig/modern_treasury/models/payment_order_create_async_params.rbs +10 -3
  130. data/sig/modern_treasury/models/payment_order_create_params.rbs +10 -7
  131. data/sig/modern_treasury/models/payment_order_subtype.rbs +6 -0
  132. data/sig/modern_treasury/models/payment_order_update_params.rbs +10 -3
  133. data/sig/modern_treasury/models/payment_reference.rbs +2 -2
  134. data/sig/modern_treasury/models/return_object.rbs +2 -2
  135. data/sig/modern_treasury/models/third_party_verification.rbs +2 -0
  136. data/sig/modern_treasury/models/virtual_account.rbs +5 -0
  137. data/sig/modern_treasury/models/virtual_account_create_params.rbs +10 -3
  138. data/sig/modern_treasury/models/virtual_account_list_params.rbs +7 -0
  139. data/sig/modern_treasury/resources/expected_payments.rbs +2 -2
  140. data/sig/modern_treasury/resources/incoming_payment_details.rbs +1 -1
  141. data/sig/modern_treasury/resources/internal_accounts.rbs +1 -0
  142. data/sig/modern_treasury/resources/legal_entities.rbs +2 -0
  143. data/sig/modern_treasury/resources/payment_orders.rbs +3 -0
  144. data/sig/modern_treasury/resources/virtual_accounts.rbs +2 -0
  145. metadata +2 -2
@@ -66,24 +66,51 @@ module ModernTreasury
66
66
  module IDType
67
67
  extend ModernTreasury::Internal::Type::Enum
68
68
 
69
+ AD_NRT = :ad_nrt
70
+ AE_EID = :ae_eid
71
+ AE_TRN = :ae_trn
72
+ AG_TIN = :ag_tin
73
+ AI_TIN = :ai_tin
74
+ AL_NID = :al_nid
75
+ AL_NIPT = :al_nipt
76
+ AM_TIN = :am_tin
77
+ AO_NIF = :ao_nif
69
78
  AR_CUIL = :ar_cuil
70
79
  AR_CUIT = :ar_cuit
71
80
  AT_ATIN = :at_atin
72
81
  AT_VAT = :at_vat
73
82
  AU_ABN = :au_abn
74
83
  AU_TFN = :au_tfn
84
+ AW_TIN = :aw_tin
85
+ AZ_PIN = :az_pin
86
+ BB_TIN = :bb_tin
87
+ BD_TIN = :bd_tin
75
88
  BE_ENT = :be_ent
76
89
  BE_NRN = :be_nrn
90
+ BF_IFU = :bf_ifu
91
+ BG_EGN = :bg_egn
92
+ BH_CPR = :bh_cpr
93
+ BH_VAT = :bh_vat
94
+ BJ_IFU = :bj_ifu
95
+ BO_NIT = :bo_nit
77
96
  BR_CNPJ = :br_cnpj
78
97
  BR_CPF = :br_cpf
98
+ BS_TIN = :bs_tin
99
+ BT_BIN = :bt_bin
100
+ BW_TIN = :bw_tin
101
+ BZ_TIN = :bz_tin
79
102
  CA_BN = :ca_bn
80
103
  CA_SIN = :ca_sin
81
104
  CH_AHV = :ch_ahv
82
105
  CH_UID = :ch_uid
106
+ CI_NCC = :ci_ncc
83
107
  CL_RUN = :cl_run
84
108
  CL_RUT = :cl_rut
109
+ CM_NIU = :cm_niu
85
110
  CO_CEDULAS = :co_cedulas
86
111
  CO_NIT = :co_nit
112
+ CR_CPF = :cr_cpf
113
+ CW_CRIB = :cw_crib
87
114
  CY_TIN = :cy_tin
88
115
  CZ_ICO = :cz_ico
89
116
  CZ_RC = :cz_rc
@@ -92,21 +119,39 @@ module ModernTreasury
92
119
  DE_VAT = :de_vat
93
120
  DK_CPR = :dk_cpr
94
121
  DK_CVR = :dk_cvr
122
+ DM_TIN = :dm_tin
123
+ DO_CEDULA = :do_cedula
124
+ DO_RNC = :do_rnc
95
125
  DRIVERS_LICENSE = :drivers_license
126
+ EC_RUC = :ec_ruc
96
127
  EE_IK = :ee_ik
97
128
  EE_RK = :ee_rk
98
129
  ES_NIE = :es_nie
99
130
  ES_NIF = :es_nif
100
131
  FI_HETU = :fi_hetu
101
132
  FI_YTJ = :fi_ytj
133
+ FJ_TIN = :fj_tin
134
+ FO_PTAL = :fo_ptal
102
135
  FR_NIF = :fr_nif
103
136
  FR_SIREN = :fr_siren
104
137
  FR_VAT = :fr_vat
105
138
  GB_NINO = :gb_nino
106
139
  GB_UTR = :gb_utr
107
140
  GB_VAT = :gb_vat
141
+ GD_TIN = :gd_tin
142
+ GE_IC = :ge_ic
143
+ GE_PN = :ge_pn
144
+ GE_TIN = :ge_tin
108
145
  GENERIC_INTERNATIONAL = :generic_international
146
+ GG_SIN = :gg_sin
147
+ GH_PIN = :gh_pin
148
+ GH_TIN = :gh_tin
149
+ GI_TRN = :gi_trn
150
+ GL_CPR = :gl_cpr
151
+ GL_GER = :gl_ger
152
+ GM_TIN = :gm_tin
109
153
  GR_VAT = :gr_vat
154
+ GT_NIT = :gt_nit
110
155
  HK_BRN = :hk_brn
111
156
  HK_HKID = :hk_hkid
112
157
  HN_ID = :hn_id
@@ -114,29 +159,64 @@ module ModernTreasury
114
159
  HR_OIB = :hr_oib
115
160
  HU_ADJ = :hu_adj
116
161
  HU_ANUM = :hu_anum
162
+ ID_NIK = :id_nik
163
+ ID_NPWP = :id_npwp
117
164
  IE_PPS = :ie_pps
118
165
  IE_TRN = :ie_trn
166
+ IL_CN = :il_cn
167
+ IL_PIN = :il_pin
168
+ IM_TRN = :im_trn
119
169
  IN_LEI = :in_lei
120
170
  IS_KNT = :is_knt
121
171
  IT_CF = :it_cf
122
172
  IT_PIVA = :it_piva
173
+ JE_SSN = :je_ssn
174
+ JE_TIN = :je_tin
175
+ JM_TRN = :jm_trn
176
+ JO_TIN = :jo_tin
123
177
  JP_HB = :jp_hb
124
178
  JP_MN = :jp_mn
179
+ KE_PIN = :ke_pin
180
+ KG_PIN = :kg_pin
181
+ KN_TIN = :kn_tin
125
182
  KR_BRN = :kr_brn
126
183
  KR_CRN = :kr_crn
127
184
  KR_RRN = :kr_rrn
185
+ KW_CID = :kw_cid
186
+ KZ_BIN = :kz_bin
187
+ KZ_IIN = :kz_iin
188
+ LA_TIN = :la_tin
189
+ LC_TIN = :lc_tin
128
190
  LI_PEID = :li_peid
191
+ LK_TIN = :lk_tin
192
+ LS_TIN = :ls_tin
129
193
  LT_AK = :lt_ak
130
194
  LT_JAK = :lt_jak
131
195
  LU_MTC = :lu_mtc
132
196
  LU_VAT = :lu_vat
133
197
  LV_PK = :lv_pk
134
198
  LV_RN = :lv_rn
199
+ MD_IDNP = :md_idnp
200
+ ME_JMBG = :me_jmbg
201
+ ME_PIB = :me_pib
202
+ MG_NIF = :mg_nif
203
+ MH_SSN = :mh_ssn
204
+ MO_BIR = :mo_bir
205
+ MO_TIN_B = :mo_tin_b
206
+ MO_TIN_I = :mo_tin_i
207
+ MR_NIF = :mr_nif
135
208
  MT_TIN = :mt_tin
136
209
  MT_VAT = :mt_vat
210
+ MU_TAN = :mu_tan
211
+ MW_TPIN = :mw_tpin
137
212
  MX_CURP = :mx_curp
138
213
  MX_INE = :mx_ine
139
214
  MX_RFC = :mx_rfc
215
+ MY_NPC = :my_npc
216
+ MY_NRIC = :my_nric
217
+ MY_TIN_B = :my_tin_b
218
+ MZ_NUIT = :mz_nuit
219
+ NA_TIN = :na_tin
140
220
  NATIONAL_ID = :national_id
141
221
  NL_BSN = :nl_bsn
142
222
  NL_BTW = :nl_btw
@@ -144,13 +224,24 @@ module ModernTreasury
144
224
  NO_FDN = :no_fdn
145
225
  NO_MVA = :no_mva
146
226
  NO_ORGNR = :no_orgnr
227
+ NR_TIN = :nr_tin
147
228
  NZ_IRD = :nz_ird
229
+ OM_CID = :om_cid
230
+ PA_CEDULA = :pa_cedula
231
+ PA_RUC = :pa_ruc
148
232
  PASSPORT = :passport
233
+ PE_RUC = :pe_ruc
234
+ PG_TIN = :pg_tin
235
+ PH_TIN = :ph_tin
149
236
  PL_NIP = :pl_nip
150
237
  PL_PESEL = :pl_pesel
151
238
  PT_NIF = :pt_nif
239
+ PY_RUC = :py_ruc
240
+ QA_QID = :qa_qid
241
+ QA_TIN = :qa_tin
152
242
  RO_CNP = :ro_cnp
153
243
  RO_CUI = :ro_cui
244
+ RW_TIN = :rw_tin
154
245
  SA_TIN = :sa_tin
155
246
  SA_VAT = :sa_vat
156
247
  SE_ORGNR = :se_orgnr
@@ -162,11 +253,29 @@ module ModernTreasury
162
253
  SI_TIN = :si_tin
163
254
  SK_ICO = :sk_ico
164
255
  SK_RC = :sk_rc
256
+ SL_TIN = :sl_tin
257
+ SM_SSI = :sm_ssi
258
+ SZ_TIN = :sz_tin
259
+ TG_NIF = :tg_nif
260
+ TH_JID = :th_jid
261
+ TH_PIN = :th_pin
262
+ TJ_INN = :tj_inn
263
+ TO_TIN = :to_tin
264
+ TR_TCKN = :tr_tckn
265
+ TT_BIR = :tt_bir
266
+ TW_NRIC = :tw_nric
267
+ TW_UBN = :tw_ubn
268
+ UG_TIN = :ug_tin
165
269
  US_EIN = :us_ein
166
270
  US_ITIN = :us_itin
167
271
  US_SSN = :us_ssn
168
272
  UY_RUT = :uy_rut
273
+ UZ_INN = :uz_inn
274
+ UZ_PIN = :uz_pin
169
275
  VN_TIN = :vn_tin
276
+ ZA_TRN = :za_trn
277
+ ZA_VAT = :za_vat
278
+ ZM_TPIN = :zm_tpin
170
279
 
171
280
  # @!method self.values
172
281
  # @return [Array<Symbol>]
@@ -284,7 +284,9 @@ module ModernTreasury
284
284
  module OriginatingAccountNumberType
285
285
  extend ModernTreasury::Internal::Type::Enum
286
286
 
287
+ ARBITRUM_ADDRESS = :arbitrum_address
287
288
  AU_NUMBER = :au_number
289
+ AVALANCHE_ADDRESS = :avalanche_address
288
290
  BASE_ADDRESS = :base_address
289
291
  CARD_TOKEN = :card_token
290
292
  CLABE = :clabe
@@ -298,7 +300,6 @@ module ModernTreasury
298
300
  POLYGON_ADDRESS = :polygon_address
299
301
  SG_NUMBER = :sg_number
300
302
  SOLANA_ADDRESS = :solana_address
301
- WALLET_ADDRESS = :wallet_address
302
303
 
303
304
  # @!method self.values
304
305
  # @return [Array<Symbol>]
@@ -42,8 +42,8 @@ module ModernTreasury
42
42
  # @!attribute direction
43
43
  # One of `credit`, `debit`.
44
44
  #
45
- # @return [Symbol, ModernTreasury::Models::IncomingPaymentDetailCreateAsyncParams::Direction, nil]
46
- optional :direction, enum: -> { ModernTreasury::IncomingPaymentDetailCreateAsyncParams::Direction }
45
+ # @return [Symbol, ModernTreasury::Models::TransactionDirection, nil]
46
+ optional :direction, enum: -> { ModernTreasury::TransactionDirection }
47
47
 
48
48
  # @!attribute internal_account_id
49
49
  # The ID of one of your internal accounts.
@@ -86,7 +86,7 @@ module ModernTreasury
86
86
  #
87
87
  # @param description [String, nil] Defaults to a random description.
88
88
  #
89
- # @param direction [Symbol, ModernTreasury::Models::IncomingPaymentDetailCreateAsyncParams::Direction] One of `credit`, `debit`.
89
+ # @param direction [Symbol, ModernTreasury::Models::TransactionDirection] One of `credit`, `debit`.
90
90
  #
91
91
  # @param internal_account_id [String] The ID of one of your internal accounts.
92
92
  #
@@ -98,17 +98,6 @@ module ModernTreasury
98
98
  #
99
99
  # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
100
100
 
101
- # One of `credit`, `debit`.
102
- module Direction
103
- extend ModernTreasury::Internal::Type::Enum
104
-
105
- CREDIT = :credit
106
- DEBIT = :debit
107
-
108
- # @!method self.values
109
- # @return [Array<Symbol>]
110
- end
111
-
112
101
  # One of `ach`, `wire`, `check`.
113
102
  module Type
114
103
  extend ModernTreasury::Internal::Type::Enum
@@ -148,6 +148,13 @@ module ModernTreasury
148
148
  # @return [Symbol, ModernTreasury::Models::InternalAccount::Status, nil]
149
149
  required :status, enum: -> { ModernTreasury::InternalAccount::Status }, nil?: true
150
150
 
151
+ # @!attribute title
152
+ # The account title at the financial institution, used in place of the party name.
153
+ # Only applicable to accounts created under supported connections.
154
+ #
155
+ # @return [String, nil]
156
+ required :title, String, nil?: true
157
+
151
158
  # @!attribute updated_at
152
159
  #
153
160
  # @return [Time]
@@ -159,7 +166,7 @@ module ModernTreasury
159
166
  # @return [String, nil]
160
167
  required :vendor_id, String, nil?: true
161
168
 
162
- # @!method initialize(id:, account_capabilities:, account_details:, account_type:, connection:, contra_ledger_account_id:, counterparty_id:, created_at:, currency:, debitable:, external_id:, ledger_account_id:, legal_entity_id:, live_mode:, metadata:, name:, object:, parent_account_id:, party_address:, party_name:, party_type:, routing_details:, status:, updated_at:, vendor_id:)
169
+ # @!method initialize(id:, account_capabilities:, account_details:, account_type:, connection:, contra_ledger_account_id:, counterparty_id:, created_at:, currency:, debitable:, external_id:, ledger_account_id:, legal_entity_id:, live_mode:, metadata:, name:, object:, parent_account_id:, party_address:, party_name:, party_type:, routing_details:, status:, title:, updated_at:, vendor_id:)
163
170
  # Some parameter documentations has been truncated, see
164
171
  # {ModernTreasury::Models::InternalAccount} for more details.
165
172
  #
@@ -209,6 +216,8 @@ module ModernTreasury
209
216
  #
210
217
  # @param status [Symbol, ModernTreasury::Models::InternalAccount::Status, nil] The internal account status.
211
218
  #
219
+ # @param title [String, nil] The account title at the financial institution, used in place of the party name.
220
+ #
212
221
  # @param updated_at [Time]
213
222
  #
214
223
  # @param vendor_id [String, nil] The vendor ID associated with this account.
@@ -101,6 +101,14 @@ module ModernTreasury
101
101
  optional :requested_account_number_types,
102
102
  -> { ModernTreasury::Internal::Type::ArrayOf[enum: ModernTreasury::InternalAccountCreateParams::RequestedAccountNumberType] }
103
103
 
104
+ # @!attribute title
105
+ # The account title at the financial institution, used in place of the party name.
106
+ # Only applicable to accounts created under supported connections. Please reach
107
+ # out to your customer success manager to enable this capability for your program.
108
+ #
109
+ # @return [String, nil]
110
+ optional :title, String, nil?: true
111
+
104
112
  # @!attribute vendor_attributes
105
113
  # A hash of vendor specific attributes that will be used when creating the account
106
114
  # at the vendor specified by the given connection.
@@ -108,7 +116,7 @@ module ModernTreasury
108
116
  # @return [Hash{Symbol=>String}, nil]
109
117
  optional :vendor_attributes, ModernTreasury::Internal::Type::HashOf[String]
110
118
 
111
- # @!method initialize(currency:, name:, account_capabilities: nil, account_type: nil, connection_id: nil, counterparty_id: nil, debitable: nil, external_id: nil, legal_entity_id: nil, metadata: nil, parent_account_id: nil, party_address: nil, party_name: nil, requested_account_number_types: nil, vendor_attributes: nil, request_options: {})
119
+ # @!method initialize(currency:, name:, account_capabilities: nil, account_type: nil, connection_id: nil, counterparty_id: nil, debitable: nil, external_id: nil, legal_entity_id: nil, metadata: nil, parent_account_id: nil, party_address: nil, party_name: nil, requested_account_number_types: nil, title: nil, vendor_attributes: nil, request_options: {})
112
120
  # Some parameter documentations has been truncated, see
113
121
  # {ModernTreasury::Models::InternalAccountCreateParams} for more details.
114
122
  #
@@ -140,6 +148,8 @@ module ModernTreasury
140
148
  #
141
149
  # @param requested_account_number_types [Array<Symbol, ModernTreasury::Models::InternalAccountCreateParams::RequestedAccountNumberType>] An array of account number types requested for provisioning.
142
150
  #
151
+ # @param title [String, nil] The account title at the financial institution, used in place of the party name.
152
+ #
143
153
  # @param vendor_attributes [Hash{Symbol=>String}] A hash of vendor specific attributes that will be used when creating the account
144
154
  #
145
155
  # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
@@ -358,6 +368,8 @@ module ModernTreasury
358
368
  module RequestedAccountNumberType
359
369
  extend ModernTreasury::Internal::Type::Enum
360
370
 
371
+ ARBITRUM_ADDRESS = :arbitrum_address
372
+ AVALANCHE_ADDRESS = :avalanche_address
361
373
  BASE_ADDRESS = :base_address
362
374
  ETHEREUM_ADDRESS = :ethereum_address
363
375
  POLYGON_ADDRESS = :polygon_address
@@ -206,7 +206,6 @@ module ModernTreasury
206
206
  module LedgerableType
207
207
  extend ModernTreasury::Internal::Type::Enum
208
208
 
209
- COUNTERPARTY = :counterparty
210
209
  EXTERNAL_ACCOUNT = :external_account
211
210
  INTERNAL_ACCOUNT = :internal_account
212
211
  VIRTUAL_ACCOUNT = :virtual_account
@@ -108,7 +108,6 @@ module ModernTreasury
108
108
  module LedgerableType
109
109
  extend ModernTreasury::Internal::Type::Enum
110
110
 
111
- COUNTERPARTY = :counterparty
112
111
  EXTERNAL_ACCOUNT = :external_account
113
112
  INTERNAL_ACCOUNT = :internal_account
114
113
  VIRTUAL_ACCOUNT = :virtual_account
@@ -217,7 +217,7 @@ module ModernTreasury
217
217
  required :prefix, String, nil?: true
218
218
 
219
219
  # @!attribute primary_social_media_sites
220
- # A list of primary social media URLs for the business.
220
+ # A list of the entity's primary social media URLs.
221
221
  #
222
222
  # @return [Array<String>]
223
223
  required :primary_social_media_sites, ModernTreasury::Internal::Type::ArrayOf[String]
@@ -243,8 +243,8 @@ module ModernTreasury
243
243
  required :service_provider_legal_entity_id, String, nil?: true
244
244
 
245
245
  # @!attribute status
246
- # The activation status of the legal entity. One of pending, active, suspended, or
247
- # denied.
246
+ # The activation status of the legal entity. One of draft, pending, active,
247
+ # suspended, or denied.
248
248
  #
249
249
  # @return [Symbol, ModernTreasury::Models::LegalEntity::Status, nil]
250
250
  required :status, enum: -> { ModernTreasury::LegalEntity::Status }, nil?: true
@@ -382,7 +382,7 @@ module ModernTreasury
382
382
  #
383
383
  # @param prefix [String, nil] An individual's prefix.
384
384
  #
385
- # @param primary_social_media_sites [Array<String>] A list of primary social media URLs for the business.
385
+ # @param primary_social_media_sites [Array<String>] A list of the entity's primary social media URLs.
386
386
  #
387
387
  # @param regulators [Array<ModernTreasury::Models::LegalEntity::Regulator>, nil] Array of regulatory bodies overseeing this institution.
388
388
  #
@@ -390,7 +390,7 @@ module ModernTreasury
390
390
  #
391
391
  # @param service_provider_legal_entity_id [String, nil] The UUID of the parent legal entity in the service provider tree.
392
392
  #
393
- # @param status [Symbol, ModernTreasury::Models::LegalEntity::Status, nil] The activation status of the legal entity. One of pending, active, suspended, or
393
+ # @param status [Symbol, ModernTreasury::Models::LegalEntity::Status, nil] The activation status of the legal entity. One of draft, pending, active, suspen
394
394
  #
395
395
  # @param suffix [String, nil] An individual's suffix.
396
396
  #
@@ -647,8 +647,8 @@ module ModernTreasury
647
647
  # @return [Array<Symbol>]
648
648
  end
649
649
 
650
- # The activation status of the legal entity. One of pending, active, suspended, or
651
- # denied.
650
+ # The activation status of the legal entity. One of draft, pending, active,
651
+ # suspended, or denied.
652
652
  #
653
653
  # @see ModernTreasury::Models::LegalEntity#status
654
654
  module Status
@@ -656,6 +656,7 @@ module ModernTreasury
656
656
 
657
657
  ACTIVE = :active
658
658
  DENIED = :denied
659
+ DRAFT = :draft
659
660
  PENDING = :pending
660
661
  SUSPENDED = :suspended
661
662
 
@@ -21,19 +21,6 @@ module ModernTreasury
21
21
  # @return [String, nil]
22
22
  required :locality, String, nil?: true
23
23
 
24
- # @!attribute postal_code
25
- # The postal code of the address.
26
- #
27
- # @return [String, nil]
28
- required :postal_code, String, nil?: true
29
-
30
- # @!attribute region
31
- # Region or State. This field is free-form; for US states, we recommend a
32
- # two-letter code (e.g. CA). Full state names are also accepted.
33
- #
34
- # @return [String, nil]
35
- required :region, String, nil?: true
36
-
37
24
  # @!attribute address_types
38
25
  # The types of this address.
39
26
  #
@@ -46,6 +33,12 @@ module ModernTreasury
46
33
  # @return [String, nil]
47
34
  optional :line2, String, nil?: true
48
35
 
36
+ # @!attribute postal_code
37
+ # The postal code of the address.
38
+ #
39
+ # @return [String, nil]
40
+ optional :postal_code, String, nil?: true
41
+
49
42
  # @!attribute primary
50
43
  # Whether this address is the primary address for the legal entity. Optional; when
51
44
  # omitted it is inferred from the address types.
@@ -53,7 +46,14 @@ module ModernTreasury
53
46
  # @return [Boolean, nil]
54
47
  optional :primary, ModernTreasury::Internal::Type::Boolean, nil?: true
55
48
 
56
- # @!method initialize(country:, line1:, locality:, postal_code:, region:, address_types: nil, line2: nil, primary: nil)
49
+ # @!attribute region
50
+ # Region or State. This field is free-form; for US states, we recommend a
51
+ # two-letter code (e.g. CA). Full state names are also accepted.
52
+ #
53
+ # @return [String, nil]
54
+ optional :region, String, nil?: true
55
+
56
+ # @!method initialize(country:, line1:, locality:, address_types: nil, line2: nil, postal_code: nil, primary: nil, region: nil)
57
57
  # Some parameter documentations has been truncated, see
58
58
  # {ModernTreasury::Models::LegalEntityAddressCreateRequest} for more details.
59
59
  #
@@ -63,15 +63,15 @@ module ModernTreasury
63
63
  #
64
64
  # @param locality [String, nil] Locality or City. Use the full city name rather than an abbreviation (e.g. San F
65
65
  #
66
- # @param postal_code [String, nil] The postal code of the address.
67
- #
68
- # @param region [String, nil] Region or State. This field is free-form; for US states, we recommend a two-lett
69
- #
70
66
  # @param address_types [Array<Symbol, ModernTreasury::Models::LegalEntityAddressCreateRequest::AddressType>] The types of this address.
71
67
  #
72
68
  # @param line2 [String, nil]
73
69
  #
70
+ # @param postal_code [String, nil] The postal code of the address.
71
+ #
74
72
  # @param primary [Boolean, nil] Whether this address is the primary address for the legal entity. Optional; when
73
+ #
74
+ # @param region [String, nil] Region or State. This field is free-form; for US states, we recommend a two-lett
75
75
 
76
76
  module AddressType
77
77
  extend ModernTreasury::Internal::Type::Enum
@@ -218,7 +218,7 @@ module ModernTreasury
218
218
  optional :prefix, String, nil?: true
219
219
 
220
220
  # @!attribute primary_social_media_sites
221
- # A list of primary social media URLs for the business.
221
+ # A list of the entity's primary social media URLs.
222
222
  #
223
223
  # @return [Array<String>, nil]
224
224
  optional :primary_social_media_sites, ModernTreasury::Internal::Type::ArrayOf[String]
@@ -245,6 +245,13 @@ module ModernTreasury
245
245
  # @return [String, nil]
246
246
  optional :service_provider_legal_entity_id, String, nil?: true
247
247
 
248
+ # @!attribute status
249
+ # Set to draft to create the legal entity as a draft. Omit to create it as
250
+ # pending. Inline child legal entities take the parent's status.
251
+ #
252
+ # @return [Symbol, ModernTreasury::Models::LegalEntityCreateParams::Status, nil]
253
+ optional :status, enum: -> { ModernTreasury::LegalEntityCreateParams::Status }
254
+
248
255
  # @!attribute suffix
249
256
  # An individual's suffix.
250
257
  #
@@ -291,7 +298,7 @@ module ModernTreasury
291
298
  # @return [String, nil]
292
299
  optional :website, String, nil?: true
293
300
 
294
- # @!method initialize(legal_entity_type:, addresses: nil, bank_settings: nil, business_description: nil, business_designation: nil, business_name: nil, citizenship_country: nil, compliance_details: nil, connection_id: nil, country_of_incorporation: nil, date_formed: nil, date_of_birth: nil, documents: nil, doing_business_as_names: nil, email: nil, expected_activity_volume: nil, external_id: nil, first_name: nil, identifications: nil, industry_classifications: nil, intended_use: nil, last_name: nil, legal_entity_associations: nil, legal_structure: nil, listed_exchange: nil, metadata: nil, middle_name: nil, operating_jurisdictions: nil, phone_numbers: nil, politically_exposed_person: nil, preferred_name: nil, prefix: nil, primary_social_media_sites: nil, regulators: nil, risk_rating: nil, service_provider_legal_entity_id: nil, suffix: nil, terms_of_use: nil, third_party_verification: nil, third_party_verifications: nil, ticker_symbol: nil, wealth_and_employment_details: nil, website: nil, request_options: {})
301
+ # @!method initialize(legal_entity_type:, addresses: nil, bank_settings: nil, business_description: nil, business_designation: nil, business_name: nil, citizenship_country: nil, compliance_details: nil, connection_id: nil, country_of_incorporation: nil, date_formed: nil, date_of_birth: nil, documents: nil, doing_business_as_names: nil, email: nil, expected_activity_volume: nil, external_id: nil, first_name: nil, identifications: nil, industry_classifications: nil, intended_use: nil, last_name: nil, legal_entity_associations: nil, legal_structure: nil, listed_exchange: nil, metadata: nil, middle_name: nil, operating_jurisdictions: nil, phone_numbers: nil, politically_exposed_person: nil, preferred_name: nil, prefix: nil, primary_social_media_sites: nil, regulators: nil, risk_rating: nil, service_provider_legal_entity_id: nil, status: nil, suffix: nil, terms_of_use: nil, third_party_verification: nil, third_party_verifications: nil, ticker_symbol: nil, wealth_and_employment_details: nil, website: nil, request_options: {})
295
302
  # Some parameter documentations has been truncated, see
296
303
  # {ModernTreasury::Models::LegalEntityCreateParams} for more details.
297
304
  #
@@ -359,7 +366,7 @@ module ModernTreasury
359
366
  #
360
367
  # @param prefix [String, nil] An individual's prefix.
361
368
  #
362
- # @param primary_social_media_sites [Array<String>] A list of primary social media URLs for the business.
369
+ # @param primary_social_media_sites [Array<String>] A list of the entity's primary social media URLs.
363
370
  #
364
371
  # @param regulators [Array<ModernTreasury::Models::LegalEntityCreateParams::Regulator>, nil] Array of regulatory bodies overseeing this institution.
365
372
  #
@@ -367,6 +374,8 @@ module ModernTreasury
367
374
  #
368
375
  # @param service_provider_legal_entity_id [String, nil] The UUID of the parent legal entity in the service provider tree.
369
376
  #
377
+ # @param status [Symbol, ModernTreasury::Models::LegalEntityCreateParams::Status] Set to draft to create the legal entity as a draft. Omit to create it as pending
378
+ #
370
379
  # @param suffix [String, nil] An individual's suffix.
371
380
  #
372
381
  # @param terms_of_use [ModernTreasury::Models::LegalEntityCreateParams::TermsOfUse, nil] Acceptance of terms of use by the legal entity.
@@ -526,6 +535,17 @@ module ModernTreasury
526
535
  # @return [Array<Symbol>]
527
536
  end
528
537
 
538
+ # Set to draft to create the legal entity as a draft. Omit to create it as
539
+ # pending. Inline child legal entities take the parent's status.
540
+ module Status
541
+ extend ModernTreasury::Internal::Type::Enum
542
+
543
+ DRAFT = :draft
544
+
545
+ # @!method self.values
546
+ # @return [Array<Symbol>]
547
+ end
548
+
529
549
  class TermsOfUse < ModernTreasury::Internal::Type::BaseModel
530
550
  # @!attribute accepted_at
531
551
  # The ISO 8601 timestamp indicating when the terms of use were accepted.
@@ -80,6 +80,7 @@ module ModernTreasury
80
80
  extend ModernTreasury::Internal::Type::Enum
81
81
 
82
82
  PENDING = :pending
83
+ DRAFT = :draft
83
84
  ACTIVE = :active
84
85
  SUSPENDED = :suspended
85
86
  DENIED = :denied
@@ -183,7 +183,7 @@ module ModernTreasury
183
183
  optional :prefix, String, nil?: true
184
184
 
185
185
  # @!attribute primary_social_media_sites
186
- # A list of primary social media URLs for the business.
186
+ # A list of the entity's primary social media URLs.
187
187
  #
188
188
  # @return [Array<String>, nil]
189
189
  optional :primary_social_media_sites, ModernTreasury::Internal::Type::ArrayOf[String]
@@ -210,6 +210,14 @@ module ModernTreasury
210
210
  # @return [String, nil]
211
211
  optional :service_provider_legal_entity_id, String, nil?: true
212
212
 
213
+ # @!attribute status
214
+ # Set to pending to submit a draft legal entity for processing. Only valid while
215
+ # the legal entity is draft, and must be the only attribute in the request. Draft
216
+ # child legal entities are submitted with it.
217
+ #
218
+ # @return [Symbol, ModernTreasury::Models::LegalEntityUpdateParams::Status, nil]
219
+ optional :status, enum: -> { ModernTreasury::LegalEntityUpdateParams::Status }
220
+
213
221
  # @!attribute suffix
214
222
  # An individual's suffix.
215
223
  #
@@ -256,7 +264,7 @@ module ModernTreasury
256
264
  # @return [String, nil]
257
265
  optional :website, String, nil?: true
258
266
 
259
- # @!method initialize(id:, addresses: nil, bank_settings: nil, business_description: nil, business_designation: nil, business_name: nil, citizenship_country: nil, country_of_incorporation: nil, date_formed: nil, date_of_birth: nil, doing_business_as_names: nil, email: nil, expected_activity_volume: nil, external_id: nil, first_name: nil, identifications: nil, industry_classifications: nil, intended_use: nil, last_name: nil, legal_structure: nil, listed_exchange: nil, metadata: nil, middle_name: nil, operating_jurisdictions: nil, phone_numbers: nil, politically_exposed_person: nil, preferred_name: nil, prefix: nil, primary_social_media_sites: nil, regulators: nil, risk_rating: nil, service_provider_legal_entity_id: nil, suffix: nil, terms_of_use: nil, third_party_verification: nil, third_party_verifications: nil, ticker_symbol: nil, wealth_and_employment_details: nil, website: nil, request_options: {})
267
+ # @!method initialize(id:, addresses: nil, bank_settings: nil, business_description: nil, business_designation: nil, business_name: nil, citizenship_country: nil, country_of_incorporation: nil, date_formed: nil, date_of_birth: nil, doing_business_as_names: nil, email: nil, expected_activity_volume: nil, external_id: nil, first_name: nil, identifications: nil, industry_classifications: nil, intended_use: nil, last_name: nil, legal_structure: nil, listed_exchange: nil, metadata: nil, middle_name: nil, operating_jurisdictions: nil, phone_numbers: nil, politically_exposed_person: nil, preferred_name: nil, prefix: nil, primary_social_media_sites: nil, regulators: nil, risk_rating: nil, service_provider_legal_entity_id: nil, status: nil, suffix: nil, terms_of_use: nil, third_party_verification: nil, third_party_verifications: nil, ticker_symbol: nil, wealth_and_employment_details: nil, website: nil, request_options: {})
260
268
  # Some parameter documentations has been truncated, see
261
269
  # {ModernTreasury::Models::LegalEntityUpdateParams} for more details.
262
270
  #
@@ -316,7 +324,7 @@ module ModernTreasury
316
324
  #
317
325
  # @param prefix [String, nil] An individual's prefix.
318
326
  #
319
- # @param primary_social_media_sites [Array<String>] A list of primary social media URLs for the business.
327
+ # @param primary_social_media_sites [Array<String>] A list of the entity's primary social media URLs.
320
328
  #
321
329
  # @param regulators [Array<ModernTreasury::Models::LegalEntityUpdateParams::Regulator>, nil] Array of regulatory bodies overseeing this institution.
322
330
  #
@@ -324,6 +332,8 @@ module ModernTreasury
324
332
  #
325
333
  # @param service_provider_legal_entity_id [String, nil] The UUID of the parent legal entity in the service provider tree.
326
334
  #
335
+ # @param status [Symbol, ModernTreasury::Models::LegalEntityUpdateParams::Status] Set to pending to submit a draft legal entity for processing. Only valid while t
336
+ #
327
337
  # @param suffix [String, nil] An individual's suffix.
328
338
  #
329
339
  # @param terms_of_use [ModernTreasury::Models::LegalEntityUpdateParams::TermsOfUse, nil] Acceptance of terms of use by the legal entity.
@@ -427,6 +437,18 @@ module ModernTreasury
427
437
  # @return [Array<Symbol>]
428
438
  end
429
439
 
440
+ # Set to pending to submit a draft legal entity for processing. Only valid while
441
+ # the legal entity is draft, and must be the only attribute in the request. Draft
442
+ # child legal entities are submitted with it.
443
+ module Status
444
+ extend ModernTreasury::Internal::Type::Enum
445
+
446
+ PENDING = :pending
447
+
448
+ # @!method self.values
449
+ # @return [Array<Symbol>]
450
+ end
451
+
430
452
  class TermsOfUse < ModernTreasury::Internal::Type::BaseModel
431
453
  # @!attribute accepted_at
432
454
  # The ISO 8601 timestamp indicating when the terms of use were accepted.