increase 1.351.0 → 1.352.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 (51) 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/entity_create_params.rb +33 -20
  6. data/lib/increase/models/entity_update_params.rb +33 -20
  7. data/lib/increase/models/event.rb +12 -0
  8. data/lib/increase/models/event_list_params.rb +12 -0
  9. data/lib/increase/models/event_subscription.rb +12 -0
  10. data/lib/increase/models/event_subscription_create_params.rb +12 -0
  11. data/lib/increase/models/inbound_ach_transfer.rb +9 -1
  12. data/lib/increase/models/pending_transaction.rb +121 -1
  13. data/lib/increase/models/pending_transaction_list_params.rb +6 -0
  14. data/lib/increase/models/simulations/physical_card_create_params.rb +9 -6
  15. data/lib/increase/models/transaction.rb +103 -1
  16. data/lib/increase/models/transaction_list_params.rb +6 -0
  17. data/lib/increase/models/unwrap_webhook_event.rb +12 -0
  18. data/lib/increase/resources/simulations/account_statements.rb +2 -1
  19. data/lib/increase/resources/simulations/physical_cards.rb +5 -3
  20. data/lib/increase/version.rb +1 -1
  21. data/rbi/increase/models/account_statement.rbi +12 -4
  22. data/rbi/increase/models/balance_lookup.rbi +3 -87
  23. data/rbi/increase/models/entity_create_params.rbi +39 -21
  24. data/rbi/increase/models/entity_update_params.rbi +39 -21
  25. data/rbi/increase/models/event.rbi +28 -0
  26. data/rbi/increase/models/event_list_params.rbi +28 -0
  27. data/rbi/increase/models/event_subscription.rbi +28 -0
  28. data/rbi/increase/models/event_subscription_create_params.rbi +28 -0
  29. data/rbi/increase/models/inbound_ach_transfer.rbi +8 -0
  30. data/rbi/increase/models/pending_transaction.rbi +254 -0
  31. data/rbi/increase/models/pending_transaction_list_params.rbi +14 -0
  32. data/rbi/increase/models/simulations/physical_card_create_params.rbi +8 -6
  33. data/rbi/increase/models/transaction.rbi +178 -0
  34. data/rbi/increase/models/transaction_list_params.rbi +14 -0
  35. data/rbi/increase/models/unwrap_webhook_event.rbi +28 -0
  36. data/rbi/increase/resources/simulations/account_statements.rbi +2 -1
  37. data/rbi/increase/resources/simulations/physical_cards.rbi +4 -3
  38. data/sig/increase/models/balance_lookup.rbs +3 -42
  39. data/sig/increase/models/entity_create_params.rbs +20 -11
  40. data/sig/increase/models/entity_update_params.rbs +20 -11
  41. data/sig/increase/models/event.rbs +16 -0
  42. data/sig/increase/models/event_list_params.rbs +16 -0
  43. data/sig/increase/models/event_subscription.rbs +16 -0
  44. data/sig/increase/models/event_subscription_create_params.rbs +16 -0
  45. data/sig/increase/models/inbound_ach_transfer.rbs +5 -0
  46. data/sig/increase/models/pending_transaction.rbs +84 -0
  47. data/sig/increase/models/pending_transaction_list_params.rbs +8 -0
  48. data/sig/increase/models/transaction.rbs +50 -0
  49. data/sig/increase/models/transaction_list_params.rbs +8 -0
  50. data/sig/increase/models/unwrap_webhook_event.rbs +16 -0
  51. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 229dee88f03c345c4903597d7a20db497482448aa3268a0edf90f2bafa52450d
4
- data.tar.gz: '029a7517e800af1f34139527fd05b26548bb85464855ef7ce51bed4edb031b7a'
3
+ metadata.gz: a3a0faba0f1fabf59ef08da704ac074fb3072fe05fd88f030085c6a1a607e21a
4
+ data.tar.gz: 914e704b6cc6f73250740529117d1fd2c8cfa8aa4dd4e3aa29995c0b145d0eb0
5
5
  SHA512:
6
- metadata.gz: 137e0f76116c15a8ea3cfd28d475a9f35a1531af5294e24ba92f3db5ebf2541d787fee2b19228291a4f5e8cfaeae4018b164d90b8de4f92adc89caef979b4749
7
- data.tar.gz: 20c432c45dcdd377e6fe61efa6469ff320adc0a87019012c5b964fdc9d929d902671e7ba9a3b7e4e4b93078d84d3cef41b389c2a04dc5976502f92b038292e28
6
+ metadata.gz: e05ef8df91dc79fafdc84978f7c23289a198df220494b0459ad427a2b4b34dbe2d8e68aac97e04c20ba6dacaba97ce801e3c58f9e022a4331078fc3b1d2cf741
7
+ data.tar.gz: 4cefdcfc16a1f118021f0d7abe63c22187ab17429645820a782bef66f41a8d22dd3cfe52ae9379842bf0a7a4edd399ee8c4289f6970f37c5943d3a69165f384c
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.351.0"
18
+ gem "increase", "~> 1.352.0"
19
19
  ```
20
20
 
21
21
  <!-- x-release-please-end -->
@@ -49,14 +49,18 @@ module Increase
49
49
 
50
50
  # @!attribute statement_period_end
51
51
  # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time representing the end
52
- # of the period the Account Statement covers.
52
+ # of the period the Account Statement covers. The statement covers all
53
+ # transactions up to, but not including this timestamp. Usually, this is the
54
+ # beginning of the following month.
53
55
  #
54
56
  # @return [Time]
55
57
  required :statement_period_end, Time
56
58
 
57
59
  # @!attribute statement_period_start
58
60
  # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time representing the
59
- # start of the period the Account Statement covers.
61
+ # start of the period the Account Statement covers. This is the first moment of
62
+ # the statement period and is inclusive. Usually, this is the beginning of the
63
+ # month this statement covers.
60
64
  #
61
65
  # @return [Time]
62
66
  required :statement_period_start, Time
@@ -91,11 +95,15 @@ module Increase
91
95
  #
92
96
  # @param statement_period_end [Time]
93
97
  # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time representing the end
94
- # of the period the Account Statement covers.
98
+ # of the period the Account Statement covers. The statement covers all
99
+ # transactions up to, but not including this timestamp. Usually, this is the
100
+ # beginning of the following month.
95
101
  #
96
102
  # @param statement_period_start [Time]
97
103
  # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time representing the
98
- # start of the period the Account Statement covers.
104
+ # start of the period the Account Statement covers. This is the first moment of
105
+ # the statement period and is inclusive. Usually, this is the beginning of the
106
+ # month this statement covers.
99
107
  #
100
108
  # @param type [Symbol, Increase::Models::AccountStatement::Type]
101
109
  # A constant representing the object's type. For this resource it will always be
@@ -59,19 +59,6 @@ module Increase
59
59
 
60
60
  # @see Increase::Models::BalanceLookup#loan
61
61
  class Loan < Increase::Internal::Type::BaseModel
62
- # @!attribute due_at
63
- # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the loan
64
- # payment is due.
65
- #
66
- # @return [Time, nil]
67
- required :due_at, Time, nil?: true
68
-
69
- # @!attribute due_balance
70
- # The total amount due on the loan.
71
- #
72
- # @return [Integer]
73
- required :due_balance, Integer
74
-
75
62
  # @!attribute due_fees
76
63
  # The fees on the loan that are due and unpaid.
77
64
  #
@@ -108,27 +95,9 @@ module Increase
108
95
  # @return [Integer, nil]
109
96
  required :not_due_principal, Integer, nil?: true
110
97
 
111
- # @!attribute past_due_balance
112
- # The amount past due on the loan.
113
- #
114
- # @return [Integer]
115
- required :past_due_balance, Integer
116
-
117
- # @!attribute receivables
118
- # The receivables balances for the loan.
119
- #
120
- # @return [Increase::Models::BalanceLookup::Loan::Receivables, nil]
121
- required :receivables, -> { Increase::BalanceLookup::Loan::Receivables }, nil?: true
122
-
123
- # @!method initialize(due_at:, due_balance:, due_fees:, due_interest:, due_principal:, not_due_fees:, not_due_interest:, not_due_principal:, past_due_balance:, receivables:)
98
+ # @!method initialize(due_fees:, due_interest:, due_principal:, not_due_fees:, not_due_interest:, not_due_principal:)
124
99
  # The loan balances for the Account.
125
100
  #
126
- # @param due_at [Time, nil]
127
- # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the loan
128
- # payment is due.
129
- #
130
- # @param due_balance [Integer] The total amount due on the loan.
131
- #
132
101
  # @param due_fees [Integer, nil] The fees on the loan that are due and unpaid.
133
102
  #
134
103
  # @param due_interest [Integer, nil] The interest on the loan that is due and unpaid.
@@ -140,33 +109,6 @@ module Increase
140
109
  # @param not_due_interest [Integer, nil] The interest on the loan that is not yet due.
141
110
  #
142
111
  # @param not_due_principal [Integer, nil] The principal on the loan that is not yet due.
143
- #
144
- # @param past_due_balance [Integer] The amount past due on the loan.
145
- #
146
- # @param receivables [Increase::Models::BalanceLookup::Loan::Receivables, nil]
147
- # The receivables balances for the loan.
148
-
149
- # @see Increase::Models::BalanceLookup::Loan#receivables
150
- class Receivables < Increase::Internal::Type::BaseModel
151
- # @!attribute purchasable_balance
152
- # The balance of seasoned receivables available to be purchased.
153
- #
154
- # @return [Integer]
155
- required :purchasable_balance, Integer
156
-
157
- # @!attribute purchased_balance
158
- # The balance of receivables that have been purchased.
159
- #
160
- # @return [Integer]
161
- required :purchased_balance, Integer
162
-
163
- # @!method initialize(purchasable_balance:, purchased_balance:)
164
- # The receivables balances for the loan.
165
- #
166
- # @param purchasable_balance [Integer] The balance of seasoned receivables available to be purchased.
167
- #
168
- # @param purchased_balance [Integer] The balance of receivables that have been purchased.
169
- end
170
112
  end
171
113
 
172
114
  # A constant representing the object's type. For this resource it will always be
@@ -2193,29 +2193,24 @@ module Increase
2193
2193
  # @see Increase::Models::EntityCreateParams::Trust#address
2194
2194
  class Address < Increase::Internal::Type::BaseModel
2195
2195
  # @!attribute city
2196
- # The city of the address.
2196
+ # The city, district, town, or village of the address.
2197
2197
  #
2198
2198
  # @return [String]
2199
2199
  required :city, String
2200
2200
 
2201
- # @!attribute line1
2202
- # The first line of the address. This is usually the street number and street.
2201
+ # @!attribute country
2202
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
2203
2203
  #
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.
2204
+ # Defaults to `US`.
2210
2205
  #
2211
2206
  # @return [String]
2212
- required :state, String
2207
+ required :country, String
2213
2208
 
2214
- # @!attribute zip
2215
- # The ZIP code of the address.
2209
+ # @!attribute line1
2210
+ # The first line of the address. This is usually the street number and street.
2216
2211
  #
2217
2212
  # @return [String]
2218
- required :zip, String
2213
+ required :line1, String
2219
2214
 
2220
2215
  # @!attribute line2
2221
2216
  # The second line of the address. This might be the floor or room number.
@@ -2223,21 +2218,39 @@ module Increase
2223
2218
  # @return [String, nil]
2224
2219
  optional :line2, String
2225
2220
 
2226
- # @!method initialize(city:, line1:, state:, zip:, line2: nil)
2221
+ # @!attribute state
2222
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
2223
+ # state, province, or region of the address. Required in certain countries.
2224
+ #
2225
+ # @return [String, nil]
2226
+ optional :state, String
2227
+
2228
+ # @!attribute zip
2229
+ # The ZIP or postal code of the address. Required in certain countries.
2230
+ #
2231
+ # @return [String, nil]
2232
+ optional :zip, String
2233
+
2234
+ # @!method initialize(city:, country:, line1:, line2: nil, state: nil, zip: nil)
2227
2235
  # The trust's physical address. Mail receiving locations like PO Boxes and PMB's
2228
2236
  # are disallowed.
2229
2237
  #
2230
- # @param city [String] The city of the address.
2238
+ # @param city [String] The city, district, town, or village of the address.
2231
2239
  #
2232
- # @param line1 [String] The first line of the address. This is usually the street number and street.
2240
+ # @param country [String]
2241
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
2233
2242
  #
2234
- # @param state [String]
2235
- # The two-letter United States Postal Service (USPS) abbreviation for the state of
2236
- # the address.
2243
+ # Defaults to `US`.
2237
2244
  #
2238
- # @param zip [String] The ZIP code of the address.
2245
+ # @param line1 [String] The first line of the address. This is usually the street number and street.
2239
2246
  #
2240
2247
  # @param line2 [String] The second line of the address. This might be the floor or room number.
2248
+ #
2249
+ # @param state [String]
2250
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
2251
+ # state, province, or region of the address. Required in certain countries.
2252
+ #
2253
+ # @param zip [String] The ZIP or postal code of the address. Required in certain countries.
2241
2254
  end
2242
2255
 
2243
2256
  # 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