cybersource_rest_client 0.0.87 → 0.0.88
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/lib/cybersource_rest_client/api/acp_checkout_api.rb +553 -0
- data/lib/cybersource_rest_client/api/agent_registration_api.rb +721 -0
- data/lib/cybersource_rest_client/api/bank_account_validation_api.rb +0 -1
- data/lib/cybersource_rest_client/api/enrollment_api.rb +104 -0
- data/lib/cybersource_rest_client/api/{merchant_capabilities_api.rb → merchant_registration_api.rb} +47 -391
- data/lib/cybersource_rest_client/api/payment_events_api.rb +197 -0
- data/lib/cybersource_rest_client/api/product_feed_api.rb +365 -0
- data/lib/cybersource_rest_client/api/purchase_intent_api.rb +278 -0
- data/lib/cybersource_rest_client/api/ucp_checkout_api.rb +453 -0
- data/lib/cybersource_rest_client/models/activate_merchant_key_response200.rb +1 -1
- data/lib/cybersource_rest_client/models/add_agent_key_response201.rb +11 -11
- data/lib/cybersource_rest_client/models/agent_registration_response201.rb +13 -15
- data/lib/cybersource_rest_client/models/agent_registration_response201_keys.rb +8 -8
- data/lib/cybersource_rest_client/models/agent_request.rb +9 -11
- data/lib/cybersource_rest_client/models/agent_update.rb +7 -9
- data/lib/cybersource_rest_client/models/auth_reversal_request.rb +1 -1
- data/lib/cybersource_rest_client/models/boarding_payouts_configurations.rb +1 -1
- data/lib/cybersource_rest_client/models/{inline_response_200_19_google_merchant_products.rb → boarding_payouts_configurations_acquirer.rb} +33 -76
- data/lib/cybersource_rest_client/models/{inline_response_200_19_errors.rb → boarding_payouts_configurations_merchant_descriptor.rb} +25 -33
- data/lib/cybersource_rest_client/models/boarding_payouts_configurations_processors.rb +581 -0
- data/lib/cybersource_rest_client/models/capture_payment_request.rb +1 -1
- data/lib/cybersource_rest_client/models/create_order_request.rb +11 -1
- data/lib/cybersource_rest_client/models/create_payment_request.rb +14 -1
- data/lib/cybersource_rest_client/models/create_session_req.rb +14 -1
- data/lib/cybersource_rest_client/models/create_session_request.rb +14 -1
- data/lib/cybersource_rest_client/models/iccv1agents_keys.rb +4 -4
- data/lib/cybersource_rest_client/models/iccv1merchants_api_integrations.rb +2 -2
- data/lib/cybersource_rest_client/models/iccv1merchants_encryption_key.rb +6 -6
- data/lib/cybersource_rest_client/models/iccv1merchants_protocol_interactions.rb +1 -1
- data/lib/cybersource_rest_client/models/iccv1merchants_web_integrations.rb +2 -2
- data/lib/cybersource_rest_client/models/inline_response_200_17.rb +55 -0
- data/lib/cybersource_rest_client/models/inline_response_200_18.rb +40 -0
- data/lib/cybersource_rest_client/models/inline_response_200_19.rb +30 -107
- data/lib/cybersource_rest_client/models/inline_response_200_19_processing.rb +213 -0
- data/lib/cybersource_rest_client/models/inline_response_200_19_syndication.rb +224 -0
- data/lib/cybersource_rest_client/models/inline_response_200_20_products.rb +80 -682
- data/lib/cybersource_rest_client/models/inline_response_201_12.rb +40 -0
- data/lib/cybersource_rest_client/models/inline_response_201_12_fulfillment_options.rb +30 -0
- data/lib/cybersource_rest_client/models/inline_response_201_12_totals.rb +15 -0
- data/lib/cybersource_rest_client/models/inline_response_201_6_setups_risk.rb +15 -5
- data/lib/cybersource_rest_client/models/inline_response_201_6_setups_value_added_services.rb +15 -5
- data/lib/cybersource_rest_client/models/{deactivate_merchant_key_response200.rb → inline_response_202_1.rb} +11 -16
- data/lib/cybersource_rest_client/models/key_request.rb +4 -4
- data/lib/cybersource_rest_client/models/key_request_1.rb +5 -5
- data/lib/cybersource_rest_client/models/key_update.rb +5 -5
- data/lib/cybersource_rest_client/models/key_update_1.rb +5 -5
- data/lib/cybersource_rest_client/models/list_agent_keys_response200.rb +2 -2
- data/lib/cybersource_rest_client/models/merchant_registration_response201.rb +10 -10
- data/lib/cybersource_rest_client/models/merchant_registration_response201_api_integrations.rb +225 -0
- data/lib/cybersource_rest_client/models/merchant_registration_response201_keys.rb +1 -1
- data/lib/cybersource_rest_client/models/merchant_registration_response201_web_integrations.rb +225 -0
- data/lib/cybersource_rest_client/models/merchant_request.rb +7 -7
- data/lib/cybersource_rest_client/models/merchant_update.rb +7 -7
- data/lib/cybersource_rest_client/models/mit_reversal_request.rb +1 -1
- data/lib/cybersource_rest_client/models/mit_void_request.rb +15 -5
- data/lib/cybersource_rest_client/models/payments_configuration_setup.rb +11 -1
- data/lib/cybersource_rest_client/models/payments_products.rb +11 -1
- data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response.rb +12 -1
- data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_1.rb +12 -1
- data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_1_order_information.rb +44 -1
- data/lib/cybersource_rest_client/models/{pts_v2_payouts_post201_response_merchant_information_merchant_descriptor.rb → pts_v2_payments_post201_response_1_order_information_merchant_descriptor.rb} +1 -1
- data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_1_processor_information.rb +18 -1
- data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_installment_information.rb +101 -5
- data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_order_information_ship_to.rb +12 -1
- data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_point_of_sale_information.rb +22 -5
- data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_processor_information.rb +22 -5
- data/lib/cybersource_rest_client/models/pts_v2_payments_refund_post201_response_processor_information.rb +22 -5
- data/lib/cybersource_rest_client/models/pts_v2_payments_reversals_post201_response.rb +1 -1
- data/lib/cybersource_rest_client/models/{ptsv2paymentsidreversals_point_of_sale_information.rb → pts_v2_payments_reversals_post201_response_point_of_sale_information.rb} +2 -2
- data/lib/cybersource_rest_client/models/{ptsv2paymentsidreversals_point_of_sale_information_emv.rb → pts_v2_payments_reversals_post201_response_point_of_sale_information_emv.rb} +1 -1
- data/lib/cybersource_rest_client/models/pts_v2_payments_reversals_post201_response_processor_information.rb +22 -5
- data/lib/cybersource_rest_client/models/pts_v2_payouts_post201_response_merchant_information.rb +1 -1
- data/lib/cybersource_rest_client/models/ptsv2intents_buyer_information.rb +196 -0
- data/lib/cybersource_rest_client/models/ptsv2intents_merchant_information_merchant_descriptor.rb +18 -1
- data/lib/cybersource_rest_client/models/ptsv2intents_order_information_bill_to.rb +154 -1
- data/lib/cybersource_rest_client/models/ptsv2intents_order_information_line_items.rb +16 -5
- data/lib/cybersource_rest_client/models/ptsv2intentsid_merchant_information.rb +1 -1
- data/lib/cybersource_rest_client/models/ptsv2intentsid_merchant_information_merchant_descriptor.rb +207 -0
- data/lib/cybersource_rest_client/models/{ptsv2paymentsidcaptures_point_of_sale_information.rb → ptsv2payments_buyer.rb} +55 -31
- data/lib/cybersource_rest_client/models/{inline_response_200_19_google_merchant.rb → ptsv2payments_order_history.rb} +42 -41
- data/lib/cybersource_rest_client/models/ptsv2payments_ship_to.rb +281 -0
- data/lib/cybersource_rest_client/models/ptsv2paymentsidrefunds_point_of_sale_information.rb +1 -1
- data/lib/cybersource_rest_client/models/{ptsv2paymentsidcaptures_point_of_sale_information_emv.rb → ptsv2paymentsidrefunds_point_of_sale_information_emv.rb} +1 -1
- data/lib/cybersource_rest_client/models/risk_products.rb +15 -5
- data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_point_of_sale_information.rb +1 -1
- data/lib/cybersource_rest_client/models/tss_v2_transactions_post201_response__embedded_point_of_sale_information.rb +1 -1
- data/lib/cybersource_rest_client/models/unifiedrisk_acquirer_merchant_account_security_amount.rb +3 -3
- data/lib/cybersource_rest_client/models/unifiedrisk_merchant_merchant_descriptor_expected_annual_sales.rb +3 -3
- data/lib/cybersource_rest_client/models/unifiedrisk_merchant_merchant_descriptor_expected_average_ticket_size.rb +3 -3
- data/lib/cybersource_rest_client/models/unifiedrisk_merchant_merchant_descriptor_expected_monthly_sales.rb +3 -3
- data/lib/cybersource_rest_client/models/unifiedrisk_merchant_merchant_descriptor_limit_value.rb +3 -3
- data/lib/cybersource_rest_client/models/unifiedrisk_payment_bank_account_balance_before.rb +2 -2
- data/lib/cybersource_rest_client/models/unifiedrisk_payment_bank_account_credit_limit.rb +3 -3
- data/lib/cybersource_rest_client/models/unifiedrisk_transaction_additional_fees.rb +2 -2
- data/lib/cybersource_rest_client/models/unifiedrisk_transaction_amount.rb +3 -3
- data/lib/cybersource_rest_client/models/value_added_services_products.rb +15 -5
- data/lib/cybersource_rest_client/models/void_capture_request.rb +15 -5
- data/lib/cybersource_rest_client/models/void_credit_request.rb +15 -5
- data/lib/cybersource_rest_client/models/void_payment_request.rb +15 -5
- data/lib/cybersource_rest_client/models/void_refund_request.rb +15 -5
- data/lib/cybersource_rest_client.rb +25 -11
- metadata +27 -13
- data/lib/cybersource_rest_client/api/agent_capabilities_api.rb +0 -2279
data/lib/cybersource_rest_client/api/{merchant_capabilities_api.rb → merchant_registration_api.rb}
RENAMED
|
@@ -12,7 +12,7 @@ Swagger Codegen version: 2.4.38
|
|
|
12
12
|
require 'uri'
|
|
13
13
|
require 'AuthenticationSDK/util/MLEUtility'
|
|
14
14
|
module CyberSource
|
|
15
|
-
class
|
|
15
|
+
class MerchantRegistrationApi
|
|
16
16
|
attr_accessor :api_client
|
|
17
17
|
|
|
18
18
|
def initialize(api_client = ApiClient.default, config)
|
|
@@ -20,7 +20,7 @@ module CyberSource
|
|
|
20
20
|
@api_client.set_configuration(config)
|
|
21
21
|
end
|
|
22
22
|
# Activate a merchant key
|
|
23
|
-
# Activate a deactivated key
|
|
23
|
+
# **Activate a Merchant Key**<br>Activates a deactivated encryption key for the specified merchant.<br><br> **Note:** Expired keys must be renewed via `PUT /merchants/{merchantId}/keys/{keyId}` before they can be activated.<br> Returns **403** if the merchant is deactivated or the key is expired, **404** if the merchant or key is not found, **409** if the key is already active.
|
|
24
24
|
#
|
|
25
25
|
# @param merchant_id Unique merchant identifier (UUID)
|
|
26
26
|
# @param key_id Unique key identifier (UUID)
|
|
@@ -33,7 +33,7 @@ module CyberSource
|
|
|
33
33
|
end
|
|
34
34
|
|
|
35
35
|
# Activate a merchant key
|
|
36
|
-
# Activate a deactivated key
|
|
36
|
+
# **Activate a Merchant Key**<br>Activates a deactivated encryption key for the specified merchant.<br><br> **Note:** Expired keys must be renewed via `PUT /merchants/{merchantId}/keys/{keyId}` before they can be activated.<br> Returns **403** if the merchant is deactivated or the key is expired, **404** if the merchant or key is not found, **409** if the key is already active.
|
|
37
37
|
# @param merchant_id Unique merchant identifier (UUID)
|
|
38
38
|
# @param key_id Unique key identifier (UUID)
|
|
39
39
|
# @param [Hash] opts the optional parameters
|
|
@@ -43,18 +43,18 @@ module CyberSource
|
|
|
43
43
|
if @api_client.config.debugging
|
|
44
44
|
begin
|
|
45
45
|
raise
|
|
46
|
-
@api_client.config.logger.debug 'Calling API:
|
|
46
|
+
@api_client.config.logger.debug 'Calling API: MerchantRegistrationApi.activate_merchant_key ...'
|
|
47
47
|
rescue
|
|
48
48
|
puts 'Cannot write to log'
|
|
49
49
|
end
|
|
50
50
|
end
|
|
51
51
|
# verify the required parameter 'merchant_id' is set
|
|
52
52
|
if @api_client.config.client_side_validation && merchant_id.nil?
|
|
53
|
-
fail ArgumentError, "Missing the required parameter 'merchant_id' when calling
|
|
53
|
+
fail ArgumentError, "Missing the required parameter 'merchant_id' when calling MerchantRegistrationApi.activate_merchant_key"
|
|
54
54
|
end
|
|
55
55
|
# verify the required parameter 'key_id' is set
|
|
56
56
|
if @api_client.config.client_side_validation && key_id.nil?
|
|
57
|
-
fail ArgumentError, "Missing the required parameter 'key_id' when calling
|
|
57
|
+
fail ArgumentError, "Missing the required parameter 'key_id' when calling MerchantRegistrationApi.activate_merchant_key"
|
|
58
58
|
end
|
|
59
59
|
# resource path
|
|
60
60
|
local_var_path = 'icc/v1/merchants/{merchantId}/keys/{keyId}/activate'.sub('{' + 'merchantId' + '}', merchant_id.to_s).sub('{' + 'keyId' + '}', key_id.to_s)
|
|
@@ -101,7 +101,7 @@ module CyberSource
|
|
|
101
101
|
if @api_client.config.debugging
|
|
102
102
|
begin
|
|
103
103
|
raise
|
|
104
|
-
@api_client.config.logger.debug "API called:
|
|
104
|
+
@api_client.config.logger.debug "API called: MerchantRegistrationApi#activate_merchant_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
105
105
|
rescue
|
|
106
106
|
puts 'Cannot write to log'
|
|
107
107
|
end
|
|
@@ -109,7 +109,7 @@ module CyberSource
|
|
|
109
109
|
return data, status_code, headers
|
|
110
110
|
end
|
|
111
111
|
# Add a key to a merchant
|
|
112
|
-
# Add a new encryption key for
|
|
112
|
+
# **Add a Key to a Merchant**<br>Adds a new encryption key for the specified merchant. The new key is created as ***active*** immediately.<br><br> **Note:** Adding a new key automatically deactivates all previously active keys for this merchant (single-active key invariant).<br> Returns **403** if the merchant is deactivated, **404** if the merchant is not found.
|
|
113
113
|
#
|
|
114
114
|
# @param merchant_id Unique merchant identifier (UUID)
|
|
115
115
|
# @param key_request Key creation request
|
|
@@ -122,7 +122,7 @@ module CyberSource
|
|
|
122
122
|
end
|
|
123
123
|
|
|
124
124
|
# Add a key to a merchant
|
|
125
|
-
# Add a new encryption key for
|
|
125
|
+
# **Add a Key to a Merchant**<br>Adds a new encryption key for the specified merchant. The new key is created as ***active*** immediately.<br><br> **Note:** Adding a new key automatically deactivates all previously active keys for this merchant (single-active key invariant).<br> Returns **403** if the merchant is deactivated, **404** if the merchant is not found.
|
|
126
126
|
# @param merchant_id Unique merchant identifier (UUID)
|
|
127
127
|
# @param key_request Key creation request
|
|
128
128
|
# @param [Hash] opts the optional parameters
|
|
@@ -132,18 +132,18 @@ module CyberSource
|
|
|
132
132
|
if @api_client.config.debugging
|
|
133
133
|
begin
|
|
134
134
|
raise
|
|
135
|
-
@api_client.config.logger.debug 'Calling API:
|
|
135
|
+
@api_client.config.logger.debug 'Calling API: MerchantRegistrationApi.add_merchant_key ...'
|
|
136
136
|
rescue
|
|
137
137
|
puts 'Cannot write to log'
|
|
138
138
|
end
|
|
139
139
|
end
|
|
140
140
|
# verify the required parameter 'merchant_id' is set
|
|
141
141
|
if @api_client.config.client_side_validation && merchant_id.nil?
|
|
142
|
-
fail ArgumentError, "Missing the required parameter 'merchant_id' when calling
|
|
142
|
+
fail ArgumentError, "Missing the required parameter 'merchant_id' when calling MerchantRegistrationApi.add_merchant_key"
|
|
143
143
|
end
|
|
144
144
|
# verify the required parameter 'key_request' is set
|
|
145
145
|
if @api_client.config.client_side_validation && key_request.nil?
|
|
146
|
-
fail ArgumentError, "Missing the required parameter 'key_request' when calling
|
|
146
|
+
fail ArgumentError, "Missing the required parameter 'key_request' when calling MerchantRegistrationApi.add_merchant_key"
|
|
147
147
|
end
|
|
148
148
|
# resource path
|
|
149
149
|
local_var_path = 'icc/v1/merchants/{merchantId}/keys'.sub('{' + 'merchantId' + '}', merchant_id.to_s)
|
|
@@ -188,183 +188,7 @@ module CyberSource
|
|
|
188
188
|
if @api_client.config.debugging
|
|
189
189
|
begin
|
|
190
190
|
raise
|
|
191
|
-
@api_client.config.logger.debug "API called:
|
|
192
|
-
rescue
|
|
193
|
-
puts 'Cannot write to log'
|
|
194
|
-
end
|
|
195
|
-
end
|
|
196
|
-
return data, status_code, headers
|
|
197
|
-
end
|
|
198
|
-
# Deactivate a merchant key
|
|
199
|
-
# Deactivate a key (soft delete). Raises 401 if not authenticated, 403 if caller does not own the merchant, 404 if key not found.
|
|
200
|
-
#
|
|
201
|
-
# @param merchant_id Unique merchant identifier (UUID)
|
|
202
|
-
# @param key_id Unique key identifier (UUID)
|
|
203
|
-
# @param [Hash] opts the optional parameters
|
|
204
|
-
# @return [DeactivateMerchantKeyResponse200]
|
|
205
|
-
#
|
|
206
|
-
def deactivate_merchant_key(merchant_id, key_id, opts = {})
|
|
207
|
-
data, status_code, headers = deactivate_merchant_key_with_http_info(merchant_id, key_id, opts)
|
|
208
|
-
return data, status_code, headers
|
|
209
|
-
end
|
|
210
|
-
|
|
211
|
-
# Deactivate a merchant key
|
|
212
|
-
# Deactivate a key (soft delete). Raises 401 if not authenticated, 403 if caller does not own the merchant, 404 if key not found.
|
|
213
|
-
# @param merchant_id Unique merchant identifier (UUID)
|
|
214
|
-
# @param key_id Unique key identifier (UUID)
|
|
215
|
-
# @param [Hash] opts the optional parameters
|
|
216
|
-
# @return [Array<(DeactivateMerchantKeyResponse200, Fixnum, Hash)>] DeactivateMerchantKeyResponse200 data, response status code and response headers
|
|
217
|
-
def deactivate_merchant_key_with_http_info(merchant_id, key_id, opts = {})
|
|
218
|
-
|
|
219
|
-
if @api_client.config.debugging
|
|
220
|
-
begin
|
|
221
|
-
raise
|
|
222
|
-
@api_client.config.logger.debug 'Calling API: MerchantCapabilitiesApi.deactivate_merchant_key ...'
|
|
223
|
-
rescue
|
|
224
|
-
puts 'Cannot write to log'
|
|
225
|
-
end
|
|
226
|
-
end
|
|
227
|
-
# verify the required parameter 'merchant_id' is set
|
|
228
|
-
if @api_client.config.client_side_validation && merchant_id.nil?
|
|
229
|
-
fail ArgumentError, "Missing the required parameter 'merchant_id' when calling MerchantCapabilitiesApi.deactivate_merchant_key"
|
|
230
|
-
end
|
|
231
|
-
# verify the required parameter 'key_id' is set
|
|
232
|
-
if @api_client.config.client_side_validation && key_id.nil?
|
|
233
|
-
fail ArgumentError, "Missing the required parameter 'key_id' when calling MerchantCapabilitiesApi.deactivate_merchant_key"
|
|
234
|
-
end
|
|
235
|
-
# resource path
|
|
236
|
-
local_var_path = 'icc/v1/merchants/{merchantId}/keys/{keyId}'.sub('{' + 'merchantId' + '}', merchant_id.to_s).sub('{' + 'keyId' + '}', key_id.to_s)
|
|
237
|
-
|
|
238
|
-
# query parameters
|
|
239
|
-
query_params = {}
|
|
240
|
-
|
|
241
|
-
# header parameters
|
|
242
|
-
header_params = {}
|
|
243
|
-
# HTTP header 'Accept' (if needed)
|
|
244
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/hal+json;charset=utf-8'])
|
|
245
|
-
# HTTP header 'Content-Type'
|
|
246
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8'])
|
|
247
|
-
|
|
248
|
-
# form parameters
|
|
249
|
-
form_params = {}
|
|
250
|
-
|
|
251
|
-
# http body (model)
|
|
252
|
-
if 'DELETE' == 'POST'
|
|
253
|
-
post_body = '{}'
|
|
254
|
-
else
|
|
255
|
-
post_body = nil
|
|
256
|
-
end
|
|
257
|
-
inbound_mle_status = "mandatory"
|
|
258
|
-
if MLEUtility.check_is_mle_for_API(@api_client.merchantconfig, inbound_mle_status, ["deactivate_merchant_key","deactivate_merchant_key_with_http_info"])
|
|
259
|
-
begin
|
|
260
|
-
post_body = MLEUtility.encrypt_request_payload(@api_client.merchantconfig, post_body)
|
|
261
|
-
rescue
|
|
262
|
-
raise
|
|
263
|
-
end
|
|
264
|
-
end
|
|
265
|
-
|
|
266
|
-
is_response_mle_for_api = MLEUtility.check_is_response_mle_for_api(@api_client.merchantconfig, ["deactivate_merchant_key","deactivate_merchant_key_with_http_info"])
|
|
267
|
-
|
|
268
|
-
auth_names = []
|
|
269
|
-
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
|
270
|
-
:header_params => header_params,
|
|
271
|
-
:query_params => query_params,
|
|
272
|
-
:form_params => form_params,
|
|
273
|
-
:body => post_body,
|
|
274
|
-
:auth_names => auth_names,
|
|
275
|
-
:return_type => 'DeactivateMerchantKeyResponse200',
|
|
276
|
-
:isResponseMLEForApi => is_response_mle_for_api)
|
|
277
|
-
if @api_client.config.debugging
|
|
278
|
-
begin
|
|
279
|
-
raise
|
|
280
|
-
@api_client.config.logger.debug "API called: MerchantCapabilitiesApi#deactivate_merchant_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
281
|
-
rescue
|
|
282
|
-
puts 'Cannot write to log'
|
|
283
|
-
end
|
|
284
|
-
end
|
|
285
|
-
return data, status_code, headers
|
|
286
|
-
end
|
|
287
|
-
# Get All Products
|
|
288
|
-
# Returns the full product catalog stored in ACG. **Note:** This endpoint is intended for catalog verification and merchant tooling. It is not a real-time product discovery API for end buyers.
|
|
289
|
-
#
|
|
290
|
-
# @param get_all_products_request Empty request body.
|
|
291
|
-
# @param [Hash] opts the optional parameters
|
|
292
|
-
# @option opts [Integer] :page Page number to retrieve (0-based). Defaults to 0. (default to 0)
|
|
293
|
-
# @option opts [Integer] :size Number of products per page. Defaults to 300. Server enforces a maximum of 1000; values above 1000 are capped. (default to 300)
|
|
294
|
-
# @return [InlineResponse20020]
|
|
295
|
-
#
|
|
296
|
-
def get_all_products(get_all_products_request, opts = {})
|
|
297
|
-
data, status_code, headers = get_all_products_with_http_info(get_all_products_request, opts)
|
|
298
|
-
return data, status_code, headers
|
|
299
|
-
end
|
|
300
|
-
|
|
301
|
-
# Get All Products
|
|
302
|
-
# Returns the full product catalog stored in ACG. **Note:** This endpoint is intended for catalog verification and merchant tooling. It is not a real-time product discovery API for end buyers.
|
|
303
|
-
# @param get_all_products_request Empty request body.
|
|
304
|
-
# @param [Hash] opts the optional parameters
|
|
305
|
-
# @option opts [Integer] :page Page number to retrieve (0-based). Defaults to 0.
|
|
306
|
-
# @option opts [Integer] :size Number of products per page. Defaults to 300. Server enforces a maximum of 1000; values above 1000 are capped.
|
|
307
|
-
# @return [Array<(InlineResponse20020, Fixnum, Hash)>] InlineResponse20020 data, response status code and response headers
|
|
308
|
-
def get_all_products_with_http_info(get_all_products_request, opts = {})
|
|
309
|
-
|
|
310
|
-
if @api_client.config.debugging
|
|
311
|
-
begin
|
|
312
|
-
raise
|
|
313
|
-
@api_client.config.logger.debug 'Calling API: MerchantCapabilitiesApi.get_all_products ...'
|
|
314
|
-
rescue
|
|
315
|
-
puts 'Cannot write to log'
|
|
316
|
-
end
|
|
317
|
-
end
|
|
318
|
-
# verify the required parameter 'get_all_products_request' is set
|
|
319
|
-
if @api_client.config.client_side_validation && get_all_products_request.nil?
|
|
320
|
-
fail ArgumentError, "Missing the required parameter 'get_all_products_request' when calling MerchantCapabilitiesApi.get_all_products"
|
|
321
|
-
end
|
|
322
|
-
# resource path
|
|
323
|
-
local_var_path = 'icc/v1/products'
|
|
324
|
-
|
|
325
|
-
# query parameters
|
|
326
|
-
query_params = {}
|
|
327
|
-
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
|
328
|
-
query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
|
|
329
|
-
|
|
330
|
-
# header parameters
|
|
331
|
-
header_params = {}
|
|
332
|
-
# HTTP header 'Accept' (if needed)
|
|
333
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/hal+json;charset=utf-8'])
|
|
334
|
-
# HTTP header 'Content-Type'
|
|
335
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8'])
|
|
336
|
-
|
|
337
|
-
# form parameters
|
|
338
|
-
form_params = {}
|
|
339
|
-
|
|
340
|
-
# http body (model)
|
|
341
|
-
post_body = @api_client.object_to_http_body(get_all_products_request)
|
|
342
|
-
sdk_tracker = SdkTracker.new
|
|
343
|
-
post_body = sdk_tracker.insert_developer_id_tracker(post_body, 'Object', @api_client.config.host, @api_client.merchantconfig.defaultDeveloperId)
|
|
344
|
-
inbound_mle_status = "false"
|
|
345
|
-
if MLEUtility.check_is_mle_for_API(@api_client.merchantconfig, inbound_mle_status, ["get_all_products","get_all_products_with_http_info"])
|
|
346
|
-
begin
|
|
347
|
-
post_body = MLEUtility.encrypt_request_payload(@api_client.merchantconfig, post_body)
|
|
348
|
-
rescue
|
|
349
|
-
raise
|
|
350
|
-
end
|
|
351
|
-
end
|
|
352
|
-
|
|
353
|
-
is_response_mle_for_api = MLEUtility.check_is_response_mle_for_api(@api_client.merchantconfig, ["get_all_products","get_all_products_with_http_info"])
|
|
354
|
-
|
|
355
|
-
auth_names = []
|
|
356
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
357
|
-
:header_params => header_params,
|
|
358
|
-
:query_params => query_params,
|
|
359
|
-
:form_params => form_params,
|
|
360
|
-
:body => post_body,
|
|
361
|
-
:auth_names => auth_names,
|
|
362
|
-
:return_type => 'InlineResponse20020',
|
|
363
|
-
:isResponseMLEForApi => is_response_mle_for_api)
|
|
364
|
-
if @api_client.config.debugging
|
|
365
|
-
begin
|
|
366
|
-
raise
|
|
367
|
-
@api_client.config.logger.debug "API called: MerchantCapabilitiesApi#get_all_products\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
191
|
+
@api_client.config.logger.debug "API called: MerchantRegistrationApi#add_merchant_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
368
192
|
rescue
|
|
369
193
|
puts 'Cannot write to log'
|
|
370
194
|
end
|
|
@@ -372,7 +196,7 @@ module CyberSource
|
|
|
372
196
|
return data, status_code, headers
|
|
373
197
|
end
|
|
374
198
|
# Get a merchant
|
|
375
|
-
# Get merchant by
|
|
199
|
+
# **Get a Merchant**<br>Retrieves a single merchant by its unique identifier, including all associated encryption keys.<br><br> Returns **404** if the merchant is not found.
|
|
376
200
|
#
|
|
377
201
|
# @param merchant_id Unique merchant identifier (UUID)
|
|
378
202
|
# @param [Hash] opts the optional parameters
|
|
@@ -384,7 +208,7 @@ module CyberSource
|
|
|
384
208
|
end
|
|
385
209
|
|
|
386
210
|
# Get a merchant
|
|
387
|
-
# Get merchant by
|
|
211
|
+
# **Get a Merchant**<br>Retrieves a single merchant by its unique identifier, including all associated encryption keys.<br><br> Returns **404** if the merchant is not found.
|
|
388
212
|
# @param merchant_id Unique merchant identifier (UUID)
|
|
389
213
|
# @param [Hash] opts the optional parameters
|
|
390
214
|
# @return [Array<(MerchantRegistrationResponse201, Fixnum, Hash)>] MerchantRegistrationResponse201 data, response status code and response headers
|
|
@@ -393,14 +217,14 @@ module CyberSource
|
|
|
393
217
|
if @api_client.config.debugging
|
|
394
218
|
begin
|
|
395
219
|
raise
|
|
396
|
-
@api_client.config.logger.debug 'Calling API:
|
|
220
|
+
@api_client.config.logger.debug 'Calling API: MerchantRegistrationApi.get_merchant ...'
|
|
397
221
|
rescue
|
|
398
222
|
puts 'Cannot write to log'
|
|
399
223
|
end
|
|
400
224
|
end
|
|
401
225
|
# verify the required parameter 'merchant_id' is set
|
|
402
226
|
if @api_client.config.client_side_validation && merchant_id.nil?
|
|
403
|
-
fail ArgumentError, "Missing the required parameter 'merchant_id' when calling
|
|
227
|
+
fail ArgumentError, "Missing the required parameter 'merchant_id' when calling MerchantRegistrationApi.get_merchant"
|
|
404
228
|
end
|
|
405
229
|
# resource path
|
|
406
230
|
local_var_path = 'icc/v1/merchants/{merchantId}'.sub('{' + 'merchantId' + '}', merchant_id.to_s)
|
|
@@ -447,7 +271,7 @@ module CyberSource
|
|
|
447
271
|
if @api_client.config.debugging
|
|
448
272
|
begin
|
|
449
273
|
raise
|
|
450
|
-
@api_client.config.logger.debug "API called:
|
|
274
|
+
@api_client.config.logger.debug "API called: MerchantRegistrationApi#get_merchant\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
451
275
|
rescue
|
|
452
276
|
puts 'Cannot write to log'
|
|
453
277
|
end
|
|
@@ -455,7 +279,7 @@ module CyberSource
|
|
|
455
279
|
return data, status_code, headers
|
|
456
280
|
end
|
|
457
281
|
# Get a key by merchant and key ID
|
|
458
|
-
# Get a specific key by merchant ID and key ID
|
|
282
|
+
# **Get a Merchant Key**<br>Retrieves a specific encryption key by merchant ID and key ID.<br><br> Returns **404** if the merchant or key is not found.
|
|
459
283
|
#
|
|
460
284
|
# @param merchant_id Unique merchant identifier (UUID)
|
|
461
285
|
# @param key_id Unique key identifier (UUID)
|
|
@@ -468,7 +292,7 @@ module CyberSource
|
|
|
468
292
|
end
|
|
469
293
|
|
|
470
294
|
# Get a key by merchant and key ID
|
|
471
|
-
# Get a specific key by merchant ID and key ID
|
|
295
|
+
# **Get a Merchant Key**<br>Retrieves a specific encryption key by merchant ID and key ID.<br><br> Returns **404** if the merchant or key is not found.
|
|
472
296
|
# @param merchant_id Unique merchant identifier (UUID)
|
|
473
297
|
# @param key_id Unique key identifier (UUID)
|
|
474
298
|
# @param [Hash] opts the optional parameters
|
|
@@ -478,18 +302,18 @@ module CyberSource
|
|
|
478
302
|
if @api_client.config.debugging
|
|
479
303
|
begin
|
|
480
304
|
raise
|
|
481
|
-
@api_client.config.logger.debug 'Calling API:
|
|
305
|
+
@api_client.config.logger.debug 'Calling API: MerchantRegistrationApi.get_merchant_key ...'
|
|
482
306
|
rescue
|
|
483
307
|
puts 'Cannot write to log'
|
|
484
308
|
end
|
|
485
309
|
end
|
|
486
310
|
# verify the required parameter 'merchant_id' is set
|
|
487
311
|
if @api_client.config.client_side_validation && merchant_id.nil?
|
|
488
|
-
fail ArgumentError, "Missing the required parameter 'merchant_id' when calling
|
|
312
|
+
fail ArgumentError, "Missing the required parameter 'merchant_id' when calling MerchantRegistrationApi.get_merchant_key"
|
|
489
313
|
end
|
|
490
314
|
# verify the required parameter 'key_id' is set
|
|
491
315
|
if @api_client.config.client_side_validation && key_id.nil?
|
|
492
|
-
fail ArgumentError, "Missing the required parameter 'key_id' when calling
|
|
316
|
+
fail ArgumentError, "Missing the required parameter 'key_id' when calling MerchantRegistrationApi.get_merchant_key"
|
|
493
317
|
end
|
|
494
318
|
# resource path
|
|
495
319
|
local_var_path = 'icc/v1/merchants/{merchantId}/keys/{keyId}'.sub('{' + 'merchantId' + '}', merchant_id.to_s).sub('{' + 'keyId' + '}', key_id.to_s)
|
|
@@ -536,175 +360,7 @@ module CyberSource
|
|
|
536
360
|
if @api_client.config.debugging
|
|
537
361
|
begin
|
|
538
362
|
raise
|
|
539
|
-
@api_client.config.logger.debug "API called:
|
|
540
|
-
rescue
|
|
541
|
-
puts 'Cannot write to log'
|
|
542
|
-
end
|
|
543
|
-
end
|
|
544
|
-
return data, status_code, headers
|
|
545
|
-
end
|
|
546
|
-
# Get Product by ID
|
|
547
|
-
# Retrieves a single product from the ACG catalog by its unique product identifier (SKU). Use this to verify that a product was ingested correctly, inspect its current field values, or check its syndication-eligibility flags (`is_eligible_search`, `is_eligible_checkout`).
|
|
548
|
-
#
|
|
549
|
-
# @param product_id The unique product identifier (SKU) assigned by the merchant and provided during feed ingestion. Example: `SKU-1001`.
|
|
550
|
-
# @param get_product_request Empty request body.
|
|
551
|
-
# @param [Hash] opts the optional parameters
|
|
552
|
-
# @return [InlineResponse20021]
|
|
553
|
-
#
|
|
554
|
-
def get_product(product_id, get_product_request, opts = {})
|
|
555
|
-
data, status_code, headers = get_product_with_http_info(product_id, get_product_request, opts)
|
|
556
|
-
return data, status_code, headers
|
|
557
|
-
end
|
|
558
|
-
|
|
559
|
-
# Get Product by ID
|
|
560
|
-
# Retrieves a single product from the ACG catalog by its unique product identifier (SKU). Use this to verify that a product was ingested correctly, inspect its current field values, or check its syndication-eligibility flags (`is_eligible_search`, `is_eligible_checkout`).
|
|
561
|
-
# @param product_id The unique product identifier (SKU) assigned by the merchant and provided during feed ingestion. Example: `SKU-1001`.
|
|
562
|
-
# @param get_product_request Empty request body.
|
|
563
|
-
# @param [Hash] opts the optional parameters
|
|
564
|
-
# @return [Array<(InlineResponse20021, Fixnum, Hash)>] InlineResponse20021 data, response status code and response headers
|
|
565
|
-
def get_product_with_http_info(product_id, get_product_request, opts = {})
|
|
566
|
-
|
|
567
|
-
if @api_client.config.debugging
|
|
568
|
-
begin
|
|
569
|
-
raise
|
|
570
|
-
@api_client.config.logger.debug 'Calling API: MerchantCapabilitiesApi.get_product ...'
|
|
571
|
-
rescue
|
|
572
|
-
puts 'Cannot write to log'
|
|
573
|
-
end
|
|
574
|
-
end
|
|
575
|
-
# verify the required parameter 'product_id' is set
|
|
576
|
-
if @api_client.config.client_side_validation && product_id.nil?
|
|
577
|
-
fail ArgumentError, "Missing the required parameter 'product_id' when calling MerchantCapabilitiesApi.get_product"
|
|
578
|
-
end
|
|
579
|
-
# verify the required parameter 'get_product_request' is set
|
|
580
|
-
if @api_client.config.client_side_validation && get_product_request.nil?
|
|
581
|
-
fail ArgumentError, "Missing the required parameter 'get_product_request' when calling MerchantCapabilitiesApi.get_product"
|
|
582
|
-
end
|
|
583
|
-
# resource path
|
|
584
|
-
local_var_path = 'icc/v1/products/{product_id}'.sub('{' + 'product_id' + '}', product_id.to_s)
|
|
585
|
-
|
|
586
|
-
# query parameters
|
|
587
|
-
query_params = {}
|
|
588
|
-
|
|
589
|
-
# header parameters
|
|
590
|
-
header_params = {}
|
|
591
|
-
# HTTP header 'Accept' (if needed)
|
|
592
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/hal+json;charset=utf-8'])
|
|
593
|
-
# HTTP header 'Content-Type'
|
|
594
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8'])
|
|
595
|
-
|
|
596
|
-
# form parameters
|
|
597
|
-
form_params = {}
|
|
598
|
-
|
|
599
|
-
# http body (model)
|
|
600
|
-
post_body = @api_client.object_to_http_body(get_product_request)
|
|
601
|
-
sdk_tracker = SdkTracker.new
|
|
602
|
-
post_body = sdk_tracker.insert_developer_id_tracker(post_body, 'Object', @api_client.config.host, @api_client.merchantconfig.defaultDeveloperId)
|
|
603
|
-
inbound_mle_status = "false"
|
|
604
|
-
if MLEUtility.check_is_mle_for_API(@api_client.merchantconfig, inbound_mle_status, ["get_product","get_product_with_http_info"])
|
|
605
|
-
begin
|
|
606
|
-
post_body = MLEUtility.encrypt_request_payload(@api_client.merchantconfig, post_body)
|
|
607
|
-
rescue
|
|
608
|
-
raise
|
|
609
|
-
end
|
|
610
|
-
end
|
|
611
|
-
|
|
612
|
-
is_response_mle_for_api = MLEUtility.check_is_response_mle_for_api(@api_client.merchantconfig, ["get_product","get_product_with_http_info"])
|
|
613
|
-
|
|
614
|
-
auth_names = []
|
|
615
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
616
|
-
:header_params => header_params,
|
|
617
|
-
:query_params => query_params,
|
|
618
|
-
:form_params => form_params,
|
|
619
|
-
:body => post_body,
|
|
620
|
-
:auth_names => auth_names,
|
|
621
|
-
:return_type => 'InlineResponse20021',
|
|
622
|
-
:isResponseMLEForApi => is_response_mle_for_api)
|
|
623
|
-
if @api_client.config.debugging
|
|
624
|
-
begin
|
|
625
|
-
raise
|
|
626
|
-
@api_client.config.logger.debug "API called: MerchantCapabilitiesApi#get_product\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
627
|
-
rescue
|
|
628
|
-
puts 'Cannot write to log'
|
|
629
|
-
end
|
|
630
|
-
end
|
|
631
|
-
return data, status_code, headers
|
|
632
|
-
end
|
|
633
|
-
# Ingest Product Feed
|
|
634
|
-
# Uploads a merchant product catalog to ACG and triggers asynchronous syndication to all configured protocol backends (e.g. Google Merchant Center). **Processing pipeline:** 1. Each product is validated against UCP/ACP schema requirements (required fields, format rules) 2. Valid products are saved to the ACG catalog 3. An async syndication job is triggered to push the catalog to configured backends 4. A `feed_id` is returned — use this with the Syndication Status endpoint to monitor progress **Supported content types:** `application/json` (this endpoint). CSV and JSONL uploads are also supported via file upload endpoints. **Partial success:** If some products fail validation, the response status is `PARTIAL_SUCCESS` and the `errors` array lists the per-product validation failures. Successfully validated products are still ingested and syndicated.
|
|
635
|
-
#
|
|
636
|
-
# @param product_feed_request Product feed payload. The `products` array is required and must contain at least one product. See `ProductInput` for the full list of required fields.
|
|
637
|
-
# @param [Hash] opts the optional parameters
|
|
638
|
-
# @return [InlineResponse20019]
|
|
639
|
-
#
|
|
640
|
-
def ingest_product_feed_json(product_feed_request, opts = {})
|
|
641
|
-
data, status_code, headers = ingest_product_feed_json_with_http_info(product_feed_request, opts)
|
|
642
|
-
return data, status_code, headers
|
|
643
|
-
end
|
|
644
|
-
|
|
645
|
-
# Ingest Product Feed
|
|
646
|
-
# Uploads a merchant product catalog to ACG and triggers asynchronous syndication to all configured protocol backends (e.g. Google Merchant Center). **Processing pipeline:** 1. Each product is validated against UCP/ACP schema requirements (required fields, format rules) 2. Valid products are saved to the ACG catalog 3. An async syndication job is triggered to push the catalog to configured backends 4. A `feed_id` is returned — use this with the Syndication Status endpoint to monitor progress **Supported content types:** `application/json` (this endpoint). CSV and JSONL uploads are also supported via file upload endpoints. **Partial success:** If some products fail validation, the response status is `PARTIAL_SUCCESS` and the `errors` array lists the per-product validation failures. Successfully validated products are still ingested and syndicated.
|
|
647
|
-
# @param product_feed_request Product feed payload. The `products` array is required and must contain at least one product. See `ProductInput` for the full list of required fields.
|
|
648
|
-
# @param [Hash] opts the optional parameters
|
|
649
|
-
# @return [Array<(InlineResponse20019, Fixnum, Hash)>] InlineResponse20019 data, response status code and response headers
|
|
650
|
-
def ingest_product_feed_json_with_http_info(product_feed_request, opts = {})
|
|
651
|
-
|
|
652
|
-
if @api_client.config.debugging
|
|
653
|
-
begin
|
|
654
|
-
raise
|
|
655
|
-
@api_client.config.logger.debug 'Calling API: MerchantCapabilitiesApi.ingest_product_feed_json ...'
|
|
656
|
-
rescue
|
|
657
|
-
puts 'Cannot write to log'
|
|
658
|
-
end
|
|
659
|
-
end
|
|
660
|
-
# verify the required parameter 'product_feed_request' is set
|
|
661
|
-
if @api_client.config.client_side_validation && product_feed_request.nil?
|
|
662
|
-
fail ArgumentError, "Missing the required parameter 'product_feed_request' when calling MerchantCapabilitiesApi.ingest_product_feed_json"
|
|
663
|
-
end
|
|
664
|
-
# resource path
|
|
665
|
-
local_var_path = 'icc/v1/products/feed'
|
|
666
|
-
|
|
667
|
-
# query parameters
|
|
668
|
-
query_params = {}
|
|
669
|
-
|
|
670
|
-
# header parameters
|
|
671
|
-
header_params = {}
|
|
672
|
-
# HTTP header 'Accept' (if needed)
|
|
673
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/hal+json;charset=utf-8'])
|
|
674
|
-
# HTTP header 'Content-Type'
|
|
675
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8'])
|
|
676
|
-
|
|
677
|
-
# form parameters
|
|
678
|
-
form_params = {}
|
|
679
|
-
|
|
680
|
-
# http body (model)
|
|
681
|
-
post_body = @api_client.object_to_http_body(product_feed_request)
|
|
682
|
-
sdk_tracker = SdkTracker.new
|
|
683
|
-
post_body = sdk_tracker.insert_developer_id_tracker(post_body, 'ProductFeedRequest', @api_client.config.host, @api_client.merchantconfig.defaultDeveloperId)
|
|
684
|
-
inbound_mle_status = "mandatory"
|
|
685
|
-
if MLEUtility.check_is_mle_for_API(@api_client.merchantconfig, inbound_mle_status, ["ingest_product_feed_json","ingest_product_feed_json_with_http_info"])
|
|
686
|
-
begin
|
|
687
|
-
post_body = MLEUtility.encrypt_request_payload(@api_client.merchantconfig, post_body)
|
|
688
|
-
rescue
|
|
689
|
-
raise
|
|
690
|
-
end
|
|
691
|
-
end
|
|
692
|
-
|
|
693
|
-
is_response_mle_for_api = MLEUtility.check_is_response_mle_for_api(@api_client.merchantconfig, ["ingest_product_feed_json","ingest_product_feed_json_with_http_info"])
|
|
694
|
-
|
|
695
|
-
auth_names = []
|
|
696
|
-
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
697
|
-
:header_params => header_params,
|
|
698
|
-
:query_params => query_params,
|
|
699
|
-
:form_params => form_params,
|
|
700
|
-
:body => post_body,
|
|
701
|
-
:auth_names => auth_names,
|
|
702
|
-
:return_type => 'InlineResponse20019',
|
|
703
|
-
:isResponseMLEForApi => is_response_mle_for_api)
|
|
704
|
-
if @api_client.config.debugging
|
|
705
|
-
begin
|
|
706
|
-
raise
|
|
707
|
-
@api_client.config.logger.debug "API called: MerchantCapabilitiesApi#ingest_product_feed_json\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
363
|
+
@api_client.config.logger.debug "API called: MerchantRegistrationApi#get_merchant_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
708
364
|
rescue
|
|
709
365
|
puts 'Cannot write to log'
|
|
710
366
|
end
|
|
@@ -712,7 +368,7 @@ module CyberSource
|
|
|
712
368
|
return data, status_code, headers
|
|
713
369
|
end
|
|
714
370
|
# List keys for a merchant
|
|
715
|
-
# List all keys
|
|
371
|
+
# **List Keys for a Merchant**<br>Returns all encryption keys associated with the specified merchant, with optional filtering by key status.<br><br> Returns **404** if the merchant is not found.
|
|
716
372
|
#
|
|
717
373
|
# @param merchant_id Unique merchant identifier (UUID)
|
|
718
374
|
# @param [Hash] opts the optional parameters
|
|
@@ -725,7 +381,7 @@ module CyberSource
|
|
|
725
381
|
end
|
|
726
382
|
|
|
727
383
|
# List keys for a merchant
|
|
728
|
-
# List all keys
|
|
384
|
+
# **List Keys for a Merchant**<br>Returns all encryption keys associated with the specified merchant, with optional filtering by key status.<br><br> Returns **404** if the merchant is not found.
|
|
729
385
|
# @param merchant_id Unique merchant identifier (UUID)
|
|
730
386
|
# @param [Hash] opts the optional parameters
|
|
731
387
|
# @option opts [String] :status Filter by key status: 'active', 'deactivated', or 'expired'. Omit to return all keys.
|
|
@@ -735,14 +391,14 @@ module CyberSource
|
|
|
735
391
|
if @api_client.config.debugging
|
|
736
392
|
begin
|
|
737
393
|
raise
|
|
738
|
-
@api_client.config.logger.debug 'Calling API:
|
|
394
|
+
@api_client.config.logger.debug 'Calling API: MerchantRegistrationApi.list_merchant_keys ...'
|
|
739
395
|
rescue
|
|
740
396
|
puts 'Cannot write to log'
|
|
741
397
|
end
|
|
742
398
|
end
|
|
743
399
|
# verify the required parameter 'merchant_id' is set
|
|
744
400
|
if @api_client.config.client_side_validation && merchant_id.nil?
|
|
745
|
-
fail ArgumentError, "Missing the required parameter 'merchant_id' when calling
|
|
401
|
+
fail ArgumentError, "Missing the required parameter 'merchant_id' when calling MerchantRegistrationApi.list_merchant_keys"
|
|
746
402
|
end
|
|
747
403
|
if @api_client.config.client_side_validation && opts[:'status'] && !['active', 'deactivated', 'expired'].include?(opts[:'status'])
|
|
748
404
|
fail ArgumentError, 'invalid value for "status", must be one of active, deactivated, expired'
|
|
@@ -793,7 +449,7 @@ module CyberSource
|
|
|
793
449
|
if @api_client.config.debugging
|
|
794
450
|
begin
|
|
795
451
|
raise
|
|
796
|
-
@api_client.config.logger.debug "API called:
|
|
452
|
+
@api_client.config.logger.debug "API called: MerchantRegistrationApi#list_merchant_keys\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
797
453
|
rescue
|
|
798
454
|
puts 'Cannot write to log'
|
|
799
455
|
end
|
|
@@ -801,7 +457,7 @@ module CyberSource
|
|
|
801
457
|
return data, status_code, headers
|
|
802
458
|
end
|
|
803
459
|
# Register a merchant
|
|
804
|
-
#
|
|
460
|
+
# **Register a Merchant**<br>Onboards a new merchant into the Visa Merchant Registry Service (VMRS). The merchant declares how payment credentials should be delivered: cryptogram type (TAVV or DAVV), transaction indicator (TAP — Trusted Agent Protocol, ACG — Agentic Checkout Gateway, or BOTH), and whether credentials should be encrypted.<br><br> If `paymentPayloadType` is set to ***ENCRYPTED***, an `encryptionKey` must be provided.<br> Returns **409** if a merchant with the same `merchantUrl` or `vmid` already exists.
|
|
805
461
|
#
|
|
806
462
|
# @param merchant_request Merchant registration request
|
|
807
463
|
# @param [Hash] opts the optional parameters
|
|
@@ -813,7 +469,7 @@ module CyberSource
|
|
|
813
469
|
end
|
|
814
470
|
|
|
815
471
|
# Register a merchant
|
|
816
|
-
#
|
|
472
|
+
# **Register a Merchant**<br>Onboards a new merchant into the Visa Merchant Registry Service (VMRS). The merchant declares how payment credentials should be delivered: cryptogram type (TAVV or DAVV), transaction indicator (TAP — Trusted Agent Protocol, ACG — Agentic Checkout Gateway, or BOTH), and whether credentials should be encrypted.<br><br> If `paymentPayloadType` is set to ***ENCRYPTED***, an `encryptionKey` must be provided.<br> Returns **409** if a merchant with the same `merchantUrl` or `vmid` already exists.
|
|
817
473
|
# @param merchant_request Merchant registration request
|
|
818
474
|
# @param [Hash] opts the optional parameters
|
|
819
475
|
# @return [Array<(MerchantRegistrationResponse201, Fixnum, Hash)>] MerchantRegistrationResponse201 data, response status code and response headers
|
|
@@ -822,14 +478,14 @@ module CyberSource
|
|
|
822
478
|
if @api_client.config.debugging
|
|
823
479
|
begin
|
|
824
480
|
raise
|
|
825
|
-
@api_client.config.logger.debug 'Calling API:
|
|
481
|
+
@api_client.config.logger.debug 'Calling API: MerchantRegistrationApi.register_merchant ...'
|
|
826
482
|
rescue
|
|
827
483
|
puts 'Cannot write to log'
|
|
828
484
|
end
|
|
829
485
|
end
|
|
830
486
|
# verify the required parameter 'merchant_request' is set
|
|
831
487
|
if @api_client.config.client_side_validation && merchant_request.nil?
|
|
832
|
-
fail ArgumentError, "Missing the required parameter 'merchant_request' when calling
|
|
488
|
+
fail ArgumentError, "Missing the required parameter 'merchant_request' when calling MerchantRegistrationApi.register_merchant"
|
|
833
489
|
end
|
|
834
490
|
# resource path
|
|
835
491
|
local_var_path = 'icc/v1/merchants'
|
|
@@ -874,7 +530,7 @@ module CyberSource
|
|
|
874
530
|
if @api_client.config.debugging
|
|
875
531
|
begin
|
|
876
532
|
raise
|
|
877
|
-
@api_client.config.logger.debug "API called:
|
|
533
|
+
@api_client.config.logger.debug "API called: MerchantRegistrationApi#register_merchant\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
878
534
|
rescue
|
|
879
535
|
puts 'Cannot write to log'
|
|
880
536
|
end
|
|
@@ -882,7 +538,7 @@ module CyberSource
|
|
|
882
538
|
return data, status_code, headers
|
|
883
539
|
end
|
|
884
540
|
# Update a merchant
|
|
885
|
-
# Update merchant configuration.
|
|
541
|
+
# **Update a Merchant**<br>Updates merchant configuration. The following fields can be modified: `merchantName`, `merchantUrl`, `cryptogramType`, `paymentPayloadType`, `acceptanceRelationships`, `protocolInteractions`, `webIntegrations`, and `apiIntegrations`.<br><br> Partial updates are supported — only provided fields are changed. The `vmid` and `indicator` fields cannot be updated via this endpoint.<br> Returns **400** if switching to ***ENCRYPTED*** without an active encryption key, **403** if the merchant is deactivated, **404** if not found, **409** if the new `merchantUrl` already exists.
|
|
886
542
|
#
|
|
887
543
|
# @param merchant_id Unique merchant identifier (UUID)
|
|
888
544
|
# @param merchant_update Merchant update request
|
|
@@ -895,7 +551,7 @@ module CyberSource
|
|
|
895
551
|
end
|
|
896
552
|
|
|
897
553
|
# Update a merchant
|
|
898
|
-
# Update merchant configuration.
|
|
554
|
+
# **Update a Merchant**<br>Updates merchant configuration. The following fields can be modified: `merchantName`, `merchantUrl`, `cryptogramType`, `paymentPayloadType`, `acceptanceRelationships`, `protocolInteractions`, `webIntegrations`, and `apiIntegrations`.<br><br> Partial updates are supported — only provided fields are changed. The `vmid` and `indicator` fields cannot be updated via this endpoint.<br> Returns **400** if switching to ***ENCRYPTED*** without an active encryption key, **403** if the merchant is deactivated, **404** if not found, **409** if the new `merchantUrl` already exists.
|
|
899
555
|
# @param merchant_id Unique merchant identifier (UUID)
|
|
900
556
|
# @param merchant_update Merchant update request
|
|
901
557
|
# @param [Hash] opts the optional parameters
|
|
@@ -905,18 +561,18 @@ module CyberSource
|
|
|
905
561
|
if @api_client.config.debugging
|
|
906
562
|
begin
|
|
907
563
|
raise
|
|
908
|
-
@api_client.config.logger.debug 'Calling API:
|
|
564
|
+
@api_client.config.logger.debug 'Calling API: MerchantRegistrationApi.update_merchant ...'
|
|
909
565
|
rescue
|
|
910
566
|
puts 'Cannot write to log'
|
|
911
567
|
end
|
|
912
568
|
end
|
|
913
569
|
# verify the required parameter 'merchant_id' is set
|
|
914
570
|
if @api_client.config.client_side_validation && merchant_id.nil?
|
|
915
|
-
fail ArgumentError, "Missing the required parameter 'merchant_id' when calling
|
|
571
|
+
fail ArgumentError, "Missing the required parameter 'merchant_id' when calling MerchantRegistrationApi.update_merchant"
|
|
916
572
|
end
|
|
917
573
|
# verify the required parameter 'merchant_update' is set
|
|
918
574
|
if @api_client.config.client_side_validation && merchant_update.nil?
|
|
919
|
-
fail ArgumentError, "Missing the required parameter 'merchant_update' when calling
|
|
575
|
+
fail ArgumentError, "Missing the required parameter 'merchant_update' when calling MerchantRegistrationApi.update_merchant"
|
|
920
576
|
end
|
|
921
577
|
# resource path
|
|
922
578
|
local_var_path = 'icc/v1/merchants/{merchantId}'.sub('{' + 'merchantId' + '}', merchant_id.to_s)
|
|
@@ -961,7 +617,7 @@ module CyberSource
|
|
|
961
617
|
if @api_client.config.debugging
|
|
962
618
|
begin
|
|
963
619
|
raise
|
|
964
|
-
@api_client.config.logger.debug "API called:
|
|
620
|
+
@api_client.config.logger.debug "API called: MerchantRegistrationApi#update_merchant\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
965
621
|
rescue
|
|
966
622
|
puts 'Cannot write to log'
|
|
967
623
|
end
|
|
@@ -969,7 +625,7 @@ module CyberSource
|
|
|
969
625
|
return data, status_code, headers
|
|
970
626
|
end
|
|
971
627
|
# Update a merchant key
|
|
972
|
-
# Update key information.
|
|
628
|
+
# **Update a Merchant Key**<br>Updates encryption key information. The following fields can be modified: `keyName`, `encryptionKey`, `algorithm`, `encryptionType`, and `expirationDate`.<br><br> Returns **403** if the merchant is deactivated, key is deactivated, or key is expired, **404** if the merchant or key is not found, **409** if the new `keyName` already exists.
|
|
973
629
|
#
|
|
974
630
|
# @param merchant_id Unique merchant identifier (UUID)
|
|
975
631
|
# @param key_id Unique key identifier (UUID)
|
|
@@ -983,7 +639,7 @@ module CyberSource
|
|
|
983
639
|
end
|
|
984
640
|
|
|
985
641
|
# Update a merchant key
|
|
986
|
-
# Update key information.
|
|
642
|
+
# **Update a Merchant Key**<br>Updates encryption key information. The following fields can be modified: `keyName`, `encryptionKey`, `algorithm`, `encryptionType`, and `expirationDate`.<br><br> Returns **403** if the merchant is deactivated, key is deactivated, or key is expired, **404** if the merchant or key is not found, **409** if the new `keyName` already exists.
|
|
987
643
|
# @param merchant_id Unique merchant identifier (UUID)
|
|
988
644
|
# @param key_id Unique key identifier (UUID)
|
|
989
645
|
# @param key_update Key update request
|
|
@@ -994,22 +650,22 @@ module CyberSource
|
|
|
994
650
|
if @api_client.config.debugging
|
|
995
651
|
begin
|
|
996
652
|
raise
|
|
997
|
-
@api_client.config.logger.debug 'Calling API:
|
|
653
|
+
@api_client.config.logger.debug 'Calling API: MerchantRegistrationApi.update_merchant_key ...'
|
|
998
654
|
rescue
|
|
999
655
|
puts 'Cannot write to log'
|
|
1000
656
|
end
|
|
1001
657
|
end
|
|
1002
658
|
# verify the required parameter 'merchant_id' is set
|
|
1003
659
|
if @api_client.config.client_side_validation && merchant_id.nil?
|
|
1004
|
-
fail ArgumentError, "Missing the required parameter 'merchant_id' when calling
|
|
660
|
+
fail ArgumentError, "Missing the required parameter 'merchant_id' when calling MerchantRegistrationApi.update_merchant_key"
|
|
1005
661
|
end
|
|
1006
662
|
# verify the required parameter 'key_id' is set
|
|
1007
663
|
if @api_client.config.client_side_validation && key_id.nil?
|
|
1008
|
-
fail ArgumentError, "Missing the required parameter 'key_id' when calling
|
|
664
|
+
fail ArgumentError, "Missing the required parameter 'key_id' when calling MerchantRegistrationApi.update_merchant_key"
|
|
1009
665
|
end
|
|
1010
666
|
# verify the required parameter 'key_update' is set
|
|
1011
667
|
if @api_client.config.client_side_validation && key_update.nil?
|
|
1012
|
-
fail ArgumentError, "Missing the required parameter 'key_update' when calling
|
|
668
|
+
fail ArgumentError, "Missing the required parameter 'key_update' when calling MerchantRegistrationApi.update_merchant_key"
|
|
1013
669
|
end
|
|
1014
670
|
# resource path
|
|
1015
671
|
local_var_path = 'icc/v1/merchants/{merchantId}/keys/{keyId}'.sub('{' + 'merchantId' + '}', merchant_id.to_s).sub('{' + 'keyId' + '}', key_id.to_s)
|
|
@@ -1054,7 +710,7 @@ module CyberSource
|
|
|
1054
710
|
if @api_client.config.debugging
|
|
1055
711
|
begin
|
|
1056
712
|
raise
|
|
1057
|
-
@api_client.config.logger.debug "API called:
|
|
713
|
+
@api_client.config.logger.debug "API called: MerchantRegistrationApi#update_merchant_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1058
714
|
rescue
|
|
1059
715
|
puts 'Cannot write to log'
|
|
1060
716
|
end
|