increase 1.351.0 → 1.353.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 (74) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/increase/models/account_statement.rb +12 -4
  4. data/lib/increase/models/balance_lookup.rb +1 -59
  5. data/lib/increase/models/beneficial_owner_create_params.rb +3 -0
  6. data/lib/increase/models/beneficial_owner_update_params.rb +3 -0
  7. data/lib/increase/models/card_payment.rb +1174 -2
  8. data/lib/increase/models/check_transfer.rb +15 -9
  9. data/lib/increase/models/entity.rb +18 -0
  10. data/lib/increase/models/entity_beneficial_owner.rb +3 -0
  11. data/lib/increase/models/entity_create_params.rb +36 -20
  12. data/lib/increase/models/entity_update_params.rb +33 -20
  13. data/lib/increase/models/event.rb +12 -0
  14. data/lib/increase/models/event_list_params.rb +12 -0
  15. data/lib/increase/models/event_subscription.rb +12 -0
  16. data/lib/increase/models/event_subscription_create_params.rb +12 -0
  17. data/lib/increase/models/inbound_ach_transfer.rb +9 -1
  18. data/lib/increase/models/pending_transaction.rb +121 -1
  19. data/lib/increase/models/pending_transaction_list_params.rb +6 -0
  20. data/lib/increase/models/simulations/physical_card_create_params.rb +9 -6
  21. data/lib/increase/models/transaction.rb +1277 -3
  22. data/lib/increase/models/transaction_list_params.rb +6 -0
  23. data/lib/increase/models/unwrap_webhook_event.rb +12 -0
  24. data/lib/increase/models/wire_drawdown_request.rb +3 -3
  25. data/lib/increase/models/wire_drawdown_request_list_params.rb +3 -3
  26. data/lib/increase/resources/simulations/account_statements.rb +2 -1
  27. data/lib/increase/resources/simulations/physical_cards.rb +5 -3
  28. data/lib/increase/version.rb +1 -1
  29. data/rbi/increase/models/account_statement.rbi +12 -4
  30. data/rbi/increase/models/balance_lookup.rbi +3 -87
  31. data/rbi/increase/models/beneficial_owner_create_params.rbi +7 -0
  32. data/rbi/increase/models/beneficial_owner_update_params.rbi +7 -0
  33. data/rbi/increase/models/card_payment.rbi +5276 -2964
  34. data/rbi/increase/models/check_transfer.rbi +15 -9
  35. data/rbi/increase/models/entity.rbi +42 -0
  36. data/rbi/increase/models/entity_beneficial_owner.rbi +7 -0
  37. data/rbi/increase/models/entity_create_params.rbi +46 -21
  38. data/rbi/increase/models/entity_update_params.rbi +39 -21
  39. data/rbi/increase/models/event.rbi +28 -0
  40. data/rbi/increase/models/event_list_params.rbi +28 -0
  41. data/rbi/increase/models/event_subscription.rbi +28 -0
  42. data/rbi/increase/models/event_subscription_create_params.rbi +28 -0
  43. data/rbi/increase/models/inbound_ach_transfer.rbi +8 -0
  44. data/rbi/increase/models/pending_transaction.rbi +254 -0
  45. data/rbi/increase/models/pending_transaction_list_params.rbi +14 -0
  46. data/rbi/increase/models/simulations/physical_card_create_params.rbi +8 -6
  47. data/rbi/increase/models/transaction.rbi +4848 -2358
  48. data/rbi/increase/models/transaction_list_params.rbi +14 -0
  49. data/rbi/increase/models/unwrap_webhook_event.rbi +28 -0
  50. data/rbi/increase/models/wire_drawdown_request.rbi +4 -4
  51. data/rbi/increase/models/wire_drawdown_request_list_params.rbi +6 -6
  52. data/rbi/increase/resources/simulations/account_statements.rbi +2 -1
  53. data/rbi/increase/resources/simulations/physical_cards.rbi +4 -3
  54. data/sig/increase/models/balance_lookup.rbs +3 -42
  55. data/sig/increase/models/beneficial_owner_create_params.rbs +4 -0
  56. data/sig/increase/models/beneficial_owner_update_params.rbs +4 -0
  57. data/sig/increase/models/card_payment.rbs +1186 -0
  58. data/sig/increase/models/entity.rbs +24 -0
  59. data/sig/increase/models/entity_beneficial_owner.rbs +4 -0
  60. data/sig/increase/models/entity_create_params.rbs +24 -11
  61. data/sig/increase/models/entity_update_params.rbs +20 -11
  62. data/sig/increase/models/event.rbs +16 -0
  63. data/sig/increase/models/event_list_params.rbs +16 -0
  64. data/sig/increase/models/event_subscription.rbs +16 -0
  65. data/sig/increase/models/event_subscription_create_params.rbs +16 -0
  66. data/sig/increase/models/inbound_ach_transfer.rbs +5 -0
  67. data/sig/increase/models/pending_transaction.rbs +84 -0
  68. data/sig/increase/models/pending_transaction_list_params.rbs +8 -0
  69. data/sig/increase/models/transaction.rbs +1236 -0
  70. data/sig/increase/models/transaction_list_params.rbs +8 -0
  71. data/sig/increase/models/unwrap_webhook_event.rbs +16 -0
  72. data/sig/increase/models/wire_drawdown_request.rbs +4 -4
  73. data/sig/increase/models/wire_drawdown_request_list_params.rbs +4 -4
  74. metadata +2 -2
@@ -98,8 +98,8 @@ module Increase
98
98
  required :idempotency_key, String, nil?: true
99
99
 
100
100
  # @!attribute mailing
101
- # If the check has been mailed by Increase, this will contain details of the
102
- # shipment.
101
+ # Once the check has been mailed, this will contain details about the shipment.
102
+ # Only available when `fulfillment_method` is equal to `physical_check`.
103
103
  #
104
104
  # @return [Increase::Models::CheckTransfer::Mailing, nil]
105
105
  required :mailing, -> { Increase::CheckTransfer::Mailing }, nil?: true
@@ -147,7 +147,9 @@ module Increase
147
147
  required :stop_payment_request, -> { Increase::CheckTransfer::StopPaymentRequest }, nil?: true
148
148
 
149
149
  # @!attribute submission
150
- # After the transfer is submitted, this will contain supplemental details.
150
+ # Once the check has been submitted to our printer, this will contain details
151
+ # about the submission. Only available when `fulfillment_method` is equal to
152
+ # `physical_check`.
151
153
  #
152
154
  # @return [Increase::Models::CheckTransfer::Submission, nil]
153
155
  required :submission, -> { Increase::CheckTransfer::Submission }, nil?: true
@@ -226,8 +228,8 @@ module Increase
226
228
  # about [idempotency](https://increase.com/documentation/idempotency-keys).
227
229
  #
228
230
  # @param mailing [Increase::Models::CheckTransfer::Mailing, nil]
229
- # If the check has been mailed by Increase, this will contain details of the
230
- # shipment.
231
+ # Once the check has been mailed, this will contain details about the shipment.
232
+ # Only available when `fulfillment_method` is equal to `physical_check`.
231
233
  #
232
234
  # @param pending_transaction_id [String, nil]
233
235
  # The ID for the pending transaction representing the transfer. A pending
@@ -252,7 +254,9 @@ module Increase
252
254
  # details.
253
255
  #
254
256
  # @param submission [Increase::Models::CheckTransfer::Submission, nil]
255
- # After the transfer is submitted, this will contain supplemental details.
257
+ # Once the check has been submitted to our printer, this will contain details
258
+ # about the submission. Only available when `fulfillment_method` is equal to
259
+ # `physical_check`.
256
260
  #
257
261
  # @param third_party [Increase::Models::CheckTransfer::ThirdParty, nil]
258
262
  # Details relating to the custom fulfillment you will perform. Will be present if
@@ -485,8 +489,8 @@ module Increase
485
489
  required :mailed_at, Time
486
490
 
487
491
  # @!method initialize(mailed_at:)
488
- # If the check has been mailed by Increase, this will contain details of the
489
- # shipment.
492
+ # Once the check has been mailed, this will contain details about the shipment.
493
+ # Only available when `fulfillment_method` is equal to `physical_check`.
490
494
  #
491
495
  # @param mailed_at [Time]
492
496
  # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
@@ -1029,7 +1033,9 @@ module Increase
1029
1033
  required :tracking_number, String, nil?: true
1030
1034
 
1031
1035
  # @!method initialize(preview_file_id:, submitted_address:, submitted_at:, tracking_number:)
1032
- # After the transfer is submitted, this will contain supplemental details.
1036
+ # Once the check has been submitted to our printer, this will contain details
1037
+ # about the submission. Only available when `fulfillment_method` is equal to
1038
+ # `physical_check`.
1033
1039
  #
1034
1040
  # @param preview_file_id [String, nil]
1035
1041
  # The ID of the file corresponding to an image of the check that was mailed, if
@@ -546,6 +546,9 @@ module Increase
546
546
  # A social security number.
547
547
  SOCIAL_SECURITY_NUMBER = :social_security_number
548
548
 
549
+ # The last four digits of a social security number.
550
+ SOCIAL_SECURITY_NUMBER_LAST4 = :social_security_number_last4
551
+
549
552
  # An individual taxpayer identification number (ITIN).
550
553
  INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER = :individual_taxpayer_identification_number
551
554
 
@@ -949,6 +952,9 @@ module Increase
949
952
  # A social security number.
950
953
  SOCIAL_SECURITY_NUMBER = :social_security_number
951
954
 
955
+ # The last four digits of a social security number.
956
+ SOCIAL_SECURITY_NUMBER_LAST4 = :social_security_number_last4
957
+
952
958
  # An individual taxpayer identification number (ITIN).
953
959
  INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER = :individual_taxpayer_identification_number
954
960
 
@@ -1102,6 +1108,9 @@ module Increase
1102
1108
  # A social security number.
1103
1109
  SOCIAL_SECURITY_NUMBER = :social_security_number
1104
1110
 
1111
+ # The last four digits of a social security number.
1112
+ SOCIAL_SECURITY_NUMBER_LAST4 = :social_security_number_last4
1113
+
1105
1114
  # An individual taxpayer identification number (ITIN).
1106
1115
  INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER = :individual_taxpayer_identification_number
1107
1116
 
@@ -1424,6 +1433,9 @@ module Increase
1424
1433
  # A social security number.
1425
1434
  SOCIAL_SECURITY_NUMBER = :social_security_number
1426
1435
 
1436
+ # The last four digits of a social security number.
1437
+ SOCIAL_SECURITY_NUMBER_LAST4 = :social_security_number_last4
1438
+
1427
1439
  # An individual taxpayer identification number (ITIN).
1428
1440
  INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER = :individual_taxpayer_identification_number
1429
1441
 
@@ -1846,6 +1858,9 @@ module Increase
1846
1858
  # A social security number.
1847
1859
  SOCIAL_SECURITY_NUMBER = :social_security_number
1848
1860
 
1861
+ # The last four digits of a social security number.
1862
+ SOCIAL_SECURITY_NUMBER_LAST4 = :social_security_number_last4
1863
+
1849
1864
  # An individual taxpayer identification number (ITIN).
1850
1865
  INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER = :individual_taxpayer_identification_number
1851
1866
 
@@ -2022,6 +2037,9 @@ module Increase
2022
2037
  # A social security number.
2023
2038
  SOCIAL_SECURITY_NUMBER = :social_security_number
2024
2039
 
2040
+ # The last four digits of a social security number.
2041
+ SOCIAL_SECURITY_NUMBER_LAST4 = :social_security_number_last4
2042
+
2025
2043
  # An individual taxpayer identification number (ITIN).
2026
2044
  INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER = :individual_taxpayer_identification_number
2027
2045
 
@@ -223,6 +223,9 @@ module Increase
223
223
  # A social security number.
224
224
  SOCIAL_SECURITY_NUMBER = :social_security_number
225
225
 
226
+ # The last four digits of a social security number.
227
+ SOCIAL_SECURITY_NUMBER_LAST4 = :social_security_number_last4
228
+
226
229
  # An individual taxpayer identification number (ITIN).
227
230
  INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER = :individual_taxpayer_identification_number
228
231
 
@@ -587,6 +587,9 @@ module Increase
587
587
  # A social security number.
588
588
  SOCIAL_SECURITY_NUMBER = :social_security_number
589
589
 
590
+ # The last four digits of a social security number.
591
+ SOCIAL_SECURITY_NUMBER_LAST4 = :social_security_number_last4
592
+
590
593
  # An individual taxpayer identification number (ITIN).
591
594
  INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER = :individual_taxpayer_identification_number
592
595
 
@@ -2193,29 +2196,24 @@ module Increase
2193
2196
  # @see Increase::Models::EntityCreateParams::Trust#address
2194
2197
  class Address < Increase::Internal::Type::BaseModel
2195
2198
  # @!attribute city
2196
- # The city of the address.
2199
+ # The city, district, town, or village of the address.
2197
2200
  #
2198
2201
  # @return [String]
2199
2202
  required :city, String
2200
2203
 
2201
- # @!attribute line1
2202
- # The first line of the address. This is usually the street number and street.
2204
+ # @!attribute country
2205
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
2203
2206
  #
2204
- # @return [String]
2205
- required :line1, String
2206
-
2207
- # @!attribute state
2208
- # The two-letter United States Postal Service (USPS) abbreviation for the state of
2209
- # the address.
2207
+ # Defaults to `US`.
2210
2208
  #
2211
2209
  # @return [String]
2212
- required :state, String
2210
+ required :country, String
2213
2211
 
2214
- # @!attribute zip
2215
- # The ZIP code of the address.
2212
+ # @!attribute line1
2213
+ # The first line of the address. This is usually the street number and street.
2216
2214
  #
2217
2215
  # @return [String]
2218
- required :zip, String
2216
+ required :line1, String
2219
2217
 
2220
2218
  # @!attribute line2
2221
2219
  # The second line of the address. This might be the floor or room number.
@@ -2223,21 +2221,39 @@ module Increase
2223
2221
  # @return [String, nil]
2224
2222
  optional :line2, String
2225
2223
 
2226
- # @!method initialize(city:, line1:, state:, zip:, line2: nil)
2224
+ # @!attribute state
2225
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
2226
+ # state, province, or region of the address. Required in certain countries.
2227
+ #
2228
+ # @return [String, nil]
2229
+ optional :state, String
2230
+
2231
+ # @!attribute zip
2232
+ # The ZIP or postal code of the address. Required in certain countries.
2233
+ #
2234
+ # @return [String, nil]
2235
+ optional :zip, String
2236
+
2237
+ # @!method initialize(city:, country:, line1:, line2: nil, state: nil, zip: nil)
2227
2238
  # The trust's physical address. Mail receiving locations like PO Boxes and PMB's
2228
2239
  # are disallowed.
2229
2240
  #
2230
- # @param city [String] The city of the address.
2241
+ # @param city [String] The city, district, town, or village of the address.
2231
2242
  #
2232
- # @param line1 [String] The first line of the address. This is usually the street number and street.
2243
+ # @param country [String]
2244
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
2233
2245
  #
2234
- # @param state [String]
2235
- # The two-letter United States Postal Service (USPS) abbreviation for the state of
2236
- # the address.
2246
+ # Defaults to `US`.
2237
2247
  #
2238
- # @param zip [String] The ZIP code of the address.
2248
+ # @param line1 [String] The first line of the address. This is usually the street number and street.
2239
2249
  #
2240
2250
  # @param line2 [String] The second line of the address. This might be the floor or room number.
2251
+ #
2252
+ # @param state [String]
2253
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
2254
+ # state, province, or region of the address. Required in certain countries.
2255
+ #
2256
+ # @param zip [String] The ZIP or postal code of the address. Required in certain countries.
2241
2257
  end
2242
2258
 
2243
2259
  # Whether the trust is `revocable` or `irrevocable`. Irrevocable trusts require
@@ -1350,29 +1350,24 @@ module Increase
1350
1350
  # @see Increase::Models::EntityUpdateParams::Trust#address
1351
1351
  class Address < Increase::Internal::Type::BaseModel
1352
1352
  # @!attribute city
1353
- # The city of the address.
1353
+ # The city, district, town, or village of the address.
1354
1354
  #
1355
1355
  # @return [String]
1356
1356
  required :city, String
1357
1357
 
1358
- # @!attribute line1
1359
- # The first line of the address. This is usually the street number and street.
1358
+ # @!attribute country
1359
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
1360
1360
  #
1361
- # @return [String]
1362
- required :line1, String
1363
-
1364
- # @!attribute state
1365
- # The two-letter United States Postal Service (USPS) abbreviation for the state of
1366
- # the address.
1361
+ # Defaults to `US`.
1367
1362
  #
1368
1363
  # @return [String]
1369
- required :state, String
1364
+ required :country, String
1370
1365
 
1371
- # @!attribute zip
1372
- # The ZIP code of the address.
1366
+ # @!attribute line1
1367
+ # The first line of the address. This is usually the street number and street.
1373
1368
  #
1374
1369
  # @return [String]
1375
- required :zip, String
1370
+ required :line1, String
1376
1371
 
1377
1372
  # @!attribute line2
1378
1373
  # The second line of the address. This might be the floor or room number.
@@ -1380,21 +1375,39 @@ module Increase
1380
1375
  # @return [String, nil]
1381
1376
  optional :line2, String
1382
1377
 
1383
- # @!method initialize(city:, line1:, state:, zip:, line2: nil)
1378
+ # @!attribute state
1379
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
1380
+ # state, province, or region of the address. Required in certain countries.
1381
+ #
1382
+ # @return [String, nil]
1383
+ optional :state, String
1384
+
1385
+ # @!attribute zip
1386
+ # The ZIP or postal code of the address. Required in certain countries.
1387
+ #
1388
+ # @return [String, nil]
1389
+ optional :zip, String
1390
+
1391
+ # @!method initialize(city:, country:, line1:, line2: nil, state: nil, zip: nil)
1384
1392
  # The entity's physical address. Mail receiving locations like PO Boxes and PMB's
1385
1393
  # are disallowed.
1386
1394
  #
1387
- # @param city [String] The city of the address.
1395
+ # @param city [String] The city, district, town, or village of the address.
1388
1396
  #
1389
- # @param line1 [String] The first line of the address. This is usually the street number and street.
1397
+ # @param country [String]
1398
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
1390
1399
  #
1391
- # @param state [String]
1392
- # The two-letter United States Postal Service (USPS) abbreviation for the state of
1393
- # the address.
1400
+ # Defaults to `US`.
1394
1401
  #
1395
- # @param zip [String] The ZIP code of the address.
1402
+ # @param line1 [String] The first line of the address. This is usually the street number and street.
1396
1403
  #
1397
1404
  # @param line2 [String] The second line of the address. This might be the floor or room number.
1405
+ #
1406
+ # @param state [String]
1407
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
1408
+ # state, province, or region of the address. Required in certain countries.
1409
+ #
1410
+ # @param zip [String] The ZIP or postal code of the address. Required in certain countries.
1398
1411
  end
1399
1412
 
1400
1413
  # @see Increase::Models::EntityUpdateParams::Trust#grantor
@@ -423,6 +423,12 @@ module Increase
423
423
  # Occurs whenever a Real-Time Payments Request for Payment is updated.
424
424
  REAL_TIME_PAYMENTS_REQUEST_FOR_PAYMENT_UPDATED = :"real_time_payments_request_for_payment.updated"
425
425
 
426
+ # Occurs whenever a SEPA Instant Transfer is created.
427
+ SEPA_INSTANT_TRANSFER_CREATED = :"sepa_instant_transfer.created"
428
+
429
+ # Occurs whenever a SEPA Instant Transfer is updated.
430
+ SEPA_INSTANT_TRANSFER_UPDATED = :"sepa_instant_transfer.updated"
431
+
426
432
  # Occurs whenever a Swift Transfer is created.
427
433
  SWIFT_TRANSFER_CREATED = :"swift_transfer.created"
428
434
 
@@ -432,6 +438,12 @@ module Increase
432
438
  # Occurs whenever a Transaction is created.
433
439
  TRANSACTION_CREATED = :"transaction.created"
434
440
 
441
+ # Occurs whenever a UK Faster Payment System Transfer is created.
442
+ UK_FASTER_PAYMENT_SYSTEM_TRANSFER_CREATED = :"uk_faster_payment_system_transfer.created"
443
+
444
+ # Occurs whenever a UK Faster Payment System Transfer is updated.
445
+ UK_FASTER_PAYMENT_SYSTEM_TRANSFER_UPDATED = :"uk_faster_payment_system_transfer.updated"
446
+
435
447
  # Occurs whenever a Wire Drawdown Request is created.
436
448
  WIRE_DRAWDOWN_REQUEST_CREATED = :"wire_drawdown_request.created"
437
449
 
@@ -435,6 +435,12 @@ module Increase
435
435
  # Occurs whenever a Real-Time Payments Request for Payment is updated.
436
436
  REAL_TIME_PAYMENTS_REQUEST_FOR_PAYMENT_UPDATED = :"real_time_payments_request_for_payment.updated"
437
437
 
438
+ # Occurs whenever a SEPA Instant Transfer is created.
439
+ SEPA_INSTANT_TRANSFER_CREATED = :"sepa_instant_transfer.created"
440
+
441
+ # Occurs whenever a SEPA Instant Transfer is updated.
442
+ SEPA_INSTANT_TRANSFER_UPDATED = :"sepa_instant_transfer.updated"
443
+
438
444
  # Occurs whenever a Swift Transfer is created.
439
445
  SWIFT_TRANSFER_CREATED = :"swift_transfer.created"
440
446
 
@@ -444,6 +450,12 @@ module Increase
444
450
  # Occurs whenever a Transaction is created.
445
451
  TRANSACTION_CREATED = :"transaction.created"
446
452
 
453
+ # Occurs whenever a UK Faster Payment System Transfer is created.
454
+ UK_FASTER_PAYMENT_SYSTEM_TRANSFER_CREATED = :"uk_faster_payment_system_transfer.created"
455
+
456
+ # Occurs whenever a UK Faster Payment System Transfer is updated.
457
+ UK_FASTER_PAYMENT_SYSTEM_TRANSFER_UPDATED = :"uk_faster_payment_system_transfer.updated"
458
+
447
459
  # Occurs whenever a Wire Drawdown Request is created.
448
460
  WIRE_DRAWDOWN_REQUEST_CREATED = :"wire_drawdown_request.created"
449
461
 
@@ -464,6 +464,12 @@ module Increase
464
464
  # Occurs whenever a Real-Time Payments Request for Payment is updated.
465
465
  REAL_TIME_PAYMENTS_REQUEST_FOR_PAYMENT_UPDATED = :"real_time_payments_request_for_payment.updated"
466
466
 
467
+ # Occurs whenever a SEPA Instant Transfer is created.
468
+ SEPA_INSTANT_TRANSFER_CREATED = :"sepa_instant_transfer.created"
469
+
470
+ # Occurs whenever a SEPA Instant Transfer is updated.
471
+ SEPA_INSTANT_TRANSFER_UPDATED = :"sepa_instant_transfer.updated"
472
+
467
473
  # Occurs whenever a Swift Transfer is created.
468
474
  SWIFT_TRANSFER_CREATED = :"swift_transfer.created"
469
475
 
@@ -473,6 +479,12 @@ module Increase
473
479
  # Occurs whenever a Transaction is created.
474
480
  TRANSACTION_CREATED = :"transaction.created"
475
481
 
482
+ # Occurs whenever a UK Faster Payment System Transfer is created.
483
+ UK_FASTER_PAYMENT_SYSTEM_TRANSFER_CREATED = :"uk_faster_payment_system_transfer.created"
484
+
485
+ # Occurs whenever a UK Faster Payment System Transfer is updated.
486
+ UK_FASTER_PAYMENT_SYSTEM_TRANSFER_UPDATED = :"uk_faster_payment_system_transfer.updated"
487
+
476
488
  # Occurs whenever a Wire Drawdown Request is created.
477
489
  WIRE_DRAWDOWN_REQUEST_CREATED = :"wire_drawdown_request.created"
478
490
 
@@ -433,6 +433,12 @@ module Increase
433
433
  # Occurs whenever a Real-Time Payments Request for Payment is updated.
434
434
  REAL_TIME_PAYMENTS_REQUEST_FOR_PAYMENT_UPDATED = :"real_time_payments_request_for_payment.updated"
435
435
 
436
+ # Occurs whenever a SEPA Instant Transfer is created.
437
+ SEPA_INSTANT_TRANSFER_CREATED = :"sepa_instant_transfer.created"
438
+
439
+ # Occurs whenever a SEPA Instant Transfer is updated.
440
+ SEPA_INSTANT_TRANSFER_UPDATED = :"sepa_instant_transfer.updated"
441
+
436
442
  # Occurs whenever a Swift Transfer is created.
437
443
  SWIFT_TRANSFER_CREATED = :"swift_transfer.created"
438
444
 
@@ -442,6 +448,12 @@ module Increase
442
448
  # Occurs whenever a Transaction is created.
443
449
  TRANSACTION_CREATED = :"transaction.created"
444
450
 
451
+ # Occurs whenever a UK Faster Payment System Transfer is created.
452
+ UK_FASTER_PAYMENT_SYSTEM_TRANSFER_CREATED = :"uk_faster_payment_system_transfer.created"
453
+
454
+ # Occurs whenever a UK Faster Payment System Transfer is updated.
455
+ UK_FASTER_PAYMENT_SYSTEM_TRANSFER_UPDATED = :"uk_faster_payment_system_transfer.updated"
456
+
445
457
  # Occurs whenever a Wire Drawdown Request is created.
446
458
  WIRE_DRAWDOWN_REQUEST_CREATED = :"wire_drawdown_request.created"
447
459
 
@@ -1088,6 +1088,12 @@ module Increase
1088
1088
 
1089
1089
  # @see Increase::Models::InboundACHTransfer#transfer_return
1090
1090
  class TransferReturn < Increase::Internal::Type::BaseModel
1091
+ # @!attribute raw_reason_code
1092
+ # The three character ACH return code, in the range R01 to R85.
1093
+ #
1094
+ # @return [String]
1095
+ required :raw_reason_code, String
1096
+
1091
1097
  # @!attribute reason
1092
1098
  # The reason for the transfer return.
1093
1099
  #
@@ -1106,9 +1112,11 @@ module Increase
1106
1112
  # @return [String]
1107
1113
  required :transaction_id, String
1108
1114
 
1109
- # @!method initialize(reason:, returned_at:, transaction_id:)
1115
+ # @!method initialize(raw_reason_code:, reason:, returned_at:, transaction_id:)
1110
1116
  # If your transfer is returned, this will contain details of the return.
1111
1117
  #
1118
+ # @param raw_reason_code [String] The three character ACH return code, in the range R01 to R85.
1119
+ #
1112
1120
  # @param reason [Symbol, Increase::Models::InboundACHTransfer::TransferReturn::Reason]
1113
1121
  # The reason for the transfer return.
1114
1122
  #
@@ -331,6 +331,16 @@ module Increase
331
331
  -> { Increase::PendingTransaction::Source::RealTimePaymentsTransferInstruction },
332
332
  nil?: true
333
333
 
334
+ # @!attribute sepa_instant_transfer_instruction
335
+ # A SEPA Instant Transfer Instruction object. This field will be present in the
336
+ # JSON response if and only if `category` is equal to
337
+ # `sepa_instant_transfer_instruction`.
338
+ #
339
+ # @return [Increase::Models::PendingTransaction::Source::SepaInstantTransferInstruction, nil]
340
+ optional :sepa_instant_transfer_instruction,
341
+ -> { Increase::PendingTransaction::Source::SepaInstantTransferInstruction },
342
+ nil?: true
343
+
334
344
  # @!attribute swift_transfer_instruction
335
345
  # A Swift Transfer Instruction object. This field will be present in the JSON
336
346
  # response if and only if `category` is equal to `swift_transfer_instruction`.
@@ -340,6 +350,16 @@ module Increase
340
350
  -> { Increase::PendingTransaction::Source::SwiftTransferInstruction },
341
351
  nil?: true
342
352
 
353
+ # @!attribute uk_faster_payment_system_transfer_instruction
354
+ # An UK Faster Payment System Transfer Instruction object. This field will be
355
+ # present in the JSON response if and only if `category` is equal to
356
+ # `uk_faster_payment_system_transfer_instruction`.
357
+ #
358
+ # @return [Increase::Models::PendingTransaction::Source::UkFasterPaymentSystemTransferInstruction, nil]
359
+ optional :uk_faster_payment_system_transfer_instruction,
360
+ -> { Increase::PendingTransaction::Source::UkFasterPaymentSystemTransferInstruction },
361
+ nil?: true
362
+
343
363
  # @!attribute user_initiated_hold
344
364
  # An User Initiated Hold object. This field will be present in the JSON response
345
365
  # if and only if `category` is equal to `user_initiated_hold`. Created when a user
@@ -359,7 +379,7 @@ module Increase
359
379
  -> { Increase::PendingTransaction::Source::WireTransferInstruction },
360
380
  nil?: true
361
381
 
362
- # @!method initialize(category:, account_transfer_instruction: nil, ach_transfer_instruction: nil, blockchain_offramp_transfer: nil, blockchain_onramp_transfer_instruction: nil, card_authorization: nil, card_push_transfer_instruction: nil, check_deposit_instruction: nil, check_transfer_instruction: nil, fednow_transfer_instruction: nil, inbound_funds_hold: nil, inbound_wire_transfer_reversal: nil, other: nil, real_time_payments_transfer_instruction: nil, swift_transfer_instruction: nil, user_initiated_hold: nil, wire_transfer_instruction: nil)
382
+ # @!method initialize(category:, account_transfer_instruction: nil, ach_transfer_instruction: nil, blockchain_offramp_transfer: nil, blockchain_onramp_transfer_instruction: nil, card_authorization: nil, card_push_transfer_instruction: nil, check_deposit_instruction: nil, check_transfer_instruction: nil, fednow_transfer_instruction: nil, inbound_funds_hold: nil, inbound_wire_transfer_reversal: nil, other: nil, real_time_payments_transfer_instruction: nil, sepa_instant_transfer_instruction: nil, swift_transfer_instruction: nil, uk_faster_payment_system_transfer_instruction: nil, user_initiated_hold: nil, wire_transfer_instruction: nil)
363
383
  # This is an object giving more details on the network-level event that caused the
364
384
  # Pending Transaction. For example, for a card transaction this lists the
365
385
  # merchant's industry and location.
@@ -430,10 +450,20 @@ module Increase
430
450
  # the JSON response if and only if `category` is equal to
431
451
  # `real_time_payments_transfer_instruction`.
432
452
  #
453
+ # @param sepa_instant_transfer_instruction [Increase::Models::PendingTransaction::Source::SepaInstantTransferInstruction, nil]
454
+ # A SEPA Instant Transfer Instruction object. This field will be present in the
455
+ # JSON response if and only if `category` is equal to
456
+ # `sepa_instant_transfer_instruction`.
457
+ #
433
458
  # @param swift_transfer_instruction [Increase::Models::PendingTransaction::Source::SwiftTransferInstruction, nil]
434
459
  # A Swift Transfer Instruction object. This field will be present in the JSON
435
460
  # response if and only if `category` is equal to `swift_transfer_instruction`.
436
461
  #
462
+ # @param uk_faster_payment_system_transfer_instruction [Increase::Models::PendingTransaction::Source::UkFasterPaymentSystemTransferInstruction, nil]
463
+ # An UK Faster Payment System Transfer Instruction object. This field will be
464
+ # present in the JSON response if and only if `category` is equal to
465
+ # `uk_faster_payment_system_transfer_instruction`.
466
+ #
437
467
  # @param user_initiated_hold [Hash{Symbol=>Object}, nil]
438
468
  # An User Initiated Hold object. This field will be present in the JSON response
439
469
  # if and only if `category` is equal to `user_initiated_hold`. Created when a user
@@ -495,6 +525,12 @@ module Increase
495
525
  # Blockchain Off-Ramp Transfer: details will be under the `blockchain_offramp_transfer` object.
496
526
  BLOCKCHAIN_OFFRAMP_TRANSFER = :blockchain_offramp_transfer
497
527
 
528
+ # UK Faster Payment System Transfer Instruction: details will be under the `uk_faster_payment_system_transfer_instruction` object.
529
+ UK_FASTER_PAYMENT_SYSTEM_TRANSFER_INSTRUCTION = :uk_faster_payment_system_transfer_instruction
530
+
531
+ # SEPA Instant Transfer Instruction: details will be under the `sepa_instant_transfer_instruction` object.
532
+ SEPA_INSTANT_TRANSFER_INSTRUCTION = :sepa_instant_transfer_instruction
533
+
498
534
  # The Pending Transaction was made for an undocumented or deprecated reason.
499
535
  OTHER = :other
500
536
 
@@ -2735,6 +2771,48 @@ module Increase
2735
2771
  # Transaction.
2736
2772
  end
2737
2773
 
2774
+ # @see Increase::Models::PendingTransaction::Source#sepa_instant_transfer_instruction
2775
+ class SepaInstantTransferInstruction < Increase::Internal::Type::BaseModel
2776
+ # @!attribute amount
2777
+ # The transfer amount in EUR cents.
2778
+ #
2779
+ # @return [Integer]
2780
+ required :amount, Integer
2781
+
2782
+ # @!attribute currency
2783
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the
2784
+ # transfer's currency. This is always `EUR`.
2785
+ #
2786
+ # @return [Symbol, Increase::Models::PendingTransaction::Source::SepaInstantTransferInstruction::Currency]
2787
+ required :currency,
2788
+ enum: -> { Increase::PendingTransaction::Source::SepaInstantTransferInstruction::Currency }
2789
+
2790
+ # @!method initialize(amount:, currency:)
2791
+ # A SEPA Instant Transfer Instruction object. This field will be present in the
2792
+ # JSON response if and only if `category` is equal to
2793
+ # `sepa_instant_transfer_instruction`.
2794
+ #
2795
+ # @param amount [Integer] The transfer amount in EUR cents.
2796
+ #
2797
+ # @param currency [Symbol, Increase::Models::PendingTransaction::Source::SepaInstantTransferInstruction::Currency]
2798
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the
2799
+ # transfer's currency. This is always `EUR`.
2800
+
2801
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the
2802
+ # transfer's currency. This is always `EUR`.
2803
+ #
2804
+ # @see Increase::Models::PendingTransaction::Source::SepaInstantTransferInstruction#currency
2805
+ module Currency
2806
+ extend Increase::Internal::Type::Enum
2807
+
2808
+ # EUR
2809
+ EUR = :EUR
2810
+
2811
+ # @!method self.values
2812
+ # @return [Array<Symbol>]
2813
+ end
2814
+ end
2815
+
2738
2816
  # @see Increase::Models::PendingTransaction::Source#swift_transfer_instruction
2739
2817
  class SwiftTransferInstruction < Increase::Internal::Type::BaseModel
2740
2818
  # @!attribute transfer_id
@@ -2750,6 +2828,48 @@ module Increase
2750
2828
  # @param transfer_id [String] The identifier of the Swift Transfer that led to this Pending Transaction.
2751
2829
  end
2752
2830
 
2831
+ # @see Increase::Models::PendingTransaction::Source#uk_faster_payment_system_transfer_instruction
2832
+ class UkFasterPaymentSystemTransferInstruction < Increase::Internal::Type::BaseModel
2833
+ # @!attribute amount
2834
+ # The transfer amount in GBP pence.
2835
+ #
2836
+ # @return [Integer]
2837
+ required :amount, Integer
2838
+
2839
+ # @!attribute currency
2840
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the
2841
+ # transfer's currency. This is always `GBP`.
2842
+ #
2843
+ # @return [Symbol, Increase::Models::PendingTransaction::Source::UkFasterPaymentSystemTransferInstruction::Currency]
2844
+ required :currency,
2845
+ enum: -> { Increase::PendingTransaction::Source::UkFasterPaymentSystemTransferInstruction::Currency }
2846
+
2847
+ # @!method initialize(amount:, currency:)
2848
+ # An UK Faster Payment System Transfer Instruction object. This field will be
2849
+ # present in the JSON response if and only if `category` is equal to
2850
+ # `uk_faster_payment_system_transfer_instruction`.
2851
+ #
2852
+ # @param amount [Integer] The transfer amount in GBP pence.
2853
+ #
2854
+ # @param currency [Symbol, Increase::Models::PendingTransaction::Source::UkFasterPaymentSystemTransferInstruction::Currency]
2855
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the
2856
+ # transfer's currency. This is always `GBP`.
2857
+
2858
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the
2859
+ # transfer's currency. This is always `GBP`.
2860
+ #
2861
+ # @see Increase::Models::PendingTransaction::Source::UkFasterPaymentSystemTransferInstruction#currency
2862
+ module Currency
2863
+ extend Increase::Internal::Type::Enum
2864
+
2865
+ # GBP
2866
+ GBP = :GBP
2867
+
2868
+ # @!method self.values
2869
+ # @return [Array<Symbol>]
2870
+ end
2871
+ end
2872
+
2753
2873
  # @see Increase::Models::PendingTransaction::Source#wire_transfer_instruction
2754
2874
  class WireTransferInstruction < Increase::Internal::Type::BaseModel
2755
2875
  # @!attribute account_number
@@ -135,6 +135,12 @@ module Increase
135
135
  # Blockchain Off-Ramp Transfer: details will be under the `blockchain_offramp_transfer` object.
136
136
  BLOCKCHAIN_OFFRAMP_TRANSFER = :blockchain_offramp_transfer
137
137
 
138
+ # UK Faster Payment System Transfer Instruction: details will be under the `uk_faster_payment_system_transfer_instruction` object.
139
+ UK_FASTER_PAYMENT_SYSTEM_TRANSFER_INSTRUCTION = :uk_faster_payment_system_transfer_instruction
140
+
141
+ # SEPA Instant Transfer Instruction: details will be under the `sepa_instant_transfer_instruction` object.
142
+ SEPA_INSTANT_TRANSFER_INSTRUCTION = :sepa_instant_transfer_instruction
143
+
138
144
  # The Pending Transaction was made for an undocumented or deprecated reason.
139
145
  OTHER = :other
140
146