increase 1.294.0 → 1.295.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: 9e5dcc8dd08f58f6ae9204e2e9ae0f36352ccb71f23e523aa620651c86b0c614
4
- data.tar.gz: 0b15784ef624a7adef77a687db26ce2563786db6fffa42fe5e650e397d8a7864
3
+ metadata.gz: 567701574c02ba560bbb96a1e04827f022b68d0a7cf84e0872ea76c9af85dece
4
+ data.tar.gz: 0253d3e5d408b42a93191492eb0f3e489abb3a9477dc323fbcbcee5c5b4b33ba
5
5
  SHA512:
6
- metadata.gz: 7b3196b5a27d4e21b7345cb9abebee720a1a1246d108a2f11ca9d9c2e7ec5c0d708f07e61769c6c63baae0769b68673469c47ca21e1d604d942ef77d4f916887
7
- data.tar.gz: a405a85ed0c105a1f70d54ef1b1bd0cc72ff2d6f64a54dab294bc94c34ffe5eed4bd01ef7c220b4db1e38d54a42228a345e9952f0aa42b334fcb0f5284e30bd8
6
+ metadata.gz: 5a3ea4fa764355741a79cef56034c5d44e46fb39349aab6c9ef8b54bed59b7f22fd195ea0c7664f6723d80a4b0584886e682e4aa90f3fe2dcc38120b00d0de4c
7
+ data.tar.gz: ec2cad6647a883fa54596c4c7630d07c380d74a9fd075db0b8981934bc8156d406f10fc0cbde04a920898dc15d3f2f0771d98cf6a930317e9fcc2d96c710e247
data/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # Changelog
2
2
 
3
+ ## 1.295.0 (2026-04-13)
4
+
5
+ Full Changelog: [v1.294.0...v1.295.0](https://github.com/Increase/increase-ruby/compare/v1.294.0...v1.295.0)
6
+
7
+ ### Features
8
+
9
+ * **api:** api update ([b0eedbe](https://github.com/Increase/increase-ruby/commit/b0eedbe1db3daaf38c542071c9430e602def8045))
10
+
3
11
  ## 1.294.0 (2026-04-13)
4
12
 
5
13
  Full Changelog: [v1.293.0...v1.294.0](https://github.com/Increase/increase-ruby/compare/v1.293.0...v1.294.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.294.0"
18
+ gem "increase", "~> 1.295.0"
19
19
  ```
20
20
 
21
21
  <!-- x-release-please-end -->
@@ -0,0 +1,214 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Increase
4
+ module Models
5
+ module Simulations
6
+ # @see Increase::Resources::Simulations::CardPurchaseSupplements#create
7
+ class CardPurchaseSupplementCreateParams < Increase::Internal::Type::BaseModel
8
+ extend Increase::Internal::Type::RequestParameters::Converter
9
+ include Increase::Internal::Type::RequestParameters
10
+
11
+ # @!attribute transaction_id
12
+ # The identifier of the Transaction to create a Card Purchase Supplement for. The
13
+ # Transaction must have a source of type `card_settlement`.
14
+ #
15
+ # @return [String]
16
+ required :transaction_id, String
17
+
18
+ # @!attribute invoice
19
+ # Invoice-level information about the payment.
20
+ #
21
+ # @return [Increase::Models::Simulations::CardPurchaseSupplementCreateParams::Invoice, nil]
22
+ optional :invoice, -> { Increase::Simulations::CardPurchaseSupplementCreateParams::Invoice }
23
+
24
+ # @!attribute line_items
25
+ # Line item information, such as individual products purchased.
26
+ #
27
+ # @return [Array<Increase::Models::Simulations::CardPurchaseSupplementCreateParams::LineItem>, nil]
28
+ optional :line_items,
29
+ -> { Increase::Internal::Type::ArrayOf[Increase::Simulations::CardPurchaseSupplementCreateParams::LineItem] }
30
+
31
+ # @!method initialize(transaction_id:, invoice: nil, line_items: nil, request_options: {})
32
+ # Some parameter documentations has been truncated, see
33
+ # {Increase::Models::Simulations::CardPurchaseSupplementCreateParams} for more
34
+ # details.
35
+ #
36
+ # @param transaction_id [String] The identifier of the Transaction to create a Card Purchase Supplement for. The
37
+ #
38
+ # @param invoice [Increase::Models::Simulations::CardPurchaseSupplementCreateParams::Invoice] Invoice-level information about the payment.
39
+ #
40
+ # @param line_items [Array<Increase::Models::Simulations::CardPurchaseSupplementCreateParams::LineItem>] Line item information, such as individual products purchased.
41
+ #
42
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
43
+
44
+ class Invoice < Increase::Internal::Type::BaseModel
45
+ # @!attribute discount_amount
46
+ # Discount given to cardholder.
47
+ #
48
+ # @return [Integer, nil]
49
+ optional :discount_amount, Integer
50
+
51
+ # @!attribute duty_tax_amount
52
+ # Amount of duty taxes.
53
+ #
54
+ # @return [Integer, nil]
55
+ optional :duty_tax_amount, Integer
56
+
57
+ # @!attribute order_date
58
+ # Date the order was taken.
59
+ #
60
+ # @return [Date, nil]
61
+ optional :order_date, Date
62
+
63
+ # @!attribute shipping_amount
64
+ # The shipping cost.
65
+ #
66
+ # @return [Integer, nil]
67
+ optional :shipping_amount, Integer
68
+
69
+ # @!attribute shipping_destination_country_code
70
+ # Country code of the shipping destination.
71
+ #
72
+ # @return [String, nil]
73
+ optional :shipping_destination_country_code, String
74
+
75
+ # @!attribute shipping_destination_postal_code
76
+ # Postal code of the shipping destination.
77
+ #
78
+ # @return [String, nil]
79
+ optional :shipping_destination_postal_code, String
80
+
81
+ # @!attribute shipping_source_postal_code
82
+ # Postal code of the location being shipped from.
83
+ #
84
+ # @return [String, nil]
85
+ optional :shipping_source_postal_code, String
86
+
87
+ # @!attribute shipping_tax_amount
88
+ # Taxes paid for freight and shipping.
89
+ #
90
+ # @return [Integer, nil]
91
+ optional :shipping_tax_amount, Integer
92
+
93
+ # @!attribute shipping_tax_rate
94
+ # Tax rate for freight and shipping.
95
+ #
96
+ # @return [String, nil]
97
+ optional :shipping_tax_rate, String
98
+
99
+ # @!attribute unique_value_added_tax_invoice_reference
100
+ # Value added tax invoice reference number.
101
+ #
102
+ # @return [String, nil]
103
+ optional :unique_value_added_tax_invoice_reference, String
104
+
105
+ # @!method initialize(discount_amount: nil, duty_tax_amount: nil, order_date: nil, shipping_amount: nil, shipping_destination_country_code: nil, shipping_destination_postal_code: nil, shipping_source_postal_code: nil, shipping_tax_amount: nil, shipping_tax_rate: nil, unique_value_added_tax_invoice_reference: nil)
106
+ # Invoice-level information about the payment.
107
+ #
108
+ # @param discount_amount [Integer] Discount given to cardholder.
109
+ #
110
+ # @param duty_tax_amount [Integer] Amount of duty taxes.
111
+ #
112
+ # @param order_date [Date] Date the order was taken.
113
+ #
114
+ # @param shipping_amount [Integer] The shipping cost.
115
+ #
116
+ # @param shipping_destination_country_code [String] Country code of the shipping destination.
117
+ #
118
+ # @param shipping_destination_postal_code [String] Postal code of the shipping destination.
119
+ #
120
+ # @param shipping_source_postal_code [String] Postal code of the location being shipped from.
121
+ #
122
+ # @param shipping_tax_amount [Integer] Taxes paid for freight and shipping.
123
+ #
124
+ # @param shipping_tax_rate [String] Tax rate for freight and shipping.
125
+ #
126
+ # @param unique_value_added_tax_invoice_reference [String] Value added tax invoice reference number.
127
+ end
128
+
129
+ class LineItem < Increase::Internal::Type::BaseModel
130
+ # @!attribute discount_amount
131
+ # Discount amount for this specific line item.
132
+ #
133
+ # @return [Integer, nil]
134
+ optional :discount_amount, Integer
135
+
136
+ # @!attribute item_commodity_code
137
+ # Code used to categorize the purchase item.
138
+ #
139
+ # @return [String, nil]
140
+ optional :item_commodity_code, String
141
+
142
+ # @!attribute item_descriptor
143
+ # Description of the purchase item.
144
+ #
145
+ # @return [String, nil]
146
+ optional :item_descriptor, String
147
+
148
+ # @!attribute item_quantity
149
+ # The number of units of the product being purchased.
150
+ #
151
+ # @return [String, nil]
152
+ optional :item_quantity, String
153
+
154
+ # @!attribute product_code
155
+ # Code used to categorize the product being purchased.
156
+ #
157
+ # @return [String, nil]
158
+ optional :product_code, String
159
+
160
+ # @!attribute sales_tax_amount
161
+ # Sales tax amount for this line item.
162
+ #
163
+ # @return [Integer, nil]
164
+ optional :sales_tax_amount, Integer
165
+
166
+ # @!attribute sales_tax_rate
167
+ # Sales tax rate for this line item.
168
+ #
169
+ # @return [String, nil]
170
+ optional :sales_tax_rate, String
171
+
172
+ # @!attribute total_amount
173
+ # Total amount of all line items.
174
+ #
175
+ # @return [Integer, nil]
176
+ optional :total_amount, Integer
177
+
178
+ # @!attribute unit_cost
179
+ # Cost of line item per unit of measure, in major units.
180
+ #
181
+ # @return [String, nil]
182
+ optional :unit_cost, String
183
+
184
+ # @!attribute unit_of_measure_code
185
+ # Code indicating unit of measure (gallons, etc.).
186
+ #
187
+ # @return [String, nil]
188
+ optional :unit_of_measure_code, String
189
+
190
+ # @!method initialize(discount_amount: nil, item_commodity_code: nil, item_descriptor: nil, item_quantity: nil, product_code: nil, sales_tax_amount: nil, sales_tax_rate: nil, total_amount: nil, unit_cost: nil, unit_of_measure_code: nil)
191
+ # @param discount_amount [Integer] Discount amount for this specific line item.
192
+ #
193
+ # @param item_commodity_code [String] Code used to categorize the purchase item.
194
+ #
195
+ # @param item_descriptor [String] Description of the purchase item.
196
+ #
197
+ # @param item_quantity [String] The number of units of the product being purchased.
198
+ #
199
+ # @param product_code [String] Code used to categorize the product being purchased.
200
+ #
201
+ # @param sales_tax_amount [Integer] Sales tax amount for this line item.
202
+ #
203
+ # @param sales_tax_rate [String] Sales tax rate for this line item.
204
+ #
205
+ # @param total_amount [Integer] Total amount of all line items.
206
+ #
207
+ # @param unit_cost [String] Cost of line item per unit of measure, in major units.
208
+ #
209
+ # @param unit_of_measure_code [String] Code indicating unit of measure (gallons, etc.).
210
+ end
211
+ end
212
+ end
213
+ end
214
+ end
@@ -0,0 +1,48 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Increase
4
+ module Resources
5
+ class Simulations
6
+ class CardPurchaseSupplements
7
+ # Some parameter documentations has been truncated, see
8
+ # {Increase::Models::Simulations::CardPurchaseSupplementCreateParams} for more
9
+ # details.
10
+ #
11
+ # Simulates the creation of a Card Purchase Supplement (Level 3 data) for a card
12
+ # settlement. This happens asynchronously in production when Visa sends enhanced
13
+ # transaction data about a purchase.
14
+ #
15
+ # @overload create(transaction_id:, invoice: nil, line_items: nil, request_options: {})
16
+ #
17
+ # @param transaction_id [String] The identifier of the Transaction to create a Card Purchase Supplement for. The
18
+ #
19
+ # @param invoice [Increase::Models::Simulations::CardPurchaseSupplementCreateParams::Invoice] Invoice-level information about the payment.
20
+ #
21
+ # @param line_items [Array<Increase::Models::Simulations::CardPurchaseSupplementCreateParams::LineItem>] Line item information, such as individual products purchased.
22
+ #
23
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
24
+ #
25
+ # @return [Increase::Models::CardPurchaseSupplement]
26
+ #
27
+ # @see Increase::Models::Simulations::CardPurchaseSupplementCreateParams
28
+ def create(params)
29
+ parsed, options = Increase::Simulations::CardPurchaseSupplementCreateParams.dump_request(params)
30
+ @client.request(
31
+ method: :post,
32
+ path: "simulations/card_purchase_supplements",
33
+ body: parsed,
34
+ model: Increase::CardPurchaseSupplement,
35
+ options: options
36
+ )
37
+ end
38
+
39
+ # @api private
40
+ #
41
+ # @param client [Increase::Client]
42
+ def initialize(client:)
43
+ @client = client
44
+ end
45
+ end
46
+ end
47
+ end
48
+ end
@@ -33,6 +33,9 @@ module Increase
33
33
  # @return [Increase::Resources::Simulations::CardAuthentications]
34
34
  attr_reader :card_authentications
35
35
 
36
+ # @return [Increase::Resources::Simulations::CardPurchaseSupplements]
37
+ attr_reader :card_purchase_supplements
38
+
36
39
  # @return [Increase::Resources::Simulations::CardDisputes]
37
40
  attr_reader :card_disputes
38
41
 
@@ -115,6 +118,8 @@ module Increase
115
118
  @card_fuel_confirmations = Increase::Resources::Simulations::CardFuelConfirmations.new(client: client)
116
119
  @card_refunds = Increase::Resources::Simulations::CardRefunds.new(client: client)
117
120
  @card_authentications = Increase::Resources::Simulations::CardAuthentications.new(client: client)
121
+ @card_purchase_supplements =
122
+ Increase::Resources::Simulations::CardPurchaseSupplements.new(client: client)
118
123
  @card_disputes = Increase::Resources::Simulations::CardDisputes.new(client: client)
119
124
  @physical_cards = Increase::Resources::Simulations::PhysicalCards.new(client: client)
120
125
  @digital_wallet_token_requests =
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Increase
4
- VERSION = "1.294.0"
4
+ VERSION = "1.295.0"
5
5
  end
data/lib/increase.rb CHANGED
@@ -308,6 +308,7 @@ require_relative "increase/models/simulations/card_balance_inquiry_create_params
308
308
  require_relative "increase/models/simulations/card_dispute_action_params"
309
309
  require_relative "increase/models/simulations/card_fuel_confirmation_create_params"
310
310
  require_relative "increase/models/simulations/card_increment_create_params"
311
+ require_relative "increase/models/simulations/card_purchase_supplement_create_params"
311
312
  require_relative "increase/models/simulations/card_refund_create_params"
312
313
  require_relative "increase/models/simulations/card_reversal_create_params"
313
314
  require_relative "increase/models/simulations/card_settlement_create_params"
@@ -425,6 +426,7 @@ require_relative "increase/resources/simulations/card_balance_inquiries"
425
426
  require_relative "increase/resources/simulations/card_disputes"
426
427
  require_relative "increase/resources/simulations/card_fuel_confirmations"
427
428
  require_relative "increase/resources/simulations/card_increments"
429
+ require_relative "increase/resources/simulations/card_purchase_supplements"
428
430
  require_relative "increase/resources/simulations/card_refunds"
429
431
  require_relative "increase/resources/simulations/card_reversals"
430
432
  require_relative "increase/resources/simulations/card_settlements"
@@ -0,0 +1,381 @@
1
+ # typed: strong
2
+
3
+ module Increase
4
+ module Models
5
+ module Simulations
6
+ class CardPurchaseSupplementCreateParams < 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::CardPurchaseSupplementCreateParams,
14
+ Increase::Internal::AnyHash
15
+ )
16
+ end
17
+
18
+ # The identifier of the Transaction to create a Card Purchase Supplement for. The
19
+ # Transaction must have a source of type `card_settlement`.
20
+ sig { returns(String) }
21
+ attr_accessor :transaction_id
22
+
23
+ # Invoice-level information about the payment.
24
+ sig do
25
+ returns(
26
+ T.nilable(
27
+ Increase::Simulations::CardPurchaseSupplementCreateParams::Invoice
28
+ )
29
+ )
30
+ end
31
+ attr_reader :invoice
32
+
33
+ sig do
34
+ params(
35
+ invoice:
36
+ Increase::Simulations::CardPurchaseSupplementCreateParams::Invoice::OrHash
37
+ ).void
38
+ end
39
+ attr_writer :invoice
40
+
41
+ # Line item information, such as individual products purchased.
42
+ sig do
43
+ returns(
44
+ T.nilable(
45
+ T::Array[
46
+ Increase::Simulations::CardPurchaseSupplementCreateParams::LineItem
47
+ ]
48
+ )
49
+ )
50
+ end
51
+ attr_reader :line_items
52
+
53
+ sig do
54
+ params(
55
+ line_items:
56
+ T::Array[
57
+ Increase::Simulations::CardPurchaseSupplementCreateParams::LineItem::OrHash
58
+ ]
59
+ ).void
60
+ end
61
+ attr_writer :line_items
62
+
63
+ sig do
64
+ params(
65
+ transaction_id: String,
66
+ invoice:
67
+ Increase::Simulations::CardPurchaseSupplementCreateParams::Invoice::OrHash,
68
+ line_items:
69
+ T::Array[
70
+ Increase::Simulations::CardPurchaseSupplementCreateParams::LineItem::OrHash
71
+ ],
72
+ request_options: Increase::RequestOptions::OrHash
73
+ ).returns(T.attached_class)
74
+ end
75
+ def self.new(
76
+ # The identifier of the Transaction to create a Card Purchase Supplement for. The
77
+ # Transaction must have a source of type `card_settlement`.
78
+ transaction_id:,
79
+ # Invoice-level information about the payment.
80
+ invoice: nil,
81
+ # Line item information, such as individual products purchased.
82
+ line_items: nil,
83
+ request_options: {}
84
+ )
85
+ end
86
+
87
+ sig do
88
+ override.returns(
89
+ {
90
+ transaction_id: String,
91
+ invoice:
92
+ Increase::Simulations::CardPurchaseSupplementCreateParams::Invoice,
93
+ line_items:
94
+ T::Array[
95
+ Increase::Simulations::CardPurchaseSupplementCreateParams::LineItem
96
+ ],
97
+ request_options: Increase::RequestOptions
98
+ }
99
+ )
100
+ end
101
+ def to_hash
102
+ end
103
+
104
+ class Invoice < Increase::Internal::Type::BaseModel
105
+ OrHash =
106
+ T.type_alias do
107
+ T.any(
108
+ Increase::Simulations::CardPurchaseSupplementCreateParams::Invoice,
109
+ Increase::Internal::AnyHash
110
+ )
111
+ end
112
+
113
+ # Discount given to cardholder.
114
+ sig { returns(T.nilable(Integer)) }
115
+ attr_reader :discount_amount
116
+
117
+ sig { params(discount_amount: Integer).void }
118
+ attr_writer :discount_amount
119
+
120
+ # Amount of duty taxes.
121
+ sig { returns(T.nilable(Integer)) }
122
+ attr_reader :duty_tax_amount
123
+
124
+ sig { params(duty_tax_amount: Integer).void }
125
+ attr_writer :duty_tax_amount
126
+
127
+ # Date the order was taken.
128
+ sig { returns(T.nilable(Date)) }
129
+ attr_reader :order_date
130
+
131
+ sig { params(order_date: Date).void }
132
+ attr_writer :order_date
133
+
134
+ # The shipping cost.
135
+ sig { returns(T.nilable(Integer)) }
136
+ attr_reader :shipping_amount
137
+
138
+ sig { params(shipping_amount: Integer).void }
139
+ attr_writer :shipping_amount
140
+
141
+ # Country code of the shipping destination.
142
+ sig { returns(T.nilable(String)) }
143
+ attr_reader :shipping_destination_country_code
144
+
145
+ sig { params(shipping_destination_country_code: String).void }
146
+ attr_writer :shipping_destination_country_code
147
+
148
+ # Postal code of the shipping destination.
149
+ sig { returns(T.nilable(String)) }
150
+ attr_reader :shipping_destination_postal_code
151
+
152
+ sig { params(shipping_destination_postal_code: String).void }
153
+ attr_writer :shipping_destination_postal_code
154
+
155
+ # Postal code of the location being shipped from.
156
+ sig { returns(T.nilable(String)) }
157
+ attr_reader :shipping_source_postal_code
158
+
159
+ sig { params(shipping_source_postal_code: String).void }
160
+ attr_writer :shipping_source_postal_code
161
+
162
+ # Taxes paid for freight and shipping.
163
+ sig { returns(T.nilable(Integer)) }
164
+ attr_reader :shipping_tax_amount
165
+
166
+ sig { params(shipping_tax_amount: Integer).void }
167
+ attr_writer :shipping_tax_amount
168
+
169
+ # Tax rate for freight and shipping.
170
+ sig { returns(T.nilable(String)) }
171
+ attr_reader :shipping_tax_rate
172
+
173
+ sig { params(shipping_tax_rate: String).void }
174
+ attr_writer :shipping_tax_rate
175
+
176
+ # Value added tax invoice reference number.
177
+ sig { returns(T.nilable(String)) }
178
+ attr_reader :unique_value_added_tax_invoice_reference
179
+
180
+ sig { params(unique_value_added_tax_invoice_reference: String).void }
181
+ attr_writer :unique_value_added_tax_invoice_reference
182
+
183
+ # Invoice-level information about the payment.
184
+ sig do
185
+ params(
186
+ discount_amount: Integer,
187
+ duty_tax_amount: Integer,
188
+ order_date: Date,
189
+ shipping_amount: Integer,
190
+ shipping_destination_country_code: String,
191
+ shipping_destination_postal_code: String,
192
+ shipping_source_postal_code: String,
193
+ shipping_tax_amount: Integer,
194
+ shipping_tax_rate: String,
195
+ unique_value_added_tax_invoice_reference: String
196
+ ).returns(T.attached_class)
197
+ end
198
+ def self.new(
199
+ # Discount given to cardholder.
200
+ discount_amount: nil,
201
+ # Amount of duty taxes.
202
+ duty_tax_amount: nil,
203
+ # Date the order was taken.
204
+ order_date: nil,
205
+ # The shipping cost.
206
+ shipping_amount: nil,
207
+ # Country code of the shipping destination.
208
+ shipping_destination_country_code: nil,
209
+ # Postal code of the shipping destination.
210
+ shipping_destination_postal_code: nil,
211
+ # Postal code of the location being shipped from.
212
+ shipping_source_postal_code: nil,
213
+ # Taxes paid for freight and shipping.
214
+ shipping_tax_amount: nil,
215
+ # Tax rate for freight and shipping.
216
+ shipping_tax_rate: nil,
217
+ # Value added tax invoice reference number.
218
+ unique_value_added_tax_invoice_reference: nil
219
+ )
220
+ end
221
+
222
+ sig do
223
+ override.returns(
224
+ {
225
+ discount_amount: Integer,
226
+ duty_tax_amount: Integer,
227
+ order_date: Date,
228
+ shipping_amount: Integer,
229
+ shipping_destination_country_code: String,
230
+ shipping_destination_postal_code: String,
231
+ shipping_source_postal_code: String,
232
+ shipping_tax_amount: Integer,
233
+ shipping_tax_rate: String,
234
+ unique_value_added_tax_invoice_reference: String
235
+ }
236
+ )
237
+ end
238
+ def to_hash
239
+ end
240
+ end
241
+
242
+ class LineItem < Increase::Internal::Type::BaseModel
243
+ OrHash =
244
+ T.type_alias do
245
+ T.any(
246
+ Increase::Simulations::CardPurchaseSupplementCreateParams::LineItem,
247
+ Increase::Internal::AnyHash
248
+ )
249
+ end
250
+
251
+ # Discount amount for this specific line item.
252
+ sig { returns(T.nilable(Integer)) }
253
+ attr_reader :discount_amount
254
+
255
+ sig { params(discount_amount: Integer).void }
256
+ attr_writer :discount_amount
257
+
258
+ # Code used to categorize the purchase item.
259
+ sig { returns(T.nilable(String)) }
260
+ attr_reader :item_commodity_code
261
+
262
+ sig { params(item_commodity_code: String).void }
263
+ attr_writer :item_commodity_code
264
+
265
+ # Description of the purchase item.
266
+ sig { returns(T.nilable(String)) }
267
+ attr_reader :item_descriptor
268
+
269
+ sig { params(item_descriptor: String).void }
270
+ attr_writer :item_descriptor
271
+
272
+ # The number of units of the product being purchased.
273
+ sig { returns(T.nilable(String)) }
274
+ attr_reader :item_quantity
275
+
276
+ sig { params(item_quantity: String).void }
277
+ attr_writer :item_quantity
278
+
279
+ # Code used to categorize the product being purchased.
280
+ sig { returns(T.nilable(String)) }
281
+ attr_reader :product_code
282
+
283
+ sig { params(product_code: String).void }
284
+ attr_writer :product_code
285
+
286
+ # Sales tax amount for this line item.
287
+ sig { returns(T.nilable(Integer)) }
288
+ attr_reader :sales_tax_amount
289
+
290
+ sig { params(sales_tax_amount: Integer).void }
291
+ attr_writer :sales_tax_amount
292
+
293
+ # Sales tax rate for this line item.
294
+ sig { returns(T.nilable(String)) }
295
+ attr_reader :sales_tax_rate
296
+
297
+ sig { params(sales_tax_rate: String).void }
298
+ attr_writer :sales_tax_rate
299
+
300
+ # Total amount of all line items.
301
+ sig { returns(T.nilable(Integer)) }
302
+ attr_reader :total_amount
303
+
304
+ sig { params(total_amount: Integer).void }
305
+ attr_writer :total_amount
306
+
307
+ # Cost of line item per unit of measure, in major units.
308
+ sig { returns(T.nilable(String)) }
309
+ attr_reader :unit_cost
310
+
311
+ sig { params(unit_cost: String).void }
312
+ attr_writer :unit_cost
313
+
314
+ # Code indicating unit of measure (gallons, etc.).
315
+ sig { returns(T.nilable(String)) }
316
+ attr_reader :unit_of_measure_code
317
+
318
+ sig { params(unit_of_measure_code: String).void }
319
+ attr_writer :unit_of_measure_code
320
+
321
+ sig do
322
+ params(
323
+ discount_amount: Integer,
324
+ item_commodity_code: String,
325
+ item_descriptor: String,
326
+ item_quantity: String,
327
+ product_code: String,
328
+ sales_tax_amount: Integer,
329
+ sales_tax_rate: String,
330
+ total_amount: Integer,
331
+ unit_cost: String,
332
+ unit_of_measure_code: String
333
+ ).returns(T.attached_class)
334
+ end
335
+ def self.new(
336
+ # Discount amount for this specific line item.
337
+ discount_amount: nil,
338
+ # Code used to categorize the purchase item.
339
+ item_commodity_code: nil,
340
+ # Description of the purchase item.
341
+ item_descriptor: nil,
342
+ # The number of units of the product being purchased.
343
+ item_quantity: nil,
344
+ # Code used to categorize the product being purchased.
345
+ product_code: nil,
346
+ # Sales tax amount for this line item.
347
+ sales_tax_amount: nil,
348
+ # Sales tax rate for this line item.
349
+ sales_tax_rate: nil,
350
+ # Total amount of all line items.
351
+ total_amount: nil,
352
+ # Cost of line item per unit of measure, in major units.
353
+ unit_cost: nil,
354
+ # Code indicating unit of measure (gallons, etc.).
355
+ unit_of_measure_code: nil
356
+ )
357
+ end
358
+
359
+ sig do
360
+ override.returns(
361
+ {
362
+ discount_amount: Integer,
363
+ item_commodity_code: String,
364
+ item_descriptor: String,
365
+ item_quantity: String,
366
+ product_code: String,
367
+ sales_tax_amount: Integer,
368
+ sales_tax_rate: String,
369
+ total_amount: Integer,
370
+ unit_cost: String,
371
+ unit_of_measure_code: String
372
+ }
373
+ )
374
+ end
375
+ def to_hash
376
+ end
377
+ end
378
+ end
379
+ end
380
+ end
381
+ end
@@ -0,0 +1,41 @@
1
+ # typed: strong
2
+
3
+ module Increase
4
+ module Resources
5
+ class Simulations
6
+ class CardPurchaseSupplements
7
+ # Simulates the creation of a Card Purchase Supplement (Level 3 data) for a card
8
+ # settlement. This happens asynchronously in production when Visa sends enhanced
9
+ # transaction data about a purchase.
10
+ sig do
11
+ params(
12
+ transaction_id: String,
13
+ invoice:
14
+ Increase::Simulations::CardPurchaseSupplementCreateParams::Invoice::OrHash,
15
+ line_items:
16
+ T::Array[
17
+ Increase::Simulations::CardPurchaseSupplementCreateParams::LineItem::OrHash
18
+ ],
19
+ request_options: Increase::RequestOptions::OrHash
20
+ ).returns(Increase::CardPurchaseSupplement)
21
+ end
22
+ def create(
23
+ # The identifier of the Transaction to create a Card Purchase Supplement for. The
24
+ # Transaction must have a source of type `card_settlement`.
25
+ transaction_id:,
26
+ # Invoice-level information about the payment.
27
+ invoice: nil,
28
+ # Line item information, such as individual products purchased.
29
+ line_items: nil,
30
+ request_options: {}
31
+ )
32
+ end
33
+
34
+ # @api private
35
+ sig { params(client: Increase::Client).returns(T.attached_class) }
36
+ def self.new(client:)
37
+ end
38
+ end
39
+ end
40
+ end
41
+ end
@@ -35,6 +35,9 @@ module Increase
35
35
  sig { returns(Increase::Resources::Simulations::CardAuthentications) }
36
36
  attr_reader :card_authentications
37
37
 
38
+ sig { returns(Increase::Resources::Simulations::CardPurchaseSupplements) }
39
+ attr_reader :card_purchase_supplements
40
+
38
41
  sig { returns(Increase::Resources::Simulations::CardDisputes) }
39
42
  attr_reader :card_disputes
40
43
 
@@ -0,0 +1,210 @@
1
+ module Increase
2
+ module Models
3
+ module Simulations
4
+ type card_purchase_supplement_create_params =
5
+ {
6
+ transaction_id: String,
7
+ invoice: Increase::Simulations::CardPurchaseSupplementCreateParams::Invoice,
8
+ line_items: ::Array[Increase::Simulations::CardPurchaseSupplementCreateParams::LineItem]
9
+ }
10
+ & Increase::Internal::Type::request_parameters
11
+
12
+ class CardPurchaseSupplementCreateParams < Increase::Internal::Type::BaseModel
13
+ extend Increase::Internal::Type::RequestParameters::Converter
14
+ include Increase::Internal::Type::RequestParameters
15
+
16
+ attr_accessor transaction_id: String
17
+
18
+ attr_reader invoice: Increase::Simulations::CardPurchaseSupplementCreateParams::Invoice?
19
+
20
+ def invoice=: (
21
+ Increase::Simulations::CardPurchaseSupplementCreateParams::Invoice
22
+ ) -> Increase::Simulations::CardPurchaseSupplementCreateParams::Invoice
23
+
24
+ attr_reader line_items: ::Array[Increase::Simulations::CardPurchaseSupplementCreateParams::LineItem]?
25
+
26
+ def line_items=: (
27
+ ::Array[Increase::Simulations::CardPurchaseSupplementCreateParams::LineItem]
28
+ ) -> ::Array[Increase::Simulations::CardPurchaseSupplementCreateParams::LineItem]
29
+
30
+ def initialize: (
31
+ transaction_id: String,
32
+ ?invoice: Increase::Simulations::CardPurchaseSupplementCreateParams::Invoice,
33
+ ?line_items: ::Array[Increase::Simulations::CardPurchaseSupplementCreateParams::LineItem],
34
+ ?request_options: Increase::request_opts
35
+ ) -> void
36
+
37
+ def to_hash: -> {
38
+ transaction_id: String,
39
+ invoice: Increase::Simulations::CardPurchaseSupplementCreateParams::Invoice,
40
+ line_items: ::Array[Increase::Simulations::CardPurchaseSupplementCreateParams::LineItem],
41
+ request_options: Increase::RequestOptions
42
+ }
43
+
44
+ type invoice =
45
+ {
46
+ discount_amount: Integer,
47
+ duty_tax_amount: Integer,
48
+ order_date: Date,
49
+ shipping_amount: Integer,
50
+ shipping_destination_country_code: String,
51
+ shipping_destination_postal_code: String,
52
+ shipping_source_postal_code: String,
53
+ shipping_tax_amount: Integer,
54
+ shipping_tax_rate: String,
55
+ unique_value_added_tax_invoice_reference: String
56
+ }
57
+
58
+ class Invoice < Increase::Internal::Type::BaseModel
59
+ attr_reader discount_amount: Integer?
60
+
61
+ def discount_amount=: (Integer) -> Integer
62
+
63
+ attr_reader duty_tax_amount: Integer?
64
+
65
+ def duty_tax_amount=: (Integer) -> Integer
66
+
67
+ attr_reader order_date: Date?
68
+
69
+ def order_date=: (Date) -> Date
70
+
71
+ attr_reader shipping_amount: Integer?
72
+
73
+ def shipping_amount=: (Integer) -> Integer
74
+
75
+ attr_reader shipping_destination_country_code: String?
76
+
77
+ def shipping_destination_country_code=: (String) -> String
78
+
79
+ attr_reader shipping_destination_postal_code: String?
80
+
81
+ def shipping_destination_postal_code=: (String) -> String
82
+
83
+ attr_reader shipping_source_postal_code: String?
84
+
85
+ def shipping_source_postal_code=: (String) -> String
86
+
87
+ attr_reader shipping_tax_amount: Integer?
88
+
89
+ def shipping_tax_amount=: (Integer) -> Integer
90
+
91
+ attr_reader shipping_tax_rate: String?
92
+
93
+ def shipping_tax_rate=: (String) -> String
94
+
95
+ attr_reader unique_value_added_tax_invoice_reference: String?
96
+
97
+ def unique_value_added_tax_invoice_reference=: (String) -> String
98
+
99
+ def initialize: (
100
+ ?discount_amount: Integer,
101
+ ?duty_tax_amount: Integer,
102
+ ?order_date: Date,
103
+ ?shipping_amount: Integer,
104
+ ?shipping_destination_country_code: String,
105
+ ?shipping_destination_postal_code: String,
106
+ ?shipping_source_postal_code: String,
107
+ ?shipping_tax_amount: Integer,
108
+ ?shipping_tax_rate: String,
109
+ ?unique_value_added_tax_invoice_reference: String
110
+ ) -> void
111
+
112
+ def to_hash: -> {
113
+ discount_amount: Integer,
114
+ duty_tax_amount: Integer,
115
+ order_date: Date,
116
+ shipping_amount: Integer,
117
+ shipping_destination_country_code: String,
118
+ shipping_destination_postal_code: String,
119
+ shipping_source_postal_code: String,
120
+ shipping_tax_amount: Integer,
121
+ shipping_tax_rate: String,
122
+ unique_value_added_tax_invoice_reference: String
123
+ }
124
+ end
125
+
126
+ type line_item =
127
+ {
128
+ discount_amount: Integer,
129
+ item_commodity_code: String,
130
+ item_descriptor: String,
131
+ item_quantity: String,
132
+ product_code: String,
133
+ sales_tax_amount: Integer,
134
+ sales_tax_rate: String,
135
+ total_amount: Integer,
136
+ unit_cost: String,
137
+ unit_of_measure_code: String
138
+ }
139
+
140
+ class LineItem < Increase::Internal::Type::BaseModel
141
+ attr_reader discount_amount: Integer?
142
+
143
+ def discount_amount=: (Integer) -> Integer
144
+
145
+ attr_reader item_commodity_code: String?
146
+
147
+ def item_commodity_code=: (String) -> String
148
+
149
+ attr_reader item_descriptor: String?
150
+
151
+ def item_descriptor=: (String) -> String
152
+
153
+ attr_reader item_quantity: String?
154
+
155
+ def item_quantity=: (String) -> String
156
+
157
+ attr_reader product_code: String?
158
+
159
+ def product_code=: (String) -> String
160
+
161
+ attr_reader sales_tax_amount: Integer?
162
+
163
+ def sales_tax_amount=: (Integer) -> Integer
164
+
165
+ attr_reader sales_tax_rate: String?
166
+
167
+ def sales_tax_rate=: (String) -> String
168
+
169
+ attr_reader total_amount: Integer?
170
+
171
+ def total_amount=: (Integer) -> Integer
172
+
173
+ attr_reader unit_cost: String?
174
+
175
+ def unit_cost=: (String) -> String
176
+
177
+ attr_reader unit_of_measure_code: String?
178
+
179
+ def unit_of_measure_code=: (String) -> String
180
+
181
+ def initialize: (
182
+ ?discount_amount: Integer,
183
+ ?item_commodity_code: String,
184
+ ?item_descriptor: String,
185
+ ?item_quantity: String,
186
+ ?product_code: String,
187
+ ?sales_tax_amount: Integer,
188
+ ?sales_tax_rate: String,
189
+ ?total_amount: Integer,
190
+ ?unit_cost: String,
191
+ ?unit_of_measure_code: String
192
+ ) -> void
193
+
194
+ def to_hash: -> {
195
+ discount_amount: Integer,
196
+ item_commodity_code: String,
197
+ item_descriptor: String,
198
+ item_quantity: String,
199
+ product_code: String,
200
+ sales_tax_amount: Integer,
201
+ sales_tax_rate: String,
202
+ total_amount: Integer,
203
+ unit_cost: String,
204
+ unit_of_measure_code: String
205
+ }
206
+ end
207
+ end
208
+ end
209
+ end
210
+ end
@@ -0,0 +1,16 @@
1
+ module Increase
2
+ module Resources
3
+ class Simulations
4
+ class CardPurchaseSupplements
5
+ def create: (
6
+ transaction_id: String,
7
+ ?invoice: Increase::Simulations::CardPurchaseSupplementCreateParams::Invoice,
8
+ ?line_items: ::Array[Increase::Simulations::CardPurchaseSupplementCreateParams::LineItem],
9
+ ?request_options: Increase::request_opts
10
+ ) -> Increase::CardPurchaseSupplement
11
+
12
+ def initialize: (client: Increase::Client) -> void
13
+ end
14
+ end
15
+ end
16
+ end
@@ -21,6 +21,8 @@ module Increase
21
21
 
22
22
  attr_reader card_authentications: Increase::Resources::Simulations::CardAuthentications
23
23
 
24
+ attr_reader card_purchase_supplements: Increase::Resources::Simulations::CardPurchaseSupplements
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.294.0
4
+ version: 1.295.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Increase
@@ -338,6 +338,7 @@ files:
338
338
  - lib/increase/models/simulations/card_dispute_action_params.rb
339
339
  - lib/increase/models/simulations/card_fuel_confirmation_create_params.rb
340
340
  - lib/increase/models/simulations/card_increment_create_params.rb
341
+ - lib/increase/models/simulations/card_purchase_supplement_create_params.rb
341
342
  - lib/increase/models/simulations/card_refund_create_params.rb
342
343
  - lib/increase/models/simulations/card_reversal_create_params.rb
343
344
  - lib/increase/models/simulations/card_settlement_create_params.rb
@@ -455,6 +456,7 @@ files:
455
456
  - lib/increase/resources/simulations/card_disputes.rb
456
457
  - lib/increase/resources/simulations/card_fuel_confirmations.rb
457
458
  - lib/increase/resources/simulations/card_increments.rb
459
+ - lib/increase/resources/simulations/card_purchase_supplements.rb
458
460
  - lib/increase/resources/simulations/card_refunds.rb
459
461
  - lib/increase/resources/simulations/card_reversals.rb
460
462
  - lib/increase/resources/simulations/card_settlements.rb
@@ -759,6 +761,7 @@ files:
759
761
  - rbi/increase/models/simulations/card_dispute_action_params.rbi
760
762
  - rbi/increase/models/simulations/card_fuel_confirmation_create_params.rbi
761
763
  - rbi/increase/models/simulations/card_increment_create_params.rbi
764
+ - rbi/increase/models/simulations/card_purchase_supplement_create_params.rbi
762
765
  - rbi/increase/models/simulations/card_refund_create_params.rbi
763
766
  - rbi/increase/models/simulations/card_reversal_create_params.rbi
764
767
  - rbi/increase/models/simulations/card_settlement_create_params.rbi
@@ -876,6 +879,7 @@ files:
876
879
  - rbi/increase/resources/simulations/card_disputes.rbi
877
880
  - rbi/increase/resources/simulations/card_fuel_confirmations.rbi
878
881
  - rbi/increase/resources/simulations/card_increments.rbi
882
+ - rbi/increase/resources/simulations/card_purchase_supplements.rbi
879
883
  - rbi/increase/resources/simulations/card_refunds.rbi
880
884
  - rbi/increase/resources/simulations/card_reversals.rbi
881
885
  - rbi/increase/resources/simulations/card_settlements.rbi
@@ -1179,6 +1183,7 @@ files:
1179
1183
  - sig/increase/models/simulations/card_dispute_action_params.rbs
1180
1184
  - sig/increase/models/simulations/card_fuel_confirmation_create_params.rbs
1181
1185
  - sig/increase/models/simulations/card_increment_create_params.rbs
1186
+ - sig/increase/models/simulations/card_purchase_supplement_create_params.rbs
1182
1187
  - sig/increase/models/simulations/card_refund_create_params.rbs
1183
1188
  - sig/increase/models/simulations/card_reversal_create_params.rbs
1184
1189
  - sig/increase/models/simulations/card_settlement_create_params.rbs
@@ -1296,6 +1301,7 @@ files:
1296
1301
  - sig/increase/resources/simulations/card_disputes.rbs
1297
1302
  - sig/increase/resources/simulations/card_fuel_confirmations.rbs
1298
1303
  - sig/increase/resources/simulations/card_increments.rbs
1304
+ - sig/increase/resources/simulations/card_purchase_supplements.rbs
1299
1305
  - sig/increase/resources/simulations/card_refunds.rbs
1300
1306
  - sig/increase/resources/simulations/card_reversals.rbs
1301
1307
  - sig/increase/resources/simulations/card_settlements.rbs