modern_treasury 0.11.0 → 0.12.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (116) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +31 -0
  3. data/README.md +10 -1
  4. data/lib/modern_treasury/internal/transport/pooled_net_requester.rb +12 -10
  5. data/lib/modern_treasury/internal/util.rb +7 -2
  6. data/lib/modern_treasury/models/bulk_request_create_params.rb +146 -2
  7. data/lib/modern_treasury/models/child_legal_entity.rb +609 -0
  8. data/lib/modern_treasury/models/child_legal_entity_create.rb +63 -1
  9. data/lib/modern_treasury/models/connection_legal_entity.rb +2 -0
  10. data/lib/modern_treasury/models/connection_legal_entity_create_params.rb +54 -63
  11. data/lib/modern_treasury/models/connection_legal_entity_list_params.rb +2 -0
  12. data/lib/modern_treasury/models/counterparty_create_params.rb +54 -59
  13. data/lib/modern_treasury/models/expected_payment.rb +69 -1
  14. data/lib/modern_treasury/models/expected_payment_create_params.rb +65 -1
  15. data/lib/modern_treasury/models/expected_payment_update_params.rb +65 -1
  16. data/lib/modern_treasury/models/incoming_payment_detail.rb +5 -0
  17. data/lib/modern_treasury/models/incoming_payment_detail_create_async_params.rb +5 -0
  18. data/lib/modern_treasury/models/incoming_payment_detail_list_params.rb +5 -0
  19. data/lib/modern_treasury/models/internal_account.rb +10 -1
  20. data/lib/modern_treasury/models/internal_account_update_params.rb +9 -1
  21. data/lib/modern_treasury/models/invoice.rb +2 -0
  22. data/lib/modern_treasury/models/invoice_create_params.rb +1 -19
  23. data/lib/modern_treasury/models/invoice_update_params.rb +1 -19
  24. data/lib/modern_treasury/models/ledger_entry.rb +10 -1
  25. data/lib/modern_treasury/models/ledger_entry_create_request.rb +10 -1
  26. data/lib/modern_treasury/models/ledger_transactions/ledger_transaction_version.rb +10 -1
  27. data/lib/modern_treasury/models/legal_entity.rb +61 -11
  28. data/lib/modern_treasury/models/legal_entity_association.rb +3 -559
  29. data/lib/modern_treasury/models/legal_entity_association_inline_create.rb +60 -0
  30. data/lib/modern_treasury/models/legal_entity_create_params.rb +54 -59
  31. data/lib/modern_treasury/models/legal_entity_update_params.rb +51 -1
  32. data/lib/modern_treasury/models/payment_order.rb +4 -0
  33. data/lib/modern_treasury/models/payment_reference.rb +4 -0
  34. data/lib/modern_treasury/models/return_object.rb +5 -0
  35. data/lib/modern_treasury/models/transaction.rb +1 -0
  36. data/lib/modern_treasury/models.rb +4 -0
  37. data/lib/modern_treasury/resources/expected_payments.rb +18 -2
  38. data/lib/modern_treasury/resources/internal_accounts.rb +3 -1
  39. data/lib/modern_treasury/resources/invoices.rb +2 -10
  40. data/lib/modern_treasury/resources/ledger_accounts.rb +3 -3
  41. data/lib/modern_treasury/resources/ledger_transactions.rb +5 -2
  42. data/lib/modern_treasury/resources/legal_entities.rb +27 -3
  43. data/lib/modern_treasury/version.rb +1 -1
  44. data/lib/modern_treasury.rb +3 -0
  45. data/manifest.yaml +1 -0
  46. data/rbi/modern_treasury/models/bulk_request_create_params.rbi +272 -0
  47. data/rbi/modern_treasury/models/child_legal_entity.rbi +969 -0
  48. data/rbi/modern_treasury/models/child_legal_entity_create.rbi +78 -0
  49. data/rbi/modern_treasury/models/connection_legal_entity.rbi +10 -0
  50. data/rbi/modern_treasury/models/connection_legal_entity_create_params.rbi +61 -135
  51. data/rbi/modern_treasury/models/connection_legal_entity_list_params.rbi +10 -0
  52. data/rbi/modern_treasury/models/counterparty_create_params.rbi +61 -135
  53. data/rbi/modern_treasury/models/expected_payment.rbi +136 -0
  54. data/rbi/modern_treasury/models/expected_payment_create_params.rbi +136 -0
  55. data/rbi/modern_treasury/models/expected_payment_update_params.rbi +136 -0
  56. data/rbi/modern_treasury/models/incoming_payment_detail.rbi +25 -0
  57. data/rbi/modern_treasury/models/incoming_payment_detail_create_async_params.rbi +25 -0
  58. data/rbi/modern_treasury/models/incoming_payment_detail_list_params.rbi +25 -0
  59. data/rbi/modern_treasury/models/internal_account.rbi +10 -0
  60. data/rbi/modern_treasury/models/internal_account_update_params.rbi +11 -0
  61. data/rbi/modern_treasury/models/invoice_create_params.rbi +0 -20
  62. data/rbi/modern_treasury/models/invoice_update_params.rbi +0 -20
  63. data/rbi/modern_treasury/models/ledger_entry.rbi +10 -0
  64. data/rbi/modern_treasury/models/ledger_entry_create_request.rbi +13 -0
  65. data/rbi/modern_treasury/models/ledger_transactions/ledger_transaction_version.rbi +10 -0
  66. data/rbi/modern_treasury/models/legal_entity.rbi +67 -15
  67. data/rbi/modern_treasury/models/legal_entity_association.rbi +4 -962
  68. data/rbi/modern_treasury/models/legal_entity_association_inline_create.rbi +130 -0
  69. data/rbi/modern_treasury/models/legal_entity_create_params.rbi +61 -134
  70. data/rbi/modern_treasury/models/legal_entity_update_params.rbi +58 -0
  71. data/rbi/modern_treasury/models/payment_order.rbi +20 -0
  72. data/rbi/modern_treasury/models/payment_reference.rbi +20 -0
  73. data/rbi/modern_treasury/models/return_object.rbi +22 -0
  74. data/rbi/modern_treasury/models/transaction.rbi +5 -0
  75. data/rbi/modern_treasury/models.rbi +5 -0
  76. data/rbi/modern_treasury/resources/expected_payments.rbi +44 -0
  77. data/rbi/modern_treasury/resources/internal_accounts.rbi +3 -0
  78. data/rbi/modern_treasury/resources/invoices.rbi +0 -16
  79. data/rbi/modern_treasury/resources/ledger_accounts.rbi +3 -3
  80. data/rbi/modern_treasury/resources/ledger_transactions.rbi +3 -2
  81. data/rbi/modern_treasury/resources/legal_entities.rbi +41 -1
  82. data/sig/modern_treasury/models/bulk_request_create_params.rbs +84 -0
  83. data/sig/modern_treasury/models/child_legal_entity.rbs +469 -0
  84. data/sig/modern_treasury/models/child_legal_entity_create.rbs +39 -0
  85. data/sig/modern_treasury/models/connection_legal_entity.rbs +4 -1
  86. data/sig/modern_treasury/models/connection_legal_entity_create_params.rbs +38 -60
  87. data/sig/modern_treasury/models/connection_legal_entity_list_params.rbs +4 -1
  88. data/sig/modern_treasury/models/counterparty_create_params.rbs +38 -60
  89. data/sig/modern_treasury/models/expected_payment.rbs +42 -0
  90. data/sig/modern_treasury/models/expected_payment_create_params.rbs +42 -0
  91. data/sig/modern_treasury/models/expected_payment_update_params.rbs +42 -0
  92. data/sig/modern_treasury/models/incoming_payment_detail.rbs +10 -0
  93. data/sig/modern_treasury/models/incoming_payment_detail_create_async_params.rbs +10 -0
  94. data/sig/modern_treasury/models/incoming_payment_detail_list_params.rbs +10 -0
  95. data/sig/modern_treasury/models/internal_account.rbs +5 -0
  96. data/sig/modern_treasury/models/internal_account_update_params.rbs +7 -0
  97. data/sig/modern_treasury/models/invoice_create_params.rbs +0 -10
  98. data/sig/modern_treasury/models/invoice_update_params.rbs +0 -10
  99. data/sig/modern_treasury/models/ledger_entry.rbs +5 -0
  100. data/sig/modern_treasury/models/ledger_entry_create_request.rbs +7 -0
  101. data/sig/modern_treasury/models/ledger_transactions/ledger_transaction_version.rbs +5 -0
  102. data/sig/modern_treasury/models/legal_entity.rbs +38 -8
  103. data/sig/modern_treasury/models/legal_entity_association.rbs +4 -435
  104. data/sig/modern_treasury/models/legal_entity_association_inline_create.rbs +59 -0
  105. data/sig/modern_treasury/models/legal_entity_create_params.rbs +38 -60
  106. data/sig/modern_treasury/models/legal_entity_update_params.rbs +34 -0
  107. data/sig/modern_treasury/models/payment_order.rbs +8 -0
  108. data/sig/modern_treasury/models/payment_reference.rbs +8 -0
  109. data/sig/modern_treasury/models/return_object.rbs +10 -0
  110. data/sig/modern_treasury/models/transaction.rbs +2 -0
  111. data/sig/modern_treasury/models.rbs +4 -0
  112. data/sig/modern_treasury/resources/expected_payments.rbs +8 -0
  113. data/sig/modern_treasury/resources/internal_accounts.rbs +1 -0
  114. data/sig/modern_treasury/resources/invoices.rbs +0 -4
  115. data/sig/modern_treasury/resources/legal_entities.rbs +13 -1
  116. metadata +8 -2
@@ -15,6 +15,12 @@ module ModernTreasury
15
15
  # @return [ModernTreasury::Models::LegalEntityBankSettings, nil]
16
16
  optional :bank_settings, -> { ModernTreasury::LegalEntityBankSettings }, nil?: true
17
17
 
18
+ # @!attribute business_description
19
+ # A description of the business.
20
+ #
21
+ # @return [String, nil]
22
+ optional :business_description, String, nil?: true
23
+
18
24
  # @!attribute business_name
19
25
  # The business's legal business name.
20
26
  #
@@ -32,6 +38,13 @@ module ModernTreasury
32
38
  # @return [ModernTreasury::Models::LegalEntityComplianceDetail, nil]
33
39
  optional :compliance_details, -> { ModernTreasury::LegalEntityComplianceDetail }, nil?: true
34
40
 
41
+ # @!attribute country_of_incorporation
42
+ # The country code where the business is incorporated in the ISO 3166-1 alpha-2 or
43
+ # alpha-3 formats.
44
+ #
45
+ # @return [String, nil]
46
+ optional :country_of_incorporation, String, nil?: true
47
+
35
48
  # @!attribute date_formed
36
49
  # A business's formation date (YYYY-MM-DD).
37
50
  #
@@ -55,6 +68,12 @@ module ModernTreasury
55
68
  # @return [String, nil]
56
69
  optional :email, String, nil?: true
57
70
 
71
+ # @!attribute expected_activity_volume
72
+ # Monthly expected transaction volume in entity's local currency.
73
+ #
74
+ # @return [Integer, nil]
75
+ optional :expected_activity_volume, Integer, nil?: true
76
+
58
77
  # @!attribute first_name
59
78
  # An individual's first name.
60
79
  #
@@ -75,12 +94,28 @@ module ModernTreasury
75
94
  optional :industry_classifications,
76
95
  -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::LegalEntityIndustryClassification] }
77
96
 
97
+ # @!attribute intended_use
98
+ # A description of the intended use of the legal entity.
99
+ #
100
+ # @return [String, nil]
101
+ optional :intended_use, String, nil?: true
102
+
78
103
  # @!attribute last_name
79
104
  # An individual's last name.
80
105
  #
81
106
  # @return [String, nil]
82
107
  optional :last_name, String, nil?: true
83
108
 
109
+ # @!attribute legal_entity_associations
110
+ # The legal entity associations and its child legal entities.
111
+ #
112
+ # @return [Array<ModernTreasury::Models::LegalEntityAssociationInlineCreate>, nil]
113
+ optional :legal_entity_associations,
114
+ -> {
115
+ ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::LegalEntityAssociationInlineCreate]
116
+ },
117
+ nil?: true
118
+
84
119
  # @!attribute legal_entity_type
85
120
  # The type of legal entity.
86
121
  #
@@ -110,6 +145,13 @@ module ModernTreasury
110
145
  # @return [String, nil]
111
146
  optional :middle_name, String, nil?: true
112
147
 
148
+ # @!attribute operating_jurisdictions
149
+ # A list of countries where the business operates (ISO 3166-1 alpha-2 or alpha-3
150
+ # codes).
151
+ #
152
+ # @return [Array<String>, nil]
153
+ optional :operating_jurisdictions, ModernTreasury::Internal::Type::ArrayOf[String]
154
+
113
155
  # @!attribute phone_numbers
114
156
  #
115
157
  # @return [Array<ModernTreasury::Models::ChildLegalEntityCreate::PhoneNumber>, nil]
@@ -134,6 +176,12 @@ module ModernTreasury
134
176
  # @return [String, nil]
135
177
  optional :prefix, String, nil?: true
136
178
 
179
+ # @!attribute primary_social_media_sites
180
+ # A list of primary social media URLs for the business.
181
+ #
182
+ # @return [Array<String>, nil]
183
+ optional :primary_social_media_sites, ModernTreasury::Internal::Type::ArrayOf[String]
184
+
137
185
  # @!attribute risk_rating
138
186
  # The risk rating of the legal entity. One of low, medium, high.
139
187
  #
@@ -159,7 +207,7 @@ module ModernTreasury
159
207
  # @return [String, nil]
160
208
  optional :website, String, nil?: true
161
209
 
162
- # @!method initialize(addresses: nil, bank_settings: nil, business_name: nil, citizenship_country: nil, compliance_details: nil, date_formed: nil, date_of_birth: nil, doing_business_as_names: nil, email: nil, first_name: nil, identifications: nil, industry_classifications: nil, last_name: nil, legal_entity_type: nil, legal_structure: nil, metadata: nil, middle_name: nil, phone_numbers: nil, politically_exposed_person: nil, preferred_name: nil, prefix: nil, risk_rating: nil, suffix: nil, wealth_and_employment_details: nil, website: nil)
210
+ # @!method initialize(addresses: nil, bank_settings: nil, business_description: nil, business_name: nil, citizenship_country: nil, compliance_details: nil, country_of_incorporation: nil, date_formed: nil, date_of_birth: nil, doing_business_as_names: nil, email: nil, expected_activity_volume: nil, first_name: nil, identifications: nil, industry_classifications: nil, intended_use: nil, last_name: nil, legal_entity_associations: nil, legal_entity_type: nil, legal_structure: 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, risk_rating: nil, suffix: nil, wealth_and_employment_details: nil, website: nil)
163
211
  # Some parameter documentations has been truncated, see
164
212
  # {ModernTreasury::Models::ChildLegalEntityCreate} for more details.
165
213
  #
@@ -167,12 +215,16 @@ module ModernTreasury
167
215
  #
168
216
  # @param bank_settings [ModernTreasury::Models::LegalEntityBankSettings, nil]
169
217
  #
218
+ # @param business_description [String, nil] A description of the business.
219
+ #
170
220
  # @param business_name [String, nil] The business's legal business name.
171
221
  #
172
222
  # @param citizenship_country [String, nil] The country of citizenship for an individual.
173
223
  #
174
224
  # @param compliance_details [ModernTreasury::Models::LegalEntityComplianceDetail, nil]
175
225
  #
226
+ # @param country_of_incorporation [String, nil] The country code where the business is incorporated in the ISO 3166-1 alpha-2 or
227
+ #
176
228
  # @param date_formed [Date, nil] A business's formation date (YYYY-MM-DD).
177
229
  #
178
230
  # @param date_of_birth [Date, nil] An individual's date of birth (YYYY-MM-DD).
@@ -181,14 +233,20 @@ module ModernTreasury
181
233
  #
182
234
  # @param email [String, nil] The entity's primary email.
183
235
  #
236
+ # @param expected_activity_volume [Integer, nil] Monthly expected transaction volume in entity's local currency.
237
+ #
184
238
  # @param first_name [String, nil] An individual's first name.
185
239
  #
186
240
  # @param identifications [Array<ModernTreasury::Models::IdentificationCreateRequest>] A list of identifications for the legal entity.
187
241
  #
188
242
  # @param industry_classifications [Array<ModernTreasury::Models::LegalEntityIndustryClassification>] A list of industry classifications for the legal entity.
189
243
  #
244
+ # @param intended_use [String, nil] A description of the intended use of the legal entity.
245
+ #
190
246
  # @param last_name [String, nil] An individual's last name.
191
247
  #
248
+ # @param legal_entity_associations [Array<ModernTreasury::Models::LegalEntityAssociationInlineCreate>, nil] The legal entity associations and its child legal entities.
249
+ #
192
250
  # @param legal_entity_type [Symbol, ModernTreasury::Models::ChildLegalEntityCreate::LegalEntityType] The type of legal entity.
193
251
  #
194
252
  # @param legal_structure [Symbol, ModernTreasury::Models::ChildLegalEntityCreate::LegalStructure, nil] The business's legal structure.
@@ -197,6 +255,8 @@ module ModernTreasury
197
255
  #
198
256
  # @param middle_name [String, nil] An individual's middle name.
199
257
  #
258
+ # @param operating_jurisdictions [Array<String>] A list of countries where the business operates (ISO 3166-1 alpha-2 or alpha-3 c
259
+ #
200
260
  # @param phone_numbers [Array<ModernTreasury::Models::ChildLegalEntityCreate::PhoneNumber>]
201
261
  #
202
262
  # @param politically_exposed_person [Boolean, nil] Whether the individual is a politically exposed person.
@@ -205,6 +265,8 @@ module ModernTreasury
205
265
  #
206
266
  # @param prefix [String, nil] An individual's prefix.
207
267
  #
268
+ # @param primary_social_media_sites [Array<String>] A list of primary social media URLs for the business.
269
+ #
208
270
  # @param risk_rating [Symbol, ModernTreasury::Models::ChildLegalEntityCreate::RiskRating, nil] The risk rating of the legal entity. One of low, medium, high.
209
271
  #
210
272
  # @param suffix [String, nil] An individual's suffix.
@@ -90,10 +90,12 @@ module ModernTreasury
90
90
  module Status
91
91
  extend ModernTreasury::Internal::Type::Enum
92
92
 
93
+ CLOSED = :closed
93
94
  COMPLETED = :completed
94
95
  DENIED = :denied
95
96
  FAILED = :failed
96
97
  PROCESSING = :processing
98
+ SUSPENDED = :suspended
97
99
 
98
100
  # @!method self.values
99
101
  # @return [Array<Symbol>]
@@ -47,6 +47,12 @@ module ModernTreasury
47
47
  # @return [ModernTreasury::Models::LegalEntityBankSettings, nil]
48
48
  optional :bank_settings, -> { ModernTreasury::LegalEntityBankSettings }, nil?: true
49
49
 
50
+ # @!attribute business_description
51
+ # A description of the business.
52
+ #
53
+ # @return [String, nil]
54
+ optional :business_description, String, nil?: true
55
+
50
56
  # @!attribute business_name
51
57
  # The business's legal business name.
52
58
  #
@@ -64,6 +70,13 @@ module ModernTreasury
64
70
  # @return [ModernTreasury::Models::LegalEntityComplianceDetail, nil]
65
71
  optional :compliance_details, -> { ModernTreasury::LegalEntityComplianceDetail }, nil?: true
66
72
 
73
+ # @!attribute country_of_incorporation
74
+ # The country code where the business is incorporated in the ISO 3166-1 alpha-2 or
75
+ # alpha-3 formats.
76
+ #
77
+ # @return [String, nil]
78
+ optional :country_of_incorporation, String, nil?: true
79
+
67
80
  # @!attribute date_formed
68
81
  # A business's formation date (YYYY-MM-DD).
69
82
  #
@@ -87,6 +100,12 @@ module ModernTreasury
87
100
  # @return [String, nil]
88
101
  optional :email, String, nil?: true
89
102
 
103
+ # @!attribute expected_activity_volume
104
+ # Monthly expected transaction volume in entity's local currency.
105
+ #
106
+ # @return [Integer, nil]
107
+ optional :expected_activity_volume, Integer, nil?: true
108
+
90
109
  # @!attribute first_name
91
110
  # An individual's first name.
92
111
  #
@@ -107,6 +126,12 @@ module ModernTreasury
107
126
  optional :industry_classifications,
108
127
  -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::LegalEntityIndustryClassification] }
109
128
 
129
+ # @!attribute intended_use
130
+ # A description of the intended use of the legal entity.
131
+ #
132
+ # @return [String, nil]
133
+ optional :intended_use, String, nil?: true
134
+
110
135
  # @!attribute last_name
111
136
  # An individual's last name.
112
137
  #
@@ -116,10 +141,10 @@ module ModernTreasury
116
141
  # @!attribute legal_entity_associations
117
142
  # The legal entity associations and its child legal entities.
118
143
  #
119
- # @return [Array<ModernTreasury::Models::ConnectionLegalEntityCreateParams::LegalEntity::LegalEntityAssociation>, nil]
144
+ # @return [Array<ModernTreasury::Models::LegalEntityAssociationInlineCreate>, nil]
120
145
  optional :legal_entity_associations,
121
146
  -> {
122
- ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::ConnectionLegalEntityCreateParams::LegalEntity::LegalEntityAssociation]
147
+ ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::LegalEntityAssociationInlineCreate]
123
148
  },
124
149
  nil?: true
125
150
 
@@ -151,6 +176,13 @@ module ModernTreasury
151
176
  # @return [String, nil]
152
177
  optional :middle_name, String, nil?: true
153
178
 
179
+ # @!attribute operating_jurisdictions
180
+ # A list of countries where the business operates (ISO 3166-1 alpha-2 or alpha-3
181
+ # codes).
182
+ #
183
+ # @return [Array<String>, nil]
184
+ optional :operating_jurisdictions, ModernTreasury::Internal::Type::ArrayOf[String]
185
+
154
186
  # @!attribute phone_numbers
155
187
  #
156
188
  # @return [Array<ModernTreasury::Models::ConnectionLegalEntityCreateParams::LegalEntity::PhoneNumber>, nil]
@@ -175,6 +207,12 @@ module ModernTreasury
175
207
  # @return [String, nil]
176
208
  optional :prefix, String, nil?: true
177
209
 
210
+ # @!attribute primary_social_media_sites
211
+ # A list of primary social media URLs for the business.
212
+ #
213
+ # @return [Array<String>, nil]
214
+ optional :primary_social_media_sites, ModernTreasury::Internal::Type::ArrayOf[String]
215
+
178
216
  # @!attribute risk_rating
179
217
  # The risk rating of the legal entity. One of low, medium, high.
180
218
  #
@@ -202,7 +240,7 @@ module ModernTreasury
202
240
  # @return [String, nil]
203
241
  optional :website, String, nil?: true
204
242
 
205
- # @!method initialize(addresses: nil, bank_settings: nil, business_name: nil, citizenship_country: nil, compliance_details: nil, date_formed: nil, date_of_birth: nil, doing_business_as_names: nil, email: nil, first_name: nil, identifications: nil, industry_classifications: nil, last_name: nil, legal_entity_associations: nil, legal_entity_type: nil, legal_structure: nil, metadata: nil, middle_name: nil, phone_numbers: nil, politically_exposed_person: nil, preferred_name: nil, prefix: nil, risk_rating: nil, suffix: nil, wealth_and_employment_details: nil, website: nil)
243
+ # @!method initialize(addresses: nil, bank_settings: nil, business_description: nil, business_name: nil, citizenship_country: nil, compliance_details: nil, country_of_incorporation: nil, date_formed: nil, date_of_birth: nil, doing_business_as_names: nil, email: nil, expected_activity_volume: nil, first_name: nil, identifications: nil, industry_classifications: nil, intended_use: nil, last_name: nil, legal_entity_associations: nil, legal_entity_type: nil, legal_structure: 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, risk_rating: nil, suffix: nil, wealth_and_employment_details: nil, website: nil)
206
244
  # Some parameter documentations has been truncated, see
207
245
  # {ModernTreasury::Models::ConnectionLegalEntityCreateParams::LegalEntity} for
208
246
  # more details.
@@ -213,12 +251,16 @@ module ModernTreasury
213
251
  #
214
252
  # @param bank_settings [ModernTreasury::Models::LegalEntityBankSettings, nil]
215
253
  #
254
+ # @param business_description [String, nil] A description of the business.
255
+ #
216
256
  # @param business_name [String, nil] The business's legal business name.
217
257
  #
218
258
  # @param citizenship_country [String, nil] The country of citizenship for an individual.
219
259
  #
220
260
  # @param compliance_details [ModernTreasury::Models::LegalEntityComplianceDetail, nil]
221
261
  #
262
+ # @param country_of_incorporation [String, nil] The country code where the business is incorporated in the ISO 3166-1 alpha-2 or
263
+ #
222
264
  # @param date_formed [Date, nil] A business's formation date (YYYY-MM-DD).
223
265
  #
224
266
  # @param date_of_birth [Date, nil] An individual's date of birth (YYYY-MM-DD).
@@ -227,15 +269,19 @@ module ModernTreasury
227
269
  #
228
270
  # @param email [String, nil] The entity's primary email.
229
271
  #
272
+ # @param expected_activity_volume [Integer, nil] Monthly expected transaction volume in entity's local currency.
273
+ #
230
274
  # @param first_name [String, nil] An individual's first name.
231
275
  #
232
276
  # @param identifications [Array<ModernTreasury::Models::IdentificationCreateRequest>] A list of identifications for the legal entity.
233
277
  #
234
278
  # @param industry_classifications [Array<ModernTreasury::Models::LegalEntityIndustryClassification>] A list of industry classifications for the legal entity.
235
279
  #
280
+ # @param intended_use [String, nil] A description of the intended use of the legal entity.
281
+ #
236
282
  # @param last_name [String, nil] An individual's last name.
237
283
  #
238
- # @param legal_entity_associations [Array<ModernTreasury::Models::ConnectionLegalEntityCreateParams::LegalEntity::LegalEntityAssociation>, nil] The legal entity associations and its child legal entities.
284
+ # @param legal_entity_associations [Array<ModernTreasury::Models::LegalEntityAssociationInlineCreate>, nil] The legal entity associations and its child legal entities.
239
285
  #
240
286
  # @param legal_entity_type [Symbol, ModernTreasury::Models::ConnectionLegalEntityCreateParams::LegalEntity::LegalEntityType] The type of legal entity.
241
287
  #
@@ -245,6 +291,8 @@ module ModernTreasury
245
291
  #
246
292
  # @param middle_name [String, nil] An individual's middle name.
247
293
  #
294
+ # @param operating_jurisdictions [Array<String>] A list of countries where the business operates (ISO 3166-1 alpha-2 or alpha-3 c
295
+ #
248
296
  # @param phone_numbers [Array<ModernTreasury::Models::ConnectionLegalEntityCreateParams::LegalEntity::PhoneNumber>]
249
297
  #
250
298
  # @param politically_exposed_person [Boolean, nil] Whether the individual is a politically exposed person.
@@ -253,6 +301,8 @@ module ModernTreasury
253
301
  #
254
302
  # @param prefix [String, nil] An individual's prefix.
255
303
  #
304
+ # @param primary_social_media_sites [Array<String>] A list of primary social media URLs for the business.
305
+ #
256
306
  # @param risk_rating [Symbol, ModernTreasury::Models::ConnectionLegalEntityCreateParams::LegalEntity::RiskRating, nil] The risk rating of the legal entity. One of low, medium, high.
257
307
  #
258
308
  # @param suffix [String, nil] An individual's suffix.
@@ -261,65 +311,6 @@ module ModernTreasury
261
311
  #
262
312
  # @param website [String, nil] The entity's primary website URL.
263
313
 
264
- class LegalEntityAssociation < ModernTreasury::Internal::Type::BaseModel
265
- # @!attribute relationship_types
266
- #
267
- # @return [Array<Symbol, ModernTreasury::Models::ConnectionLegalEntityCreateParams::LegalEntity::LegalEntityAssociation::RelationshipType>]
268
- required :relationship_types,
269
- -> do
270
- ModernTreasury::Internal::Type::ArrayOf[
271
- enum: ModernTreasury::ConnectionLegalEntityCreateParams::LegalEntity::LegalEntityAssociation::RelationshipType
272
- ]
273
- end
274
-
275
- # @!attribute child_legal_entity
276
- # The child legal entity.
277
- #
278
- # @return [ModernTreasury::Models::ChildLegalEntityCreate, nil]
279
- optional :child_legal_entity, -> { ModernTreasury::ChildLegalEntityCreate }
280
-
281
- # @!attribute child_legal_entity_id
282
- # The ID of the child legal entity.
283
- #
284
- # @return [String, nil]
285
- optional :child_legal_entity_id, String
286
-
287
- # @!attribute ownership_percentage
288
- # The child entity's ownership percentage iff they are a beneficial owner.
289
- #
290
- # @return [Integer, nil]
291
- optional :ownership_percentage, Integer, nil?: true
292
-
293
- # @!attribute title
294
- # The job title of the child entity at the parent entity.
295
- #
296
- # @return [String, nil]
297
- optional :title, String, nil?: true
298
-
299
- # @!method initialize(relationship_types:, child_legal_entity: nil, child_legal_entity_id: nil, ownership_percentage: nil, title: nil)
300
- # @param relationship_types [Array<Symbol, ModernTreasury::Models::ConnectionLegalEntityCreateParams::LegalEntity::LegalEntityAssociation::RelationshipType>]
301
- #
302
- # @param child_legal_entity [ModernTreasury::Models::ChildLegalEntityCreate] The child legal entity.
303
- #
304
- # @param child_legal_entity_id [String] The ID of the child legal entity.
305
- #
306
- # @param ownership_percentage [Integer, nil] The child entity's ownership percentage iff they are a beneficial owner.
307
- #
308
- # @param title [String, nil] The job title of the child entity at the parent entity.
309
-
310
- # A list of relationship types for how the child entity relates to parent entity.
311
- module RelationshipType
312
- extend ModernTreasury::Internal::Type::Enum
313
-
314
- AUTHORIZED_SIGNER = :authorized_signer
315
- BENEFICIAL_OWNER = :beneficial_owner
316
- CONTROL_PERSON = :control_person
317
-
318
- # @!method self.values
319
- # @return [Array<Symbol>]
320
- end
321
- end
322
-
323
314
  # The type of legal entity.
324
315
  #
325
316
  # @see ModernTreasury::Models::ConnectionLegalEntityCreateParams::LegalEntity#legal_entity_type
@@ -43,10 +43,12 @@ module ModernTreasury
43
43
  module Status
44
44
  extend ModernTreasury::Internal::Type::Enum
45
45
 
46
+ CLOSED = :closed
46
47
  COMPLETED = :completed
47
48
  DENIED = :denied
48
49
  FAILED = :failed
49
50
  PROCESSING = :processing
51
+ SUSPENDED = :suspended
50
52
 
51
53
  # @!method self.values
52
54
  # @return [Array<Symbol>]
@@ -450,6 +450,12 @@ module ModernTreasury
450
450
  # @return [ModernTreasury::Models::LegalEntityBankSettings, nil]
451
451
  optional :bank_settings, -> { ModernTreasury::LegalEntityBankSettings }, nil?: true
452
452
 
453
+ # @!attribute business_description
454
+ # A description of the business.
455
+ #
456
+ # @return [String, nil]
457
+ optional :business_description, String, nil?: true
458
+
453
459
  # @!attribute business_name
454
460
  # The business's legal business name.
455
461
  #
@@ -467,6 +473,13 @@ module ModernTreasury
467
473
  # @return [ModernTreasury::Models::LegalEntityComplianceDetail, nil]
468
474
  optional :compliance_details, -> { ModernTreasury::LegalEntityComplianceDetail }, nil?: true
469
475
 
476
+ # @!attribute country_of_incorporation
477
+ # The country code where the business is incorporated in the ISO 3166-1 alpha-2 or
478
+ # alpha-3 formats.
479
+ #
480
+ # @return [String, nil]
481
+ optional :country_of_incorporation, String, nil?: true
482
+
470
483
  # @!attribute date_formed
471
484
  # A business's formation date (YYYY-MM-DD).
472
485
  #
@@ -490,6 +503,12 @@ module ModernTreasury
490
503
  # @return [String, nil]
491
504
  optional :email, String, nil?: true
492
505
 
506
+ # @!attribute expected_activity_volume
507
+ # Monthly expected transaction volume in entity's local currency.
508
+ #
509
+ # @return [Integer, nil]
510
+ optional :expected_activity_volume, Integer, nil?: true
511
+
493
512
  # @!attribute first_name
494
513
  # An individual's first name.
495
514
  #
@@ -510,6 +529,12 @@ module ModernTreasury
510
529
  optional :industry_classifications,
511
530
  -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::LegalEntityIndustryClassification] }
512
531
 
532
+ # @!attribute intended_use
533
+ # A description of the intended use of the legal entity.
534
+ #
535
+ # @return [String, nil]
536
+ optional :intended_use, String, nil?: true
537
+
513
538
  # @!attribute last_name
514
539
  # An individual's last name.
515
540
  #
@@ -519,10 +544,10 @@ module ModernTreasury
519
544
  # @!attribute legal_entity_associations
520
545
  # The legal entity associations and its child legal entities.
521
546
  #
522
- # @return [Array<ModernTreasury::Models::CounterpartyCreateParams::LegalEntity::LegalEntityAssociation>, nil]
547
+ # @return [Array<ModernTreasury::Models::LegalEntityAssociationInlineCreate>, nil]
523
548
  optional :legal_entity_associations,
524
549
  -> {
525
- ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::CounterpartyCreateParams::LegalEntity::LegalEntityAssociation]
550
+ ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::LegalEntityAssociationInlineCreate]
526
551
  },
527
552
  nil?: true
528
553
 
@@ -547,6 +572,13 @@ module ModernTreasury
547
572
  # @return [String, nil]
548
573
  optional :middle_name, String, nil?: true
549
574
 
575
+ # @!attribute operating_jurisdictions
576
+ # A list of countries where the business operates (ISO 3166-1 alpha-2 or alpha-3
577
+ # codes).
578
+ #
579
+ # @return [Array<String>, nil]
580
+ optional :operating_jurisdictions, ModernTreasury::Internal::Type::ArrayOf[String]
581
+
550
582
  # @!attribute phone_numbers
551
583
  #
552
584
  # @return [Array<ModernTreasury::Models::CounterpartyCreateParams::LegalEntity::PhoneNumber>, nil]
@@ -571,6 +603,12 @@ module ModernTreasury
571
603
  # @return [String, nil]
572
604
  optional :prefix, String, nil?: true
573
605
 
606
+ # @!attribute primary_social_media_sites
607
+ # A list of primary social media URLs for the business.
608
+ #
609
+ # @return [Array<String>, nil]
610
+ optional :primary_social_media_sites, ModernTreasury::Internal::Type::ArrayOf[String]
611
+
574
612
  # @!attribute risk_rating
575
613
  # The risk rating of the legal entity. One of low, medium, high.
576
614
  #
@@ -598,7 +636,7 @@ module ModernTreasury
598
636
  # @return [String, nil]
599
637
  optional :website, String, nil?: true
600
638
 
601
- # @!method initialize(legal_entity_type:, addresses: nil, bank_settings: nil, business_name: nil, citizenship_country: nil, compliance_details: nil, date_formed: nil, date_of_birth: nil, doing_business_as_names: nil, email: nil, first_name: nil, identifications: nil, industry_classifications: nil, last_name: nil, legal_entity_associations: nil, legal_structure: nil, metadata: nil, middle_name: nil, phone_numbers: nil, politically_exposed_person: nil, preferred_name: nil, prefix: nil, risk_rating: nil, suffix: nil, wealth_and_employment_details: nil, website: nil)
639
+ # @!method initialize(legal_entity_type:, addresses: nil, bank_settings: nil, business_description: nil, business_name: nil, citizenship_country: nil, compliance_details: nil, country_of_incorporation: nil, date_formed: nil, date_of_birth: nil, doing_business_as_names: nil, email: nil, expected_activity_volume: nil, first_name: nil, identifications: nil, industry_classifications: nil, intended_use: nil, last_name: nil, legal_entity_associations: nil, legal_structure: 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, risk_rating: nil, suffix: nil, wealth_and_employment_details: nil, website: nil)
602
640
  # Some parameter documentations has been truncated, see
603
641
  # {ModernTreasury::Models::CounterpartyCreateParams::LegalEntity} for more
604
642
  # details.
@@ -609,12 +647,16 @@ module ModernTreasury
609
647
  #
610
648
  # @param bank_settings [ModernTreasury::Models::LegalEntityBankSettings, nil]
611
649
  #
650
+ # @param business_description [String, nil] A description of the business.
651
+ #
612
652
  # @param business_name [String, nil] The business's legal business name.
613
653
  #
614
654
  # @param citizenship_country [String, nil] The country of citizenship for an individual.
615
655
  #
616
656
  # @param compliance_details [ModernTreasury::Models::LegalEntityComplianceDetail, nil]
617
657
  #
658
+ # @param country_of_incorporation [String, nil] The country code where the business is incorporated in the ISO 3166-1 alpha-2 or
659
+ #
618
660
  # @param date_formed [Date, nil] A business's formation date (YYYY-MM-DD).
619
661
  #
620
662
  # @param date_of_birth [Date, nil] An individual's date of birth (YYYY-MM-DD).
@@ -623,15 +665,19 @@ module ModernTreasury
623
665
  #
624
666
  # @param email [String, nil] The entity's primary email.
625
667
  #
668
+ # @param expected_activity_volume [Integer, nil] Monthly expected transaction volume in entity's local currency.
669
+ #
626
670
  # @param first_name [String, nil] An individual's first name.
627
671
  #
628
672
  # @param identifications [Array<ModernTreasury::Models::IdentificationCreateRequest>] A list of identifications for the legal entity.
629
673
  #
630
674
  # @param industry_classifications [Array<ModernTreasury::Models::LegalEntityIndustryClassification>] A list of industry classifications for the legal entity.
631
675
  #
676
+ # @param intended_use [String, nil] A description of the intended use of the legal entity.
677
+ #
632
678
  # @param last_name [String, nil] An individual's last name.
633
679
  #
634
- # @param legal_entity_associations [Array<ModernTreasury::Models::CounterpartyCreateParams::LegalEntity::LegalEntityAssociation>, nil] The legal entity associations and its child legal entities.
680
+ # @param legal_entity_associations [Array<ModernTreasury::Models::LegalEntityAssociationInlineCreate>, nil] The legal entity associations and its child legal entities.
635
681
  #
636
682
  # @param legal_structure [Symbol, ModernTreasury::Models::CounterpartyCreateParams::LegalEntity::LegalStructure, nil] The business's legal structure.
637
683
  #
@@ -639,6 +685,8 @@ module ModernTreasury
639
685
  #
640
686
  # @param middle_name [String, nil] An individual's middle name.
641
687
  #
688
+ # @param operating_jurisdictions [Array<String>] A list of countries where the business operates (ISO 3166-1 alpha-2 or alpha-3 c
689
+ #
642
690
  # @param phone_numbers [Array<ModernTreasury::Models::CounterpartyCreateParams::LegalEntity::PhoneNumber>]
643
691
  #
644
692
  # @param politically_exposed_person [Boolean, nil] Whether the individual is a politically exposed person.
@@ -647,6 +695,8 @@ module ModernTreasury
647
695
  #
648
696
  # @param prefix [String, nil] An individual's prefix.
649
697
  #
698
+ # @param primary_social_media_sites [Array<String>] A list of primary social media URLs for the business.
699
+ #
650
700
  # @param risk_rating [Symbol, ModernTreasury::Models::CounterpartyCreateParams::LegalEntity::RiskRating, nil] The risk rating of the legal entity. One of low, medium, high.
651
701
  #
652
702
  # @param suffix [String, nil] An individual's suffix.
@@ -668,61 +718,6 @@ module ModernTreasury
668
718
  # @return [Array<Symbol>]
669
719
  end
670
720
 
671
- class LegalEntityAssociation < ModernTreasury::Internal::Type::BaseModel
672
- # @!attribute relationship_types
673
- #
674
- # @return [Array<Symbol, ModernTreasury::Models::CounterpartyCreateParams::LegalEntity::LegalEntityAssociation::RelationshipType>]
675
- required :relationship_types,
676
- -> { ModernTreasury::Internal::Type::ArrayOf[enum: ModernTreasury::CounterpartyCreateParams::LegalEntity::LegalEntityAssociation::RelationshipType] }
677
-
678
- # @!attribute child_legal_entity
679
- # The child legal entity.
680
- #
681
- # @return [ModernTreasury::Models::ChildLegalEntityCreate, nil]
682
- optional :child_legal_entity, -> { ModernTreasury::ChildLegalEntityCreate }
683
-
684
- # @!attribute child_legal_entity_id
685
- # The ID of the child legal entity.
686
- #
687
- # @return [String, nil]
688
- optional :child_legal_entity_id, String
689
-
690
- # @!attribute ownership_percentage
691
- # The child entity's ownership percentage iff they are a beneficial owner.
692
- #
693
- # @return [Integer, nil]
694
- optional :ownership_percentage, Integer, nil?: true
695
-
696
- # @!attribute title
697
- # The job title of the child entity at the parent entity.
698
- #
699
- # @return [String, nil]
700
- optional :title, String, nil?: true
701
-
702
- # @!method initialize(relationship_types:, child_legal_entity: nil, child_legal_entity_id: nil, ownership_percentage: nil, title: nil)
703
- # @param relationship_types [Array<Symbol, ModernTreasury::Models::CounterpartyCreateParams::LegalEntity::LegalEntityAssociation::RelationshipType>]
704
- #
705
- # @param child_legal_entity [ModernTreasury::Models::ChildLegalEntityCreate] The child legal entity.
706
- #
707
- # @param child_legal_entity_id [String] The ID of the child legal entity.
708
- #
709
- # @param ownership_percentage [Integer, nil] The child entity's ownership percentage iff they are a beneficial owner.
710
- #
711
- # @param title [String, nil] The job title of the child entity at the parent entity.
712
-
713
- # A list of relationship types for how the child entity relates to parent entity.
714
- module RelationshipType
715
- extend ModernTreasury::Internal::Type::Enum
716
-
717
- AUTHORIZED_SIGNER = :authorized_signer
718
- BENEFICIAL_OWNER = :beneficial_owner
719
- CONTROL_PERSON = :control_person
720
-
721
- # @!method self.values
722
- # @return [Array<Symbol>]
723
- end
724
- end
725
-
726
721
  # The business's legal structure.
727
722
  #
728
723
  # @see ModernTreasury::Models::CounterpartyCreateParams::LegalEntity#legal_structure