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
@@ -21,7 +21,8 @@ module ModernTreasury
21
21
  sig { returns(T.nilable(String)) }
22
22
  attr_accessor :line2
23
23
 
24
- # Locality or City.
24
+ # Locality or City. Use the full city name rather than an abbreviation (e.g. San
25
+ # Francisco).
25
26
  sig { returns(T.nilable(String)) }
26
27
  attr_accessor :locality
27
28
 
@@ -29,7 +30,8 @@ module ModernTreasury
29
30
  sig { returns(T.nilable(String)) }
30
31
  attr_accessor :postal_code
31
32
 
32
- # Region or State.
33
+ # Region or State. This field is free-form; for US states, we recommend a
34
+ # two-letter code (e.g. CA). Full state names are also accepted.
33
35
  sig { returns(T.nilable(String)) }
34
36
  attr_accessor :region
35
37
 
@@ -48,11 +50,13 @@ module ModernTreasury
48
50
  country: nil,
49
51
  line1: nil,
50
52
  line2: nil,
51
- # Locality or City.
53
+ # Locality or City. Use the full city name rather than an abbreviation (e.g. San
54
+ # Francisco).
52
55
  locality: nil,
53
56
  # The postal code of the address.
54
57
  postal_code: nil,
55
- # 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.
56
60
  region: nil
57
61
  )
58
62
  end
@@ -36,7 +36,7 @@ module ModernTreasury
36
36
  ModernTreasury::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest,
37
37
  ModernTreasury::LedgerTransactionCreateRequest,
38
38
  ModernTreasury::LedgerAccountCreateRequest,
39
- T.anything,
39
+ ModernTreasury::BulkRequestCreateParams::Resource::TransactionCreateRequest,
40
40
  ModernTreasury::BulkRequestCreateParams::Resource::ID,
41
41
  ModernTreasury::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID,
42
42
  ModernTreasury::BulkRequestCreateParams::Resource::ExpectedPaymentUpdateRequestWithID,
@@ -70,7 +70,7 @@ module ModernTreasury
70
70
  ModernTreasury::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::OrHash,
71
71
  ModernTreasury::LedgerTransactionCreateRequest::OrHash,
72
72
  ModernTreasury::LedgerAccountCreateRequest::OrHash,
73
- T.anything,
73
+ ModernTreasury::BulkRequestCreateParams::Resource::TransactionCreateRequest::OrHash,
74
74
  ModernTreasury::BulkRequestCreateParams::Resource::ID::OrHash,
75
75
  ModernTreasury::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID::OrHash,
76
76
  ModernTreasury::BulkRequestCreateParams::Resource::ExpectedPaymentUpdateRequestWithID::OrHash,
@@ -112,7 +112,7 @@ module ModernTreasury
112
112
  ModernTreasury::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest,
113
113
  ModernTreasury::LedgerTransactionCreateRequest,
114
114
  ModernTreasury::LedgerAccountCreateRequest,
115
- T.anything,
115
+ ModernTreasury::BulkRequestCreateParams::Resource::TransactionCreateRequest,
116
116
  ModernTreasury::BulkRequestCreateParams::Resource::ID,
117
117
  ModernTreasury::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID,
118
118
  ModernTreasury::BulkRequestCreateParams::Resource::ExpectedPaymentUpdateRequestWithID,
@@ -223,6 +223,7 @@ module ModernTreasury
223
223
  end
224
224
  end
225
225
 
226
+ # At least one of "amount" or "amount_string" is required.
226
227
  module Resource
227
228
  extend ModernTreasury::Internal::Type::Union
228
229
 
@@ -233,7 +234,7 @@ module ModernTreasury
233
234
  ModernTreasury::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest,
234
235
  ModernTreasury::LedgerTransactionCreateRequest,
235
236
  ModernTreasury::LedgerAccountCreateRequest,
236
- T.anything,
237
+ ModernTreasury::BulkRequestCreateParams::Resource::TransactionCreateRequest,
237
238
  ModernTreasury::BulkRequestCreateParams::Resource::ID,
238
239
  ModernTreasury::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID,
239
240
  ModernTreasury::BulkRequestCreateParams::Resource::ExpectedPaymentUpdateRequestWithID,
@@ -617,10 +618,10 @@ module ModernTreasury
617
618
 
618
619
  # Additional vendor specific fields for this payment. Data must be represented as
619
620
  # key-value pairs.
620
- sig { returns(T.nilable(T.anything)) }
621
+ sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
621
622
  attr_reader :vendor_attributes
622
623
 
623
- sig { params(vendor_attributes: T.anything).void }
624
+ sig { params(vendor_attributes: T::Hash[Symbol, T.anything]).void }
624
625
  attr_writer :vendor_attributes
625
626
 
626
627
  sig do
@@ -683,7 +684,7 @@ module ModernTreasury
683
684
  ultimate_originating_party_name: T.nilable(String),
684
685
  ultimate_receiving_party_identifier: T.nilable(String),
685
686
  ultimate_receiving_party_name: T.nilable(String),
686
- vendor_attributes: T.anything
687
+ vendor_attributes: T::Hash[Symbol, T.anything]
687
688
  ).returns(T.attached_class)
688
689
  end
689
690
  def self.new(
@@ -884,7 +885,7 @@ module ModernTreasury
884
885
  ultimate_originating_party_name: T.nilable(String),
885
886
  ultimate_receiving_party_identifier: T.nilable(String),
886
887
  ultimate_receiving_party_name: T.nilable(String),
887
- vendor_attributes: T.anything
888
+ vendor_attributes: T::Hash[Symbol, T.anything]
888
889
  }
889
890
  )
890
891
  end
@@ -2036,7 +2037,8 @@ module ModernTreasury
2036
2037
  sig { params(line2: String).void }
2037
2038
  attr_writer :line2
2038
2039
 
2039
- # Locality or City.
2040
+ # Locality or City. Use the full city name rather than an abbreviation (e.g. San
2041
+ # Francisco).
2040
2042
  sig { returns(T.nilable(String)) }
2041
2043
  attr_reader :locality
2042
2044
 
@@ -2050,7 +2052,8 @@ module ModernTreasury
2050
2052
  sig { params(postal_code: String).void }
2051
2053
  attr_writer :postal_code
2052
2054
 
2053
- # Region or State.
2055
+ # Region or State. This field is free-form; for US states, we recommend a
2056
+ # two-letter code (e.g. CA). Full state names are also accepted.
2054
2057
  sig { returns(T.nilable(String)) }
2055
2058
  attr_reader :region
2056
2059
 
@@ -2073,11 +2076,13 @@ module ModernTreasury
2073
2076
  country: nil,
2074
2077
  line1: nil,
2075
2078
  line2: nil,
2076
- # Locality or City.
2079
+ # Locality or City. Use the full city name rather than an abbreviation (e.g. San
2080
+ # Francisco).
2077
2081
  locality: nil,
2078
2082
  # The postal code of the address.
2079
2083
  postal_code: nil,
2080
- # Region or State.
2084
+ # Region or State. This field is free-form; for US states, we recommend a
2085
+ # two-letter code (e.g. CA). Full state names are also accepted.
2081
2086
  region: nil
2082
2087
  )
2083
2088
  end
@@ -2614,6 +2619,328 @@ module ModernTreasury
2614
2619
  end
2615
2620
  end
2616
2621
 
2622
+ class TransactionCreateRequest < ModernTreasury::Internal::Type::BaseModel
2623
+ OrHash =
2624
+ T.type_alias do
2625
+ T.any(
2626
+ ModernTreasury::BulkRequestCreateParams::Resource::TransactionCreateRequest,
2627
+ ModernTreasury::Internal::AnyHash
2628
+ )
2629
+ end
2630
+
2631
+ # The date on which the transaction occurred.
2632
+ sig { returns(T.nilable(Date)) }
2633
+ attr_accessor :as_of_date
2634
+
2635
+ # Either `credit` or `debit`.
2636
+ sig { returns(String) }
2637
+ attr_accessor :direction
2638
+
2639
+ # The ID of the relevant Internal Account.
2640
+ sig { returns(String) }
2641
+ attr_accessor :internal_account_id
2642
+
2643
+ # When applicable, the bank-given code that determines the transaction's category.
2644
+ # For most banks this is the BAI2/BTRS transaction code.
2645
+ sig { returns(T.nilable(String)) }
2646
+ attr_accessor :vendor_code
2647
+
2648
+ # The type of `vendor_code` being reported. Can be one of `bai2`, `bankprov`,
2649
+ # `bnk_dev`, `cleartouch`, `currencycloud`, `cross_river`, `dc_bank`, `dwolla`,
2650
+ # `evolve`, `goldman_sachs`, `iso20022`, `jpmc`, `mx`, `silvergate`, `swift`,
2651
+ # `us_bank`, or others.
2652
+ sig { returns(T.nilable(String)) }
2653
+ attr_accessor :vendor_code_type
2654
+
2655
+ # Value in specified currency's smallest unit. e.g. $10 would be represented
2656
+ # as 1000.
2657
+ sig { returns(T.nilable(Integer)) }
2658
+ attr_reader :amount
2659
+
2660
+ sig { params(amount: Integer).void }
2661
+ attr_writer :amount
2662
+
2663
+ # The transaction amount as a string, preserving full precision for values that
2664
+ # may exceed safe integer limits in some languages.
2665
+ sig { returns(T.nilable(String)) }
2666
+ attr_reader :amount_string
2667
+
2668
+ sig { params(amount_string: String).void }
2669
+ attr_writer :amount_string
2670
+
2671
+ # Additional data represented as key-value pairs. Both the key and value must be
2672
+ # strings.
2673
+ sig { returns(T.nilable(T::Hash[Symbol, String])) }
2674
+ attr_reader :metadata
2675
+
2676
+ sig { params(metadata: T::Hash[Symbol, String]).void }
2677
+ attr_writer :metadata
2678
+
2679
+ # This field will be `true` if the transaction has posted to the account.
2680
+ sig { returns(T.nilable(T::Boolean)) }
2681
+ attr_reader :posted
2682
+
2683
+ sig { params(posted: T::Boolean).void }
2684
+ attr_writer :posted
2685
+
2686
+ # The type of the transaction. Examples could be
2687
+ # `card, `ach`, `wire`, `check`, `rtp`, or `book`.
2688
+ sig do
2689
+ returns(
2690
+ T.nilable(
2691
+ ModernTreasury::BulkRequestCreateParams::Resource::TransactionCreateRequest::Type::OrSymbol
2692
+ )
2693
+ )
2694
+ end
2695
+ attr_accessor :type
2696
+
2697
+ # An identifier given to this transaction by the bank, often `null`.
2698
+ sig { returns(T.nilable(String)) }
2699
+ attr_accessor :vendor_customer_id
2700
+
2701
+ # The transaction detail text that often appears in on your bank statement and in
2702
+ # your banking portal.
2703
+ sig { returns(T.nilable(String)) }
2704
+ attr_accessor :vendor_description
2705
+
2706
+ # At least one of "amount" or "amount_string" is required.
2707
+ sig do
2708
+ params(
2709
+ as_of_date: T.nilable(Date),
2710
+ direction: String,
2711
+ internal_account_id: String,
2712
+ vendor_code: T.nilable(String),
2713
+ vendor_code_type: T.nilable(String),
2714
+ amount: Integer,
2715
+ amount_string: String,
2716
+ metadata: T::Hash[Symbol, String],
2717
+ posted: T::Boolean,
2718
+ type:
2719
+ T.nilable(
2720
+ ModernTreasury::BulkRequestCreateParams::Resource::TransactionCreateRequest::Type::OrSymbol
2721
+ ),
2722
+ vendor_customer_id: T.nilable(String),
2723
+ vendor_description: T.nilable(String)
2724
+ ).returns(T.attached_class)
2725
+ end
2726
+ def self.new(
2727
+ # The date on which the transaction occurred.
2728
+ as_of_date:,
2729
+ # Either `credit` or `debit`.
2730
+ direction:,
2731
+ # The ID of the relevant Internal Account.
2732
+ internal_account_id:,
2733
+ # When applicable, the bank-given code that determines the transaction's category.
2734
+ # For most banks this is the BAI2/BTRS transaction code.
2735
+ vendor_code:,
2736
+ # The type of `vendor_code` being reported. Can be one of `bai2`, `bankprov`,
2737
+ # `bnk_dev`, `cleartouch`, `currencycloud`, `cross_river`, `dc_bank`, `dwolla`,
2738
+ # `evolve`, `goldman_sachs`, `iso20022`, `jpmc`, `mx`, `silvergate`, `swift`,
2739
+ # `us_bank`, or others.
2740
+ vendor_code_type:,
2741
+ # Value in specified currency's smallest unit. e.g. $10 would be represented
2742
+ # as 1000.
2743
+ amount: nil,
2744
+ # The transaction amount as a string, preserving full precision for values that
2745
+ # may exceed safe integer limits in some languages.
2746
+ amount_string: nil,
2747
+ # Additional data represented as key-value pairs. Both the key and value must be
2748
+ # strings.
2749
+ metadata: nil,
2750
+ # This field will be `true` if the transaction has posted to the account.
2751
+ posted: nil,
2752
+ # The type of the transaction. Examples could be
2753
+ # `card, `ach`, `wire`, `check`, `rtp`, or `book`.
2754
+ type: nil,
2755
+ # An identifier given to this transaction by the bank, often `null`.
2756
+ vendor_customer_id: nil,
2757
+ # The transaction detail text that often appears in on your bank statement and in
2758
+ # your banking portal.
2759
+ vendor_description: nil
2760
+ )
2761
+ end
2762
+
2763
+ sig do
2764
+ override.returns(
2765
+ {
2766
+ as_of_date: T.nilable(Date),
2767
+ direction: String,
2768
+ internal_account_id: String,
2769
+ vendor_code: T.nilable(String),
2770
+ vendor_code_type: T.nilable(String),
2771
+ amount: Integer,
2772
+ amount_string: String,
2773
+ metadata: T::Hash[Symbol, String],
2774
+ posted: T::Boolean,
2775
+ type:
2776
+ T.nilable(
2777
+ ModernTreasury::BulkRequestCreateParams::Resource::TransactionCreateRequest::Type::OrSymbol
2778
+ ),
2779
+ vendor_customer_id: T.nilable(String),
2780
+ vendor_description: T.nilable(String)
2781
+ }
2782
+ )
2783
+ end
2784
+ def to_hash
2785
+ end
2786
+
2787
+ # The type of the transaction. Examples could be
2788
+ # `card, `ach`, `wire`, `check`, `rtp`, or `book`.
2789
+ module Type
2790
+ extend ModernTreasury::Internal::Type::Enum
2791
+
2792
+ TaggedSymbol =
2793
+ T.type_alias do
2794
+ T.all(
2795
+ Symbol,
2796
+ ModernTreasury::BulkRequestCreateParams::Resource::TransactionCreateRequest::Type
2797
+ )
2798
+ end
2799
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
2800
+
2801
+ ACH =
2802
+ T.let(
2803
+ :ach,
2804
+ ModernTreasury::BulkRequestCreateParams::Resource::TransactionCreateRequest::Type::TaggedSymbol
2805
+ )
2806
+ AU_BECS =
2807
+ T.let(
2808
+ :au_becs,
2809
+ ModernTreasury::BulkRequestCreateParams::Resource::TransactionCreateRequest::Type::TaggedSymbol
2810
+ )
2811
+ BACS =
2812
+ T.let(
2813
+ :bacs,
2814
+ ModernTreasury::BulkRequestCreateParams::Resource::TransactionCreateRequest::Type::TaggedSymbol
2815
+ )
2816
+ BOOK =
2817
+ T.let(
2818
+ :book,
2819
+ ModernTreasury::BulkRequestCreateParams::Resource::TransactionCreateRequest::Type::TaggedSymbol
2820
+ )
2821
+ CARD =
2822
+ T.let(
2823
+ :card,
2824
+ ModernTreasury::BulkRequestCreateParams::Resource::TransactionCreateRequest::Type::TaggedSymbol
2825
+ )
2826
+ CHATS =
2827
+ T.let(
2828
+ :chats,
2829
+ ModernTreasury::BulkRequestCreateParams::Resource::TransactionCreateRequest::Type::TaggedSymbol
2830
+ )
2831
+ CHECK =
2832
+ T.let(
2833
+ :check,
2834
+ ModernTreasury::BulkRequestCreateParams::Resource::TransactionCreateRequest::Type::TaggedSymbol
2835
+ )
2836
+ CROSS_BORDER =
2837
+ T.let(
2838
+ :cross_border,
2839
+ ModernTreasury::BulkRequestCreateParams::Resource::TransactionCreateRequest::Type::TaggedSymbol
2840
+ )
2841
+ DK_NETS =
2842
+ T.let(
2843
+ :dk_nets,
2844
+ ModernTreasury::BulkRequestCreateParams::Resource::TransactionCreateRequest::Type::TaggedSymbol
2845
+ )
2846
+ EFT =
2847
+ T.let(
2848
+ :eft,
2849
+ ModernTreasury::BulkRequestCreateParams::Resource::TransactionCreateRequest::Type::TaggedSymbol
2850
+ )
2851
+ GB_FPS =
2852
+ T.let(
2853
+ :gb_fps,
2854
+ ModernTreasury::BulkRequestCreateParams::Resource::TransactionCreateRequest::Type::TaggedSymbol
2855
+ )
2856
+ MASAV =
2857
+ T.let(
2858
+ :masav,
2859
+ ModernTreasury::BulkRequestCreateParams::Resource::TransactionCreateRequest::Type::TaggedSymbol
2860
+ )
2861
+ MX_CCEN =
2862
+ T.let(
2863
+ :mx_ccen,
2864
+ ModernTreasury::BulkRequestCreateParams::Resource::TransactionCreateRequest::Type::TaggedSymbol
2865
+ )
2866
+ NEFT =
2867
+ T.let(
2868
+ :neft,
2869
+ ModernTreasury::BulkRequestCreateParams::Resource::TransactionCreateRequest::Type::TaggedSymbol
2870
+ )
2871
+ NICS =
2872
+ T.let(
2873
+ :nics,
2874
+ ModernTreasury::BulkRequestCreateParams::Resource::TransactionCreateRequest::Type::TaggedSymbol
2875
+ )
2876
+ NZ_BECS =
2877
+ T.let(
2878
+ :nz_becs,
2879
+ ModernTreasury::BulkRequestCreateParams::Resource::TransactionCreateRequest::Type::TaggedSymbol
2880
+ )
2881
+ PL_ELIXIR =
2882
+ T.let(
2883
+ :pl_elixir,
2884
+ ModernTreasury::BulkRequestCreateParams::Resource::TransactionCreateRequest::Type::TaggedSymbol
2885
+ )
2886
+ RTP =
2887
+ T.let(
2888
+ :rtp,
2889
+ ModernTreasury::BulkRequestCreateParams::Resource::TransactionCreateRequest::Type::TaggedSymbol
2890
+ )
2891
+ SE_BANKGIROT =
2892
+ T.let(
2893
+ :se_bankgirot,
2894
+ ModernTreasury::BulkRequestCreateParams::Resource::TransactionCreateRequest::Type::TaggedSymbol
2895
+ )
2896
+ SEPA =
2897
+ T.let(
2898
+ :sepa,
2899
+ ModernTreasury::BulkRequestCreateParams::Resource::TransactionCreateRequest::Type::TaggedSymbol
2900
+ )
2901
+ SG_GIRO =
2902
+ T.let(
2903
+ :sg_giro,
2904
+ ModernTreasury::BulkRequestCreateParams::Resource::TransactionCreateRequest::Type::TaggedSymbol
2905
+ )
2906
+ SIC =
2907
+ T.let(
2908
+ :sic,
2909
+ ModernTreasury::BulkRequestCreateParams::Resource::TransactionCreateRequest::Type::TaggedSymbol
2910
+ )
2911
+ STABLECOIN =
2912
+ T.let(
2913
+ :stablecoin,
2914
+ ModernTreasury::BulkRequestCreateParams::Resource::TransactionCreateRequest::Type::TaggedSymbol
2915
+ )
2916
+ WIRE =
2917
+ T.let(
2918
+ :wire,
2919
+ ModernTreasury::BulkRequestCreateParams::Resource::TransactionCreateRequest::Type::TaggedSymbol
2920
+ )
2921
+ ZENGIN =
2922
+ T.let(
2923
+ :zengin,
2924
+ ModernTreasury::BulkRequestCreateParams::Resource::TransactionCreateRequest::Type::TaggedSymbol
2925
+ )
2926
+ OTHER =
2927
+ T.let(
2928
+ :other,
2929
+ ModernTreasury::BulkRequestCreateParams::Resource::TransactionCreateRequest::Type::TaggedSymbol
2930
+ )
2931
+
2932
+ sig do
2933
+ override.returns(
2934
+ T::Array[
2935
+ ModernTreasury::BulkRequestCreateParams::Resource::TransactionCreateRequest::Type::TaggedSymbol
2936
+ ]
2937
+ )
2938
+ end
2939
+ def self.values
2940
+ end
2941
+ end
2942
+ end
2943
+
2617
2944
  class ID < ModernTreasury::Internal::Type::BaseModel
2618
2945
  OrHash =
2619
2946
  T.type_alias do
@@ -44,8 +44,8 @@ module ModernTreasury
44
44
  sig { returns(T.nilable(T.anything)) }
45
45
  attr_accessor :compliance_details
46
46
 
47
- # The country code where the business is incorporated in the ISO 3166-1 alpha-2 or
48
- # alpha-3 formats.
47
+ # The country where the business is incorporated, as an ISO 3166-1 alpha-2 country
48
+ # code (e.g. US).
49
49
  sig { returns(T.nilable(String)) }
50
50
  attr_accessor :country_of_incorporation
51
51
 
@@ -148,8 +148,8 @@ module ModernTreasury
148
148
  sig { returns(String) }
149
149
  attr_accessor :object
150
150
 
151
- # A list of countries where the business operates (ISO 3166-1 alpha-2 or alpha-3
152
- # codes).
151
+ # A list of countries where the business operates, as ISO 3166-1 alpha-2 country
152
+ # codes (e.g. ["US", "CA"]).
153
153
  sig { returns(T::Array[String]) }
154
154
  attr_accessor :operating_jurisdictions
155
155
 
@@ -341,8 +341,8 @@ module ModernTreasury
341
341
  # The country of citizenship for an individual.
342
342
  citizenship_country:,
343
343
  compliance_details:,
344
- # The country code where the business is incorporated in the ISO 3166-1 alpha-2 or
345
- # alpha-3 formats.
344
+ # The country where the business is incorporated, as an ISO 3166-1 alpha-2 country
345
+ # code (e.g. US).
346
346
  country_of_incorporation:,
347
347
  created_at:,
348
348
  # A business's formation date (YYYY-MM-DD).
@@ -385,8 +385,8 @@ module ModernTreasury
385
385
  # An individual's middle name.
386
386
  middle_name:,
387
387
  object:,
388
- # A list of countries where the business operates (ISO 3166-1 alpha-2 or alpha-3
389
- # codes).
388
+ # A list of countries where the business operates, as ISO 3166-1 alpha-2 country
389
+ # codes (e.g. ["US", "CA"]).
390
390
  operating_jurisdictions:,
391
391
  phone_numbers:,
392
392
  # Whether the individual is a politically exposed person.
@@ -540,7 +540,8 @@ module ModernTreasury
540
540
  sig { returns(T::Boolean) }
541
541
  attr_accessor :live_mode
542
542
 
543
- # Locality or City.
543
+ # Locality or City. Use the full city name rather than an abbreviation (e.g. San
544
+ # Francisco).
544
545
  sig { returns(T.nilable(String)) }
545
546
  attr_accessor :locality
546
547
 
@@ -556,7 +557,8 @@ module ModernTreasury
556
557
  sig { returns(T.nilable(T::Boolean)) }
557
558
  attr_accessor :primary
558
559
 
559
- # Region or State.
560
+ # Region or State. This field is free-form; for US states, we recommend a
561
+ # two-letter code (e.g. CA). Full state names are also accepted.
560
562
  sig { returns(T.nilable(String)) }
561
563
  attr_accessor :region
562
564
 
@@ -597,7 +599,8 @@ module ModernTreasury
597
599
  # This field will be true if this object exists in the live environment or false
598
600
  # if it exists in the test environment.
599
601
  live_mode:,
600
- # Locality or City.
602
+ # Locality or City. Use the full city name rather than an abbreviation (e.g. San
603
+ # Francisco).
601
604
  locality:,
602
605
  object:,
603
606
  # The postal code of the address.
@@ -605,7 +608,8 @@ module ModernTreasury
605
608
  # Whether this address is the primary address for the legal entity. Optional; when
606
609
  # omitted it is inferred from the address types.
607
610
  primary:,
608
- # Region or State.
611
+ # Region or State. This field is free-form; for US states, we recommend a
612
+ # two-letter code (e.g. CA). Full state names are also accepted.
609
613
  region:,
610
614
  updated_at:
611
615
  )
@@ -1029,6 +1033,16 @@ module ModernTreasury
1029
1033
  :gr_vat,
1030
1034
  ModernTreasury::ChildLegalEntity::Identification::IDType::TaggedSymbol
1031
1035
  )
1036
+ HK_BRN =
1037
+ T.let(
1038
+ :hk_brn,
1039
+ ModernTreasury::ChildLegalEntity::Identification::IDType::TaggedSymbol
1040
+ )
1041
+ HK_HKID =
1042
+ T.let(
1043
+ :hk_hkid,
1044
+ ModernTreasury::ChildLegalEntity::Identification::IDType::TaggedSymbol
1045
+ )
1032
1046
  HN_ID =
1033
1047
  T.let(
1034
1048
  :hn_id,
@@ -1425,6 +1439,9 @@ module ModernTreasury
1425
1439
  )
1426
1440
  end
1427
1441
 
1442
+ # A phone number in E.164 format. This format is strictly validated: include a
1443
+ # leading + and country code, followed by digits only (no spaces or dashes), e.g.
1444
+ # +12025551234.
1428
1445
  sig { returns(T.nilable(String)) }
1429
1446
  attr_reader :phone_number
1430
1447
 
@@ -1433,7 +1450,12 @@ module ModernTreasury
1433
1450
 
1434
1451
  # A list of phone numbers in E.164 format.
1435
1452
  sig { params(phone_number: String).returns(T.attached_class) }
1436
- def self.new(phone_number: nil)
1453
+ def self.new(
1454
+ # A phone number in E.164 format. This format is strictly validated: include a
1455
+ # leading + and country code, followed by digits only (no spaces or dashes), e.g.
1456
+ # +12025551234.
1457
+ phone_number: nil
1458
+ )
1437
1459
  end
1438
1460
 
1439
1461
  sig { override.returns({ phone_number: String }) }
@@ -61,8 +61,8 @@ module ModernTreasury
61
61
  sig { returns(T.nilable(String)) }
62
62
  attr_accessor :connection_id
63
63
 
64
- # The country code where the business is incorporated in the ISO 3166-1 alpha-2 or
65
- # alpha-3 formats.
64
+ # The country where the business is incorporated, as an ISO 3166-1 alpha-2 country
65
+ # code (e.g. US).
66
66
  sig { returns(T.nilable(String)) }
67
67
  attr_accessor :country_of_incorporation
68
68
 
@@ -207,8 +207,8 @@ module ModernTreasury
207
207
  sig { returns(T.nilable(String)) }
208
208
  attr_accessor :middle_name
209
209
 
210
- # A list of countries where the business operates (ISO 3166-1 alpha-2 or alpha-3
211
- # codes).
210
+ # A list of countries where the business operates, as ISO 3166-1 alpha-2 country
211
+ # codes (e.g. ["US", "CA"]).
212
212
  sig { returns(T.nilable(T::Array[String])) }
213
213
  attr_reader :operating_jurisdictions
214
214
 
@@ -436,8 +436,8 @@ module ModernTreasury
436
436
  # in a value of null to prevent the connection from being associated with the
437
437
  # legal entity.
438
438
  connection_id: nil,
439
- # The country code where the business is incorporated in the ISO 3166-1 alpha-2 or
440
- # alpha-3 formats.
439
+ # The country where the business is incorporated, as an ISO 3166-1 alpha-2 country
440
+ # code (e.g. US).
441
441
  country_of_incorporation: nil,
442
442
  # A business's formation date (YYYY-MM-DD).
443
443
  date_formed: nil,
@@ -476,8 +476,8 @@ module ModernTreasury
476
476
  metadata: nil,
477
477
  # An individual's middle name.
478
478
  middle_name: nil,
479
- # A list of countries where the business operates (ISO 3166-1 alpha-2 or alpha-3
480
- # codes).
479
+ # A list of countries where the business operates, as ISO 3166-1 alpha-2 country
480
+ # codes (e.g. ["US", "CA"]).
481
481
  operating_jurisdictions: nil,
482
482
  phone_numbers: nil,
483
483
  # Whether the individual is a politically exposed person.
@@ -802,6 +802,9 @@ module ModernTreasury
802
802
  )
803
803
  end
804
804
 
805
+ # A phone number in E.164 format. This format is strictly validated: include a
806
+ # leading + and country code, followed by digits only (no spaces or dashes), e.g.
807
+ # +12025551234.
805
808
  sig { returns(T.nilable(String)) }
806
809
  attr_reader :phone_number
807
810
 
@@ -810,7 +813,12 @@ module ModernTreasury
810
813
 
811
814
  # A list of phone numbers in E.164 format.
812
815
  sig { params(phone_number: String).returns(T.attached_class) }
813
- def self.new(phone_number: nil)
816
+ def self.new(
817
+ # A phone number in E.164 format. This format is strictly validated: include a
818
+ # leading + and country code, followed by digits only (no spaces or dashes), e.g.
819
+ # +12025551234.
820
+ phone_number: nil
821
+ )
814
822
  end
815
823
 
816
824
  sig { override.returns({ phone_number: String }) }