increase 1.338.0 → 1.340.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 (109) 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 +5 -3
  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 +8 -2
  12. data/lib/increase/models/check_transfer_list_params.rb +3 -0
  13. data/lib/increase/models/entity.rb +8 -6
  14. data/lib/increase/models/entity_create_params.rb +19 -10
  15. data/lib/increase/models/entity_supplemental_document.rb +1 -1
  16. data/lib/increase/models/entity_update_params.rb +5 -4
  17. data/lib/increase/models/fednow_transfer.rb +3 -3
  18. data/lib/increase/models/fednow_transfer_list_params.rb +3 -3
  19. data/lib/increase/models/inbound_mail_item.rb +3 -1
  20. data/lib/increase/models/inbound_real_time_payments_transfer.rb +1 -1
  21. data/lib/increase/models/lockbox_address.rb +5 -1
  22. data/lib/increase/models/lockbox_recipient_create_params.rb +3 -2
  23. data/lib/increase/models/pending_transaction.rb +5 -2
  24. data/lib/increase/models/pending_transaction_list_params.rb +1 -1
  25. data/lib/increase/models/physical_card.rb +5 -2
  26. data/lib/increase/models/real_time_payments_transfer.rb +3 -3
  27. data/lib/increase/models/real_time_payments_transfer_list_params.rb +3 -3
  28. data/lib/increase/models/simulations/inbound_ach_transfer_create_params.rb +3 -2
  29. data/lib/increase/models/simulations/inbound_mail_item_create_params.rb +6 -4
  30. data/lib/increase/models/simulations/physical_card_create_params.rb +5 -2
  31. data/lib/increase/models/swift_transfer.rb +3 -3
  32. data/lib/increase/models/swift_transfer_list_params.rb +3 -3
  33. data/lib/increase/models/transaction.rb +7 -4
  34. data/lib/increase/models/wire_transfer.rb +3 -3
  35. data/lib/increase/models/wire_transfer_list_params.rb +3 -3
  36. data/lib/increase/resources/accounts.rb +1 -1
  37. data/lib/increase/resources/ach_transfers.rb +10 -10
  38. data/lib/increase/resources/beneficial_owners.rb +1 -1
  39. data/lib/increase/resources/inbound_mail_items.rb +3 -1
  40. data/lib/increase/resources/lockbox_addresses.rb +4 -1
  41. data/lib/increase/resources/lockbox_recipients.rb +1 -1
  42. data/lib/increase/resources/simulations/card_authorizations.rb +4 -1
  43. data/lib/increase/resources/simulations/inbound_ach_transfers.rb +1 -1
  44. data/lib/increase/resources/simulations/inbound_mail_items.rb +6 -3
  45. data/lib/increase/version.rb +1 -1
  46. data/rbi/increase/models/account_create_params.rbi +6 -4
  47. data/rbi/increase/models/ach_transfer.rbi +22 -19
  48. data/rbi/increase/models/ach_transfer_create_params.rbi +67 -45
  49. data/rbi/increase/models/ach_transfer_list_params.rbi +1 -1
  50. data/rbi/increase/models/beneficial_owner_create_params.rbi +8 -4
  51. data/rbi/increase/models/beneficial_owner_update_params.rbi +4 -2
  52. data/rbi/increase/models/card_push_transfer.rbi +7 -7
  53. data/rbi/increase/models/card_push_transfer_list_params.rbi +7 -7
  54. data/rbi/increase/models/check_transfer.rbi +16 -2
  55. data/rbi/increase/models/check_transfer_list_params.rbi +7 -0
  56. data/rbi/increase/models/entity.rbi +9 -6
  57. data/rbi/increase/models/entity_create_params.rbi +34 -17
  58. data/rbi/increase/models/entity_supplemental_document.rbi +1 -1
  59. data/rbi/increase/models/entity_update_params.rbi +8 -6
  60. data/rbi/increase/models/fednow_transfer.rbi +7 -7
  61. data/rbi/increase/models/fednow_transfer_list_params.rbi +7 -7
  62. data/rbi/increase/models/inbound_mail_item.rbi +3 -1
  63. data/rbi/increase/models/inbound_real_time_payments_transfer.rbi +1 -1
  64. data/rbi/increase/models/lockbox_address.rbi +5 -1
  65. data/rbi/increase/models/lockbox_recipient_create_params.rbi +4 -2
  66. data/rbi/increase/models/pending_transaction.rbi +9 -3
  67. data/rbi/increase/models/pending_transaction_list_params.rbi +1 -1
  68. data/rbi/increase/models/physical_card.rbi +9 -2
  69. data/rbi/increase/models/real_time_payments_transfer.rbi +7 -7
  70. data/rbi/increase/models/real_time_payments_transfer_list_params.rbi +7 -7
  71. data/rbi/increase/models/simulations/inbound_ach_transfer_create_params.rbi +4 -2
  72. data/rbi/increase/models/simulations/inbound_mail_item_create_params.rbi +8 -4
  73. data/rbi/increase/models/simulations/physical_card_create_params.rbi +9 -2
  74. data/rbi/increase/models/swift_transfer.rbi +7 -7
  75. data/rbi/increase/models/swift_transfer_list_params.rbi +7 -7
  76. data/rbi/increase/models/transaction.rbi +10 -5
  77. data/rbi/increase/models/wire_transfer.rbi +4 -4
  78. data/rbi/increase/models/wire_transfer_list_params.rbi +7 -7
  79. data/rbi/increase/resources/accounts.rbi +3 -2
  80. data/rbi/increase/resources/ach_transfers.rbi +29 -19
  81. data/rbi/increase/resources/beneficial_owners.rbi +2 -1
  82. data/rbi/increase/resources/inbound_mail_items.rbi +3 -1
  83. data/rbi/increase/resources/lockbox_addresses.rbi +4 -1
  84. data/rbi/increase/resources/lockbox_recipients.rbi +2 -1
  85. data/rbi/increase/resources/simulations/card_authorizations.rbi +4 -1
  86. data/rbi/increase/resources/simulations/inbound_ach_transfers.rbi +2 -1
  87. data/rbi/increase/resources/simulations/inbound_mail_items.rbi +8 -3
  88. data/sig/increase/models/ach_transfer.rbs +2 -2
  89. data/sig/increase/models/ach_transfer_create_params.rbs +1 -1
  90. data/sig/increase/models/ach_transfer_list_params.rbs +1 -1
  91. data/sig/increase/models/card_push_transfer.rbs +4 -4
  92. data/sig/increase/models/card_push_transfer_list_params.rbs +4 -4
  93. data/sig/increase/models/check_transfer.rbs +10 -2
  94. data/sig/increase/models/check_transfer_list_params.rbs +4 -0
  95. data/sig/increase/models/fednow_transfer.rbs +5 -5
  96. data/sig/increase/models/fednow_transfer_list_params.rbs +5 -5
  97. data/sig/increase/models/inbound_real_time_payments_transfer.rbs +1 -1
  98. data/sig/increase/models/pending_transaction.rbs +1 -1
  99. data/sig/increase/models/pending_transaction_list_params.rbs +1 -1
  100. data/sig/increase/models/physical_card.rbs +6 -2
  101. data/sig/increase/models/real_time_payments_transfer.rbs +4 -4
  102. data/sig/increase/models/real_time_payments_transfer_list_params.rbs +4 -4
  103. data/sig/increase/models/simulations/physical_card_create_params.rbs +6 -2
  104. data/sig/increase/models/swift_transfer.rbs +4 -4
  105. data/sig/increase/models/swift_transfer_list_params.rbs +4 -4
  106. data/sig/increase/models/wire_transfer.rbs +4 -4
  107. data/sig/increase/models/wire_transfer_list_params.rbs +4 -4
  108. metadata +2 -3
  109. data/CHANGELOG.md +0 -4541
@@ -147,7 +147,7 @@ module Increase
147
147
  attr_writer :validation
148
148
 
149
149
  # Entities are the legal entities that own accounts. They can be people,
150
- # corporations, partnerships, government authorities, or trusts. To learn more,
150
+ # corporations, joint accounts, trusts, or government authorities. To learn more,
151
151
  # see [Entities](/documentation/entities).
152
152
  sig do
153
153
  params(
@@ -311,7 +311,8 @@ module Increase
311
311
  sig { returns(T.nilable(String)) }
312
312
  attr_accessor :industry_code
313
313
 
314
- # The legal identifier of the corporation.
314
+ # The legal identifier of the corporation, like an Employer Identification Number
315
+ # (EIN).
315
316
  sig do
316
317
  returns(T.nilable(Increase::Entity::Corporation::LegalIdentifier))
317
318
  end
@@ -370,7 +371,8 @@ module Increase
370
371
  # The numeric North American Industry Classification System (NAICS) code submitted
371
372
  # for the corporation.
372
373
  industry_code:,
373
- # The legal identifier of the corporation.
374
+ # The legal identifier of the corporation, like an Employer Identification Number
375
+ # (EIN).
374
376
  legal_identifier:,
375
377
  # The legal name of the corporation.
376
378
  name:,
@@ -955,11 +957,12 @@ module Increase
955
957
  end
956
958
  attr_accessor :category
957
959
 
958
- # The identifier of the legal identifier.
960
+ # The legal identifier itself.
959
961
  sig { returns(String) }
960
962
  attr_accessor :value
961
963
 
962
- # The legal identifier of the corporation.
964
+ # The legal identifier of the corporation, like an Employer Identification Number
965
+ # (EIN).
963
966
  sig do
964
967
  params(
965
968
  category:
@@ -970,7 +973,7 @@ module Increase
970
973
  def self.new(
971
974
  # The category of the legal identifier.
972
975
  category:,
973
- # The identifier of the legal identifier.
976
+ # The legal identifier itself.
974
977
  value:
975
978
  )
976
979
  end
@@ -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`.
@@ -1262,8 +1266,10 @@ module Increase
1262
1266
  )
1263
1267
  end
1264
1268
 
1265
- # The legal identifier. For US Employer Identification Numbers, submit nine digits
1266
- # with no dashes or other separators.
1269
+ # The legal identifier itself. For US Employer Identification Numbers, submit nine
1270
+ # digits with no dashes or other separators. When testing in sandbox, use one of
1271
+ # our
1272
+ # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
1267
1273
  sig { returns(String) }
1268
1274
  attr_accessor :value
1269
1275
 
@@ -1287,7 +1293,8 @@ module Increase
1287
1293
  attr_writer :category
1288
1294
 
1289
1295
  # The legal identifier of the corporation. This is usually the Employer
1290
- # Identification Number (EIN).
1296
+ # Identification Number (EIN). This replaces the deprecated `tax_identifier`
1297
+ # field.
1291
1298
  sig do
1292
1299
  params(
1293
1300
  value: String,
@@ -1296,8 +1303,10 @@ module Increase
1296
1303
  ).returns(T.attached_class)
1297
1304
  end
1298
1305
  def self.new(
1299
- # The legal identifier. For US Employer Identification Numbers, submit nine digits
1300
- # with no dashes or other separators.
1306
+ # The legal identifier itself. For US Employer Identification Numbers, submit nine
1307
+ # digits with no dashes or other separators. When testing in sandbox, use one of
1308
+ # our
1309
+ # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
1301
1310
  value:,
1302
1311
  # The category of the legal identifier. If not provided, the default is
1303
1312
  # `us_employer_identification_number`.
@@ -1930,7 +1939,8 @@ module Increase
1930
1939
  # An identification number that can be used to verify the individual's identity,
1931
1940
  # such as a social security number. For Social Security Numbers and Individual
1932
1941
  # Taxpayer Identification Numbers, submit nine digits with no dashes or other
1933
- # separators.
1942
+ # separators. When testing in sandbox, use one of our
1943
+ # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
1934
1944
  sig { returns(String) }
1935
1945
  attr_accessor :number
1936
1946
 
@@ -2011,7 +2021,8 @@ module Increase
2011
2021
  # An identification number that can be used to verify the individual's identity,
2012
2022
  # such as a social security number. For Social Security Numbers and Individual
2013
2023
  # Taxpayer Identification Numbers, submit nine digits with no dashes or other
2014
- # separators.
2024
+ # separators. When testing in sandbox, use one of our
2025
+ # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
2015
2026
  number:,
2016
2027
  # Information about the United States driver's license used for identification.
2017
2028
  # Required if `method` is equal to `drivers_license`.
@@ -2509,7 +2520,8 @@ module Increase
2509
2520
  # An identification number that can be used to verify the individual's identity,
2510
2521
  # such as a social security number. For Social Security Numbers and Individual
2511
2522
  # Taxpayer Identification Numbers, submit nine digits with no dashes or other
2512
- # separators.
2523
+ # separators. When testing in sandbox, use one of our
2524
+ # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
2513
2525
  sig { returns(String) }
2514
2526
  attr_accessor :number
2515
2527
 
@@ -2590,7 +2602,8 @@ module Increase
2590
2602
  # An identification number that can be used to verify the individual's identity,
2591
2603
  # such as a social security number. For Social Security Numbers and Individual
2592
2604
  # Taxpayer Identification Numbers, submit nine digits with no dashes or other
2593
- # separators.
2605
+ # separators. When testing in sandbox, use one of our
2606
+ # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
2594
2607
  number:,
2595
2608
  # Information about the United States driver's license used for identification.
2596
2609
  # Required if `method` is equal to `drivers_license`.
@@ -3700,7 +3713,8 @@ module Increase
3700
3713
  # An identification number that can be used to verify the individual's identity,
3701
3714
  # such as a social security number. For Social Security Numbers and Individual
3702
3715
  # Taxpayer Identification Numbers, submit nine digits with no dashes or other
3703
- # separators.
3716
+ # separators. When testing in sandbox, use one of our
3717
+ # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
3704
3718
  sig { returns(String) }
3705
3719
  attr_accessor :number
3706
3720
 
@@ -3781,7 +3795,8 @@ module Increase
3781
3795
  # An identification number that can be used to verify the individual's identity,
3782
3796
  # such as a social security number. For Social Security Numbers and Individual
3783
3797
  # Taxpayer Identification Numbers, submit nine digits with no dashes or other
3784
- # separators.
3798
+ # separators. When testing in sandbox, use one of our
3799
+ # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
3785
3800
  number:,
3786
3801
  # Information about the United States driver's license used for identification.
3787
3802
  # Required if `method` is equal to `drivers_license`.
@@ -4278,7 +4293,8 @@ module Increase
4278
4293
  # An identification number that can be used to verify the individual's identity,
4279
4294
  # such as a social security number. For Social Security Numbers and Individual
4280
4295
  # Taxpayer Identification Numbers, submit nine digits with no dashes or other
4281
- # separators.
4296
+ # separators. When testing in sandbox, use one of our
4297
+ # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
4282
4298
  sig { returns(String) }
4283
4299
  attr_accessor :number
4284
4300
 
@@ -4359,7 +4375,8 @@ module Increase
4359
4375
  # An identification number that can be used to verify the individual's identity,
4360
4376
  # such as a social security number. For Social Security Numbers and Individual
4361
4377
  # Taxpayer Identification Numbers, submit nine digits with no dashes or other
4362
- # separators.
4378
+ # separators. When testing in sandbox, use one of our
4379
+ # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
4363
4380
  number:,
4364
4381
  # Information about the United States driver's license used for identification.
4365
4382
  # Required if `method` is equal to `drivers_license`.
@@ -36,7 +36,7 @@ module Increase
36
36
  attr_accessor :type
37
37
 
38
38
  # Supplemental Documents are uploaded files connected to an Entity during
39
- # onboarding.
39
+ # onboarding. Not all programs require supplemental documents.
40
40
  sig do
41
41
  params(
42
42
  created_at: Time,
@@ -425,8 +425,8 @@ module Increase
425
425
  )
426
426
  end
427
427
 
428
- # The identifier of the legal identifier. For US Employer Identification Numbers,
429
- # submit nine digits with no dashes or other separators.
428
+ # The legal identifier itself. For US Employer Identification Numbers, submit nine
429
+ # digits with no dashes or other separators.
430
430
  sig { returns(String) }
431
431
  attr_accessor :value
432
432
 
@@ -458,8 +458,8 @@ module Increase
458
458
  ).returns(T.attached_class)
459
459
  end
460
460
  def self.new(
461
- # The identifier of the legal identifier. For US Employer Identification Numbers,
462
- # submit nine digits with no dashes or other separators.
461
+ # The legal identifier itself. For US Employer Identification Numbers, submit nine
462
+ # digits with no dashes or other separators.
463
463
  value:,
464
464
  # The category of the legal identifier.
465
465
  category: nil
@@ -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,
@@ -18,7 +18,8 @@ module Increase
18
18
  sig { returns(String) }
19
19
  attr_accessor :account_id
20
20
 
21
- # The Lockbox Address where this Lockbox Recipient may receive mail.
21
+ # The Lockbox Address where this Lockbox Recipient may receive mail. The Lockbox
22
+ # Address must have a `status` of `active`.
22
23
  sig { returns(String) }
23
24
  attr_accessor :lockbox_address_id
24
25
 
@@ -48,7 +49,8 @@ module Increase
48
49
  def self.new(
49
50
  # The Account that checks sent to this Lockbox Recipient should be deposited into.
50
51
  account_id:,
51
- # The Lockbox Address where this Lockbox Recipient may receive mail.
52
+ # The Lockbox Address where this Lockbox Recipient may receive mail. The Lockbox
53
+ # Address must have a `status` of `active`.
52
54
  lockbox_address_id:,
53
55
  # The description you choose for the Lockbox Recipient.
54
56
  description: nil,
@@ -17,7 +17,10 @@ module Increase
17
17
  attr_accessor :account_id
18
18
 
19
19
  # The Pending Transaction amount in the minor unit of its currency. For dollars,
20
- # for example, this is cents.
20
+ # for example, this is cents. This amount does not change after the Pending
21
+ # Transaction is created. If a card authorization settles for a different amount,
22
+ # the settled amount is available on the resulting Transaction and on the Card
23
+ # Payment's `state.settled_amount`.
21
24
  sig { returns(Integer) }
22
25
  attr_accessor :amount
23
26
 
@@ -109,7 +112,10 @@ module Increase
109
112
  # The identifier for the account this Pending Transaction belongs to.
110
113
  account_id:,
111
114
  # The Pending Transaction amount in the minor unit of its currency. For dollars,
112
- # for example, this is cents.
115
+ # for example, this is cents. This amount does not change after the Pending
116
+ # Transaction is created. If a card authorization settles for a different amount,
117
+ # the settled amount is available on the resulting Transaction and on the Card
118
+ # Payment's `state.settled_amount`.
113
119
  amount:,
114
120
  # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Pending
115
121
  # Transaction was completed.
@@ -4982,7 +4988,7 @@ module Increase
4982
4988
  PENDING =
4983
4989
  T.let(:pending, Increase::PendingTransaction::Status::TaggedSymbol)
4984
4990
 
4985
- # 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.
4991
+ # 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.
4986
4992
  COMPLETE =
4987
4993
  T.let(:complete, Increase::PendingTransaction::Status::TaggedSymbol)
4988
4994
 
@@ -473,7 +473,7 @@ module Increase
473
473
  Increase::PendingTransactionListParams::Status::In::TaggedSymbol
474
474
  )
475
475
 
476
- # 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.
476
+ # 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.
477
477
  COMPLETE =
478
478
  T.let(
479
479
  :complete,
@@ -690,14 +690,21 @@ module Increase
690
690
  Increase::PhysicalCard::Shipment::Tracking::Update::Category::TaggedSymbol
691
691
  )
692
692
 
693
- # 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.
693
+ # 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.
694
694
  DELIVERY_ISSUE =
695
695
  T.let(
696
696
  :delivery_issue,
697
697
  Increase::PhysicalCard::Shipment::Tracking::Update::Category::TaggedSymbol
698
698
  )
699
699
 
700
- # Delivery failed and the physical card was returned to sender.
700
+ # The physical card has been rerouted to the return address.
701
+ RETURNING_TO_SENDER =
702
+ T.let(
703
+ :returning_to_sender,
704
+ Increase::PhysicalCard::Shipment::Tracking::Update::Category::TaggedSymbol
705
+ )
706
+
707
+ # The physical card has been delivered to the return address.
701
708
  RETURNED_TO_SENDER =
702
709
  T.let(
703
710
  :returned_to_sender,
@@ -988,6 +988,13 @@ module Increase
988
988
  Increase::RealTimePaymentsTransfer::Status::TaggedSymbol
989
989
  )
990
990
 
991
+ # The transfer is queued to be submitted to Real-Time Payments.
992
+ PENDING_SUBMISSION =
993
+ T.let(
994
+ :pending_submission,
995
+ Increase::RealTimePaymentsTransfer::Status::TaggedSymbol
996
+ )
997
+
991
998
  # The transfer is pending review by Increase.
992
999
  PENDING_REVIEWING =
993
1000
  T.let(
@@ -1009,13 +1016,6 @@ module Increase
1009
1016
  Increase::RealTimePaymentsTransfer::Status::TaggedSymbol
1010
1017
  )
1011
1018
 
1012
- # The transfer is queued to be submitted to Real-Time Payments.
1013
- PENDING_SUBMISSION =
1014
- T.let(
1015
- :pending_submission,
1016
- Increase::RealTimePaymentsTransfer::Status::TaggedSymbol
1017
- )
1018
-
1019
1019
  # The transfer has been submitted and is pending a response from Real-Time Payments.
1020
1020
  SUBMITTED =
1021
1021
  T.let(
@@ -293,6 +293,13 @@ module Increase
293
293
  Increase::RealTimePaymentsTransferListParams::Status::In::TaggedSymbol
294
294
  )
295
295
 
296
+ # The transfer is queued to be submitted to Real-Time Payments.
297
+ PENDING_SUBMISSION =
298
+ T.let(
299
+ :pending_submission,
300
+ Increase::RealTimePaymentsTransferListParams::Status::In::TaggedSymbol
301
+ )
302
+
296
303
  # The transfer is pending review by Increase.
297
304
  PENDING_REVIEWING =
298
305
  T.let(
@@ -314,13 +321,6 @@ module Increase
314
321
  Increase::RealTimePaymentsTransferListParams::Status::In::TaggedSymbol
315
322
  )
316
323
 
317
- # The transfer is queued to be submitted to Real-Time Payments.
318
- PENDING_SUBMISSION =
319
- T.let(
320
- :pending_submission,
321
- Increase::RealTimePaymentsTransferListParams::Status::In::TaggedSymbol
322
- )
323
-
324
324
  # The transfer has been submitted and is pending a response from Real-Time Payments.
325
325
  SUBMITTED =
326
326
  T.let(
@@ -71,7 +71,8 @@ module Increase
71
71
  sig { params(company_id: String).void }
72
72
  attr_writer :company_id
73
73
 
74
- # The name of the sender.
74
+ # The name of the sender. This corresponds to the `originator_company_name` field
75
+ # on the resulting Inbound ACH Transfer.
75
76
  sig { returns(T.nilable(String)) }
76
77
  attr_reader :company_name
77
78
 
@@ -154,7 +155,8 @@ module Increase
154
155
  company_entry_description: nil,
155
156
  # The sender's company ID.
156
157
  company_id: nil,
157
- # The name of the sender.
158
+ # The name of the sender. This corresponds to the `originator_company_name` field
159
+ # on the resulting Inbound ACH Transfer.
158
160
  company_name: nil,
159
161
  # The ID of the receiver of the transfer.
160
162
  receiver_id_number: nil,
@@ -27,14 +27,16 @@ module Increase
27
27
  sig { params(contents_file_id: String).void }
28
28
  attr_writer :contents_file_id
29
29
 
30
- # The identifier of the Lockbox Address to simulate inbound mail to.
30
+ # The identifier of the Lockbox Address to simulate inbound mail to. Exactly one
31
+ # lockbox identifier parameter must be provided.
31
32
  sig { returns(T.nilable(String)) }
32
33
  attr_reader :lockbox_address_id
33
34
 
34
35
  sig { params(lockbox_address_id: String).void }
35
36
  attr_writer :lockbox_address_id
36
37
 
37
- # The identifier of the Lockbox Recipient to simulate inbound mail to.
38
+ # The identifier of the Lockbox Recipient to simulate inbound mail to. Exactly one
39
+ # lockbox identifier parameter must be provided.
38
40
  sig { returns(T.nilable(String)) }
39
41
  attr_reader :lockbox_recipient_id
40
42
 
@@ -56,9 +58,11 @@ module Increase
56
58
  # The file containing the PDF contents. If not present, a default check image file
57
59
  # will be used.
58
60
  contents_file_id: nil,
59
- # The identifier of the Lockbox Address to simulate inbound mail to.
61
+ # The identifier of the Lockbox Address to simulate inbound mail to. Exactly one
62
+ # lockbox identifier parameter must be provided.
60
63
  lockbox_address_id: nil,
61
- # The identifier of the Lockbox Recipient to simulate inbound mail to.
64
+ # The identifier of the Lockbox Recipient to simulate inbound mail to. Exactly one
65
+ # lockbox identifier parameter must be provided.
62
66
  lockbox_recipient_id: nil,
63
67
  request_options: {}
64
68
  )
@@ -137,14 +137,21 @@ module Increase
137
137
  Increase::Simulations::PhysicalCardCreateParams::Category::TaggedSymbol
138
138
  )
139
139
 
140
- # 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.
140
+ # 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.
141
141
  DELIVERY_ISSUE =
142
142
  T.let(
143
143
  :delivery_issue,
144
144
  Increase::Simulations::PhysicalCardCreateParams::Category::TaggedSymbol
145
145
  )
146
146
 
147
- # Delivery failed and the physical card was returned to sender.
147
+ # The physical card has been rerouted to the return address.
148
+ RETURNING_TO_SENDER =
149
+ T.let(
150
+ :returning_to_sender,
151
+ Increase::Simulations::PhysicalCardCreateParams::Category::TaggedSymbol
152
+ )
153
+
154
+ # The physical card has been delivered to the return address.
148
155
  RETURNED_TO_SENDER =
149
156
  T.let(
150
157
  :returned_to_sender,
@@ -665,6 +665,13 @@ module Increase
665
665
  CANCELED =
666
666
  T.let(:canceled, Increase::SwiftTransfer::Status::TaggedSymbol)
667
667
 
668
+ # The transfer is pending initiation.
669
+ PENDING_INITIATING =
670
+ T.let(
671
+ :pending_initiating,
672
+ Increase::SwiftTransfer::Status::TaggedSymbol
673
+ )
674
+
668
675
  # The transfer is pending review by Increase.
669
676
  PENDING_REVIEWING =
670
677
  T.let(
@@ -679,13 +686,6 @@ module Increase
679
686
  Increase::SwiftTransfer::Status::TaggedSymbol
680
687
  )
681
688
 
682
- # The transfer is pending initiation.
683
- PENDING_INITIATING =
684
- T.let(
685
- :pending_initiating,
686
- Increase::SwiftTransfer::Status::TaggedSymbol
687
- )
688
-
689
689
  # The transfer has been initiated.
690
690
  INITIATED =
691
691
  T.let(:initiated, Increase::SwiftTransfer::Status::TaggedSymbol)
@@ -258,6 +258,13 @@ module Increase
258
258
  Increase::SwiftTransferListParams::Status::In::TaggedSymbol
259
259
  )
260
260
 
261
+ # The transfer is pending initiation.
262
+ PENDING_INITIATING =
263
+ T.let(
264
+ :pending_initiating,
265
+ Increase::SwiftTransferListParams::Status::In::TaggedSymbol
266
+ )
267
+
261
268
  # The transfer is pending review by Increase.
262
269
  PENDING_REVIEWING =
263
270
  T.let(
@@ -272,13 +279,6 @@ module Increase
272
279
  Increase::SwiftTransferListParams::Status::In::TaggedSymbol
273
280
  )
274
281
 
275
- # The transfer is pending initiation.
276
- PENDING_INITIATING =
277
- T.let(
278
- :pending_initiating,
279
- Increase::SwiftTransferListParams::Status::In::TaggedSymbol
280
- )
281
-
282
282
  # The transfer has been initiated.
283
283
  INITIATED =
284
284
  T.let(