increase 1.348.0 → 1.349.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 (47) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/increase/models/account_create_params.rb +15 -15
  4. data/lib/increase/models/entity.rb +293 -1
  5. data/lib/increase/models/event.rb +3 -0
  6. data/lib/increase/models/event_list_params.rb +3 -0
  7. data/lib/increase/models/event_subscription.rb +3 -0
  8. data/lib/increase/models/event_subscription_create_params.rb +3 -0
  9. data/lib/increase/models/inbound_check_deposit.rb +5 -2
  10. data/lib/increase/models/inbound_fednow_transfer.rb +18 -1
  11. data/lib/increase/models/pending_transaction.rb +7 -7
  12. data/lib/increase/models/pending_transaction_list_params.rb +1 -1
  13. data/lib/increase/models/physical_card_create_params.rb +6 -3
  14. data/lib/increase/models/simulations/inbound_check_deposit_adjustment_params.rb +8 -11
  15. data/lib/increase/models/transaction.rb +5 -2
  16. data/lib/increase/models/unwrap_webhook_event.rb +3 -0
  17. data/lib/increase/resources/physical_cards.rb +2 -1
  18. data/lib/increase/resources/simulations/inbound_check_deposits.rb +4 -1
  19. data/lib/increase/version.rb +1 -1
  20. data/rbi/increase/models/account_create_params.rbi +37 -21
  21. data/rbi/increase/models/entity.rbi +491 -0
  22. data/rbi/increase/models/event.rbi +7 -0
  23. data/rbi/increase/models/event_list_params.rbi +7 -0
  24. data/rbi/increase/models/event_subscription.rbi +7 -0
  25. data/rbi/increase/models/event_subscription_create_params.rbi +7 -0
  26. data/rbi/increase/models/inbound_check_deposit.rbi +4 -2
  27. data/rbi/increase/models/inbound_fednow_transfer.rbi +16 -0
  28. data/rbi/increase/models/pending_transaction.rbi +7 -7
  29. data/rbi/increase/models/pending_transaction_list_params.rbi +1 -1
  30. data/rbi/increase/models/physical_card_create_params.rbi +6 -3
  31. data/rbi/increase/models/simulations/inbound_check_deposit_adjustment_params.rbi +8 -23
  32. data/rbi/increase/models/transaction.rbi +4 -2
  33. data/rbi/increase/models/unwrap_webhook_event.rbi +7 -0
  34. data/rbi/increase/resources/physical_cards.rbi +2 -1
  35. data/rbi/increase/resources/simulations/inbound_check_deposits.rbi +4 -1
  36. data/sig/increase/models/account_create_params.rbs +20 -12
  37. data/sig/increase/models/entity.rbs +227 -1
  38. data/sig/increase/models/event.rbs +4 -0
  39. data/sig/increase/models/event_list_params.rbs +4 -0
  40. data/sig/increase/models/event_subscription.rbs +4 -0
  41. data/sig/increase/models/event_subscription_create_params.rbs +4 -0
  42. data/sig/increase/models/inbound_fednow_transfer.rbs +10 -0
  43. data/sig/increase/models/pending_transaction.rbs +1 -1
  44. data/sig/increase/models/pending_transaction_list_params.rbs +1 -1
  45. data/sig/increase/models/simulations/inbound_check_deposit_adjustment_params.rbs +1 -15
  46. data/sig/increase/models/unwrap_webhook_event.rbs +4 -0
  47. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 4906aa8f308343c378626b6265d93e48bf8af288708b41db066670fa53d7fa8c
4
- data.tar.gz: eec002779689677251e1de2b783090b1ed44467b1f6382abaf26d02c3b6968ba
3
+ metadata.gz: 23cf98582ddaa22a0c6fcea1ae351f11324ff09dd6fc637883436dda459fe05c
4
+ data.tar.gz: 92fadfd622e3083e74f486cdbb8910d7021146294aa824c671edfbd7c35fdd7f
5
5
  SHA512:
6
- metadata.gz: 6169cec9a4d096d4c450488c0d7a8162825211274c0dfdeb33bea731b5a5ffd635c3ced4951af088001c71f73c7ce88f4fb34145d0a6f9d54f087cda8a111850
7
- data.tar.gz: 25f2bd53fb1eb615af2dab37b0a527fc52130bcd80b721a1d01c7a91ea84ae9865f35314a8a3935135448283abfb5acab3074fcb9b4c6b4d3310b8407b607a29
6
+ metadata.gz: 18170e8cff606f8ef8248eb56d106e6ecac5a7c123b351505a02cef6836dbf2f1ab459122872c136f8c50c08e62c092529cbafc73018ae3157469939d0c1b86d
7
+ data.tar.gz: 34c18ed49cc6b7ad16bdac6a4dae2bb364e22387fd50554635bc71ab2a926eb7db67c8200cea3f691f64eff52a1dcaa342686a8a4e581bc10c411dfa7eaca69a
data/README.md CHANGED
@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
15
15
  <!-- x-release-please-start-version -->
16
16
 
17
17
  ```ruby
18
- gem "increase", "~> 1.348.0"
18
+ gem "increase", "~> 1.349.0"
19
19
  ```
20
20
 
21
21
  <!-- x-release-please-end -->
@@ -92,28 +92,28 @@ module Increase
92
92
  # The number of days after the statement date that the Account can be past due
93
93
  # before being considered delinquent.
94
94
  #
95
- # @return [Integer]
96
- required :grace_period_days, Integer
95
+ # @return [Integer, nil]
96
+ optional :grace_period_days, Integer
97
+
98
+ # @!attribute maturity_date
99
+ # The date on which the loan matures.
100
+ #
101
+ # @return [Date, nil]
102
+ optional :maturity_date, Date
97
103
 
98
104
  # @!attribute statement_day_of_month
99
105
  # The day of the month on which the loan statement is generated.
100
106
  #
101
- # @return [Integer]
102
- required :statement_day_of_month, Integer
107
+ # @return [Integer, nil]
108
+ optional :statement_day_of_month, Integer
103
109
 
104
110
  # @!attribute statement_payment_type
105
111
  # The type of statement payment for the account.
106
112
  #
107
- # @return [Symbol, Increase::Models::AccountCreateParams::Loan::StatementPaymentType]
108
- required :statement_payment_type, enum: -> { Increase::AccountCreateParams::Loan::StatementPaymentType }
109
-
110
- # @!attribute maturity_date
111
- # The date on which the loan matures.
112
- #
113
- # @return [Date, nil]
114
- optional :maturity_date, Date
113
+ # @return [Symbol, Increase::Models::AccountCreateParams::Loan::StatementPaymentType, nil]
114
+ optional :statement_payment_type, enum: -> { Increase::AccountCreateParams::Loan::StatementPaymentType }
115
115
 
116
- # @!method initialize(credit_limit:, grace_period_days:, statement_day_of_month:, statement_payment_type:, maturity_date: nil)
116
+ # @!method initialize(credit_limit:, grace_period_days: nil, maturity_date: nil, statement_day_of_month: nil, statement_payment_type: nil)
117
117
  # The loan details for the account.
118
118
  #
119
119
  # @param credit_limit [Integer] The maximum amount of money that can be drawn from the Account.
@@ -122,12 +122,12 @@ module Increase
122
122
  # The number of days after the statement date that the Account can be past due
123
123
  # before being considered delinquent.
124
124
  #
125
+ # @param maturity_date [Date] The date on which the loan matures.
126
+ #
125
127
  # @param statement_day_of_month [Integer] The day of the month on which the loan statement is generated.
126
128
  #
127
129
  # @param statement_payment_type [Symbol, Increase::Models::AccountCreateParams::Loan::StatementPaymentType]
128
130
  # The type of statement payment for the account.
129
- #
130
- # @param maturity_date [Date] The date on which the loan matures.
131
131
 
132
132
  # The type of statement payment for the account.
133
133
  #
@@ -79,6 +79,13 @@ module Increase
79
79
  # @return [Increase::Models::Entity::RiskRating, nil]
80
80
  required :risk_rating, -> { Increase::Entity::RiskRating }, nil?: true
81
81
 
82
+ # @!attribute sole_proprietorship
83
+ # Details of the sole proprietorship entity. Will be present if `structure` is
84
+ # equal to `sole_proprietorship`.
85
+ #
86
+ # @return [Increase::Models::Entity::SoleProprietorship, nil]
87
+ required :sole_proprietorship, -> { Increase::Entity::SoleProprietorship }, nil?: true
88
+
82
89
  # @!attribute status
83
90
  # The status of the entity.
84
91
  #
@@ -135,7 +142,7 @@ module Increase
135
142
  # @return [Increase::Models::Entity::Validation, nil]
136
143
  required :validation, -> { Increase::Entity::Validation }, nil?: true
137
144
 
138
- # @!method initialize(id:, corporation:, created_at:, creating_entity_onboarding_session_id:, description:, details_confirmed_at:, government_authority:, idempotency_key:, joint:, natural_person:, risk_rating:, status:, structure:, supplemental_documents:, terms_agreements:, third_party_verification:, trust:, type:, validation:)
145
+ # @!method initialize(id:, corporation:, created_at:, creating_entity_onboarding_session_id:, description:, details_confirmed_at:, government_authority:, idempotency_key:, joint:, natural_person:, risk_rating:, sole_proprietorship:, status:, structure:, supplemental_documents:, terms_agreements:, third_party_verification:, trust:, type:, validation:)
139
146
  # Entities are the legal entities that own accounts. They can be people,
140
147
  # corporations, joint accounts, trusts, or government authorities. To learn more,
141
148
  # see [Entities](/documentation/entities).
@@ -180,6 +187,10 @@ module Increase
180
187
  # An assessment of the entity’s potential risk of involvement in financial crimes,
181
188
  # such as money laundering.
182
189
  #
190
+ # @param sole_proprietorship [Increase::Models::Entity::SoleProprietorship, nil]
191
+ # Details of the sole proprietorship entity. Will be present if `structure` is
192
+ # equal to `sole_proprietorship`.
193
+ #
183
194
  # @param status [Symbol, Increase::Models::Entity::Status] The status of the entity.
184
195
  #
185
196
  # @param structure [Symbol, Increase::Models::Entity::Structure] The entity's legal structure.
@@ -1154,6 +1165,284 @@ module Increase
1154
1165
  end
1155
1166
  end
1156
1167
 
1168
+ # @see Increase::Models::Entity#sole_proprietorship
1169
+ class SoleProprietorship < Increase::Internal::Type::BaseModel
1170
+ # @!attribute address
1171
+ # The sole proprietorship's address.
1172
+ #
1173
+ # @return [Increase::Models::Entity::SoleProprietorship::Address]
1174
+ required :address, -> { Increase::Entity::SoleProprietorship::Address }
1175
+
1176
+ # @!attribute doing_business_as_name
1177
+ # The name under which the sole proprietorship does business.
1178
+ #
1179
+ # @return [String, nil]
1180
+ required :doing_business_as_name, String, nil?: true
1181
+
1182
+ # @!attribute email
1183
+ # An email address for the sole proprietorship.
1184
+ #
1185
+ # @return [String, nil]
1186
+ required :email, String, nil?: true
1187
+
1188
+ # @!attribute industry_code
1189
+ # The numeric North American Industry Classification System (NAICS) code submitted
1190
+ # for the sole proprietorship.
1191
+ #
1192
+ # @return [String, nil]
1193
+ required :industry_code, String, nil?: true
1194
+
1195
+ # @!attribute sole_proprietor
1196
+ # The individual who operates the sole proprietorship.
1197
+ #
1198
+ # @return [Increase::Models::Entity::SoleProprietorship::SoleProprietor]
1199
+ required :sole_proprietor, -> { Increase::Entity::SoleProprietorship::SoleProprietor }
1200
+
1201
+ # @!attribute tax_identifier
1202
+ # The Employer Identification Number (EIN) for the sole proprietorship.
1203
+ #
1204
+ # @return [String, nil]
1205
+ required :tax_identifier, String, nil?: true
1206
+
1207
+ # @!attribute website
1208
+ # The sole proprietorship's website.
1209
+ #
1210
+ # @return [String, nil]
1211
+ required :website, String, nil?: true
1212
+
1213
+ # @!method initialize(address:, doing_business_as_name:, email:, industry_code:, sole_proprietor:, tax_identifier:, website:)
1214
+ # Details of the sole proprietorship entity. Will be present if `structure` is
1215
+ # equal to `sole_proprietorship`.
1216
+ #
1217
+ # @param address [Increase::Models::Entity::SoleProprietorship::Address] The sole proprietorship's address.
1218
+ #
1219
+ # @param doing_business_as_name [String, nil] The name under which the sole proprietorship does business.
1220
+ #
1221
+ # @param email [String, nil] An email address for the sole proprietorship.
1222
+ #
1223
+ # @param industry_code [String, nil]
1224
+ # The numeric North American Industry Classification System (NAICS) code submitted
1225
+ # for the sole proprietorship.
1226
+ #
1227
+ # @param sole_proprietor [Increase::Models::Entity::SoleProprietorship::SoleProprietor]
1228
+ # The individual who operates the sole proprietorship.
1229
+ #
1230
+ # @param tax_identifier [String, nil] The Employer Identification Number (EIN) for the sole proprietorship.
1231
+ #
1232
+ # @param website [String, nil] The sole proprietorship's website.
1233
+
1234
+ # @see Increase::Models::Entity::SoleProprietorship#address
1235
+ class Address < Increase::Internal::Type::BaseModel
1236
+ # @!attribute city
1237
+ # The city, district, town, or village of the address.
1238
+ #
1239
+ # @return [String, nil]
1240
+ required :city, String, nil?: true
1241
+
1242
+ # @!attribute country
1243
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
1244
+ #
1245
+ # @return [String]
1246
+ required :country, String
1247
+
1248
+ # @!attribute line1
1249
+ # The first line of the address.
1250
+ #
1251
+ # @return [String]
1252
+ required :line1, String
1253
+
1254
+ # @!attribute line2
1255
+ # The second line of the address.
1256
+ #
1257
+ # @return [String, nil]
1258
+ required :line2, String, nil?: true
1259
+
1260
+ # @!attribute state
1261
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
1262
+ # state, province, or region of the address.
1263
+ #
1264
+ # @return [String, nil]
1265
+ required :state, String, nil?: true
1266
+
1267
+ # @!attribute zip
1268
+ # The ZIP or postal code of the address.
1269
+ #
1270
+ # @return [String, nil]
1271
+ required :zip, String, nil?: true
1272
+
1273
+ # @!method initialize(city:, country:, line1:, line2:, state:, zip:)
1274
+ # The sole proprietorship's address.
1275
+ #
1276
+ # @param city [String, nil] The city, district, town, or village of the address.
1277
+ #
1278
+ # @param country [String] The two-letter ISO 3166-1 alpha-2 code for the country of the address.
1279
+ #
1280
+ # @param line1 [String] The first line of the address.
1281
+ #
1282
+ # @param line2 [String, nil] The second line of the address.
1283
+ #
1284
+ # @param state [String, nil]
1285
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
1286
+ # state, province, or region of the address.
1287
+ #
1288
+ # @param zip [String, nil] The ZIP or postal code of the address.
1289
+ end
1290
+
1291
+ # @see Increase::Models::Entity::SoleProprietorship#sole_proprietor
1292
+ class SoleProprietor < Increase::Internal::Type::BaseModel
1293
+ # @!attribute address
1294
+ # The person's address.
1295
+ #
1296
+ # @return [Increase::Models::Entity::SoleProprietorship::SoleProprietor::Address]
1297
+ required :address, -> { Increase::Entity::SoleProprietorship::SoleProprietor::Address }
1298
+
1299
+ # @!attribute date_of_birth
1300
+ # The person's date of birth in YYYY-MM-DD format.
1301
+ #
1302
+ # @return [Date]
1303
+ required :date_of_birth, Date
1304
+
1305
+ # @!attribute identification
1306
+ # A means of verifying the person's identity.
1307
+ #
1308
+ # @return [Increase::Models::Entity::SoleProprietorship::SoleProprietor::Identification, nil]
1309
+ required :identification,
1310
+ -> { Increase::Entity::SoleProprietorship::SoleProprietor::Identification },
1311
+ nil?: true
1312
+
1313
+ # @!attribute name
1314
+ # The person's legal name.
1315
+ #
1316
+ # @return [String]
1317
+ required :name, String
1318
+
1319
+ # @!method initialize(address:, date_of_birth:, identification:, name:)
1320
+ # The individual who operates the sole proprietorship.
1321
+ #
1322
+ # @param address [Increase::Models::Entity::SoleProprietorship::SoleProprietor::Address]
1323
+ # The person's address.
1324
+ #
1325
+ # @param date_of_birth [Date] The person's date of birth in YYYY-MM-DD format.
1326
+ #
1327
+ # @param identification [Increase::Models::Entity::SoleProprietorship::SoleProprietor::Identification, nil]
1328
+ # A means of verifying the person's identity.
1329
+ #
1330
+ # @param name [String] The person's legal name.
1331
+
1332
+ # @see Increase::Models::Entity::SoleProprietorship::SoleProprietor#address
1333
+ class Address < Increase::Internal::Type::BaseModel
1334
+ # @!attribute city
1335
+ # The city, district, town, or village of the address.
1336
+ #
1337
+ # @return [String, nil]
1338
+ required :city, String, nil?: true
1339
+
1340
+ # @!attribute country
1341
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
1342
+ #
1343
+ # @return [String]
1344
+ required :country, String
1345
+
1346
+ # @!attribute line1
1347
+ # The first line of the address.
1348
+ #
1349
+ # @return [String]
1350
+ required :line1, String
1351
+
1352
+ # @!attribute line2
1353
+ # The second line of the address.
1354
+ #
1355
+ # @return [String, nil]
1356
+ required :line2, String, nil?: true
1357
+
1358
+ # @!attribute state
1359
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
1360
+ # state, province, or region of the address.
1361
+ #
1362
+ # @return [String, nil]
1363
+ required :state, String, nil?: true
1364
+
1365
+ # @!attribute zip
1366
+ # The ZIP or postal code of the address.
1367
+ #
1368
+ # @return [String, nil]
1369
+ required :zip, String, nil?: true
1370
+
1371
+ # @!method initialize(city:, country:, line1:, line2:, state:, zip:)
1372
+ # The person's address.
1373
+ #
1374
+ # @param city [String, nil] The city, district, town, or village of the address.
1375
+ #
1376
+ # @param country [String] The two-letter ISO 3166-1 alpha-2 code for the country of the address.
1377
+ #
1378
+ # @param line1 [String] The first line of the address.
1379
+ #
1380
+ # @param line2 [String, nil] The second line of the address.
1381
+ #
1382
+ # @param state [String, nil]
1383
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
1384
+ # state, province, or region of the address.
1385
+ #
1386
+ # @param zip [String, nil] The ZIP or postal code of the address.
1387
+ end
1388
+
1389
+ # @see Increase::Models::Entity::SoleProprietorship::SoleProprietor#identification
1390
+ class Identification < Increase::Internal::Type::BaseModel
1391
+ # @!attribute method_
1392
+ # A method that can be used to verify the individual's identity.
1393
+ #
1394
+ # @return [Symbol, Increase::Models::Entity::SoleProprietorship::SoleProprietor::Identification::Method]
1395
+ required :method_,
1396
+ enum: -> {
1397
+ Increase::Entity::SoleProprietorship::SoleProprietor::Identification::Method
1398
+ },
1399
+ api_name: :method
1400
+
1401
+ # @!attribute number_last4
1402
+ # The last 4 digits of the identification number that can be used to verify the
1403
+ # individual's identity.
1404
+ #
1405
+ # @return [String]
1406
+ required :number_last4, String
1407
+
1408
+ # @!method initialize(method_:, number_last4:)
1409
+ # A means of verifying the person's identity.
1410
+ #
1411
+ # @param method_ [Symbol, Increase::Models::Entity::SoleProprietorship::SoleProprietor::Identification::Method]
1412
+ # A method that can be used to verify the individual's identity.
1413
+ #
1414
+ # @param number_last4 [String]
1415
+ # The last 4 digits of the identification number that can be used to verify the
1416
+ # individual's identity.
1417
+
1418
+ # A method that can be used to verify the individual's identity.
1419
+ #
1420
+ # @see Increase::Models::Entity::SoleProprietorship::SoleProprietor::Identification#method_
1421
+ module Method
1422
+ extend Increase::Internal::Type::Enum
1423
+
1424
+ # A social security number.
1425
+ SOCIAL_SECURITY_NUMBER = :social_security_number
1426
+
1427
+ # An individual taxpayer identification number (ITIN).
1428
+ INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER = :individual_taxpayer_identification_number
1429
+
1430
+ # A passport number.
1431
+ PASSPORT = :passport
1432
+
1433
+ # A driver's license number.
1434
+ DRIVERS_LICENSE = :drivers_license
1435
+
1436
+ # Another identifying document.
1437
+ OTHER = :other
1438
+
1439
+ # @!method self.values
1440
+ # @return [Array<Symbol>]
1441
+ end
1442
+ end
1443
+ end
1444
+ end
1445
+
1157
1446
  # The status of the entity.
1158
1447
  #
1159
1448
  # @see Increase::Models::Entity#status
@@ -1194,6 +1483,9 @@ module Increase
1194
1483
  # A government authority.
1195
1484
  GOVERNMENT_AUTHORITY = :government_authority
1196
1485
 
1486
+ # A sole proprietorship.
1487
+ SOLE_PROPRIETORSHIP = :sole_proprietorship
1488
+
1197
1489
  # @!method self.values
1198
1490
  # @return [Array<Symbol>]
1199
1491
  end
@@ -370,6 +370,9 @@ module Increase
370
370
  # Occurs whenever a Physical Check is updated.
371
371
  PHYSICAL_CHECK_UPDATED = :"physical_check.updated"
372
372
 
373
+ # Occurs whenever a Plaid Processor Token is created.
374
+ PLAID_PROCESSOR_TOKEN_CREATED = :"plaid_processor_token.created"
375
+
373
376
  # Occurs whenever a Checkbook is created.
374
377
  CHECKBOOK_CREATED = :"checkbook.created"
375
378
 
@@ -382,6 +382,9 @@ module Increase
382
382
  # Occurs whenever a Physical Check is updated.
383
383
  PHYSICAL_CHECK_UPDATED = :"physical_check.updated"
384
384
 
385
+ # Occurs whenever a Plaid Processor Token is created.
386
+ PLAID_PROCESSOR_TOKEN_CREATED = :"plaid_processor_token.created"
387
+
385
388
  # Occurs whenever a Checkbook is created.
386
389
  CHECKBOOK_CREATED = :"checkbook.created"
387
390
 
@@ -411,6 +411,9 @@ module Increase
411
411
  # Occurs whenever a Physical Check is updated.
412
412
  PHYSICAL_CHECK_UPDATED = :"physical_check.updated"
413
413
 
414
+ # Occurs whenever a Plaid Processor Token is created.
415
+ PLAID_PROCESSOR_TOKEN_CREATED = :"plaid_processor_token.created"
416
+
414
417
  # Occurs whenever a Checkbook is created.
415
418
  CHECKBOOK_CREATED = :"checkbook.created"
416
419
 
@@ -380,6 +380,9 @@ module Increase
380
380
  # Occurs whenever a Physical Check is updated.
381
381
  PHYSICAL_CHECK_UPDATED = :"physical_check.updated"
382
382
 
383
+ # Occurs whenever a Plaid Processor Token is created.
384
+ PLAID_PROCESSOR_TOKEN_CREATED = :"plaid_processor_token.created"
385
+
383
386
  # Occurs whenever a Checkbook is created.
384
387
  CHECKBOOK_CREATED = :"checkbook.created"
385
388
 
@@ -231,7 +231,8 @@ module Increase
231
231
  required :adjusted_at, Time
232
232
 
233
233
  # @!attribute amount
234
- # The amount of the adjustment.
234
+ # The amount of the adjustment in USD cents. A positive amount is a credit to your
235
+ # account and a negative amount is a debit.
235
236
  #
236
237
  # @return [Integer]
237
238
  required :amount, Integer
@@ -251,7 +252,9 @@ module Increase
251
252
  # @!method initialize(adjusted_at:, amount:, reason:, transaction_id:)
252
253
  # @param adjusted_at [Time] The time at which the return adjustment was received.
253
254
  #
254
- # @param amount [Integer] The amount of the adjustment.
255
+ # @param amount [Integer]
256
+ # The amount of the adjustment in USD cents. A positive amount is a credit to your
257
+ # account and a negative amount is a debit.
255
258
  #
256
259
  # @param reason [Symbol, Increase::Models::InboundCheckDeposit::Adjustment::Reason]
257
260
  # The reason for the adjustment.
@@ -78,6 +78,12 @@ module Increase
78
78
  # @return [Increase::Models::InboundFednowTransfer::Decline, nil]
79
79
  required :decline, -> { Increase::InboundFednowTransfer::Decline }, nil?: true
80
80
 
81
+ # @!attribute end_to_end_identification
82
+ # A free-form reference string set by the sender, to help identify the transfer.
83
+ #
84
+ # @return [String, nil]
85
+ required :end_to_end_identification, String, nil?: true
86
+
81
87
  # @!attribute status
82
88
  # The lifecycle status of the transfer.
83
89
  #
@@ -91,6 +97,12 @@ module Increase
91
97
  # @return [String, nil]
92
98
  required :transaction_id, String, nil?: true
93
99
 
100
+ # @!attribute transaction_identification
101
+ # The FedNow network identification of the transfer.
102
+ #
103
+ # @return [String, nil]
104
+ required :transaction_identification, String, nil?: true
105
+
94
106
  # @!attribute type
95
107
  # A constant representing the object's type. For this resource it will always be
96
108
  # `inbound_fednow_transfer`.
@@ -112,7 +124,7 @@ module Increase
112
124
  # @return [String, nil]
113
125
  required :unstructured_remittance_information, String, nil?: true
114
126
 
115
- # @!method initialize(id:, account_id:, account_number_id:, amount:, confirmation:, created_at:, creditor_name:, currency:, debtor_account_number:, debtor_name:, debtor_routing_number:, decline:, status:, transaction_id:, type:, unique_end_to_end_transaction_reference:, unstructured_remittance_information:)
127
+ # @!method initialize(id:, account_id:, account_number_id:, amount:, confirmation:, created_at:, creditor_name:, currency:, debtor_account_number:, debtor_name:, debtor_routing_number:, decline:, end_to_end_identification:, status:, transaction_id:, transaction_identification:, type:, unique_end_to_end_transaction_reference:, unstructured_remittance_information:)
116
128
  # An Inbound FedNow Transfer is a FedNow transfer initiated outside of Increase to
117
129
  # your account.
118
130
  #
@@ -147,6 +159,9 @@ module Increase
147
159
  # @param decline [Increase::Models::InboundFednowTransfer::Decline, nil]
148
160
  # If your transfer is declined, this will contain details of the decline.
149
161
  #
162
+ # @param end_to_end_identification [String, nil]
163
+ # A free-form reference string set by the sender, to help identify the transfer.
164
+ #
150
165
  # @param status [Symbol, Increase::Models::InboundFednowTransfer::Status]
151
166
  # The lifecycle status of the transfer.
152
167
  #
@@ -154,6 +169,8 @@ module Increase
154
169
  # The identifier of the Transaction object created when the transfer was
155
170
  # confirmed.
156
171
  #
172
+ # @param transaction_identification [String, nil] The FedNow network identification of the transfer.
173
+ #
157
174
  # @param type [Symbol, Increase::Models::InboundFednowTransfer::Type]
158
175
  # A constant representing the object's type. For this resource it will always be
159
176
  # `inbound_fednow_transfer`.
@@ -18,9 +18,9 @@ module Increase
18
18
 
19
19
  # @!attribute amount
20
20
  # The Pending Transaction amount in the minor unit of its currency. For dollars,
21
- # for example, this is cents. This amount does not change after the Pending
22
- # Transaction is created. If a card authorization settles for a different amount,
23
- # the settled amount is available on the resulting Transaction and on the Card
21
+ # for example, this is cents. For a card authorization this is the amount still
22
+ # held: it decreases when the merchant reverses part of the authorization. The
23
+ # amount that settled is available on the resulting Transaction and on the Card
24
24
  # Payment's `state.settled_amount`.
25
25
  #
26
26
  # @return [Integer]
@@ -111,9 +111,9 @@ module Increase
111
111
  #
112
112
  # @param amount [Integer]
113
113
  # The Pending Transaction amount in the minor unit of its currency. For dollars,
114
- # for example, this is cents. This amount does not change after the Pending
115
- # Transaction is created. If a card authorization settles for a different amount,
116
- # the settled amount is available on the resulting Transaction and on the Card
114
+ # for example, this is cents. For a card authorization this is the amount still
115
+ # held: it decreases when the merchant reverses part of the authorization. The
116
+ # amount that settled is available on the resulting Transaction and on the Card
117
117
  # Payment's `state.settled_amount`.
118
118
  #
119
119
  # @param completed_at [Time, nil]
@@ -2811,7 +2811,7 @@ module Increase
2811
2811
  # The Pending Transaction is still awaiting confirmation.
2812
2812
  PENDING = :pending
2813
2813
 
2814
- # The Pending Transaction is confirmed. An associated Transaction exists for this object. The Pending Transaction will no longer count against your balance and can generally be hidden from UIs, etc. The Pending Transaction's `amount` is not updated if the associated Transaction settles for a different amount.
2814
+ # The Pending Transaction is confirmed. An associated Transaction exists for this object. The Pending Transaction will no longer count against your balance and can generally be hidden from UIs, etc. The Pending Transaction's `amount` is the amount that was still held when it completed, which can differ from the amount of the associated Transaction.
2815
2815
  COMPLETE = :complete
2816
2816
 
2817
2817
  # @!method self.values
@@ -217,7 +217,7 @@ module Increase
217
217
  # The Pending Transaction is still awaiting confirmation.
218
218
  PENDING = :pending
219
219
 
220
- # The Pending Transaction is confirmed. An associated Transaction exists for this object. The Pending Transaction will no longer count against your balance and can generally be hidden from UIs, etc. The Pending Transaction's `amount` is not updated if the associated Transaction settles for a different amount.
220
+ # The Pending Transaction is confirmed. An associated Transaction exists for this object. The Pending Transaction will no longer count against your balance and can generally be hidden from UIs, etc. The Pending Transaction's `amount` is the amount that was still held when it completed, which can differ from the amount of the associated Transaction.
221
221
  COMPLETE = :complete
222
222
 
223
223
  # @!method self.values
@@ -14,7 +14,8 @@ module Increase
14
14
  required :card_id, String
15
15
 
16
16
  # @!attribute cardholder
17
- # Details about the cardholder, as it will appear on the physical card.
17
+ # Details about the cardholder, as it will appear on the physical card. The
18
+ # combined first name and last name cannot exceed 25 characters.
18
19
  #
19
20
  # @return [Increase::Models::PhysicalCardCreateParams::Cardholder]
20
21
  required :cardholder, -> { Increase::PhysicalCardCreateParams::Cardholder }
@@ -36,7 +37,8 @@ module Increase
36
37
  # @param card_id [String] The underlying card representing this physical card.
37
38
  #
38
39
  # @param cardholder [Increase::Models::PhysicalCardCreateParams::Cardholder]
39
- # Details about the cardholder, as it will appear on the physical card.
40
+ # Details about the cardholder, as it will appear on the physical card. The
41
+ # combined first name and last name cannot exceed 25 characters.
40
42
  #
41
43
  # @param shipment [Increase::Models::PhysicalCardCreateParams::Shipment]
42
44
  # The details used to ship this physical card.
@@ -61,7 +63,8 @@ module Increase
61
63
  required :last_name, String
62
64
 
63
65
  # @!method initialize(first_name:, last_name:)
64
- # Details about the cardholder, as it will appear on the physical card.
66
+ # Details about the cardholder, as it will appear on the physical card. The
67
+ # combined first name and last name cannot exceed 25 characters.
65
68
  #
66
69
  # @param first_name [String] The cardholder's first name.
67
70
  #
@@ -15,7 +15,10 @@ module Increase
15
15
  required :inbound_check_deposit_id, String
16
16
 
17
17
  # @!attribute amount
18
- # The adjustment amount in cents. Defaults to the amount of the Inbound Check
18
+ # The adjustment amount in cents. A positive amount means that the funds are being
19
+ # returned to you by the other bank and is a credit to your account, as happens
20
+ # for a `wrong_payee_credit`. A negative amount is a debit to your account, as
21
+ # happens for a `late_return`. Defaults to the amount of the Inbound Check
19
22
  # Deposit.
20
23
  #
21
24
  # @return [Integer, nil]
@@ -31,7 +34,10 @@ module Increase
31
34
  # @param inbound_check_deposit_id [String] The identifier of the Inbound Check Deposit to adjust.
32
35
  #
33
36
  # @param amount [Integer]
34
- # The adjustment amount in cents. Defaults to the amount of the Inbound Check
37
+ # The adjustment amount in cents. A positive amount means that the funds are being
38
+ # returned to you by the other bank and is a credit to your account, as happens
39
+ # for a `wrong_payee_credit`. A negative amount is a debit to your account, as
40
+ # happens for a `late_return`. Defaults to the amount of the Inbound Check
35
41
  # Deposit.
36
42
  #
37
43
  # @param reason [Symbol, Increase::Models::Simulations::InboundCheckDepositAdjustmentParams::Reason]
@@ -49,15 +55,6 @@ module Increase
49
55
  # The check was deposited to the wrong payee and the depositing institution has reimbursed the funds with a Wrong Payee Credit.
50
56
  WRONG_PAYEE_CREDIT = :wrong_payee_credit
51
57
 
52
- # The check was deposited with a different amount than what was written on the check.
53
- ADJUSTED_AMOUNT = :adjusted_amount
54
-
55
- # The recipient was not able to process the check. This usually happens for e.g., low quality images.
56
- NON_CONFORMING_ITEM = :non_conforming_item
57
-
58
- # The check has already been deposited elsewhere and so this is a duplicate.
59
- PAID = :paid
60
-
61
58
  # @!method self.values
62
59
  # @return [Array<Symbol>]
63
60
  end
@@ -7231,7 +7231,8 @@ module Increase
7231
7231
  required :adjusted_transaction_id, String
7232
7232
 
7233
7233
  # @!attribute amount
7234
- # The amount of the check adjustment.
7234
+ # The amount of the check adjustment in USD cents. A positive amount is a credit
7235
+ # to your account and a negative amount is a debit.
7235
7236
  #
7236
7237
  # @return [Integer]
7237
7238
  required :amount, Integer
@@ -7250,7 +7251,9 @@ module Increase
7250
7251
  #
7251
7252
  # @param adjusted_transaction_id [String] The ID of the transaction that was adjusted.
7252
7253
  #
7253
- # @param amount [Integer] The amount of the check adjustment.
7254
+ # @param amount [Integer]
7255
+ # The amount of the check adjustment in USD cents. A positive amount is a credit
7256
+ # to your account and a negative amount is a debit.
7254
7257
  #
7255
7258
  # @param reason [Symbol, Increase::Models::Transaction::Source::InboundCheckAdjustment::Reason]
7256
7259
  # The reason for the adjustment.