increase 1.337.0 → 1.339.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 (103) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +3 -2
  3. data/lib/increase/models/account_create_params.rb +4 -3
  4. data/lib/increase/models/ach_transfer.rb +19 -18
  5. data/lib/increase/models/ach_transfer_create_params.rb +48 -36
  6. data/lib/increase/models/ach_transfer_list_params.rb +1 -1
  7. data/lib/increase/models/beneficial_owner_create_params.rb +2 -1
  8. data/lib/increase/models/beneficial_owner_update_params.rb +2 -1
  9. data/lib/increase/models/card_push_transfer.rb +3 -3
  10. data/lib/increase/models/card_push_transfer_list_params.rb +3 -3
  11. data/lib/increase/models/check_transfer.rb +5 -2
  12. data/lib/increase/models/entity_create_params.rb +16 -8
  13. data/lib/increase/models/entity_update_params.rb +2 -1
  14. data/lib/increase/models/fednow_transfer.rb +3 -3
  15. data/lib/increase/models/fednow_transfer_list_params.rb +3 -3
  16. data/lib/increase/models/inbound_fednow_transfer.rb +11 -1
  17. data/lib/increase/models/inbound_mail_item.rb +3 -1
  18. data/lib/increase/models/inbound_real_time_payments_transfer.rb +1 -1
  19. data/lib/increase/models/lockbox_address.rb +5 -1
  20. data/lib/increase/models/lockbox_recipient_create_params.rb +3 -2
  21. data/lib/increase/models/pending_transaction.rb +5 -2
  22. data/lib/increase/models/pending_transaction_list_params.rb +1 -1
  23. data/lib/increase/models/physical_card.rb +5 -2
  24. data/lib/increase/models/real_time_payments_transfer.rb +3 -3
  25. data/lib/increase/models/real_time_payments_transfer_list_params.rb +3 -3
  26. data/lib/increase/models/simulations/inbound_ach_transfer_create_params.rb +3 -2
  27. data/lib/increase/models/simulations/inbound_mail_item_create_params.rb +6 -4
  28. data/lib/increase/models/simulations/physical_card_create_params.rb +5 -2
  29. data/lib/increase/models/swift_transfer.rb +3 -3
  30. data/lib/increase/models/swift_transfer_list_params.rb +3 -3
  31. data/lib/increase/models/transaction.rb +7 -4
  32. data/lib/increase/models/wire_transfer.rb +3 -3
  33. data/lib/increase/models/wire_transfer_list_params.rb +3 -3
  34. data/lib/increase/resources/accounts.rb +1 -1
  35. data/lib/increase/resources/ach_transfers.rb +10 -10
  36. data/lib/increase/resources/inbound_mail_items.rb +3 -1
  37. data/lib/increase/resources/lockbox_addresses.rb +4 -1
  38. data/lib/increase/resources/lockbox_recipients.rb +1 -1
  39. data/lib/increase/resources/simulations/card_authorizations.rb +4 -1
  40. data/lib/increase/resources/simulations/inbound_ach_transfers.rb +1 -1
  41. data/lib/increase/resources/simulations/inbound_mail_items.rb +6 -3
  42. data/lib/increase/version.rb +1 -1
  43. data/rbi/increase/models/account_create_params.rbi +6 -4
  44. data/rbi/increase/models/ach_transfer.rbi +22 -19
  45. data/rbi/increase/models/ach_transfer_create_params.rbi +67 -45
  46. data/rbi/increase/models/ach_transfer_list_params.rbi +1 -1
  47. data/rbi/increase/models/beneficial_owner_create_params.rbi +4 -2
  48. data/rbi/increase/models/beneficial_owner_update_params.rbi +4 -2
  49. data/rbi/increase/models/card_push_transfer.rbi +7 -7
  50. data/rbi/increase/models/card_push_transfer_list_params.rbi +7 -7
  51. data/rbi/increase/models/check_transfer.rbi +9 -2
  52. data/rbi/increase/models/entity_create_params.rbi +30 -15
  53. data/rbi/increase/models/entity_update_params.rbi +4 -2
  54. data/rbi/increase/models/fednow_transfer.rbi +7 -7
  55. data/rbi/increase/models/fednow_transfer_list_params.rbi +7 -7
  56. data/rbi/increase/models/inbound_fednow_transfer.rbi +12 -0
  57. data/rbi/increase/models/inbound_mail_item.rbi +3 -1
  58. data/rbi/increase/models/inbound_real_time_payments_transfer.rbi +1 -1
  59. data/rbi/increase/models/lockbox_address.rbi +5 -1
  60. data/rbi/increase/models/lockbox_recipient_create_params.rbi +4 -2
  61. data/rbi/increase/models/pending_transaction.rbi +9 -3
  62. data/rbi/increase/models/pending_transaction_list_params.rbi +1 -1
  63. data/rbi/increase/models/physical_card.rbi +9 -2
  64. data/rbi/increase/models/real_time_payments_transfer.rbi +7 -7
  65. data/rbi/increase/models/real_time_payments_transfer_list_params.rbi +7 -7
  66. data/rbi/increase/models/simulations/inbound_ach_transfer_create_params.rbi +4 -2
  67. data/rbi/increase/models/simulations/inbound_mail_item_create_params.rbi +8 -4
  68. data/rbi/increase/models/simulations/physical_card_create_params.rbi +9 -2
  69. data/rbi/increase/models/swift_transfer.rbi +7 -7
  70. data/rbi/increase/models/swift_transfer_list_params.rbi +7 -7
  71. data/rbi/increase/models/transaction.rbi +10 -5
  72. data/rbi/increase/models/wire_transfer.rbi +4 -4
  73. data/rbi/increase/models/wire_transfer_list_params.rbi +7 -7
  74. data/rbi/increase/resources/accounts.rbi +3 -2
  75. data/rbi/increase/resources/ach_transfers.rbi +29 -19
  76. data/rbi/increase/resources/inbound_mail_items.rbi +3 -1
  77. data/rbi/increase/resources/lockbox_addresses.rbi +4 -1
  78. data/rbi/increase/resources/lockbox_recipients.rbi +2 -1
  79. data/rbi/increase/resources/simulations/card_authorizations.rbi +4 -1
  80. data/rbi/increase/resources/simulations/inbound_ach_transfers.rbi +2 -1
  81. data/rbi/increase/resources/simulations/inbound_mail_items.rbi +8 -3
  82. data/sig/increase/models/ach_transfer.rbs +2 -2
  83. data/sig/increase/models/ach_transfer_create_params.rbs +1 -1
  84. data/sig/increase/models/ach_transfer_list_params.rbs +1 -1
  85. data/sig/increase/models/card_push_transfer.rbs +4 -4
  86. data/sig/increase/models/card_push_transfer_list_params.rbs +4 -4
  87. data/sig/increase/models/check_transfer.rbs +6 -2
  88. data/sig/increase/models/fednow_transfer.rbs +5 -5
  89. data/sig/increase/models/fednow_transfer_list_params.rbs +5 -5
  90. data/sig/increase/models/inbound_fednow_transfer.rbs +5 -0
  91. data/sig/increase/models/inbound_real_time_payments_transfer.rbs +1 -1
  92. data/sig/increase/models/pending_transaction.rbs +1 -1
  93. data/sig/increase/models/pending_transaction_list_params.rbs +1 -1
  94. data/sig/increase/models/physical_card.rbs +6 -2
  95. data/sig/increase/models/real_time_payments_transfer.rbs +4 -4
  96. data/sig/increase/models/real_time_payments_transfer_list_params.rbs +4 -4
  97. data/sig/increase/models/simulations/physical_card_create_params.rbs +6 -2
  98. data/sig/increase/models/swift_transfer.rbs +4 -4
  99. data/sig/increase/models/swift_transfer_list_params.rbs +4 -4
  100. data/sig/increase/models/wire_transfer.rbs +4 -4
  101. data/sig/increase/models/wire_transfer_list_params.rbs +4 -4
  102. metadata +2 -3
  103. data/CHANGELOG.md +0 -4534
@@ -267,6 +267,13 @@ module Increase
267
267
  Increase::WireTransferListParams::Status::In::TaggedSymbol
268
268
  )
269
269
 
270
+ # The transfer is pending creation.
271
+ PENDING_CREATING =
272
+ T.let(
273
+ :pending_creating,
274
+ Increase::WireTransferListParams::Status::In::TaggedSymbol
275
+ )
276
+
270
277
  # The transfer is pending review by Increase.
271
278
  PENDING_REVIEWING =
272
279
  T.let(
@@ -288,13 +295,6 @@ module Increase
288
295
  Increase::WireTransferListParams::Status::In::TaggedSymbol
289
296
  )
290
297
 
291
- # The transfer is pending creation.
292
- PENDING_CREATING =
293
- T.let(
294
- :pending_creating,
295
- Increase::WireTransferListParams::Status::In::TaggedSymbol
296
- )
297
-
298
298
  # The transfer has been reversed.
299
299
  REVERSED =
300
300
  T.let(
@@ -27,8 +27,9 @@ module Increase
27
27
  informational_entity_id: nil,
28
28
  # The loan details for the account.
29
29
  loan: nil,
30
- # The identifier for the Program that this Account falls under. Required if you
31
- # operate more than one Program.
30
+ # The identifier for the Program that this Account falls under. Required if your
31
+ # Group operates more than one Program. List your [Programs](#programs) to find
32
+ # their identifiers.
32
33
  program_id: nil,
33
34
  request_options: {}
34
35
  )
@@ -46,33 +46,42 @@ module Increase
46
46
  # help the customer recognize the transfer. You are highly encouraged to pass
47
47
  # `individual_name` and `company_name` instead of relying on this fallback.
48
48
  statement_descriptor:,
49
- # The account number for the destination account.
49
+ # The receiver's account number. For credit transfers (positive `amount`) this is
50
+ # the account that funds will be sent to. For debit transfers (negative `amount`)
51
+ # this is the account that funds will be pulled from.
50
52
  account_number: nil,
51
- # Additional information that will be sent to the recipient. This is included in
52
- # the transfer data sent to the receiving bank.
53
+ # Additional information passed through to the receiving bank with the transfer.
54
+ # Most ACH transfers do not need this. Only set this if your recipient has asked
55
+ # for addendum data, typically unstructured remittance information. Corporate
56
+ # Trade Exchange (CTX) flows can carry structured X12 remittance advice instead.
53
57
  addenda: nil,
54
- # The description of the date of the transfer, usually in the format `YYMMDD`.
55
- # This is included in the transfer data sent to the receiving bank.
58
+ # A description of the transfer date (typically `YYMMDD`), sent in the company
59
+ # batch header. This value is informational and does not affect funds movement,
60
+ # settlement timing, or returns. Only set this if your recipient has asked for it.
56
61
  company_descriptive_date: nil,
57
- # The data you choose to associate with the transfer. This is included in the
58
- # transfer data sent to the receiving bank.
62
+ # Custom data sent in the company batch header. This value is informational and
63
+ # does not affect funds movement, settlement timing, or returns. Most ACH
64
+ # transfers do not need this. Only set this if your recipient has asked for it.
59
65
  company_discretionary_data: nil,
60
- # A description of the transfer, included in the transfer data sent to the
61
- # receiving bank. Standardized formatting may be required, for example `PAYROLL`
62
- # for payroll-related Prearranged Payments and Deposits (PPD) credit transfers.
66
+ # A short description sent in the company batch header. Most receivers do not
67
+ # surface this. Only set this if your recipient has asked for a specific value or
68
+ # if Nacha mandates one for your Standard Entry Class (SEC) code and use case. For
69
+ # example, Prearranged Payment and Deposit (PPD) payroll credits must use
70
+ # `PAYROLL`, and reversals must use `REVERSAL`.
63
71
  company_entry_description: nil,
64
- # The name by which the recipient knows you. This is included in the transfer data
65
- # sent to the receiving bank.
72
+ # The name by which the recipient knows you, sent in the company batch header. We
73
+ # recommend setting this on every transfer; if you do not, we fall back to the ACH
74
+ # company name configured on your account.
66
75
  company_name: nil,
67
- # The type of entity that owns the account to which the ACH Transfer is being
68
- # sent.
76
+ # The type of entity that owns the receiver's account.
69
77
  destination_account_holder: nil,
70
78
  # The ID of an External Account to initiate a transfer to. If this parameter is
71
79
  # provided, `account_number`, `routing_number`, and `funding` must be absent.
72
80
  external_account_id: nil,
73
- # The type of the account to which the transfer will be sent.
81
+ # The type of the receiver's bank account.
74
82
  funding: nil,
75
- # Your identifier for the transfer recipient.
83
+ # Your internal identifier for the transfer recipient. This value is informational
84
+ # and not verified by the recipient's bank. Most callers can leave this unset.
76
85
  individual_id: nil,
77
86
  # The name of the transfer recipient. This value is informational and not verified
78
87
  # by the recipient's bank.
@@ -84,12 +93,13 @@ module Increase
84
93
  preferred_effective_date: nil,
85
94
  # Whether the transfer requires explicit approval via the dashboard or API.
86
95
  require_approval: nil,
87
- # The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
88
- # destination account.
96
+ # The American Bankers' Association (ABA) Routing Transit Number (RTN) of the
97
+ # receiver's bank.
89
98
  routing_number: nil,
90
99
  # The
91
100
  # [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes)
92
- # to use for the transfer.
101
+ # to use for the transfer. If not provided, the default is
102
+ # `corporate_credit_or_debit`.
93
103
  standard_entry_class_code: nil,
94
104
  # The timing of the transaction.
95
105
  transaction_timing: nil,
@@ -43,7 +43,9 @@ module Increase
43
43
  )
44
44
  end
45
45
 
46
- # Action an Inbound Mail Item
46
+ # Deposits or ignores each check contained in a pending Inbound Mail Item.
47
+ # Depositing a check creates a [Check Deposit](#check-deposits) into the Account
48
+ # you specify.
47
49
  sig do
48
50
  params(
49
51
  inbound_mail_item_id: String,
@@ -3,7 +3,10 @@
3
3
  module Increase
4
4
  module Resources
5
5
  class LockboxAddresses
6
- # Create a Lockbox Address
6
+ # The Lockbox Address starts with a `pending` status and a null `address`. Shortly
7
+ # after creation, Increase generates the mailing address and the status becomes
8
+ # `active`. You can only create Lockbox Recipients for an `active` Lockbox
9
+ # Address.
7
10
  sig do
8
11
  params(
9
12
  description: String,
@@ -16,7 +16,8 @@ module Increase
16
16
  def create(
17
17
  # The Account that checks sent to this Lockbox Recipient should be deposited into.
18
18
  account_id:,
19
- # The Lockbox Address where this Lockbox Recipient may receive mail.
19
+ # The Lockbox Address where this Lockbox Recipient may receive mail. The Lockbox
20
+ # Address must have a `status` of `active`.
20
21
  lockbox_address_id:,
21
22
  # The description you choose for the Lockbox Recipient.
22
23
  description: nil,
@@ -10,7 +10,10 @@ module Increase
10
10
  # `card_authorization` or a [Declined Transaction](#declined-transactions) of type
11
11
  # `card_decline`. You can pass either a Card id or a
12
12
  # [Digital Wallet Token](#digital-wallet-tokens) id to simulate the two different
13
- # ways purchases can be made.
13
+ # ways purchases can be made. The response will contain either a
14
+ # `pending_transaction` or a `declined_transaction`; the other attribute will be
15
+ # null. If the authorization is declined, the reason is available on the Declined
16
+ # Transaction at `source.card_decline.reason`.
14
17
  sig do
15
18
  params(
16
19
  amount: Integer,
@@ -50,7 +50,8 @@ module Increase
50
50
  company_entry_description: nil,
51
51
  # The sender's company ID.
52
52
  company_id: nil,
53
- # The name of the sender.
53
+ # The name of the sender. This corresponds to the `originator_company_name` field
54
+ # on the resulting Inbound ACH Transfer.
54
55
  company_name: nil,
55
56
  # The ID of the receiver of the transfer.
56
57
  receiver_id_number: nil,
@@ -5,7 +5,10 @@ module Increase
5
5
  class Simulations
6
6
  class InboundMailItems
7
7
  # Simulates an Inbound Mail Item to one of your Lockbox Addresses or Lockbox
8
- # Recipients, as if someone had mailed a physical check.
8
+ # Recipients, as if someone had mailed a physical check. Increase automatically
9
+ # deposits a check mailed to a Lockbox Recipient into the recipient's Account. A
10
+ # check mailed to a Lockbox Address must be deposited or ignored with the
11
+ # [Action an Inbound Mail Item](#inbound-mail-items) endpoint.
9
12
  sig do
10
13
  params(
11
14
  amount: Integer,
@@ -21,9 +24,11 @@ module Increase
21
24
  # The file containing the PDF contents. If not present, a default check image file
22
25
  # will be used.
23
26
  contents_file_id: nil,
24
- # The identifier of the Lockbox Address to simulate inbound mail to.
27
+ # The identifier of the Lockbox Address to simulate inbound mail to. Exactly one
28
+ # lockbox identifier parameter must be provided.
25
29
  lockbox_address_id: nil,
26
- # The identifier of the Lockbox Recipient to simulate inbound mail to.
30
+ # The identifier of the Lockbox Recipient to simulate inbound mail to. Exactly one
31
+ # lockbox identifier parameter must be provided.
27
32
  lockbox_recipient_id: nil,
28
33
  request_options: {}
29
34
  )
@@ -731,7 +731,7 @@ module Increase
731
731
  # The chosen effective date will be the same as the ACH processing date on which the transfer is submitted.
732
732
  # This is necessary, but not sufficient for the transfer to be settled same-day:
733
733
  # it must also be submitted before the last same-day cutoff
734
- # and be less than or equal to $1,000.000.00.
734
+ # and be less than or equal to $1,000,000.00.
735
735
  SAME_DAY: :same_day
736
736
 
737
737
  # The chosen effective date will be the business day following the ACH processing date on which the transfer is submitted. The transfer will be settled on that future day.
@@ -1140,7 +1140,7 @@ module Increase
1140
1140
  # The transfer has been rejected.
1141
1141
  REJECTED: :rejected
1142
1142
 
1143
- # The transfer is complete.
1143
+ # The transfer has been submitted to the Federal Reserve. When the transfer settles, the status remains `submitted` and the `settlement` sub-object is populated.
1144
1144
  SUBMITTED: :submitted
1145
1145
 
1146
1146
  # The transfer has been returned.
@@ -333,7 +333,7 @@ module Increase
333
333
  module SettlementSchedule
334
334
  extend Increase::Internal::Type::Enum
335
335
 
336
- # The chosen effective date will be the same as the ACH processing date on which the transfer is submitted. This is necessary, but not sufficient for the transfer to be settled same-day: it must also be submitted before the last same-day cutoff and be less than or equal to $1,000.000.00.
336
+ # The chosen effective date will be the same as the ACH processing date on which the transfer is submitted. This is necessary, but not sufficient for the transfer to be settled same-day: it must also be submitted before the last same-day cutoff and be less than or equal to $1,000,000.00.
337
337
  SAME_DAY: :same_day
338
338
 
339
339
  # The chosen effective date will be the business day following the ACH processing date on which the transfer is submitted. The transfer will be settled on that future day.
@@ -158,7 +158,7 @@ module Increase
158
158
  # The transfer has been rejected.
159
159
  REJECTED: :rejected
160
160
 
161
- # The transfer is complete.
161
+ # The transfer has been submitted to the Federal Reserve. When the transfer settles, the status remains `submitted` and the `settlement` sub-object is populated.
162
162
  SUBMITTED: :submitted
163
163
 
164
164
  # The transfer has been returned.
@@ -1377,9 +1377,9 @@ module Increase
1377
1377
  type status =
1378
1378
  :pending_approval
1379
1379
  | :canceled
1380
+ | :pending_submission
1380
1381
  | :pending_reviewing
1381
1382
  | :requires_attention
1382
- | :pending_submission
1383
1383
  | :submitted
1384
1384
  | :complete
1385
1385
  | :declined
@@ -1393,15 +1393,15 @@ module Increase
1393
1393
  # The transfer has been canceled.
1394
1394
  CANCELED: :canceled
1395
1395
 
1396
+ # The transfer is queued to be submitted to the card network.
1397
+ PENDING_SUBMISSION: :pending_submission
1398
+
1396
1399
  # The transfer is pending review by Increase.
1397
1400
  PENDING_REVIEWING: :pending_reviewing
1398
1401
 
1399
1402
  # The transfer requires attention from an Increase operator.
1400
1403
  REQUIRES_ATTENTION: :requires_attention
1401
1404
 
1402
- # The transfer is queued to be submitted to the card network.
1403
- PENDING_SUBMISSION: :pending_submission
1404
-
1405
1405
  # The transfer has been submitted and is pending a response from the card network.
1406
1406
  SUBMITTED: :submitted
1407
1407
 
@@ -121,9 +121,9 @@ module Increase
121
121
  type in_ =
122
122
  :pending_approval
123
123
  | :canceled
124
+ | :pending_submission
124
125
  | :pending_reviewing
125
126
  | :requires_attention
126
- | :pending_submission
127
127
  | :submitted
128
128
  | :complete
129
129
  | :declined
@@ -137,15 +137,15 @@ module Increase
137
137
  # The transfer has been canceled.
138
138
  CANCELED: :canceled
139
139
 
140
+ # The transfer is queued to be submitted to the card network.
141
+ PENDING_SUBMISSION: :pending_submission
142
+
140
143
  # The transfer is pending review by Increase.
141
144
  PENDING_REVIEWING: :pending_reviewing
142
145
 
143
146
  # The transfer requires attention from an Increase operator.
144
147
  REQUIRES_ATTENTION: :requires_attention
145
148
 
146
- # The transfer is queued to be submitted to the card network.
147
- PENDING_SUBMISSION: :pending_submission
148
-
149
149
  # The transfer has been submitted and is pending a response from the card network.
150
150
  SUBMITTED: :submitted
151
151
 
@@ -520,6 +520,7 @@ module Increase
520
520
  | :processed_for_delivery
521
521
  | :delivered
522
522
  | :delivery_issue
523
+ | :returning_to_sender
523
524
  | :returned_to_sender
524
525
 
525
526
  module Category
@@ -534,10 +535,13 @@ module Increase
534
535
  # The check has been delivered. Note that some couriers track delivery status based on driver location data rather than an explicit scan. While uncommon, a single check may have more than one delivered event.
535
536
  DELIVERED: :delivered
536
537
 
537
- # There is an issue preventing delivery. The delivery will be attempted again if possible. If the issue cannot be resolved, the check will be returned to sender.
538
+ # There is an issue preventing delivery. The delivery will be attempted again if possible. If the issue cannot be resolved, the check will be rerouted to the return address.
538
539
  DELIVERY_ISSUE: :delivery_issue
539
540
 
540
- # Delivery failed and the check was returned to sender.
541
+ # The check has been rerouted to the return address.
542
+ RETURNING_TO_SENDER: :returning_to_sender
543
+
544
+ # The check has been delivered to the return address.
541
545
  RETURNED_TO_SENDER: :returned_to_sender
542
546
 
543
547
  def self?.values: -> ::Array[Increase::Models::CheckTransfer::PhysicalCheck::TrackingUpdate::category]
@@ -391,12 +391,12 @@ module Increase
391
391
  end
392
392
 
393
393
  type status =
394
- :pending_reviewing
394
+ :pending_submitting
395
+ | :pending_reviewing
395
396
  | :canceled
396
397
  | :reviewing_rejected
397
398
  | :requires_attention
398
399
  | :pending_approval
399
- | :pending_submitting
400
400
  | :pending_response
401
401
  | :complete
402
402
  | :rejected
@@ -404,6 +404,9 @@ module Increase
404
404
  module Status
405
405
  extend Increase::Internal::Type::Enum
406
406
 
407
+ # The transfer is queued to be submitted to FedNow.
408
+ PENDING_SUBMITTING: :pending_submitting
409
+
407
410
  # The transfer is pending review by Increase.
408
411
  PENDING_REVIEWING: :pending_reviewing
409
412
 
@@ -419,9 +422,6 @@ module Increase
419
422
  # The transfer is pending approval.
420
423
  PENDING_APPROVAL: :pending_approval
421
424
 
422
- # The transfer is queued to be submitted to FedNow.
423
- PENDING_SUBMITTING: :pending_submitting
424
-
425
425
  # The transfer has been submitted and is pending a response from FedNow.
426
426
  PENDING_RESPONSE: :pending_response
427
427
 
@@ -126,12 +126,12 @@ module Increase
126
126
  }
127
127
 
128
128
  type in_ =
129
- :pending_reviewing
129
+ :pending_submitting
130
+ | :pending_reviewing
130
131
  | :canceled
131
132
  | :reviewing_rejected
132
133
  | :requires_attention
133
134
  | :pending_approval
134
- | :pending_submitting
135
135
  | :pending_response
136
136
  | :complete
137
137
  | :rejected
@@ -139,6 +139,9 @@ module Increase
139
139
  module In
140
140
  extend Increase::Internal::Type::Enum
141
141
 
142
+ # The transfer is queued to be submitted to FedNow.
143
+ PENDING_SUBMITTING: :pending_submitting
144
+
142
145
  # The transfer is pending review by Increase.
143
146
  PENDING_REVIEWING: :pending_reviewing
144
147
 
@@ -154,9 +157,6 @@ module Increase
154
157
  # The transfer is pending approval.
155
158
  PENDING_APPROVAL: :pending_approval
156
159
 
157
- # The transfer is queued to be submitted to FedNow.
158
- PENDING_SUBMITTING: :pending_submitting
159
-
160
160
  # The transfer has been submitted and is pending a response from FedNow.
161
161
  PENDING_RESPONSE: :pending_response
162
162
 
@@ -17,6 +17,7 @@ module Increase
17
17
  status: Increase::Models::InboundFednowTransfer::status,
18
18
  transaction_id: String?,
19
19
  type: Increase::Models::InboundFednowTransfer::type_,
20
+ unique_end_to_end_transaction_reference: String?,
20
21
  unstructured_remittance_information: String?
21
22
  }
22
23
 
@@ -51,6 +52,8 @@ module Increase
51
52
 
52
53
  attr_accessor type: Increase::Models::InboundFednowTransfer::type_
53
54
 
55
+ attr_accessor unique_end_to_end_transaction_reference: String?
56
+
54
57
  attr_accessor unstructured_remittance_information: String?
55
58
 
56
59
  def initialize: (
@@ -69,6 +72,7 @@ module Increase
69
72
  status: Increase::Models::InboundFednowTransfer::status,
70
73
  transaction_id: String?,
71
74
  type: Increase::Models::InboundFednowTransfer::type_,
75
+ unique_end_to_end_transaction_reference: String?,
72
76
  unstructured_remittance_information: String?
73
77
  ) -> void
74
78
 
@@ -88,6 +92,7 @@ module Increase
88
92
  status: Increase::Models::InboundFednowTransfer::status,
89
93
  transaction_id: String?,
90
94
  type: Increase::Models::InboundFednowTransfer::type_,
95
+ unique_end_to_end_transaction_reference: String?,
91
96
  unstructured_remittance_information: String?
92
97
  }
93
98
 
@@ -181,7 +181,7 @@ module Increase
181
181
  # The transfer is pending confirmation.
182
182
  PENDING_CONFIRMING: :pending_confirming
183
183
 
184
- # The transfer was not responded to in time.
184
+ # The transfer was not responded to in time. This is rare and represents an error at Increase.
185
185
  TIMED_OUT: :timed_out
186
186
 
187
187
  # The transfer has been received successfully and is confirmed.
@@ -1829,7 +1829,7 @@ module Increase
1829
1829
  # The Pending Transaction is still awaiting confirmation.
1830
1830
  PENDING: :pending
1831
1831
 
1832
- # The Pending Transaction is confirmed. An associated Transaction exists for this object. The Pending Transaction will no longer count against your balance and can generally be hidden from UIs, etc.
1832
+ # The Pending Transaction is confirmed. An associated Transaction exists for this object. The Pending Transaction will no longer count against your balance and can generally be hidden from UIs, etc. The Pending Transaction's `amount` is not updated if the associated Transaction settles for a different amount.
1833
1833
  COMPLETE: :complete
1834
1834
 
1835
1835
  def self?.values: -> ::Array[Increase::Models::PendingTransaction::status]
@@ -228,7 +228,7 @@ module Increase
228
228
  # The Pending Transaction is still awaiting confirmation.
229
229
  PENDING: :pending
230
230
 
231
- # The Pending Transaction is confirmed. An associated Transaction exists for this object. The Pending Transaction will no longer count against your balance and can generally be hidden from UIs, etc.
231
+ # The Pending Transaction is confirmed. An associated Transaction exists for this object. The Pending Transaction will no longer count against your balance and can generally be hidden from UIs, etc. The Pending Transaction's `amount` is not updated if the associated Transaction settles for a different amount.
232
232
  COMPLETE: :complete
233
233
 
234
234
  def self?.values: -> ::Array[Increase::Models::PendingTransactionListParams::Status::in_]
@@ -316,6 +316,7 @@ module Increase
316
316
  | :processed_for_delivery
317
317
  | :delivered
318
318
  | :delivery_issue
319
+ | :returning_to_sender
319
320
  | :returned_to_sender
320
321
 
321
322
  module Category
@@ -330,10 +331,13 @@ module Increase
330
331
  # The physical card has been delivered. Note that some couriers track delivery status based on driver location data rather than an explicit scan. While uncommon, a single physical card may have more than one delivered event.
331
332
  DELIVERED: :delivered
332
333
 
333
- # There is an issue preventing delivery. The delivery will be attempted again if possible. If the issue cannot be resolved, the physical card will be returned to sender.
334
+ # There is an issue preventing delivery. The delivery will be attempted again if possible. If the issue cannot be resolved, the physical card will be rerouted to the return address.
334
335
  DELIVERY_ISSUE: :delivery_issue
335
336
 
336
- # Delivery failed and the physical card was returned to sender.
337
+ # The physical card has been rerouted to the return address.
338
+ RETURNING_TO_SENDER: :returning_to_sender
339
+
340
+ # The physical card has been delivered to the return address.
337
341
  RETURNED_TO_SENDER: :returned_to_sender
338
342
 
339
343
  def self?.values: -> ::Array[Increase::Models::PhysicalCard::Shipment::Tracking::Update::category]
@@ -382,10 +382,10 @@ module Increase
382
382
  type status =
383
383
  :pending_approval
384
384
  | :canceled
385
+ | :pending_submission
385
386
  | :pending_reviewing
386
387
  | :requires_attention
387
388
  | :rejected
388
- | :pending_submission
389
389
  | :submitted
390
390
  | :complete
391
391
 
@@ -398,6 +398,9 @@ module Increase
398
398
  # The transfer has been canceled.
399
399
  CANCELED: :canceled
400
400
 
401
+ # The transfer is queued to be submitted to Real-Time Payments.
402
+ PENDING_SUBMISSION: :pending_submission
403
+
401
404
  # The transfer is pending review by Increase.
402
405
  PENDING_REVIEWING: :pending_reviewing
403
406
 
@@ -407,9 +410,6 @@ module Increase
407
410
  # The transfer was rejected by the network or the recipient's bank.
408
411
  REJECTED: :rejected
409
412
 
410
- # The transfer is queued to be submitted to Real-Time Payments.
411
- PENDING_SUBMISSION: :pending_submission
412
-
413
413
  # The transfer has been submitted and is pending a response from Real-Time Payments.
414
414
  SUBMITTED: :submitted
415
415
 
@@ -128,10 +128,10 @@ module Increase
128
128
  type in_ =
129
129
  :pending_approval
130
130
  | :canceled
131
+ | :pending_submission
131
132
  | :pending_reviewing
132
133
  | :requires_attention
133
134
  | :rejected
134
- | :pending_submission
135
135
  | :submitted
136
136
  | :complete
137
137
 
@@ -144,6 +144,9 @@ module Increase
144
144
  # The transfer has been canceled.
145
145
  CANCELED: :canceled
146
146
 
147
+ # The transfer is queued to be submitted to Real-Time Payments.
148
+ PENDING_SUBMISSION: :pending_submission
149
+
147
150
  # The transfer is pending review by Increase.
148
151
  PENDING_REVIEWING: :pending_reviewing
149
152
 
@@ -153,9 +156,6 @@ module Increase
153
156
  # The transfer was rejected by the network or the recipient's bank.
154
157
  REJECTED: :rejected
155
158
 
156
- # The transfer is queued to be submitted to Real-Time Payments.
157
- PENDING_SUBMISSION: :pending_submission
158
-
159
159
  # The transfer has been submitted and is pending a response from Real-Time Payments.
160
160
  SUBMITTED: :submitted
161
161
 
@@ -61,6 +61,7 @@ module Increase
61
61
  | :processed_for_delivery
62
62
  | :delivered
63
63
  | :delivery_issue
64
+ | :returning_to_sender
64
65
  | :returned_to_sender
65
66
 
66
67
  module Category
@@ -75,10 +76,13 @@ module Increase
75
76
  # The physical card has been delivered. Note that some couriers track delivery status based on driver location data rather than an explicit scan. While uncommon, a single physical card may have more than one delivered event.
76
77
  DELIVERED: :delivered
77
78
 
78
- # There is an issue preventing delivery. The delivery will be attempted again if possible. If the issue cannot be resolved, the physical card will be returned to sender.
79
+ # There is an issue preventing delivery. The delivery will be attempted again if possible. If the issue cannot be resolved, the physical card will be rerouted to the return address.
79
80
  DELIVERY_ISSUE: :delivery_issue
80
81
 
81
- # Delivery failed and the physical card was returned to sender.
82
+ # The physical card has been rerouted to the return address.
83
+ RETURNING_TO_SENDER: :returning_to_sender
84
+
85
+ # The physical card has been delivered to the return address.
82
86
  RETURNED_TO_SENDER: :returned_to_sender
83
87
 
84
88
  def self?.values: -> ::Array[Increase::Models::Simulations::PhysicalCardCreateParams::category]
@@ -298,9 +298,9 @@ module Increase
298
298
  type status =
299
299
  :pending_approval
300
300
  | :canceled
301
+ | :pending_initiating
301
302
  | :pending_reviewing
302
303
  | :requires_attention
303
- | :pending_initiating
304
304
  | :initiated
305
305
  | :rejected
306
306
  | :returned
@@ -314,15 +314,15 @@ module Increase
314
314
  # The transfer has been canceled.
315
315
  CANCELED: :canceled
316
316
 
317
+ # The transfer is pending initiation.
318
+ PENDING_INITIATING: :pending_initiating
319
+
317
320
  # The transfer is pending review by Increase.
318
321
  PENDING_REVIEWING: :pending_reviewing
319
322
 
320
323
  # The transfer requires attention from an Increase operator.
321
324
  REQUIRES_ATTENTION: :requires_attention
322
325
 
323
- # The transfer is pending initiation.
324
- PENDING_INITIATING: :pending_initiating
325
-
326
326
  # The transfer has been initiated.
327
327
  INITIATED: :initiated
328
328
 
@@ -119,9 +119,9 @@ module Increase
119
119
  type in_ =
120
120
  :pending_approval
121
121
  | :canceled
122
+ | :pending_initiating
122
123
  | :pending_reviewing
123
124
  | :requires_attention
124
- | :pending_initiating
125
125
  | :initiated
126
126
  | :rejected
127
127
  | :returned
@@ -135,15 +135,15 @@ module Increase
135
135
  # The transfer has been canceled.
136
136
  CANCELED: :canceled
137
137
 
138
+ # The transfer is pending initiation.
139
+ PENDING_INITIATING: :pending_initiating
140
+
138
141
  # The transfer is pending review by Increase.
139
142
  PENDING_REVIEWING: :pending_reviewing
140
143
 
141
144
  # The transfer requires attention from an Increase operator.
142
145
  REQUIRES_ATTENTION: :requires_attention
143
146
 
144
- # The transfer is pending initiation.
145
- PENDING_INITIATING: :pending_initiating
146
-
147
147
  # The transfer has been initiated.
148
148
  INITIATED: :initiated
149
149