increase 1.366.0 → 1.367.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 (31) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/increase/models/ach_transfer.rb +6 -6
  4. data/lib/increase/models/card_dispute.rb +131 -2
  5. data/lib/increase/models/card_dispute_create_params.rb +20 -16
  6. data/lib/increase/models/card_dispute_provide_provisional_credit_params.rb +22 -0
  7. data/lib/increase/models/card_dispute_reverse_provisional_credit_params.rb +22 -0
  8. data/lib/increase/models/simulations/card_refund_create_params.rb +6 -6
  9. data/lib/increase/models/simulations/inbound_ach_transfer_create_params.rb +3 -0
  10. data/lib/increase/models.rb +4 -0
  11. data/lib/increase/resources/card_disputes.rb +50 -6
  12. data/lib/increase/resources/simulations/card_refunds.rb +3 -3
  13. data/lib/increase/version.rb +1 -1
  14. data/lib/increase.rb +2 -0
  15. data/rbi/increase/models/ach_transfer.rbi +6 -6
  16. data/rbi/increase/models/card_dispute.rbi +188 -0
  17. data/rbi/increase/models/card_dispute_create_params.rbi +20 -16
  18. data/rbi/increase/models/card_dispute_provide_provisional_credit_params.rbi +43 -0
  19. data/rbi/increase/models/card_dispute_reverse_provisional_credit_params.rbi +43 -0
  20. data/rbi/increase/models/simulations/card_refund_create_params.rbi +6 -6
  21. data/rbi/increase/models/simulations/inbound_ach_transfer_create_params.rbi +3 -0
  22. data/rbi/increase/models.rbi +6 -0
  23. data/rbi/increase/resources/card_disputes.rbi +38 -6
  24. data/rbi/increase/resources/simulations/card_refunds.rbi +3 -3
  25. data/sig/increase/models/ach_transfer.rbs +8 -8
  26. data/sig/increase/models/card_dispute.rbs +79 -0
  27. data/sig/increase/models/card_dispute_provide_provisional_credit_params.rbs +23 -0
  28. data/sig/increase/models/card_dispute_reverse_provisional_credit_params.rbs +23 -0
  29. data/sig/increase/models.rbs +4 -0
  30. data/sig/increase/resources/card_disputes.rbs +10 -0
  31. metadata +8 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 211fbbf6b1a0858edc8134c95ebc037a7c2bc1405a8ba477a5be65448d26b31d
4
- data.tar.gz: 1321070823bdb7946cd8b217f2f28d3e28d64680068da7d6d4aafb7d1ec06baf
3
+ metadata.gz: 98e0ff963d3d275e9d524bc177b51d7d3367250d023e03ecb1297e047f6d91d9
4
+ data.tar.gz: bd91efc473f5df56ffa23baa5cb7989e9cf2a415b0c7c20a427e122b242922f6
5
5
  SHA512:
6
- metadata.gz: adf93ef36b26aebaacb0da3eab1170c8b811ee7f4828c997e676a4d363cab599d0e253fe3ca1ba80d8c661e9d244791826a206559ba71cb82ff9540ce03ef913
7
- data.tar.gz: 8723b388931f436101d86574b44cdcce5546812ad8e66a02d12db48331dee3eb4465435d7a3af5ed601b43592f45935cfcecaef175de606e21a1737b0ff833e9
6
+ metadata.gz: 6fcf7d6a933dd0d04acb9bee822fe14370a062f3d9ddf1bf57ec7c066b2c066a93dd5c6237dc81792988b05751a89da5e9cdd3e29d5ad04cf2bdd33d081dacfd
7
+ data.tar.gz: 2097487a3b63b2661a217b04ea67c7902b134fd1730e68b7342e97d25f873ac4a842005452414cc7051558bc0f1a657687c714de4d6cf7e830a787cc21d08de4
data/README.md CHANGED
@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
15
15
  <!-- x-release-please-start-version -->
16
16
 
17
17
  ```ruby
18
- gem "increase", "~> 1.366.0"
18
+ gem "increase", "~> 1.367.0"
19
19
  ```
20
20
 
21
21
  <!-- x-release-please-end -->
@@ -94,8 +94,8 @@ module Increase
94
94
  # @!attribute company_name
95
95
  # The name by which the recipient knows you.
96
96
  #
97
- # @return [String, nil]
98
- required :company_name, String, nil?: true
97
+ # @return [String]
98
+ required :company_name, String
99
99
 
100
100
  # @!attribute created_at
101
101
  # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
@@ -161,8 +161,8 @@ module Increase
161
161
  # The name of the transfer recipient. This value is informational and not verified
162
162
  # by the recipient's bank.
163
163
  #
164
- # @return [String, nil]
165
- required :individual_name, String, nil?: true
164
+ # @return [String]
165
+ required :individual_name, String
166
166
 
167
167
  # @!attribute network
168
168
  # The transfer's network.
@@ -312,7 +312,7 @@ module Increase
312
312
  # to debit their accounts. This value is configured by Increase and will be the
313
313
  # same for all your transfers.
314
314
  #
315
- # @param company_name [String, nil] The name by which the recipient knows you.
315
+ # @param company_name [String] The name by which the recipient knows you.
316
316
  #
317
317
  # @param created_at [Time]
318
318
  # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
@@ -346,7 +346,7 @@ module Increase
346
346
  # Your internal identifier for the transfer recipient. This value is informational
347
347
  # and not verified by the recipient's bank.
348
348
  #
349
- # @param individual_name [String, nil]
349
+ # @param individual_name [String]
350
350
  # The name of the transfer recipient. This value is informational and not verified
351
351
  # by the recipient's bank.
352
352
  #
@@ -62,6 +62,13 @@ module Increase
62
62
  # @return [Symbol, Increase::Models::CardDispute::Network]
63
63
  required :network, enum: -> { Increase::CardDispute::Network }
64
64
 
65
+ # @!attribute provisional_credit
66
+ # If a provisional credit has been provided for the Card Dispute, this will
67
+ # contain details of the provisional credit.
68
+ #
69
+ # @return [Increase::Models::CardDispute::ProvisionalCredit, nil]
70
+ required :provisional_credit, -> { Increase::CardDispute::ProvisionalCredit }, nil?: true
71
+
65
72
  # @!attribute rejection
66
73
  # If the Card Dispute has been rejected, this will contain details of the
67
74
  # rejection.
@@ -113,7 +120,7 @@ module Increase
113
120
  # @return [Increase::Models::CardDispute::Withdrawal, nil]
114
121
  required :withdrawal, -> { Increase::CardDispute::Withdrawal }, nil?: true
115
122
 
116
- # @!method initialize(id:, account_id:, amount:, card_id:, created_at:, disputed_transaction_id:, idempotency_key:, loss:, network:, rejection:, status:, type:, user_submission_required_by:, visa:, win:, withdrawal:)
123
+ # @!method initialize(id:, account_id:, amount:, card_id:, created_at:, disputed_transaction_id:, idempotency_key:, loss:, network:, provisional_credit:, rejection:, status:, type:, user_submission_required_by:, visa:, win:, withdrawal:)
117
124
  # If unauthorized activity occurs on a card, you can create a Card Dispute and
118
125
  # we'll work with the card networks to return the funds if appropriate. For more
119
126
  # information, see our guide on
@@ -145,6 +152,10 @@ module Increase
145
152
  # @param network [Symbol, Increase::Models::CardDispute::Network]
146
153
  # The network that the Card Dispute is associated with.
147
154
  #
155
+ # @param provisional_credit [Increase::Models::CardDispute::ProvisionalCredit, nil]
156
+ # If a provisional credit has been provided for the Card Dispute, this will
157
+ # contain details of the provisional credit.
158
+ #
148
159
  # @param rejection [Increase::Models::CardDispute::Rejection, nil]
149
160
  # If the Card Dispute has been rejected, this will contain details of the
150
161
  # rejection.
@@ -232,6 +243,115 @@ module Increase
232
243
  # @return [Array<Symbol>]
233
244
  end
234
245
 
246
+ # @see Increase::Models::CardDispute#provisional_credit
247
+ class ProvisionalCredit < Increase::Internal::Type::BaseModel
248
+ # @!attribute amount
249
+ # The amount of the provisional credit in the minor unit of its currency. For
250
+ # dollars, for example, this is cents.
251
+ #
252
+ # @return [Integer]
253
+ required :amount, Integer
254
+
255
+ # @!attribute cardholder_account_transaction_id
256
+ # The identifier of the Transaction that credited the cardholder's Account.
257
+ #
258
+ # @return [String]
259
+ required :cardholder_account_transaction_id, String
260
+
261
+ # @!attribute provided_at
262
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
263
+ # the provisional credit was provided.
264
+ #
265
+ # @return [Time]
266
+ required :provided_at, Time
267
+
268
+ # @!attribute provisional_credit_funding_account_transaction_id
269
+ # The identifier of the Transaction that debited the provisional credit funding
270
+ # Account.
271
+ #
272
+ # @return [String]
273
+ required :provisional_credit_funding_account_transaction_id, String
274
+
275
+ # @!attribute reversal
276
+ # If the provisional credit has been reversed, this will contain details of the
277
+ # reversal.
278
+ #
279
+ # @return [Increase::Models::CardDispute::ProvisionalCredit::Reversal, nil]
280
+ required :reversal, -> { Increase::CardDispute::ProvisionalCredit::Reversal }, nil?: true
281
+
282
+ # @!method initialize(amount:, cardholder_account_transaction_id:, provided_at:, provisional_credit_funding_account_transaction_id:, reversal:)
283
+ # If a provisional credit has been provided for the Card Dispute, this will
284
+ # contain details of the provisional credit.
285
+ #
286
+ # @param amount [Integer]
287
+ # The amount of the provisional credit in the minor unit of its currency. For
288
+ # dollars, for example, this is cents.
289
+ #
290
+ # @param cardholder_account_transaction_id [String]
291
+ # The identifier of the Transaction that credited the cardholder's Account.
292
+ #
293
+ # @param provided_at [Time]
294
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
295
+ # the provisional credit was provided.
296
+ #
297
+ # @param provisional_credit_funding_account_transaction_id [String]
298
+ # The identifier of the Transaction that debited the provisional credit funding
299
+ # Account.
300
+ #
301
+ # @param reversal [Increase::Models::CardDispute::ProvisionalCredit::Reversal, nil]
302
+ # If the provisional credit has been reversed, this will contain details of the
303
+ # reversal.
304
+
305
+ # @see Increase::Models::CardDispute::ProvisionalCredit#reversal
306
+ class Reversal < Increase::Internal::Type::BaseModel
307
+ # @!attribute amount
308
+ # The amount of the reversal in the minor unit of its currency. For dollars, for
309
+ # example, this is cents.
310
+ #
311
+ # @return [Integer]
312
+ required :amount, Integer
313
+
314
+ # @!attribute cardholder_account_transaction_id
315
+ # The identifier of the Transaction that debited the cardholder's Account.
316
+ #
317
+ # @return [String]
318
+ required :cardholder_account_transaction_id, String
319
+
320
+ # @!attribute provisional_credit_funding_account_transaction_id
321
+ # The identifier of the Transaction that credited the provisional credit funding
322
+ # Account.
323
+ #
324
+ # @return [String]
325
+ required :provisional_credit_funding_account_transaction_id, String
326
+
327
+ # @!attribute reversed_at
328
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
329
+ # the provisional credit was reversed.
330
+ #
331
+ # @return [Time]
332
+ required :reversed_at, Time
333
+
334
+ # @!method initialize(amount:, cardholder_account_transaction_id:, provisional_credit_funding_account_transaction_id:, reversed_at:)
335
+ # If the provisional credit has been reversed, this will contain details of the
336
+ # reversal.
337
+ #
338
+ # @param amount [Integer]
339
+ # The amount of the reversal in the minor unit of its currency. For dollars, for
340
+ # example, this is cents.
341
+ #
342
+ # @param cardholder_account_transaction_id [String]
343
+ # The identifier of the Transaction that debited the cardholder's Account.
344
+ #
345
+ # @param provisional_credit_funding_account_transaction_id [String]
346
+ # The identifier of the Transaction that credited the provisional credit funding
347
+ # Account.
348
+ #
349
+ # @param reversed_at [Time]
350
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
351
+ # the provisional credit was reversed.
352
+ end
353
+ end
354
+
235
355
  # @see Increase::Models::CardDispute#rejection
236
356
  class Rejection < Increase::Internal::Type::BaseModel
237
357
  # @!attribute explanation
@@ -370,6 +490,12 @@ module Increase
370
490
  # @return [Time]
371
491
  required :created_at, Time
372
492
 
493
+ # @!attribute dispute_financial_account_id
494
+ # The account the dispute financial transaction was posted to, if any.
495
+ #
496
+ # @return [String, nil]
497
+ required :dispute_financial_account_id, String, nil?: true
498
+
373
499
  # @!attribute dispute_financial_transaction_id
374
500
  # The dispute financial transaction that resulted from the network event, if any.
375
501
  #
@@ -532,7 +658,7 @@ module Increase
532
658
  -> { Increase::CardDispute::Visa::NetworkEvent::UserWithdrawalSubmitted },
533
659
  nil?: true
534
660
 
535
- # @!method initialize(attachment_files:, category:, created_at:, dispute_financial_transaction_id:, chargeback_accepted: nil, chargeback_submitted: nil, chargeback_timed_out: nil, merchant_prearbitration_decline_submitted: nil, merchant_prearbitration_received: nil, merchant_prearbitration_timed_out: nil, represented: nil, representment_timed_out: nil, user_prearbitration_accepted: nil, user_prearbitration_declined: nil, user_prearbitration_submitted: nil, user_prearbitration_timed_out: nil, user_withdrawal_submitted: nil)
661
+ # @!method initialize(attachment_files:, category:, created_at:, dispute_financial_account_id:, dispute_financial_transaction_id:, chargeback_accepted: nil, chargeback_submitted: nil, chargeback_timed_out: nil, merchant_prearbitration_decline_submitted: nil, merchant_prearbitration_received: nil, merchant_prearbitration_timed_out: nil, represented: nil, representment_timed_out: nil, user_prearbitration_accepted: nil, user_prearbitration_declined: nil, user_prearbitration_submitted: nil, user_prearbitration_timed_out: nil, user_withdrawal_submitted: nil)
536
662
  # @param attachment_files [Array<Increase::Models::CardDispute::Visa::NetworkEvent::AttachmentFile>]
537
663
  # The files attached to the Visa Card Dispute User Submission.
538
664
  #
@@ -545,6 +671,9 @@ module Increase
545
671
  # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
546
672
  # the Visa Card Dispute Network Event was created.
547
673
  #
674
+ # @param dispute_financial_account_id [String, nil]
675
+ # The account the dispute financial transaction was posted to, if any.
676
+ #
548
677
  # @param dispute_financial_transaction_id [String, nil]
549
678
  # The dispute financial transaction that resulted from the network event, if any.
550
679
  #
@@ -15,8 +15,8 @@ module Increase
15
15
  required :disputed_transaction_id, String
16
16
 
17
17
  # @!attribute network
18
- # The network of the disputed transaction. Details specific to the network are
19
- # required under the sub-object with the same identifier as the network.
18
+ # The network of the disputed transaction. Details specific to the network can be
19
+ # provided under the sub-object with the same identifier as the network.
20
20
  #
21
21
  # @return [Symbol, Increase::Models::CardDisputeCreateParams::Network]
22
22
  required :network, enum: -> { Increase::CardDisputeCreateParams::Network }
@@ -31,7 +31,8 @@ module Increase
31
31
  optional :amount, Integer
32
32
 
33
33
  # @!attribute attachment_files
34
- # The files to be attached to the initial dispute submission.
34
+ # The files to be attached to the initial dispute submission. Can only be provided
35
+ # along with the network-specific details.
35
36
  #
36
37
  # @return [Array<Increase::Models::CardDisputeCreateParams::AttachmentFile>, nil]
37
38
  optional :attachment_files,
@@ -39,14 +40,15 @@ module Increase
39
40
 
40
41
  # @!attribute explanation
41
42
  # The free-form explanation provided to Increase to provide more context for the
42
- # user submission. This field is not sent directly to the card networks.
43
+ # user submission. This field is not sent directly to the card networks. Can only
44
+ # be provided along with the network-specific details.
43
45
  #
44
46
  # @return [String, nil]
45
47
  optional :explanation, String
46
48
 
47
49
  # @!attribute visa
48
- # The Visa-specific parameters for the dispute. Required if and only if `network`
49
- # is `visa`.
50
+ # The Visa-specific parameters for the initial User Submission. If omitted, a
51
+ # later User Submission will be required.
50
52
  #
51
53
  # @return [Increase::Models::CardDisputeCreateParams::Visa, nil]
52
54
  optional :visa, -> { Increase::CardDisputeCreateParams::Visa }
@@ -57,8 +59,8 @@ module Increase
57
59
  # of `card_settlement`.
58
60
  #
59
61
  # @param network [Symbol, Increase::Models::CardDisputeCreateParams::Network]
60
- # The network of the disputed transaction. Details specific to the network are
61
- # required under the sub-object with the same identifier as the network.
62
+ # The network of the disputed transaction. Details specific to the network can be
63
+ # provided under the sub-object with the same identifier as the network.
62
64
  #
63
65
  # @param amount [Integer]
64
66
  # The monetary amount of the part of the transaction that is being disputed. This
@@ -67,20 +69,22 @@ module Increase
67
69
  # the transaction.
68
70
  #
69
71
  # @param attachment_files [Array<Increase::Models::CardDisputeCreateParams::AttachmentFile>]
70
- # The files to be attached to the initial dispute submission.
72
+ # The files to be attached to the initial dispute submission. Can only be provided
73
+ # along with the network-specific details.
71
74
  #
72
75
  # @param explanation [String]
73
76
  # The free-form explanation provided to Increase to provide more context for the
74
- # user submission. This field is not sent directly to the card networks.
77
+ # user submission. This field is not sent directly to the card networks. Can only
78
+ # be provided along with the network-specific details.
75
79
  #
76
80
  # @param visa [Increase::Models::CardDisputeCreateParams::Visa]
77
- # The Visa-specific parameters for the dispute. Required if and only if `network`
78
- # is `visa`.
81
+ # The Visa-specific parameters for the initial User Submission. If omitted, a
82
+ # later User Submission will be required.
79
83
  #
80
84
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
81
85
 
82
- # The network of the disputed transaction. Details specific to the network are
83
- # required under the sub-object with the same identifier as the network.
86
+ # The network of the disputed transaction. Details specific to the network can be
87
+ # provided under the sub-object with the same identifier as the network.
84
88
  module Network
85
89
  extend Increase::Internal::Type::Enum
86
90
 
@@ -259,8 +263,8 @@ module Increase
259
263
  optional :processing_error, -> { Increase::CardDisputeCreateParams::Visa::ProcessingError }
260
264
 
261
265
  # @!method initialize(category:, authorization: nil, consumer_canceled_merchandise: nil, consumer_canceled_recurring_transaction: nil, consumer_canceled_services: nil, consumer_counterfeit_merchandise: nil, consumer_credit_not_processed: nil, consumer_damaged_or_defective_merchandise: nil, consumer_merchandise_misrepresentation: nil, consumer_merchandise_not_as_described: nil, consumer_merchandise_not_received: nil, consumer_non_receipt_of_cash: nil, consumer_original_credit_transaction_not_accepted: nil, consumer_quality_merchandise: nil, consumer_quality_services: nil, consumer_services_misrepresentation: nil, consumer_services_not_as_described: nil, consumer_services_not_received: nil, fraud: nil, processing_error: nil)
262
- # The Visa-specific parameters for the dispute. Required if and only if `network`
263
- # is `visa`.
266
+ # The Visa-specific parameters for the initial User Submission. If omitted, a
267
+ # later User Submission will be required.
264
268
  #
265
269
  # @param category [Symbol, Increase::Models::CardDisputeCreateParams::Visa::Category] Category.
266
270
  #
@@ -0,0 +1,22 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Increase
4
+ module Models
5
+ # @see Increase::Resources::CardDisputes#provide_provisional_credit
6
+ class CardDisputeProvideProvisionalCreditParams < Increase::Internal::Type::BaseModel
7
+ extend Increase::Internal::Type::RequestParameters::Converter
8
+ include Increase::Internal::Type::RequestParameters
9
+
10
+ # @!attribute card_dispute_id
11
+ # The identifier of the Card Dispute to provide a provisional credit for.
12
+ #
13
+ # @return [String]
14
+ required :card_dispute_id, String
15
+
16
+ # @!method initialize(card_dispute_id:, request_options: {})
17
+ # @param card_dispute_id [String] The identifier of the Card Dispute to provide a provisional credit for.
18
+ #
19
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
20
+ end
21
+ end
22
+ end
@@ -0,0 +1,22 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Increase
4
+ module Models
5
+ # @see Increase::Resources::CardDisputes#reverse_provisional_credit
6
+ class CardDisputeReverseProvisionalCreditParams < Increase::Internal::Type::BaseModel
7
+ extend Increase::Internal::Type::RequestParameters::Converter
8
+ include Increase::Internal::Type::RequestParameters
9
+
10
+ # @!attribute card_dispute_id
11
+ # The identifier of the Card Dispute to reverse the provisional credit for.
12
+ #
13
+ # @return [String]
14
+ required :card_dispute_id, String
15
+
16
+ # @!method initialize(card_dispute_id:, request_options: {})
17
+ # @param card_dispute_id [String] The identifier of the Card Dispute to reverse the provisional credit for.
18
+ #
19
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
20
+ end
21
+ end
22
+ end
@@ -16,9 +16,9 @@ module Increase
16
16
  optional :amount, Integer
17
17
 
18
18
  # @!attribute pending_transaction_id
19
- # The identifier of the Pending Transaction for the refund authorization. If this
20
- # is provided, `transaction` must not be provided as a refund with a refund
21
- # authorized can not be linked to a regular transaction.
19
+ # The identifier of the Pending Transaction for the refund or original credit
20
+ # authorization. If this is provided, `transaction` must not be provided as a
21
+ # refund with a refund authorized can not be linked to a regular transaction.
22
22
  #
23
23
  # @return [String, nil]
24
24
  optional :pending_transaction_id, String
@@ -36,9 +36,9 @@ module Increase
36
36
  # `transaction` if not provided.
37
37
  #
38
38
  # @param pending_transaction_id [String]
39
- # The identifier of the Pending Transaction for the refund authorization. If this
40
- # is provided, `transaction` must not be provided as a refund with a refund
41
- # authorized can not be linked to a regular transaction.
39
+ # The identifier of the Pending Transaction for the refund or original credit
40
+ # authorization. If this is provided, `transaction` must not be provided as a
41
+ # refund with a refund authorized can not be linked to a regular transaction.
42
42
  #
43
43
  # @param transaction_id [String]
44
44
  # The identifier for the Transaction to refund. The Transaction's source must have
@@ -130,6 +130,7 @@ module Increase
130
130
 
131
131
  # @!attribute freeform
132
132
  # Unstructured `payment_related_information` passed through with the transfer.
133
+ # Required if and only if `category` is `freeform`.
133
134
  #
134
135
  # @return [Increase::Models::Simulations::InboundACHTransferCreateParams::Addenda::Freeform, nil]
135
136
  optional :freeform, -> { Increase::Simulations::InboundACHTransferCreateParams::Addenda::Freeform }
@@ -142,6 +143,7 @@ module Increase
142
143
  #
143
144
  # @param freeform [Increase::Models::Simulations::InboundACHTransferCreateParams::Addenda::Freeform]
144
145
  # Unstructured `payment_related_information` passed through with the transfer.
146
+ # Required if and only if `category` is `freeform`.
145
147
 
146
148
  # The type of addenda to simulate being sent with the transfer.
147
149
  #
@@ -167,6 +169,7 @@ module Increase
167
169
 
168
170
  # @!method initialize(entries:)
169
171
  # Unstructured `payment_related_information` passed through with the transfer.
172
+ # Required if and only if `category` is `freeform`.
170
173
  #
171
174
  # @param entries [Array<Increase::Models::Simulations::InboundACHTransferCreateParams::Addenda::Freeform::Entry>]
172
175
  # Each entry represents an addendum sent with the transfer.
@@ -133,8 +133,12 @@ module Increase
133
133
 
134
134
  CardDisputeListParams = Increase::Models::CardDisputeListParams
135
135
 
136
+ CardDisputeProvideProvisionalCreditParams = Increase::Models::CardDisputeProvideProvisionalCreditParams
137
+
136
138
  CardDisputeRetrieveParams = Increase::Models::CardDisputeRetrieveParams
137
139
 
140
+ CardDisputeReverseProvisionalCreditParams = Increase::Models::CardDisputeReverseProvisionalCreditParams
141
+
138
142
  CardDisputeSubmitUserSubmissionParams = Increase::Models::CardDisputeSubmitUserSubmissionParams
139
143
 
140
144
  CardDisputeWithdrawParams = Increase::Models::CardDisputeWithdrawParams
@@ -12,8 +12,8 @@ module Increase
12
12
  # of `card_settlement`.
13
13
  #
14
14
  # @param network [Symbol, Increase::Models::CardDisputeCreateParams::Network]
15
- # The network of the disputed transaction. Details specific to the network are
16
- # required under the sub-object with the same identifier as the network.
15
+ # The network of the disputed transaction. Details specific to the network can be
16
+ # provided under the sub-object with the same identifier as the network.
17
17
  #
18
18
  # @param amount [Integer]
19
19
  # The monetary amount of the part of the transaction that is being disputed. This
@@ -22,15 +22,17 @@ module Increase
22
22
  # the transaction.
23
23
  #
24
24
  # @param attachment_files [Array<Increase::Models::CardDisputeCreateParams::AttachmentFile>]
25
- # The files to be attached to the initial dispute submission.
25
+ # The files to be attached to the initial dispute submission. Can only be provided
26
+ # along with the network-specific details.
26
27
  #
27
28
  # @param explanation [String]
28
29
  # The free-form explanation provided to Increase to provide more context for the
29
- # user submission. This field is not sent directly to the card networks.
30
+ # user submission. This field is not sent directly to the card networks. Can only
31
+ # be provided along with the network-specific details.
30
32
  #
31
33
  # @param visa [Increase::Models::CardDisputeCreateParams::Visa]
32
- # The Visa-specific parameters for the dispute. Required if and only if `network`
33
- # is `visa`.
34
+ # The Visa-specific parameters for the initial User Submission. If omitted, a
35
+ # later User Submission will be required.
34
36
  #
35
37
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
36
38
  #
@@ -108,6 +110,48 @@ module Increase
108
110
  )
109
111
  end
110
112
 
113
+ # Credits the cardholder's Account for the Card Dispute amount, funded by your
114
+ # program's provisional credit Account.
115
+ #
116
+ # @overload provide_provisional_credit(card_dispute_id, request_options: {})
117
+ #
118
+ # @param card_dispute_id [String] The identifier of the Card Dispute to provide a provisional credit for.
119
+ #
120
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
121
+ #
122
+ # @return [Increase::Models::CardDispute]
123
+ #
124
+ # @see Increase::Models::CardDisputeProvideProvisionalCreditParams
125
+ def provide_provisional_credit(card_dispute_id, params = {})
126
+ @client.request(
127
+ method: :post,
128
+ path: ["card_disputes/%1$s/provide_provisional_credit", card_dispute_id],
129
+ model: Increase::CardDispute,
130
+ options: params[:request_options]
131
+ )
132
+ end
133
+
134
+ # Debits the cardholder's Account for the provisional credit and returns it to
135
+ # your program's provisional credit Account.
136
+ #
137
+ # @overload reverse_provisional_credit(card_dispute_id, request_options: {})
138
+ #
139
+ # @param card_dispute_id [String] The identifier of the Card Dispute to reverse the provisional credit for.
140
+ #
141
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
142
+ #
143
+ # @return [Increase::Models::CardDispute]
144
+ #
145
+ # @see Increase::Models::CardDisputeReverseProvisionalCreditParams
146
+ def reverse_provisional_credit(card_dispute_id, params = {})
147
+ @client.request(
148
+ method: :post,
149
+ path: ["card_disputes/%1$s/reverse_provisional_credit", card_dispute_id],
150
+ model: Increase::CardDispute,
151
+ options: params[:request_options]
152
+ )
153
+ end
154
+
111
155
  # Submit a User Submission for a Card Dispute
112
156
  #
113
157
  # @overload submit_user_submission(card_dispute_id, network:, amount: nil, attachment_files: nil, explanation: nil, visa: nil, request_options: {})
@@ -14,9 +14,9 @@ module Increase
14
14
  # `transaction` if not provided.
15
15
  #
16
16
  # @param pending_transaction_id [String]
17
- # The identifier of the Pending Transaction for the refund authorization. If this
18
- # is provided, `transaction` must not be provided as a refund with a refund
19
- # authorized can not be linked to a regular transaction.
17
+ # The identifier of the Pending Transaction for the refund or original credit
18
+ # authorization. If this is provided, `transaction` must not be provided as a
19
+ # refund with a refund authorized can not be linked to a regular transaction.
20
20
  #
21
21
  # @param transaction_id [String]
22
22
  # The identifier for the Transaction to refund. The Transaction's source must have
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Increase
4
- VERSION = "1.366.0"
4
+ VERSION = "1.367.0"
5
5
  end
data/lib/increase.rb CHANGED
@@ -101,7 +101,9 @@ require_relative "increase/models/card_details_token"
101
101
  require_relative "increase/models/card_dispute"
102
102
  require_relative "increase/models/card_dispute_create_params"
103
103
  require_relative "increase/models/card_dispute_list_params"
104
+ require_relative "increase/models/card_dispute_provide_provisional_credit_params"
104
105
  require_relative "increase/models/card_dispute_retrieve_params"
106
+ require_relative "increase/models/card_dispute_reverse_provisional_credit_params"
105
107
  require_relative "increase/models/card_dispute_submit_user_submission_params"
106
108
  require_relative "increase/models/card_dispute_withdraw_params"
107
109
  require_relative "increase/models/card_iframe_url"
@@ -99,7 +99,7 @@ module Increase
99
99
  attr_accessor :company_id
100
100
 
101
101
  # The name by which the recipient knows you.
102
- sig { returns(T.nilable(String)) }
102
+ sig { returns(String) }
103
103
  attr_accessor :company_name
104
104
 
105
105
  # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
@@ -163,7 +163,7 @@ module Increase
163
163
 
164
164
  # The name of the transfer recipient. This value is informational and not verified
165
165
  # by the recipient's bank.
166
- sig { returns(T.nilable(String)) }
166
+ sig { returns(String) }
167
167
  attr_accessor :individual_name
168
168
 
169
169
  # The transfer's network.
@@ -281,7 +281,7 @@ module Increase
281
281
  company_discretionary_data: T.nilable(String),
282
282
  company_entry_description: T.nilable(String),
283
283
  company_id: String,
284
- company_name: T.nilable(String),
284
+ company_name: String,
285
285
  created_at: Time,
286
286
  created_by: T.nilable(Increase::ACHTransfer::CreatedBy::OrHash),
287
287
  currency: Increase::ACHTransfer::Currency::OrSymbol,
@@ -293,7 +293,7 @@ module Increase
293
293
  inbound_funds_hold:
294
294
  T.nilable(Increase::ACHTransfer::InboundFundsHold::OrHash),
295
295
  individual_id: T.nilable(String),
296
- individual_name: T.nilable(String),
296
+ individual_name: String,
297
297
  network: Increase::ACHTransfer::Network::OrSymbol,
298
298
  notifications_of_change:
299
299
  T::Array[Increase::ACHTransfer::NotificationsOfChange::OrHash],
@@ -442,7 +442,7 @@ module Increase
442
442
  company_discretionary_data: T.nilable(String),
443
443
  company_entry_description: T.nilable(String),
444
444
  company_id: String,
445
- company_name: T.nilable(String),
445
+ company_name: String,
446
446
  created_at: Time,
447
447
  created_by: T.nilable(Increase::ACHTransfer::CreatedBy),
448
448
  currency: Increase::ACHTransfer::Currency::TaggedSymbol,
@@ -454,7 +454,7 @@ module Increase
454
454
  inbound_funds_hold:
455
455
  T.nilable(Increase::ACHTransfer::InboundFundsHold),
456
456
  individual_id: T.nilable(String),
457
- individual_name: T.nilable(String),
457
+ individual_name: String,
458
458
  network: Increase::ACHTransfer::Network::TaggedSymbol,
459
459
  notifications_of_change:
460
460
  T::Array[Increase::ACHTransfer::NotificationsOfChange],