increase 1.362.0 → 1.364.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 (165) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/increase/client.rb +8 -16
  4. data/lib/increase/models/account_number.rb +51 -81
  5. data/lib/increase/models/account_number_create_params.rb +41 -75
  6. data/lib/increase/models/account_number_list_params.rb +39 -39
  7. data/lib/increase/models/account_number_update_params.rb +48 -79
  8. data/lib/increase/models/ach_transfer.rb +38 -23
  9. data/lib/increase/models/card_payment.rb +6 -0
  10. data/lib/increase/models/card_update_params.rb +12 -8
  11. data/lib/increase/models/check_transfer.rb +58 -44
  12. data/lib/increase/models/check_transfer_create_params.rb +35 -21
  13. data/lib/increase/models/checkbook.rb +352 -0
  14. data/lib/increase/models/checkbook_check.rb +100 -0
  15. data/lib/increase/models/checkbook_check_list_params.rb +61 -0
  16. data/lib/increase/models/checkbook_check_retrieve_params.rb +22 -0
  17. data/lib/increase/models/checkbook_check_stop_params.rb +22 -0
  18. data/lib/increase/models/checkbook_create_params.rb +111 -0
  19. data/lib/increase/models/checkbook_list_params.rb +104 -0
  20. data/lib/increase/models/checkbook_retrieve_params.rb +22 -0
  21. data/lib/increase/models/checkbook_stop_params.rb +22 -0
  22. data/lib/increase/models/declined_transaction.rb +10 -1
  23. data/lib/increase/models/entity.rb +1 -65
  24. data/lib/increase/models/entity_create_params.rb +1 -65
  25. data/lib/increase/models/entity_update_params.rb +1 -57
  26. data/lib/increase/models/export.rb +12 -1
  27. data/lib/increase/models/export_create_params.rb +26 -4
  28. data/lib/increase/models/inbound_ach_transfer.rb +6 -6
  29. data/lib/increase/models/inbound_check_deposit.rb +12 -1
  30. data/lib/increase/models/inbound_real_time_payments_transfer.rb +10 -1
  31. data/lib/increase/models/inbound_real_time_payments_transfer_return_params.rb +36 -0
  32. data/lib/increase/models/real_time_decision.rb +65 -1
  33. data/lib/increase/models/real_time_payments_transfer.rb +21 -1
  34. data/lib/increase/models/simulations/checkbook_mail_params.rb +24 -0
  35. data/lib/increase/models/transaction.rb +27 -5
  36. data/lib/increase/models.rb +21 -20
  37. data/lib/increase/resources/account_numbers.rb +19 -16
  38. data/lib/increase/resources/checkbook_checks.rb +90 -0
  39. data/lib/increase/resources/checkbooks.rb +127 -0
  40. data/lib/increase/resources/entities.rb +2 -12
  41. data/lib/increase/resources/inbound_real_time_payments_transfers.rb +28 -0
  42. data/lib/increase/resources/simulations/checkbooks.rb +38 -0
  43. data/lib/increase/resources/simulations.rb +4 -0
  44. data/lib/increase/version.rb +1 -1
  45. data/lib/increase.rb +14 -14
  46. data/rbi/increase/client.rbi +6 -12
  47. data/rbi/increase/models/account_number.rbi +86 -173
  48. data/rbi/increase/models/account_number_create_params.rbi +87 -165
  49. data/rbi/increase/models/account_number_list_params.rbi +106 -105
  50. data/rbi/increase/models/account_number_update_params.rbi +105 -190
  51. data/rbi/increase/models/ach_transfer.rbi +35 -23
  52. data/rbi/increase/models/card_payment.rbi +14 -0
  53. data/rbi/increase/models/card_update_params.rbi +17 -15
  54. data/rbi/increase/models/check_transfer.rbi +72 -54
  55. data/rbi/increase/models/check_transfer_create_params.rbi +55 -21
  56. data/rbi/increase/models/checkbook.rbi +507 -0
  57. data/rbi/increase/models/checkbook_check.rbi +142 -0
  58. data/rbi/increase/models/checkbook_check_list_params.rbi +96 -0
  59. data/rbi/increase/models/{oauth_connection_retrieve_params.rbi → checkbook_check_retrieve_params.rbi} +8 -8
  60. data/rbi/increase/models/{oauth_application_retrieve_params.rbi → checkbook_check_stop_params.rbi} +8 -11
  61. data/rbi/increase/models/checkbook_create_params.rbi +178 -0
  62. data/rbi/increase/models/checkbook_list_params.rbi +198 -0
  63. data/rbi/increase/models/checkbook_retrieve_params.rbi +40 -0
  64. data/rbi/increase/models/checkbook_stop_params.rbi +40 -0
  65. data/rbi/increase/models/declined_transaction.rbi +8 -0
  66. data/rbi/increase/models/entity.rbi +0 -97
  67. data/rbi/increase/models/entity_create_params.rbi +0 -119
  68. data/rbi/increase/models/entity_update_params.rbi +0 -108
  69. data/rbi/increase/models/export.rbi +15 -3
  70. data/rbi/increase/models/export_create_params.rbi +27 -3
  71. data/rbi/increase/models/inbound_ach_transfer.rbi +6 -6
  72. data/rbi/increase/models/inbound_check_deposit.rbi +10 -0
  73. data/rbi/increase/models/inbound_real_time_payments_transfer.rbi +8 -0
  74. data/rbi/increase/models/inbound_real_time_payments_transfer_return_params.rbi +61 -0
  75. data/rbi/increase/models/real_time_decision.rbi +134 -3
  76. data/rbi/increase/models/real_time_payments_transfer.rbi +18 -0
  77. data/rbi/increase/models/simulations/checkbook_mail_params.rbi +45 -0
  78. data/rbi/increase/models/transaction.rbi +33 -3
  79. data/rbi/increase/models.rbi +21 -22
  80. data/rbi/increase/resources/account_numbers.rbi +24 -19
  81. data/rbi/increase/resources/checkbook_checks.rbi +69 -0
  82. data/rbi/increase/resources/checkbooks.rbi +96 -0
  83. data/rbi/increase/resources/entities.rbi +0 -11
  84. data/rbi/increase/resources/inbound_real_time_payments_transfers.rbi +19 -0
  85. data/rbi/increase/resources/simulations/checkbooks.rbi +30 -0
  86. data/rbi/increase/resources/simulations.rbi +3 -0
  87. data/sig/increase/client.rbs +4 -8
  88. data/sig/increase/models/account_number.rbs +34 -66
  89. data/sig/increase/models/account_number_create_params.rbs +30 -64
  90. data/sig/increase/models/account_number_list_params.rbs +44 -44
  91. data/sig/increase/models/account_number_update_params.rbs +39 -77
  92. data/sig/increase/models/ach_transfer.rbs +4 -4
  93. data/sig/increase/models/card_payment.rbs +8 -0
  94. data/sig/increase/models/card_update_params.rbs +7 -11
  95. data/sig/increase/models/check_transfer.rbs +59 -49
  96. data/sig/increase/models/check_transfer_create_params.rbs +20 -12
  97. data/sig/increase/models/checkbook.rbs +272 -0
  98. data/sig/increase/models/checkbook_check.rbs +76 -0
  99. data/sig/increase/models/checkbook_check_list_params.rbs +56 -0
  100. data/sig/increase/models/{oauth_connection_retrieve_params.rbs → checkbook_check_retrieve_params.rbs} +6 -6
  101. data/sig/increase/models/{oauth_application_retrieve_params.rbs → checkbook_check_stop_params.rbs} +6 -6
  102. data/sig/increase/models/checkbook_create_params.rbs +90 -0
  103. data/sig/increase/models/checkbook_list_params.rbs +97 -0
  104. data/sig/increase/models/checkbook_retrieve_params.rbs +23 -0
  105. data/sig/increase/models/checkbook_stop_params.rbs +23 -0
  106. data/sig/increase/models/declined_transaction.rbs +5 -0
  107. data/sig/increase/models/entity.rbs +0 -46
  108. data/sig/increase/models/entity_create_params.rbs +0 -55
  109. data/sig/increase/models/entity_update_params.rbs +0 -48
  110. data/sig/increase/models/export.rbs +13 -3
  111. data/sig/increase/models/export_create_params.rbs +7 -0
  112. data/sig/increase/models/inbound_check_deposit.rbs +5 -0
  113. data/sig/increase/models/inbound_real_time_payments_transfer.rbs +5 -0
  114. data/sig/increase/models/inbound_real_time_payments_transfer_return_params.rbs +30 -0
  115. data/sig/increase/models/real_time_decision.rbs +69 -3
  116. data/sig/increase/models/real_time_payments_transfer.rbs +10 -0
  117. data/sig/increase/models/simulations/checkbook_mail_params.rbs +25 -0
  118. data/sig/increase/models/transaction.rbs +26 -5
  119. data/sig/increase/models.rbs +20 -20
  120. data/sig/increase/resources/account_numbers.rbs +5 -5
  121. data/sig/increase/resources/checkbook_checks.rbs +26 -0
  122. data/sig/increase/resources/checkbooks.rbs +33 -0
  123. data/sig/increase/resources/entities.rbs +0 -3
  124. data/sig/increase/resources/inbound_real_time_payments_transfers.rbs +6 -0
  125. data/sig/increase/resources/simulations/checkbooks.rbs +14 -0
  126. data/sig/increase/resources/simulations.rbs +2 -0
  127. metadata +45 -45
  128. data/lib/increase/models/group.rb +0 -57
  129. data/lib/increase/models/group_retrieve_params.rb +0 -14
  130. data/lib/increase/models/oauth_application.rb +0 -111
  131. data/lib/increase/models/oauth_application_list_params.rb +0 -129
  132. data/lib/increase/models/oauth_application_retrieve_params.rb +0 -22
  133. data/lib/increase/models/oauth_connection.rb +0 -107
  134. data/lib/increase/models/oauth_connection_list_params.rb +0 -88
  135. data/lib/increase/models/oauth_connection_retrieve_params.rb +0 -22
  136. data/lib/increase/models/oauth_token.rb +0 -76
  137. data/lib/increase/models/oauth_token_create_params.rb +0 -85
  138. data/lib/increase/resources/groups.rb +0 -32
  139. data/lib/increase/resources/oauth_applications.rb +0 -68
  140. data/lib/increase/resources/oauth_connections.rb +0 -70
  141. data/lib/increase/resources/oauth_tokens.rb +0 -54
  142. data/rbi/increase/models/group.rbi +0 -74
  143. data/rbi/increase/models/group_retrieve_params.rbi +0 -27
  144. data/rbi/increase/models/oauth_application.rbi +0 -146
  145. data/rbi/increase/models/oauth_application_list_params.rbi +0 -263
  146. data/rbi/increase/models/oauth_connection.rbi +0 -142
  147. data/rbi/increase/models/oauth_connection_list_params.rbi +0 -187
  148. data/rbi/increase/models/oauth_token.rbi +0 -106
  149. data/rbi/increase/models/oauth_token_create_params.rbi +0 -133
  150. data/rbi/increase/resources/groups.rbi +0 -21
  151. data/rbi/increase/resources/oauth_applications.rbi +0 -50
  152. data/rbi/increase/resources/oauth_connections.rbi +0 -52
  153. data/rbi/increase/resources/oauth_tokens.rbi +0 -44
  154. data/sig/increase/models/group.rbs +0 -36
  155. data/sig/increase/models/group_retrieve_params.rbs +0 -15
  156. data/sig/increase/models/oauth_application.rbs +0 -74
  157. data/sig/increase/models/oauth_application_list_params.rbs +0 -123
  158. data/sig/increase/models/oauth_connection.rbs +0 -74
  159. data/sig/increase/models/oauth_connection_list_params.rbs +0 -86
  160. data/sig/increase/models/oauth_token.rbs +0 -55
  161. data/sig/increase/models/oauth_token_create_params.rbs +0 -68
  162. data/sig/increase/resources/groups.rbs +0 -11
  163. data/sig/increase/resources/oauth_applications.rbs +0 -20
  164. data/sig/increase/resources/oauth_connections.rbs +0 -20
  165. data/sig/increase/resources/oauth_tokens.rbs +0 -16
@@ -32,10 +32,6 @@ module Increase
32
32
  sig { returns(T.nilable(String)) }
33
33
  attr_accessor :creating_entity_onboarding_session_id
34
34
 
35
- # The entity's description for display purposes.
36
- sig { returns(T.nilable(String)) }
37
- attr_accessor :description
38
-
39
35
  # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the
40
36
  # Entity's details were most recently confirmed.
41
37
  sig { returns(T.nilable(Time)) }
@@ -79,18 +75,6 @@ module Increase
79
75
  end
80
76
  attr_writer :natural_person
81
77
 
82
- # An assessment of the entity’s potential risk of involvement in financial crimes,
83
- # such as money laundering.
84
- sig { returns(T.nilable(Increase::Entity::RiskRating)) }
85
- attr_reader :risk_rating
86
-
87
- sig do
88
- params(
89
- risk_rating: T.nilable(Increase::Entity::RiskRating::OrHash)
90
- ).void
91
- end
92
- attr_writer :risk_rating
93
-
94
78
  # Details of the sole proprietorship entity. Will be present if `structure` is
95
79
  # equal to `sole_proprietorship`.
96
80
  sig { returns(T.nilable(Increase::Entity::SoleProprietorship)) }
@@ -168,14 +152,12 @@ module Increase
168
152
  corporation: T.nilable(Increase::Entity::Corporation::OrHash),
169
153
  created_at: Time,
170
154
  creating_entity_onboarding_session_id: T.nilable(String),
171
- description: T.nilable(String),
172
155
  details_confirmed_at: T.nilable(Time),
173
156
  government_authority:
174
157
  T.nilable(Increase::Entity::GovernmentAuthority::OrHash),
175
158
  idempotency_key: T.nilable(String),
176
159
  joint: T.nilable(Increase::Entity::Joint::OrHash),
177
160
  natural_person: T.nilable(Increase::Entity::NaturalPerson::OrHash),
178
- risk_rating: T.nilable(Increase::Entity::RiskRating::OrHash),
179
161
  sole_proprietorship:
180
162
  T.nilable(Increase::Entity::SoleProprietorship::OrHash),
181
163
  status: Increase::Entity::Status::OrSymbol,
@@ -202,8 +184,6 @@ module Increase
202
184
  # The identifier of the Entity Onboarding Session that was used to create this
203
185
  # Entity, if any.
204
186
  creating_entity_onboarding_session_id:,
205
- # The entity's description for display purposes.
206
- description:,
207
187
  # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the
208
188
  # Entity's details were most recently confirmed.
209
189
  details_confirmed_at:,
@@ -219,9 +199,6 @@ module Increase
219
199
  # Details of the natural person entity. Will be present if `structure` is equal to
220
200
  # `natural_person`.
221
201
  natural_person:,
222
- # An assessment of the entity’s potential risk of involvement in financial crimes,
223
- # such as money laundering.
224
- risk_rating:,
225
202
  # Details of the sole proprietorship entity. Will be present if `structure` is
226
203
  # equal to `sole_proprietorship`.
227
204
  sole_proprietorship:,
@@ -258,14 +235,12 @@ module Increase
258
235
  corporation: T.nilable(Increase::Entity::Corporation),
259
236
  created_at: Time,
260
237
  creating_entity_onboarding_session_id: T.nilable(String),
261
- description: T.nilable(String),
262
238
  details_confirmed_at: T.nilable(Time),
263
239
  government_authority:
264
240
  T.nilable(Increase::Entity::GovernmentAuthority),
265
241
  idempotency_key: T.nilable(String),
266
242
  joint: T.nilable(Increase::Entity::Joint),
267
243
  natural_person: T.nilable(Increase::Entity::NaturalPerson),
268
- risk_rating: T.nilable(Increase::Entity::RiskRating),
269
244
  sole_proprietorship:
270
245
  T.nilable(Increase::Entity::SoleProprietorship),
271
246
  status: Increase::Entity::Status::TaggedSymbol,
@@ -1914,78 +1889,6 @@ module Increase
1914
1889
  end
1915
1890
  end
1916
1891
 
1917
- class RiskRating < Increase::Internal::Type::BaseModel
1918
- OrHash =
1919
- T.type_alias do
1920
- T.any(Increase::Entity::RiskRating, Increase::Internal::AnyHash)
1921
- end
1922
-
1923
- # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the risk
1924
- # rating was performed.
1925
- sig { returns(Time) }
1926
- attr_accessor :rated_at
1927
-
1928
- # The rating given to this entity.
1929
- sig { returns(Increase::Entity::RiskRating::Rating::TaggedSymbol) }
1930
- attr_accessor :rating
1931
-
1932
- # An assessment of the entity’s potential risk of involvement in financial crimes,
1933
- # such as money laundering.
1934
- sig do
1935
- params(
1936
- rated_at: Time,
1937
- rating: Increase::Entity::RiskRating::Rating::OrSymbol
1938
- ).returns(T.attached_class)
1939
- end
1940
- def self.new(
1941
- # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the risk
1942
- # rating was performed.
1943
- rated_at:,
1944
- # The rating given to this entity.
1945
- rating:
1946
- )
1947
- end
1948
-
1949
- sig do
1950
- override.returns(
1951
- {
1952
- rated_at: Time,
1953
- rating: Increase::Entity::RiskRating::Rating::TaggedSymbol
1954
- }
1955
- )
1956
- end
1957
- def to_hash
1958
- end
1959
-
1960
- # The rating given to this entity.
1961
- module Rating
1962
- extend Increase::Internal::Type::Enum
1963
-
1964
- TaggedSymbol =
1965
- T.type_alias { T.all(Symbol, Increase::Entity::RiskRating::Rating) }
1966
- OrSymbol = T.type_alias { T.any(Symbol, String) }
1967
-
1968
- # Minimal risk of involvement in financial crime.
1969
- LOW = T.let(:low, Increase::Entity::RiskRating::Rating::TaggedSymbol)
1970
-
1971
- # Moderate risk of involvement in financial crime.
1972
- MEDIUM =
1973
- T.let(:medium, Increase::Entity::RiskRating::Rating::TaggedSymbol)
1974
-
1975
- # Elevated risk of involvement in financial crime.
1976
- HIGH =
1977
- T.let(:high, Increase::Entity::RiskRating::Rating::TaggedSymbol)
1978
-
1979
- sig do
1980
- override.returns(
1981
- T::Array[Increase::Entity::RiskRating::Rating::TaggedSymbol]
1982
- )
1983
- end
1984
- def self.values
1985
- end
1986
- end
1987
- end
1988
-
1989
1892
  class SoleProprietorship < Increase::Internal::Type::BaseModel
1990
1893
  OrHash =
1991
1894
  T.type_alias do
@@ -27,13 +27,6 @@ module Increase
27
27
  end
28
28
  attr_writer :corporation
29
29
 
30
- # The description you choose to give the entity.
31
- sig { returns(T.nilable(String)) }
32
- attr_reader :description
33
-
34
- sig { params(description: String).void }
35
- attr_writer :description
36
-
37
30
  # Details of the Government Authority entity to create. Required if `structure` is
38
31
  # equal to `government_authority`.
39
32
  sig do
@@ -71,18 +64,6 @@ module Increase
71
64
  end
72
65
  attr_writer :natural_person
73
66
 
74
- # An assessment of the entity's potential risk of involvement in financial crimes,
75
- # such as money laundering.
76
- sig { returns(T.nilable(Increase::EntityCreateParams::RiskRating)) }
77
- attr_reader :risk_rating
78
-
79
- sig do
80
- params(
81
- risk_rating: Increase::EntityCreateParams::RiskRating::OrHash
82
- ).void
83
- end
84
- attr_writer :risk_rating
85
-
86
67
  # Details of the sole proprietorship entity to create. Required if `structure` is
87
68
  # equal to `sole_proprietorship`.
88
69
  sig do
@@ -161,12 +142,10 @@ module Increase
161
142
  params(
162
143
  structure: Increase::EntityCreateParams::Structure::OrSymbol,
163
144
  corporation: Increase::EntityCreateParams::Corporation::OrHash,
164
- description: String,
165
145
  government_authority:
166
146
  Increase::EntityCreateParams::GovernmentAuthority::OrHash,
167
147
  joint: Increase::EntityCreateParams::Joint::OrHash,
168
148
  natural_person: Increase::EntityCreateParams::NaturalPerson::OrHash,
169
- risk_rating: Increase::EntityCreateParams::RiskRating::OrHash,
170
149
  sole_proprietorship:
171
150
  Increase::EntityCreateParams::SoleProprietorship::OrHash,
172
151
  supplemental_documents:
@@ -187,8 +166,6 @@ module Increase
187
166
  # Details of the corporation entity to create. Required if `structure` is equal to
188
167
  # `corporation`.
189
168
  corporation: nil,
190
- # The description you choose to give the entity.
191
- description: nil,
192
169
  # Details of the Government Authority entity to create. Required if `structure` is
193
170
  # equal to `government_authority`.
194
171
  government_authority: nil,
@@ -200,9 +177,6 @@ module Increase
200
177
  # `social_security_number` or `individual_taxpayer_identification_number`
201
178
  # identification methods.
202
179
  natural_person: nil,
203
- # An assessment of the entity's potential risk of involvement in financial crimes,
204
- # such as money laundering.
205
- risk_rating: nil,
206
180
  # Details of the sole proprietorship entity to create. Required if `structure` is
207
181
  # equal to `sole_proprietorship`.
208
182
  sole_proprietorship: nil,
@@ -227,12 +201,10 @@ module Increase
227
201
  {
228
202
  structure: Increase::EntityCreateParams::Structure::OrSymbol,
229
203
  corporation: Increase::EntityCreateParams::Corporation,
230
- description: String,
231
204
  government_authority:
232
205
  Increase::EntityCreateParams::GovernmentAuthority,
233
206
  joint: Increase::EntityCreateParams::Joint,
234
207
  natural_person: Increase::EntityCreateParams::NaturalPerson,
235
- risk_rating: Increase::EntityCreateParams::RiskRating,
236
208
  sole_proprietorship:
237
209
  Increase::EntityCreateParams::SoleProprietorship,
238
210
  supplemental_documents:
@@ -2955,97 +2927,6 @@ module Increase
2955
2927
  end
2956
2928
  end
2957
2929
 
2958
- class RiskRating < Increase::Internal::Type::BaseModel
2959
- OrHash =
2960
- T.type_alias do
2961
- T.any(
2962
- Increase::EntityCreateParams::RiskRating,
2963
- Increase::Internal::AnyHash
2964
- )
2965
- end
2966
-
2967
- # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the risk
2968
- # rating was performed.
2969
- sig { returns(Time) }
2970
- attr_accessor :rated_at
2971
-
2972
- # The rating given to this entity.
2973
- sig do
2974
- returns(Increase::EntityCreateParams::RiskRating::Rating::OrSymbol)
2975
- end
2976
- attr_accessor :rating
2977
-
2978
- # An assessment of the entity's potential risk of involvement in financial crimes,
2979
- # such as money laundering.
2980
- sig do
2981
- params(
2982
- rated_at: Time,
2983
- rating: Increase::EntityCreateParams::RiskRating::Rating::OrSymbol
2984
- ).returns(T.attached_class)
2985
- end
2986
- def self.new(
2987
- # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the risk
2988
- # rating was performed.
2989
- rated_at:,
2990
- # The rating given to this entity.
2991
- rating:
2992
- )
2993
- end
2994
-
2995
- sig do
2996
- override.returns(
2997
- {
2998
- rated_at: Time,
2999
- rating: Increase::EntityCreateParams::RiskRating::Rating::OrSymbol
3000
- }
3001
- )
3002
- end
3003
- def to_hash
3004
- end
3005
-
3006
- # The rating given to this entity.
3007
- module Rating
3008
- extend Increase::Internal::Type::Enum
3009
-
3010
- TaggedSymbol =
3011
- T.type_alias do
3012
- T.all(Symbol, Increase::EntityCreateParams::RiskRating::Rating)
3013
- end
3014
- OrSymbol = T.type_alias { T.any(Symbol, String) }
3015
-
3016
- # Minimal risk of involvement in financial crime.
3017
- LOW =
3018
- T.let(
3019
- :low,
3020
- Increase::EntityCreateParams::RiskRating::Rating::TaggedSymbol
3021
- )
3022
-
3023
- # Moderate risk of involvement in financial crime.
3024
- MEDIUM =
3025
- T.let(
3026
- :medium,
3027
- Increase::EntityCreateParams::RiskRating::Rating::TaggedSymbol
3028
- )
3029
-
3030
- # Elevated risk of involvement in financial crime.
3031
- HIGH =
3032
- T.let(
3033
- :high,
3034
- Increase::EntityCreateParams::RiskRating::Rating::TaggedSymbol
3035
- )
3036
-
3037
- sig do
3038
- override.returns(
3039
- T::Array[
3040
- Increase::EntityCreateParams::RiskRating::Rating::TaggedSymbol
3041
- ]
3042
- )
3043
- end
3044
- def self.values
3045
- end
3046
- end
3047
- end
3048
-
3049
2930
  class SoleProprietorship < Increase::Internal::Type::BaseModel
3050
2931
  OrHash =
3051
2932
  T.type_alias do
@@ -63,18 +63,6 @@ module Increase
63
63
  end
64
64
  attr_writer :natural_person
65
65
 
66
- # An assessment of the entity’s potential risk of involvement in financial crimes,
67
- # such as money laundering.
68
- sig { returns(T.nilable(Increase::EntityUpdateParams::RiskRating)) }
69
- attr_reader :risk_rating
70
-
71
- sig do
72
- params(
73
- risk_rating: Increase::EntityUpdateParams::RiskRating::OrHash
74
- ).void
75
- end
76
- attr_writer :risk_rating
77
-
78
66
  # Details of the sole proprietorship entity to update. If you specify this
79
67
  # parameter and the entity is not a sole proprietorship, the request will fail.
80
68
  sig do
@@ -139,7 +127,6 @@ module Increase
139
127
  government_authority:
140
128
  Increase::EntityUpdateParams::GovernmentAuthority::OrHash,
141
129
  natural_person: Increase::EntityUpdateParams::NaturalPerson::OrHash,
142
- risk_rating: Increase::EntityUpdateParams::RiskRating::OrHash,
143
130
  sole_proprietorship:
144
131
  Increase::EntityUpdateParams::SoleProprietorship::OrHash,
145
132
  terms_agreements:
@@ -166,9 +153,6 @@ module Increase
166
153
  # Details of the natural person entity to update. If you specify this parameter
167
154
  # and the entity is not a natural person, the request will fail.
168
155
  natural_person: nil,
169
- # An assessment of the entity’s potential risk of involvement in financial crimes,
170
- # such as money laundering.
171
- risk_rating: nil,
172
156
  # Details of the sole proprietorship entity to update. If you specify this
173
157
  # parameter and the entity is not a sole proprietorship, the request will fail.
174
158
  sole_proprietorship: nil,
@@ -195,7 +179,6 @@ module Increase
195
179
  government_authority:
196
180
  Increase::EntityUpdateParams::GovernmentAuthority,
197
181
  natural_person: Increase::EntityUpdateParams::NaturalPerson,
198
- risk_rating: Increase::EntityUpdateParams::RiskRating,
199
182
  sole_proprietorship:
200
183
  Increase::EntityUpdateParams::SoleProprietorship,
201
184
  terms_agreements:
@@ -1281,97 +1264,6 @@ module Increase
1281
1264
  end
1282
1265
  end
1283
1266
 
1284
- class RiskRating < Increase::Internal::Type::BaseModel
1285
- OrHash =
1286
- T.type_alias do
1287
- T.any(
1288
- Increase::EntityUpdateParams::RiskRating,
1289
- Increase::Internal::AnyHash
1290
- )
1291
- end
1292
-
1293
- # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the risk
1294
- # rating was performed.
1295
- sig { returns(Time) }
1296
- attr_accessor :rated_at
1297
-
1298
- # The rating given to this entity.
1299
- sig do
1300
- returns(Increase::EntityUpdateParams::RiskRating::Rating::OrSymbol)
1301
- end
1302
- attr_accessor :rating
1303
-
1304
- # An assessment of the entity’s potential risk of involvement in financial crimes,
1305
- # such as money laundering.
1306
- sig do
1307
- params(
1308
- rated_at: Time,
1309
- rating: Increase::EntityUpdateParams::RiskRating::Rating::OrSymbol
1310
- ).returns(T.attached_class)
1311
- end
1312
- def self.new(
1313
- # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the risk
1314
- # rating was performed.
1315
- rated_at:,
1316
- # The rating given to this entity.
1317
- rating:
1318
- )
1319
- end
1320
-
1321
- sig do
1322
- override.returns(
1323
- {
1324
- rated_at: Time,
1325
- rating: Increase::EntityUpdateParams::RiskRating::Rating::OrSymbol
1326
- }
1327
- )
1328
- end
1329
- def to_hash
1330
- end
1331
-
1332
- # The rating given to this entity.
1333
- module Rating
1334
- extend Increase::Internal::Type::Enum
1335
-
1336
- TaggedSymbol =
1337
- T.type_alias do
1338
- T.all(Symbol, Increase::EntityUpdateParams::RiskRating::Rating)
1339
- end
1340
- OrSymbol = T.type_alias { T.any(Symbol, String) }
1341
-
1342
- # Minimal risk of involvement in financial crime.
1343
- LOW =
1344
- T.let(
1345
- :low,
1346
- Increase::EntityUpdateParams::RiskRating::Rating::TaggedSymbol
1347
- )
1348
-
1349
- # Moderate risk of involvement in financial crime.
1350
- MEDIUM =
1351
- T.let(
1352
- :medium,
1353
- Increase::EntityUpdateParams::RiskRating::Rating::TaggedSymbol
1354
- )
1355
-
1356
- # Elevated risk of involvement in financial crime.
1357
- HIGH =
1358
- T.let(
1359
- :high,
1360
- Increase::EntityUpdateParams::RiskRating::Rating::TaggedSymbol
1361
- )
1362
-
1363
- sig do
1364
- override.returns(
1365
- T::Array[
1366
- Increase::EntityUpdateParams::RiskRating::Rating::TaggedSymbol
1367
- ]
1368
- )
1369
- end
1370
- def self.values
1371
- end
1372
- end
1373
- end
1374
-
1375
1267
  class SoleProprietorship < Increase::Internal::Type::BaseModel
1376
1268
  OrHash =
1377
1269
  T.type_alias do
@@ -903,23 +903,35 @@ module Increase
903
903
  end
904
904
  attr_writer :created_at
905
905
 
906
+ # Filter fees by the UTC start date of their fee statement's period, such as
907
+ # `2026-08-01`.
908
+ sig { returns(T.nilable(Date)) }
909
+ attr_accessor :fee_statement_period_start
910
+
906
911
  # Details of the fee CSV export. This field will be present when the `category` is
907
912
  # equal to `fee_csv`.
908
913
  sig do
909
914
  params(
910
- created_at: T.nilable(Increase::Export::FeeCsv::CreatedAt::OrHash)
915
+ created_at: T.nilable(Increase::Export::FeeCsv::CreatedAt::OrHash),
916
+ fee_statement_period_start: T.nilable(Date)
911
917
  ).returns(T.attached_class)
912
918
  end
913
919
  def self.new(
914
920
  # Filter fees by their created date. The time range must not include any fees on
915
921
  # an open fee statement.
916
- created_at:
922
+ created_at:,
923
+ # Filter fees by the UTC start date of their fee statement's period, such as
924
+ # `2026-08-01`.
925
+ fee_statement_period_start:
917
926
  )
918
927
  end
919
928
 
920
929
  sig do
921
930
  override.returns(
922
- { created_at: T.nilable(Increase::Export::FeeCsv::CreatedAt) }
931
+ {
932
+ created_at: T.nilable(Increase::Export::FeeCsv::CreatedAt),
933
+ fee_statement_period_start: T.nilable(Date)
934
+ }
923
935
  )
924
936
  end
925
937
  def to_hash
@@ -709,7 +709,10 @@ module Increase
709
709
  )
710
710
  end
711
711
 
712
- # Filter results by time range on the `created_at` attribute.
712
+ # Filter exported Fees by the time they were created. This suits historical
713
+ # exports across many fee statements. To get all of the Fees for a given fee
714
+ # statement period, we recommend using `fee_statement_period_start` instead. The
715
+ # time range must not include any Fees on an open fee statement.
713
716
  sig do
714
717
  returns(T.nilable(Increase::ExportCreateParams::FeeCsv::CreatedAt))
715
718
  end
@@ -722,6 +725,15 @@ module Increase
722
725
  end
723
726
  attr_writer :created_at
724
727
 
728
+ # Filter exported Fees to the fee statements whose period starts on this UTC date,
729
+ # such as `2026-08-01`. Use this filter to export all of the Fees on a fee
730
+ # statement. The matching fee statements must be closed.
731
+ sig { returns(T.nilable(Date)) }
732
+ attr_reader :fee_statement_period_start
733
+
734
+ sig { params(fee_statement_period_start: Date).void }
735
+ attr_writer :fee_statement_period_start
736
+
725
737
  # Filter exported Fees to the specified Program.
726
738
  sig { returns(T.nilable(String)) }
727
739
  attr_reader :program_id
@@ -733,12 +745,20 @@ module Increase
733
745
  sig do
734
746
  params(
735
747
  created_at: Increase::ExportCreateParams::FeeCsv::CreatedAt::OrHash,
748
+ fee_statement_period_start: Date,
736
749
  program_id: String
737
750
  ).returns(T.attached_class)
738
751
  end
739
752
  def self.new(
740
- # Filter results by time range on the `created_at` attribute.
753
+ # Filter exported Fees by the time they were created. This suits historical
754
+ # exports across many fee statements. To get all of the Fees for a given fee
755
+ # statement period, we recommend using `fee_statement_period_start` instead. The
756
+ # time range must not include any Fees on an open fee statement.
741
757
  created_at: nil,
758
+ # Filter exported Fees to the fee statements whose period starts on this UTC date,
759
+ # such as `2026-08-01`. Use this filter to export all of the Fees on a fee
760
+ # statement. The matching fee statements must be closed.
761
+ fee_statement_period_start: nil,
742
762
  # Filter exported Fees to the specified Program.
743
763
  program_id: nil
744
764
  )
@@ -748,6 +768,7 @@ module Increase
748
768
  override.returns(
749
769
  {
750
770
  created_at: Increase::ExportCreateParams::FeeCsv::CreatedAt,
771
+ fee_statement_period_start: Date,
751
772
  program_id: String
752
773
  }
753
774
  )
@@ -796,7 +817,10 @@ module Increase
796
817
  sig { params(on_or_before: Time).void }
797
818
  attr_writer :on_or_before
798
819
 
799
- # Filter results by time range on the `created_at` attribute.
820
+ # Filter exported Fees by the time they were created. This suits historical
821
+ # exports across many fee statements. To get all of the Fees for a given fee
822
+ # statement period, we recommend using `fee_statement_period_start` instead. The
823
+ # time range must not include any Fees on an open fee statement.
800
824
  sig do
801
825
  params(
802
826
  after: Time,
@@ -143,8 +143,8 @@ module Increase
143
143
  sig { returns(T.nilable(String)) }
144
144
  attr_accessor :receiver_name
145
145
 
146
- # A subhash containing information about when and how the transfer settled at the
147
- # Federal Reserve.
146
+ # A subhash containing information about when the transfer settled (or will
147
+ # settle) at the Federal Reserve.
148
148
  sig { returns(Increase::InboundACHTransfer::Settlement) }
149
149
  attr_reader :settlement
150
150
 
@@ -281,8 +281,8 @@ module Increase
281
281
  receiver_id_number:,
282
282
  # The name of the receiver of the transfer.
283
283
  receiver_name:,
284
- # A subhash containing information about when and how the transfer settled at the
285
- # Federal Reserve.
284
+ # A subhash containing information about when the transfer settled (or will
285
+ # settle) at the Federal Reserve.
286
286
  settlement:,
287
287
  # The Standard Entry Class (SEC) code of the transfer.
288
288
  standard_entry_class_code:,
@@ -1539,8 +1539,8 @@ module Increase
1539
1539
  end
1540
1540
  attr_accessor :settlement_schedule
1541
1541
 
1542
- # A subhash containing information about when and how the transfer settled at the
1543
- # Federal Reserve.
1542
+ # A subhash containing information about when the transfer settled (or will
1543
+ # settle) at the Federal Reserve.
1544
1544
  sig do
1545
1545
  params(
1546
1546
  settled_at: Time,
@@ -60,6 +60,11 @@ module Increase
60
60
  sig { returns(T.nilable(String)) }
61
61
  attr_accessor :check_transfer_id
62
62
 
63
+ # If this deposit is for an existing Checkbook Check, the identifier of that
64
+ # Checkbook Check.
65
+ sig { returns(T.nilable(String)) }
66
+ attr_accessor :checkbook_check_id
67
+
63
68
  # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
64
69
  # the deposit was attempted.
65
70
  sig { returns(Time) }
@@ -134,6 +139,7 @@ module Increase
134
139
  bank_of_first_deposit_routing_number: T.nilable(String),
135
140
  check_number: T.nilable(String),
136
141
  check_transfer_id: T.nilable(String),
142
+ checkbook_check_id: T.nilable(String),
137
143
  created_at: Time,
138
144
  currency: Increase::InboundCheckDeposit::Currency::OrSymbol,
139
145
  declined_at: T.nilable(Time),
@@ -179,6 +185,9 @@ module Increase
179
185
  # If this deposit is for an existing Check Transfer, the identifier of that Check
180
186
  # Transfer.
181
187
  check_transfer_id:,
188
+ # If this deposit is for an existing Checkbook Check, the identifier of that
189
+ # Checkbook Check.
190
+ checkbook_check_id:,
182
191
  # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
183
192
  # the deposit was attempted.
184
193
  created_at:,
@@ -224,6 +233,7 @@ module Increase
224
233
  bank_of_first_deposit_routing_number: T.nilable(String),
225
234
  check_number: T.nilable(String),
226
235
  check_transfer_id: T.nilable(String),
236
+ checkbook_check_id: T.nilable(String),
227
237
  created_at: Time,
228
238
  currency: Increase::InboundCheckDeposit::Currency::TaggedSymbol,
229
239
  declined_at: T.nilable(Time),
@@ -95,6 +95,10 @@ module Increase
95
95
  sig { returns(T.nilable(String)) }
96
96
  attr_accessor :end_to_end_identification
97
97
 
98
+ # The identifier of the Real-Time Payments Transfer this transfer returns, if any.
99
+ sig { returns(T.nilable(String)) }
100
+ attr_accessor :return_of_real_time_payments_transfer_id
101
+
98
102
  # The lifecycle status of the transfer.
99
103
  sig do
100
104
  returns(Increase::InboundRealTimePaymentsTransfer::Status::TaggedSymbol)
@@ -140,6 +144,7 @@ module Increase
140
144
  Increase::InboundRealTimePaymentsTransfer::Decline::OrHash
141
145
  ),
142
146
  end_to_end_identification: T.nilable(String),
147
+ return_of_real_time_payments_transfer_id: T.nilable(String),
143
148
  status: Increase::InboundRealTimePaymentsTransfer::Status::OrSymbol,
144
149
  transaction_identification: String,
145
150
  type: Increase::InboundRealTimePaymentsTransfer::Type::OrSymbol,
@@ -175,6 +180,8 @@ module Increase
175
180
  decline:,
176
181
  # A free-form reference string set by the sender, to help identify the transfer.
177
182
  end_to_end_identification:,
183
+ # The identifier of the Real-Time Payments Transfer this transfer returns, if any.
184
+ return_of_real_time_payments_transfer_id:,
178
185
  # The lifecycle status of the transfer.
179
186
  status:,
180
187
  # The Real-Time Payments network identification of the transfer.
@@ -208,6 +215,7 @@ module Increase
208
215
  decline:
209
216
  T.nilable(Increase::InboundRealTimePaymentsTransfer::Decline),
210
217
  end_to_end_identification: T.nilable(String),
218
+ return_of_real_time_payments_transfer_id: T.nilable(String),
211
219
  status:
212
220
  Increase::InboundRealTimePaymentsTransfer::Status::TaggedSymbol,
213
221
  transaction_identification: String,