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
@@ -56,7 +56,11 @@ module Increase
56
56
  # {Increase::Models::LockboxAddress} for more details.
57
57
  #
58
58
  # Lockbox Addresses are physical locations that can receive mail containing paper
59
- # checks.
59
+ # checks. A Lockbox Address is not itself linked to an Account; Lockbox Recipients
60
+ # determine where checks received at the address are deposited. Lockbox Addresses
61
+ # are created with a `pending` status and a null `address`. Increase generates the
62
+ # mailing address shortly after creation, at which point the status becomes
63
+ # `active`.
60
64
  #
61
65
  # @param id [String] The Lockbox Address identifier.
62
66
  #
@@ -14,7 +14,8 @@ module Increase
14
14
  required :account_id, String
15
15
 
16
16
  # @!attribute lockbox_address_id
17
- # The Lockbox Address where this Lockbox Recipient may receive mail.
17
+ # The Lockbox Address where this Lockbox Recipient may receive mail. The Lockbox
18
+ # Address must have a `status` of `active`.
18
19
  #
19
20
  # @return [String]
20
21
  required :lockbox_address_id, String
@@ -37,7 +38,7 @@ module Increase
37
38
  #
38
39
  # @param account_id [String] The Account that checks sent to this Lockbox Recipient should be deposited into.
39
40
  #
40
- # @param lockbox_address_id [String] The Lockbox Address where this Lockbox Recipient may receive mail.
41
+ # @param lockbox_address_id [String] The Lockbox Address where this Lockbox Recipient may receive mail. The Lockbox A
41
42
  #
42
43
  # @param description [String] The description you choose for the Lockbox Recipient.
43
44
  #
@@ -18,7 +18,10 @@ module Increase
18
18
 
19
19
  # @!attribute amount
20
20
  # The Pending Transaction amount in the minor unit of its currency. For dollars,
21
- # for example, this is cents.
21
+ # for example, this is cents. This amount does not change after the Pending
22
+ # Transaction is created. If a card authorization settles for a different amount,
23
+ # the settled amount is available on the resulting Transaction and on the Card
24
+ # Payment's `state.settled_amount`.
22
25
  #
23
26
  # @return [Integer]
24
27
  required :amount, Integer
@@ -2638,7 +2641,7 @@ module Increase
2638
2641
  # The Pending Transaction is still awaiting confirmation.
2639
2642
  PENDING = :pending
2640
2643
 
2641
- # 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.
2644
+ # 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.
2642
2645
  COMPLETE = :complete
2643
2646
 
2644
2647
  # @!method self.values
@@ -209,7 +209,7 @@ module Increase
209
209
  # The Pending Transaction is still awaiting confirmation.
210
210
  PENDING = :pending
211
211
 
212
- # 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.
212
+ # 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.
213
213
  COMPLETE = :complete
214
214
 
215
215
  # @!method self.values
@@ -431,10 +431,13 @@ module Increase
431
431
  # 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.
432
432
  DELIVERED = :delivered
433
433
 
434
- # 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.
434
+ # 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.
435
435
  DELIVERY_ISSUE = :delivery_issue
436
436
 
437
- # Delivery failed and the physical card was returned to sender.
437
+ # The physical card has been rerouted to the return address.
438
+ RETURNING_TO_SENDER = :returning_to_sender
439
+
440
+ # The physical card has been delivered to the return address.
438
441
  RETURNED_TO_SENDER = :returned_to_sender
439
442
 
440
443
  # @!method self.values
@@ -538,6 +538,9 @@ module Increase
538
538
  # The transfer has been canceled.
539
539
  CANCELED = :canceled
540
540
 
541
+ # The transfer is queued to be submitted to Real-Time Payments.
542
+ PENDING_SUBMISSION = :pending_submission
543
+
541
544
  # The transfer is pending review by Increase.
542
545
  PENDING_REVIEWING = :pending_reviewing
543
546
 
@@ -547,9 +550,6 @@ module Increase
547
550
  # The transfer was rejected by the network or the recipient's bank.
548
551
  REJECTED = :rejected
549
552
 
550
- # The transfer is queued to be submitted to Real-Time Payments.
551
- PENDING_SUBMISSION = :pending_submission
552
-
553
553
  # The transfer has been submitted and is pending a response from Real-Time Payments.
554
554
  SUBMITTED = :submitted
555
555
 
@@ -142,6 +142,9 @@ module Increase
142
142
  # The transfer has been canceled.
143
143
  CANCELED = :canceled
144
144
 
145
+ # The transfer is queued to be submitted to Real-Time Payments.
146
+ PENDING_SUBMISSION = :pending_submission
147
+
145
148
  # The transfer is pending review by Increase.
146
149
  PENDING_REVIEWING = :pending_reviewing
147
150
 
@@ -151,9 +154,6 @@ module Increase
151
154
  # The transfer was rejected by the network or the recipient's bank.
152
155
  REJECTED = :rejected
153
156
 
154
- # The transfer is queued to be submitted to Real-Time Payments.
155
- PENDING_SUBMISSION = :pending_submission
156
-
157
157
  # The transfer has been submitted and is pending a response from Real-Time Payments.
158
158
  SUBMITTED = :submitted
159
159
 
@@ -53,7 +53,8 @@ module Increase
53
53
  optional :company_id, String
54
54
 
55
55
  # @!attribute company_name
56
- # The name of the sender.
56
+ # The name of the sender. This corresponds to the `originator_company_name` field
57
+ # on the resulting Inbound ACH Transfer.
57
58
  #
58
59
  # @return [String, nil]
59
60
  optional :company_name, String
@@ -103,7 +104,7 @@ module Increase
103
104
  #
104
105
  # @param company_id [String] The sender's company ID.
105
106
  #
106
- # @param company_name [String] The name of the sender.
107
+ # @param company_name [String] The name of the sender. This corresponds to the `originator_company_name` field
107
108
  #
108
109
  # @param receiver_id_number [String] The ID of the receiver of the transfer.
109
110
  #
@@ -22,13 +22,15 @@ module Increase
22
22
  optional :contents_file_id, String
23
23
 
24
24
  # @!attribute lockbox_address_id
25
- # The identifier of the Lockbox Address to simulate inbound mail to.
25
+ # The identifier of the Lockbox Address to simulate inbound mail to. Exactly one
26
+ # lockbox identifier parameter must be provided.
26
27
  #
27
28
  # @return [String, nil]
28
29
  optional :lockbox_address_id, String
29
30
 
30
31
  # @!attribute lockbox_recipient_id
31
- # The identifier of the Lockbox Recipient to simulate inbound mail to.
32
+ # The identifier of the Lockbox Recipient to simulate inbound mail to. Exactly one
33
+ # lockbox identifier parameter must be provided.
32
34
  #
33
35
  # @return [String, nil]
34
36
  optional :lockbox_recipient_id, String
@@ -41,9 +43,9 @@ module Increase
41
43
  #
42
44
  # @param contents_file_id [String] The file containing the PDF contents. If not present, a default check image file
43
45
  #
44
- # @param lockbox_address_id [String] The identifier of the Lockbox Address to simulate inbound mail to.
46
+ # @param lockbox_address_id [String] The identifier of the Lockbox Address to simulate inbound mail to. Exactly one l
45
47
  #
46
- # @param lockbox_recipient_id [String] The identifier of the Lockbox Recipient to simulate inbound mail to.
48
+ # @param lockbox_recipient_id [String] The identifier of the Lockbox Recipient to simulate inbound mail to. Exactly one
47
49
  #
48
50
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
49
51
  end
@@ -76,10 +76,13 @@ module Increase
76
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.
77
77
  DELIVERED = :delivered
78
78
 
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 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.
80
80
  DELIVERY_ISSUE = :delivery_issue
81
81
 
82
- # 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.
83
86
  RETURNED_TO_SENDER = :returned_to_sender
84
87
 
85
88
  # @!method self.values
@@ -439,15 +439,15 @@ module Increase
439
439
  # The transfer has been canceled.
440
440
  CANCELED = :canceled
441
441
 
442
+ # The transfer is pending initiation.
443
+ PENDING_INITIATING = :pending_initiating
444
+
442
445
  # The transfer is pending review by Increase.
443
446
  PENDING_REVIEWING = :pending_reviewing
444
447
 
445
448
  # The transfer requires attention from an Increase operator.
446
449
  REQUIRES_ATTENTION = :requires_attention
447
450
 
448
- # The transfer is pending initiation.
449
- PENDING_INITIATING = :pending_initiating
450
-
451
451
  # The transfer has been initiated.
452
452
  INITIATED = :initiated
453
453
 
@@ -132,15 +132,15 @@ module Increase
132
132
  # The transfer has been canceled.
133
133
  CANCELED = :canceled
134
134
 
135
+ # The transfer is pending initiation.
136
+ PENDING_INITIATING = :pending_initiating
137
+
135
138
  # The transfer is pending review by Increase.
136
139
  PENDING_REVIEWING = :pending_reviewing
137
140
 
138
141
  # The transfer requires attention from an Increase operator.
139
142
  REQUIRES_ATTENTION = :requires_attention
140
143
 
141
- # The transfer is pending initiation.
142
- PENDING_INITIATING = :pending_initiating
143
-
144
144
  # The transfer has been initiated.
145
145
  INITIATED = :initiated
146
146
 
@@ -202,7 +202,8 @@ module Increase
202
202
  # Return is created when an ACH Transfer is returned by the receiving bank. It
203
203
  # offsets the ACH Transfer Intention. ACH Transfer Returns usually occur within
204
204
  # the first two business days after the transfer is initiated, but can occur much
205
- # later.
205
+ # later. The return appears as a new posted Transaction; no Pending Transaction is
206
+ # created.
206
207
  #
207
208
  # @return [Increase::Models::Transaction::Source::ACHTransferReturn, nil]
208
209
  optional :ach_transfer_return, -> { Increase::Transaction::Source::ACHTransferReturn }, nil?: true
@@ -977,7 +978,8 @@ module Increase
977
978
  required :transaction_id, String
978
979
 
979
980
  # @!attribute transfer_id
980
- # The identifier of the ACH Transfer associated with this return.
981
+ # The identifier of the ACH Transfer associated with this return. This matches the
982
+ # original Transaction's `source.ach_transfer_intention.transfer_id`.
981
983
  #
982
984
  # @return [String]
983
985
  required :transfer_id, String
@@ -991,7 +993,8 @@ module Increase
991
993
  # Return is created when an ACH Transfer is returned by the receiving bank. It
992
994
  # offsets the ACH Transfer Intention. ACH Transfer Returns usually occur within
993
995
  # the first two business days after the transfer is initiated, but can occur much
994
- # later.
996
+ # later. The return appears as a new posted Transaction; no Pending Transaction is
997
+ # created.
995
998
  #
996
999
  # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
997
1000
  #
@@ -1003,7 +1006,7 @@ module Increase
1003
1006
  #
1004
1007
  # @param transaction_id [String] The identifier of the Transaction associated with this return.
1005
1008
  #
1006
- # @param transfer_id [String] The identifier of the ACH Transfer associated with this return.
1009
+ # @param transfer_id [String] The identifier of the ACH Transfer associated with this return. This matches the
1007
1010
 
1008
1011
  # Why the ACH Transfer was returned. This reason code is sent by the receiving
1009
1012
  # bank back to Increase.
@@ -777,6 +777,9 @@ module Increase
777
777
  # The transfer has been canceled.
778
778
  CANCELED = :canceled
779
779
 
780
+ # The transfer is pending creation.
781
+ PENDING_CREATING = :pending_creating
782
+
780
783
  # The transfer is pending review by Increase.
781
784
  PENDING_REVIEWING = :pending_reviewing
782
785
 
@@ -786,9 +789,6 @@ module Increase
786
789
  # The transfer requires attention from an Increase operator.
787
790
  REQUIRES_ATTENTION = :requires_attention
788
791
 
789
- # The transfer is pending creation.
790
- PENDING_CREATING = :pending_creating
791
-
792
792
  # The transfer has been reversed.
793
793
  REVERSED = :reversed
794
794
 
@@ -138,6 +138,9 @@ module Increase
138
138
  # The transfer has been canceled.
139
139
  CANCELED = :canceled
140
140
 
141
+ # The transfer is pending creation.
142
+ PENDING_CREATING = :pending_creating
143
+
141
144
  # The transfer is pending review by Increase.
142
145
  PENDING_REVIEWING = :pending_reviewing
143
146
 
@@ -147,9 +150,6 @@ module Increase
147
150
  # The transfer requires attention from an Increase operator.
148
151
  REQUIRES_ATTENTION = :requires_attention
149
152
 
150
- # The transfer is pending creation.
151
- PENDING_CREATING = :pending_creating
152
-
153
153
  # The transfer has been reversed.
154
154
  REVERSED = :reversed
155
155
 
@@ -20,7 +20,7 @@ module Increase
20
20
  #
21
21
  # @param loan [Increase::Models::AccountCreateParams::Loan] The loan details for the account.
22
22
  #
23
- # @param program_id [String] The identifier for the Program that this Account falls under. Required if you op
23
+ # @param program_id [String] The identifier for the Program that this Account falls under. Required if your G
24
24
  #
25
25
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
26
26
  #
@@ -16,25 +16,25 @@ module Increase
16
16
  #
17
17
  # @param statement_descriptor [String] A description you choose to give the transfer. This will be saved with the trans
18
18
  #
19
- # @param account_number [String] The account number for the destination account.
19
+ # @param account_number [String] The receiver's account number. For credit transfers (positive `amount`) this is
20
20
  #
21
- # @param addenda [Increase::Models::ACHTransferCreateParams::Addenda] Additional information that will be sent to the recipient. This is included in t
21
+ # @param addenda [Increase::Models::ACHTransferCreateParams::Addenda] Additional information passed through to the receiving bank with the transfer. M
22
22
  #
23
- # @param company_descriptive_date [String] The description of the date of the transfer, usually in the format `YYMMDD`. Thi
23
+ # @param company_descriptive_date [String] A description of the transfer date (typically `YYMMDD`), sent in the company bat
24
24
  #
25
- # @param company_discretionary_data [String] The data you choose to associate with the transfer. This is included in the tran
25
+ # @param company_discretionary_data [String] Custom data sent in the company batch header. This value is informational and do
26
26
  #
27
- # @param company_entry_description [String] A description of the transfer, included in the transfer data sent to the receivi
27
+ # @param company_entry_description [String] A short description sent in the company batch header. Most receivers do not surf
28
28
  #
29
- # @param company_name [String] The name by which the recipient knows you. This is included in the transfer data
29
+ # @param company_name [String] The name by which the recipient knows you, sent in the company batch header. We
30
30
  #
31
- # @param destination_account_holder [Symbol, Increase::Models::ACHTransferCreateParams::DestinationAccountHolder] The type of entity that owns the account to which the ACH Transfer is being sent
31
+ # @param destination_account_holder [Symbol, Increase::Models::ACHTransferCreateParams::DestinationAccountHolder] The type of entity that owns the receiver's account.
32
32
  #
33
33
  # @param external_account_id [String] The ID of an External Account to initiate a transfer to. If this parameter is pr
34
34
  #
35
- # @param funding [Symbol, Increase::Models::ACHTransferCreateParams::Funding] The type of the account to which the transfer will be sent.
35
+ # @param funding [Symbol, Increase::Models::ACHTransferCreateParams::Funding] The type of the receiver's bank account.
36
36
  #
37
- # @param individual_id [String] Your identifier for the transfer recipient.
37
+ # @param individual_id [String] Your internal identifier for the transfer recipient. This value is informational
38
38
  #
39
39
  # @param individual_name [String] The name of the transfer recipient. This value is informational and not verified
40
40
  #
@@ -42,7 +42,7 @@ module Increase
42
42
  #
43
43
  # @param require_approval [Boolean] Whether the transfer requires explicit approval via the dashboard or API.
44
44
  #
45
- # @param routing_number [String] The American Bankers' Association (ABA) Routing Transit Number (RTN) for the des
45
+ # @param routing_number [String] The American Bankers' Association (ABA) Routing Transit Number (RTN) of the rece
46
46
  #
47
47
  # @param standard_entry_class_code [Symbol, Increase::Models::ACHTransferCreateParams::StandardEntryClassCode] The [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-co
48
48
  #
@@ -58,7 +58,9 @@ module Increase
58
58
  )
59
59
  end
60
60
 
61
- # Action an Inbound Mail Item
61
+ # Deposits or ignores each check contained in a pending Inbound Mail Item.
62
+ # Depositing a check creates a [Check Deposit](#check-deposits) into the Account
63
+ # you specify.
62
64
  #
63
65
  # @overload action(inbound_mail_item_id, checks:, request_options: {})
64
66
  #
@@ -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
  #
8
11
  # @overload create(description: nil, request_options: {})
9
12
  #
@@ -12,7 +12,7 @@ module Increase
12
12
  #
13
13
  # @param account_id [String] The Account that checks sent to this Lockbox Recipient should be deposited into.
14
14
  #
15
- # @param lockbox_address_id [String] The Lockbox Address where this Lockbox Recipient may receive mail.
15
+ # @param lockbox_address_id [String] The Lockbox Address where this Lockbox Recipient may receive mail. The Lockbox A
16
16
  #
17
17
  # @param description [String] The description you choose for the Lockbox Recipient.
18
18
  #
@@ -13,7 +13,10 @@ module Increase
13
13
  # `card_authorization` or a [Declined Transaction](#declined-transactions) of type
14
14
  # `card_decline`. You can pass either a Card id or a
15
15
  # [Digital Wallet Token](#digital-wallet-tokens) id to simulate the two different
16
- # ways purchases can be made.
16
+ # ways purchases can be made. The response will contain either a
17
+ # `pending_transaction` or a `declined_transaction`; the other attribute will be
18
+ # null. If the authorization is declined, the reason is available on the Declined
19
+ # Transaction at `source.card_decline.reason`.
17
20
  #
18
21
  # @overload create(amount:, authenticated_card_payment_id: nil, card_id: nil, decline_reason: nil, digital_wallet_token_id: nil, event_subscription_id: nil, merchant_acceptor_id: nil, merchant_category_code: nil, merchant_city: nil, merchant_country: nil, merchant_descriptor: nil, merchant_state: nil, network_details: nil, network_risk_score: nil, physical_card_id: nil, processing_category: nil, terminal_id: nil, request_options: {})
19
22
  #
@@ -35,7 +35,7 @@ module Increase
35
35
  #
36
36
  # @param company_id [String] The sender's company ID.
37
37
  #
38
- # @param company_name [String] The name of the sender.
38
+ # @param company_name [String] The name of the sender. This corresponds to the `originator_company_name` field
39
39
  #
40
40
  # @param receiver_id_number [String] The ID of the receiver of the transfer.
41
41
  #
@@ -8,7 +8,10 @@ module Increase
8
8
  # {Increase::Models::Simulations::InboundMailItemCreateParams} for more details.
9
9
  #
10
10
  # Simulates an Inbound Mail Item to one of your Lockbox Addresses or Lockbox
11
- # Recipients, as if someone had mailed a physical check.
11
+ # Recipients, as if someone had mailed a physical check. Increase automatically
12
+ # deposits a check mailed to a Lockbox Recipient into the recipient's Account. A
13
+ # check mailed to a Lockbox Address must be deposited or ignored with the
14
+ # [Action an Inbound Mail Item](#inbound-mail-items) endpoint.
12
15
  #
13
16
  # @overload create(amount:, contents_file_id: nil, lockbox_address_id: nil, lockbox_recipient_id: nil, request_options: {})
14
17
  #
@@ -16,9 +19,9 @@ module Increase
16
19
  #
17
20
  # @param contents_file_id [String] The file containing the PDF contents. If not present, a default check image file
18
21
  #
19
- # @param lockbox_address_id [String] The identifier of the Lockbox Address to simulate inbound mail to.
22
+ # @param lockbox_address_id [String] The identifier of the Lockbox Address to simulate inbound mail to. Exactly one l
20
23
  #
21
- # @param lockbox_recipient_id [String] The identifier of the Lockbox Recipient to simulate inbound mail to.
24
+ # @param lockbox_recipient_id [String] The identifier of the Lockbox Recipient to simulate inbound mail to. Exactly one
22
25
  #
23
26
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
24
27
  #
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Increase
4
- VERSION = "1.338.0"
4
+ VERSION = "1.339.0"
5
5
  end
@@ -48,8 +48,9 @@ module Increase
48
48
  sig { params(loan: Increase::AccountCreateParams::Loan::OrHash).void }
49
49
  attr_writer :loan
50
50
 
51
- # The identifier for the Program that this Account falls under. Required if you
52
- # operate more than one Program.
51
+ # The identifier for the Program that this Account falls under. Required if your
52
+ # Group operates more than one Program. List your [Programs](#programs) to find
53
+ # their identifiers.
53
54
  sig { returns(T.nilable(String)) }
54
55
  attr_reader :program_id
55
56
 
@@ -79,8 +80,9 @@ module Increase
79
80
  informational_entity_id: nil,
80
81
  # The loan details for the account.
81
82
  loan: nil,
82
- # The identifier for the Program that this Account falls under. Required if you
83
- # operate more than one Program.
83
+ # The identifier for the Program that this Account falls under. Required if your
84
+ # Group operates more than one Program. List your [Programs](#programs) to find
85
+ # their identifiers.
84
86
  program_id: nil,
85
87
  request_options: {}
86
88
  )
@@ -16,7 +16,7 @@ module Increase
16
16
  sig { returns(String) }
17
17
  attr_accessor :account_id
18
18
 
19
- # The destination account number.
19
+ # The receiver's account number.
20
20
  sig { returns(String) }
21
21
  attr_accessor :account_number
22
22
 
@@ -114,8 +114,7 @@ module Increase
114
114
  sig { returns(Increase::ACHTransfer::Currency::TaggedSymbol) }
115
115
  attr_accessor :currency
116
116
 
117
- # The type of entity that owns the account to which the ACH Transfer is being
118
- # sent.
117
+ # The type of entity that owns the receiver's account.
119
118
  sig do
120
119
  returns(Increase::ACHTransfer::DestinationAccountHolder::TaggedSymbol)
121
120
  end
@@ -125,7 +124,7 @@ module Increase
125
124
  sig { returns(T.nilable(String)) }
126
125
  attr_accessor :external_account_id
127
126
 
128
- # The type of the account to which the transfer will be sent.
127
+ # The type of the receiver's bank account.
129
128
  sig { returns(Increase::ACHTransfer::Funding::TaggedSymbol) }
130
129
  attr_accessor :funding
131
130
 
@@ -148,7 +147,8 @@ module Increase
148
147
  end
149
148
  attr_writer :inbound_funds_hold
150
149
 
151
- # Your identifier for the transfer recipient.
150
+ # Your internal identifier for the transfer recipient. This value is informational
151
+ # and not verified by the recipient's bank.
152
152
  sig { returns(T.nilable(String)) }
153
153
  attr_accessor :individual_id
154
154
 
@@ -197,7 +197,8 @@ module Increase
197
197
  end
198
198
  attr_writer :return_
199
199
 
200
- # The American Bankers' Association (ABA) Routing Transit Number (RTN).
200
+ # The American Bankers' Association (ABA) Routing Transit Number (RTN) of the
201
+ # receiver's bank.
201
202
  sig { returns(String) }
202
203
  attr_accessor :routing_number
203
204
 
@@ -306,7 +307,7 @@ module Increase
306
307
  id:,
307
308
  # The Account to which the transfer belongs.
308
309
  account_id:,
309
- # The destination account number.
310
+ # The receiver's account number.
310
311
  account_number:,
311
312
  # After the transfer is acknowledged by FedACH, this will contain supplemental
312
313
  # details. The Federal Reserve sends an acknowledgement message for each file that
@@ -342,12 +343,11 @@ module Increase
342
343
  # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's
343
344
  # currency. For ACH transfers this is always equal to `usd`.
344
345
  currency:,
345
- # The type of entity that owns the account to which the ACH Transfer is being
346
- # sent.
346
+ # The type of entity that owns the receiver's account.
347
347
  destination_account_holder:,
348
348
  # The identifier of the External Account the transfer was made to, if any.
349
349
  external_account_id:,
350
- # The type of the account to which the transfer will be sent.
350
+ # The type of the receiver's bank account.
351
351
  funding:,
352
352
  # The idempotency key you chose for this object. This value is unique across
353
353
  # Increase and is used to ensure that a request is only processed once. Learn more
@@ -356,7 +356,8 @@ module Increase
356
356
  # Increase will sometimes hold the funds for ACH debit transfers. If funds are
357
357
  # held, this sub-object will contain details of the hold.
358
358
  inbound_funds_hold:,
359
- # Your identifier for the transfer recipient.
359
+ # Your internal identifier for the transfer recipient. This value is informational
360
+ # and not verified by the recipient's bank.
360
361
  individual_id:,
361
362
  # The name of the transfer recipient. This value is informational and not verified
362
363
  # by the recipient's bank.
@@ -378,7 +379,8 @@ module Increase
378
379
  preferred_effective_date:,
379
380
  # If your transfer is returned, this will contain details of the return.
380
381
  return_:,
381
- # The American Bankers' Association (ABA) Routing Transit Number (RTN).
382
+ # The American Bankers' Association (ABA) Routing Transit Number (RTN) of the
383
+ # receiver's bank.
382
384
  routing_number:,
383
385
  # A subhash containing information about when and how the transfer settled at the
384
386
  # Federal Reserve.
@@ -1088,8 +1090,7 @@ module Increase
1088
1090
  end
1089
1091
  end
1090
1092
 
1091
- # The type of entity that owns the account to which the ACH Transfer is being
1092
- # sent.
1093
+ # The type of entity that owns the receiver's account.
1093
1094
  module DestinationAccountHolder
1094
1095
  extend Increase::Internal::Type::Enum
1095
1096
 
@@ -1131,7 +1132,7 @@ module Increase
1131
1132
  end
1132
1133
  end
1133
1134
 
1134
- # The type of the account to which the transfer will be sent.
1135
+ # The type of the receiver's bank account.
1135
1136
  module Funding
1136
1137
  extend Increase::Internal::Type::Enum
1137
1138
 
@@ -1781,7 +1782,7 @@ module Increase
1781
1782
  # The chosen effective date will be the same as the ACH processing date on which the transfer is submitted.
1782
1783
  # This is necessary, but not sufficient for the transfer to be settled same-day:
1783
1784
  # it must also be submitted before the last same-day cutoff
1784
- # and be less than or equal to $1,000.000.00.
1785
+ # and be less than or equal to $1,000,000.00.
1785
1786
  SAME_DAY =
1786
1787
  T.let(
1787
1788
  :same_day,
@@ -1840,7 +1841,8 @@ module Increase
1840
1841
  sig { returns(String) }
1841
1842
  attr_accessor :transaction_id
1842
1843
 
1843
- # The identifier of the ACH Transfer associated with this return.
1844
+ # The identifier of the ACH Transfer associated with this return. This matches the
1845
+ # original Transaction's `source.ach_transfer_intention.transfer_id`.
1844
1846
  sig { returns(String) }
1845
1847
  attr_accessor :transfer_id
1846
1848
 
@@ -1872,7 +1874,8 @@ module Increase
1872
1874
  trace_number:,
1873
1875
  # The identifier of the Transaction associated with this return.
1874
1876
  transaction_id:,
1875
- # The identifier of the ACH Transfer associated with this return.
1877
+ # The identifier of the ACH Transfer associated with this return. This matches the
1878
+ # original Transaction's `source.ach_transfer_intention.transfer_id`.
1876
1879
  transfer_id:
1877
1880
  )
1878
1881
  end
@@ -2529,7 +2532,7 @@ module Increase
2529
2532
  # The transfer has been rejected.
2530
2533
  REJECTED = T.let(:rejected, Increase::ACHTransfer::Status::TaggedSymbol)
2531
2534
 
2532
- # The transfer is complete.
2535
+ # The transfer has been submitted to the Federal Reserve. When the transfer settles, the status remains `submitted` and the `settlement` sub-object is populated.
2533
2536
  SUBMITTED =
2534
2537
  T.let(:submitted, Increase::ACHTransfer::Status::TaggedSymbol)
2535
2538