increase 1.353.0 → 1.355.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 (152) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/increase/client.rb +18 -0
  4. data/lib/increase/models/ach_transfer.rb +3 -3
  5. data/lib/increase/models/beneficial_owner_create_params.rb +1 -1
  6. data/lib/increase/models/beneficial_owner_update_params.rb +1 -1
  7. data/lib/increase/models/card_create_details_token_params.rb +22 -0
  8. data/lib/increase/models/card_details_token.rb +57 -0
  9. data/lib/increase/models/card_payment.rb +29 -1
  10. data/lib/increase/models/declined_transaction.rb +3 -0
  11. data/lib/increase/models/digital_wallet_token.rb +18 -0
  12. data/lib/increase/models/digital_wallet_token_request.rb +307 -0
  13. data/lib/increase/models/digital_wallet_token_request_list_params.rb +99 -0
  14. data/lib/increase/models/digital_wallet_token_request_retrieve_params.rb +22 -0
  15. data/lib/increase/models/digital_wallet_token_transition_params.rb +48 -0
  16. data/lib/increase/models/entity.rb +35 -7
  17. data/lib/increase/models/entity_beneficial_owner.rb +1 -1
  18. data/lib/increase/models/entity_create_params.rb +1 -1
  19. data/lib/increase/models/export.rb +19 -19
  20. data/lib/increase/models/export_create_params.rb +15 -15
  21. data/lib/increase/models/export_list_params.rb +19 -19
  22. data/lib/increase/models/inbound_real_time_payments_request_for_payment.rb +318 -0
  23. data/lib/increase/models/inbound_real_time_payments_requests_for_payment_list_params.rb +113 -0
  24. data/lib/increase/models/inbound_real_time_payments_requests_for_payment_retrieve_params.rb +25 -0
  25. data/lib/increase/models/inbound_wire_transfer.rb +10 -1
  26. data/lib/increase/models/physical_check_batch.rb +266 -0
  27. data/lib/increase/models/physical_check_batch_cancel_params.rb +22 -0
  28. data/lib/increase/models/physical_check_batch_complete_params.rb +22 -0
  29. data/lib/increase/models/physical_check_batch_create_params.rb +189 -0
  30. data/lib/increase/models/real_time_decision.rb +9 -0
  31. data/lib/increase/models/real_time_decision_action_params.rb +3 -0
  32. data/lib/increase/models/real_time_payments_request_for_payment.rb +658 -0
  33. data/lib/increase/models/real_time_payments_requests_for_payment_cancel_params.rb +64 -0
  34. data/lib/increase/models/real_time_payments_requests_for_payment_create_params.rb +194 -0
  35. data/lib/increase/models/real_time_payments_requests_for_payment_list_params.rb +117 -0
  36. data/lib/increase/models/real_time_payments_requests_for_payment_retrieve_params.rb +23 -0
  37. data/lib/increase/models/simulations/digital_wallet_token_request_create_response.rb +9 -0
  38. data/lib/increase/models/simulations/entity_update_validation_params.rb +3 -0
  39. data/lib/increase/models/simulations/fednow_transfer_complete_params.rb +103 -0
  40. data/lib/increase/models/simulations/inbound_check_deposit_accept_params.rb +24 -0
  41. data/lib/increase/models/transaction.rb +36 -2
  42. data/lib/increase/models.rb +42 -0
  43. data/lib/increase/resources/cards.rb +23 -0
  44. data/lib/increase/resources/digital_wallet_token_requests.rb +68 -0
  45. data/lib/increase/resources/digital_wallet_tokens.rb +28 -0
  46. data/lib/increase/resources/inbound_real_time_payments_requests_for_payment.rb +79 -0
  47. data/lib/increase/resources/physical_check_batches.rb +86 -0
  48. data/lib/increase/resources/real_time_payments_requests_for_payment.rb +159 -0
  49. data/lib/increase/resources/simulations/fednow_transfers.rb +43 -0
  50. data/lib/increase/resources/simulations/inbound_check_deposits.rb +22 -0
  51. data/lib/increase/resources/simulations.rb +4 -0
  52. data/lib/increase/version.rb +1 -1
  53. data/lib/increase.rb +25 -0
  54. data/rbi/increase/client.rbi +14 -0
  55. data/rbi/increase/models/ach_transfer.rbi +3 -3
  56. data/rbi/increase/models/beneficial_owner_create_params.rbi +1 -1
  57. data/rbi/increase/models/beneficial_owner_update_params.rbi +1 -1
  58. data/rbi/increase/models/card_create_details_token_params.rbi +43 -0
  59. data/rbi/increase/models/card_details_token.rbi +85 -0
  60. data/rbi/increase/models/card_payment.rbi +59 -0
  61. data/rbi/increase/models/declined_transaction.rbi +7 -0
  62. data/rbi/increase/models/digital_wallet_token.rbi +42 -0
  63. data/rbi/increase/models/digital_wallet_token_request.rbi +586 -0
  64. data/rbi/increase/models/digital_wallet_token_request_list_params.rbi +171 -0
  65. data/rbi/increase/models/digital_wallet_token_request_retrieve_params.rbi +46 -0
  66. data/rbi/increase/models/digital_wallet_token_transition_params.rbi +100 -0
  67. data/rbi/increase/models/entity.rbi +71 -6
  68. data/rbi/increase/models/entity_beneficial_owner.rbi +1 -1
  69. data/rbi/increase/models/entity_create_params.rbi +1 -1
  70. data/rbi/increase/models/export.rbi +32 -32
  71. data/rbi/increase/models/export_create_params.rbi +29 -29
  72. data/rbi/increase/models/export_list_params.rbi +37 -37
  73. data/rbi/increase/models/inbound_real_time_payments_request_for_payment.rbi +442 -0
  74. data/rbi/increase/models/inbound_real_time_payments_requests_for_payment_list_params.rbi +188 -0
  75. data/rbi/increase/models/inbound_real_time_payments_requests_for_payment_retrieve_params.rbi +48 -0
  76. data/rbi/increase/models/inbound_wire_transfer.rbi +8 -0
  77. data/rbi/increase/models/physical_check_batch.rbi +382 -0
  78. data/rbi/increase/models/physical_check_batch_cancel_params.rbi +46 -0
  79. data/rbi/increase/models/physical_check_batch_complete_params.rbi +46 -0
  80. data/rbi/increase/models/physical_check_batch_create_params.rbi +326 -0
  81. data/rbi/increase/models/real_time_decision.rbi +21 -0
  82. data/rbi/increase/models/real_time_decision_action_params.rbi +7 -0
  83. data/rbi/increase/models/real_time_payments_request_for_payment.rbi +1166 -0
  84. data/rbi/increase/models/real_time_payments_requests_for_payment_cancel_params.rbi +136 -0
  85. data/rbi/increase/models/real_time_payments_requests_for_payment_create_params.rbi +303 -0
  86. data/rbi/increase/models/real_time_payments_requests_for_payment_list_params.rbi +192 -0
  87. data/rbi/increase/models/real_time_payments_requests_for_payment_retrieve_params.rbi +46 -0
  88. data/rbi/increase/models/simulations/digital_wallet_token_request_create_response.rbi +21 -0
  89. data/rbi/increase/models/simulations/entity_update_validation_params.rbi +7 -0
  90. data/rbi/increase/models/simulations/fednow_transfer_complete_params.rbi +243 -0
  91. data/rbi/increase/models/simulations/inbound_check_deposit_accept_params.rbi +48 -0
  92. data/rbi/increase/models/transaction.rbi +60 -0
  93. data/rbi/increase/models.rbi +50 -0
  94. data/rbi/increase/resources/cards.rbi +17 -0
  95. data/rbi/increase/resources/digital_wallet_token_requests.rbi +52 -0
  96. data/rbi/increase/resources/digital_wallet_tokens.rbi +21 -0
  97. data/rbi/increase/resources/inbound_real_time_payments_requests_for_payment.rbi +62 -0
  98. data/rbi/increase/resources/physical_check_batches.rbi +66 -0
  99. data/rbi/increase/resources/real_time_payments_requests_for_payment.rbi +127 -0
  100. data/rbi/increase/resources/simulations/fednow_transfers.rbi +34 -0
  101. data/rbi/increase/resources/simulations/inbound_check_deposits.rbi +16 -0
  102. data/rbi/increase/resources/simulations.rbi +3 -0
  103. data/sig/increase/client.rbs +8 -0
  104. data/sig/increase/models/ach_transfer.rbs +4 -4
  105. data/sig/increase/models/beneficial_owner_create_params.rbs +1 -1
  106. data/sig/increase/models/beneficial_owner_update_params.rbs +1 -1
  107. data/sig/increase/models/card_create_details_token_params.rbs +23 -0
  108. data/sig/increase/models/card_details_token.rbs +40 -0
  109. data/sig/increase/models/card_payment.rbs +23 -0
  110. data/sig/increase/models/declined_transaction.rbs +4 -0
  111. data/sig/increase/models/digital_wallet_token.rbs +36 -3
  112. data/sig/increase/models/digital_wallet_token_request.rbs +260 -0
  113. data/sig/increase/models/digital_wallet_token_request_list_params.rbs +86 -0
  114. data/sig/increase/models/digital_wallet_token_request_retrieve_params.rbs +24 -0
  115. data/sig/increase/models/digital_wallet_token_transition_params.rbs +48 -0
  116. data/sig/increase/models/entity.rbs +25 -6
  117. data/sig/increase/models/entity_beneficial_owner.rbs +1 -1
  118. data/sig/increase/models/entity_create_params.rbs +1 -1
  119. data/sig/increase/models/export.rbs +28 -28
  120. data/sig/increase/models/export_create_params.rbs +22 -22
  121. data/sig/increase/models/export_list_params.rbs +28 -28
  122. data/sig/increase/models/inbound_real_time_payments_request_for_payment.rbs +200 -0
  123. data/sig/increase/models/inbound_real_time_payments_requests_for_payment_list_params.rbs +93 -0
  124. data/sig/increase/models/inbound_real_time_payments_requests_for_payment_retrieve_params.rbs +24 -0
  125. data/sig/increase/models/inbound_wire_transfer.rbs +5 -0
  126. data/sig/increase/models/physical_check_batch.rbs +193 -0
  127. data/sig/increase/models/physical_check_batch_cancel_params.rbs +24 -0
  128. data/sig/increase/models/physical_check_batch_complete_params.rbs +24 -0
  129. data/sig/increase/models/physical_check_batch_create_params.rbs +156 -0
  130. data/sig/increase/models/real_time_decision.rbs +14 -2
  131. data/sig/increase/models/real_time_decision_action_params.rbs +4 -0
  132. data/sig/increase/models/real_time_payments_request_for_payment.rbs +513 -0
  133. data/sig/increase/models/real_time_payments_requests_for_payment_cancel_params.rbs +66 -0
  134. data/sig/increase/models/real_time_payments_requests_for_payment_create_params.rbs +149 -0
  135. data/sig/increase/models/real_time_payments_requests_for_payment_list_params.rbs +93 -0
  136. data/sig/increase/models/real_time_payments_requests_for_payment_retrieve_params.rbs +24 -0
  137. data/sig/increase/models/simulations/digital_wallet_token_request_create_response.rbs +12 -0
  138. data/sig/increase/models/simulations/entity_update_validation_params.rbs +4 -0
  139. data/sig/increase/models/simulations/fednow_transfer_complete_params.rbs +122 -0
  140. data/sig/increase/models/simulations/inbound_check_deposit_accept_params.rbs +26 -0
  141. data/sig/increase/models/transaction.rbs +24 -0
  142. data/sig/increase/models.rbs +36 -0
  143. data/sig/increase/resources/cards.rbs +5 -0
  144. data/sig/increase/resources/digital_wallet_token_requests.rbs +20 -0
  145. data/sig/increase/resources/digital_wallet_tokens.rbs +6 -0
  146. data/sig/increase/resources/inbound_real_time_payments_requests_for_payment.rbs +21 -0
  147. data/sig/increase/resources/physical_check_batches.rbs +24 -0
  148. data/sig/increase/resources/real_time_payments_requests_for_payment.rbs +41 -0
  149. data/sig/increase/resources/simulations/fednow_transfers.rbs +15 -0
  150. data/sig/increase/resources/simulations/inbound_check_deposits.rbs +5 -0
  151. data/sig/increase/resources/simulations.rbs +2 -0
  152. metadata +77 -2
@@ -0,0 +1,171 @@
1
+ # typed: strong
2
+
3
+ module Increase
4
+ module Models
5
+ class DigitalWalletTokenRequestListParams < Increase::Internal::Type::BaseModel
6
+ extend Increase::Internal::Type::RequestParameters::Converter
7
+ include Increase::Internal::Type::RequestParameters
8
+
9
+ OrHash =
10
+ T.type_alias do
11
+ T.any(
12
+ Increase::DigitalWalletTokenRequestListParams,
13
+ Increase::Internal::AnyHash
14
+ )
15
+ end
16
+
17
+ # Filter Digital Wallet Token Requests to ones for the specified Card.
18
+ sig { returns(T.nilable(String)) }
19
+ attr_reader :card_id
20
+
21
+ sig { params(card_id: String).void }
22
+ attr_writer :card_id
23
+
24
+ sig do
25
+ returns(
26
+ T.nilable(Increase::DigitalWalletTokenRequestListParams::CreatedAt)
27
+ )
28
+ end
29
+ attr_reader :created_at
30
+
31
+ sig do
32
+ params(
33
+ created_at:
34
+ Increase::DigitalWalletTokenRequestListParams::CreatedAt::OrHash
35
+ ).void
36
+ end
37
+ attr_writer :created_at
38
+
39
+ # Return the page of entries after this one.
40
+ sig { returns(T.nilable(String)) }
41
+ attr_reader :cursor
42
+
43
+ sig { params(cursor: String).void }
44
+ attr_writer :cursor
45
+
46
+ # Limit the size of the list that is returned. The default (and maximum) is 100
47
+ # objects.
48
+ #
49
+ # Defaults to `100`.
50
+ sig { returns(T.nilable(Integer)) }
51
+ attr_reader :limit
52
+
53
+ sig { params(limit: Integer).void }
54
+ attr_writer :limit
55
+
56
+ sig do
57
+ params(
58
+ card_id: String,
59
+ created_at:
60
+ Increase::DigitalWalletTokenRequestListParams::CreatedAt::OrHash,
61
+ cursor: String,
62
+ limit: Integer,
63
+ request_options: Increase::RequestOptions::OrHash
64
+ ).returns(T.attached_class)
65
+ end
66
+ def self.new(
67
+ # Filter Digital Wallet Token Requests to ones for the specified Card.
68
+ card_id: nil,
69
+ created_at: nil,
70
+ # Return the page of entries after this one.
71
+ cursor: nil,
72
+ # Limit the size of the list that is returned. The default (and maximum) is 100
73
+ # objects.
74
+ #
75
+ # Defaults to `100`.
76
+ limit: nil,
77
+ request_options: {}
78
+ )
79
+ end
80
+
81
+ sig do
82
+ override.returns(
83
+ {
84
+ card_id: String,
85
+ created_at:
86
+ Increase::DigitalWalletTokenRequestListParams::CreatedAt,
87
+ cursor: String,
88
+ limit: Integer,
89
+ request_options: Increase::RequestOptions
90
+ }
91
+ )
92
+ end
93
+ def to_hash
94
+ end
95
+
96
+ class CreatedAt < Increase::Internal::Type::BaseModel
97
+ OrHash =
98
+ T.type_alias do
99
+ T.any(
100
+ Increase::DigitalWalletTokenRequestListParams::CreatedAt,
101
+ Increase::Internal::AnyHash
102
+ )
103
+ end
104
+
105
+ # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
106
+ # timestamp.
107
+ sig { returns(T.nilable(Time)) }
108
+ attr_reader :after
109
+
110
+ sig { params(after: Time).void }
111
+ attr_writer :after
112
+
113
+ # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
114
+ # timestamp.
115
+ sig { returns(T.nilable(Time)) }
116
+ attr_reader :before
117
+
118
+ sig { params(before: Time).void }
119
+ attr_writer :before
120
+
121
+ # Return results on or after this
122
+ # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
123
+ sig { returns(T.nilable(Time)) }
124
+ attr_reader :on_or_after
125
+
126
+ sig { params(on_or_after: Time).void }
127
+ attr_writer :on_or_after
128
+
129
+ # Return results on or before this
130
+ # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
131
+ sig { returns(T.nilable(Time)) }
132
+ attr_reader :on_or_before
133
+
134
+ sig { params(on_or_before: Time).void }
135
+ attr_writer :on_or_before
136
+
137
+ sig do
138
+ params(
139
+ after: Time,
140
+ before: Time,
141
+ on_or_after: Time,
142
+ on_or_before: Time
143
+ ).returns(T.attached_class)
144
+ end
145
+ def self.new(
146
+ # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
147
+ # timestamp.
148
+ after: nil,
149
+ # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
150
+ # timestamp.
151
+ before: nil,
152
+ # Return results on or after this
153
+ # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
154
+ on_or_after: nil,
155
+ # Return results on or before this
156
+ # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
157
+ on_or_before: nil
158
+ )
159
+ end
160
+
161
+ sig do
162
+ override.returns(
163
+ { after: Time, before: Time, on_or_after: Time, on_or_before: Time }
164
+ )
165
+ end
166
+ def to_hash
167
+ end
168
+ end
169
+ end
170
+ end
171
+ end
@@ -0,0 +1,46 @@
1
+ # typed: strong
2
+
3
+ module Increase
4
+ module Models
5
+ class DigitalWalletTokenRequestRetrieveParams < Increase::Internal::Type::BaseModel
6
+ extend Increase::Internal::Type::RequestParameters::Converter
7
+ include Increase::Internal::Type::RequestParameters
8
+
9
+ OrHash =
10
+ T.type_alias do
11
+ T.any(
12
+ Increase::DigitalWalletTokenRequestRetrieveParams,
13
+ Increase::Internal::AnyHash
14
+ )
15
+ end
16
+
17
+ # The identifier of the Digital Wallet Token Request.
18
+ sig { returns(String) }
19
+ attr_accessor :digital_wallet_token_request_id
20
+
21
+ sig do
22
+ params(
23
+ digital_wallet_token_request_id: String,
24
+ request_options: Increase::RequestOptions::OrHash
25
+ ).returns(T.attached_class)
26
+ end
27
+ def self.new(
28
+ # The identifier of the Digital Wallet Token Request.
29
+ digital_wallet_token_request_id:,
30
+ request_options: {}
31
+ )
32
+ end
33
+
34
+ sig do
35
+ override.returns(
36
+ {
37
+ digital_wallet_token_request_id: String,
38
+ request_options: Increase::RequestOptions
39
+ }
40
+ )
41
+ end
42
+ def to_hash
43
+ end
44
+ end
45
+ end
46
+ end
@@ -0,0 +1,100 @@
1
+ # typed: strong
2
+
3
+ module Increase
4
+ module Models
5
+ class DigitalWalletTokenTransitionParams < Increase::Internal::Type::BaseModel
6
+ extend Increase::Internal::Type::RequestParameters::Converter
7
+ include Increase::Internal::Type::RequestParameters
8
+
9
+ OrHash =
10
+ T.type_alias do
11
+ T.any(
12
+ Increase::DigitalWalletTokenTransitionParams,
13
+ Increase::Internal::AnyHash
14
+ )
15
+ end
16
+
17
+ # The identifier of the Digital Wallet Token.
18
+ sig { returns(String) }
19
+ attr_accessor :digital_wallet_token_id
20
+
21
+ # The status to transition the Digital Wallet Token to.
22
+ sig do
23
+ returns(Increase::DigitalWalletTokenTransitionParams::Status::OrSymbol)
24
+ end
25
+ attr_accessor :status
26
+
27
+ sig do
28
+ params(
29
+ digital_wallet_token_id: String,
30
+ status:
31
+ Increase::DigitalWalletTokenTransitionParams::Status::OrSymbol,
32
+ request_options: Increase::RequestOptions::OrHash
33
+ ).returns(T.attached_class)
34
+ end
35
+ def self.new(
36
+ # The identifier of the Digital Wallet Token.
37
+ digital_wallet_token_id:,
38
+ # The status to transition the Digital Wallet Token to.
39
+ status:,
40
+ request_options: {}
41
+ )
42
+ end
43
+
44
+ sig do
45
+ override.returns(
46
+ {
47
+ digital_wallet_token_id: String,
48
+ status:
49
+ Increase::DigitalWalletTokenTransitionParams::Status::OrSymbol,
50
+ request_options: Increase::RequestOptions
51
+ }
52
+ )
53
+ end
54
+ def to_hash
55
+ end
56
+
57
+ # The status to transition the Digital Wallet Token to.
58
+ module Status
59
+ extend Increase::Internal::Type::Enum
60
+
61
+ TaggedSymbol =
62
+ T.type_alias do
63
+ T.all(Symbol, Increase::DigitalWalletTokenTransitionParams::Status)
64
+ end
65
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
66
+
67
+ # Reactivate a suspended Digital Wallet Token.
68
+ ACTIVE =
69
+ T.let(
70
+ :active,
71
+ Increase::DigitalWalletTokenTransitionParams::Status::TaggedSymbol
72
+ )
73
+
74
+ # Temporarily pause an active Digital Wallet Token.
75
+ SUSPENDED =
76
+ T.let(
77
+ :suspended,
78
+ Increase::DigitalWalletTokenTransitionParams::Status::TaggedSymbol
79
+ )
80
+
81
+ # Permanently cancel an active, inactive, or suspended Digital Wallet Token.
82
+ DEACTIVATED =
83
+ T.let(
84
+ :deactivated,
85
+ Increase::DigitalWalletTokenTransitionParams::Status::TaggedSymbol
86
+ )
87
+
88
+ sig do
89
+ override.returns(
90
+ T::Array[
91
+ Increase::DigitalWalletTokenTransitionParams::Status::TaggedSymbol
92
+ ]
93
+ )
94
+ end
95
+ def self.values
96
+ end
97
+ end
98
+ end
99
+ end
100
+ end
@@ -828,7 +828,7 @@ module Increase
828
828
  Increase::Entity::Corporation::BeneficialOwner::Individual::Identification::Method::TaggedSymbol
829
829
  )
830
830
 
831
- # The last four digits of a social security number.
831
+ # The last four digits of a social security number. Not all programs can use this method.
832
832
  SOCIAL_SECURITY_NUMBER_LAST4 =
833
833
  T.let(
834
834
  :social_security_number_last4,
@@ -1592,7 +1592,7 @@ module Increase
1592
1592
  Increase::Entity::Joint::Individual::Identification::Method::TaggedSymbol
1593
1593
  )
1594
1594
 
1595
- # The last four digits of a social security number.
1595
+ # The last four digits of a social security number. Not all programs can use this method.
1596
1596
  SOCIAL_SECURITY_NUMBER_LAST4 =
1597
1597
  T.let(
1598
1598
  :social_security_number_last4,
@@ -1866,7 +1866,7 @@ module Increase
1866
1866
  Increase::Entity::NaturalPerson::Identification::Method::TaggedSymbol
1867
1867
  )
1868
1868
 
1869
- # The last four digits of a social security number.
1869
+ # The last four digits of a social security number. Not all programs can use this method.
1870
1870
  SOCIAL_SECURITY_NUMBER_LAST4 =
1871
1871
  T.let(
1872
1872
  :social_security_number_last4,
@@ -2411,7 +2411,7 @@ module Increase
2411
2411
  Increase::Entity::SoleProprietorship::SoleProprietor::Identification::Method::TaggedSymbol
2412
2412
  )
2413
2413
 
2414
- # The last four digits of a social security number.
2414
+ # The last four digits of a social security number. Not all programs can use this method.
2415
2415
  SOCIAL_SECURITY_NUMBER_LAST4 =
2416
2416
  T.let(
2417
2417
  :social_security_number_last4,
@@ -3114,7 +3114,7 @@ module Increase
3114
3114
  Increase::Entity::Trust::Grantor::Identification::Method::TaggedSymbol
3115
3115
  )
3116
3116
 
3117
- # The last four digits of a social security number.
3117
+ # The last four digits of a social security number. Not all programs can use this method.
3118
3118
  SOCIAL_SECURITY_NUMBER_LAST4 =
3119
3119
  T.let(
3120
3120
  :social_security_number_last4,
@@ -3464,7 +3464,7 @@ module Increase
3464
3464
  Increase::Entity::Trust::Trustee::Individual::Identification::Method::TaggedSymbol
3465
3465
  )
3466
3466
 
3467
- # The last four digits of a social security number.
3467
+ # The last four digits of a social security number. Not all programs can use this method.
3468
3468
  SOCIAL_SECURITY_NUMBER_LAST4 =
3469
3469
  T.let(
3470
3470
  :social_security_number_last4,
@@ -3649,6 +3649,26 @@ module Increase
3649
3649
  end
3650
3650
  attr_writer :beneficial_owner_identity
3651
3651
 
3652
+ # Details when the issue is with a beneficial owner's tax identifier.
3653
+ sig do
3654
+ returns(
3655
+ T.nilable(
3656
+ Increase::Entity::Validation::Issue::BeneficialOwnerTaxIdentifier
3657
+ )
3658
+ )
3659
+ end
3660
+ attr_reader :beneficial_owner_tax_identifier
3661
+
3662
+ sig do
3663
+ params(
3664
+ beneficial_owner_tax_identifier:
3665
+ T.nilable(
3666
+ Increase::Entity::Validation::Issue::BeneficialOwnerTaxIdentifier::OrHash
3667
+ )
3668
+ ).void
3669
+ end
3670
+ attr_writer :beneficial_owner_tax_identifier
3671
+
3652
3672
  # The type of issue. We may add additional possible values for this enum over
3653
3673
  # time; your application should be able to handle such additions gracefully.
3654
3674
  sig do
@@ -3722,6 +3742,10 @@ module Increase
3722
3742
  T.nilable(
3723
3743
  Increase::Entity::Validation::Issue::BeneficialOwnerIdentity::OrHash
3724
3744
  ),
3745
+ beneficial_owner_tax_identifier:
3746
+ T.nilable(
3747
+ Increase::Entity::Validation::Issue::BeneficialOwnerTaxIdentifier::OrHash
3748
+ ),
3725
3749
  category: Increase::Entity::Validation::Issue::Category::OrSymbol,
3726
3750
  entity_address:
3727
3751
  T.nilable(
@@ -3742,6 +3766,8 @@ module Increase
3742
3766
  beneficial_owner_address:,
3743
3767
  # Details when the issue is with a beneficial owner's identity verification.
3744
3768
  beneficial_owner_identity:,
3769
+ # Details when the issue is with a beneficial owner's tax identifier.
3770
+ beneficial_owner_tax_identifier:,
3745
3771
  # The type of issue. We may add additional possible values for this enum over
3746
3772
  # time; your application should be able to handle such additions gracefully.
3747
3773
  category:,
@@ -3765,6 +3791,10 @@ module Increase
3765
3791
  T.nilable(
3766
3792
  Increase::Entity::Validation::Issue::BeneficialOwnerIdentity
3767
3793
  ),
3794
+ beneficial_owner_tax_identifier:
3795
+ T.nilable(
3796
+ Increase::Entity::Validation::Issue::BeneficialOwnerTaxIdentifier
3797
+ ),
3768
3798
  category:
3769
3799
  Increase::Entity::Validation::Issue::Category::TaggedSymbol,
3770
3800
  entity_address:
@@ -3892,6 +3922,34 @@ module Increase
3892
3922
  end
3893
3923
  end
3894
3924
 
3925
+ class BeneficialOwnerTaxIdentifier < Increase::Internal::Type::BaseModel
3926
+ OrHash =
3927
+ T.type_alias do
3928
+ T.any(
3929
+ Increase::Entity::Validation::Issue::BeneficialOwnerTaxIdentifier,
3930
+ Increase::Internal::AnyHash
3931
+ )
3932
+ end
3933
+
3934
+ # The ID of the beneficial owner.
3935
+ sig { returns(String) }
3936
+ attr_accessor :beneficial_owner_id
3937
+
3938
+ # Details when the issue is with a beneficial owner's tax identifier.
3939
+ sig do
3940
+ params(beneficial_owner_id: String).returns(T.attached_class)
3941
+ end
3942
+ def self.new(
3943
+ # The ID of the beneficial owner.
3944
+ beneficial_owner_id:
3945
+ )
3946
+ end
3947
+
3948
+ sig { override.returns({ beneficial_owner_id: String }) }
3949
+ def to_hash
3950
+ end
3951
+ end
3952
+
3895
3953
  # The type of issue. We may add additional possible values for this enum over
3896
3954
  # time; your application should be able to handle such additions gracefully.
3897
3955
  module Category
@@ -3938,6 +3996,13 @@ module Increase
3938
3996
  Increase::Entity::Validation::Issue::Category::TaggedSymbol
3939
3997
  )
3940
3998
 
3999
+ # A beneficial owner's full tax identifier is required. A non-US person can submit a passport or driver's license. Make changes via the [update a beneficial owner API](/documentation/api/beneficial-owners#update-a-beneficial-owner).
4000
+ BENEFICIAL_OWNER_TAX_IDENTIFIER =
4001
+ T.let(
4002
+ :beneficial_owner_tax_identifier,
4003
+ Increase::Entity::Validation::Issue::Category::TaggedSymbol
4004
+ )
4005
+
3941
4006
  sig do
3942
4007
  override.returns(
3943
4008
  T::Array[
@@ -351,7 +351,7 @@ module Increase
351
351
  Increase::EntityBeneficialOwner::Individual::Identification::Method::TaggedSymbol
352
352
  )
353
353
 
354
- # The last four digits of a social security number.
354
+ # The last four digits of a social security number. Not all programs can use this method.
355
355
  SOCIAL_SECURITY_NUMBER_LAST4 =
356
356
  T.let(
357
357
  :social_security_number_last4,
@@ -1025,7 +1025,7 @@ module Increase
1025
1025
  Increase::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Method::TaggedSymbol
1026
1026
  )
1027
1027
 
1028
- # The last four digits of a social security number.
1028
+ # The last four digits of a social security number. Not all programs can use this method.
1029
1029
  SOCIAL_SECURITY_NUMBER_LAST4 =
1030
1030
  T.let(
1031
1031
  :social_security_number_last4,
@@ -714,6 +714,13 @@ module Increase
714
714
  T.type_alias { T.all(Symbol, Increase::Export::Category) }
715
715
  OrSymbol = T.type_alias { T.any(Symbol, String) }
716
716
 
717
+ # Export a BAI2 file of transactions and balances for a given date and optional Account.
718
+ ACCOUNT_STATEMENT_BAI2 =
719
+ T.let(
720
+ :account_statement_bai2,
721
+ Increase::Export::Category::TaggedSymbol
722
+ )
723
+
717
724
  # Export an Open Financial Exchange (OFX) file of transactions and balances for a given time range and Account.
718
725
  ACCOUNT_STATEMENT_OFX =
719
726
  T.let(
@@ -721,17 +728,13 @@ module Increase
721
728
  Increase::Export::Category::TaggedSymbol
722
729
  )
723
730
 
724
- # Export a BAI2 file of transactions and balances for a given date and optional Account.
725
- ACCOUNT_STATEMENT_BAI2 =
731
+ # A PDF of an account verification letter.
732
+ ACCOUNT_VERIFICATION_LETTER =
726
733
  T.let(
727
- :account_statement_bai2,
734
+ :account_verification_letter,
728
735
  Increase::Export::Category::TaggedSymbol
729
736
  )
730
737
 
731
- # Export a CSV of all transactions for a given time range.
732
- TRANSACTION_CSV =
733
- T.let(:transaction_csv, Increase::Export::Category::TaggedSymbol)
734
-
735
738
  # Export a CSV of account balances for the dates in a given range. (deprecated, use `daily_account_balance_csv` instead)
736
739
  BALANCE_CSV =
737
740
  T.let(:balance_csv, Increase::Export::Category::TaggedSymbol)
@@ -743,28 +746,23 @@ module Increase
743
746
  Increase::Export::Category::TaggedSymbol
744
747
  )
745
748
 
746
- # Export a CSV of entities with a given status.
747
- ENTITY_CSV =
748
- T.let(:entity_csv, Increase::Export::Category::TaggedSymbol)
749
-
750
- # Export a CSV of vendors added to the third-party risk management dashboard.
751
- VENDOR_CSV =
752
- T.let(:vendor_csv, Increase::Export::Category::TaggedSymbol)
749
+ # Export a CSV of daily account balances with starting and ending balances for a given date range.
750
+ DAILY_ACCOUNT_BALANCE_CSV =
751
+ T.let(
752
+ :daily_account_balance_csv,
753
+ Increase::Export::Category::TaggedSymbol
754
+ )
753
755
 
754
756
  # Certain dashboard tables are available as CSV exports. This export cannot be created via the API.
755
757
  DASHBOARD_TABLE_CSV =
756
758
  T.let(:dashboard_table_csv, Increase::Export::Category::TaggedSymbol)
757
759
 
758
- # A PDF of an account verification letter.
759
- ACCOUNT_VERIFICATION_LETTER =
760
- T.let(
761
- :account_verification_letter,
762
- Increase::Export::Category::TaggedSymbol
763
- )
760
+ # Export a CSV of entities with a given status.
761
+ ENTITY_CSV =
762
+ T.let(:entity_csv, Increase::Export::Category::TaggedSymbol)
764
763
 
765
- # A PDF of funding instructions.
766
- FUNDING_INSTRUCTIONS =
767
- T.let(:funding_instructions, Increase::Export::Category::TaggedSymbol)
764
+ # Export a CSV of fees. The time range must not include any fees that are part of an open fee statement.
765
+ FEE_CSV = T.let(:fee_csv, Increase::Export::Category::TaggedSymbol)
768
766
 
769
767
  # A PDF of an Internal Revenue Service Form 1099-INT.
770
768
  FORM_1099_INT =
@@ -774,20 +772,22 @@ module Increase
774
772
  FORM_1099_MISC =
775
773
  T.let(:form_1099_misc, Increase::Export::Category::TaggedSymbol)
776
774
 
777
- # Export a CSV of fees. The time range must not include any fees that are part of an open fee statement.
778
- FEE_CSV = T.let(:fee_csv, Increase::Export::Category::TaggedSymbol)
775
+ # A PDF of funding instructions.
776
+ FUNDING_INSTRUCTIONS =
777
+ T.let(:funding_instructions, Increase::Export::Category::TaggedSymbol)
778
+
779
+ # Export a CSV of all transactions for a given time range.
780
+ TRANSACTION_CSV =
781
+ T.let(:transaction_csv, Increase::Export::Category::TaggedSymbol)
782
+
783
+ # Export a CSV of vendors added to the third-party risk management dashboard.
784
+ VENDOR_CSV =
785
+ T.let(:vendor_csv, Increase::Export::Category::TaggedSymbol)
779
786
 
780
787
  # A PDF of a voided check.
781
788
  VOIDED_CHECK =
782
789
  T.let(:voided_check, Increase::Export::Category::TaggedSymbol)
783
790
 
784
- # Export a CSV of daily account balances with starting and ending balances for a given date range.
785
- DAILY_ACCOUNT_BALANCE_CSV =
786
- T.let(
787
- :daily_account_balance_csv,
788
- Increase::Export::Category::TaggedSymbol
789
- )
790
-
791
791
  sig do
792
792
  override.returns(T::Array[Increase::Export::Category::TaggedSymbol])
793
793
  end