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
@@ -25,6 +25,12 @@ module ModernTreasury
25
25
  # @return [ModernTreasury::Models::LegalEntityBankSettings, nil]
26
26
  optional :bank_settings, -> { ModernTreasury::LegalEntityBankSettings }, nil?: true
27
27
 
28
+ # @!attribute business_description
29
+ # A description of the business.
30
+ #
31
+ # @return [String, nil]
32
+ optional :business_description, String, nil?: true
33
+
28
34
  # @!attribute business_name
29
35
  # The business's legal business name.
30
36
  #
@@ -42,6 +48,13 @@ module ModernTreasury
42
48
  # @return [ModernTreasury::Models::LegalEntityComplianceDetail, nil]
43
49
  optional :compliance_details, -> { ModernTreasury::LegalEntityComplianceDetail }, nil?: true
44
50
 
51
+ # @!attribute country_of_incorporation
52
+ # The country code where the business is incorporated in the ISO 3166-1 alpha-2 or
53
+ # alpha-3 formats.
54
+ #
55
+ # @return [String, nil]
56
+ optional :country_of_incorporation, String, nil?: true
57
+
45
58
  # @!attribute date_formed
46
59
  # A business's formation date (YYYY-MM-DD).
47
60
  #
@@ -65,6 +78,12 @@ module ModernTreasury
65
78
  # @return [String, nil]
66
79
  optional :email, String, nil?: true
67
80
 
81
+ # @!attribute expected_activity_volume
82
+ # Monthly expected transaction volume in entity's local currency.
83
+ #
84
+ # @return [Integer, nil]
85
+ optional :expected_activity_volume, Integer, nil?: true
86
+
68
87
  # @!attribute first_name
69
88
  # An individual's first name.
70
89
  #
@@ -85,6 +104,12 @@ module ModernTreasury
85
104
  optional :industry_classifications,
86
105
  -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::LegalEntityIndustryClassification] }
87
106
 
107
+ # @!attribute intended_use
108
+ # A description of the intended use of the legal entity.
109
+ #
110
+ # @return [String, nil]
111
+ optional :intended_use, String, nil?: true
112
+
88
113
  # @!attribute last_name
89
114
  # An individual's last name.
90
115
  #
@@ -94,10 +119,10 @@ module ModernTreasury
94
119
  # @!attribute legal_entity_associations
95
120
  # The legal entity associations and its child legal entities.
96
121
  #
97
- # @return [Array<ModernTreasury::Models::LegalEntityCreateParams::LegalEntityAssociation>, nil]
122
+ # @return [Array<ModernTreasury::Models::LegalEntityAssociationInlineCreate>, nil]
98
123
  optional :legal_entity_associations,
99
124
  -> {
100
- ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::LegalEntityCreateParams::LegalEntityAssociation]
125
+ ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::LegalEntityAssociationInlineCreate]
101
126
  },
102
127
  nil?: true
103
128
 
@@ -122,6 +147,13 @@ module ModernTreasury
122
147
  # @return [String, nil]
123
148
  optional :middle_name, String, nil?: true
124
149
 
150
+ # @!attribute operating_jurisdictions
151
+ # A list of countries where the business operates (ISO 3166-1 alpha-2 or alpha-3
152
+ # codes).
153
+ #
154
+ # @return [Array<String>, nil]
155
+ optional :operating_jurisdictions, ModernTreasury::Internal::Type::ArrayOf[String]
156
+
125
157
  # @!attribute phone_numbers
126
158
  #
127
159
  # @return [Array<ModernTreasury::Models::LegalEntityCreateParams::PhoneNumber>, nil]
@@ -146,6 +178,12 @@ module ModernTreasury
146
178
  # @return [String, nil]
147
179
  optional :prefix, String, nil?: true
148
180
 
181
+ # @!attribute primary_social_media_sites
182
+ # A list of primary social media URLs for the business.
183
+ #
184
+ # @return [Array<String>, nil]
185
+ optional :primary_social_media_sites, ModernTreasury::Internal::Type::ArrayOf[String]
186
+
149
187
  # @!attribute risk_rating
150
188
  # The risk rating of the legal entity. One of low, medium, high.
151
189
  #
@@ -171,7 +209,7 @@ module ModernTreasury
171
209
  # @return [String, nil]
172
210
  optional :website, String, nil?: true
173
211
 
174
- # @!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, request_options: {})
212
+ # @!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, request_options: {})
175
213
  # Some parameter documentations has been truncated, see
176
214
  # {ModernTreasury::Models::LegalEntityCreateParams} for more details.
177
215
  #
@@ -181,12 +219,16 @@ module ModernTreasury
181
219
  #
182
220
  # @param bank_settings [ModernTreasury::Models::LegalEntityBankSettings, nil]
183
221
  #
222
+ # @param business_description [String, nil] A description of the business.
223
+ #
184
224
  # @param business_name [String, nil] The business's legal business name.
185
225
  #
186
226
  # @param citizenship_country [String, nil] The country of citizenship for an individual.
187
227
  #
188
228
  # @param compliance_details [ModernTreasury::Models::LegalEntityComplianceDetail, nil]
189
229
  #
230
+ # @param country_of_incorporation [String, nil] The country code where the business is incorporated in the ISO 3166-1 alpha-2 or
231
+ #
190
232
  # @param date_formed [Date, nil] A business's formation date (YYYY-MM-DD).
191
233
  #
192
234
  # @param date_of_birth [Date, nil] An individual's date of birth (YYYY-MM-DD).
@@ -195,15 +237,19 @@ module ModernTreasury
195
237
  #
196
238
  # @param email [String, nil] The entity's primary email.
197
239
  #
240
+ # @param expected_activity_volume [Integer, nil] Monthly expected transaction volume in entity's local currency.
241
+ #
198
242
  # @param first_name [String, nil] An individual's first name.
199
243
  #
200
244
  # @param identifications [Array<ModernTreasury::Models::IdentificationCreateRequest>] A list of identifications for the legal entity.
201
245
  #
202
246
  # @param industry_classifications [Array<ModernTreasury::Models::LegalEntityIndustryClassification>] A list of industry classifications for the legal entity.
203
247
  #
248
+ # @param intended_use [String, nil] A description of the intended use of the legal entity.
249
+ #
204
250
  # @param last_name [String, nil] An individual's last name.
205
251
  #
206
- # @param legal_entity_associations [Array<ModernTreasury::Models::LegalEntityCreateParams::LegalEntityAssociation>, nil] The legal entity associations and its child legal entities.
252
+ # @param legal_entity_associations [Array<ModernTreasury::Models::LegalEntityAssociationInlineCreate>, nil] The legal entity associations and its child legal entities.
207
253
  #
208
254
  # @param legal_structure [Symbol, ModernTreasury::Models::LegalEntityCreateParams::LegalStructure, nil] The business's legal structure.
209
255
  #
@@ -211,6 +257,8 @@ module ModernTreasury
211
257
  #
212
258
  # @param middle_name [String, nil] An individual's middle name.
213
259
  #
260
+ # @param operating_jurisdictions [Array<String>] A list of countries where the business operates (ISO 3166-1 alpha-2 or alpha-3 c
261
+ #
214
262
  # @param phone_numbers [Array<ModernTreasury::Models::LegalEntityCreateParams::PhoneNumber>]
215
263
  #
216
264
  # @param politically_exposed_person [Boolean, nil] Whether the individual is a politically exposed person.
@@ -219,6 +267,8 @@ module ModernTreasury
219
267
  #
220
268
  # @param prefix [String, nil] An individual's prefix.
221
269
  #
270
+ # @param primary_social_media_sites [Array<String>] A list of primary social media URLs for the business.
271
+ #
222
272
  # @param risk_rating [Symbol, ModernTreasury::Models::LegalEntityCreateParams::RiskRating, nil] The risk rating of the legal entity. One of low, medium, high.
223
273
  #
224
274
  # @param suffix [String, nil] An individual's suffix.
@@ -240,61 +290,6 @@ module ModernTreasury
240
290
  # @return [Array<Symbol>]
241
291
  end
242
292
 
243
- class LegalEntityAssociation < ModernTreasury::Internal::Type::BaseModel
244
- # @!attribute relationship_types
245
- #
246
- # @return [Array<Symbol, ModernTreasury::Models::LegalEntityCreateParams::LegalEntityAssociation::RelationshipType>]
247
- required :relationship_types,
248
- -> { ModernTreasury::Internal::Type::ArrayOf[enum: ModernTreasury::LegalEntityCreateParams::LegalEntityAssociation::RelationshipType] }
249
-
250
- # @!attribute child_legal_entity
251
- # The child legal entity.
252
- #
253
- # @return [ModernTreasury::Models::ChildLegalEntityCreate, nil]
254
- optional :child_legal_entity, -> { ModernTreasury::ChildLegalEntityCreate }
255
-
256
- # @!attribute child_legal_entity_id
257
- # The ID of the child legal entity.
258
- #
259
- # @return [String, nil]
260
- optional :child_legal_entity_id, String
261
-
262
- # @!attribute ownership_percentage
263
- # The child entity's ownership percentage iff they are a beneficial owner.
264
- #
265
- # @return [Integer, nil]
266
- optional :ownership_percentage, Integer, nil?: true
267
-
268
- # @!attribute title
269
- # The job title of the child entity at the parent entity.
270
- #
271
- # @return [String, nil]
272
- optional :title, String, nil?: true
273
-
274
- # @!method initialize(relationship_types:, child_legal_entity: nil, child_legal_entity_id: nil, ownership_percentage: nil, title: nil)
275
- # @param relationship_types [Array<Symbol, ModernTreasury::Models::LegalEntityCreateParams::LegalEntityAssociation::RelationshipType>]
276
- #
277
- # @param child_legal_entity [ModernTreasury::Models::ChildLegalEntityCreate] The child legal entity.
278
- #
279
- # @param child_legal_entity_id [String] The ID of the child legal entity.
280
- #
281
- # @param ownership_percentage [Integer, nil] The child entity's ownership percentage iff they are a beneficial owner.
282
- #
283
- # @param title [String, nil] The job title of the child entity at the parent entity.
284
-
285
- # A list of relationship types for how the child entity relates to parent entity.
286
- module RelationshipType
287
- extend ModernTreasury::Internal::Type::Enum
288
-
289
- AUTHORIZED_SIGNER = :authorized_signer
290
- BENEFICIAL_OWNER = :beneficial_owner
291
- CONTROL_PERSON = :control_person
292
-
293
- # @!method self.values
294
- # @return [Array<Symbol>]
295
- end
296
- end
297
-
298
293
  # The business's legal structure.
299
294
  module LegalStructure
300
295
  extend ModernTreasury::Internal::Type::Enum
@@ -19,6 +19,12 @@ module ModernTreasury
19
19
  # @return [ModernTreasury::Models::LegalEntityBankSettings, nil]
20
20
  optional :bank_settings, -> { ModernTreasury::LegalEntityBankSettings }, nil?: true
21
21
 
22
+ # @!attribute business_description
23
+ # A description of the business.
24
+ #
25
+ # @return [String, nil]
26
+ optional :business_description, String, nil?: true
27
+
22
28
  # @!attribute business_name
23
29
  # The business's legal business name.
24
30
  #
@@ -36,6 +42,13 @@ module ModernTreasury
36
42
  # @return [ModernTreasury::Models::LegalEntityComplianceDetail, nil]
37
43
  optional :compliance_details, -> { ModernTreasury::LegalEntityComplianceDetail }, nil?: true
38
44
 
45
+ # @!attribute country_of_incorporation
46
+ # The country code where the business is incorporated in the ISO 3166-1 alpha-2 or
47
+ # alpha-3 formats.
48
+ #
49
+ # @return [String, nil]
50
+ optional :country_of_incorporation, String, nil?: true
51
+
39
52
  # @!attribute date_formed
40
53
  # A business's formation date (YYYY-MM-DD).
41
54
  #
@@ -59,6 +72,12 @@ module ModernTreasury
59
72
  # @return [String, nil]
60
73
  optional :email, String, nil?: true
61
74
 
75
+ # @!attribute expected_activity_volume
76
+ # Monthly expected transaction volume in entity's local currency.
77
+ #
78
+ # @return [Integer, nil]
79
+ optional :expected_activity_volume, Integer, nil?: true
80
+
62
81
  # @!attribute first_name
63
82
  # An individual's first name.
64
83
  #
@@ -79,6 +98,12 @@ module ModernTreasury
79
98
  optional :industry_classifications,
80
99
  -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::LegalEntityIndustryClassification] }
81
100
 
101
+ # @!attribute intended_use
102
+ # A description of the intended use of the legal entity.
103
+ #
104
+ # @return [String, nil]
105
+ optional :intended_use, String, nil?: true
106
+
82
107
  # @!attribute last_name
83
108
  # An individual's last name.
84
109
  #
@@ -106,6 +131,13 @@ module ModernTreasury
106
131
  # @return [String, nil]
107
132
  optional :middle_name, String, nil?: true
108
133
 
134
+ # @!attribute operating_jurisdictions
135
+ # A list of countries where the business operates (ISO 3166-1 alpha-2 or alpha-3
136
+ # codes).
137
+ #
138
+ # @return [Array<String>, nil]
139
+ optional :operating_jurisdictions, ModernTreasury::Internal::Type::ArrayOf[String]
140
+
109
141
  # @!attribute phone_numbers
110
142
  #
111
143
  # @return [Array<ModernTreasury::Models::LegalEntityUpdateParams::PhoneNumber>, nil]
@@ -130,6 +162,12 @@ module ModernTreasury
130
162
  # @return [String, nil]
131
163
  optional :prefix, String, nil?: true
132
164
 
165
+ # @!attribute primary_social_media_sites
166
+ # A list of primary social media URLs for the business.
167
+ #
168
+ # @return [Array<String>, nil]
169
+ optional :primary_social_media_sites, ModernTreasury::Internal::Type::ArrayOf[String]
170
+
133
171
  # @!attribute risk_rating
134
172
  # The risk rating of the legal entity. One of low, medium, high.
135
173
  #
@@ -155,7 +193,7 @@ module ModernTreasury
155
193
  # @return [String, nil]
156
194
  optional :website, String, nil?: true
157
195
 
158
- # @!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_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, request_options: {})
196
+ # @!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_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, request_options: {})
159
197
  # Some parameter documentations has been truncated, see
160
198
  # {ModernTreasury::Models::LegalEntityUpdateParams} for more details.
161
199
  #
@@ -163,12 +201,16 @@ module ModernTreasury
163
201
  #
164
202
  # @param bank_settings [ModernTreasury::Models::LegalEntityBankSettings, nil]
165
203
  #
204
+ # @param business_description [String, nil] A description of the business.
205
+ #
166
206
  # @param business_name [String, nil] The business's legal business name.
167
207
  #
168
208
  # @param citizenship_country [String, nil] The country of citizenship for an individual.
169
209
  #
170
210
  # @param compliance_details [ModernTreasury::Models::LegalEntityComplianceDetail, nil]
171
211
  #
212
+ # @param country_of_incorporation [String, nil] The country code where the business is incorporated in the ISO 3166-1 alpha-2 or
213
+ #
172
214
  # @param date_formed [Date, nil] A business's formation date (YYYY-MM-DD).
173
215
  #
174
216
  # @param date_of_birth [Date, nil] An individual's date of birth (YYYY-MM-DD).
@@ -177,12 +219,16 @@ module ModernTreasury
177
219
  #
178
220
  # @param email [String, nil] The entity's primary email.
179
221
  #
222
+ # @param expected_activity_volume [Integer, nil] Monthly expected transaction volume in entity's local currency.
223
+ #
180
224
  # @param first_name [String, nil] An individual's first name.
181
225
  #
182
226
  # @param identifications [Array<ModernTreasury::Models::IdentificationCreateRequest>] A list of identifications for the legal entity.
183
227
  #
184
228
  # @param industry_classifications [Array<ModernTreasury::Models::LegalEntityIndustryClassification>] A list of industry classifications for the legal entity.
185
229
  #
230
+ # @param intended_use [String, nil] A description of the intended use of the legal entity.
231
+ #
186
232
  # @param last_name [String, nil] An individual's last name.
187
233
  #
188
234
  # @param legal_structure [Symbol, ModernTreasury::Models::LegalEntityUpdateParams::LegalStructure, nil] The business's legal structure.
@@ -191,6 +237,8 @@ module ModernTreasury
191
237
  #
192
238
  # @param middle_name [String, nil] An individual's middle name.
193
239
  #
240
+ # @param operating_jurisdictions [Array<String>] A list of countries where the business operates (ISO 3166-1 alpha-2 or alpha-3 c
241
+ #
194
242
  # @param phone_numbers [Array<ModernTreasury::Models::LegalEntityUpdateParams::PhoneNumber>]
195
243
  #
196
244
  # @param politically_exposed_person [Boolean, nil] Whether the individual is a politically exposed person.
@@ -199,6 +247,8 @@ module ModernTreasury
199
247
  #
200
248
  # @param prefix [String, nil] An individual's prefix.
201
249
  #
250
+ # @param primary_social_media_sites [Array<String>] A list of primary social media URLs for the business.
251
+ #
202
252
  # @param risk_rating [Symbol, ModernTreasury::Models::LegalEntityUpdateParams::RiskRating, nil] The risk rating of the legal entity. One of low, medium, high.
203
253
  #
204
254
  # @param suffix [String, nil] An individual's suffix.
@@ -789,6 +789,7 @@ module ModernTreasury
789
789
  ACH_TRACE_NUMBER = :ach_trace_number
790
790
  BANKPROV_PAYMENT_ACTIVITY_DATE = :bankprov_payment_activity_date
791
791
  BANKPROV_PAYMENT_ID = :bankprov_payment_id
792
+ BLOCKCHAIN_TRANSACTION_HASH = :blockchain_transaction_hash
792
793
  BNK_DEV_PRENOTIFICATION_ID = :bnk_dev_prenotification_id
793
794
  BNK_DEV_TRANSFER_ID = :bnk_dev_transfer_id
794
795
  BNY_MELLON_TRANSACTION_REFERENCE_NUMBER = :bny_mellon_transaction_reference_number
@@ -839,9 +840,12 @@ module ModernTreasury
839
840
  JPMC_PAYMENT_RETURNED_DATETIME = :jpmc_payment_returned_datetime
840
841
  JPMC_TRANSACTION_REFERENCE_NUMBER = :jpmc_transaction_reference_number
841
842
  LOB_CHECK_ID = :lob_check_id
843
+ MT_FLOW_ACH_NOC_ID = :mt_flow_ach_noc_id
842
844
  MT_FLOW_TRANSFER_ID = :mt_flow_transfer_id
843
845
  OTHER = :other
844
846
  PARTIAL_SWIFT_MIR = :partial_swift_mir
847
+ PAXOS_ORCHESTRATION_ID = :paxos_orchestration_id
848
+ PAXOS_TRANSFER_ID = :paxos_transfer_id
845
849
  PNC_CLEARING_REFERENCE = :pnc_clearing_reference
846
850
  PNC_INSTRUCTION_ID = :pnc_instruction_id
847
851
  PNC_MULTIPAYMENT_ID = :pnc_multipayment_id
@@ -89,6 +89,7 @@ module ModernTreasury
89
89
  ACH_TRACE_NUMBER = :ach_trace_number
90
90
  BANKPROV_PAYMENT_ACTIVITY_DATE = :bankprov_payment_activity_date
91
91
  BANKPROV_PAYMENT_ID = :bankprov_payment_id
92
+ BLOCKCHAIN_TRANSACTION_HASH = :blockchain_transaction_hash
92
93
  BNK_DEV_PRENOTIFICATION_ID = :bnk_dev_prenotification_id
93
94
  BNK_DEV_TRANSFER_ID = :bnk_dev_transfer_id
94
95
  BNY_MELLON_TRANSACTION_REFERENCE_NUMBER = :bny_mellon_transaction_reference_number
@@ -139,9 +140,12 @@ module ModernTreasury
139
140
  JPMC_PAYMENT_RETURNED_DATETIME = :jpmc_payment_returned_datetime
140
141
  JPMC_TRANSACTION_REFERENCE_NUMBER = :jpmc_transaction_reference_number
141
142
  LOB_CHECK_ID = :lob_check_id
143
+ MT_FLOW_ACH_NOC_ID = :mt_flow_ach_noc_id
142
144
  MT_FLOW_TRANSFER_ID = :mt_flow_transfer_id
143
145
  OTHER = :other
144
146
  PARTIAL_SWIFT_MIR = :partial_swift_mir
147
+ PAXOS_ORCHESTRATION_ID = :paxos_orchestration_id
148
+ PAXOS_TRANSFER_ID = :paxos_transfer_id
145
149
  PNC_CLEARING_REFERENCE = :pnc_clearing_reference
146
150
  PNC_INSTRUCTION_ID = :pnc_instruction_id
147
151
  PNC_MULTIPAYMENT_ID = :pnc_multipayment_id
@@ -482,6 +482,7 @@ module ModernTreasury
482
482
  ACH_TRACE_NUMBER = :ach_trace_number
483
483
  BANKPROV_PAYMENT_ACTIVITY_DATE = :bankprov_payment_activity_date
484
484
  BANKPROV_PAYMENT_ID = :bankprov_payment_id
485
+ BLOCKCHAIN_TRANSACTION_HASH = :blockchain_transaction_hash
485
486
  BNK_DEV_PRENOTIFICATION_ID = :bnk_dev_prenotification_id
486
487
  BNK_DEV_TRANSFER_ID = :bnk_dev_transfer_id
487
488
  BNY_MELLON_TRANSACTION_REFERENCE_NUMBER = :bny_mellon_transaction_reference_number
@@ -532,9 +533,12 @@ module ModernTreasury
532
533
  JPMC_PAYMENT_RETURNED_DATETIME = :jpmc_payment_returned_datetime
533
534
  JPMC_TRANSACTION_REFERENCE_NUMBER = :jpmc_transaction_reference_number
534
535
  LOB_CHECK_ID = :lob_check_id
536
+ MT_FLOW_ACH_NOC_ID = :mt_flow_ach_noc_id
535
537
  MT_FLOW_TRANSFER_ID = :mt_flow_transfer_id
536
538
  OTHER = :other
537
539
  PARTIAL_SWIFT_MIR = :partial_swift_mir
540
+ PAXOS_ORCHESTRATION_ID = :paxos_orchestration_id
541
+ PAXOS_TRANSFER_ID = :paxos_transfer_id
538
542
  PNC_CLEARING_REFERENCE = :pnc_clearing_reference
539
543
  PNC_INSTRUCTION_ID = :pnc_instruction_id
540
544
  PNC_MULTIPAYMENT_ID = :pnc_multipayment_id
@@ -636,6 +640,7 @@ module ModernTreasury
636
640
  MANUAL = :manual
637
641
  SEPA = :sepa
638
642
  WIRE = :wire
643
+ ZENGIN = :zengin
639
644
 
640
645
  # @!method self.values
641
646
  # @return [Array<Symbol>]
@@ -299,6 +299,7 @@ module ModernTreasury
299
299
  JPMC = :jpmc
300
300
  MT_FLOW = :mt_flow
301
301
  MX = :mx
302
+ PAXOS = :paxos
302
303
  PAYPAL = :paypal
303
304
  PNC = :pnc
304
305
  SIGNET = :signet
@@ -86,6 +86,8 @@ module ModernTreasury
86
86
 
87
87
  BulkResultRetrieveParams = ModernTreasury::Models::BulkResultRetrieveParams
88
88
 
89
+ ChildLegalEntity = ModernTreasury::Models::ChildLegalEntity
90
+
89
91
  ChildLegalEntityCreate = ModernTreasury::Models::ChildLegalEntityCreate
90
92
 
91
93
  ClientPingParams = ModernTreasury::Models::ClientPingParams
@@ -364,6 +366,8 @@ module ModernTreasury
364
366
 
365
367
  LegalEntityAssociationCreateParams = ModernTreasury::Models::LegalEntityAssociationCreateParams
366
368
 
369
+ LegalEntityAssociationInlineCreate = ModernTreasury::Models::LegalEntityAssociationInlineCreate
370
+
367
371
  LegalEntityBankSettings = ModernTreasury::Models::LegalEntityBankSettings
368
372
 
369
373
  LegalEntityComplianceDetail = ModernTreasury::Models::LegalEntityComplianceDetail
@@ -8,10 +8,18 @@ module ModernTreasury
8
8
  #
9
9
  # create expected payment
10
10
  #
11
- # @overload create(amount_lower_bound: nil, amount_upper_bound: nil, counterparty_id: nil, currency: nil, date_lower_bound: nil, date_upper_bound: nil, description: nil, direction: nil, external_id: nil, internal_account_id: nil, ledger_transaction: nil, ledger_transaction_id: nil, line_items: nil, metadata: nil, reconciliation_filters: nil, reconciliation_groups: nil, reconciliation_rule_variables: nil, remittance_information: nil, statement_descriptor: nil, type: nil, request_options: {})
11
+ # @overload create(amount_lower_bound: nil, amount_reconciled: nil, amount_reconciled_direction: nil, amount_unreconciled: nil, amount_unreconciled_direction: nil, amount_upper_bound: nil, counterparty_id: nil, currency: nil, date_lower_bound: nil, date_upper_bound: nil, description: nil, direction: nil, external_id: nil, internal_account_id: nil, ledger_transaction: nil, ledger_transaction_id: nil, line_items: nil, metadata: nil, reconciliation_filters: nil, reconciliation_groups: nil, reconciliation_rule_variables: nil, remittance_information: nil, statement_descriptor: nil, type: nil, request_options: {})
12
12
  #
13
13
  # @param amount_lower_bound [Integer, nil] The lowest amount this expected payment may be equal to. Value in specified curr
14
14
  #
15
+ # @param amount_reconciled [Integer, nil] The amount reconciled for this expected payment. Value in specified currency's s
16
+ #
17
+ # @param amount_reconciled_direction [Symbol, ModernTreasury::Models::ExpectedPaymentCreateParams::AmountReconciledDirection, nil] One of credit or debit. Indicates whether amount_reconciled is a credit or debit
18
+ #
19
+ # @param amount_unreconciled [Integer, nil] The amount that remains unreconciled for this expected payment. Value in specifi
20
+ #
21
+ # @param amount_unreconciled_direction [Symbol, ModernTreasury::Models::ExpectedPaymentCreateParams::AmountUnreconciledDirection, nil] One of credit or debit. Indicates whether amount_unreconciled is a credit or deb
22
+ #
15
23
  # @param amount_upper_bound [Integer, nil] The highest amount this expected payment may be equal to. Value in specified cur
16
24
  #
17
25
  # @param counterparty_id [String, nil] The ID of the counterparty you expect for this payment.
@@ -91,12 +99,20 @@ module ModernTreasury
91
99
  #
92
100
  # update expected payment
93
101
  #
94
- # @overload update(id, amount_lower_bound: nil, amount_upper_bound: nil, counterparty_id: nil, currency: nil, date_lower_bound: nil, date_upper_bound: nil, description: nil, direction: nil, external_id: nil, internal_account_id: nil, metadata: nil, reconciliation_filters: nil, reconciliation_groups: nil, reconciliation_rule_variables: nil, remittance_information: nil, statement_descriptor: nil, status: nil, type: nil, request_options: {})
102
+ # @overload update(id, amount_lower_bound: nil, amount_reconciled: nil, amount_reconciled_direction: nil, amount_unreconciled: nil, amount_unreconciled_direction: nil, amount_upper_bound: nil, counterparty_id: nil, currency: nil, date_lower_bound: nil, date_upper_bound: nil, description: nil, direction: nil, external_id: nil, internal_account_id: nil, metadata: nil, reconciliation_filters: nil, reconciliation_groups: nil, reconciliation_rule_variables: nil, remittance_information: nil, statement_descriptor: nil, status: nil, type: nil, request_options: {})
95
103
  #
96
104
  # @param id [String] id
97
105
  #
98
106
  # @param amount_lower_bound [Integer, nil] The lowest amount this expected payment may be equal to. Value in specified curr
99
107
  #
108
+ # @param amount_reconciled [Integer, nil] The amount reconciled for this expected payment. Value in specified currency's s
109
+ #
110
+ # @param amount_reconciled_direction [Symbol, ModernTreasury::Models::ExpectedPaymentUpdateParams::AmountReconciledDirection, nil] One of credit or debit. Indicates whether amount_reconciled is a credit or debit
111
+ #
112
+ # @param amount_unreconciled [Integer, nil] The amount that remains unreconciled for this expected payment. Value in specifi
113
+ #
114
+ # @param amount_unreconciled_direction [Symbol, ModernTreasury::Models::ExpectedPaymentUpdateParams::AmountUnreconciledDirection, nil] One of credit or debit. Indicates whether amount_unreconciled is a credit or deb
115
+ #
100
116
  # @param amount_upper_bound [Integer, nil] The highest amount this expected payment may be equal to. Value in specified cur
101
117
  #
102
118
  # @param counterparty_id [String, nil] The ID of the counterparty you expect for this payment.
@@ -76,10 +76,12 @@ module ModernTreasury
76
76
  #
77
77
  # update internal account
78
78
  #
79
- # @overload update(id, counterparty_id: nil, ledger_account_id: nil, metadata: nil, name: nil, parent_account_id: nil, request_options: {})
79
+ # @overload update(id, contra_ledger_account_id: nil, counterparty_id: nil, ledger_account_id: nil, metadata: nil, name: nil, parent_account_id: nil, request_options: {})
80
80
  #
81
81
  # @param id [String] Unique identifier for the account.
82
82
  #
83
+ # @param contra_ledger_account_id [String] The Contra Ledger Account associated to this account.
84
+ #
83
85
  # @param counterparty_id [String] The Counterparty associated to this account.
84
86
  #
85
87
  # @param ledger_account_id [String] The Ledger Account associated to this account.
@@ -11,7 +11,7 @@ module ModernTreasury
11
11
  #
12
12
  # create invoice
13
13
  #
14
- # @overload create(counterparty_id:, due_date:, originating_account_id:, auto_advance: nil, contact_details: nil, counterparty_billing_address: nil, counterparty_shipping_address: nil, currency: nil, description: nil, fallback_payment_method: nil, ingest_ledger_entries: nil, invoice_line_items: nil, invoicer_address: nil, ledger_account_settlement_id: nil, metadata: nil, notification_email_addresses: nil, notifications_enabled: nil, payment_effective_date: nil, payment_method: nil, payment_type: nil, receiving_account_id: nil, recipient_email: nil, recipient_name: nil, remind_after_overdue_days: nil, virtual_account_id: nil, request_options: {})
14
+ # @overload create(counterparty_id:, due_date:, originating_account_id:, auto_advance: nil, contact_details: nil, counterparty_billing_address: nil, counterparty_shipping_address: nil, currency: nil, description: nil, fallback_payment_method: nil, invoice_line_items: nil, invoicer_address: nil, metadata: nil, notification_email_addresses: nil, notifications_enabled: nil, payment_effective_date: nil, payment_method: nil, payment_type: nil, receiving_account_id: nil, recipient_email: nil, recipient_name: nil, remind_after_overdue_days: nil, virtual_account_id: nil, request_options: {})
15
15
  #
16
16
  # @param counterparty_id [String] The ID of the counterparty receiving the invoice.
17
17
  #
@@ -33,14 +33,10 @@ module ModernTreasury
33
33
  #
34
34
  # @param fallback_payment_method [String, nil] When payment_method is automatic, the fallback payment method to use when an aut
35
35
  #
36
- # @param ingest_ledger_entries [Boolean, nil] Whether to ingest the ledger_entries to populate the invoice line items. If this
37
- #
38
36
  # @param invoice_line_items [Array<ModernTreasury::Models::InvoiceCreateParams::InvoiceLineItem>, nil] An array of invoice line items. The API supports a maximum of 50 invoice line it
39
37
  #
40
38
  # @param invoicer_address [ModernTreasury::Models::InvoiceCreateParams::InvoicerAddress, nil] The invoice issuer's business address.
41
39
  #
42
- # @param ledger_account_settlement_id [String, nil] The ID of the virtual account the invoice should be paid to.
43
- #
44
40
  # @param metadata [Hash{Symbol=>String}, nil] Additional data represented as key-value pairs. Both the key and value must be s
45
41
  #
46
42
  # @param notification_email_addresses [Array<String>, nil] Emails in addition to the counterparty email to send invoice status notification
@@ -104,7 +100,7 @@ module ModernTreasury
104
100
  #
105
101
  # update invoice
106
102
  #
107
- # @overload update(id, contact_details: nil, counterparty_billing_address: nil, counterparty_id: nil, counterparty_shipping_address: nil, currency: nil, description: nil, due_date: nil, fallback_payment_method: nil, ingest_ledger_entries: nil, invoice_line_items: nil, invoicer_address: nil, ledger_account_settlement_id: nil, metadata: nil, notification_email_addresses: nil, notifications_enabled: nil, originating_account_id: nil, payment_effective_date: nil, payment_method: nil, payment_type: nil, receiving_account_id: nil, recipient_email: nil, recipient_name: nil, remind_after_overdue_days: nil, status: nil, virtual_account_id: nil, request_options: {})
103
+ # @overload update(id, contact_details: nil, counterparty_billing_address: nil, counterparty_id: nil, counterparty_shipping_address: nil, currency: nil, description: nil, due_date: nil, fallback_payment_method: nil, invoice_line_items: nil, invoicer_address: nil, metadata: nil, notification_email_addresses: nil, notifications_enabled: nil, originating_account_id: nil, payment_effective_date: nil, payment_method: nil, payment_type: nil, receiving_account_id: nil, recipient_email: nil, recipient_name: nil, remind_after_overdue_days: nil, status: nil, virtual_account_id: nil, request_options: {})
108
104
  #
109
105
  # @param id [String] id
110
106
  #
@@ -124,14 +120,10 @@ module ModernTreasury
124
120
  #
125
121
  # @param fallback_payment_method [String, nil] When payment_method is automatic, the fallback payment method to use when an aut
126
122
  #
127
- # @param ingest_ledger_entries [Boolean, nil] Whether to ingest the ledger_entries to populate the invoice line items. If this
128
- #
129
123
  # @param invoice_line_items [Array<ModernTreasury::Models::InvoiceUpdateParams::InvoiceLineItem>, nil] An array of invoice line items. The API supports a maximum of 50 invoice line it
130
124
  #
131
125
  # @param invoicer_address [ModernTreasury::Models::InvoiceUpdateParams::InvoicerAddress, nil] The invoice issuer's business address.
132
126
  #
133
- # @param ledger_account_settlement_id [String, nil] The ID of the virtual account the invoice should be paid to.
134
- #
135
127
  # @param metadata [Hash{Symbol=>String}, nil] Additional data represented as key-value pairs. Both the key and value must be s
136
128
  #
137
129
  # @param notification_email_addresses [Array<String>, nil] Emails in addition to the counterparty email to send invoice status notification
@@ -53,7 +53,7 @@ module ModernTreasury
53
53
  #
54
54
  # @overload retrieve(id, balances: nil, request_options: {})
55
55
  #
56
- # @param id [String] id
56
+ # @param id [String] The ledger account id (UUID) or external_id
57
57
  #
58
58
  # @param balances [ModernTreasury::Models::LedgerAccountRetrieveParams::Balances] Use `balances[effective_at_lower_bound]` and `balances[effective_at_upper_bound]
59
59
  #
@@ -80,7 +80,7 @@ module ModernTreasury
80
80
  #
81
81
  # @overload update(id, description: nil, metadata: nil, name: nil, request_options: {})
82
82
  #
83
- # @param id [String] id
83
+ # @param id [String] The ledger account id (UUID)
84
84
  #
85
85
  # @param description [String, nil] The description of the ledger account.
86
86
  #
@@ -164,7 +164,7 @@ module ModernTreasury
164
164
  #
165
165
  # @overload delete(id, request_options: {})
166
166
  #
167
- # @param id [String] id
167
+ # @param id [String] The ledger account id (UUID)
168
168
  #
169
169
  # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
170
170
  #
@@ -47,11 +47,14 @@ module ModernTreasury
47
47
  )
48
48
  end
49
49
 
50
+ # Some parameter documentations has been truncated, see
51
+ # {ModernTreasury::Models::LedgerTransactionRetrieveParams} for more details.
52
+ #
50
53
  # Get details on a single ledger transaction.
51
54
  #
52
55
  # @overload retrieve(id, request_options: {})
53
56
  #
54
- # @param id [String] id
57
+ # @param id [String] The ledger transaction id (UUID) or external_id. If using external_id, only non-
55
58
  #
56
59
  # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
57
60
  #
@@ -74,7 +77,7 @@ module ModernTreasury
74
77
  #
75
78
  # @overload update(id, description: nil, effective_at: nil, ledger_entries: nil, ledgerable_id: nil, ledgerable_type: nil, metadata: nil, status: nil, request_options: {})
76
79
  #
77
- # @param id [String] id
80
+ # @param id [String] The ledger transaction id (UUID)
78
81
  #
79
82
  # @param description [String, nil] An optional description for internal use.
80
83
  #