increase 1.0.0 → 1.1.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 (61) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +25 -0
  3. data/README.md +1 -1
  4. data/lib/increase/errors.rb +22 -0
  5. data/lib/increase/internal/type/array_of.rb +6 -1
  6. data/lib/increase/internal/type/base_model.rb +77 -25
  7. data/lib/increase/internal/type/boolean.rb +7 -1
  8. data/lib/increase/internal/type/converter.rb +42 -34
  9. data/lib/increase/internal/type/enum.rb +10 -2
  10. data/lib/increase/internal/type/file_input.rb +6 -1
  11. data/lib/increase/internal/type/hash_of.rb +6 -1
  12. data/lib/increase/internal/type/union.rb +12 -7
  13. data/lib/increase/internal/type/unknown.rb +7 -1
  14. data/lib/increase/models/card_payment.rb +13 -13
  15. data/lib/increase/models/check_transfer.rb +24 -1
  16. data/lib/increase/models/check_transfer_create_params.rb +26 -2
  17. data/lib/increase/models/event.rb +22 -4
  18. data/lib/increase/models/event_list_params.rb +22 -4
  19. data/lib/increase/models/event_subscription.rb +22 -4
  20. data/lib/increase/models/event_subscription_create_params.rb +22 -4
  21. data/lib/increase/models/inbound_ach_transfer.rb +56 -26
  22. data/lib/increase/models/inbound_mail_item.rb +38 -1
  23. data/lib/increase/models/pending_transaction.rb +37 -44
  24. data/lib/increase/models/pending_transaction_list_params.rb +2 -2
  25. data/lib/increase/models/transaction.rb +41 -43
  26. data/lib/increase/models/transaction_list_params.rb +2 -2
  27. data/lib/increase/version.rb +1 -1
  28. data/rbi/increase/errors.rbi +16 -0
  29. data/rbi/increase/internal/type/boolean.rbi +2 -0
  30. data/rbi/increase/internal/type/converter.rbi +15 -15
  31. data/rbi/increase/internal/type/union.rbi +5 -0
  32. data/rbi/increase/internal/type/unknown.rbi +2 -0
  33. data/rbi/increase/models/card_payment.rbi +18 -18
  34. data/rbi/increase/models/check_transfer.rbi +36 -0
  35. data/rbi/increase/models/check_transfer_create_params.rbi +63 -2
  36. data/rbi/increase/models/event.rbi +46 -4
  37. data/rbi/increase/models/event_list_params.rbi +46 -4
  38. data/rbi/increase/models/event_subscription.rbi +46 -4
  39. data/rbi/increase/models/event_subscription_create_params.rbi +46 -4
  40. data/rbi/increase/models/inbound_ach_transfer.rbi +108 -52
  41. data/rbi/increase/models/inbound_mail_item.rbi +57 -0
  42. data/rbi/increase/models/pending_transaction.rbi +72 -77
  43. data/rbi/increase/models/pending_transaction_list_params.rbi +3 -3
  44. data/rbi/increase/models/transaction.rbi +76 -81
  45. data/rbi/increase/models/transaction_list_params.rbi +3 -3
  46. data/sig/increase/errors.rbs +9 -0
  47. data/sig/increase/internal/type/converter.rbs +7 -1
  48. data/sig/increase/models/card_payment.rbs +3 -3
  49. data/sig/increase/models/check_transfer.rbs +15 -0
  50. data/sig/increase/models/check_transfer_create_params.rbs +19 -0
  51. data/sig/increase/models/event.rbs +28 -4
  52. data/sig/increase/models/event_list_params.rbs +28 -4
  53. data/sig/increase/models/event_subscription.rbs +28 -4
  54. data/sig/increase/models/event_subscription_create_params.rbs +28 -4
  55. data/sig/increase/models/inbound_ach_transfer.rbs +41 -19
  56. data/sig/increase/models/inbound_mail_item.rbs +28 -0
  57. data/sig/increase/models/pending_transaction.rbs +21 -21
  58. data/sig/increase/models/pending_transaction_list_params.rbs +3 -3
  59. data/sig/increase/models/transaction.rbs +21 -21
  60. data/sig/increase/models/transaction_list_params.rbs +3 -3
  61. metadata +2 -2
@@ -171,10 +171,10 @@ module Increase
171
171
  required :card_settlement, -> { Increase::CardPayment::Element::CardSettlement }, nil?: true
172
172
 
173
173
  # @!attribute card_validation
174
- # A Card Validation object. This field will be present in the JSON response if and
175
- # only if `category` is equal to `card_validation`. Card Validations are requests
176
- # from a merchant to verify that a card number and optionally its address and/or
177
- # Card Verification Value are valid.
174
+ # An Inbound Card Validation object. This field will be present in the JSON
175
+ # response if and only if `category` is equal to `card_validation`. Inbound Card
176
+ # Validations are requests from a merchant to verify that a card number and
177
+ # optionally its address and/or Card Verification Value are valid.
178
178
  #
179
179
  # @return [Increase::Models::CardPayment::Element::CardValidation, nil]
180
180
  required :card_validation, -> { Increase::CardPayment::Element::CardValidation }, nil?: true
@@ -222,7 +222,7 @@ module Increase
222
222
  #
223
223
  # @param card_settlement [Increase::Models::CardPayment::Element::CardSettlement, nil] A Card Settlement object. This field will be present in the JSON response if and
224
224
  #
225
- # @param card_validation [Increase::Models::CardPayment::Element::CardValidation, nil] A Card Validation object. This field will be present in the JSON response if and
225
+ # @param card_validation [Increase::Models::CardPayment::Element::CardValidation, nil] An Inbound Card Validation object. This field will be present in the JSON respon
226
226
  #
227
227
  # @param category [Symbol, Increase::Models::CardPayment::Element::Category] The type of the resource. We may add additional possible values for this enum ov
228
228
  #
@@ -5880,7 +5880,7 @@ module Increase
5880
5880
 
5881
5881
  # @!attribute type
5882
5882
  # A constant representing the object's type. For this resource it will always be
5883
- # `card_validation`.
5883
+ # `inbound_card_validation`.
5884
5884
  #
5885
5885
  # @return [Symbol, Increase::Models::CardPayment::Element::CardValidation::Type]
5886
5886
  required :type, enum: -> { Increase::CardPayment::Element::CardValidation::Type }
@@ -5895,10 +5895,10 @@ module Increase
5895
5895
  # Some parameter documentations has been truncated, see
5896
5896
  # {Increase::Models::CardPayment::Element::CardValidation} for more details.
5897
5897
  #
5898
- # A Card Validation object. This field will be present in the JSON response if and
5899
- # only if `category` is equal to `card_validation`. Card Validations are requests
5900
- # from a merchant to verify that a card number and optionally its address and/or
5901
- # Card Verification Value are valid.
5898
+ # An Inbound Card Validation object. This field will be present in the JSON
5899
+ # response if and only if `category` is equal to `card_validation`. Inbound Card
5900
+ # Validations are requests from a merchant to verify that a card number and
5901
+ # optionally its address and/or Card Verification Value are valid.
5902
5902
  #
5903
5903
  # @param id [String] The Card Validation identifier.
5904
5904
  #
@@ -6232,13 +6232,13 @@ module Increase
6232
6232
  end
6233
6233
 
6234
6234
  # A constant representing the object's type. For this resource it will always be
6235
- # `card_validation`.
6235
+ # `inbound_card_validation`.
6236
6236
  #
6237
6237
  # @see Increase::Models::CardPayment::Element::CardValidation#type
6238
6238
  module Type
6239
6239
  extend Increase::Internal::Type::Enum
6240
6240
 
6241
- CARD_VALIDATION = :card_validation
6241
+ INBOUND_CARD_VALIDATION = :inbound_card_validation
6242
6242
 
6243
6243
  # @!method self.values
6244
6244
  # @return [Array<Symbol>]
@@ -6408,7 +6408,7 @@ module Increase
6408
6408
  # Card Authentication: details will be under the `card_authentication` object.
6409
6409
  CARD_AUTHENTICATION = :card_authentication
6410
6410
 
6411
- # Card Validation: details will be under the `card_validation` object.
6411
+ # Inbound Card Validation: details will be under the `card_validation` object.
6412
6412
  CARD_VALIDATION = :card_validation
6413
6413
 
6414
6414
  # Card Decline: details will be under the `card_decline` object.
@@ -473,6 +473,16 @@ module Increase
473
473
  # @return [String, nil]
474
474
  required :note, String, nil?: true
475
475
 
476
+ # @!attribute payer
477
+ # The payer of the check. This will be printed on the top-left portion of the
478
+ # check and defaults to the return address if unspecified.
479
+ #
480
+ # @return [Array<Increase::Models::CheckTransfer::PhysicalCheck::Payer>]
481
+ required :payer,
482
+ -> {
483
+ Increase::Internal::Type::ArrayOf[Increase::CheckTransfer::PhysicalCheck::Payer]
484
+ }
485
+
476
486
  # @!attribute recipient_name
477
487
  # The name that will be printed on the check.
478
488
  #
@@ -511,7 +521,7 @@ module Increase
511
521
  Increase::Internal::Type::ArrayOf[Increase::CheckTransfer::PhysicalCheck::TrackingUpdate]
512
522
  }
513
523
 
514
- # @!method initialize(attachment_file_id:, mailing_address:, memo:, note:, recipient_name:, return_address:, shipping_method:, signature_text:, tracking_updates:)
524
+ # @!method initialize(attachment_file_id:, mailing_address:, memo:, note:, payer:, recipient_name:, return_address:, shipping_method:, signature_text:, tracking_updates:)
515
525
  # Some parameter documentations has been truncated, see
516
526
  # {Increase::Models::CheckTransfer::PhysicalCheck} for more details.
517
527
  #
@@ -526,6 +536,8 @@ module Increase
526
536
  #
527
537
  # @param note [String, nil] The descriptor that will be printed on the letter included with the check.
528
538
  #
539
+ # @param payer [Array<Increase::Models::CheckTransfer::PhysicalCheck::Payer>] The payer of the check. This will be printed on the top-left portion of the chec
540
+ #
529
541
  # @param recipient_name [String] The name that will be printed on the check.
530
542
  #
531
543
  # @param return_address [Increase::Models::CheckTransfer::PhysicalCheck::ReturnAddress, nil] The return address to be printed on the check.
@@ -590,6 +602,17 @@ module Increase
590
602
  # @param state [String, nil] The state of the check's destination.
591
603
  end
592
604
 
605
+ class Payer < Increase::Internal::Type::BaseModel
606
+ # @!attribute contents
607
+ # The contents of the line.
608
+ #
609
+ # @return [String]
610
+ required :contents, String
611
+
612
+ # @!method initialize(contents:)
613
+ # @param contents [String] The contents of the line.
614
+ end
615
+
593
616
  # @see Increase::Models::CheckTransfer::PhysicalCheck#return_address
594
617
  class ReturnAddress < Increase::Internal::Type::BaseModel
595
618
  # @!attribute city
@@ -131,6 +131,17 @@ module Increase
131
131
  # @return [String, nil]
132
132
  optional :note, String
133
133
 
134
+ # @!attribute payer
135
+ # The payer of the check. This will be printed on the top-left portion of the
136
+ # check and defaults to the return address if unspecified. This should be an array
137
+ # of up to 4 elements, each of which represents a line of the payer.
138
+ #
139
+ # @return [Array<Increase::Models::CheckTransferCreateParams::PhysicalCheck::Payer>, nil]
140
+ optional :payer,
141
+ -> {
142
+ Increase::Internal::Type::ArrayOf[Increase::CheckTransferCreateParams::PhysicalCheck::Payer]
143
+ }
144
+
134
145
  # @!attribute return_address
135
146
  # The return address to be printed on the check. If omitted this will default to
136
147
  # an Increase-owned address that will mark checks as delivery failed and shred
@@ -156,7 +167,7 @@ module Increase
156
167
  # @return [String, nil]
157
168
  optional :signature_text, String
158
169
 
159
- # @!method initialize(mailing_address:, memo:, recipient_name:, attachment_file_id: nil, note: nil, return_address: nil, shipping_method: nil, signature_text: nil)
170
+ # @!method initialize(mailing_address:, memo:, recipient_name:, attachment_file_id: nil, note: nil, payer: nil, return_address: nil, shipping_method: nil, signature_text: nil)
160
171
  # Some parameter documentations has been truncated, see
161
172
  # {Increase::Models::CheckTransferCreateParams::PhysicalCheck} for more details.
162
173
  #
@@ -174,6 +185,8 @@ module Increase
174
185
  #
175
186
  # @param note [String] The descriptor that will be printed on the letter included with the check.
176
187
  #
188
+ # @param payer [Array<Increase::Models::CheckTransferCreateParams::PhysicalCheck::Payer>] The payer of the check. This will be printed on the top-left portion of the chec
189
+ #
177
190
  # @param return_address [Increase::Models::CheckTransferCreateParams::PhysicalCheck::ReturnAddress] The return address to be printed on the check. If omitted this will default to a
178
191
  #
179
192
  # @param shipping_method [Symbol, Increase::Models::CheckTransferCreateParams::PhysicalCheck::ShippingMethod] How to ship the check. For details on pricing, timing, and restrictions, see htt
@@ -226,6 +239,17 @@ module Increase
226
239
  # @param line2 [String] The second line of the address component of the check's destination address.
227
240
  end
228
241
 
242
+ class Payer < Increase::Internal::Type::BaseModel
243
+ # @!attribute contents
244
+ # The contents of the line.
245
+ #
246
+ # @return [String]
247
+ required :contents, String
248
+
249
+ # @!method initialize(contents:)
250
+ # @param contents [String] The contents of the line.
251
+ end
252
+
229
253
  # @see Increase::Models::CheckTransferCreateParams::PhysicalCheck#return_address
230
254
  class ReturnAddress < Increase::Internal::Type::BaseModel
231
255
  # @!attribute city
@@ -304,7 +328,7 @@ module Increase
304
328
  # @!attribute recipient_name
305
329
  # The pay-to name you will print on the check. If provided, this is used for
306
330
  # [Positive Pay](/documentation/positive-pay). If this is omitted, Increase will
307
- # be unable to validate the payee name when the check is deposited.
331
+ # be unable to validate the payer name when the check is deposited.
308
332
  #
309
333
  # @return [String, nil]
310
334
  optional :recipient_name, String
@@ -262,18 +262,30 @@ module Increase
262
262
  # Occurs whenever an OAuth Connection is deactivated.
263
263
  OAUTH_CONNECTION_DEACTIVATED = :"oauth_connection.deactivated"
264
264
 
265
- # Occurs whenever an Outbound Card Push Transfer is created.
265
+ # Occurs whenever a Card Push Transfer is created.
266
266
  OUTBOUND_CARD_PUSH_TRANSFER_CREATED = :"outbound_card_push_transfer.created"
267
267
 
268
- # Occurs whenever an Outbound Card Push Transfer is updated.
268
+ # Occurs whenever a Card Push Transfer is updated.
269
269
  OUTBOUND_CARD_PUSH_TRANSFER_UPDATED = :"outbound_card_push_transfer.updated"
270
270
 
271
- # Occurs whenever an Outbound Card Validation is created.
271
+ # Occurs whenever a Card Validation is created.
272
272
  OUTBOUND_CARD_VALIDATION_CREATED = :"outbound_card_validation.created"
273
273
 
274
- # Occurs whenever an Outbound Card Validation is updated.
274
+ # Occurs whenever a Card Validation is updated.
275
275
  OUTBOUND_CARD_VALIDATION_UPDATED = :"outbound_card_validation.updated"
276
276
 
277
+ # Occurs whenever a Card Push Transfer is created.
278
+ CARD_PUSH_TRANSFER_CREATED = :"card_push_transfer.created"
279
+
280
+ # Occurs whenever a Card Push Transfer is updated.
281
+ CARD_PUSH_TRANSFER_UPDATED = :"card_push_transfer.updated"
282
+
283
+ # Occurs whenever a Card Validation is created.
284
+ CARD_VALIDATION_CREATED = :"card_validation.created"
285
+
286
+ # Occurs whenever a Card Validation is updated.
287
+ CARD_VALIDATION_UPDATED = :"card_validation.updated"
288
+
277
289
  # Occurs whenever a Pending Transaction is created.
278
290
  PENDING_TRANSACTION_CREATED = :"pending_transaction.created"
279
291
 
@@ -327,6 +339,12 @@ module Increase
327
339
  # Occurs whenever a Real-Time Payments Request for Payment is updated.
328
340
  REAL_TIME_PAYMENTS_REQUEST_FOR_PAYMENT_UPDATED = :"real_time_payments_request_for_payment.updated"
329
341
 
342
+ # Occurs whenever a Swift Transfer is created.
343
+ SWIFT_TRANSFER_CREATED = :"swift_transfer.created"
344
+
345
+ # Occurs whenever a Swift Transfer is updated.
346
+ SWIFT_TRANSFER_UPDATED = :"swift_transfer.updated"
347
+
330
348
  # Occurs whenever a Transaction is created.
331
349
  TRANSACTION_CREATED = :"transaction.created"
332
350
 
@@ -264,18 +264,30 @@ module Increase
264
264
  # Occurs whenever an OAuth Connection is deactivated.
265
265
  OAUTH_CONNECTION_DEACTIVATED = :"oauth_connection.deactivated"
266
266
 
267
- # Occurs whenever an Outbound Card Push Transfer is created.
267
+ # Occurs whenever a Card Push Transfer is created.
268
268
  OUTBOUND_CARD_PUSH_TRANSFER_CREATED = :"outbound_card_push_transfer.created"
269
269
 
270
- # Occurs whenever an Outbound Card Push Transfer is updated.
270
+ # Occurs whenever a Card Push Transfer is updated.
271
271
  OUTBOUND_CARD_PUSH_TRANSFER_UPDATED = :"outbound_card_push_transfer.updated"
272
272
 
273
- # Occurs whenever an Outbound Card Validation is created.
273
+ # Occurs whenever a Card Validation is created.
274
274
  OUTBOUND_CARD_VALIDATION_CREATED = :"outbound_card_validation.created"
275
275
 
276
- # Occurs whenever an Outbound Card Validation is updated.
276
+ # Occurs whenever a Card Validation is updated.
277
277
  OUTBOUND_CARD_VALIDATION_UPDATED = :"outbound_card_validation.updated"
278
278
 
279
+ # Occurs whenever a Card Push Transfer is created.
280
+ CARD_PUSH_TRANSFER_CREATED = :"card_push_transfer.created"
281
+
282
+ # Occurs whenever a Card Push Transfer is updated.
283
+ CARD_PUSH_TRANSFER_UPDATED = :"card_push_transfer.updated"
284
+
285
+ # Occurs whenever a Card Validation is created.
286
+ CARD_VALIDATION_CREATED = :"card_validation.created"
287
+
288
+ # Occurs whenever a Card Validation is updated.
289
+ CARD_VALIDATION_UPDATED = :"card_validation.updated"
290
+
279
291
  # Occurs whenever a Pending Transaction is created.
280
292
  PENDING_TRANSACTION_CREATED = :"pending_transaction.created"
281
293
 
@@ -329,6 +341,12 @@ module Increase
329
341
  # Occurs whenever a Real-Time Payments Request for Payment is updated.
330
342
  REAL_TIME_PAYMENTS_REQUEST_FOR_PAYMENT_UPDATED = :"real_time_payments_request_for_payment.updated"
331
343
 
344
+ # Occurs whenever a Swift Transfer is created.
345
+ SWIFT_TRANSFER_CREATED = :"swift_transfer.created"
346
+
347
+ # Occurs whenever a Swift Transfer is updated.
348
+ SWIFT_TRANSFER_UPDATED = :"swift_transfer.updated"
349
+
332
350
  # Occurs whenever a Transaction is created.
333
351
  TRANSACTION_CREATED = :"transaction.created"
334
352
 
@@ -285,18 +285,30 @@ module Increase
285
285
  # Occurs whenever an OAuth Connection is deactivated.
286
286
  OAUTH_CONNECTION_DEACTIVATED = :"oauth_connection.deactivated"
287
287
 
288
- # Occurs whenever an Outbound Card Push Transfer is created.
288
+ # Occurs whenever a Card Push Transfer is created.
289
289
  OUTBOUND_CARD_PUSH_TRANSFER_CREATED = :"outbound_card_push_transfer.created"
290
290
 
291
- # Occurs whenever an Outbound Card Push Transfer is updated.
291
+ # Occurs whenever a Card Push Transfer is updated.
292
292
  OUTBOUND_CARD_PUSH_TRANSFER_UPDATED = :"outbound_card_push_transfer.updated"
293
293
 
294
- # Occurs whenever an Outbound Card Validation is created.
294
+ # Occurs whenever a Card Validation is created.
295
295
  OUTBOUND_CARD_VALIDATION_CREATED = :"outbound_card_validation.created"
296
296
 
297
- # Occurs whenever an Outbound Card Validation is updated.
297
+ # Occurs whenever a Card Validation is updated.
298
298
  OUTBOUND_CARD_VALIDATION_UPDATED = :"outbound_card_validation.updated"
299
299
 
300
+ # Occurs whenever a Card Push Transfer is created.
301
+ CARD_PUSH_TRANSFER_CREATED = :"card_push_transfer.created"
302
+
303
+ # Occurs whenever a Card Push Transfer is updated.
304
+ CARD_PUSH_TRANSFER_UPDATED = :"card_push_transfer.updated"
305
+
306
+ # Occurs whenever a Card Validation is created.
307
+ CARD_VALIDATION_CREATED = :"card_validation.created"
308
+
309
+ # Occurs whenever a Card Validation is updated.
310
+ CARD_VALIDATION_UPDATED = :"card_validation.updated"
311
+
300
312
  # Occurs whenever a Pending Transaction is created.
301
313
  PENDING_TRANSACTION_CREATED = :"pending_transaction.created"
302
314
 
@@ -350,6 +362,12 @@ module Increase
350
362
  # Occurs whenever a Real-Time Payments Request for Payment is updated.
351
363
  REAL_TIME_PAYMENTS_REQUEST_FOR_PAYMENT_UPDATED = :"real_time_payments_request_for_payment.updated"
352
364
 
365
+ # Occurs whenever a Swift Transfer is created.
366
+ SWIFT_TRANSFER_CREATED = :"swift_transfer.created"
367
+
368
+ # Occurs whenever a Swift Transfer is updated.
369
+ SWIFT_TRANSFER_UPDATED = :"swift_transfer.updated"
370
+
353
371
  # Occurs whenever a Transaction is created.
354
372
  TRANSACTION_CREATED = :"transaction.created"
355
373
 
@@ -246,18 +246,30 @@ module Increase
246
246
  # Occurs whenever an OAuth Connection is deactivated.
247
247
  OAUTH_CONNECTION_DEACTIVATED = :"oauth_connection.deactivated"
248
248
 
249
- # Occurs whenever an Outbound Card Push Transfer is created.
249
+ # Occurs whenever a Card Push Transfer is created.
250
250
  OUTBOUND_CARD_PUSH_TRANSFER_CREATED = :"outbound_card_push_transfer.created"
251
251
 
252
- # Occurs whenever an Outbound Card Push Transfer is updated.
252
+ # Occurs whenever a Card Push Transfer is updated.
253
253
  OUTBOUND_CARD_PUSH_TRANSFER_UPDATED = :"outbound_card_push_transfer.updated"
254
254
 
255
- # Occurs whenever an Outbound Card Validation is created.
255
+ # Occurs whenever a Card Validation is created.
256
256
  OUTBOUND_CARD_VALIDATION_CREATED = :"outbound_card_validation.created"
257
257
 
258
- # Occurs whenever an Outbound Card Validation is updated.
258
+ # Occurs whenever a Card Validation is updated.
259
259
  OUTBOUND_CARD_VALIDATION_UPDATED = :"outbound_card_validation.updated"
260
260
 
261
+ # Occurs whenever a Card Push Transfer is created.
262
+ CARD_PUSH_TRANSFER_CREATED = :"card_push_transfer.created"
263
+
264
+ # Occurs whenever a Card Push Transfer is updated.
265
+ CARD_PUSH_TRANSFER_UPDATED = :"card_push_transfer.updated"
266
+
267
+ # Occurs whenever a Card Validation is created.
268
+ CARD_VALIDATION_CREATED = :"card_validation.created"
269
+
270
+ # Occurs whenever a Card Validation is updated.
271
+ CARD_VALIDATION_UPDATED = :"card_validation.updated"
272
+
261
273
  # Occurs whenever a Pending Transaction is created.
262
274
  PENDING_TRANSACTION_CREATED = :"pending_transaction.created"
263
275
 
@@ -311,6 +323,12 @@ module Increase
311
323
  # Occurs whenever a Real-Time Payments Request for Payment is updated.
312
324
  REAL_TIME_PAYMENTS_REQUEST_FOR_PAYMENT_UPDATED = :"real_time_payments_request_for_payment.updated"
313
325
 
326
+ # Occurs whenever a Swift Transfer is created.
327
+ SWIFT_TRANSFER_CREATED = :"swift_transfer.created"
328
+
329
+ # Occurs whenever a Swift Transfer is updated.
330
+ SWIFT_TRANSFER_UPDATED = :"swift_transfer.updated"
331
+
314
332
  # Occurs whenever a Transaction is created.
315
333
  TRANSACTION_CREATED = :"transaction.created"
316
334
 
@@ -72,13 +72,6 @@ module Increase
72
72
  # @return [Date]
73
73
  required :effective_date, Date
74
74
 
75
- # @!attribute expected_settlement_schedule
76
- # The settlement schedule the transfer is expected to follow.
77
- #
78
- # @return [Symbol, Increase::Models::InboundACHTransfer::ExpectedSettlementSchedule]
79
- required :expected_settlement_schedule,
80
- enum: -> { Increase::InboundACHTransfer::ExpectedSettlementSchedule }
81
-
82
75
  # @!attribute international_addenda
83
76
  # If the Inbound ACH Transfer has a Standard Entry Class Code of IAT, this will
84
77
  # contain fields pertaining to the International ACH Transaction.
@@ -142,6 +135,13 @@ module Increase
142
135
  # @return [String, nil]
143
136
  required :receiver_name, String, nil?: true
144
137
 
138
+ # @!attribute settlement
139
+ # A subhash containing information about when and how the transfer settled at the
140
+ # Federal Reserve.
141
+ #
142
+ # @return [Increase::Models::InboundACHTransfer::Settlement]
143
+ required :settlement, -> { Increase::InboundACHTransfer::Settlement }
144
+
145
145
  # @!attribute standard_entry_class_code
146
146
  # The Standard Entry Class (SEC) code of the transfer.
147
147
  #
@@ -176,7 +176,7 @@ module Increase
176
176
  # @return [Symbol, Increase::Models::InboundACHTransfer::Type]
177
177
  required :type, enum: -> { Increase::InboundACHTransfer::Type }
178
178
 
179
- # @!method initialize(id:, acceptance:, account_id:, account_number_id:, addenda:, amount:, automatically_resolves_at:, created_at:, decline:, direction:, effective_date:, expected_settlement_schedule:, international_addenda:, notification_of_change:, originator_company_descriptive_date:, originator_company_discretionary_data:, originator_company_entry_description:, originator_company_id:, originator_company_name:, originator_routing_number:, receiver_id_number:, receiver_name:, standard_entry_class_code:, status:, trace_number:, transfer_return:, type:)
179
+ # @!method initialize(id:, acceptance:, account_id:, account_number_id:, addenda:, amount:, automatically_resolves_at:, created_at:, decline:, direction:, effective_date:, international_addenda:, notification_of_change:, originator_company_descriptive_date:, originator_company_discretionary_data:, originator_company_entry_description:, originator_company_id:, originator_company_name:, originator_routing_number:, receiver_id_number:, receiver_name:, settlement:, standard_entry_class_code:, status:, trace_number:, transfer_return:, type:)
180
180
  # Some parameter documentations has been truncated, see
181
181
  # {Increase::Models::InboundACHTransfer} for more details.
182
182
  #
@@ -205,8 +205,6 @@ module Increase
205
205
  #
206
206
  # @param effective_date [Date] The effective date of the transfer. This is sent by the sending bank and is a fa
207
207
  #
208
- # @param expected_settlement_schedule [Symbol, Increase::Models::InboundACHTransfer::ExpectedSettlementSchedule] The settlement schedule the transfer is expected to follow.
209
- #
210
208
  # @param international_addenda [Increase::Models::InboundACHTransfer::InternationalAddenda, nil] If the Inbound ACH Transfer has a Standard Entry Class Code of IAT, this will co
211
209
  #
212
210
  # @param notification_of_change [Increase::Models::InboundACHTransfer::NotificationOfChange, nil] If you initiate a notification of change in response to the transfer, this will
@@ -227,6 +225,8 @@ module Increase
227
225
  #
228
226
  # @param receiver_name [String, nil] The name of the receiver of the transfer.
229
227
  #
228
+ # @param settlement [Increase::Models::InboundACHTransfer::Settlement] A subhash containing information about when and how the transfer settled at the
229
+ #
230
230
  # @param standard_entry_class_code [Symbol, Increase::Models::InboundACHTransfer::StandardEntryClassCode] The Standard Entry Class (SEC) code of the transfer.
231
231
  #
232
232
  # @param status [Symbol, Increase::Models::InboundACHTransfer::Status] The status of the transfer.
@@ -431,22 +431,6 @@ module Increase
431
431
  # @return [Array<Symbol>]
432
432
  end
433
433
 
434
- # The settlement schedule the transfer is expected to follow.
435
- #
436
- # @see Increase::Models::InboundACHTransfer#expected_settlement_schedule
437
- module ExpectedSettlementSchedule
438
- extend Increase::Internal::Type::Enum
439
-
440
- # The transfer is expected to settle same-day.
441
- SAME_DAY = :same_day
442
-
443
- # The transfer is expected to settle on a future date.
444
- FUTURE_DATED = :future_dated
445
-
446
- # @!method self.values
447
- # @return [Array<Symbol>]
448
- end
449
-
450
434
  # @see Increase::Models::InboundACHTransfer#international_addenda
451
435
  class InternationalAddenda < Increase::Internal::Type::BaseModel
452
436
  # @!attribute destination_country_code
@@ -926,6 +910,52 @@ module Increase
926
910
  # @param updated_routing_number [String, nil] The new account number provided in the notification of change.
927
911
  end
928
912
 
913
+ # @see Increase::Models::InboundACHTransfer#settlement
914
+ class Settlement < Increase::Internal::Type::BaseModel
915
+ # @!attribute settled_at
916
+ # When the funds for this transfer settle at the recipient bank at the Federal
917
+ # Reserve.
918
+ #
919
+ # @return [Time]
920
+ required :settled_at, Time
921
+
922
+ # @!attribute settlement_schedule
923
+ # The settlement schedule this transfer follows.
924
+ #
925
+ # @return [Symbol, Increase::Models::InboundACHTransfer::Settlement::SettlementSchedule]
926
+ required :settlement_schedule,
927
+ enum: -> {
928
+ Increase::InboundACHTransfer::Settlement::SettlementSchedule
929
+ }
930
+
931
+ # @!method initialize(settled_at:, settlement_schedule:)
932
+ # Some parameter documentations has been truncated, see
933
+ # {Increase::Models::InboundACHTransfer::Settlement} for more details.
934
+ #
935
+ # A subhash containing information about when and how the transfer settled at the
936
+ # Federal Reserve.
937
+ #
938
+ # @param settled_at [Time] When the funds for this transfer settle at the recipient bank at the Federal Res
939
+ #
940
+ # @param settlement_schedule [Symbol, Increase::Models::InboundACHTransfer::Settlement::SettlementSchedule] The settlement schedule this transfer follows.
941
+
942
+ # The settlement schedule this transfer follows.
943
+ #
944
+ # @see Increase::Models::InboundACHTransfer::Settlement#settlement_schedule
945
+ module SettlementSchedule
946
+ extend Increase::Internal::Type::Enum
947
+
948
+ # The transfer is expected to settle same-day.
949
+ SAME_DAY = :same_day
950
+
951
+ # The transfer is expected to settle on a future date.
952
+ FUTURE_DATED = :future_dated
953
+
954
+ # @!method self.values
955
+ # @return [Array<Symbol>]
956
+ end
957
+ end
958
+
929
959
  # The Standard Entry Class (SEC) code of the transfer.
930
960
  #
931
961
  # @see Increase::Models::InboundACHTransfer#standard_entry_class_code
@@ -10,6 +10,12 @@ module Increase
10
10
  # @return [String]
11
11
  required :id, String
12
12
 
13
+ # @!attribute checks
14
+ # The checks in the mail item.
15
+ #
16
+ # @return [Array<Increase::Models::InboundMailItem::Check>]
17
+ required :checks, -> { Increase::Internal::Type::ArrayOf[Increase::InboundMailItem::Check] }
18
+
13
19
  # @!attribute created_at
14
20
  # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Inbound
15
21
  # Mail Item was created.
@@ -55,7 +61,7 @@ module Increase
55
61
  # @return [Symbol, Increase::Models::InboundMailItem::Type]
56
62
  required :type, enum: -> { Increase::InboundMailItem::Type }
57
63
 
58
- # @!method initialize(id:, created_at:, file_id:, lockbox_id:, recipient_name:, rejection_reason:, status:, type:)
64
+ # @!method initialize(id:, checks:, created_at:, file_id:, lockbox_id:, recipient_name:, rejection_reason:, status:, type:)
59
65
  # Some parameter documentations has been truncated, see
60
66
  # {Increase::Models::InboundMailItem} for more details.
61
67
  #
@@ -63,6 +69,8 @@ module Increase
63
69
  #
64
70
  # @param id [String] The Inbound Mail Item identifier.
65
71
  #
72
+ # @param checks [Array<Increase::Models::InboundMailItem::Check>] The checks in the mail item.
73
+ #
66
74
  # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Inbound
67
75
  #
68
76
  # @param file_id [String] The identifier for the File containing the scanned contents of the mail item.
@@ -77,6 +85,35 @@ module Increase
77
85
  #
78
86
  # @param type [Symbol, Increase::Models::InboundMailItem::Type] A constant representing the object's type. For this resource it will always be `
79
87
 
88
+ class Check < Increase::Internal::Type::BaseModel
89
+ # @!attribute amount
90
+ # The amount of the check.
91
+ #
92
+ # @return [Integer]
93
+ required :amount, Integer
94
+
95
+ # @!attribute back_file_id
96
+ # The identifier for the File containing the back of the check.
97
+ #
98
+ # @return [String, nil]
99
+ required :back_file_id, String, nil?: true
100
+
101
+ # @!attribute front_file_id
102
+ # The identifier for the File containing the front of the check.
103
+ #
104
+ # @return [String, nil]
105
+ required :front_file_id, String, nil?: true
106
+
107
+ # @!method initialize(amount:, back_file_id:, front_file_id:)
108
+ # Inbound Mail Item Checks represent the checks in an Inbound Mail Item.
109
+ #
110
+ # @param amount [Integer] The amount of the check.
111
+ #
112
+ # @param back_file_id [String, nil] The identifier for the File containing the back of the check.
113
+ #
114
+ # @param front_file_id [String, nil] The identifier for the File containing the front of the check.
115
+ end
116
+
80
117
  # If the mail item has been rejected, why it was rejected.
81
118
  #
82
119
  # @see Increase::Models::InboundMailItem#rejection_reason