increase 1.81.0 → 1.83.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 +21 -0
- data/README.md +1 -1
- data/lib/increase/client.rb +4 -0
- data/lib/increase/models/{card_create_details_iframe_params.rb → card_detail_create_details_iframe_params.rb} +2 -2
- data/lib/increase/models/{card_details_params.rb → card_detail_details_params.rb} +2 -2
- data/lib/increase/models/card_detail_update_params.rb +22 -0
- data/lib/increase/models/card_details.rb +8 -8
- data/lib/increase/models/card_iframe_url.rb +1 -1
- data/lib/increase/models/card_update_params.rb +9 -1
- data/lib/increase/models/real_time_decision_action_params.rb +8 -18
- data/lib/increase/models/simulations/{physical_card_tracking_updates_params.rb → physical_card_create_params.rb} +6 -7
- data/lib/increase/models.rb +6 -4
- data/lib/increase/resources/card_details.rb +85 -0
- data/lib/increase/resources/cards.rb +3 -48
- data/lib/increase/resources/simulations/physical_cards.rb +28 -29
- data/lib/increase/version.rb +1 -1
- data/lib/increase.rb +5 -3
- data/rbi/increase/client.rbi +3 -0
- data/rbi/increase/models/{card_create_details_iframe_params.rbi → card_detail_create_details_iframe_params.rbi} +2 -2
- data/rbi/increase/models/{card_details_params.rbi → card_detail_details_params.rbi} +2 -2
- data/rbi/increase/models/card_detail_update_params.rbi +40 -0
- data/rbi/increase/models/card_details.rbi +11 -9
- data/rbi/increase/models/card_update_params.rbi +11 -0
- data/rbi/increase/models/real_time_decision_action_params.rbi +12 -27
- data/rbi/increase/models/simulations/{physical_card_tracking_updates_params.rbi → physical_card_create_params.rbi} +11 -11
- data/rbi/increase/models.rbi +7 -5
- data/rbi/increase/resources/card_details.rbi +63 -0
- data/rbi/increase/resources/cards.rbi +3 -34
- data/rbi/increase/resources/simulations/physical_cards.rbi +22 -22
- data/sig/increase/client.rbs +2 -0
- data/sig/increase/models/{card_create_details_iframe_params.rbs → card_detail_create_details_iframe_params.rbs} +2 -2
- data/sig/increase/models/{card_details_params.rbs → card_detail_details_params.rbs} +2 -2
- data/sig/increase/models/card_detail_update_params.rbs +20 -0
- data/sig/increase/models/card_details.rbs +7 -7
- data/sig/increase/models/card_update_params.rbs +7 -0
- data/sig/increase/models/simulations/{physical_card_tracking_updates_params.rbs → physical_card_create_params.rbs} +7 -7
- data/sig/increase/models.rbs +6 -4
- data/sig/increase/resources/card_details.rbs +24 -0
- data/sig/increase/resources/cards.rbs +1 -11
- data/sig/increase/resources/simulations/physical_cards.rbs +8 -8
- metadata +17 -11
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: a156cc8fb30a1aeb5c705fcf7c2a37b505d99f74ad56f6036be8421d416120b8
|
4
|
+
data.tar.gz: abc55330390548940b38d83c0dd56923097349efd05b4098adf2fbbb23bcfd8d
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: d7488833178a3f9b4a6928cc08fd62ed7a6de7f72e22317ffb779c4786128564250cab4b3307ce2e95fd92969dc156e8ac9e871ba1b50a54f5f8d84f93a5816b
|
7
|
+
data.tar.gz: 92c8efabf6627a2c32c6f25ec2084284b4180a44a1b72b645ac2b58c3bc3f6af61a64db1be8608d55c7336d77aaf6a010ce07e6e8d2f4bffb66d7b40c3f25018
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,26 @@
|
|
1
1
|
# Changelog
|
2
2
|
|
3
|
+
## 1.83.0 (2025-09-19)
|
4
|
+
|
5
|
+
Full Changelog: [v1.82.0...v1.83.0](https://github.com/Increase/increase-ruby/compare/v1.82.0...v1.83.0)
|
6
|
+
|
7
|
+
### Features
|
8
|
+
|
9
|
+
* **api:** api update ([e4382bb](https://github.com/Increase/increase-ruby/commit/e4382bb2fad1d76e20ff852aa75d8d819bd13d01))
|
10
|
+
|
11
|
+
|
12
|
+
### Chores
|
13
|
+
|
14
|
+
* do not install brew dependencies in ./scripts/bootstrap by default ([0173be9](https://github.com/Increase/increase-ruby/commit/0173be95cdbd2321196c60b385970c9b2520bcd8))
|
15
|
+
|
16
|
+
## 1.82.0 (2025-09-19)
|
17
|
+
|
18
|
+
Full Changelog: [v1.81.0...v1.82.0](https://github.com/Increase/increase-ruby/compare/v1.81.0...v1.82.0)
|
19
|
+
|
20
|
+
### Features
|
21
|
+
|
22
|
+
* **api:** api update ([624dfb0](https://github.com/Increase/increase-ruby/commit/624dfb082089270ae2431cda1b51e544366cf73c))
|
23
|
+
|
3
24
|
## 1.81.0 (2025-09-18)
|
4
25
|
|
5
26
|
Full Changelog: [v1.80.0...v1.81.0](https://github.com/Increase/increase-ruby/compare/v1.80.0...v1.81.0)
|
data/README.md
CHANGED
data/lib/increase/client.rb
CHANGED
@@ -35,6 +35,9 @@ module Increase
|
|
35
35
|
# @return [Increase::Resources::Cards]
|
36
36
|
attr_reader :cards
|
37
37
|
|
38
|
+
# @return [Increase::Resources::CardDetails]
|
39
|
+
attr_reader :card_details
|
40
|
+
|
38
41
|
# @return [Increase::Resources::CardPayments]
|
39
42
|
attr_reader :card_payments
|
40
43
|
|
@@ -251,6 +254,7 @@ module Increase
|
|
251
254
|
@account_numbers = Increase::Resources::AccountNumbers.new(client: self)
|
252
255
|
@account_transfers = Increase::Resources::AccountTransfers.new(client: self)
|
253
256
|
@cards = Increase::Resources::Cards.new(client: self)
|
257
|
+
@card_details = Increase::Resources::CardDetails.new(client: self)
|
254
258
|
@card_payments = Increase::Resources::CardPayments.new(client: self)
|
255
259
|
@card_purchase_supplements = Increase::Resources::CardPurchaseSupplements.new(client: self)
|
256
260
|
@physical_cards = Increase::Resources::PhysicalCards.new(client: self)
|
@@ -2,8 +2,8 @@
|
|
2
2
|
|
3
3
|
module Increase
|
4
4
|
module Models
|
5
|
-
# @see Increase::Resources::
|
6
|
-
class
|
5
|
+
# @see Increase::Resources::CardDetails#create_details_iframe
|
6
|
+
class CardDetailCreateDetailsIframeParams < Increase::Internal::Type::BaseModel
|
7
7
|
extend Increase::Internal::Type::RequestParameters::Converter
|
8
8
|
include Increase::Internal::Type::RequestParameters
|
9
9
|
|
@@ -2,8 +2,8 @@
|
|
2
2
|
|
3
3
|
module Increase
|
4
4
|
module Models
|
5
|
-
# @see Increase::Resources::
|
6
|
-
class
|
5
|
+
# @see Increase::Resources::CardDetails#details
|
6
|
+
class CardDetailDetailsParams < Increase::Internal::Type::BaseModel
|
7
7
|
extend Increase::Internal::Type::RequestParameters::Converter
|
8
8
|
include Increase::Internal::Type::RequestParameters
|
9
9
|
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Increase
|
4
|
+
module Models
|
5
|
+
# @see Increase::Resources::CardDetails#update
|
6
|
+
class CardDetailUpdateParams < Increase::Internal::Type::BaseModel
|
7
|
+
extend Increase::Internal::Type::RequestParameters::Converter
|
8
|
+
include Increase::Internal::Type::RequestParameters
|
9
|
+
|
10
|
+
# @!attribute pin
|
11
|
+
# The 4-digit PIN for the card, for use with ATMs.
|
12
|
+
#
|
13
|
+
# @return [String]
|
14
|
+
required :pin, String
|
15
|
+
|
16
|
+
# @!method initialize(pin:, request_options: {})
|
17
|
+
# @param pin [String] The 4-digit PIN for the card, for use with ATMs.
|
18
|
+
#
|
19
|
+
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
20
|
+
end
|
21
|
+
end
|
22
|
+
end
|
@@ -2,8 +2,8 @@
|
|
2
2
|
|
3
3
|
module Increase
|
4
4
|
module Models
|
5
|
-
# @see Increase::Resources::
|
6
|
-
class
|
5
|
+
# @see Increase::Resources::CardDetails#update
|
6
|
+
class CardDetailsAPI < Increase::Internal::Type::BaseModel
|
7
7
|
# @!attribute card_id
|
8
8
|
# The identifier for the Card for which sensitive details have been returned.
|
9
9
|
#
|
@@ -38,8 +38,8 @@ module Increase
|
|
38
38
|
# A constant representing the object's type. For this resource it will always be
|
39
39
|
# `card_details`.
|
40
40
|
#
|
41
|
-
# @return [Symbol, Increase::Models::
|
42
|
-
required :type, enum: -> { Increase::
|
41
|
+
# @return [Symbol, Increase::Models::CardDetailsAPI::Type]
|
42
|
+
required :type, enum: -> { Increase::CardDetailsAPI::Type }
|
43
43
|
|
44
44
|
# @!attribute verification_code
|
45
45
|
# The three-digit verification code for the card. It's also known as the Card
|
@@ -51,9 +51,9 @@ module Increase
|
|
51
51
|
|
52
52
|
# @!method initialize(card_id:, expiration_month:, expiration_year:, pin:, primary_account_number:, type:, verification_code:)
|
53
53
|
# Some parameter documentations has been truncated, see
|
54
|
-
# {Increase::Models::
|
54
|
+
# {Increase::Models::CardDetailsAPI} for more details.
|
55
55
|
#
|
56
|
-
# An object containing the sensitive details (card number,
|
56
|
+
# An object containing the sensitive details (card number, CVC, etc) for a Card.
|
57
57
|
#
|
58
58
|
# @param card_id [String] The identifier for the Card for which sensitive details have been returned.
|
59
59
|
#
|
@@ -65,14 +65,14 @@ module Increase
|
|
65
65
|
#
|
66
66
|
# @param primary_account_number [String] The card number.
|
67
67
|
#
|
68
|
-
# @param type [Symbol, Increase::Models::
|
68
|
+
# @param type [Symbol, Increase::Models::CardDetailsAPI::Type] A constant representing the object's type. For this resource it will always be `
|
69
69
|
#
|
70
70
|
# @param verification_code [String] The three-digit verification code for the card. It's also known as the Card Veri
|
71
71
|
|
72
72
|
# A constant representing the object's type. For this resource it will always be
|
73
73
|
# `card_details`.
|
74
74
|
#
|
75
|
-
# @see Increase::Models::
|
75
|
+
# @see Increase::Models::CardDetailsAPI#type
|
76
76
|
module Type
|
77
77
|
extend Increase::Internal::Type::Enum
|
78
78
|
|
@@ -2,7 +2,7 @@
|
|
2
2
|
|
3
3
|
module Increase
|
4
4
|
module Models
|
5
|
-
# @see Increase::Resources::
|
5
|
+
# @see Increase::Resources::CardDetails#create_details_iframe
|
6
6
|
class CardIframeURL < Increase::Internal::Type::BaseModel
|
7
7
|
# @!attribute expires_at
|
8
8
|
# The time the iframe URL will expire.
|
@@ -34,13 +34,19 @@ module Increase
|
|
34
34
|
# @return [String, nil]
|
35
35
|
optional :entity_id, String
|
36
36
|
|
37
|
+
# @!attribute pin
|
38
|
+
# The 4-digit PIN for the card, for use with ATMs.
|
39
|
+
#
|
40
|
+
# @return [String, nil]
|
41
|
+
optional :pin, String
|
42
|
+
|
37
43
|
# @!attribute status
|
38
44
|
# The status to update the Card with.
|
39
45
|
#
|
40
46
|
# @return [Symbol, Increase::Models::CardUpdateParams::Status, nil]
|
41
47
|
optional :status, enum: -> { Increase::CardUpdateParams::Status }
|
42
48
|
|
43
|
-
# @!method initialize(billing_address: nil, description: nil, digital_wallet: nil, entity_id: nil, status: nil, request_options: {})
|
49
|
+
# @!method initialize(billing_address: nil, description: nil, digital_wallet: nil, entity_id: nil, pin: nil, status: nil, request_options: {})
|
44
50
|
# Some parameter documentations has been truncated, see
|
45
51
|
# {Increase::Models::CardUpdateParams} for more details.
|
46
52
|
#
|
@@ -52,6 +58,8 @@ module Increase
|
|
52
58
|
#
|
53
59
|
# @param entity_id [String] The Entity the card belongs to. You only need to supply this in rare situations
|
54
60
|
#
|
61
|
+
# @param pin [String] The 4-digit PIN for the card, for use with ATMs.
|
62
|
+
#
|
55
63
|
# @param status [Symbol, Increase::Models::CardUpdateParams::Status] The status to update the Card with.
|
56
64
|
#
|
57
65
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
@@ -187,15 +187,10 @@ module Increase
|
|
187
187
|
# @!attribute cardholder_address_verification_result
|
188
188
|
# Your decisions on whether or not each provided address component is a match.
|
189
189
|
# Your response here is evaluated against the customer's provided `postal_code`
|
190
|
-
# and `line1`, and an appropriate network response is generated. For
|
191
|
-
#
|
192
|
-
#
|
193
|
-
#
|
194
|
-
# the available address information, or will report that no check was performed if
|
195
|
-
# no address information is available. If you do not provide a response, the
|
196
|
-
# address verification result will be calculated by Increase using the available
|
197
|
-
# address information available on the card. If none is available, Increase will
|
198
|
-
# report that no check was performed.
|
190
|
+
# and `line1`, and an appropriate network response is generated. For more
|
191
|
+
# information, see our
|
192
|
+
# [Address Verification System Codes and Overrides](https://increase.com/documentation/address-verification-system-codes-and-overrides)
|
193
|
+
# guide.
|
199
194
|
#
|
200
195
|
# @return [Increase::Models::RealTimeDecisionActionParams::CardAuthorization::Approval::CardholderAddressVerificationResult, nil]
|
201
196
|
optional :cardholder_address_verification_result,
|
@@ -232,15 +227,10 @@ module Increase
|
|
232
227
|
# @!method initialize(line1:, postal_code:)
|
233
228
|
# Your decisions on whether or not each provided address component is a match.
|
234
229
|
# Your response here is evaluated against the customer's provided `postal_code`
|
235
|
-
# and `line1`, and an appropriate network response is generated. For
|
236
|
-
#
|
237
|
-
#
|
238
|
-
#
|
239
|
-
# the available address information, or will report that no check was performed if
|
240
|
-
# no address information is available. If you do not provide a response, the
|
241
|
-
# address verification result will be calculated by Increase using the available
|
242
|
-
# address information available on the card. If none is available, Increase will
|
243
|
-
# report that no check was performed.
|
230
|
+
# and `line1`, and an appropriate network response is generated. For more
|
231
|
+
# information, see our
|
232
|
+
# [Address Verification System Codes and Overrides](https://increase.com/documentation/address-verification-system-codes-and-overrides)
|
233
|
+
# guide.
|
244
234
|
#
|
245
235
|
# @param line1 [Symbol, Increase::Models::RealTimeDecisionActionParams::CardAuthorization::Approval::CardholderAddressVerificationResult::Line1] Your decision on the address line of the provided address.
|
246
236
|
#
|
@@ -3,16 +3,16 @@
|
|
3
3
|
module Increase
|
4
4
|
module Models
|
5
5
|
module Simulations
|
6
|
-
# @see Increase::Resources::Simulations::PhysicalCards#
|
7
|
-
class
|
6
|
+
# @see Increase::Resources::Simulations::PhysicalCards#create
|
7
|
+
class PhysicalCardCreateParams < Increase::Internal::Type::BaseModel
|
8
8
|
extend Increase::Internal::Type::RequestParameters::Converter
|
9
9
|
include Increase::Internal::Type::RequestParameters
|
10
10
|
|
11
11
|
# @!attribute category
|
12
12
|
# The type of tracking event.
|
13
13
|
#
|
14
|
-
# @return [Symbol, Increase::Models::Simulations::
|
15
|
-
required :category, enum: -> { Increase::Simulations::
|
14
|
+
# @return [Symbol, Increase::Models::Simulations::PhysicalCardCreateParams::Category]
|
15
|
+
required :category, enum: -> { Increase::Simulations::PhysicalCardCreateParams::Category }
|
16
16
|
|
17
17
|
# @!attribute carrier_estimated_delivery_at
|
18
18
|
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time when the
|
@@ -41,10 +41,9 @@ module Increase
|
|
41
41
|
|
42
42
|
# @!method initialize(category:, carrier_estimated_delivery_at: nil, city: nil, postal_code: nil, state: nil, request_options: {})
|
43
43
|
# Some parameter documentations has been truncated, see
|
44
|
-
# {Increase::Models::Simulations::
|
45
|
-
# details.
|
44
|
+
# {Increase::Models::Simulations::PhysicalCardCreateParams} for more details.
|
46
45
|
#
|
47
|
-
# @param category [Symbol, Increase::Models::Simulations::
|
46
|
+
# @param category [Symbol, Increase::Models::Simulations::PhysicalCardCreateParams::Category] The type of tracking event.
|
48
47
|
#
|
49
48
|
# @param carrier_estimated_delivery_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time when the ca
|
50
49
|
#
|
data/lib/increase/models.rb
CHANGED
@@ -131,13 +131,15 @@ module Increase
|
|
131
131
|
|
132
132
|
Card = Increase::Models::Card
|
133
133
|
|
134
|
-
CardCreateDetailsIframeParams = Increase::Models::CardCreateDetailsIframeParams
|
135
|
-
|
136
134
|
CardCreateParams = Increase::Models::CardCreateParams
|
137
135
|
|
138
|
-
|
136
|
+
CardDetailCreateDetailsIframeParams = Increase::Models::CardDetailCreateDetailsIframeParams
|
137
|
+
|
138
|
+
CardDetailDetailsParams = Increase::Models::CardDetailDetailsParams
|
139
|
+
|
140
|
+
CardDetailsAPI = Increase::Models::CardDetailsAPI
|
139
141
|
|
140
|
-
|
142
|
+
CardDetailUpdateParams = Increase::Models::CardDetailUpdateParams
|
141
143
|
|
142
144
|
CardIframeURL = Increase::Models::CardIframeURL
|
143
145
|
|
@@ -0,0 +1,85 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Increase
|
4
|
+
module Resources
|
5
|
+
class CardDetails
|
6
|
+
# Update a Card's Details
|
7
|
+
#
|
8
|
+
# @overload update(card_id, pin:, request_options: {})
|
9
|
+
#
|
10
|
+
# @param card_id [String] The card identifier.
|
11
|
+
#
|
12
|
+
# @param pin [String] The 4-digit PIN for the card, for use with ATMs.
|
13
|
+
#
|
14
|
+
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
15
|
+
#
|
16
|
+
# @return [Increase::Models::CardDetailsAPI]
|
17
|
+
#
|
18
|
+
# @see Increase::Models::CardDetailUpdateParams
|
19
|
+
def update(card_id, params)
|
20
|
+
parsed, options = Increase::CardDetailUpdateParams.dump_request(params)
|
21
|
+
@client.request(
|
22
|
+
method: :patch,
|
23
|
+
path: ["cards/%1$s/details", card_id],
|
24
|
+
body: parsed,
|
25
|
+
model: Increase::CardDetailsAPI,
|
26
|
+
options: options
|
27
|
+
)
|
28
|
+
end
|
29
|
+
|
30
|
+
# Create an iframe URL for a Card to display the card details. More details about
|
31
|
+
# styling and usage can be found in the
|
32
|
+
# [documentation](/documentation/embedded-card-component).
|
33
|
+
#
|
34
|
+
# @overload create_details_iframe(card_id, physical_card_id: nil, request_options: {})
|
35
|
+
#
|
36
|
+
# @param card_id [String] The identifier of the Card to retrieve details for.
|
37
|
+
#
|
38
|
+
# @param physical_card_id [String] The identifier of the Physical Card to retrieve details for.
|
39
|
+
#
|
40
|
+
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
41
|
+
#
|
42
|
+
# @return [Increase::Models::CardIframeURL]
|
43
|
+
#
|
44
|
+
# @see Increase::Models::CardDetailCreateDetailsIframeParams
|
45
|
+
def create_details_iframe(card_id, params = {})
|
46
|
+
parsed, options = Increase::CardDetailCreateDetailsIframeParams.dump_request(params)
|
47
|
+
@client.request(
|
48
|
+
method: :post,
|
49
|
+
path: ["cards/%1$s/create_details_iframe", card_id],
|
50
|
+
body: parsed,
|
51
|
+
model: Increase::CardIframeURL,
|
52
|
+
options: options
|
53
|
+
)
|
54
|
+
end
|
55
|
+
|
56
|
+
# Sensitive details for a Card include the primary account number, expiry, card
|
57
|
+
# verification code, and PIN.
|
58
|
+
#
|
59
|
+
# @overload details(card_id, request_options: {})
|
60
|
+
#
|
61
|
+
# @param card_id [String] The identifier of the Card to retrieve details for.
|
62
|
+
#
|
63
|
+
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
64
|
+
#
|
65
|
+
# @return [Increase::Models::CardDetailsAPI]
|
66
|
+
#
|
67
|
+
# @see Increase::Models::CardDetailDetailsParams
|
68
|
+
def details(card_id, params = {})
|
69
|
+
@client.request(
|
70
|
+
method: :get,
|
71
|
+
path: ["cards/%1$s/details", card_id],
|
72
|
+
model: Increase::CardDetailsAPI,
|
73
|
+
options: params[:request_options]
|
74
|
+
)
|
75
|
+
end
|
76
|
+
|
77
|
+
# @api private
|
78
|
+
#
|
79
|
+
# @param client [Increase::Client]
|
80
|
+
def initialize(client:)
|
81
|
+
@client = client
|
82
|
+
end
|
83
|
+
end
|
84
|
+
end
|
85
|
+
end
|
@@ -55,7 +55,7 @@ module Increase
|
|
55
55
|
#
|
56
56
|
# Update a Card
|
57
57
|
#
|
58
|
-
# @overload update(card_id, billing_address: nil, description: nil, digital_wallet: nil, entity_id: nil, status: nil, request_options: {})
|
58
|
+
# @overload update(card_id, billing_address: nil, description: nil, digital_wallet: nil, entity_id: nil, pin: nil, status: nil, request_options: {})
|
59
59
|
#
|
60
60
|
# @param card_id [String] The card identifier.
|
61
61
|
#
|
@@ -67,6 +67,8 @@ module Increase
|
|
67
67
|
#
|
68
68
|
# @param entity_id [String] The Entity the card belongs to. You only need to supply this in rare situations
|
69
69
|
#
|
70
|
+
# @param pin [String] The 4-digit PIN for the card, for use with ATMs.
|
71
|
+
#
|
70
72
|
# @param status [Symbol, Increase::Models::CardUpdateParams::Status] The status to update the Card with.
|
71
73
|
#
|
72
74
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
@@ -121,53 +123,6 @@ module Increase
|
|
121
123
|
)
|
122
124
|
end
|
123
125
|
|
124
|
-
# Create an iframe URL for a Card to display the card details. More details about
|
125
|
-
# styling and usage can be found in the
|
126
|
-
# [documentation](/documentation/embedded-card-component).
|
127
|
-
#
|
128
|
-
# @overload create_details_iframe(card_id, physical_card_id: nil, request_options: {})
|
129
|
-
#
|
130
|
-
# @param card_id [String] The identifier of the Card to retrieve details for.
|
131
|
-
#
|
132
|
-
# @param physical_card_id [String] The identifier of the Physical Card to retrieve details for.
|
133
|
-
#
|
134
|
-
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
135
|
-
#
|
136
|
-
# @return [Increase::Models::CardIframeURL]
|
137
|
-
#
|
138
|
-
# @see Increase::Models::CardCreateDetailsIframeParams
|
139
|
-
def create_details_iframe(card_id, params = {})
|
140
|
-
parsed, options = Increase::CardCreateDetailsIframeParams.dump_request(params)
|
141
|
-
@client.request(
|
142
|
-
method: :post,
|
143
|
-
path: ["cards/%1$s/create_details_iframe", card_id],
|
144
|
-
body: parsed,
|
145
|
-
model: Increase::CardIframeURL,
|
146
|
-
options: options
|
147
|
-
)
|
148
|
-
end
|
149
|
-
|
150
|
-
# Sensitive details for a Card include the primary account number, expiry, card
|
151
|
-
# verification code, and PIN.
|
152
|
-
#
|
153
|
-
# @overload details(card_id, request_options: {})
|
154
|
-
#
|
155
|
-
# @param card_id [String] The identifier of the Card to retrieve details for.
|
156
|
-
#
|
157
|
-
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
158
|
-
#
|
159
|
-
# @return [Increase::Models::CardDetails]
|
160
|
-
#
|
161
|
-
# @see Increase::Models::CardDetailsParams
|
162
|
-
def details(card_id, params = {})
|
163
|
-
@client.request(
|
164
|
-
method: :get,
|
165
|
-
path: ["cards/%1$s/details", card_id],
|
166
|
-
model: Increase::CardDetails,
|
167
|
-
options: params[:request_options]
|
168
|
-
)
|
169
|
-
end
|
170
|
-
|
171
126
|
# @api private
|
172
127
|
#
|
173
128
|
# @param client [Increase::Client]
|
@@ -4,63 +4,62 @@ module Increase
|
|
4
4
|
module Resources
|
5
5
|
class Simulations
|
6
6
|
class PhysicalCards
|
7
|
-
#
|
8
|
-
#
|
9
|
-
# failed delivery.
|
7
|
+
# Some parameter documentations has been truncated, see
|
8
|
+
# {Increase::Models::Simulations::PhysicalCardCreateParams} for more details.
|
10
9
|
#
|
11
|
-
#
|
10
|
+
# This endpoint allows you to simulate receiving a tracking update for a Physical
|
11
|
+
# Card, to simulate the progress of a shipment.
|
12
|
+
#
|
13
|
+
# @overload create(physical_card_id, category:, carrier_estimated_delivery_at: nil, city: nil, postal_code: nil, state: nil, request_options: {})
|
12
14
|
#
|
13
15
|
# @param physical_card_id [String] The Physical Card you would like to action.
|
14
16
|
#
|
15
|
-
# @param
|
17
|
+
# @param category [Symbol, Increase::Models::Simulations::PhysicalCardCreateParams::Category] The type of tracking event.
|
18
|
+
#
|
19
|
+
# @param carrier_estimated_delivery_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time when the ca
|
20
|
+
#
|
21
|
+
# @param city [String] The city where the event took place.
|
22
|
+
#
|
23
|
+
# @param postal_code [String] The postal code where the event took place.
|
24
|
+
#
|
25
|
+
# @param state [String] The state where the event took place.
|
16
26
|
#
|
17
27
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
18
28
|
#
|
19
29
|
# @return [Increase::Models::PhysicalCard]
|
20
30
|
#
|
21
|
-
# @see Increase::Models::Simulations::
|
22
|
-
def
|
23
|
-
parsed, options = Increase::Simulations::
|
31
|
+
# @see Increase::Models::Simulations::PhysicalCardCreateParams
|
32
|
+
def create(physical_card_id, params)
|
33
|
+
parsed, options = Increase::Simulations::PhysicalCardCreateParams.dump_request(params)
|
24
34
|
@client.request(
|
25
35
|
method: :post,
|
26
|
-
path: ["simulations/physical_cards/%1$s/
|
36
|
+
path: ["simulations/physical_cards/%1$s/tracking_updates", physical_card_id],
|
27
37
|
body: parsed,
|
28
38
|
model: Increase::PhysicalCard,
|
29
39
|
options: options
|
30
40
|
)
|
31
41
|
end
|
32
42
|
|
33
|
-
#
|
34
|
-
#
|
35
|
-
#
|
36
|
-
#
|
37
|
-
# This endpoint allows you to simulate receiving a tracking update for a Physical
|
38
|
-
# Card, to simulate the progress of a shipment.
|
43
|
+
# This endpoint allows you to simulate advancing the shipment status of a Physical
|
44
|
+
# Card, to simulate e.g., that a physical card was attempted shipped but then
|
45
|
+
# failed delivery.
|
39
46
|
#
|
40
|
-
# @overload
|
47
|
+
# @overload advance_shipment(physical_card_id, shipment_status:, request_options: {})
|
41
48
|
#
|
42
49
|
# @param physical_card_id [String] The Physical Card you would like to action.
|
43
50
|
#
|
44
|
-
# @param
|
45
|
-
#
|
46
|
-
# @param carrier_estimated_delivery_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time when the ca
|
47
|
-
#
|
48
|
-
# @param city [String] The city where the event took place.
|
49
|
-
#
|
50
|
-
# @param postal_code [String] The postal code where the event took place.
|
51
|
-
#
|
52
|
-
# @param state [String] The state where the event took place.
|
51
|
+
# @param shipment_status [Symbol, Increase::Models::Simulations::PhysicalCardAdvanceShipmentParams::ShipmentStatus] The shipment status to move the Physical Card to.
|
53
52
|
#
|
54
53
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
55
54
|
#
|
56
55
|
# @return [Increase::Models::PhysicalCard]
|
57
56
|
#
|
58
|
-
# @see Increase::Models::Simulations::
|
59
|
-
def
|
60
|
-
parsed, options = Increase::Simulations::
|
57
|
+
# @see Increase::Models::Simulations::PhysicalCardAdvanceShipmentParams
|
58
|
+
def advance_shipment(physical_card_id, params)
|
59
|
+
parsed, options = Increase::Simulations::PhysicalCardAdvanceShipmentParams.dump_request(params)
|
61
60
|
@client.request(
|
62
61
|
method: :post,
|
63
|
-
path: ["simulations/physical_cards/%1$s/
|
62
|
+
path: ["simulations/physical_cards/%1$s/advance_shipment", physical_card_id],
|
64
63
|
body: parsed,
|
65
64
|
model: Increase::PhysicalCard,
|
66
65
|
options: options
|
data/lib/increase/version.rb
CHANGED
data/lib/increase.rb
CHANGED
@@ -97,10 +97,11 @@ require_relative "increase/models/bookkeeping_entry_set_create_params"
|
|
97
97
|
require_relative "increase/models/bookkeeping_entry_set_list_params"
|
98
98
|
require_relative "increase/models/bookkeeping_entry_set_retrieve_params"
|
99
99
|
require_relative "increase/models/card"
|
100
|
-
require_relative "increase/models/card_create_details_iframe_params"
|
101
100
|
require_relative "increase/models/card_create_params"
|
101
|
+
require_relative "increase/models/card_detail_create_details_iframe_params"
|
102
|
+
require_relative "increase/models/card_detail_details_params"
|
102
103
|
require_relative "increase/models/card_details"
|
103
|
-
require_relative "increase/models/
|
104
|
+
require_relative "increase/models/card_detail_update_params"
|
104
105
|
require_relative "increase/models/card_iframe_url"
|
105
106
|
require_relative "increase/models/card_list_params"
|
106
107
|
require_relative "increase/models/card_payment"
|
@@ -302,7 +303,7 @@ require_relative "increase/models/simulations/inbound_wire_transfer_create_param
|
|
302
303
|
require_relative "increase/models/simulations/interest_payment_create_params"
|
303
304
|
require_relative "increase/models/simulations/pending_transaction_release_inbound_funds_hold_params"
|
304
305
|
require_relative "increase/models/simulations/physical_card_advance_shipment_params"
|
305
|
-
require_relative "increase/models/simulations/
|
306
|
+
require_relative "increase/models/simulations/physical_card_create_params"
|
306
307
|
require_relative "increase/models/simulations/program_create_params"
|
307
308
|
require_relative "increase/models/simulations/real_time_payments_transfer_complete_params"
|
308
309
|
require_relative "increase/models/simulations/wire_drawdown_request_refuse_params"
|
@@ -334,6 +335,7 @@ require_relative "increase/resources/ach_transfers"
|
|
334
335
|
require_relative "increase/resources/bookkeeping_accounts"
|
335
336
|
require_relative "increase/resources/bookkeeping_entries"
|
336
337
|
require_relative "increase/resources/bookkeeping_entry_sets"
|
338
|
+
require_relative "increase/resources/card_details"
|
337
339
|
require_relative "increase/resources/card_payments"
|
338
340
|
require_relative "increase/resources/card_purchase_supplements"
|
339
341
|
require_relative "increase/resources/card_push_transfers"
|
data/rbi/increase/client.rbi
CHANGED
@@ -34,6 +34,9 @@ module Increase
|
|
34
34
|
sig { returns(Increase::Resources::Cards) }
|
35
35
|
attr_reader :cards
|
36
36
|
|
37
|
+
sig { returns(Increase::Resources::CardDetails) }
|
38
|
+
attr_reader :card_details
|
39
|
+
|
37
40
|
sig { returns(Increase::Resources::CardPayments) }
|
38
41
|
attr_reader :card_payments
|
39
42
|
|
@@ -2,14 +2,14 @@
|
|
2
2
|
|
3
3
|
module Increase
|
4
4
|
module Models
|
5
|
-
class
|
5
|
+
class CardDetailCreateDetailsIframeParams < Increase::Internal::Type::BaseModel
|
6
6
|
extend Increase::Internal::Type::RequestParameters::Converter
|
7
7
|
include Increase::Internal::Type::RequestParameters
|
8
8
|
|
9
9
|
OrHash =
|
10
10
|
T.type_alias do
|
11
11
|
T.any(
|
12
|
-
Increase::
|
12
|
+
Increase::CardDetailCreateDetailsIframeParams,
|
13
13
|
Increase::Internal::AnyHash
|
14
14
|
)
|
15
15
|
end
|
@@ -2,13 +2,13 @@
|
|
2
2
|
|
3
3
|
module Increase
|
4
4
|
module Models
|
5
|
-
class
|
5
|
+
class CardDetailDetailsParams < Increase::Internal::Type::BaseModel
|
6
6
|
extend Increase::Internal::Type::RequestParameters::Converter
|
7
7
|
include Increase::Internal::Type::RequestParameters
|
8
8
|
|
9
9
|
OrHash =
|
10
10
|
T.type_alias do
|
11
|
-
T.any(Increase::
|
11
|
+
T.any(Increase::CardDetailDetailsParams, Increase::Internal::AnyHash)
|
12
12
|
end
|
13
13
|
|
14
14
|
sig do
|