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
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 9dfba7114a6da4f70b3e5b74ff7bdaa3904230ce10f204da37525dba4bce4327
4
- data.tar.gz: 15da306ec9444a2fd903c8547f5619dacbcb11f4ec79e53340ad36f7d95ca38d
3
+ metadata.gz: 20d89043eb349b2e59b81d7a59688622b41f42dc3f5714d425990edd3b68a682
4
+ data.tar.gz: f6f31150adcd14edb1d50dd9c03e070a5f363c58672b9e2bbeff61353989c8c7
5
5
  SHA512:
6
- metadata.gz: 2dd30ba11b96b292bdb48ac58ad59e701735d489050954e87b5ca5e03ed9a107d3e4edf823c52af704eac7162cd9fb782287cdef588ebd308c3062662dba2433
7
- data.tar.gz: d0338d06beb7d97316660c4e92da581a0ba5d1d53a82e3fdd89c86dc4a2079cc4c9e840544a9b27972ed447bc4b51cc78a9e3a67c93b7f1eacb88f7ee8041e1d
6
+ metadata.gz: d8155a7b01dcd215ee593798427901c177fcbe002c908f6270467f770ea100e884c69593d7edba04509311de06590a75b14c436ebe87b6d42547687c793a21bc
7
+ data.tar.gz: c0f62e35829db036915c3d59bb90460e02db5facd4582259fb9e2aaade391fab72d8c5af8b0df8906b63d81760ea13019ab695d98a6809036303b26dfc7697dc
data/CHANGELOG.md CHANGED
@@ -1,5 +1,23 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.29.0 (2026-07-24)
4
+
5
+ Full Changelog: [v0.28.0...v0.29.0](https://github.com/Modern-Treasury/modern-treasury-ruby/compare/v0.28.0...v0.29.0)
6
+
7
+ ### Features
8
+
9
+ * **api:** api update ([a67fb96](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/a67fb96739780ee8800974f64c44dcb865c2a1a6))
10
+ * **api:** api update ([991d181](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/991d1814e2636b6eaf4beb8b02357181741b807b))
11
+ * **api:** api update ([222861e](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/222861ea87ee8aefbc4083347da936eea56c634f))
12
+ * **api:** api update ([1b84642](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/1b84642a83c14a49134dac9bc8a30e17b7dcce7e))
13
+ * **stlc:** configurable CI runner and private-production-repo support in workflow templates ([12a94e4](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/12a94e4c4c91266ce3b7bcc2749b1dbfb534c3ec))
14
+
15
+
16
+ ### Chores
17
+
18
+ * regenerate SDKs from 24f3dc7dc33d9f75e2d589541d11b7a8bd943451 ([9834fb8](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/9834fb8cea0f8729fa96ba1eca12e21f618186dd))
19
+ * regenerate SDKs from e1e0e3ef1458022fd1daec6fcf15bb4695c49a4b ([9bf4ecb](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/9bf4ecbfbf48cdbfa95763f017849ee17b4a31d8))
20
+
3
21
  ## 0.28.0 (2026-07-11)
4
22
 
5
23
  Full Changelog: [v0.27.0...v0.28.0](https://github.com/Modern-Treasury/modern-treasury-ruby/compare/v0.27.0...v0.28.0)
data/README.md CHANGED
@@ -6,8 +6,8 @@ The Modern Treasury Ruby library provides convenient access to the Modern Treasu
6
6
 
7
7
  Use the Modern Treasury MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.
8
8
 
9
- [![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=modern-treasury-mcp&config=eyJuYW1lIjoibW9kZXJuLXRyZWFzdXJ5LW1jcCIsInRyYW5zcG9ydCI6Imh0dHAiLCJ1cmwiOiJodHRwczovL21vZGVybi10cmVhc3VyeS5zdGxtY3AuY29tIiwiaGVhZGVycyI6eyJ4LW1vZGVybi10cmVhc3VyeS1vcmdhbml6YXRpb24taWQiOiJteS1vcmdhbml6YXRpb24tSUQiLCJ4LW1vZGVybi10cmVhc3VyeS1hcGkta2V5IjoiTXkgQVBJIEtleSJ9fQ)
10
- [![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22modern-treasury-mcp%22%2C%22type%22%3A%22http%22%2C%22url%22%3A%22https%3A%2F%2Fmodern-treasury.stlmcp.com%22%2C%22headers%22%3A%7B%22x-modern-treasury-organization-id%22%3A%22my-organization-ID%22%2C%22x-modern-treasury-api-key%22%3A%22My%20API%20Key%22%7D%7D)
9
+ [![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=modern-treasury-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIm1vZGVybi10cmVhc3VyeS1tY3AiXSwiZW52Ijp7Ik1PREVSTl9UUkVBU1VSWV9BUElfS0VZIjoiTXkgQVBJIEtleSIsIk1PREVSTl9UUkVBU1VSWV9PUkdBTklaQVRJT05fSUQiOiJteS1vcmdhbml6YXRpb24tSUQiLCJNT0RFUk5fVFJFQVNVUllfV0VCSE9PS19LRVkiOiJNeSBXZWJob29rIEtleSJ9fQ)
10
+ [![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22modern-treasury-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22modern-treasury-mcp%22%5D%2C%22env%22%3A%7B%22MODERN_TREASURY_API_KEY%22%3A%22My%20API%20Key%22%2C%22MODERN_TREASURY_ORGANIZATION_ID%22%3A%22my-organization-ID%22%2C%22MODERN_TREASURY_WEBHOOK_KEY%22%3A%22My%20Webhook%20Key%22%7D%7D)
11
11
 
12
12
  > Note: You may need to set environment variables in your MCP client.
13
13
 
@@ -24,7 +24,7 @@ To use this gem, install via Bundler by adding the following to your application
24
24
  <!-- x-release-please-start-version -->
25
25
 
26
26
  ```ruby
27
- gem "modern_treasury", "~> 0.28.0"
27
+ gem "modern_treasury", "~> 0.29.0"
28
28
  ```
29
29
 
30
30
  <!-- x-release-please-end -->
@@ -37,7 +37,8 @@ module ModernTreasury
37
37
  required :live_mode, ModernTreasury::Internal::Type::Boolean
38
38
 
39
39
  # @!attribute locality
40
- # Locality or City.
40
+ # Locality or City. Use the full city name rather than an abbreviation (e.g. San
41
+ # Francisco).
41
42
  #
42
43
  # @return [String, nil]
43
44
  required :locality, String, nil?: true
@@ -54,7 +55,8 @@ module ModernTreasury
54
55
  required :postal_code, String, nil?: true
55
56
 
56
57
  # @!attribute region
57
- # Region or State.
58
+ # Region or State. This field is free-form; for US states, we recommend a
59
+ # two-letter code (e.g. CA). Full state names are also accepted.
58
60
  #
59
61
  # @return [String, nil]
60
62
  required :region, String, nil?: true
@@ -80,13 +82,13 @@ module ModernTreasury
80
82
  #
81
83
  # @param live_mode [Boolean] This field will be true if this object exists in the live environment or false i
82
84
  #
83
- # @param locality [String, nil] Locality or City.
85
+ # @param locality [String, nil] Locality or City. Use the full city name rather than an abbreviation (e.g. San F
84
86
  #
85
87
  # @param object [String]
86
88
  #
87
89
  # @param postal_code [String, nil] The postal code of the address.
88
90
  #
89
- # @param region [String, nil] Region or State.
91
+ # @param region [String, nil] Region or State. This field is free-form; for US states, we recommend a two-lett
90
92
  #
91
93
  # @param updated_at [Time]
92
94
  end
@@ -20,7 +20,8 @@ module ModernTreasury
20
20
  optional :line2, String, nil?: true
21
21
 
22
22
  # @!attribute locality
23
- # Locality or City.
23
+ # Locality or City. Use the full city name rather than an abbreviation (e.g. San
24
+ # Francisco).
24
25
  #
25
26
  # @return [String, nil]
26
27
  optional :locality, String, nil?: true
@@ -32,23 +33,27 @@ module ModernTreasury
32
33
  optional :postal_code, String, nil?: true
33
34
 
34
35
  # @!attribute region
35
- # Region or State.
36
+ # Region or State. This field is free-form; for US states, we recommend a
37
+ # two-letter code (e.g. CA). Full state names are also accepted.
36
38
  #
37
39
  # @return [String, nil]
38
40
  optional :region, String, nil?: true
39
41
 
40
42
  # @!method initialize(country: nil, line1: nil, line2: nil, locality: nil, postal_code: nil, region: nil)
43
+ # Some parameter documentations has been truncated, see
44
+ # {ModernTreasury::Models::AddressRequest} for more details.
45
+ #
41
46
  # @param country [String, nil] Country code conforms to [ISO 3166-1 alpha-2]
42
47
  #
43
48
  # @param line1 [String, nil]
44
49
  #
45
50
  # @param line2 [String, nil]
46
51
  #
47
- # @param locality [String, nil] Locality or City.
52
+ # @param locality [String, nil] Locality or City. Use the full city name rather than an abbreviation (e.g. San F
48
53
  #
49
54
  # @param postal_code [String, nil] The postal code of the address.
50
55
  #
51
- # @param region [String, nil] Region or State.
56
+ # @param region [String, nil] Region or State. This field is free-form; for US states, we recommend a two-lett
52
57
  end
53
58
  end
54
59
  end
@@ -23,7 +23,7 @@ module ModernTreasury
23
23
  # An array of objects where each object contains the input params for a single
24
24
  # `action_type` request on a `resource_type` resource
25
25
  #
26
- # @return [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>]
26
+ # @return [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>]
27
27
  required :resources,
28
28
  -> { ModernTreasury::Internal::Type::ArrayOf[union: ModernTreasury::BulkRequestCreateParams::Resource] }
29
29
 
@@ -42,7 +42,7 @@ module ModernTreasury
42
42
  #
43
43
  # @param resource_type [Symbol, ModernTreasury::Models::BulkRequestCreateParams::ResourceType] One of payment_order, expected_payment, or ledger_transaction.
44
44
  #
45
- # @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
45
+ # @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
46
46
  #
47
47
  # @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
48
48
  #
@@ -76,6 +76,7 @@ module ModernTreasury
76
76
  # @return [Array<Symbol>]
77
77
  end
78
78
 
79
+ # At least one of "amount" or "amount_string" is required.
79
80
  module Resource
80
81
  extend ModernTreasury::Internal::Type::Union
81
82
 
@@ -87,7 +88,8 @@ module ModernTreasury
87
88
 
88
89
  variant -> { ModernTreasury::LedgerAccountCreateRequest }
89
90
 
90
- variant ModernTreasury::Internal::Type::Unknown
91
+ # At least one of "amount" or "amount_string" is required.
92
+ variant -> { ModernTreasury::BulkRequestCreateParams::Resource::TransactionCreateRequest }
91
93
 
92
94
  variant -> { ModernTreasury::BulkRequestCreateParams::Resource::ID }
93
95
 
@@ -417,8 +419,9 @@ module ModernTreasury
417
419
  # Additional vendor specific fields for this payment. Data must be represented as
418
420
  # key-value pairs.
419
421
  #
420
- # @return [Object, nil]
421
- optional :vendor_attributes, ModernTreasury::Internal::Type::Unknown
422
+ # @return [Hash{Symbol=>Object}, nil]
423
+ optional :vendor_attributes,
424
+ ModernTreasury::Internal::Type::HashOf[ModernTreasury::Internal::Type::Unknown]
422
425
 
423
426
  # @!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)
424
427
  # Some parameter documentations has been truncated, see
@@ -503,7 +506,7 @@ module ModernTreasury
503
506
  #
504
507
  # @param ultimate_receiving_party_name [String, nil] Name of the ultimate funds recipient.
505
508
  #
506
- # @param vendor_attributes [Object] Additional vendor specific fields for this payment. Data must be represented as
509
+ # @param vendor_attributes [Hash{Symbol=>Object}] Additional vendor specific fields for this payment. Data must be represented as
507
510
 
508
511
  # One of `credit`, `debit`. Describes the direction money is flowing in the
509
512
  # transaction. A `credit` moves money from your account to someone else's. A
@@ -964,7 +967,8 @@ module ModernTreasury
964
967
  optional :line2, String
965
968
 
966
969
  # @!attribute locality
967
- # Locality or City.
970
+ # Locality or City. Use the full city name rather than an abbreviation (e.g. San
971
+ # Francisco).
968
972
  #
969
973
  # @return [String, nil]
970
974
  optional :locality, String
@@ -976,12 +980,17 @@ module ModernTreasury
976
980
  optional :postal_code, String
977
981
 
978
982
  # @!attribute region
979
- # Region or State.
983
+ # Region or State. This field is free-form; for US states, we recommend a
984
+ # two-letter code (e.g. CA). Full state names are also accepted.
980
985
  #
981
986
  # @return [String, nil]
982
987
  optional :region, String
983
988
 
984
989
  # @!method initialize(country: nil, line1: nil, line2: nil, locality: nil, postal_code: nil, region: nil)
990
+ # Some parameter documentations has been truncated, see
991
+ # {ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest::UltimateOriginatingPartyAddress}
992
+ # for more details.
993
+ #
985
994
  # Address of the ultimate originator of the payment order.
986
995
  #
987
996
  # @param country [String] Country code conforms to [ISO 3166-1 alpha-2]
@@ -990,11 +999,11 @@ module ModernTreasury
990
999
  #
991
1000
  # @param line2 [String]
992
1001
  #
993
- # @param locality [String] Locality or City.
1002
+ # @param locality [String] Locality or City. Use the full city name rather than an abbreviation (e.g. San F
994
1003
  #
995
1004
  # @param postal_code [String] The postal code of the address.
996
1005
  #
997
- # @param region [String] Region or State.
1006
+ # @param region [String] Region or State. This field is free-form; for US states, we recommend a two-lett
998
1007
  end
999
1008
  end
1000
1009
 
@@ -1314,6 +1323,162 @@ module ModernTreasury
1314
1323
  end
1315
1324
  end
1316
1325
 
1326
+ class TransactionCreateRequest < ModernTreasury::Internal::Type::BaseModel
1327
+ # @!attribute as_of_date
1328
+ # The date on which the transaction occurred.
1329
+ #
1330
+ # @return [Date, nil]
1331
+ required :as_of_date, Date, nil?: true
1332
+
1333
+ # @!attribute direction
1334
+ # Either `credit` or `debit`.
1335
+ #
1336
+ # @return [String]
1337
+ required :direction, String
1338
+
1339
+ # @!attribute internal_account_id
1340
+ # The ID of the relevant Internal Account.
1341
+ #
1342
+ # @return [String]
1343
+ required :internal_account_id, String
1344
+
1345
+ # @!attribute vendor_code
1346
+ # When applicable, the bank-given code that determines the transaction's category.
1347
+ # For most banks this is the BAI2/BTRS transaction code.
1348
+ #
1349
+ # @return [String, nil]
1350
+ required :vendor_code, String, nil?: true
1351
+
1352
+ # @!attribute vendor_code_type
1353
+ # The type of `vendor_code` being reported. Can be one of `bai2`, `bankprov`,
1354
+ # `bnk_dev`, `cleartouch`, `currencycloud`, `cross_river`, `dc_bank`, `dwolla`,
1355
+ # `evolve`, `goldman_sachs`, `iso20022`, `jpmc`, `mx`, `silvergate`, `swift`,
1356
+ # `us_bank`, or others.
1357
+ #
1358
+ # @return [String, nil]
1359
+ required :vendor_code_type, String, nil?: true
1360
+
1361
+ # @!attribute amount
1362
+ # Value in specified currency's smallest unit. e.g. $10 would be represented
1363
+ # as 1000.
1364
+ #
1365
+ # @return [Integer, nil]
1366
+ optional :amount, Integer
1367
+
1368
+ # @!attribute amount_string
1369
+ # The transaction amount as a string, preserving full precision for values that
1370
+ # may exceed safe integer limits in some languages.
1371
+ #
1372
+ # @return [String, nil]
1373
+ optional :amount_string, String
1374
+
1375
+ # @!attribute metadata
1376
+ # Additional data represented as key-value pairs. Both the key and value must be
1377
+ # strings.
1378
+ #
1379
+ # @return [Hash{Symbol=>String}, nil]
1380
+ optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
1381
+
1382
+ # @!attribute posted
1383
+ # This field will be `true` if the transaction has posted to the account.
1384
+ #
1385
+ # @return [Boolean, nil]
1386
+ optional :posted, ModernTreasury::Internal::Type::Boolean
1387
+
1388
+ # @!attribute type
1389
+ # The type of the transaction. Examples could be
1390
+ # `card, `ach`, `wire`, `check`, `rtp`, or `book`.
1391
+ #
1392
+ # @return [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::TransactionCreateRequest::Type, nil]
1393
+ optional :type,
1394
+ enum: -> {
1395
+ ModernTreasury::BulkRequestCreateParams::Resource::TransactionCreateRequest::Type
1396
+ },
1397
+ nil?: true
1398
+
1399
+ # @!attribute vendor_customer_id
1400
+ # An identifier given to this transaction by the bank, often `null`.
1401
+ #
1402
+ # @return [String, nil]
1403
+ optional :vendor_customer_id, String, nil?: true
1404
+
1405
+ # @!attribute vendor_description
1406
+ # The transaction detail text that often appears in on your bank statement and in
1407
+ # your banking portal.
1408
+ #
1409
+ # @return [String, nil]
1410
+ optional :vendor_description, String, nil?: true
1411
+
1412
+ # @!method initialize(as_of_date:, direction:, internal_account_id:, vendor_code:, vendor_code_type:, amount: nil, amount_string: nil, metadata: nil, posted: nil, type: nil, vendor_customer_id: nil, vendor_description: nil)
1413
+ # Some parameter documentations has been truncated, see
1414
+ # {ModernTreasury::Models::BulkRequestCreateParams::Resource::TransactionCreateRequest}
1415
+ # for more details.
1416
+ #
1417
+ # At least one of "amount" or "amount_string" is required.
1418
+ #
1419
+ # @param as_of_date [Date, nil] The date on which the transaction occurred.
1420
+ #
1421
+ # @param direction [String] Either `credit` or `debit`.
1422
+ #
1423
+ # @param internal_account_id [String] The ID of the relevant Internal Account.
1424
+ #
1425
+ # @param vendor_code [String, nil] When applicable, the bank-given code that determines the transaction's category.
1426
+ #
1427
+ # @param vendor_code_type [String, nil] The type of `vendor_code` being reported. Can be one of `bai2`, `bankprov`, `bnk
1428
+ #
1429
+ # @param amount [Integer] Value in specified currency's smallest unit. e.g. $10 would be represented as 10
1430
+ #
1431
+ # @param amount_string [String] The transaction amount as a string, preserving full precision for values that ma
1432
+ #
1433
+ # @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
1434
+ #
1435
+ # @param posted [Boolean] This field will be `true` if the transaction has posted to the account.
1436
+ #
1437
+ # @param type [Symbol, ModernTreasury::Models::BulkRequestCreateParams::Resource::TransactionCreateRequest::Type, nil] The type of the transaction. Examples could be `card, `ach`, `wire`, `check`, `r
1438
+ #
1439
+ # @param vendor_customer_id [String, nil] An identifier given to this transaction by the bank, often `null`.
1440
+ #
1441
+ # @param vendor_description [String, nil] The transaction detail text that often appears in on your bank statement and in
1442
+
1443
+ # The type of the transaction. Examples could be
1444
+ # `card, `ach`, `wire`, `check`, `rtp`, or `book`.
1445
+ #
1446
+ # @see ModernTreasury::Models::BulkRequestCreateParams::Resource::TransactionCreateRequest#type
1447
+ module Type
1448
+ extend ModernTreasury::Internal::Type::Enum
1449
+
1450
+ ACH = :ach
1451
+ AU_BECS = :au_becs
1452
+ BACS = :bacs
1453
+ BOOK = :book
1454
+ CARD = :card
1455
+ CHATS = :chats
1456
+ CHECK = :check
1457
+ CROSS_BORDER = :cross_border
1458
+ DK_NETS = :dk_nets
1459
+ EFT = :eft
1460
+ GB_FPS = :gb_fps
1461
+ MASAV = :masav
1462
+ MX_CCEN = :mx_ccen
1463
+ NEFT = :neft
1464
+ NICS = :nics
1465
+ NZ_BECS = :nz_becs
1466
+ PL_ELIXIR = :pl_elixir
1467
+ RTP = :rtp
1468
+ SE_BANKGIROT = :se_bankgirot
1469
+ SEPA = :sepa
1470
+ SG_GIRO = :sg_giro
1471
+ SIC = :sic
1472
+ STABLECOIN = :stablecoin
1473
+ WIRE = :wire
1474
+ ZENGIN = :zengin
1475
+ OTHER = :other
1476
+
1477
+ # @!method self.values
1478
+ # @return [Array<Symbol>]
1479
+ end
1480
+ end
1481
+
1317
1482
  class ID < ModernTreasury::Internal::Type::BaseModel
1318
1483
  # @!attribute id
1319
1484
  #
@@ -2633,7 +2798,7 @@ module ModernTreasury
2633
2798
  end
2634
2799
 
2635
2800
  # @!method self.variants
2636
- # @return [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)]
2801
+ # @return [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)]
2637
2802
  end
2638
2803
  end
2639
2804
  end
@@ -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
@@ -185,8 +185,8 @@ module ModernTreasury
185
185
  required :object, String
186
186
 
187
187
  # @!attribute operating_jurisdictions
188
- # A list of countries where the business operates (ISO 3166-1 alpha-2 or alpha-3
189
- # codes).
188
+ # A list of countries where the business operates, as ISO 3166-1 alpha-2 country
189
+ # codes (e.g. ["US", "CA"]).
190
190
  #
191
191
  # @return [Array<String>]
192
192
  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
  #
@@ -363,7 +363,7 @@ module ModernTreasury
363
363
  #
364
364
  # @param object [String]
365
365
  #
366
- # @param operating_jurisdictions [Array<String>] A list of countries where the business operates (ISO 3166-1 alpha-2 or alpha-3 c
366
+ # @param operating_jurisdictions [Array<String>] A list of countries where the business operates, as ISO 3166-1 alpha-2 country c
367
367
  #
368
368
  # @param phone_numbers [Array<ModernTreasury::Models::ChildLegalEntity::PhoneNumber>]
369
369
  #
@@ -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::ChildLegalEntity::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
@@ -50,8 +50,8 @@ module ModernTreasury
50
50
  optional :connection_id, String, nil?: true
51
51
 
52
52
  # @!attribute country_of_incorporation
53
- # The country code where the business is incorporated in the ISO 3166-1 alpha-2 or
54
- # alpha-3 formats.
53
+ # The country where the business is incorporated, as an ISO 3166-1 alpha-2 country
54
+ # code (e.g. US).
55
55
  #
56
56
  # @return [String, nil]
57
57
  optional :country_of_incorporation, String, nil?: true
@@ -177,8 +177,8 @@ module ModernTreasury
177
177
  optional :middle_name, String, nil?: true
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>, nil]
184
184
  optional :operating_jurisdictions, ModernTreasury::Internal::Type::ArrayOf[String]
@@ -299,7 +299,7 @@ module ModernTreasury
299
299
  #
300
300
  # @param connection_id [String, nil] The connection ID for the connection the legal entity is associated with. Defaul
301
301
  #
302
- # @param country_of_incorporation [String, nil] The country code where the business is incorporated in the ISO 3166-1 alpha-2 or
302
+ # @param country_of_incorporation [String, nil] The country where the business is incorporated, as an ISO 3166-1 alpha-2 country
303
303
  #
304
304
  # @param date_formed [Date, nil] A business's formation date (YYYY-MM-DD).
305
305
  #
@@ -337,7 +337,7 @@ module ModernTreasury
337
337
  #
338
338
  # @param middle_name [String, nil] An individual's middle name.
339
339
  #
340
- # @param operating_jurisdictions [Array<String>] A list of countries where the business operates (ISO 3166-1 alpha-2 or alpha-3 c
340
+ # @param operating_jurisdictions [Array<String>] A list of countries where the business operates, as ISO 3166-1 alpha-2 country c
341
341
  #
342
342
  # @param phone_numbers [Array<ModernTreasury::Models::ChildLegalEntityCreate::PhoneNumber>]
343
343
  #
@@ -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::ChildLegalEntityCreate::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
@@ -82,8 +82,8 @@ module ModernTreasury
82
82
  optional :connection_id, String, nil?: true
83
83
 
84
84
  # @!attribute country_of_incorporation
85
- # The country code where the business is incorporated in the ISO 3166-1 alpha-2 or
86
- # alpha-3 formats.
85
+ # The country where the business is incorporated, as an ISO 3166-1 alpha-2 country
86
+ # code (e.g. US).
87
87
  #
88
88
  # @return [String, nil]
89
89
  optional :country_of_incorporation, String, nil?: true
@@ -208,8 +208,8 @@ module ModernTreasury
208
208
  optional :middle_name, String, nil?: true
209
209
 
210
210
  # @!attribute operating_jurisdictions
211
- # A list of countries where the business operates (ISO 3166-1 alpha-2 or alpha-3
212
- # codes).
211
+ # A list of countries where the business operates, as ISO 3166-1 alpha-2 country
212
+ # codes (e.g. ["US", "CA"]).
213
213
  #
214
214
  # @return [Array<String>, nil]
215
215
  optional :operating_jurisdictions, ModernTreasury::Internal::Type::ArrayOf[String]
@@ -337,7 +337,7 @@ module ModernTreasury
337
337
  #
338
338
  # @param connection_id [String, nil] The connection ID for the connection the legal entity is associated with. Defaul
339
339
  #
340
- # @param country_of_incorporation [String, nil] The country code where the business is incorporated in the ISO 3166-1 alpha-2 or
340
+ # @param country_of_incorporation [String, nil] The country where the business is incorporated, as an ISO 3166-1 alpha-2 country
341
341
  #
342
342
  # @param date_formed [Date, nil] A business's formation date (YYYY-MM-DD).
343
343
  #
@@ -375,7 +375,7 @@ module ModernTreasury
375
375
  #
376
376
  # @param middle_name [String, nil] An individual's middle name.
377
377
  #
378
- # @param operating_jurisdictions [Array<String>] A list of countries where the business operates (ISO 3166-1 alpha-2 or alpha-3 c
378
+ # @param operating_jurisdictions [Array<String>] A list of countries where the business operates, as ISO 3166-1 alpha-2 country c
379
379
  #
380
380
  # @param phone_numbers [Array<ModernTreasury::Models::ConnectionLegalEntityCreateParams::LegalEntity::PhoneNumber>]
381
381
  #
@@ -485,14 +485,21 @@ module ModernTreasury
485
485
 
486
486
  class PhoneNumber < ModernTreasury::Internal::Type::BaseModel
487
487
  # @!attribute phone_number
488
+ # A phone number in E.164 format. This format is strictly validated: include a
489
+ # leading + and country code, followed by digits only (no spaces or dashes), e.g.
490
+ # +12025551234.
488
491
  #
489
492
  # @return [String, nil]
490
493
  optional :phone_number, String
491
494
 
492
495
  # @!method initialize(phone_number: nil)
496
+ # Some parameter documentations has been truncated, see
497
+ # {ModernTreasury::Models::ConnectionLegalEntityCreateParams::LegalEntity::PhoneNumber}
498
+ # for more details.
499
+ #
493
500
  # A list of phone numbers in E.164 format.
494
501
  #
495
- # @param phone_number [String]
502
+ # @param phone_number [String] A phone number in E.164 format. This format is strictly validated: include a lea
496
503
  end
497
504
 
498
505
  class Regulator < ModernTreasury::Internal::Type::BaseModel