modern_treasury 0.28.0 → 0.29.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 (76) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +18 -0
  3. data/README.md +3 -3
  4. data/lib/modern_treasury/models/address.rb +6 -4
  5. data/lib/modern_treasury/models/address_request.rb +9 -4
  6. data/lib/modern_treasury/models/bulk_request_create_params.rb +176 -11
  7. data/lib/modern_treasury/models/child_legal_entity.rb +21 -11
  8. data/lib/modern_treasury/models/child_legal_entity_create.rb +13 -7
  9. data/lib/modern_treasury/models/connection_legal_entity_create_params.rb +14 -7
  10. data/lib/modern_treasury/models/counterparty_create_params.rb +14 -7
  11. data/lib/modern_treasury/models/identification_create_request.rb +2 -0
  12. data/lib/modern_treasury/models/internal_account_create_params.rb +32 -5
  13. data/lib/modern_treasury/models/internal_accounts/balance_report_create_params.rb +2 -0
  14. data/lib/modern_treasury/models/invoice.rb +27 -12
  15. data/lib/modern_treasury/models/invoice_create_params.rb +29 -12
  16. data/lib/modern_treasury/models/invoice_update_params.rb +29 -12
  17. data/lib/modern_treasury/models/ledger_entry_create_request.rb +2 -0
  18. data/lib/modern_treasury/models/ledger_transaction_create_partial_post_params.rb +2 -0
  19. data/lib/modern_treasury/models/legal_entity.rb +21 -11
  20. data/lib/modern_treasury/models/legal_entity_address_create_request.rb +6 -4
  21. data/lib/modern_treasury/models/legal_entity_create_params.rb +13 -7
  22. data/lib/modern_treasury/models/legal_entity_update_params.rb +13 -7
  23. data/lib/modern_treasury/models/legal_entity_wealth_employment_detail.rb +3 -2
  24. data/lib/modern_treasury/models/payment_order_create_async_params.rb +14 -7
  25. data/lib/modern_treasury/models/payment_order_create_params.rb +14 -7
  26. data/lib/modern_treasury/models/wealth_and_employment_details.rb +3 -2
  27. data/lib/modern_treasury/models.rb +0 -2
  28. data/lib/modern_treasury/resources/bulk_requests.rb +1 -1
  29. data/lib/modern_treasury/resources/internal_accounts.rb +3 -1
  30. data/lib/modern_treasury/resources/legal_entities.rb +5 -32
  31. data/lib/modern_treasury/resources/payment_orders.rb +2 -2
  32. data/lib/modern_treasury/version.rb +1 -1
  33. data/lib/modern_treasury.rb +0 -1
  34. data/rbi/modern_treasury/models/address.rbi +8 -4
  35. data/rbi/modern_treasury/models/address_request.rbi +8 -4
  36. data/rbi/modern_treasury/models/bulk_request_create_params.rbi +339 -12
  37. data/rbi/modern_treasury/models/child_legal_entity.rbi +35 -13
  38. data/rbi/modern_treasury/models/child_legal_entity_create.rbi +17 -9
  39. data/rbi/modern_treasury/models/connection_legal_entity_create_params.rbi +17 -9
  40. data/rbi/modern_treasury/models/counterparty_create_params.rbi +17 -9
  41. data/rbi/modern_treasury/models/identification_create_request.rbi +10 -0
  42. data/rbi/modern_treasury/models/internal_account_create_params.rbi +84 -4
  43. data/rbi/modern_treasury/models/internal_accounts/balance_report_create_params.rbi +1 -0
  44. data/rbi/modern_treasury/models/invoice.rbi +24 -12
  45. data/rbi/modern_treasury/models/invoice_create_params.rbi +24 -12
  46. data/rbi/modern_treasury/models/invoice_update_params.rbi +24 -12
  47. data/rbi/modern_treasury/models/ledger_entry_create_request.rbi +1 -0
  48. data/rbi/modern_treasury/models/ledger_transaction_create_partial_post_params.rbi +1 -0
  49. data/rbi/modern_treasury/models/legal_entity.rbi +35 -13
  50. data/rbi/modern_treasury/models/legal_entity_address_create_request.rbi +8 -4
  51. data/rbi/modern_treasury/models/legal_entity_create_params.rbi +17 -9
  52. data/rbi/modern_treasury/models/legal_entity_update_params.rbi +17 -9
  53. data/rbi/modern_treasury/models/legal_entity_wealth_employment_detail.rbi +4 -2
  54. data/rbi/modern_treasury/models/payment_order_create_async_params.rbi +12 -8
  55. data/rbi/modern_treasury/models/payment_order_create_params.rbi +12 -8
  56. data/rbi/modern_treasury/models/wealth_and_employment_details.rbi +4 -2
  57. data/rbi/modern_treasury/models.rbi +0 -3
  58. data/rbi/modern_treasury/resources/bulk_requests.rbi +1 -1
  59. data/rbi/modern_treasury/resources/internal_accounts.rbi +6 -0
  60. data/rbi/modern_treasury/resources/legal_entities.rbi +9 -28
  61. data/rbi/modern_treasury/resources/payment_orders.rbi +2 -2
  62. data/sig/modern_treasury/models/bulk_request_create_params.rbs +147 -6
  63. data/sig/modern_treasury/models/child_legal_entity.rbs +4 -0
  64. data/sig/modern_treasury/models/identification_create_request.rbs +4 -0
  65. data/sig/modern_treasury/models/internal_account_create_params.rbs +23 -0
  66. data/sig/modern_treasury/models/legal_entity.rbs +4 -0
  67. data/sig/modern_treasury/models/payment_order_create_async_params.rbs +5 -5
  68. data/sig/modern_treasury/models/payment_order_create_params.rbs +5 -5
  69. data/sig/modern_treasury/models.rbs +0 -2
  70. data/sig/modern_treasury/resources/internal_accounts.rbs +1 -0
  71. data/sig/modern_treasury/resources/legal_entities.rbs +0 -6
  72. data/sig/modern_treasury/resources/payment_orders.rbs +2 -2
  73. metadata +2 -5
  74. data/lib/modern_treasury/models/legal_entity_update_status_params.rb +0 -46
  75. data/rbi/modern_treasury/models/legal_entity_update_status_params.rbi +0 -96
  76. data/sig/modern_treasury/models/legal_entity_update_status_params.rbs +0 -43
@@ -45,8 +45,8 @@ module ModernTreasury
45
45
  required :compliance_details, ModernTreasury::Internal::Type::Unknown, nil?: true
46
46
 
47
47
  # @!attribute country_of_incorporation
48
- # The country code where the business is incorporated in the ISO 3166-1 alpha-2 or
49
- # alpha-3 formats.
48
+ # The country where the business is incorporated, as an ISO 3166-1 alpha-2 country
49
+ # code (e.g. US).
50
50
  #
51
51
  # @return [String, nil]
52
52
  required :country_of_incorporation, String, nil?: true
@@ -177,8 +177,8 @@ module ModernTreasury
177
177
  required :object, String
178
178
 
179
179
  # @!attribute operating_jurisdictions
180
- # A list of countries where the business operates (ISO 3166-1 alpha-2 or alpha-3
181
- # codes).
180
+ # A list of countries where the business operates, as ISO 3166-1 alpha-2 country
181
+ # codes (e.g. ["US", "CA"]).
182
182
  #
183
183
  # @return [Array<String>]
184
184
  required :operating_jurisdictions, ModernTreasury::Internal::Type::ArrayOf[String]
@@ -317,7 +317,7 @@ module ModernTreasury
317
317
  #
318
318
  # @param compliance_details [Object, nil]
319
319
  #
320
- # @param country_of_incorporation [String, nil] The country code where the business is incorporated in the ISO 3166-1 alpha-2 or
320
+ # @param country_of_incorporation [String, nil] The country where the business is incorporated, as an ISO 3166-1 alpha-2 country
321
321
  #
322
322
  # @param created_at [Time]
323
323
  #
@@ -361,7 +361,7 @@ module ModernTreasury
361
361
  #
362
362
  # @param object [String]
363
363
  #
364
- # @param operating_jurisdictions [Array<String>] A list of countries where the business operates (ISO 3166-1 alpha-2 or alpha-3 c
364
+ # @param operating_jurisdictions [Array<String>] A list of countries where the business operates, as ISO 3166-1 alpha-2 country c
365
365
  #
366
366
  # @param phone_numbers [Array<ModernTreasury::Models::LegalEntity::PhoneNumber>]
367
367
  #
@@ -446,7 +446,8 @@ module ModernTreasury
446
446
  required :live_mode, ModernTreasury::Internal::Type::Boolean
447
447
 
448
448
  # @!attribute locality
449
- # Locality or City.
449
+ # Locality or City. Use the full city name rather than an abbreviation (e.g. San
450
+ # Francisco).
450
451
  #
451
452
  # @return [String, nil]
452
453
  required :locality, String, nil?: true
@@ -470,7 +471,8 @@ module ModernTreasury
470
471
  required :primary, ModernTreasury::Internal::Type::Boolean, nil?: true
471
472
 
472
473
  # @!attribute region
473
- # Region or State.
474
+ # Region or State. This field is free-form; for US states, we recommend a
475
+ # two-letter code (e.g. CA). Full state names are also accepted.
474
476
  #
475
477
  # @return [String, nil]
476
478
  required :region, String, nil?: true
@@ -500,7 +502,7 @@ module ModernTreasury
500
502
  #
501
503
  # @param live_mode [Boolean] This field will be true if this object exists in the live environment or false i
502
504
  #
503
- # @param locality [String, nil] Locality or City.
505
+ # @param locality [String, nil] Locality or City. Use the full city name rather than an abbreviation (e.g. San F
504
506
  #
505
507
  # @param object [String]
506
508
  #
@@ -508,7 +510,7 @@ module ModernTreasury
508
510
  #
509
511
  # @param primary [Boolean, nil] Whether this address is the primary address for the legal entity. Optional; when
510
512
  #
511
- # @param region [String, nil] Region or State.
513
+ # @param region [String, nil] Region or State. This field is free-form; for US states, we recommend a two-lett
512
514
  #
513
515
  # @param updated_at [Time]
514
516
 
@@ -665,6 +667,8 @@ module ModernTreasury
665
667
  GB_VAT = :gb_vat
666
668
  GENERIC_INTERNATIONAL = :generic_international
667
669
  GR_VAT = :gr_vat
670
+ HK_BRN = :hk_brn
671
+ HK_HKID = :hk_hkid
668
672
  HN_ID = :hn_id
669
673
  HN_RTN = :hn_rtn
670
674
  HR_OIB = :hr_oib
@@ -761,14 +765,20 @@ module ModernTreasury
761
765
 
762
766
  class PhoneNumber < ModernTreasury::Internal::Type::BaseModel
763
767
  # @!attribute phone_number
768
+ # A phone number in E.164 format. This format is strictly validated: include a
769
+ # leading + and country code, followed by digits only (no spaces or dashes), e.g.
770
+ # +12025551234.
764
771
  #
765
772
  # @return [String, nil]
766
773
  optional :phone_number, String
767
774
 
768
775
  # @!method initialize(phone_number: nil)
776
+ # Some parameter documentations has been truncated, see
777
+ # {ModernTreasury::Models::LegalEntity::PhoneNumber} for more details.
778
+ #
769
779
  # A list of phone numbers in E.164 format.
770
780
  #
771
- # @param phone_number [String]
781
+ # @param phone_number [String] A phone number in E.164 format. This format is strictly validated: include a lea
772
782
  end
773
783
 
774
784
  class Regulator < ModernTreasury::Internal::Type::BaseModel
@@ -15,7 +15,8 @@ module ModernTreasury
15
15
  required :line1, String, nil?: true
16
16
 
17
17
  # @!attribute locality
18
- # Locality or City.
18
+ # Locality or City. Use the full city name rather than an abbreviation (e.g. San
19
+ # Francisco).
19
20
  #
20
21
  # @return [String, nil]
21
22
  required :locality, String, nil?: true
@@ -27,7 +28,8 @@ module ModernTreasury
27
28
  required :postal_code, String, nil?: true
28
29
 
29
30
  # @!attribute region
30
- # Region or State.
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.
31
33
  #
32
34
  # @return [String, nil]
33
35
  required :region, String, nil?: true
@@ -59,11 +61,11 @@ module ModernTreasury
59
61
  #
60
62
  # @param line1 [String, nil]
61
63
  #
62
- # @param locality [String, nil] Locality or City.
64
+ # @param locality [String, nil] Locality or City. Use the full city name rather than an abbreviation (e.g. San F
63
65
  #
64
66
  # @param postal_code [String, nil] The postal code of the address.
65
67
  #
66
- # @param region [String, nil] Region or State.
68
+ # @param region [String, nil] Region or State. This field is free-form; for US states, we recommend a two-lett
67
69
  #
68
70
  # @param address_types [Array<Symbol, ModernTreasury::Models::LegalEntityAddressCreateRequest::AddressType>] The types of this address.
69
71
  #
@@ -60,8 +60,8 @@ module ModernTreasury
60
60
  optional :connection_id, String, nil?: true
61
61
 
62
62
  # @!attribute country_of_incorporation
63
- # The country code where the business is incorporated in the ISO 3166-1 alpha-2 or
64
- # alpha-3 formats.
63
+ # The country where the business is incorporated, as an ISO 3166-1 alpha-2 country
64
+ # code (e.g. US).
65
65
  #
66
66
  # @return [String, nil]
67
67
  optional :country_of_incorporation, String, nil?: true
@@ -179,8 +179,8 @@ module ModernTreasury
179
179
  optional :middle_name, String, nil?: true
180
180
 
181
181
  # @!attribute operating_jurisdictions
182
- # A list of countries where the business operates (ISO 3166-1 alpha-2 or alpha-3
183
- # codes).
182
+ # A list of countries where the business operates, as ISO 3166-1 alpha-2 country
183
+ # codes (e.g. ["US", "CA"]).
184
184
  #
185
185
  # @return [Array<String>, nil]
186
186
  optional :operating_jurisdictions, ModernTreasury::Internal::Type::ArrayOf[String]
@@ -303,7 +303,7 @@ module ModernTreasury
303
303
  #
304
304
  # @param connection_id [String, nil] The connection ID for the connection the legal entity is associated with. Defaul
305
305
  #
306
- # @param country_of_incorporation [String, nil] The country code where the business is incorporated in the ISO 3166-1 alpha-2 or
306
+ # @param country_of_incorporation [String, nil] The country where the business is incorporated, as an ISO 3166-1 alpha-2 country
307
307
  #
308
308
  # @param date_formed [Date, nil] A business's formation date (YYYY-MM-DD).
309
309
  #
@@ -339,7 +339,7 @@ module ModernTreasury
339
339
  #
340
340
  # @param middle_name [String, nil] An individual's middle name.
341
341
  #
342
- # @param operating_jurisdictions [Array<String>] A list of countries where the business operates (ISO 3166-1 alpha-2 or alpha-3 c
342
+ # @param operating_jurisdictions [Array<String>] A list of countries where the business operates, as ISO 3166-1 alpha-2 country c
343
343
  #
344
344
  # @param phone_numbers [Array<ModernTreasury::Models::LegalEntityCreateParams::PhoneNumber>]
345
345
  #
@@ -446,14 +446,20 @@ module ModernTreasury
446
446
 
447
447
  class PhoneNumber < ModernTreasury::Internal::Type::BaseModel
448
448
  # @!attribute phone_number
449
+ # A phone number in E.164 format. This format is strictly validated: include a
450
+ # leading + and country code, followed by digits only (no spaces or dashes), e.g.
451
+ # +12025551234.
449
452
  #
450
453
  # @return [String, nil]
451
454
  optional :phone_number, String
452
455
 
453
456
  # @!method initialize(phone_number: nil)
457
+ # Some parameter documentations has been truncated, see
458
+ # {ModernTreasury::Models::LegalEntityCreateParams::PhoneNumber} for more details.
459
+ #
454
460
  # A list of phone numbers in E.164 format.
455
461
  #
456
- # @param phone_number [String]
462
+ # @param phone_number [String] A phone number in E.164 format. This format is strictly validated: include a lea
457
463
  end
458
464
 
459
465
  class Regulator < ModernTreasury::Internal::Type::BaseModel
@@ -43,8 +43,8 @@ module ModernTreasury
43
43
  optional :citizenship_country, String, nil?: true
44
44
 
45
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.
46
+ # The country where the business is incorporated, as an ISO 3166-1 alpha-2 country
47
+ # code (e.g. US).
48
48
  #
49
49
  # @return [String, nil]
50
50
  optional :country_of_incorporation, String, nil?: true
@@ -144,8 +144,8 @@ module ModernTreasury
144
144
  optional :middle_name, String, nil?: true
145
145
 
146
146
  # @!attribute operating_jurisdictions
147
- # A list of countries where the business operates (ISO 3166-1 alpha-2 or alpha-3
148
- # codes).
147
+ # A list of countries where the business operates, as ISO 3166-1 alpha-2 country
148
+ # codes (e.g. ["US", "CA"]).
149
149
  #
150
150
  # @return [Array<String>, nil]
151
151
  optional :operating_jurisdictions, ModernTreasury::Internal::Type::ArrayOf[String]
@@ -264,7 +264,7 @@ module ModernTreasury
264
264
  #
265
265
  # @param citizenship_country [String, nil] The country of citizenship for an individual.
266
266
  #
267
- # @param country_of_incorporation [String, nil] The country code where the business is incorporated in the ISO 3166-1 alpha-2 or
267
+ # @param country_of_incorporation [String, nil] The country where the business is incorporated, as an ISO 3166-1 alpha-2 country
268
268
  #
269
269
  # @param date_formed [Date, nil] A business's formation date (YYYY-MM-DD).
270
270
  #
@@ -296,7 +296,7 @@ module ModernTreasury
296
296
  #
297
297
  # @param middle_name [String, nil] An individual's middle name.
298
298
  #
299
- # @param operating_jurisdictions [Array<String>] A list of countries where the business operates (ISO 3166-1 alpha-2 or alpha-3 c
299
+ # @param operating_jurisdictions [Array<String>] A list of countries where the business operates, as ISO 3166-1 alpha-2 country c
300
300
  #
301
301
  # @param phone_numbers [Array<ModernTreasury::Models::LegalEntityUpdateParams::PhoneNumber>]
302
302
  #
@@ -347,14 +347,20 @@ module ModernTreasury
347
347
 
348
348
  class PhoneNumber < ModernTreasury::Internal::Type::BaseModel
349
349
  # @!attribute phone_number
350
+ # A phone number in E.164 format. This format is strictly validated: include a
351
+ # leading + and country code, followed by digits only (no spaces or dashes), e.g.
352
+ # +12025551234.
350
353
  #
351
354
  # @return [String, nil]
352
355
  optional :phone_number, String
353
356
 
354
357
  # @!method initialize(phone_number: nil)
358
+ # Some parameter documentations has been truncated, see
359
+ # {ModernTreasury::Models::LegalEntityUpdateParams::PhoneNumber} for more details.
360
+ #
355
361
  # A list of phone numbers in E.164 format.
356
362
  #
357
- # @param phone_number [String]
363
+ # @param phone_number [String] A phone number in E.164 format. This format is strictly validated: include a lea
358
364
  end
359
365
 
360
366
  class Regulator < ModernTreasury::Internal::Type::BaseModel
@@ -37,7 +37,8 @@ module ModernTreasury
37
37
  required :employer_name, String, nil?: true
38
38
 
39
39
  # @!attribute employer_state
40
- # The state in which the employer is located.
40
+ # The state in which the employer is located. This field is free-form text; for US
41
+ # states, we recommend a two-letter abbreviation (e.g. CA).
41
42
  #
42
43
  # @return [String, nil]
43
44
  required :employer_state, String, nil?: true
@@ -133,7 +134,7 @@ module ModernTreasury
133
134
  #
134
135
  # @param employer_name [String, nil] The name of the employer.
135
136
  #
136
- # @param employer_state [String, nil] The state in which the employer is located.
137
+ # @param employer_state [String, nil] The state in which the employer is located. This field is free-form text; for US
137
138
  #
138
139
  # @param employment_status [Symbol, ModernTreasury::Models::LegalEntityWealthEmploymentDetail::EmploymentStatus, nil] The employment status of the individual.
139
140
  #
@@ -311,8 +311,9 @@ module ModernTreasury
311
311
  # Additional vendor specific fields for this payment. Data must be represented as
312
312
  # key-value pairs.
313
313
  #
314
- # @return [Object, nil]
315
- optional :vendor_attributes, ModernTreasury::Internal::Type::Unknown
314
+ # @return [Hash{Symbol=>Object}, nil]
315
+ optional :vendor_attributes,
316
+ ModernTreasury::Internal::Type::HashOf[ModernTreasury::Internal::Type::Unknown]
316
317
 
317
318
  # @!method initialize(amount:, direction:, originating_account_id:, type:, accounting: nil, accounting_category_id: nil, accounting_ledger_class_id: nil, charge_bearer: nil, currency: nil, description: nil, effective_date: nil, expires_at: nil, external_id: nil, fallback_type: nil, foreign_exchange_contract: nil, foreign_exchange_indicator: nil, ledger_transaction: nil, ledger_transaction_id: nil, line_items: nil, metadata: nil, nsf_protected: nil, originating_party_name: nil, priority: nil, process_after: nil, purpose: nil, receiving_account: nil, receiving_account_id: nil, reconciliation_status: nil, remittance_information: nil, send_remittance_advice: nil, statement_descriptor: nil, subtype: nil, transaction_monitoring_enabled: nil, ultimate_originating_account_id: nil, ultimate_originating_party_address: nil, ultimate_originating_party_identifier: nil, ultimate_originating_party_name: nil, ultimate_receiving_party_identifier: nil, ultimate_receiving_party_name: nil, vendor_attributes: nil, request_options: {})
318
319
  # Some parameter documentations has been truncated, see
@@ -396,7 +397,7 @@ module ModernTreasury
396
397
  #
397
398
  # @param ultimate_receiving_party_name [String, nil] Name of the ultimate funds recipient.
398
399
  #
399
- # @param vendor_attributes [Object] Additional vendor specific fields for this payment. Data must be represented as
400
+ # @param vendor_attributes [Hash{Symbol=>Object}] Additional vendor specific fields for this payment. Data must be represented as
400
401
  #
401
402
  # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
402
403
 
@@ -833,7 +834,8 @@ module ModernTreasury
833
834
  optional :line2, String
834
835
 
835
836
  # @!attribute locality
836
- # Locality or City.
837
+ # Locality or City. Use the full city name rather than an abbreviation (e.g. San
838
+ # Francisco).
837
839
  #
838
840
  # @return [String, nil]
839
841
  optional :locality, String
@@ -845,12 +847,17 @@ module ModernTreasury
845
847
  optional :postal_code, String
846
848
 
847
849
  # @!attribute region
848
- # Region or State.
850
+ # Region or State. This field is free-form; for US states, we recommend a
851
+ # two-letter code (e.g. CA). Full state names are also accepted.
849
852
  #
850
853
  # @return [String, nil]
851
854
  optional :region, String
852
855
 
853
856
  # @!method initialize(country: nil, line1: nil, line2: nil, locality: nil, postal_code: nil, region: nil)
857
+ # Some parameter documentations has been truncated, see
858
+ # {ModernTreasury::Models::PaymentOrderCreateAsyncParams::UltimateOriginatingPartyAddress}
859
+ # for more details.
860
+ #
854
861
  # Address of the ultimate originator of the payment order.
855
862
  #
856
863
  # @param country [String] Country code conforms to [ISO 3166-1 alpha-2]
@@ -859,11 +866,11 @@ module ModernTreasury
859
866
  #
860
867
  # @param line2 [String]
861
868
  #
862
- # @param locality [String] Locality or City.
869
+ # @param locality [String] Locality or City. Use the full city name rather than an abbreviation (e.g. San F
863
870
  #
864
871
  # @param postal_code [String] The postal code of the address.
865
872
  #
866
- # @param region [String] Region or State.
873
+ # @param region [String] Region or State. This field is free-form; for US states, we recommend a two-lett
867
874
  end
868
875
  end
869
876
  end
@@ -317,8 +317,9 @@ module ModernTreasury
317
317
  # Additional vendor specific fields for this payment. Data must be represented as
318
318
  # key-value pairs.
319
319
  #
320
- # @return [Object, nil]
321
- optional :vendor_attributes, ModernTreasury::Internal::Type::Unknown
320
+ # @return [Hash{Symbol=>Object}, nil]
321
+ optional :vendor_attributes,
322
+ ModernTreasury::Internal::Type::HashOf[ModernTreasury::Internal::Type::Unknown]
322
323
 
323
324
  # @!method initialize(amount:, direction:, originating_account_id:, type:, accounting: nil, accounting_category_id: nil, accounting_ledger_class_id: nil, charge_bearer: nil, currency: nil, description: nil, documents: nil, effective_date: nil, expires_at: nil, external_id: nil, fallback_type: nil, foreign_exchange_contract: nil, foreign_exchange_indicator: nil, ledger_transaction: nil, ledger_transaction_id: nil, line_items: nil, metadata: nil, nsf_protected: nil, originating_party_name: nil, priority: nil, process_after: nil, purpose: nil, receiving_account: nil, receiving_account_id: nil, reconciliation_status: nil, remittance_information: nil, send_remittance_advice: nil, statement_descriptor: nil, subtype: nil, transaction_monitoring_enabled: nil, ultimate_originating_account_id: nil, ultimate_originating_party_address: nil, ultimate_originating_party_identifier: nil, ultimate_originating_party_name: nil, ultimate_receiving_party_identifier: nil, ultimate_receiving_party_name: nil, vendor_attributes: nil, request_options: {})
324
325
  # Some parameter documentations has been truncated, see
@@ -404,7 +405,7 @@ module ModernTreasury
404
405
  #
405
406
  # @param ultimate_receiving_party_name [String, nil] Name of the ultimate funds recipient.
406
407
  #
407
- # @param vendor_attributes [Object] Additional vendor specific fields for this payment. Data must be represented as
408
+ # @param vendor_attributes [Hash{Symbol=>Object}] Additional vendor specific fields for this payment. Data must be represented as
408
409
  #
409
410
  # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
410
411
 
@@ -893,7 +894,8 @@ module ModernTreasury
893
894
  optional :line2, String
894
895
 
895
896
  # @!attribute locality
896
- # Locality or City.
897
+ # Locality or City. Use the full city name rather than an abbreviation (e.g. San
898
+ # Francisco).
897
899
  #
898
900
  # @return [String, nil]
899
901
  optional :locality, String
@@ -905,12 +907,17 @@ module ModernTreasury
905
907
  optional :postal_code, String
906
908
 
907
909
  # @!attribute region
908
- # Region or State.
910
+ # Region or State. This field is free-form; for US states, we recommend a
911
+ # two-letter code (e.g. CA). Full state names are also accepted.
909
912
  #
910
913
  # @return [String, nil]
911
914
  optional :region, String
912
915
 
913
916
  # @!method initialize(country: nil, line1: nil, line2: nil, locality: nil, postal_code: nil, region: nil)
917
+ # Some parameter documentations has been truncated, see
918
+ # {ModernTreasury::Models::PaymentOrderCreateParams::UltimateOriginatingPartyAddress}
919
+ # for more details.
920
+ #
914
921
  # Address of the ultimate originator of the payment order.
915
922
  #
916
923
  # @param country [String] Country code conforms to [ISO 3166-1 alpha-2]
@@ -919,11 +926,11 @@ module ModernTreasury
919
926
  #
920
927
  # @param line2 [String]
921
928
  #
922
- # @param locality [String] Locality or City.
929
+ # @param locality [String] Locality or City. Use the full city name rather than an abbreviation (e.g. San F
923
930
  #
924
931
  # @param postal_code [String] The postal code of the address.
925
932
  #
926
- # @param region [String] Region or State.
933
+ # @param region [String] Region or State. This field is free-form; for US states, we recommend a two-lett
927
934
  end
928
935
  end
929
936
  end
@@ -37,7 +37,8 @@ module ModernTreasury
37
37
  required :employer_name, String, nil?: true
38
38
 
39
39
  # @!attribute employer_state
40
- # The state in which the employer is located.
40
+ # The state in which the employer is located. This field is free-form text; for US
41
+ # states, we recommend a two-letter abbreviation (e.g. CA).
41
42
  #
42
43
  # @return [String, nil]
43
44
  required :employer_state, String, nil?: true
@@ -135,7 +136,7 @@ module ModernTreasury
135
136
  #
136
137
  # @param employer_name [String, nil] The name of the employer.
137
138
  #
138
- # @param employer_state [String, nil] The state in which the employer is located.
139
+ # @param employer_state [String, nil] The state in which the employer is located. This field is free-form text; for US
139
140
  #
140
141
  # @param employment_status [Symbol, ModernTreasury::Models::WealthAndEmploymentDetails::EmploymentStatus, nil] The employment status of the individual.
141
142
  #
@@ -378,8 +378,6 @@ module ModernTreasury
378
378
 
379
379
  LegalEntityUpdateParams = ModernTreasury::Models::LegalEntityUpdateParams
380
380
 
381
- LegalEntityUpdateStatusParams = ModernTreasury::Models::LegalEntityUpdateStatusParams
382
-
383
381
  LegalEntityWealthEmploymentDetail = ModernTreasury::Models::LegalEntityWealthEmploymentDetail
384
382
 
385
383
  LineItem = ModernTreasury::Models::LineItem
@@ -14,7 +14,7 @@ module ModernTreasury
14
14
  #
15
15
  # @param resource_type [Symbol, ModernTreasury::Models::BulkRequestCreateParams::ResourceType] One of payment_order, expected_payment, or ledger_transaction.
16
16
  #
17
- # @param resources [Array<ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest, ModernTreasury::Models::LedgerTransactionCreateRequest, ModernTreasury::Models::LedgerAccountCreateRequest, Object, ModernTreasury::Models::BulkRequestCreateParams::Resource::ID, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::TransactionUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerAccountUpdateRequestWithID>] An array of objects where each object contains the input params for a single `ac
17
+ # @param resources [Array<ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest, ModernTreasury::Models::LedgerTransactionCreateRequest, ModernTreasury::Models::LedgerAccountCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::TransactionCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::ID, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::TransactionUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerAccountUpdateRequestWithID>] An array of objects where each object contains the input params for a single `ac
18
18
  #
19
19
  # @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
20
20
  #
@@ -11,7 +11,7 @@ module ModernTreasury
11
11
  #
12
12
  # create internal account
13
13
  #
14
- # @overload create(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, vendor_attributes: nil, request_options: {})
14
+ # @overload create(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: {})
15
15
  #
16
16
  # @param currency [Symbol, ModernTreasury::Models::InternalAccountCreateParams::Currency] The currency of the internal account. Supports fiat and stablecoin currencies.
17
17
  #
@@ -39,6 +39,8 @@ module ModernTreasury
39
39
  #
40
40
  # @param party_name [String, nil] The legal name of the entity which owns the account.
41
41
  #
42
+ # @param requested_account_number_types [Array<Symbol, ModernTreasury::Models::InternalAccountCreateParams::RequestedAccountNumberType>] An array of account number types requested for provisioning.
43
+ #
42
44
  # @param vendor_attributes [Hash{Symbol=>String}] A hash of vendor specific attributes that will be used when creating the account
43
45
  #
44
46
  # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -6,7 +6,7 @@ module ModernTreasury
6
6
  # Some parameter documentations has been truncated, see
7
7
  # {ModernTreasury::Models::LegalEntityCreateParams} for more details.
8
8
  #
9
- # create legal_entity
9
+ # Create a legal entity. All country fields use ISO 3166-1 alpha-2 (e.g. US).
10
10
  #
11
11
  # @overload create(legal_entity_type:, addresses: nil, bank_settings: nil, business_description: 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: {})
12
12
  #
@@ -26,7 +26,7 @@ module ModernTreasury
26
26
  #
27
27
  # @param connection_id [String, nil] The connection ID for the connection the legal entity is associated with. Defaul
28
28
  #
29
- # @param country_of_incorporation [String, nil] The country code where the business is incorporated in the ISO 3166-1 alpha-2 or
29
+ # @param country_of_incorporation [String, nil] The country where the business is incorporated, as an ISO 3166-1 alpha-2 country
30
30
  #
31
31
  # @param date_formed [Date, nil] A business's formation date (YYYY-MM-DD).
32
32
  #
@@ -62,7 +62,7 @@ module ModernTreasury
62
62
  #
63
63
  # @param middle_name [String, nil] An individual's middle name.
64
64
  #
65
- # @param operating_jurisdictions [Array<String>] A list of countries where the business operates (ISO 3166-1 alpha-2 or alpha-3 c
65
+ # @param operating_jurisdictions [Array<String>] A list of countries where the business operates, as ISO 3166-1 alpha-2 country c
66
66
  #
67
67
  # @param phone_numbers [Array<ModernTreasury::Models::LegalEntityCreateParams::PhoneNumber>]
68
68
  #
@@ -149,7 +149,7 @@ module ModernTreasury
149
149
  #
150
150
  # @param citizenship_country [String, nil] The country of citizenship for an individual.
151
151
  #
152
- # @param country_of_incorporation [String, nil] The country code where the business is incorporated in the ISO 3166-1 alpha-2 or
152
+ # @param country_of_incorporation [String, nil] The country where the business is incorporated, as an ISO 3166-1 alpha-2 country
153
153
  #
154
154
  # @param date_formed [Date, nil] A business's formation date (YYYY-MM-DD).
155
155
  #
@@ -181,7 +181,7 @@ module ModernTreasury
181
181
  #
182
182
  # @param middle_name [String, nil] An individual's middle name.
183
183
  #
184
- # @param operating_jurisdictions [Array<String>] A list of countries where the business operates (ISO 3166-1 alpha-2 or alpha-3 c
184
+ # @param operating_jurisdictions [Array<String>] A list of countries where the business operates, as ISO 3166-1 alpha-2 country c
185
185
  #
186
186
  # @param phone_numbers [Array<ModernTreasury::Models::LegalEntityUpdateParams::PhoneNumber>]
187
187
  #
@@ -268,33 +268,6 @@ module ModernTreasury
268
268
  )
269
269
  end
270
270
 
271
- # Some parameter documentations has been truncated, see
272
- # {ModernTreasury::Models::LegalEntityUpdateStatusParams} for more details.
273
- #
274
- # Update Legal Entity Status (sandbox only)
275
- #
276
- # @overload update_status(id, status:, request_options: {})
277
- #
278
- # @param id [String] Legal entity ID
279
- #
280
- # @param status [Symbol, ModernTreasury::Models::LegalEntityUpdateStatusParams::Status] The target status for the legal entity. One of `active`, `suspended`, or `denied
281
- #
282
- # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
283
- #
284
- # @return [ModernTreasury::Models::LegalEntity]
285
- #
286
- # @see ModernTreasury::Models::LegalEntityUpdateStatusParams
287
- def update_status(id, params)
288
- parsed, options = ModernTreasury::LegalEntityUpdateStatusParams.dump_request(params)
289
- @client.request(
290
- method: :patch,
291
- path: ["api/simulations/legal_entities/%1$s/update_status", id],
292
- body: parsed,
293
- model: ModernTreasury::LegalEntity,
294
- options: options
295
- )
296
- end
297
-
298
271
  # @api private
299
272
  #
300
273
  # @param client [ModernTreasury::Client]
@@ -93,7 +93,7 @@ module ModernTreasury
93
93
  #
94
94
  # @param ultimate_receiving_party_name [String, nil] Name of the ultimate funds recipient.
95
95
  #
96
- # @param vendor_attributes [Object] Additional vendor specific fields for this payment. Data must be represented as
96
+ # @param vendor_attributes [Hash{Symbol=>Object}] Additional vendor specific fields for this payment. Data must be represented as
97
97
  #
98
98
  # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
99
99
  #
@@ -373,7 +373,7 @@ module ModernTreasury
373
373
  #
374
374
  # @param ultimate_receiving_party_name [String, nil] Name of the ultimate funds recipient.
375
375
  #
376
- # @param vendor_attributes [Object] Additional vendor specific fields for this payment. Data must be represented as
376
+ # @param vendor_attributes [Hash{Symbol=>Object}] Additional vendor specific fields for this payment. Data must be represented as
377
377
  #
378
378
  # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
379
379
  #
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module ModernTreasury
4
- VERSION = "0.28.0"
4
+ VERSION = "0.29.0"
5
5
  end
@@ -236,7 +236,6 @@ require_relative "modern_treasury/models/legal_entity_industry_classification"
236
236
  require_relative "modern_treasury/models/legal_entity_list_params"
237
237
  require_relative "modern_treasury/models/legal_entity_retrieve_params"
238
238
  require_relative "modern_treasury/models/legal_entity_update_params"
239
- require_relative "modern_treasury/models/legal_entity_update_status_params"
240
239
  require_relative "modern_treasury/models/legal_entity_wealth_employment_detail"
241
240
  require_relative "modern_treasury/models/line_item"
242
241
  require_relative "modern_treasury/models/line_item_list_params"
@@ -29,7 +29,8 @@ module ModernTreasury
29
29
  sig { returns(T::Boolean) }
30
30
  attr_accessor :live_mode
31
31
 
32
- # Locality or City.
32
+ # Locality or City. Use the full city name rather than an abbreviation (e.g. San
33
+ # Francisco).
33
34
  sig { returns(T.nilable(String)) }
34
35
  attr_accessor :locality
35
36
 
@@ -40,7 +41,8 @@ module ModernTreasury
40
41
  sig { returns(T.nilable(String)) }
41
42
  attr_accessor :postal_code
42
43
 
43
- # Region or State.
44
+ # Region or State. This field is free-form; for US states, we recommend a
45
+ # two-letter code (e.g. CA). Full state names are also accepted.
44
46
  sig { returns(T.nilable(String)) }
45
47
  attr_accessor :region
46
48
 
@@ -72,12 +74,14 @@ module ModernTreasury
72
74
  # This field will be true if this object exists in the live environment or false
73
75
  # if it exists in the test environment.
74
76
  live_mode:,
75
- # Locality or City.
77
+ # Locality or City. Use the full city name rather than an abbreviation (e.g. San
78
+ # Francisco).
76
79
  locality:,
77
80
  object:,
78
81
  # The postal code of the address.
79
82
  postal_code:,
80
- # Region or State.
83
+ # Region or State. This field is free-form; for US states, we recommend a
84
+ # two-letter code (e.g. CA). Full state names are also accepted.
81
85
  region:,
82
86
  updated_at:
83
87
  )