increase 1.216.0 → 1.218.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +16 -0
- data/README.md +1 -1
- data/lib/increase/models/check_deposit.rb +71 -1
- data/lib/increase/models/simulations/card_authentication_challenge_attempts_params.rb +24 -0
- data/lib/increase/models/simulations/card_authentication_challenges_params.rb +16 -0
- data/lib/increase/models/simulations/card_authentication_create_params.rb +118 -0
- data/lib/increase/resources/simulations/card_authentications.rb +110 -0
- data/lib/increase/resources/simulations.rb +4 -0
- data/lib/increase/version.rb +1 -1
- data/lib/increase.rb +4 -0
- data/rbi/increase/models/check_deposit.rbi +132 -0
- data/rbi/increase/models/simulations/card_authentication_challenge_attempts_params.rbi +45 -0
- data/rbi/increase/models/simulations/card_authentication_challenges_params.rbi +32 -0
- data/rbi/increase/models/simulations/card_authentication_create_params.rbi +238 -0
- data/rbi/increase/resources/simulations/card_authentications.rbi +94 -0
- data/rbi/increase/resources/simulations.rbi +3 -0
- data/sig/increase/models/check_deposit.rbs +65 -0
- data/sig/increase/models/simulations/card_authentication_challenge_attempts_params.rbs +25 -0
- data/sig/increase/models/simulations/card_authentication_challenges_params.rbs +17 -0
- data/sig/increase/models/simulations/card_authentication_create_params.rbs +112 -0
- data/sig/increase/resources/simulations/card_authentications.rbs +32 -0
- data/sig/increase/resources/simulations.rbs +2 -0
- metadata +13 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 0cd7dde29c42405ca749acf881e24a487184457b1371388b5b828eec58d80154
|
|
4
|
+
data.tar.gz: 4d75b7acb28334eb6c2bd01aaa115636881e51b5d754e1634cc8dd150a3d615c
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 6038c8150968381895ce68f88068016ff234b1b757666067eb419b320ba2000052bfab03d8fbfc8ce28ac9f20ccf1b3edd3344f65aee932e2b556e0a80bd5012
|
|
7
|
+
data.tar.gz: eeab266d19941a50bdd29dd53a46fd73a8047f7b5186f0beb16372367453249758fa5658ed47785e859a5b892c79b4f571137d7508c888890b05815daa020136
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,21 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 1.218.0 (2026-03-02)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v1.217.0...v1.218.0](https://github.com/Increase/increase-ruby/compare/v1.217.0...v1.218.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* **api:** api update ([7dbf570](https://github.com/Increase/increase-ruby/commit/7dbf5703b250d0d377a6b713c3d09c6011d3ddc9))
|
|
10
|
+
|
|
11
|
+
## 1.217.0 (2026-03-02)
|
|
12
|
+
|
|
13
|
+
Full Changelog: [v1.216.0...v1.217.0](https://github.com/Increase/increase-ruby/compare/v1.216.0...v1.217.0)
|
|
14
|
+
|
|
15
|
+
### Features
|
|
16
|
+
|
|
17
|
+
* **api:** api update ([e890f47](https://github.com/Increase/increase-ruby/commit/e890f473afbe526a119d61b8a356177ca5bf4d95))
|
|
18
|
+
|
|
3
19
|
## 1.216.0 (2026-03-02)
|
|
4
20
|
|
|
5
21
|
Full Changelog: [v1.215.0...v1.216.0](https://github.com/Increase/increase-ruby/compare/v1.215.0...v1.216.0)
|
data/README.md
CHANGED
|
@@ -42,6 +42,14 @@ module Increase
|
|
|
42
42
|
# @return [Increase::Models::CheckDeposit::DepositAcceptance, nil]
|
|
43
43
|
required :deposit_acceptance, -> { Increase::CheckDeposit::DepositAcceptance }, nil?: true
|
|
44
44
|
|
|
45
|
+
# @!attribute deposit_adjustments
|
|
46
|
+
# If the deposit or the return was adjusted by the receiving institution, this
|
|
47
|
+
# will contain details of the adjustments.
|
|
48
|
+
#
|
|
49
|
+
# @return [Array<Increase::Models::CheckDeposit::DepositAdjustment>]
|
|
50
|
+
required :deposit_adjustments,
|
|
51
|
+
-> { Increase::Internal::Type::ArrayOf[Increase::CheckDeposit::DepositAdjustment] }
|
|
52
|
+
|
|
45
53
|
# @!attribute deposit_rejection
|
|
46
54
|
# If your deposit is rejected by Increase, this will contain details as to why it
|
|
47
55
|
# was rejected.
|
|
@@ -123,7 +131,7 @@ module Increase
|
|
|
123
131
|
# @return [Symbol, Increase::Models::CheckDeposit::Type]
|
|
124
132
|
required :type, enum: -> { Increase::CheckDeposit::Type }
|
|
125
133
|
|
|
126
|
-
# @!method initialize(id:, account_id:, amount:, back_image_file_id:, created_at:, deposit_acceptance:, deposit_rejection:, deposit_return:, deposit_submission:, description:, front_image_file_id:, idempotency_key:, inbound_funds_hold:, inbound_mail_item_id:, lockbox_id:, status:, transaction_id:, type:)
|
|
134
|
+
# @!method initialize(id:, account_id:, amount:, back_image_file_id:, created_at:, deposit_acceptance:, deposit_adjustments:, deposit_rejection:, deposit_return:, deposit_submission:, description:, front_image_file_id:, idempotency_key:, inbound_funds_hold:, inbound_mail_item_id:, lockbox_id:, status:, transaction_id:, type:)
|
|
127
135
|
# Some parameter documentations has been truncated, see
|
|
128
136
|
# {Increase::Models::CheckDeposit} for more details.
|
|
129
137
|
#
|
|
@@ -141,6 +149,8 @@ module Increase
|
|
|
141
149
|
#
|
|
142
150
|
# @param deposit_acceptance [Increase::Models::CheckDeposit::DepositAcceptance, nil] Once your deposit is successfully parsed and accepted by Increase, this will con
|
|
143
151
|
#
|
|
152
|
+
# @param deposit_adjustments [Array<Increase::Models::CheckDeposit::DepositAdjustment>] If the deposit or the return was adjusted by the receiving institution, this wil
|
|
153
|
+
#
|
|
144
154
|
# @param deposit_rejection [Increase::Models::CheckDeposit::DepositRejection, nil] If your deposit is rejected by Increase, this will contain details as to why it
|
|
145
155
|
#
|
|
146
156
|
# @param deposit_return [Increase::Models::CheckDeposit::DepositReturn, nil] If your deposit is returned, this will contain details as to why it was returned
|
|
@@ -251,6 +261,66 @@ module Increase
|
|
|
251
261
|
end
|
|
252
262
|
end
|
|
253
263
|
|
|
264
|
+
class DepositAdjustment < Increase::Internal::Type::BaseModel
|
|
265
|
+
# @!attribute adjusted_at
|
|
266
|
+
# The time at which the adjustment was received.
|
|
267
|
+
#
|
|
268
|
+
# @return [Time]
|
|
269
|
+
required :adjusted_at, Time
|
|
270
|
+
|
|
271
|
+
# @!attribute amount
|
|
272
|
+
# The amount of the adjustment.
|
|
273
|
+
#
|
|
274
|
+
# @return [Integer]
|
|
275
|
+
required :amount, Integer
|
|
276
|
+
|
|
277
|
+
# @!attribute reason
|
|
278
|
+
# The reason for the adjustment.
|
|
279
|
+
#
|
|
280
|
+
# @return [Symbol, Increase::Models::CheckDeposit::DepositAdjustment::Reason]
|
|
281
|
+
required :reason, enum: -> { Increase::CheckDeposit::DepositAdjustment::Reason }
|
|
282
|
+
|
|
283
|
+
# @!attribute transaction_id
|
|
284
|
+
# The id of the transaction for the adjustment.
|
|
285
|
+
#
|
|
286
|
+
# @return [String]
|
|
287
|
+
required :transaction_id, String
|
|
288
|
+
|
|
289
|
+
# @!method initialize(adjusted_at:, amount:, reason:, transaction_id:)
|
|
290
|
+
# @param adjusted_at [Time] The time at which the adjustment was received.
|
|
291
|
+
#
|
|
292
|
+
# @param amount [Integer] The amount of the adjustment.
|
|
293
|
+
#
|
|
294
|
+
# @param reason [Symbol, Increase::Models::CheckDeposit::DepositAdjustment::Reason] The reason for the adjustment.
|
|
295
|
+
#
|
|
296
|
+
# @param transaction_id [String] The id of the transaction for the adjustment.
|
|
297
|
+
|
|
298
|
+
# The reason for the adjustment.
|
|
299
|
+
#
|
|
300
|
+
# @see Increase::Models::CheckDeposit::DepositAdjustment#reason
|
|
301
|
+
module Reason
|
|
302
|
+
extend Increase::Internal::Type::Enum
|
|
303
|
+
|
|
304
|
+
# The return was initiated too late and the receiving institution has responded with a Late Return Claim.
|
|
305
|
+
LATE_RETURN = :late_return
|
|
306
|
+
|
|
307
|
+
# The check was deposited to the wrong payee and the depositing institution has reimbursed the funds with a Wrong Payee Credit.
|
|
308
|
+
WRONG_PAYEE_CREDIT = :wrong_payee_credit
|
|
309
|
+
|
|
310
|
+
# The check was deposited with a different amount than what was written on the check.
|
|
311
|
+
ADJUSTED_AMOUNT = :adjusted_amount
|
|
312
|
+
|
|
313
|
+
# The recipient was not able to process the check. This usually happens for e.g., low quality images.
|
|
314
|
+
NON_CONFORMING_ITEM = :non_conforming_item
|
|
315
|
+
|
|
316
|
+
# The check has already been deposited elsewhere and so this is a duplicate.
|
|
317
|
+
PAID = :paid
|
|
318
|
+
|
|
319
|
+
# @!method self.values
|
|
320
|
+
# @return [Array<Symbol>]
|
|
321
|
+
end
|
|
322
|
+
end
|
|
323
|
+
|
|
254
324
|
# @see Increase::Models::CheckDeposit#deposit_rejection
|
|
255
325
|
class DepositRejection < Increase::Internal::Type::BaseModel
|
|
256
326
|
# @!attribute amount
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Increase
|
|
4
|
+
module Models
|
|
5
|
+
module Simulations
|
|
6
|
+
# @see Increase::Resources::Simulations::CardAuthentications#challenge_attempts
|
|
7
|
+
class CardAuthenticationChallengeAttemptsParams < Increase::Internal::Type::BaseModel
|
|
8
|
+
extend Increase::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include Increase::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute one_time_code
|
|
12
|
+
# The one-time code to be validated.
|
|
13
|
+
#
|
|
14
|
+
# @return [String]
|
|
15
|
+
required :one_time_code, String
|
|
16
|
+
|
|
17
|
+
# @!method initialize(one_time_code:, request_options: {})
|
|
18
|
+
# @param one_time_code [String] The one-time code to be validated.
|
|
19
|
+
#
|
|
20
|
+
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
21
|
+
end
|
|
22
|
+
end
|
|
23
|
+
end
|
|
24
|
+
end
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Increase
|
|
4
|
+
module Models
|
|
5
|
+
module Simulations
|
|
6
|
+
# @see Increase::Resources::Simulations::CardAuthentications#challenges
|
|
7
|
+
class CardAuthenticationChallengesParams < Increase::Internal::Type::BaseModel
|
|
8
|
+
extend Increase::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include Increase::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!method initialize(request_options: {})
|
|
12
|
+
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
13
|
+
end
|
|
14
|
+
end
|
|
15
|
+
end
|
|
16
|
+
end
|
|
@@ -0,0 +1,118 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Increase
|
|
4
|
+
module Models
|
|
5
|
+
module Simulations
|
|
6
|
+
# @see Increase::Resources::Simulations::CardAuthentications#create
|
|
7
|
+
class CardAuthenticationCreateParams < Increase::Internal::Type::BaseModel
|
|
8
|
+
extend Increase::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include Increase::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute card_id
|
|
12
|
+
# The identifier of the Card to be authorized.
|
|
13
|
+
#
|
|
14
|
+
# @return [String]
|
|
15
|
+
required :card_id, String
|
|
16
|
+
|
|
17
|
+
# @!attribute category
|
|
18
|
+
# The category of the card authentication attempt.
|
|
19
|
+
#
|
|
20
|
+
# @return [Symbol, Increase::Models::Simulations::CardAuthenticationCreateParams::Category, nil]
|
|
21
|
+
optional :category, enum: -> { Increase::Simulations::CardAuthenticationCreateParams::Category }
|
|
22
|
+
|
|
23
|
+
# @!attribute device_channel
|
|
24
|
+
# The device channel of the card authentication attempt.
|
|
25
|
+
#
|
|
26
|
+
# @return [Symbol, Increase::Models::Simulations::CardAuthenticationCreateParams::DeviceChannel, nil]
|
|
27
|
+
optional :device_channel,
|
|
28
|
+
enum: -> { Increase::Simulations::CardAuthenticationCreateParams::DeviceChannel }
|
|
29
|
+
|
|
30
|
+
# @!attribute merchant_acceptor_id
|
|
31
|
+
# The merchant identifier (commonly abbreviated as MID) of the merchant the card
|
|
32
|
+
# is transacting with.
|
|
33
|
+
#
|
|
34
|
+
# @return [String, nil]
|
|
35
|
+
optional :merchant_acceptor_id, String
|
|
36
|
+
|
|
37
|
+
# @!attribute merchant_category_code
|
|
38
|
+
# The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
|
|
39
|
+
# card is transacting with.
|
|
40
|
+
#
|
|
41
|
+
# @return [String, nil]
|
|
42
|
+
optional :merchant_category_code, String
|
|
43
|
+
|
|
44
|
+
# @!attribute merchant_country
|
|
45
|
+
# The country the merchant resides in.
|
|
46
|
+
#
|
|
47
|
+
# @return [String, nil]
|
|
48
|
+
optional :merchant_country, String
|
|
49
|
+
|
|
50
|
+
# @!attribute merchant_name
|
|
51
|
+
# The name of the merchant
|
|
52
|
+
#
|
|
53
|
+
# @return [String, nil]
|
|
54
|
+
optional :merchant_name, String
|
|
55
|
+
|
|
56
|
+
# @!attribute purchase_amount
|
|
57
|
+
# The purchase amount in cents.
|
|
58
|
+
#
|
|
59
|
+
# @return [Integer, nil]
|
|
60
|
+
optional :purchase_amount, Integer
|
|
61
|
+
|
|
62
|
+
# @!method initialize(card_id:, category: nil, device_channel: nil, merchant_acceptor_id: nil, merchant_category_code: nil, merchant_country: nil, merchant_name: nil, purchase_amount: nil, request_options: {})
|
|
63
|
+
# Some parameter documentations has been truncated, see
|
|
64
|
+
# {Increase::Models::Simulations::CardAuthenticationCreateParams} for more
|
|
65
|
+
# details.
|
|
66
|
+
#
|
|
67
|
+
# @param card_id [String] The identifier of the Card to be authorized.
|
|
68
|
+
#
|
|
69
|
+
# @param category [Symbol, Increase::Models::Simulations::CardAuthenticationCreateParams::Category] The category of the card authentication attempt.
|
|
70
|
+
#
|
|
71
|
+
# @param device_channel [Symbol, Increase::Models::Simulations::CardAuthenticationCreateParams::DeviceChannel] The device channel of the card authentication attempt.
|
|
72
|
+
#
|
|
73
|
+
# @param merchant_acceptor_id [String] The merchant identifier (commonly abbreviated as MID) of the merchant the card i
|
|
74
|
+
#
|
|
75
|
+
# @param merchant_category_code [String] The Merchant Category Code (commonly abbreviated as MCC) of the merchant the car
|
|
76
|
+
#
|
|
77
|
+
# @param merchant_country [String] The country the merchant resides in.
|
|
78
|
+
#
|
|
79
|
+
# @param merchant_name [String] The name of the merchant
|
|
80
|
+
#
|
|
81
|
+
# @param purchase_amount [Integer] The purchase amount in cents.
|
|
82
|
+
#
|
|
83
|
+
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
84
|
+
|
|
85
|
+
# The category of the card authentication attempt.
|
|
86
|
+
module Category
|
|
87
|
+
extend Increase::Internal::Type::Enum
|
|
88
|
+
|
|
89
|
+
# The authentication attempt is for a payment.
|
|
90
|
+
PAYMENT_AUTHENTICATION = :payment_authentication
|
|
91
|
+
|
|
92
|
+
# The authentication attempt is not for a payment.
|
|
93
|
+
NON_PAYMENT_AUTHENTICATION = :non_payment_authentication
|
|
94
|
+
|
|
95
|
+
# @!method self.values
|
|
96
|
+
# @return [Array<Symbol>]
|
|
97
|
+
end
|
|
98
|
+
|
|
99
|
+
# The device channel of the card authentication attempt.
|
|
100
|
+
module DeviceChannel
|
|
101
|
+
extend Increase::Internal::Type::Enum
|
|
102
|
+
|
|
103
|
+
# The authentication attempt was made from an app.
|
|
104
|
+
APP = :app
|
|
105
|
+
|
|
106
|
+
# The authentication attempt was made from a browser.
|
|
107
|
+
BROWSER = :browser
|
|
108
|
+
|
|
109
|
+
# The authentication attempt was initiated by the 3DS Requestor.
|
|
110
|
+
THREE_DS_REQUESTOR_INITIATED = :three_ds_requestor_initiated
|
|
111
|
+
|
|
112
|
+
# @!method self.values
|
|
113
|
+
# @return [Array<Symbol>]
|
|
114
|
+
end
|
|
115
|
+
end
|
|
116
|
+
end
|
|
117
|
+
end
|
|
118
|
+
end
|
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Increase
|
|
4
|
+
module Resources
|
|
5
|
+
class Simulations
|
|
6
|
+
class CardAuthentications
|
|
7
|
+
# Some parameter documentations has been truncated, see
|
|
8
|
+
# {Increase::Models::Simulations::CardAuthenticationCreateParams} for more
|
|
9
|
+
# details.
|
|
10
|
+
#
|
|
11
|
+
# Simulates a Card Authentication attempt on a [Card](#cards). The attempt always
|
|
12
|
+
# results in a [Card Payment](#card_payments) being created, either with a status
|
|
13
|
+
# that allows further action or a terminal failed status.
|
|
14
|
+
#
|
|
15
|
+
# @overload create(card_id:, category: nil, device_channel: nil, merchant_acceptor_id: nil, merchant_category_code: nil, merchant_country: nil, merchant_name: nil, purchase_amount: nil, request_options: {})
|
|
16
|
+
#
|
|
17
|
+
# @param card_id [String] The identifier of the Card to be authorized.
|
|
18
|
+
#
|
|
19
|
+
# @param category [Symbol, Increase::Models::Simulations::CardAuthenticationCreateParams::Category] The category of the card authentication attempt.
|
|
20
|
+
#
|
|
21
|
+
# @param device_channel [Symbol, Increase::Models::Simulations::CardAuthenticationCreateParams::DeviceChannel] The device channel of the card authentication attempt.
|
|
22
|
+
#
|
|
23
|
+
# @param merchant_acceptor_id [String] The merchant identifier (commonly abbreviated as MID) of the merchant the card i
|
|
24
|
+
#
|
|
25
|
+
# @param merchant_category_code [String] The Merchant Category Code (commonly abbreviated as MCC) of the merchant the car
|
|
26
|
+
#
|
|
27
|
+
# @param merchant_country [String] The country the merchant resides in.
|
|
28
|
+
#
|
|
29
|
+
# @param merchant_name [String] The name of the merchant
|
|
30
|
+
#
|
|
31
|
+
# @param purchase_amount [Integer] The purchase amount in cents.
|
|
32
|
+
#
|
|
33
|
+
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
34
|
+
#
|
|
35
|
+
# @return [Increase::Models::CardPayment]
|
|
36
|
+
#
|
|
37
|
+
# @see Increase::Models::Simulations::CardAuthenticationCreateParams
|
|
38
|
+
def create(params)
|
|
39
|
+
parsed, options = Increase::Simulations::CardAuthenticationCreateParams.dump_request(params)
|
|
40
|
+
@client.request(
|
|
41
|
+
method: :post,
|
|
42
|
+
path: "simulations/card_authentications",
|
|
43
|
+
body: parsed,
|
|
44
|
+
model: Increase::CardPayment,
|
|
45
|
+
options: options
|
|
46
|
+
)
|
|
47
|
+
end
|
|
48
|
+
|
|
49
|
+
# Simulates an attempt at a Card Authentication Challenge. This updates the
|
|
50
|
+
# `card_authentications` object under the [Card Payment](#card_payments). You can
|
|
51
|
+
# also attempt the challenge by navigating to
|
|
52
|
+
# https://dashboard.increase.com/card_authentication_simulation/:card_payment_id.
|
|
53
|
+
#
|
|
54
|
+
# @overload challenge_attempts(card_payment_id, one_time_code:, request_options: {})
|
|
55
|
+
#
|
|
56
|
+
# @param card_payment_id [String] The identifier of the Card Payment to be challenged.
|
|
57
|
+
#
|
|
58
|
+
# @param one_time_code [String] The one-time code to be validated.
|
|
59
|
+
#
|
|
60
|
+
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
61
|
+
#
|
|
62
|
+
# @return [Increase::Models::CardPayment]
|
|
63
|
+
#
|
|
64
|
+
# @see Increase::Models::Simulations::CardAuthenticationChallengeAttemptsParams
|
|
65
|
+
def challenge_attempts(card_payment_id, params)
|
|
66
|
+
parsed, options = Increase::Simulations::CardAuthenticationChallengeAttemptsParams.dump_request(params)
|
|
67
|
+
@client.request(
|
|
68
|
+
method: :post,
|
|
69
|
+
path: ["simulations/card_authentications/%1$s/challenge_attempts", card_payment_id],
|
|
70
|
+
body: parsed,
|
|
71
|
+
model: Increase::CardPayment,
|
|
72
|
+
options: options
|
|
73
|
+
)
|
|
74
|
+
end
|
|
75
|
+
|
|
76
|
+
# Simulates starting a Card Authentication Challenge for an existing Card
|
|
77
|
+
# Authentication. This updates the `card_authentications` object under the
|
|
78
|
+
# [Card Payment](#card_payments). To attempt the challenge, use the
|
|
79
|
+
# `/simulations/card_authentications/:card_payment_id/challenge_attempts` endpoint
|
|
80
|
+
# or navigate to
|
|
81
|
+
# https://dashboard.increase.com/card_authentication_simulation/:card_payment_id.
|
|
82
|
+
#
|
|
83
|
+
# @overload challenges(card_payment_id, request_options: {})
|
|
84
|
+
#
|
|
85
|
+
# @param card_payment_id [String] The identifier of the Card Payment to be challenged.
|
|
86
|
+
#
|
|
87
|
+
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
88
|
+
#
|
|
89
|
+
# @return [Increase::Models::CardPayment]
|
|
90
|
+
#
|
|
91
|
+
# @see Increase::Models::Simulations::CardAuthenticationChallengesParams
|
|
92
|
+
def challenges(card_payment_id, params = {})
|
|
93
|
+
@client.request(
|
|
94
|
+
method: :post,
|
|
95
|
+
path: ["simulations/card_authentications/%1$s/challenges", card_payment_id],
|
|
96
|
+
model: Increase::CardPayment,
|
|
97
|
+
options: params[:request_options]
|
|
98
|
+
)
|
|
99
|
+
end
|
|
100
|
+
|
|
101
|
+
# @api private
|
|
102
|
+
#
|
|
103
|
+
# @param client [Increase::Client]
|
|
104
|
+
def initialize(client:)
|
|
105
|
+
@client = client
|
|
106
|
+
end
|
|
107
|
+
end
|
|
108
|
+
end
|
|
109
|
+
end
|
|
110
|
+
end
|
|
@@ -33,6 +33,9 @@ module Increase
|
|
|
33
33
|
# @return [Increase::Resources::Simulations::CardRefunds]
|
|
34
34
|
attr_reader :card_refunds
|
|
35
35
|
|
|
36
|
+
# @return [Increase::Resources::Simulations::CardAuthentications]
|
|
37
|
+
attr_reader :card_authentications
|
|
38
|
+
|
|
36
39
|
# @return [Increase::Resources::Simulations::CardDisputes]
|
|
37
40
|
attr_reader :card_disputes
|
|
38
41
|
|
|
@@ -112,6 +115,7 @@ module Increase
|
|
|
112
115
|
@card_increments = Increase::Resources::Simulations::CardIncrements.new(client: client)
|
|
113
116
|
@card_fuel_confirmations = Increase::Resources::Simulations::CardFuelConfirmations.new(client: client)
|
|
114
117
|
@card_refunds = Increase::Resources::Simulations::CardRefunds.new(client: client)
|
|
118
|
+
@card_authentications = Increase::Resources::Simulations::CardAuthentications.new(client: client)
|
|
115
119
|
@card_disputes = Increase::Resources::Simulations::CardDisputes.new(client: client)
|
|
116
120
|
@physical_cards = Increase::Resources::Simulations::PhysicalCards.new(client: client)
|
|
117
121
|
@digital_wallet_token_requests =
|
data/lib/increase/version.rb
CHANGED
data/lib/increase.rb
CHANGED
|
@@ -293,6 +293,9 @@ require_relative "increase/models/simulations/ach_transfer_create_notification_o
|
|
|
293
293
|
require_relative "increase/models/simulations/ach_transfer_return_params"
|
|
294
294
|
require_relative "increase/models/simulations/ach_transfer_settle_params"
|
|
295
295
|
require_relative "increase/models/simulations/ach_transfer_submit_params"
|
|
296
|
+
require_relative "increase/models/simulations/card_authentication_challenge_attempts_params"
|
|
297
|
+
require_relative "increase/models/simulations/card_authentication_challenges_params"
|
|
298
|
+
require_relative "increase/models/simulations/card_authentication_create_params"
|
|
296
299
|
require_relative "increase/models/simulations/card_authorization_create_params"
|
|
297
300
|
require_relative "increase/models/simulations/card_authorization_create_response"
|
|
298
301
|
require_relative "increase/models/simulations/card_authorization_expiration_create_params"
|
|
@@ -406,6 +409,7 @@ require_relative "increase/resources/simulations"
|
|
|
406
409
|
require_relative "increase/resources/simulations/account_statements"
|
|
407
410
|
require_relative "increase/resources/simulations/account_transfers"
|
|
408
411
|
require_relative "increase/resources/simulations/ach_transfers"
|
|
412
|
+
require_relative "increase/resources/simulations/card_authentications"
|
|
409
413
|
require_relative "increase/resources/simulations/card_authorization_expirations"
|
|
410
414
|
require_relative "increase/resources/simulations/card_authorizations"
|
|
411
415
|
require_relative "increase/resources/simulations/card_balance_inquiries"
|
|
@@ -42,6 +42,11 @@ module Increase
|
|
|
42
42
|
end
|
|
43
43
|
attr_writer :deposit_acceptance
|
|
44
44
|
|
|
45
|
+
# If the deposit or the return was adjusted by the receiving institution, this
|
|
46
|
+
# will contain details of the adjustments.
|
|
47
|
+
sig { returns(T::Array[Increase::CheckDeposit::DepositAdjustment]) }
|
|
48
|
+
attr_accessor :deposit_adjustments
|
|
49
|
+
|
|
45
50
|
# If your deposit is rejected by Increase, this will contain details as to why it
|
|
46
51
|
# was rejected.
|
|
47
52
|
sig { returns(T.nilable(Increase::CheckDeposit::DepositRejection)) }
|
|
@@ -141,6 +146,8 @@ module Increase
|
|
|
141
146
|
created_at: Time,
|
|
142
147
|
deposit_acceptance:
|
|
143
148
|
T.nilable(Increase::CheckDeposit::DepositAcceptance::OrHash),
|
|
149
|
+
deposit_adjustments:
|
|
150
|
+
T::Array[Increase::CheckDeposit::DepositAdjustment::OrHash],
|
|
144
151
|
deposit_rejection:
|
|
145
152
|
T.nilable(Increase::CheckDeposit::DepositRejection::OrHash),
|
|
146
153
|
deposit_return:
|
|
@@ -174,6 +181,9 @@ module Increase
|
|
|
174
181
|
# Once your deposit is successfully parsed and accepted by Increase, this will
|
|
175
182
|
# contain details of the parsed check.
|
|
176
183
|
deposit_acceptance:,
|
|
184
|
+
# If the deposit or the return was adjusted by the receiving institution, this
|
|
185
|
+
# will contain details of the adjustments.
|
|
186
|
+
deposit_adjustments:,
|
|
177
187
|
# If your deposit is rejected by Increase, this will contain details as to why it
|
|
178
188
|
# was rejected.
|
|
179
189
|
deposit_rejection:,
|
|
@@ -220,6 +230,8 @@ module Increase
|
|
|
220
230
|
created_at: Time,
|
|
221
231
|
deposit_acceptance:
|
|
222
232
|
T.nilable(Increase::CheckDeposit::DepositAcceptance),
|
|
233
|
+
deposit_adjustments:
|
|
234
|
+
T::Array[Increase::CheckDeposit::DepositAdjustment],
|
|
223
235
|
deposit_rejection:
|
|
224
236
|
T.nilable(Increase::CheckDeposit::DepositRejection),
|
|
225
237
|
deposit_return: T.nilable(Increase::CheckDeposit::DepositReturn),
|
|
@@ -373,6 +385,126 @@ module Increase
|
|
|
373
385
|
end
|
|
374
386
|
end
|
|
375
387
|
|
|
388
|
+
class DepositAdjustment < Increase::Internal::Type::BaseModel
|
|
389
|
+
OrHash =
|
|
390
|
+
T.type_alias do
|
|
391
|
+
T.any(
|
|
392
|
+
Increase::CheckDeposit::DepositAdjustment,
|
|
393
|
+
Increase::Internal::AnyHash
|
|
394
|
+
)
|
|
395
|
+
end
|
|
396
|
+
|
|
397
|
+
# The time at which the adjustment was received.
|
|
398
|
+
sig { returns(Time) }
|
|
399
|
+
attr_accessor :adjusted_at
|
|
400
|
+
|
|
401
|
+
# The amount of the adjustment.
|
|
402
|
+
sig { returns(Integer) }
|
|
403
|
+
attr_accessor :amount
|
|
404
|
+
|
|
405
|
+
# The reason for the adjustment.
|
|
406
|
+
sig do
|
|
407
|
+
returns(
|
|
408
|
+
Increase::CheckDeposit::DepositAdjustment::Reason::TaggedSymbol
|
|
409
|
+
)
|
|
410
|
+
end
|
|
411
|
+
attr_accessor :reason
|
|
412
|
+
|
|
413
|
+
# The id of the transaction for the adjustment.
|
|
414
|
+
sig { returns(String) }
|
|
415
|
+
attr_accessor :transaction_id
|
|
416
|
+
|
|
417
|
+
sig do
|
|
418
|
+
params(
|
|
419
|
+
adjusted_at: Time,
|
|
420
|
+
amount: Integer,
|
|
421
|
+
reason: Increase::CheckDeposit::DepositAdjustment::Reason::OrSymbol,
|
|
422
|
+
transaction_id: String
|
|
423
|
+
).returns(T.attached_class)
|
|
424
|
+
end
|
|
425
|
+
def self.new(
|
|
426
|
+
# The time at which the adjustment was received.
|
|
427
|
+
adjusted_at:,
|
|
428
|
+
# The amount of the adjustment.
|
|
429
|
+
amount:,
|
|
430
|
+
# The reason for the adjustment.
|
|
431
|
+
reason:,
|
|
432
|
+
# The id of the transaction for the adjustment.
|
|
433
|
+
transaction_id:
|
|
434
|
+
)
|
|
435
|
+
end
|
|
436
|
+
|
|
437
|
+
sig do
|
|
438
|
+
override.returns(
|
|
439
|
+
{
|
|
440
|
+
adjusted_at: Time,
|
|
441
|
+
amount: Integer,
|
|
442
|
+
reason:
|
|
443
|
+
Increase::CheckDeposit::DepositAdjustment::Reason::TaggedSymbol,
|
|
444
|
+
transaction_id: String
|
|
445
|
+
}
|
|
446
|
+
)
|
|
447
|
+
end
|
|
448
|
+
def to_hash
|
|
449
|
+
end
|
|
450
|
+
|
|
451
|
+
# The reason for the adjustment.
|
|
452
|
+
module Reason
|
|
453
|
+
extend Increase::Internal::Type::Enum
|
|
454
|
+
|
|
455
|
+
TaggedSymbol =
|
|
456
|
+
T.type_alias do
|
|
457
|
+
T.all(Symbol, Increase::CheckDeposit::DepositAdjustment::Reason)
|
|
458
|
+
end
|
|
459
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
460
|
+
|
|
461
|
+
# The return was initiated too late and the receiving institution has responded with a Late Return Claim.
|
|
462
|
+
LATE_RETURN =
|
|
463
|
+
T.let(
|
|
464
|
+
:late_return,
|
|
465
|
+
Increase::CheckDeposit::DepositAdjustment::Reason::TaggedSymbol
|
|
466
|
+
)
|
|
467
|
+
|
|
468
|
+
# The check was deposited to the wrong payee and the depositing institution has reimbursed the funds with a Wrong Payee Credit.
|
|
469
|
+
WRONG_PAYEE_CREDIT =
|
|
470
|
+
T.let(
|
|
471
|
+
:wrong_payee_credit,
|
|
472
|
+
Increase::CheckDeposit::DepositAdjustment::Reason::TaggedSymbol
|
|
473
|
+
)
|
|
474
|
+
|
|
475
|
+
# The check was deposited with a different amount than what was written on the check.
|
|
476
|
+
ADJUSTED_AMOUNT =
|
|
477
|
+
T.let(
|
|
478
|
+
:adjusted_amount,
|
|
479
|
+
Increase::CheckDeposit::DepositAdjustment::Reason::TaggedSymbol
|
|
480
|
+
)
|
|
481
|
+
|
|
482
|
+
# The recipient was not able to process the check. This usually happens for e.g., low quality images.
|
|
483
|
+
NON_CONFORMING_ITEM =
|
|
484
|
+
T.let(
|
|
485
|
+
:non_conforming_item,
|
|
486
|
+
Increase::CheckDeposit::DepositAdjustment::Reason::TaggedSymbol
|
|
487
|
+
)
|
|
488
|
+
|
|
489
|
+
# The check has already been deposited elsewhere and so this is a duplicate.
|
|
490
|
+
PAID =
|
|
491
|
+
T.let(
|
|
492
|
+
:paid,
|
|
493
|
+
Increase::CheckDeposit::DepositAdjustment::Reason::TaggedSymbol
|
|
494
|
+
)
|
|
495
|
+
|
|
496
|
+
sig do
|
|
497
|
+
override.returns(
|
|
498
|
+
T::Array[
|
|
499
|
+
Increase::CheckDeposit::DepositAdjustment::Reason::TaggedSymbol
|
|
500
|
+
]
|
|
501
|
+
)
|
|
502
|
+
end
|
|
503
|
+
def self.values
|
|
504
|
+
end
|
|
505
|
+
end
|
|
506
|
+
end
|
|
507
|
+
|
|
376
508
|
class DepositRejection < Increase::Internal::Type::BaseModel
|
|
377
509
|
OrHash =
|
|
378
510
|
T.type_alias do
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# typed: strong
|
|
2
|
+
|
|
3
|
+
module Increase
|
|
4
|
+
module Models
|
|
5
|
+
module Simulations
|
|
6
|
+
class CardAuthenticationChallengeAttemptsParams < Increase::Internal::Type::BaseModel
|
|
7
|
+
extend Increase::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include Increase::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
OrHash =
|
|
11
|
+
T.type_alias do
|
|
12
|
+
T.any(
|
|
13
|
+
Increase::Simulations::CardAuthenticationChallengeAttemptsParams,
|
|
14
|
+
Increase::Internal::AnyHash
|
|
15
|
+
)
|
|
16
|
+
end
|
|
17
|
+
|
|
18
|
+
# The one-time code to be validated.
|
|
19
|
+
sig { returns(String) }
|
|
20
|
+
attr_accessor :one_time_code
|
|
21
|
+
|
|
22
|
+
sig do
|
|
23
|
+
params(
|
|
24
|
+
one_time_code: String,
|
|
25
|
+
request_options: Increase::RequestOptions::OrHash
|
|
26
|
+
).returns(T.attached_class)
|
|
27
|
+
end
|
|
28
|
+
def self.new(
|
|
29
|
+
# The one-time code to be validated.
|
|
30
|
+
one_time_code:,
|
|
31
|
+
request_options: {}
|
|
32
|
+
)
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
sig do
|
|
36
|
+
override.returns(
|
|
37
|
+
{ one_time_code: String, request_options: Increase::RequestOptions }
|
|
38
|
+
)
|
|
39
|
+
end
|
|
40
|
+
def to_hash
|
|
41
|
+
end
|
|
42
|
+
end
|
|
43
|
+
end
|
|
44
|
+
end
|
|
45
|
+
end
|