increase 1.217.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 26a77a23dc8c764bfa79aaa005456d2cffbcdc060e06c2a173633f60c786dfcc
4
- data.tar.gz: 44b3637ec3aa79d2c92425d060e29b504447e13c37ce53856fde6519d910c582
3
+ metadata.gz: 0cd7dde29c42405ca749acf881e24a487184457b1371388b5b828eec58d80154
4
+ data.tar.gz: 4d75b7acb28334eb6c2bd01aaa115636881e51b5d754e1634cc8dd150a3d615c
5
5
  SHA512:
6
- metadata.gz: 367227a99e017c597f780711ff82345674734e5bbe07654c976bfc59fd0198148339c004ba9937b34c60f1194f6166c2a589f30db1062366a65a4c9f35888a11
7
- data.tar.gz: 57988c078c09701afeb9a42f75872afc0ece49731cd38a9cae16ddfcd6cda8b19ee98e332015a9ddc7d5b1c1b3b8a162a40abf6419d68ae5c5a8f63bb92aefc3
6
+ metadata.gz: 6038c8150968381895ce68f88068016ff234b1b757666067eb419b320ba2000052bfab03d8fbfc8ce28ac9f20ccf1b3edd3344f65aee932e2b556e0a80bd5012
7
+ data.tar.gz: eeab266d19941a50bdd29dd53a46fd73a8047f7b5186f0beb16372367453249758fa5658ed47785e859a5b892c79b4f571137d7508c888890b05815daa020136
data/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
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
+
3
11
  ## 1.217.0 (2026-03-02)
4
12
 
5
13
  Full Changelog: [v1.216.0...v1.217.0](https://github.com/Increase/increase-ruby/compare/v1.216.0...v1.217.0)
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.217.0"
18
+ gem "increase", "~> 1.218.0"
19
19
  ```
20
20
 
21
21
  <!-- x-release-please-end -->
@@ -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 =
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Increase
4
- VERSION = "1.217.0"
4
+ VERSION = "1.218.0"
5
5
  end
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"
@@ -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
@@ -0,0 +1,32 @@
1
+ # typed: strong
2
+
3
+ module Increase
4
+ module Models
5
+ module Simulations
6
+ class CardAuthenticationChallengesParams < 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::CardAuthenticationChallengesParams,
14
+ Increase::Internal::AnyHash
15
+ )
16
+ end
17
+
18
+ sig do
19
+ params(request_options: Increase::RequestOptions::OrHash).returns(
20
+ T.attached_class
21
+ )
22
+ end
23
+ def self.new(request_options: {})
24
+ end
25
+
26
+ sig { override.returns({ request_options: Increase::RequestOptions }) }
27
+ def to_hash
28
+ end
29
+ end
30
+ end
31
+ end
32
+ end
@@ -0,0 +1,238 @@
1
+ # typed: strong
2
+
3
+ module Increase
4
+ module Models
5
+ module Simulations
6
+ class CardAuthenticationCreateParams < 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::CardAuthenticationCreateParams,
14
+ Increase::Internal::AnyHash
15
+ )
16
+ end
17
+
18
+ # The identifier of the Card to be authorized.
19
+ sig { returns(String) }
20
+ attr_accessor :card_id
21
+
22
+ # The category of the card authentication attempt.
23
+ sig do
24
+ returns(
25
+ T.nilable(
26
+ Increase::Simulations::CardAuthenticationCreateParams::Category::OrSymbol
27
+ )
28
+ )
29
+ end
30
+ attr_reader :category
31
+
32
+ sig do
33
+ params(
34
+ category:
35
+ Increase::Simulations::CardAuthenticationCreateParams::Category::OrSymbol
36
+ ).void
37
+ end
38
+ attr_writer :category
39
+
40
+ # The device channel of the card authentication attempt.
41
+ sig do
42
+ returns(
43
+ T.nilable(
44
+ Increase::Simulations::CardAuthenticationCreateParams::DeviceChannel::OrSymbol
45
+ )
46
+ )
47
+ end
48
+ attr_reader :device_channel
49
+
50
+ sig do
51
+ params(
52
+ device_channel:
53
+ Increase::Simulations::CardAuthenticationCreateParams::DeviceChannel::OrSymbol
54
+ ).void
55
+ end
56
+ attr_writer :device_channel
57
+
58
+ # The merchant identifier (commonly abbreviated as MID) of the merchant the card
59
+ # is transacting with.
60
+ sig { returns(T.nilable(String)) }
61
+ attr_reader :merchant_acceptor_id
62
+
63
+ sig { params(merchant_acceptor_id: String).void }
64
+ attr_writer :merchant_acceptor_id
65
+
66
+ # The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
67
+ # card is transacting with.
68
+ sig { returns(T.nilable(String)) }
69
+ attr_reader :merchant_category_code
70
+
71
+ sig { params(merchant_category_code: String).void }
72
+ attr_writer :merchant_category_code
73
+
74
+ # The country the merchant resides in.
75
+ sig { returns(T.nilable(String)) }
76
+ attr_reader :merchant_country
77
+
78
+ sig { params(merchant_country: String).void }
79
+ attr_writer :merchant_country
80
+
81
+ # The name of the merchant
82
+ sig { returns(T.nilable(String)) }
83
+ attr_reader :merchant_name
84
+
85
+ sig { params(merchant_name: String).void }
86
+ attr_writer :merchant_name
87
+
88
+ # The purchase amount in cents.
89
+ sig { returns(T.nilable(Integer)) }
90
+ attr_reader :purchase_amount
91
+
92
+ sig { params(purchase_amount: Integer).void }
93
+ attr_writer :purchase_amount
94
+
95
+ sig do
96
+ params(
97
+ card_id: String,
98
+ category:
99
+ Increase::Simulations::CardAuthenticationCreateParams::Category::OrSymbol,
100
+ device_channel:
101
+ Increase::Simulations::CardAuthenticationCreateParams::DeviceChannel::OrSymbol,
102
+ merchant_acceptor_id: String,
103
+ merchant_category_code: String,
104
+ merchant_country: String,
105
+ merchant_name: String,
106
+ purchase_amount: Integer,
107
+ request_options: Increase::RequestOptions::OrHash
108
+ ).returns(T.attached_class)
109
+ end
110
+ def self.new(
111
+ # The identifier of the Card to be authorized.
112
+ card_id:,
113
+ # The category of the card authentication attempt.
114
+ category: nil,
115
+ # The device channel of the card authentication attempt.
116
+ device_channel: nil,
117
+ # The merchant identifier (commonly abbreviated as MID) of the merchant the card
118
+ # is transacting with.
119
+ merchant_acceptor_id: nil,
120
+ # The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
121
+ # card is transacting with.
122
+ merchant_category_code: nil,
123
+ # The country the merchant resides in.
124
+ merchant_country: nil,
125
+ # The name of the merchant
126
+ merchant_name: nil,
127
+ # The purchase amount in cents.
128
+ purchase_amount: nil,
129
+ request_options: {}
130
+ )
131
+ end
132
+
133
+ sig do
134
+ override.returns(
135
+ {
136
+ card_id: String,
137
+ category:
138
+ Increase::Simulations::CardAuthenticationCreateParams::Category::OrSymbol,
139
+ device_channel:
140
+ Increase::Simulations::CardAuthenticationCreateParams::DeviceChannel::OrSymbol,
141
+ merchant_acceptor_id: String,
142
+ merchant_category_code: String,
143
+ merchant_country: String,
144
+ merchant_name: String,
145
+ purchase_amount: Integer,
146
+ request_options: Increase::RequestOptions
147
+ }
148
+ )
149
+ end
150
+ def to_hash
151
+ end
152
+
153
+ # The category of the card authentication attempt.
154
+ module Category
155
+ extend Increase::Internal::Type::Enum
156
+
157
+ TaggedSymbol =
158
+ T.type_alias do
159
+ T.all(
160
+ Symbol,
161
+ Increase::Simulations::CardAuthenticationCreateParams::Category
162
+ )
163
+ end
164
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
165
+
166
+ # The authentication attempt is for a payment.
167
+ PAYMENT_AUTHENTICATION =
168
+ T.let(
169
+ :payment_authentication,
170
+ Increase::Simulations::CardAuthenticationCreateParams::Category::TaggedSymbol
171
+ )
172
+
173
+ # The authentication attempt is not for a payment.
174
+ NON_PAYMENT_AUTHENTICATION =
175
+ T.let(
176
+ :non_payment_authentication,
177
+ Increase::Simulations::CardAuthenticationCreateParams::Category::TaggedSymbol
178
+ )
179
+
180
+ sig do
181
+ override.returns(
182
+ T::Array[
183
+ Increase::Simulations::CardAuthenticationCreateParams::Category::TaggedSymbol
184
+ ]
185
+ )
186
+ end
187
+ def self.values
188
+ end
189
+ end
190
+
191
+ # The device channel of the card authentication attempt.
192
+ module DeviceChannel
193
+ extend Increase::Internal::Type::Enum
194
+
195
+ TaggedSymbol =
196
+ T.type_alias do
197
+ T.all(
198
+ Symbol,
199
+ Increase::Simulations::CardAuthenticationCreateParams::DeviceChannel
200
+ )
201
+ end
202
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
203
+
204
+ # The authentication attempt was made from an app.
205
+ APP =
206
+ T.let(
207
+ :app,
208
+ Increase::Simulations::CardAuthenticationCreateParams::DeviceChannel::TaggedSymbol
209
+ )
210
+
211
+ # The authentication attempt was made from a browser.
212
+ BROWSER =
213
+ T.let(
214
+ :browser,
215
+ Increase::Simulations::CardAuthenticationCreateParams::DeviceChannel::TaggedSymbol
216
+ )
217
+
218
+ # The authentication attempt was initiated by the 3DS Requestor.
219
+ THREE_DS_REQUESTOR_INITIATED =
220
+ T.let(
221
+ :three_ds_requestor_initiated,
222
+ Increase::Simulations::CardAuthenticationCreateParams::DeviceChannel::TaggedSymbol
223
+ )
224
+
225
+ sig do
226
+ override.returns(
227
+ T::Array[
228
+ Increase::Simulations::CardAuthenticationCreateParams::DeviceChannel::TaggedSymbol
229
+ ]
230
+ )
231
+ end
232
+ def self.values
233
+ end
234
+ end
235
+ end
236
+ end
237
+ end
238
+ end
@@ -0,0 +1,94 @@
1
+ # typed: strong
2
+
3
+ module Increase
4
+ module Resources
5
+ class Simulations
6
+ class CardAuthentications
7
+ # Simulates a Card Authentication attempt on a [Card](#cards). The attempt always
8
+ # results in a [Card Payment](#card_payments) being created, either with a status
9
+ # that allows further action or a terminal failed status.
10
+ sig do
11
+ params(
12
+ card_id: String,
13
+ category:
14
+ Increase::Simulations::CardAuthenticationCreateParams::Category::OrSymbol,
15
+ device_channel:
16
+ Increase::Simulations::CardAuthenticationCreateParams::DeviceChannel::OrSymbol,
17
+ merchant_acceptor_id: String,
18
+ merchant_category_code: String,
19
+ merchant_country: String,
20
+ merchant_name: String,
21
+ purchase_amount: Integer,
22
+ request_options: Increase::RequestOptions::OrHash
23
+ ).returns(Increase::CardPayment)
24
+ end
25
+ def create(
26
+ # The identifier of the Card to be authorized.
27
+ card_id:,
28
+ # The category of the card authentication attempt.
29
+ category: nil,
30
+ # The device channel of the card authentication attempt.
31
+ device_channel: nil,
32
+ # The merchant identifier (commonly abbreviated as MID) of the merchant the card
33
+ # is transacting with.
34
+ merchant_acceptor_id: nil,
35
+ # The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
36
+ # card is transacting with.
37
+ merchant_category_code: nil,
38
+ # The country the merchant resides in.
39
+ merchant_country: nil,
40
+ # The name of the merchant
41
+ merchant_name: nil,
42
+ # The purchase amount in cents.
43
+ purchase_amount: nil,
44
+ request_options: {}
45
+ )
46
+ end
47
+
48
+ # Simulates an attempt at a Card Authentication Challenge. This updates the
49
+ # `card_authentications` object under the [Card Payment](#card_payments). You can
50
+ # also attempt the challenge by navigating to
51
+ # https://dashboard.increase.com/card_authentication_simulation/:card_payment_id.
52
+ sig do
53
+ params(
54
+ card_payment_id: String,
55
+ one_time_code: String,
56
+ request_options: Increase::RequestOptions::OrHash
57
+ ).returns(Increase::CardPayment)
58
+ end
59
+ def challenge_attempts(
60
+ # The identifier of the Card Payment to be challenged.
61
+ card_payment_id,
62
+ # The one-time code to be validated.
63
+ one_time_code:,
64
+ request_options: {}
65
+ )
66
+ end
67
+
68
+ # Simulates starting a Card Authentication Challenge for an existing Card
69
+ # Authentication. This updates the `card_authentications` object under the
70
+ # [Card Payment](#card_payments). To attempt the challenge, use the
71
+ # `/simulations/card_authentications/:card_payment_id/challenge_attempts` endpoint
72
+ # or navigate to
73
+ # https://dashboard.increase.com/card_authentication_simulation/:card_payment_id.
74
+ sig do
75
+ params(
76
+ card_payment_id: String,
77
+ request_options: Increase::RequestOptions::OrHash
78
+ ).returns(Increase::CardPayment)
79
+ end
80
+ def challenges(
81
+ # The identifier of the Card Payment to be challenged.
82
+ card_payment_id,
83
+ request_options: {}
84
+ )
85
+ end
86
+
87
+ # @api private
88
+ sig { params(client: Increase::Client).returns(T.attached_class) }
89
+ def self.new(client:)
90
+ end
91
+ end
92
+ end
93
+ end
94
+ end
@@ -35,6 +35,9 @@ module Increase
35
35
  sig { returns(Increase::Resources::Simulations::CardRefunds) }
36
36
  attr_reader :card_refunds
37
37
 
38
+ sig { returns(Increase::Resources::Simulations::CardAuthentications) }
39
+ attr_reader :card_authentications
40
+
38
41
  sig { returns(Increase::Resources::Simulations::CardDisputes) }
39
42
  attr_reader :card_disputes
40
43
 
@@ -0,0 +1,25 @@
1
+ module Increase
2
+ module Models
3
+ module Simulations
4
+ type card_authentication_challenge_attempts_params =
5
+ { one_time_code: String } & Increase::Internal::Type::request_parameters
6
+
7
+ class CardAuthenticationChallengeAttemptsParams < Increase::Internal::Type::BaseModel
8
+ extend Increase::Internal::Type::RequestParameters::Converter
9
+ include Increase::Internal::Type::RequestParameters
10
+
11
+ attr_accessor one_time_code: String
12
+
13
+ def initialize: (
14
+ one_time_code: String,
15
+ ?request_options: Increase::request_opts
16
+ ) -> void
17
+
18
+ def to_hash: -> {
19
+ one_time_code: String,
20
+ request_options: Increase::RequestOptions
21
+ }
22
+ end
23
+ end
24
+ end
25
+ end
@@ -0,0 +1,17 @@
1
+ module Increase
2
+ module Models
3
+ module Simulations
4
+ type card_authentication_challenges_params =
5
+ { } & Increase::Internal::Type::request_parameters
6
+
7
+ class CardAuthenticationChallengesParams < Increase::Internal::Type::BaseModel
8
+ extend Increase::Internal::Type::RequestParameters::Converter
9
+ include Increase::Internal::Type::RequestParameters
10
+
11
+ def initialize: (?request_options: Increase::request_opts) -> void
12
+
13
+ def to_hash: -> { request_options: Increase::RequestOptions }
14
+ end
15
+ end
16
+ end
17
+ end
@@ -0,0 +1,112 @@
1
+ module Increase
2
+ module Models
3
+ module Simulations
4
+ type card_authentication_create_params =
5
+ {
6
+ card_id: String,
7
+ category: Increase::Models::Simulations::CardAuthenticationCreateParams::category,
8
+ device_channel: Increase::Models::Simulations::CardAuthenticationCreateParams::device_channel,
9
+ merchant_acceptor_id: String,
10
+ merchant_category_code: String,
11
+ merchant_country: String,
12
+ merchant_name: String,
13
+ purchase_amount: Integer
14
+ }
15
+ & Increase::Internal::Type::request_parameters
16
+
17
+ class CardAuthenticationCreateParams < Increase::Internal::Type::BaseModel
18
+ extend Increase::Internal::Type::RequestParameters::Converter
19
+ include Increase::Internal::Type::RequestParameters
20
+
21
+ attr_accessor card_id: String
22
+
23
+ attr_reader category: Increase::Models::Simulations::CardAuthenticationCreateParams::category?
24
+
25
+ def category=: (
26
+ Increase::Models::Simulations::CardAuthenticationCreateParams::category
27
+ ) -> Increase::Models::Simulations::CardAuthenticationCreateParams::category
28
+
29
+ attr_reader device_channel: Increase::Models::Simulations::CardAuthenticationCreateParams::device_channel?
30
+
31
+ def device_channel=: (
32
+ Increase::Models::Simulations::CardAuthenticationCreateParams::device_channel
33
+ ) -> Increase::Models::Simulations::CardAuthenticationCreateParams::device_channel
34
+
35
+ attr_reader merchant_acceptor_id: String?
36
+
37
+ def merchant_acceptor_id=: (String) -> String
38
+
39
+ attr_reader merchant_category_code: String?
40
+
41
+ def merchant_category_code=: (String) -> String
42
+
43
+ attr_reader merchant_country: String?
44
+
45
+ def merchant_country=: (String) -> String
46
+
47
+ attr_reader merchant_name: String?
48
+
49
+ def merchant_name=: (String) -> String
50
+
51
+ attr_reader purchase_amount: Integer?
52
+
53
+ def purchase_amount=: (Integer) -> Integer
54
+
55
+ def initialize: (
56
+ card_id: String,
57
+ ?category: Increase::Models::Simulations::CardAuthenticationCreateParams::category,
58
+ ?device_channel: Increase::Models::Simulations::CardAuthenticationCreateParams::device_channel,
59
+ ?merchant_acceptor_id: String,
60
+ ?merchant_category_code: String,
61
+ ?merchant_country: String,
62
+ ?merchant_name: String,
63
+ ?purchase_amount: Integer,
64
+ ?request_options: Increase::request_opts
65
+ ) -> void
66
+
67
+ def to_hash: -> {
68
+ card_id: String,
69
+ category: Increase::Models::Simulations::CardAuthenticationCreateParams::category,
70
+ device_channel: Increase::Models::Simulations::CardAuthenticationCreateParams::device_channel,
71
+ merchant_acceptor_id: String,
72
+ merchant_category_code: String,
73
+ merchant_country: String,
74
+ merchant_name: String,
75
+ purchase_amount: Integer,
76
+ request_options: Increase::RequestOptions
77
+ }
78
+
79
+ type category = :payment_authentication | :non_payment_authentication
80
+
81
+ module Category
82
+ extend Increase::Internal::Type::Enum
83
+
84
+ # The authentication attempt is for a payment.
85
+ PAYMENT_AUTHENTICATION: :payment_authentication
86
+
87
+ # The authentication attempt is not for a payment.
88
+ NON_PAYMENT_AUTHENTICATION: :non_payment_authentication
89
+
90
+ def self?.values: -> ::Array[Increase::Models::Simulations::CardAuthenticationCreateParams::category]
91
+ end
92
+
93
+ type device_channel = :app | :browser | :three_ds_requestor_initiated
94
+
95
+ module DeviceChannel
96
+ extend Increase::Internal::Type::Enum
97
+
98
+ # The authentication attempt was made from an app.
99
+ APP: :app
100
+
101
+ # The authentication attempt was made from a browser.
102
+ BROWSER: :browser
103
+
104
+ # The authentication attempt was initiated by the 3DS Requestor.
105
+ THREE_DS_REQUESTOR_INITIATED: :three_ds_requestor_initiated
106
+
107
+ def self?.values: -> ::Array[Increase::Models::Simulations::CardAuthenticationCreateParams::device_channel]
108
+ end
109
+ end
110
+ end
111
+ end
112
+ end
@@ -0,0 +1,32 @@
1
+ module Increase
2
+ module Resources
3
+ class Simulations
4
+ class CardAuthentications
5
+ def create: (
6
+ card_id: String,
7
+ ?category: Increase::Models::Simulations::CardAuthenticationCreateParams::category,
8
+ ?device_channel: Increase::Models::Simulations::CardAuthenticationCreateParams::device_channel,
9
+ ?merchant_acceptor_id: String,
10
+ ?merchant_category_code: String,
11
+ ?merchant_country: String,
12
+ ?merchant_name: String,
13
+ ?purchase_amount: Integer,
14
+ ?request_options: Increase::request_opts
15
+ ) -> Increase::CardPayment
16
+
17
+ def challenge_attempts: (
18
+ String card_payment_id,
19
+ one_time_code: String,
20
+ ?request_options: Increase::request_opts
21
+ ) -> Increase::CardPayment
22
+
23
+ def challenges: (
24
+ String card_payment_id,
25
+ ?request_options: Increase::request_opts
26
+ ) -> Increase::CardPayment
27
+
28
+ def initialize: (client: Increase::Client) -> void
29
+ end
30
+ end
31
+ end
32
+ end
@@ -21,6 +21,8 @@ module Increase
21
21
 
22
22
  attr_reader card_refunds: Increase::Resources::Simulations::CardRefunds
23
23
 
24
+ attr_reader card_authentications: Increase::Resources::Simulations::CardAuthentications
25
+
24
26
  attr_reader card_disputes: Increase::Resources::Simulations::CardDisputes
25
27
 
26
28
  attr_reader physical_cards: Increase::Resources::Simulations::PhysicalCards
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: increase
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.217.0
4
+ version: 1.218.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Increase
@@ -310,6 +310,9 @@ files:
310
310
  - lib/increase/models/simulations/ach_transfer_return_params.rb
311
311
  - lib/increase/models/simulations/ach_transfer_settle_params.rb
312
312
  - lib/increase/models/simulations/ach_transfer_submit_params.rb
313
+ - lib/increase/models/simulations/card_authentication_challenge_attempts_params.rb
314
+ - lib/increase/models/simulations/card_authentication_challenges_params.rb
315
+ - lib/increase/models/simulations/card_authentication_create_params.rb
313
316
  - lib/increase/models/simulations/card_authorization_create_params.rb
314
317
  - lib/increase/models/simulations/card_authorization_create_response.rb
315
318
  - lib/increase/models/simulations/card_authorization_expiration_create_params.rb
@@ -423,6 +426,7 @@ files:
423
426
  - lib/increase/resources/simulations/account_statements.rb
424
427
  - lib/increase/resources/simulations/account_transfers.rb
425
428
  - lib/increase/resources/simulations/ach_transfers.rb
429
+ - lib/increase/resources/simulations/card_authentications.rb
426
430
  - lib/increase/resources/simulations/card_authorization_expirations.rb
427
431
  - lib/increase/resources/simulations/card_authorizations.rb
428
432
  - lib/increase/resources/simulations/card_balance_inquiries.rb
@@ -718,6 +722,9 @@ files:
718
722
  - rbi/increase/models/simulations/ach_transfer_return_params.rbi
719
723
  - rbi/increase/models/simulations/ach_transfer_settle_params.rbi
720
724
  - rbi/increase/models/simulations/ach_transfer_submit_params.rbi
725
+ - rbi/increase/models/simulations/card_authentication_challenge_attempts_params.rbi
726
+ - rbi/increase/models/simulations/card_authentication_challenges_params.rbi
727
+ - rbi/increase/models/simulations/card_authentication_create_params.rbi
721
728
  - rbi/increase/models/simulations/card_authorization_create_params.rbi
722
729
  - rbi/increase/models/simulations/card_authorization_create_response.rbi
723
730
  - rbi/increase/models/simulations/card_authorization_expiration_create_params.rbi
@@ -831,6 +838,7 @@ files:
831
838
  - rbi/increase/resources/simulations/account_statements.rbi
832
839
  - rbi/increase/resources/simulations/account_transfers.rbi
833
840
  - rbi/increase/resources/simulations/ach_transfers.rbi
841
+ - rbi/increase/resources/simulations/card_authentications.rbi
834
842
  - rbi/increase/resources/simulations/card_authorization_expirations.rbi
835
843
  - rbi/increase/resources/simulations/card_authorizations.rbi
836
844
  - rbi/increase/resources/simulations/card_balance_inquiries.rbi
@@ -1125,6 +1133,9 @@ files:
1125
1133
  - sig/increase/models/simulations/ach_transfer_return_params.rbs
1126
1134
  - sig/increase/models/simulations/ach_transfer_settle_params.rbs
1127
1135
  - sig/increase/models/simulations/ach_transfer_submit_params.rbs
1136
+ - sig/increase/models/simulations/card_authentication_challenge_attempts_params.rbs
1137
+ - sig/increase/models/simulations/card_authentication_challenges_params.rbs
1138
+ - sig/increase/models/simulations/card_authentication_create_params.rbs
1128
1139
  - sig/increase/models/simulations/card_authorization_create_params.rbs
1129
1140
  - sig/increase/models/simulations/card_authorization_create_response.rbs
1130
1141
  - sig/increase/models/simulations/card_authorization_expiration_create_params.rbs
@@ -1238,6 +1249,7 @@ files:
1238
1249
  - sig/increase/resources/simulations/account_statements.rbs
1239
1250
  - sig/increase/resources/simulations/account_transfers.rbs
1240
1251
  - sig/increase/resources/simulations/ach_transfers.rbs
1252
+ - sig/increase/resources/simulations/card_authentications.rbs
1241
1253
  - sig/increase/resources/simulations/card_authorization_expirations.rbs
1242
1254
  - sig/increase/resources/simulations/card_authorizations.rbs
1243
1255
  - sig/increase/resources/simulations/card_balance_inquiries.rbs