increase 1.338.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 (100) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  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_mail_item.rb +3 -1
  17. data/lib/increase/models/inbound_real_time_payments_transfer.rb +1 -1
  18. data/lib/increase/models/lockbox_address.rb +5 -1
  19. data/lib/increase/models/lockbox_recipient_create_params.rb +3 -2
  20. data/lib/increase/models/pending_transaction.rb +5 -2
  21. data/lib/increase/models/pending_transaction_list_params.rb +1 -1
  22. data/lib/increase/models/physical_card.rb +5 -2
  23. data/lib/increase/models/real_time_payments_transfer.rb +3 -3
  24. data/lib/increase/models/real_time_payments_transfer_list_params.rb +3 -3
  25. data/lib/increase/models/simulations/inbound_ach_transfer_create_params.rb +3 -2
  26. data/lib/increase/models/simulations/inbound_mail_item_create_params.rb +6 -4
  27. data/lib/increase/models/simulations/physical_card_create_params.rb +5 -2
  28. data/lib/increase/models/swift_transfer.rb +3 -3
  29. data/lib/increase/models/swift_transfer_list_params.rb +3 -3
  30. data/lib/increase/models/transaction.rb +7 -4
  31. data/lib/increase/models/wire_transfer.rb +3 -3
  32. data/lib/increase/models/wire_transfer_list_params.rb +3 -3
  33. data/lib/increase/resources/accounts.rb +1 -1
  34. data/lib/increase/resources/ach_transfers.rb +10 -10
  35. data/lib/increase/resources/inbound_mail_items.rb +3 -1
  36. data/lib/increase/resources/lockbox_addresses.rb +4 -1
  37. data/lib/increase/resources/lockbox_recipients.rb +1 -1
  38. data/lib/increase/resources/simulations/card_authorizations.rb +4 -1
  39. data/lib/increase/resources/simulations/inbound_ach_transfers.rb +1 -1
  40. data/lib/increase/resources/simulations/inbound_mail_items.rb +6 -3
  41. data/lib/increase/version.rb +1 -1
  42. data/rbi/increase/models/account_create_params.rbi +6 -4
  43. data/rbi/increase/models/ach_transfer.rbi +22 -19
  44. data/rbi/increase/models/ach_transfer_create_params.rbi +67 -45
  45. data/rbi/increase/models/ach_transfer_list_params.rbi +1 -1
  46. data/rbi/increase/models/beneficial_owner_create_params.rbi +4 -2
  47. data/rbi/increase/models/beneficial_owner_update_params.rbi +4 -2
  48. data/rbi/increase/models/card_push_transfer.rbi +7 -7
  49. data/rbi/increase/models/card_push_transfer_list_params.rbi +7 -7
  50. data/rbi/increase/models/check_transfer.rbi +9 -2
  51. data/rbi/increase/models/entity_create_params.rbi +30 -15
  52. data/rbi/increase/models/entity_update_params.rbi +4 -2
  53. data/rbi/increase/models/fednow_transfer.rbi +7 -7
  54. data/rbi/increase/models/fednow_transfer_list_params.rbi +7 -7
  55. data/rbi/increase/models/inbound_mail_item.rbi +3 -1
  56. data/rbi/increase/models/inbound_real_time_payments_transfer.rbi +1 -1
  57. data/rbi/increase/models/lockbox_address.rbi +5 -1
  58. data/rbi/increase/models/lockbox_recipient_create_params.rbi +4 -2
  59. data/rbi/increase/models/pending_transaction.rbi +9 -3
  60. data/rbi/increase/models/pending_transaction_list_params.rbi +1 -1
  61. data/rbi/increase/models/physical_card.rbi +9 -2
  62. data/rbi/increase/models/real_time_payments_transfer.rbi +7 -7
  63. data/rbi/increase/models/real_time_payments_transfer_list_params.rbi +7 -7
  64. data/rbi/increase/models/simulations/inbound_ach_transfer_create_params.rbi +4 -2
  65. data/rbi/increase/models/simulations/inbound_mail_item_create_params.rbi +8 -4
  66. data/rbi/increase/models/simulations/physical_card_create_params.rbi +9 -2
  67. data/rbi/increase/models/swift_transfer.rbi +7 -7
  68. data/rbi/increase/models/swift_transfer_list_params.rbi +7 -7
  69. data/rbi/increase/models/transaction.rbi +10 -5
  70. data/rbi/increase/models/wire_transfer.rbi +4 -4
  71. data/rbi/increase/models/wire_transfer_list_params.rbi +7 -7
  72. data/rbi/increase/resources/accounts.rbi +3 -2
  73. data/rbi/increase/resources/ach_transfers.rbi +29 -19
  74. data/rbi/increase/resources/inbound_mail_items.rbi +3 -1
  75. data/rbi/increase/resources/lockbox_addresses.rbi +4 -1
  76. data/rbi/increase/resources/lockbox_recipients.rbi +2 -1
  77. data/rbi/increase/resources/simulations/card_authorizations.rbi +4 -1
  78. data/rbi/increase/resources/simulations/inbound_ach_transfers.rbi +2 -1
  79. data/rbi/increase/resources/simulations/inbound_mail_items.rbi +8 -3
  80. data/sig/increase/models/ach_transfer.rbs +2 -2
  81. data/sig/increase/models/ach_transfer_create_params.rbs +1 -1
  82. data/sig/increase/models/ach_transfer_list_params.rbs +1 -1
  83. data/sig/increase/models/card_push_transfer.rbs +4 -4
  84. data/sig/increase/models/card_push_transfer_list_params.rbs +4 -4
  85. data/sig/increase/models/check_transfer.rbs +6 -2
  86. data/sig/increase/models/fednow_transfer.rbs +5 -5
  87. data/sig/increase/models/fednow_transfer_list_params.rbs +5 -5
  88. data/sig/increase/models/inbound_real_time_payments_transfer.rbs +1 -1
  89. data/sig/increase/models/pending_transaction.rbs +1 -1
  90. data/sig/increase/models/pending_transaction_list_params.rbs +1 -1
  91. data/sig/increase/models/physical_card.rbs +6 -2
  92. data/sig/increase/models/real_time_payments_transfer.rbs +4 -4
  93. data/sig/increase/models/real_time_payments_transfer_list_params.rbs +4 -4
  94. data/sig/increase/models/simulations/physical_card_create_params.rbs +6 -2
  95. data/sig/increase/models/swift_transfer.rbs +4 -4
  96. data/sig/increase/models/swift_transfer_list_params.rbs +4 -4
  97. data/sig/increase/models/wire_transfer.rbs +4 -4
  98. data/sig/increase/models/wire_transfer_list_params.rbs +4 -4
  99. metadata +2 -3
  100. data/CHANGELOG.md +0 -4541
@@ -30,15 +30,19 @@ module Increase
30
30
  sig { returns(String) }
31
31
  attr_accessor :statement_descriptor
32
32
 
33
- # The account number for the destination account.
33
+ # The receiver's account number. For credit transfers (positive `amount`) this is
34
+ # the account that funds will be sent to. For debit transfers (negative `amount`)
35
+ # this is the account that funds will be pulled from.
34
36
  sig { returns(T.nilable(String)) }
35
37
  attr_reader :account_number
36
38
 
37
39
  sig { params(account_number: String).void }
38
40
  attr_writer :account_number
39
41
 
40
- # Additional information that will be sent to the recipient. This is included in
41
- # the transfer data sent to the receiving bank.
42
+ # Additional information passed through to the receiving bank with the transfer.
43
+ # Most ACH transfers do not need this. Only set this if your recipient has asked
44
+ # for addendum data, typically unstructured remittance information. Corporate
45
+ # Trade Exchange (CTX) flows can carry structured X12 remittance advice instead.
42
46
  sig { returns(T.nilable(Increase::ACHTransferCreateParams::Addenda)) }
43
47
  attr_reader :addenda
44
48
 
@@ -47,41 +51,45 @@ module Increase
47
51
  end
48
52
  attr_writer :addenda
49
53
 
50
- # The description of the date of the transfer, usually in the format `YYMMDD`.
51
- # This is included in the transfer data sent to the receiving bank.
54
+ # A description of the transfer date (typically `YYMMDD`), sent in the company
55
+ # batch header. This value is informational and does not affect funds movement,
56
+ # settlement timing, or returns. Only set this if your recipient has asked for it.
52
57
  sig { returns(T.nilable(String)) }
53
58
  attr_reader :company_descriptive_date
54
59
 
55
60
  sig { params(company_descriptive_date: String).void }
56
61
  attr_writer :company_descriptive_date
57
62
 
58
- # The data you choose to associate with the transfer. This is included in the
59
- # transfer data sent to the receiving bank.
63
+ # Custom data sent in the company batch header. This value is informational and
64
+ # does not affect funds movement, settlement timing, or returns. Most ACH
65
+ # transfers do not need this. Only set this if your recipient has asked for it.
60
66
  sig { returns(T.nilable(String)) }
61
67
  attr_reader :company_discretionary_data
62
68
 
63
69
  sig { params(company_discretionary_data: String).void }
64
70
  attr_writer :company_discretionary_data
65
71
 
66
- # A description of the transfer, included in the transfer data sent to the
67
- # receiving bank. Standardized formatting may be required, for example `PAYROLL`
68
- # for payroll-related Prearranged Payments and Deposits (PPD) credit transfers.
72
+ # A short description sent in the company batch header. Most receivers do not
73
+ # surface this. Only set this if your recipient has asked for a specific value or
74
+ # if Nacha mandates one for your Standard Entry Class (SEC) code and use case. For
75
+ # example, Prearranged Payment and Deposit (PPD) payroll credits must use
76
+ # `PAYROLL`, and reversals must use `REVERSAL`.
69
77
  sig { returns(T.nilable(String)) }
70
78
  attr_reader :company_entry_description
71
79
 
72
80
  sig { params(company_entry_description: String).void }
73
81
  attr_writer :company_entry_description
74
82
 
75
- # The name by which the recipient knows you. This is included in the transfer data
76
- # sent to the receiving bank.
83
+ # The name by which the recipient knows you, sent in the company batch header. We
84
+ # recommend setting this on every transfer; if you do not, we fall back to the ACH
85
+ # company name configured on your account.
77
86
  sig { returns(T.nilable(String)) }
78
87
  attr_reader :company_name
79
88
 
80
89
  sig { params(company_name: String).void }
81
90
  attr_writer :company_name
82
91
 
83
- # The type of entity that owns the account to which the ACH Transfer is being
84
- # sent.
92
+ # The type of entity that owns the receiver's account.
85
93
  sig do
86
94
  returns(
87
95
  T.nilable(
@@ -107,7 +115,7 @@ module Increase
107
115
  sig { params(external_account_id: String).void }
108
116
  attr_writer :external_account_id
109
117
 
110
- # The type of the account to which the transfer will be sent.
118
+ # The type of the receiver's bank account.
111
119
  sig do
112
120
  returns(T.nilable(Increase::ACHTransferCreateParams::Funding::OrSymbol))
113
121
  end
@@ -120,7 +128,8 @@ module Increase
120
128
  end
121
129
  attr_writer :funding
122
130
 
123
- # Your identifier for the transfer recipient.
131
+ # Your internal identifier for the transfer recipient. This value is informational
132
+ # and not verified by the recipient's bank. Most callers can leave this unset.
124
133
  sig { returns(T.nilable(String)) }
125
134
  attr_reader :individual_id
126
135
 
@@ -161,8 +170,8 @@ module Increase
161
170
  sig { params(require_approval: T::Boolean).void }
162
171
  attr_writer :require_approval
163
172
 
164
- # The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
165
- # destination account.
173
+ # The American Bankers' Association (ABA) Routing Transit Number (RTN) of the
174
+ # receiver's bank.
166
175
  sig { returns(T.nilable(String)) }
167
176
  attr_reader :routing_number
168
177
 
@@ -171,7 +180,8 @@ module Increase
171
180
 
172
181
  # The
173
182
  # [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes)
174
- # to use for the transfer.
183
+ # to use for the transfer. If not provided, the default is
184
+ # `corporate_credit_or_debit`.
175
185
  sig do
176
186
  returns(
177
187
  T.nilable(
@@ -249,33 +259,42 @@ module Increase
249
259
  # help the customer recognize the transfer. You are highly encouraged to pass
250
260
  # `individual_name` and `company_name` instead of relying on this fallback.
251
261
  statement_descriptor:,
252
- # The account number for the destination account.
262
+ # The receiver's account number. For credit transfers (positive `amount`) this is
263
+ # the account that funds will be sent to. For debit transfers (negative `amount`)
264
+ # this is the account that funds will be pulled from.
253
265
  account_number: nil,
254
- # Additional information that will be sent to the recipient. This is included in
255
- # the transfer data sent to the receiving bank.
266
+ # Additional information passed through to the receiving bank with the transfer.
267
+ # Most ACH transfers do not need this. Only set this if your recipient has asked
268
+ # for addendum data, typically unstructured remittance information. Corporate
269
+ # Trade Exchange (CTX) flows can carry structured X12 remittance advice instead.
256
270
  addenda: nil,
257
- # The description of the date of the transfer, usually in the format `YYMMDD`.
258
- # This is included in the transfer data sent to the receiving bank.
271
+ # A description of the transfer date (typically `YYMMDD`), sent in the company
272
+ # batch header. This value is informational and does not affect funds movement,
273
+ # settlement timing, or returns. Only set this if your recipient has asked for it.
259
274
  company_descriptive_date: nil,
260
- # The data you choose to associate with the transfer. This is included in the
261
- # transfer data sent to the receiving bank.
275
+ # Custom data sent in the company batch header. This value is informational and
276
+ # does not affect funds movement, settlement timing, or returns. Most ACH
277
+ # transfers do not need this. Only set this if your recipient has asked for it.
262
278
  company_discretionary_data: nil,
263
- # A description of the transfer, included in the transfer data sent to the
264
- # receiving bank. Standardized formatting may be required, for example `PAYROLL`
265
- # for payroll-related Prearranged Payments and Deposits (PPD) credit transfers.
279
+ # A short description sent in the company batch header. Most receivers do not
280
+ # surface this. Only set this if your recipient has asked for a specific value or
281
+ # if Nacha mandates one for your Standard Entry Class (SEC) code and use case. For
282
+ # example, Prearranged Payment and Deposit (PPD) payroll credits must use
283
+ # `PAYROLL`, and reversals must use `REVERSAL`.
266
284
  company_entry_description: nil,
267
- # The name by which the recipient knows you. This is included in the transfer data
268
- # sent to the receiving bank.
285
+ # The name by which the recipient knows you, sent in the company batch header. We
286
+ # recommend setting this on every transfer; if you do not, we fall back to the ACH
287
+ # company name configured on your account.
269
288
  company_name: nil,
270
- # The type of entity that owns the account to which the ACH Transfer is being
271
- # sent.
289
+ # The type of entity that owns the receiver's account.
272
290
  destination_account_holder: nil,
273
291
  # The ID of an External Account to initiate a transfer to. If this parameter is
274
292
  # provided, `account_number`, `routing_number`, and `funding` must be absent.
275
293
  external_account_id: nil,
276
- # The type of the account to which the transfer will be sent.
294
+ # The type of the receiver's bank account.
277
295
  funding: nil,
278
- # Your identifier for the transfer recipient.
296
+ # Your internal identifier for the transfer recipient. This value is informational
297
+ # and not verified by the recipient's bank. Most callers can leave this unset.
279
298
  individual_id: nil,
280
299
  # The name of the transfer recipient. This value is informational and not verified
281
300
  # by the recipient's bank.
@@ -287,12 +306,13 @@ module Increase
287
306
  preferred_effective_date: nil,
288
307
  # Whether the transfer requires explicit approval via the dashboard or API.
289
308
  require_approval: nil,
290
- # The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
291
- # destination account.
309
+ # The American Bankers' Association (ABA) Routing Transit Number (RTN) of the
310
+ # receiver's bank.
292
311
  routing_number: nil,
293
312
  # The
294
313
  # [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes)
295
- # to use for the transfer.
314
+ # to use for the transfer. If not provided, the default is
315
+ # `corporate_credit_or_debit`.
296
316
  standard_entry_class_code: nil,
297
317
  # The timing of the transaction.
298
318
  transaction_timing: nil,
@@ -387,8 +407,10 @@ module Increase
387
407
  end
388
408
  attr_writer :payment_order_remittance_advice
389
409
 
390
- # Additional information that will be sent to the recipient. This is included in
391
- # the transfer data sent to the receiving bank.
410
+ # Additional information passed through to the receiving bank with the transfer.
411
+ # Most ACH transfers do not need this. Only set this if your recipient has asked
412
+ # for addendum data, typically unstructured remittance information. Corporate
413
+ # Trade Exchange (CTX) flows can carry structured X12 remittance advice instead.
392
414
  sig do
393
415
  params(
394
416
  category:
@@ -636,8 +658,7 @@ module Increase
636
658
  end
637
659
  end
638
660
 
639
- # The type of entity that owns the account to which the ACH Transfer is being
640
- # sent.
661
+ # The type of entity that owns the receiver's account.
641
662
  module DestinationAccountHolder
642
663
  extend Increase::Internal::Type::Enum
643
664
 
@@ -682,7 +703,7 @@ module Increase
682
703
  end
683
704
  end
684
705
 
685
- # The type of the account to which the transfer will be sent.
706
+ # The type of the receiver's bank account.
686
707
  module Funding
687
708
  extend Increase::Internal::Type::Enum
688
709
 
@@ -806,7 +827,7 @@ module Increase
806
827
  end
807
828
  OrSymbol = T.type_alias { T.any(Symbol, String) }
808
829
 
809
- # 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.
830
+ # 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.
810
831
  SAME_DAY =
811
832
  T.let(
812
833
  :same_day,
@@ -834,7 +855,8 @@ module Increase
834
855
 
835
856
  # The
836
857
  # [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes)
837
- # to use for the transfer.
858
+ # to use for the transfer. If not provided, the default is
859
+ # `corporate_credit_or_debit`.
838
860
  module StandardEntryClassCode
839
861
  extend Increase::Internal::Type::Enum
840
862
 
@@ -300,7 +300,7 @@ module Increase
300
300
  Increase::ACHTransferListParams::Status::In::TaggedSymbol
301
301
  )
302
302
 
303
- # The transfer is complete.
303
+ # The transfer has been submitted to the Federal Reserve. When the transfer settles, the status remains `submitted` and the `settlement` sub-object is populated.
304
304
  SUBMITTED =
305
305
  T.let(
306
306
  :submitted,
@@ -298,7 +298,8 @@ module Increase
298
298
  # An identification number that can be used to verify the individual's identity,
299
299
  # such as a social security number. For Social Security Numbers and Individual
300
300
  # Taxpayer Identification Numbers, submit nine digits with no dashes or other
301
- # separators.
301
+ # separators. When testing in sandbox, use one of our
302
+ # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
302
303
  sig { returns(String) }
303
304
  attr_accessor :number
304
305
 
@@ -379,7 +380,8 @@ module Increase
379
380
  # An identification number that can be used to verify the individual's identity,
380
381
  # such as a social security number. For Social Security Numbers and Individual
381
382
  # Taxpayer Identification Numbers, submit nine digits with no dashes or other
382
- # separators.
383
+ # separators. When testing in sandbox, use one of our
384
+ # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
383
385
  number:,
384
386
  # Information about the United States driver's license used for identification.
385
387
  # Required if `method` is equal to `drivers_license`.
@@ -247,7 +247,8 @@ module Increase
247
247
  # An identification number that can be used to verify the individual's identity,
248
248
  # such as a social security number. For Social Security Numbers and Individual
249
249
  # Taxpayer Identification Numbers, submit nine digits with no dashes or other
250
- # separators.
250
+ # separators. When testing in sandbox, use one of our
251
+ # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
251
252
  sig { returns(String) }
252
253
  attr_accessor :number
253
254
 
@@ -328,7 +329,8 @@ module Increase
328
329
  # An identification number that can be used to verify the individual's identity,
329
330
  # such as a social security number. For Social Security Numbers and Individual
330
331
  # Taxpayer Identification Numbers, submit nine digits with no dashes or other
331
- # separators.
332
+ # separators. When testing in sandbox, use one of our
333
+ # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
332
334
  number:,
333
335
  # Information about the United States driver's license used for identification.
334
336
  # Required if `method` is equal to `drivers_license`.
@@ -2725,6 +2725,13 @@ module Increase
2725
2725
  CANCELED =
2726
2726
  T.let(:canceled, Increase::CardPushTransfer::Status::TaggedSymbol)
2727
2727
 
2728
+ # The transfer is queued to be submitted to the card network.
2729
+ PENDING_SUBMISSION =
2730
+ T.let(
2731
+ :pending_submission,
2732
+ Increase::CardPushTransfer::Status::TaggedSymbol
2733
+ )
2734
+
2728
2735
  # The transfer is pending review by Increase.
2729
2736
  PENDING_REVIEWING =
2730
2737
  T.let(
@@ -2739,13 +2746,6 @@ module Increase
2739
2746
  Increase::CardPushTransfer::Status::TaggedSymbol
2740
2747
  )
2741
2748
 
2742
- # The transfer is queued to be submitted to the card network.
2743
- PENDING_SUBMISSION =
2744
- T.let(
2745
- :pending_submission,
2746
- Increase::CardPushTransfer::Status::TaggedSymbol
2747
- )
2748
-
2749
2749
  # The transfer has been submitted and is pending a response from the card network.
2750
2750
  SUBMITTED =
2751
2751
  T.let(:submitted, Increase::CardPushTransfer::Status::TaggedSymbol)
@@ -271,6 +271,13 @@ module Increase
271
271
  Increase::CardPushTransferListParams::Status::In::TaggedSymbol
272
272
  )
273
273
 
274
+ # The transfer is queued to be submitted to the card network.
275
+ PENDING_SUBMISSION =
276
+ T.let(
277
+ :pending_submission,
278
+ Increase::CardPushTransferListParams::Status::In::TaggedSymbol
279
+ )
280
+
274
281
  # The transfer is pending review by Increase.
275
282
  PENDING_REVIEWING =
276
283
  T.let(
@@ -285,13 +292,6 @@ module Increase
285
292
  Increase::CardPushTransferListParams::Status::In::TaggedSymbol
286
293
  )
287
294
 
288
- # The transfer is queued to be submitted to the card network.
289
- PENDING_SUBMISSION =
290
- T.let(
291
- :pending_submission,
292
- Increase::CardPushTransferListParams::Status::In::TaggedSymbol
293
- )
294
-
295
295
  # The transfer has been submitted and is pending a response from the card network.
296
296
  SUBMITTED =
297
297
  T.let(
@@ -1296,14 +1296,21 @@ module Increase
1296
1296
  Increase::CheckTransfer::PhysicalCheck::TrackingUpdate::Category::TaggedSymbol
1297
1297
  )
1298
1298
 
1299
- # 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.
1299
+ # 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.
1300
1300
  DELIVERY_ISSUE =
1301
1301
  T.let(
1302
1302
  :delivery_issue,
1303
1303
  Increase::CheckTransfer::PhysicalCheck::TrackingUpdate::Category::TaggedSymbol
1304
1304
  )
1305
1305
 
1306
- # Delivery failed and the check was returned to sender.
1306
+ # The check has been rerouted to the return address.
1307
+ RETURNING_TO_SENDER =
1308
+ T.let(
1309
+ :returning_to_sender,
1310
+ Increase::CheckTransfer::PhysicalCheck::TrackingUpdate::Category::TaggedSymbol
1311
+ )
1312
+
1313
+ # The check has been delivered to the return address.
1307
1314
  RETURNED_TO_SENDER =
1308
1315
  T.let(
1309
1316
  :returned_to_sender,
@@ -310,7 +310,8 @@ module Increase
310
310
  attr_accessor :beneficial_owners
311
311
 
312
312
  # The legal identifier of the corporation. This is usually the Employer
313
- # Identification Number (EIN).
313
+ # Identification Number (EIN). This replaces the deprecated `tax_identifier`
314
+ # field.
314
315
  sig do
315
316
  returns(Increase::EntityCreateParams::Corporation::LegalIdentifier)
316
317
  end
@@ -414,7 +415,8 @@ module Increase
414
415
  # `control` person.
415
416
  beneficial_owners:,
416
417
  # The legal identifier of the corporation. This is usually the Employer
417
- # Identification Number (EIN).
418
+ # Identification Number (EIN). This replaces the deprecated `tax_identifier`
419
+ # field.
418
420
  legal_identifier:,
419
421
  # The legal name of the corporation.
420
422
  name:,
@@ -847,7 +849,8 @@ module Increase
847
849
  # An identification number that can be used to verify the individual's identity,
848
850
  # such as a social security number. For Social Security Numbers and Individual
849
851
  # Taxpayer Identification Numbers, submit nine digits with no dashes or other
850
- # separators.
852
+ # separators. When testing in sandbox, use one of our
853
+ # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
851
854
  sig { returns(String) }
852
855
  attr_accessor :number
853
856
 
@@ -928,7 +931,8 @@ module Increase
928
931
  # An identification number that can be used to verify the individual's identity,
929
932
  # such as a social security number. For Social Security Numbers and Individual
930
933
  # Taxpayer Identification Numbers, submit nine digits with no dashes or other
931
- # separators.
934
+ # separators. When testing in sandbox, use one of our
935
+ # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
932
936
  number:,
933
937
  # Information about the United States driver's license used for identification.
934
938
  # Required if `method` is equal to `drivers_license`.
@@ -1263,7 +1267,8 @@ module Increase
1263
1267
  end
1264
1268
 
1265
1269
  # The legal identifier. For US Employer Identification Numbers, submit nine digits
1266
- # with no dashes or other separators.
1270
+ # with no dashes or other separators. When testing in sandbox, use one of our
1271
+ # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
1267
1272
  sig { returns(String) }
1268
1273
  attr_accessor :value
1269
1274
 
@@ -1287,7 +1292,8 @@ module Increase
1287
1292
  attr_writer :category
1288
1293
 
1289
1294
  # The legal identifier of the corporation. This is usually the Employer
1290
- # Identification Number (EIN).
1295
+ # Identification Number (EIN). This replaces the deprecated `tax_identifier`
1296
+ # field.
1291
1297
  sig do
1292
1298
  params(
1293
1299
  value: String,
@@ -1297,7 +1303,8 @@ module Increase
1297
1303
  end
1298
1304
  def self.new(
1299
1305
  # The legal identifier. For US Employer Identification Numbers, submit nine digits
1300
- # with no dashes or other separators.
1306
+ # with no dashes or other separators. When testing in sandbox, use one of our
1307
+ # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
1301
1308
  value:,
1302
1309
  # The category of the legal identifier. If not provided, the default is
1303
1310
  # `us_employer_identification_number`.
@@ -1930,7 +1937,8 @@ module Increase
1930
1937
  # An identification number that can be used to verify the individual's identity,
1931
1938
  # such as a social security number. For Social Security Numbers and Individual
1932
1939
  # Taxpayer Identification Numbers, submit nine digits with no dashes or other
1933
- # separators.
1940
+ # separators. When testing in sandbox, use one of our
1941
+ # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
1934
1942
  sig { returns(String) }
1935
1943
  attr_accessor :number
1936
1944
 
@@ -2011,7 +2019,8 @@ module Increase
2011
2019
  # An identification number that can be used to verify the individual's identity,
2012
2020
  # such as a social security number. For Social Security Numbers and Individual
2013
2021
  # Taxpayer Identification Numbers, submit nine digits with no dashes or other
2014
- # separators.
2022
+ # separators. When testing in sandbox, use one of our
2023
+ # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
2015
2024
  number:,
2016
2025
  # Information about the United States driver's license used for identification.
2017
2026
  # Required if `method` is equal to `drivers_license`.
@@ -2509,7 +2518,8 @@ module Increase
2509
2518
  # An identification number that can be used to verify the individual's identity,
2510
2519
  # such as a social security number. For Social Security Numbers and Individual
2511
2520
  # Taxpayer Identification Numbers, submit nine digits with no dashes or other
2512
- # separators.
2521
+ # separators. When testing in sandbox, use one of our
2522
+ # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
2513
2523
  sig { returns(String) }
2514
2524
  attr_accessor :number
2515
2525
 
@@ -2590,7 +2600,8 @@ module Increase
2590
2600
  # An identification number that can be used to verify the individual's identity,
2591
2601
  # such as a social security number. For Social Security Numbers and Individual
2592
2602
  # Taxpayer Identification Numbers, submit nine digits with no dashes or other
2593
- # separators.
2603
+ # separators. When testing in sandbox, use one of our
2604
+ # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
2594
2605
  number:,
2595
2606
  # Information about the United States driver's license used for identification.
2596
2607
  # Required if `method` is equal to `drivers_license`.
@@ -3700,7 +3711,8 @@ module Increase
3700
3711
  # An identification number that can be used to verify the individual's identity,
3701
3712
  # such as a social security number. For Social Security Numbers and Individual
3702
3713
  # Taxpayer Identification Numbers, submit nine digits with no dashes or other
3703
- # separators.
3714
+ # separators. When testing in sandbox, use one of our
3715
+ # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
3704
3716
  sig { returns(String) }
3705
3717
  attr_accessor :number
3706
3718
 
@@ -3781,7 +3793,8 @@ module Increase
3781
3793
  # An identification number that can be used to verify the individual's identity,
3782
3794
  # such as a social security number. For Social Security Numbers and Individual
3783
3795
  # Taxpayer Identification Numbers, submit nine digits with no dashes or other
3784
- # separators.
3796
+ # separators. When testing in sandbox, use one of our
3797
+ # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
3785
3798
  number:,
3786
3799
  # Information about the United States driver's license used for identification.
3787
3800
  # Required if `method` is equal to `drivers_license`.
@@ -4278,7 +4291,8 @@ module Increase
4278
4291
  # An identification number that can be used to verify the individual's identity,
4279
4292
  # such as a social security number. For Social Security Numbers and Individual
4280
4293
  # Taxpayer Identification Numbers, submit nine digits with no dashes or other
4281
- # separators.
4294
+ # separators. When testing in sandbox, use one of our
4295
+ # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
4282
4296
  sig { returns(String) }
4283
4297
  attr_accessor :number
4284
4298
 
@@ -4359,7 +4373,8 @@ module Increase
4359
4373
  # An identification number that can be used to verify the individual's identity,
4360
4374
  # such as a social security number. For Social Security Numbers and Individual
4361
4375
  # Taxpayer Identification Numbers, submit nine digits with no dashes or other
4362
- # separators.
4376
+ # separators. When testing in sandbox, use one of our
4377
+ # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
4363
4378
  number:,
4364
4379
  # Information about the United States driver's license used for identification.
4365
4380
  # Required if `method` is equal to `drivers_license`.
@@ -869,7 +869,8 @@ module Increase
869
869
  # An identification number that can be used to verify the individual's identity,
870
870
  # such as a social security number. For Social Security Numbers and Individual
871
871
  # Taxpayer Identification Numbers, submit nine digits with no dashes or other
872
- # separators.
872
+ # separators. When testing in sandbox, use one of our
873
+ # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
873
874
  sig { returns(String) }
874
875
  attr_accessor :number
875
876
 
@@ -950,7 +951,8 @@ module Increase
950
951
  # An identification number that can be used to verify the individual's identity,
951
952
  # such as a social security number. For Social Security Numbers and Individual
952
953
  # Taxpayer Identification Numbers, submit nine digits with no dashes or other
953
- # separators.
954
+ # separators. When testing in sandbox, use one of our
955
+ # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
954
956
  number:,
955
957
  # Information about the United States driver's license used for identification.
956
958
  # Required if `method` is equal to `drivers_license`.
@@ -885,6 +885,13 @@ module Increase
885
885
  T.type_alias { T.all(Symbol, Increase::FednowTransfer::Status) }
886
886
  OrSymbol = T.type_alias { T.any(Symbol, String) }
887
887
 
888
+ # The transfer is queued to be submitted to FedNow.
889
+ PENDING_SUBMITTING =
890
+ T.let(
891
+ :pending_submitting,
892
+ Increase::FednowTransfer::Status::TaggedSymbol
893
+ )
894
+
888
895
  # The transfer is pending review by Increase.
889
896
  PENDING_REVIEWING =
890
897
  T.let(
@@ -917,13 +924,6 @@ module Increase
917
924
  Increase::FednowTransfer::Status::TaggedSymbol
918
925
  )
919
926
 
920
- # The transfer is queued to be submitted to FedNow.
921
- PENDING_SUBMITTING =
922
- T.let(
923
- :pending_submitting,
924
- Increase::FednowTransfer::Status::TaggedSymbol
925
- )
926
-
927
927
  # The transfer has been submitted and is pending a response from FedNow.
928
928
  PENDING_RESPONSE =
929
929
  T.let(
@@ -255,6 +255,13 @@ module Increase
255
255
  end
256
256
  OrSymbol = T.type_alias { T.any(Symbol, String) }
257
257
 
258
+ # The transfer is queued to be submitted to FedNow.
259
+ PENDING_SUBMITTING =
260
+ T.let(
261
+ :pending_submitting,
262
+ Increase::FednowTransferListParams::Status::In::TaggedSymbol
263
+ )
264
+
258
265
  # The transfer is pending review by Increase.
259
266
  PENDING_REVIEWING =
260
267
  T.let(
@@ -290,13 +297,6 @@ module Increase
290
297
  Increase::FednowTransferListParams::Status::In::TaggedSymbol
291
298
  )
292
299
 
293
- # The transfer is queued to be submitted to FedNow.
294
- PENDING_SUBMITTING =
295
- T.let(
296
- :pending_submitting,
297
- Increase::FednowTransferListParams::Status::In::TaggedSymbol
298
- )
299
-
300
300
  # The transfer has been submitted and is pending a response from FedNow.
301
301
  PENDING_RESPONSE =
302
302
  T.let(
@@ -56,7 +56,9 @@ module Increase
56
56
  attr_accessor :type
57
57
 
58
58
  # Inbound Mail Items represent pieces of physical mail delivered to a Lockbox
59
- # Address.
59
+ # Address. Increase automatically deposits checks mailed to a Lockbox Recipient
60
+ # into the recipient's Account. Checks that are not matched to a Lockbox Recipient
61
+ # must be deposited or ignored using the Action an Inbound Mail Item endpoint.
60
62
  sig do
61
63
  params(
62
64
  id: String,
@@ -417,7 +417,7 @@ module Increase
417
417
  Increase::InboundRealTimePaymentsTransfer::Status::TaggedSymbol
418
418
  )
419
419
 
420
- # The transfer was not responded to in time.
420
+ # The transfer was not responded to in time. This is rare and represents an error at Increase.
421
421
  TIMED_OUT =
422
422
  T.let(
423
423
  :timed_out,
@@ -49,7 +49,11 @@ module Increase
49
49
  attr_accessor :type
50
50
 
51
51
  # Lockbox Addresses are physical locations that can receive mail containing paper
52
- # checks.
52
+ # checks. A Lockbox Address is not itself linked to an Account; Lockbox Recipients
53
+ # determine where checks received at the address are deposited. Lockbox Addresses
54
+ # are created with a `pending` status and a null `address`. Increase generates the
55
+ # mailing address shortly after creation, at which point the status becomes
56
+ # `active`.
53
57
  sig do
54
58
  params(
55
59
  id: String,