ultracart_api 4.1.203 → 4.1.205
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/README.md +26 -2
- data/docs/SfvbApi.md +711 -7
- data/docs/SfvbApprovalParams.md +4 -0
- data/docs/SfvbCommsDnsRecord.md +24 -0
- data/docs/SfvbCommsSendingDomain.md +38 -0
- data/docs/SfvbCommsSendingDomainsResponse.md +18 -0
- data/docs/SfvbCommsTwilioAccount.md +38 -0
- data/docs/SfvbCommsTwilioAccountResponse.md +20 -0
- data/docs/SfvbEmailRenderRequest.md +24 -0
- data/docs/SfvbEmailRenderResponse.md +34 -0
- data/docs/SfvbSecretRequestCreate.md +1 -1
- data/docs/SfvbTransactionalEmail.md +24 -0
- data/docs/SfvbTransactionalEmailsResponse.md +18 -0
- data/lib/ultracart_api/api/sfvb_api.rb +906 -26
- data/lib/ultracart_api/models/sfvb_approval_params.rb +21 -1
- data/lib/ultracart_api/models/sfvb_comms_dns_record.rb +296 -0
- data/lib/ultracart_api/models/sfvb_comms_sending_domain.rb +356 -0
- data/lib/ultracart_api/models/sfvb_comms_sending_domains_response.rb +222 -0
- data/lib/ultracart_api/models/sfvb_comms_twilio_account.rb +322 -0
- data/lib/ultracart_api/models/sfvb_comms_twilio_account_response.rb +231 -0
- data/lib/ultracart_api/models/sfvb_email_render_request.rb +252 -0
- data/lib/ultracart_api/models/sfvb_email_render_response.rb +301 -0
- data/lib/ultracart_api/models/sfvb_secret_request_create.rb +1 -1
- data/lib/ultracart_api/models/sfvb_transactional_email.rb +250 -0
- data/lib/ultracart_api/models/sfvb_transactional_emails_response.rb +222 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +9 -0
- metadata +19 -1
|
@@ -915,6 +915,134 @@ module UltracartClient
|
|
|
915
915
|
return data, status_code, headers
|
|
916
916
|
end
|
|
917
917
|
|
|
918
|
+
# Remove a sending domain
|
|
919
|
+
# Removes the domain from UltraCart and from Amazon SES. Needs an approved sending_domain.delete request for it (POST approvals, params.domain).
|
|
920
|
+
# @param domain [String]
|
|
921
|
+
# @param [Hash] opts the optional parameters
|
|
922
|
+
# @option opts [String] :approval_id The approval_id of an approved sending_domain.delete request for this domain. See POST /sfvb/approvals.
|
|
923
|
+
# @return [nil]
|
|
924
|
+
def delete_sfvb_comms_sending_domain(domain, opts = {})
|
|
925
|
+
delete_sfvb_comms_sending_domain_with_http_info(domain, opts)
|
|
926
|
+
nil
|
|
927
|
+
end
|
|
928
|
+
|
|
929
|
+
# Remove a sending domain
|
|
930
|
+
# Removes the domain from UltraCart and from Amazon SES. Needs an approved sending_domain.delete request for it (POST approvals, params.domain).
|
|
931
|
+
# @param domain [String]
|
|
932
|
+
# @param [Hash] opts the optional parameters
|
|
933
|
+
# @option opts [String] :approval_id The approval_id of an approved sending_domain.delete request for this domain. See POST /sfvb/approvals.
|
|
934
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
935
|
+
def delete_sfvb_comms_sending_domain_with_http_info(domain, opts = {})
|
|
936
|
+
if @api_client.config.debugging
|
|
937
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.delete_sfvb_comms_sending_domain ...'
|
|
938
|
+
end
|
|
939
|
+
# verify the required parameter 'domain' is set
|
|
940
|
+
if @api_client.config.client_side_validation && domain.nil?
|
|
941
|
+
fail ArgumentError, "Missing the required parameter 'domain' when calling SfvbApi.delete_sfvb_comms_sending_domain"
|
|
942
|
+
end
|
|
943
|
+
# resource path
|
|
944
|
+
local_var_path = '/sfvb/comms/sending_domains/{domain}'.sub('{' + 'domain' + '}', CGI.escape(domain.to_s))
|
|
945
|
+
|
|
946
|
+
# query parameters
|
|
947
|
+
query_params = opts[:query_params] || {}
|
|
948
|
+
|
|
949
|
+
# header parameters
|
|
950
|
+
header_params = opts[:header_params] || {}
|
|
951
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
952
|
+
# HTTP header 'Accept' (if needed)
|
|
953
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
954
|
+
header_params[:'Approval-Id'] = opts[:'approval_id'] if !opts[:'approval_id'].nil?
|
|
955
|
+
|
|
956
|
+
# form parameters
|
|
957
|
+
form_params = opts[:form_params] || {}
|
|
958
|
+
|
|
959
|
+
# http body (model)
|
|
960
|
+
post_body = opts[:debug_body]
|
|
961
|
+
|
|
962
|
+
# return_type
|
|
963
|
+
return_type = opts[:debug_return_type]
|
|
964
|
+
|
|
965
|
+
# auth_names
|
|
966
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
967
|
+
|
|
968
|
+
new_options = opts.merge(
|
|
969
|
+
:operation => :"SfvbApi.delete_sfvb_comms_sending_domain",
|
|
970
|
+
:header_params => header_params,
|
|
971
|
+
:query_params => query_params,
|
|
972
|
+
:form_params => form_params,
|
|
973
|
+
:body => post_body,
|
|
974
|
+
:auth_names => auth_names,
|
|
975
|
+
:return_type => return_type
|
|
976
|
+
)
|
|
977
|
+
|
|
978
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
979
|
+
if @api_client.config.debugging
|
|
980
|
+
@api_client.config.logger.debug "API called: SfvbApi#delete_sfvb_comms_sending_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
981
|
+
end
|
|
982
|
+
return data, status_code, headers
|
|
983
|
+
end
|
|
984
|
+
|
|
985
|
+
# Remove the Twilio account
|
|
986
|
+
# Removes the account's Twilio account and its credentials from UltraCart. The account stays at Twilio. Needs an approved twilio_account.delete request for it (POST approvals, params.esp_twilio_uuid).
|
|
987
|
+
# @param [Hash] opts the optional parameters
|
|
988
|
+
# @option opts [String] :approval_id The approval_id of an approved twilio_account.delete request for this account. See POST /sfvb/approvals.
|
|
989
|
+
# @return [nil]
|
|
990
|
+
def delete_sfvb_comms_twilio_account(opts = {})
|
|
991
|
+
delete_sfvb_comms_twilio_account_with_http_info(opts)
|
|
992
|
+
nil
|
|
993
|
+
end
|
|
994
|
+
|
|
995
|
+
# Remove the Twilio account
|
|
996
|
+
# Removes the account's Twilio account and its credentials from UltraCart. The account stays at Twilio. Needs an approved twilio_account.delete request for it (POST approvals, params.esp_twilio_uuid).
|
|
997
|
+
# @param [Hash] opts the optional parameters
|
|
998
|
+
# @option opts [String] :approval_id The approval_id of an approved twilio_account.delete request for this account. See POST /sfvb/approvals.
|
|
999
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
1000
|
+
def delete_sfvb_comms_twilio_account_with_http_info(opts = {})
|
|
1001
|
+
if @api_client.config.debugging
|
|
1002
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.delete_sfvb_comms_twilio_account ...'
|
|
1003
|
+
end
|
|
1004
|
+
# resource path
|
|
1005
|
+
local_var_path = '/sfvb/comms/twilio_account'
|
|
1006
|
+
|
|
1007
|
+
# query parameters
|
|
1008
|
+
query_params = opts[:query_params] || {}
|
|
1009
|
+
|
|
1010
|
+
# header parameters
|
|
1011
|
+
header_params = opts[:header_params] || {}
|
|
1012
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
1013
|
+
# HTTP header 'Accept' (if needed)
|
|
1014
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1015
|
+
header_params[:'Approval-Id'] = opts[:'approval_id'] if !opts[:'approval_id'].nil?
|
|
1016
|
+
|
|
1017
|
+
# form parameters
|
|
1018
|
+
form_params = opts[:form_params] || {}
|
|
1019
|
+
|
|
1020
|
+
# http body (model)
|
|
1021
|
+
post_body = opts[:debug_body]
|
|
1022
|
+
|
|
1023
|
+
# return_type
|
|
1024
|
+
return_type = opts[:debug_return_type]
|
|
1025
|
+
|
|
1026
|
+
# auth_names
|
|
1027
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
1028
|
+
|
|
1029
|
+
new_options = opts.merge(
|
|
1030
|
+
:operation => :"SfvbApi.delete_sfvb_comms_twilio_account",
|
|
1031
|
+
:header_params => header_params,
|
|
1032
|
+
:query_params => query_params,
|
|
1033
|
+
:form_params => form_params,
|
|
1034
|
+
:body => post_body,
|
|
1035
|
+
:auth_names => auth_names,
|
|
1036
|
+
:return_type => return_type
|
|
1037
|
+
)
|
|
1038
|
+
|
|
1039
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
1040
|
+
if @api_client.config.debugging
|
|
1041
|
+
@api_client.config.logger.debug "API called: SfvbApi#delete_sfvb_comms_twilio_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1042
|
+
end
|
|
1043
|
+
return data, status_code, headers
|
|
1044
|
+
end
|
|
1045
|
+
|
|
918
1046
|
# Delete a storefront file
|
|
919
1047
|
# Recoverable from the recycle bin.
|
|
920
1048
|
# @param storefront_oid [Integer]
|
|
@@ -3197,6 +3325,186 @@ module UltracartClient
|
|
|
3197
3325
|
return data, status_code, headers
|
|
3198
3326
|
end
|
|
3199
3327
|
|
|
3328
|
+
# Read a sending domain
|
|
3329
|
+
# One sending domain as stored. To check an amazon domain's DNS again, use the status call.
|
|
3330
|
+
# @param domain [String]
|
|
3331
|
+
# @param [Hash] opts the optional parameters
|
|
3332
|
+
# @return [SfvbCommsSendingDomain]
|
|
3333
|
+
def get_sfvb_comms_sending_domain(domain, opts = {})
|
|
3334
|
+
data, _status_code, _headers = get_sfvb_comms_sending_domain_with_http_info(domain, opts)
|
|
3335
|
+
data
|
|
3336
|
+
end
|
|
3337
|
+
|
|
3338
|
+
# Read a sending domain
|
|
3339
|
+
# One sending domain as stored. To check an amazon domain's DNS again, use the status call.
|
|
3340
|
+
# @param domain [String]
|
|
3341
|
+
# @param [Hash] opts the optional parameters
|
|
3342
|
+
# @return [Array<(SfvbCommsSendingDomain, Integer, Hash)>] SfvbCommsSendingDomain data, response status code and response headers
|
|
3343
|
+
def get_sfvb_comms_sending_domain_with_http_info(domain, opts = {})
|
|
3344
|
+
if @api_client.config.debugging
|
|
3345
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_sending_domain ...'
|
|
3346
|
+
end
|
|
3347
|
+
# verify the required parameter 'domain' is set
|
|
3348
|
+
if @api_client.config.client_side_validation && domain.nil?
|
|
3349
|
+
fail ArgumentError, "Missing the required parameter 'domain' when calling SfvbApi.get_sfvb_comms_sending_domain"
|
|
3350
|
+
end
|
|
3351
|
+
# resource path
|
|
3352
|
+
local_var_path = '/sfvb/comms/sending_domains/{domain}'.sub('{' + 'domain' + '}', CGI.escape(domain.to_s))
|
|
3353
|
+
|
|
3354
|
+
# query parameters
|
|
3355
|
+
query_params = opts[:query_params] || {}
|
|
3356
|
+
|
|
3357
|
+
# header parameters
|
|
3358
|
+
header_params = opts[:header_params] || {}
|
|
3359
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
3360
|
+
# HTTP header 'Accept' (if needed)
|
|
3361
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
3362
|
+
|
|
3363
|
+
# form parameters
|
|
3364
|
+
form_params = opts[:form_params] || {}
|
|
3365
|
+
|
|
3366
|
+
# http body (model)
|
|
3367
|
+
post_body = opts[:debug_body]
|
|
3368
|
+
|
|
3369
|
+
# return_type
|
|
3370
|
+
return_type = opts[:debug_return_type] || 'SfvbCommsSendingDomain'
|
|
3371
|
+
|
|
3372
|
+
# auth_names
|
|
3373
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
3374
|
+
|
|
3375
|
+
new_options = opts.merge(
|
|
3376
|
+
:operation => :"SfvbApi.get_sfvb_comms_sending_domain",
|
|
3377
|
+
:header_params => header_params,
|
|
3378
|
+
:query_params => query_params,
|
|
3379
|
+
:form_params => form_params,
|
|
3380
|
+
:body => post_body,
|
|
3381
|
+
:auth_names => auth_names,
|
|
3382
|
+
:return_type => return_type
|
|
3383
|
+
)
|
|
3384
|
+
|
|
3385
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
3386
|
+
if @api_client.config.debugging
|
|
3387
|
+
@api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_sending_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
3388
|
+
end
|
|
3389
|
+
return data, status_code, headers
|
|
3390
|
+
end
|
|
3391
|
+
|
|
3392
|
+
# List the sending domains
|
|
3393
|
+
# Every domain the account sends email from, with its provider, verification status and the DNS records an amazon domain needs. mailgun_api_key is always a mask.
|
|
3394
|
+
# @param [Hash] opts the optional parameters
|
|
3395
|
+
# @return [SfvbCommsSendingDomainsResponse]
|
|
3396
|
+
def get_sfvb_comms_sending_domains(opts = {})
|
|
3397
|
+
data, _status_code, _headers = get_sfvb_comms_sending_domains_with_http_info(opts)
|
|
3398
|
+
data
|
|
3399
|
+
end
|
|
3400
|
+
|
|
3401
|
+
# List the sending domains
|
|
3402
|
+
# Every domain the account sends email from, with its provider, verification status and the DNS records an amazon domain needs. mailgun_api_key is always a mask.
|
|
3403
|
+
# @param [Hash] opts the optional parameters
|
|
3404
|
+
# @return [Array<(SfvbCommsSendingDomainsResponse, Integer, Hash)>] SfvbCommsSendingDomainsResponse data, response status code and response headers
|
|
3405
|
+
def get_sfvb_comms_sending_domains_with_http_info(opts = {})
|
|
3406
|
+
if @api_client.config.debugging
|
|
3407
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_sending_domains ...'
|
|
3408
|
+
end
|
|
3409
|
+
# resource path
|
|
3410
|
+
local_var_path = '/sfvb/comms/sending_domains'
|
|
3411
|
+
|
|
3412
|
+
# query parameters
|
|
3413
|
+
query_params = opts[:query_params] || {}
|
|
3414
|
+
|
|
3415
|
+
# header parameters
|
|
3416
|
+
header_params = opts[:header_params] || {}
|
|
3417
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
3418
|
+
# HTTP header 'Accept' (if needed)
|
|
3419
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
3420
|
+
|
|
3421
|
+
# form parameters
|
|
3422
|
+
form_params = opts[:form_params] || {}
|
|
3423
|
+
|
|
3424
|
+
# http body (model)
|
|
3425
|
+
post_body = opts[:debug_body]
|
|
3426
|
+
|
|
3427
|
+
# return_type
|
|
3428
|
+
return_type = opts[:debug_return_type] || 'SfvbCommsSendingDomainsResponse'
|
|
3429
|
+
|
|
3430
|
+
# auth_names
|
|
3431
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
3432
|
+
|
|
3433
|
+
new_options = opts.merge(
|
|
3434
|
+
:operation => :"SfvbApi.get_sfvb_comms_sending_domains",
|
|
3435
|
+
:header_params => header_params,
|
|
3436
|
+
:query_params => query_params,
|
|
3437
|
+
:form_params => form_params,
|
|
3438
|
+
:body => post_body,
|
|
3439
|
+
:auth_names => auth_names,
|
|
3440
|
+
:return_type => return_type
|
|
3441
|
+
)
|
|
3442
|
+
|
|
3443
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
3444
|
+
if @api_client.config.debugging
|
|
3445
|
+
@api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_sending_domains\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
3446
|
+
end
|
|
3447
|
+
return data, status_code, headers
|
|
3448
|
+
end
|
|
3449
|
+
|
|
3450
|
+
# Read the Twilio account
|
|
3451
|
+
# The account's Twilio account, used for SMS and the phone system, or none. An account has at most one. auth_token is always a mask.
|
|
3452
|
+
# @param [Hash] opts the optional parameters
|
|
3453
|
+
# @return [SfvbCommsTwilioAccountResponse]
|
|
3454
|
+
def get_sfvb_comms_twilio_account(opts = {})
|
|
3455
|
+
data, _status_code, _headers = get_sfvb_comms_twilio_account_with_http_info(opts)
|
|
3456
|
+
data
|
|
3457
|
+
end
|
|
3458
|
+
|
|
3459
|
+
# Read the Twilio account
|
|
3460
|
+
# The account's Twilio account, used for SMS and the phone system, or none. An account has at most one. auth_token is always a mask.
|
|
3461
|
+
# @param [Hash] opts the optional parameters
|
|
3462
|
+
# @return [Array<(SfvbCommsTwilioAccountResponse, Integer, Hash)>] SfvbCommsTwilioAccountResponse data, response status code and response headers
|
|
3463
|
+
def get_sfvb_comms_twilio_account_with_http_info(opts = {})
|
|
3464
|
+
if @api_client.config.debugging
|
|
3465
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_twilio_account ...'
|
|
3466
|
+
end
|
|
3467
|
+
# resource path
|
|
3468
|
+
local_var_path = '/sfvb/comms/twilio_account'
|
|
3469
|
+
|
|
3470
|
+
# query parameters
|
|
3471
|
+
query_params = opts[:query_params] || {}
|
|
3472
|
+
|
|
3473
|
+
# header parameters
|
|
3474
|
+
header_params = opts[:header_params] || {}
|
|
3475
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
3476
|
+
# HTTP header 'Accept' (if needed)
|
|
3477
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
3478
|
+
|
|
3479
|
+
# form parameters
|
|
3480
|
+
form_params = opts[:form_params] || {}
|
|
3481
|
+
|
|
3482
|
+
# http body (model)
|
|
3483
|
+
post_body = opts[:debug_body]
|
|
3484
|
+
|
|
3485
|
+
# return_type
|
|
3486
|
+
return_type = opts[:debug_return_type] || 'SfvbCommsTwilioAccountResponse'
|
|
3487
|
+
|
|
3488
|
+
# auth_names
|
|
3489
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
3490
|
+
|
|
3491
|
+
new_options = opts.merge(
|
|
3492
|
+
:operation => :"SfvbApi.get_sfvb_comms_twilio_account",
|
|
3493
|
+
:header_params => header_params,
|
|
3494
|
+
:query_params => query_params,
|
|
3495
|
+
:form_params => form_params,
|
|
3496
|
+
:body => post_body,
|
|
3497
|
+
:auth_names => auth_names,
|
|
3498
|
+
:return_type => return_type
|
|
3499
|
+
)
|
|
3500
|
+
|
|
3501
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
3502
|
+
if @api_client.config.debugging
|
|
3503
|
+
@api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_twilio_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
3504
|
+
end
|
|
3505
|
+
return data, status_code, headers
|
|
3506
|
+
end
|
|
3507
|
+
|
|
3200
3508
|
# Read a container stored outside the file system
|
|
3201
3509
|
# owner_type is one of upsell, email, postcardfront, postcardback, item or itemid. It also says how owner_object_id is read - item and upsell take an oid, itemid takes a merchant item id, and the rest take an esp uuid. itemid reaches the same containers as item and is the way to address one from a storefront, where data-context-item-id carries the merchant item id and the oid appears nowhere. Item containers also require container_name. Theme and page containers are files; read those through files/content.
|
|
3202
3510
|
# @param storefront_oid [Integer]
|
|
@@ -6320,45 +6628,109 @@ module UltracartClient
|
|
|
6320
6628
|
return data, status_code, headers
|
|
6321
6629
|
end
|
|
6322
6630
|
|
|
6323
|
-
#
|
|
6324
|
-
# The
|
|
6631
|
+
# List the transactional emails a storefront sends
|
|
6632
|
+
# The order, shipment, auto order and other transactional emails this storefront sends, with their template files and the body container a draft replaces. Forgot password and chat verification are not listed, because they have no preview.
|
|
6325
6633
|
# @param storefront_oid [Integer]
|
|
6326
|
-
# @param upsell_offer_oid [Integer]
|
|
6327
6634
|
# @param [Hash] opts the optional parameters
|
|
6328
|
-
# @
|
|
6329
|
-
|
|
6330
|
-
|
|
6331
|
-
# @option opts [String] :stats_weekdays Only these weekdays, comma separated mon to sun
|
|
6332
|
-
# @return [SfvbUpsellOffer]
|
|
6333
|
-
def get_sfvb_upsell_offer(storefront_oid, upsell_offer_oid, opts = {})
|
|
6334
|
-
data, _status_code, _headers = get_sfvb_upsell_offer_with_http_info(storefront_oid, upsell_offer_oid, opts)
|
|
6635
|
+
# @return [SfvbTransactionalEmailsResponse]
|
|
6636
|
+
def get_sfvb_transactional_emails(storefront_oid, opts = {})
|
|
6637
|
+
data, _status_code, _headers = get_sfvb_transactional_emails_with_http_info(storefront_oid, opts)
|
|
6335
6638
|
data
|
|
6336
6639
|
end
|
|
6337
6640
|
|
|
6338
|
-
#
|
|
6339
|
-
# The
|
|
6641
|
+
# List the transactional emails a storefront sends
|
|
6642
|
+
# The order, shipment, auto order and other transactional emails this storefront sends, with their template files and the body container a draft replaces. Forgot password and chat verification are not listed, because they have no preview.
|
|
6340
6643
|
# @param storefront_oid [Integer]
|
|
6341
|
-
# @param upsell_offer_oid [Integer]
|
|
6342
6644
|
# @param [Hash] opts the optional parameters
|
|
6343
|
-
# @
|
|
6344
|
-
|
|
6345
|
-
# @option opts [String] :stats_end Stats window end, YYYY-MM-DD
|
|
6346
|
-
# @option opts [String] :stats_weekdays Only these weekdays, comma separated mon to sun
|
|
6347
|
-
# @return [Array<(SfvbUpsellOffer, Integer, Hash)>] SfvbUpsellOffer data, response status code and response headers
|
|
6348
|
-
def get_sfvb_upsell_offer_with_http_info(storefront_oid, upsell_offer_oid, opts = {})
|
|
6645
|
+
# @return [Array<(SfvbTransactionalEmailsResponse, Integer, Hash)>] SfvbTransactionalEmailsResponse data, response status code and response headers
|
|
6646
|
+
def get_sfvb_transactional_emails_with_http_info(storefront_oid, opts = {})
|
|
6349
6647
|
if @api_client.config.debugging
|
|
6350
|
-
@api_client.config.logger.debug 'Calling API: SfvbApi.
|
|
6648
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_transactional_emails ...'
|
|
6351
6649
|
end
|
|
6352
6650
|
# verify the required parameter 'storefront_oid' is set
|
|
6353
6651
|
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
6354
|
-
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.
|
|
6355
|
-
end
|
|
6356
|
-
# verify the required parameter 'upsell_offer_oid' is set
|
|
6357
|
-
if @api_client.config.client_side_validation && upsell_offer_oid.nil?
|
|
6358
|
-
fail ArgumentError, "Missing the required parameter 'upsell_offer_oid' when calling SfvbApi.get_sfvb_upsell_offer"
|
|
6652
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_transactional_emails"
|
|
6359
6653
|
end
|
|
6360
6654
|
# resource path
|
|
6361
|
-
local_var_path = '/sfvb/storefronts/{storefront_oid}/
|
|
6655
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/transactional_emails'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
|
|
6656
|
+
|
|
6657
|
+
# query parameters
|
|
6658
|
+
query_params = opts[:query_params] || {}
|
|
6659
|
+
|
|
6660
|
+
# header parameters
|
|
6661
|
+
header_params = opts[:header_params] || {}
|
|
6662
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
6663
|
+
# HTTP header 'Accept' (if needed)
|
|
6664
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
6665
|
+
|
|
6666
|
+
# form parameters
|
|
6667
|
+
form_params = opts[:form_params] || {}
|
|
6668
|
+
|
|
6669
|
+
# http body (model)
|
|
6670
|
+
post_body = opts[:debug_body]
|
|
6671
|
+
|
|
6672
|
+
# return_type
|
|
6673
|
+
return_type = opts[:debug_return_type] || 'SfvbTransactionalEmailsResponse'
|
|
6674
|
+
|
|
6675
|
+
# auth_names
|
|
6676
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
6677
|
+
|
|
6678
|
+
new_options = opts.merge(
|
|
6679
|
+
:operation => :"SfvbApi.get_sfvb_transactional_emails",
|
|
6680
|
+
:header_params => header_params,
|
|
6681
|
+
:query_params => query_params,
|
|
6682
|
+
:form_params => form_params,
|
|
6683
|
+
:body => post_body,
|
|
6684
|
+
:auth_names => auth_names,
|
|
6685
|
+
:return_type => return_type
|
|
6686
|
+
)
|
|
6687
|
+
|
|
6688
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
6689
|
+
if @api_client.config.debugging
|
|
6690
|
+
@api_client.config.logger.debug "API called: SfvbApi#get_sfvb_transactional_emails\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
6691
|
+
end
|
|
6692
|
+
return data, status_code, headers
|
|
6693
|
+
end
|
|
6694
|
+
|
|
6695
|
+
# Get an upsell offer
|
|
6696
|
+
# The whole offer, with the hash an update sends back in If-Match, which upsell items are out of stock now, and whether loyalty, TowerData and Everflow are set up. Stats as on the path list.
|
|
6697
|
+
# @param storefront_oid [Integer]
|
|
6698
|
+
# @param upsell_offer_oid [Integer]
|
|
6699
|
+
# @param [Hash] opts the optional parameters
|
|
6700
|
+
# @option opts [Boolean] :stats Include stats
|
|
6701
|
+
# @option opts [String] :stats_start Stats window start, YYYY-MM-DD
|
|
6702
|
+
# @option opts [String] :stats_end Stats window end, YYYY-MM-DD
|
|
6703
|
+
# @option opts [String] :stats_weekdays Only these weekdays, comma separated mon to sun
|
|
6704
|
+
# @return [SfvbUpsellOffer]
|
|
6705
|
+
def get_sfvb_upsell_offer(storefront_oid, upsell_offer_oid, opts = {})
|
|
6706
|
+
data, _status_code, _headers = get_sfvb_upsell_offer_with_http_info(storefront_oid, upsell_offer_oid, opts)
|
|
6707
|
+
data
|
|
6708
|
+
end
|
|
6709
|
+
|
|
6710
|
+
# Get an upsell offer
|
|
6711
|
+
# The whole offer, with the hash an update sends back in If-Match, which upsell items are out of stock now, and whether loyalty, TowerData and Everflow are set up. Stats as on the path list.
|
|
6712
|
+
# @param storefront_oid [Integer]
|
|
6713
|
+
# @param upsell_offer_oid [Integer]
|
|
6714
|
+
# @param [Hash] opts the optional parameters
|
|
6715
|
+
# @option opts [Boolean] :stats Include stats
|
|
6716
|
+
# @option opts [String] :stats_start Stats window start, YYYY-MM-DD
|
|
6717
|
+
# @option opts [String] :stats_end Stats window end, YYYY-MM-DD
|
|
6718
|
+
# @option opts [String] :stats_weekdays Only these weekdays, comma separated mon to sun
|
|
6719
|
+
# @return [Array<(SfvbUpsellOffer, Integer, Hash)>] SfvbUpsellOffer data, response status code and response headers
|
|
6720
|
+
def get_sfvb_upsell_offer_with_http_info(storefront_oid, upsell_offer_oid, opts = {})
|
|
6721
|
+
if @api_client.config.debugging
|
|
6722
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_upsell_offer ...'
|
|
6723
|
+
end
|
|
6724
|
+
# verify the required parameter 'storefront_oid' is set
|
|
6725
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
6726
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_upsell_offer"
|
|
6727
|
+
end
|
|
6728
|
+
# verify the required parameter 'upsell_offer_oid' is set
|
|
6729
|
+
if @api_client.config.client_side_validation && upsell_offer_oid.nil?
|
|
6730
|
+
fail ArgumentError, "Missing the required parameter 'upsell_offer_oid' when calling SfvbApi.get_sfvb_upsell_offer"
|
|
6731
|
+
end
|
|
6732
|
+
# resource path
|
|
6733
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/upsell_offers/{upsell_offer_oid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'upsell_offer_oid' + '}', CGI.escape(upsell_offer_oid.to_s))
|
|
6362
6734
|
|
|
6363
6735
|
# query parameters
|
|
6364
6736
|
query_params = opts[:query_params] || {}
|
|
@@ -6892,6 +7264,144 @@ module UltracartClient
|
|
|
6892
7264
|
return data, status_code, headers
|
|
6893
7265
|
end
|
|
6894
7266
|
|
|
7267
|
+
# Add a sending domain
|
|
7268
|
+
# Adds a domain to send email from. An amazon domain starts verification with Amazon SES and returns the DNS records to publish; the person signed in also gets them by email. A mailgun domain needs mailgun_api_key as a secret handle made for the domain (POST secrets, sink mailgun.domain.api_key), never the key itself. UltraCart sets up its webhooks on the Mailgun domain with the key; if Mailgun refuses, nothing is saved and the handle is given back unused.
|
|
7269
|
+
# @param sending_domain [SfvbCommsSendingDomain] The sending domain
|
|
7270
|
+
# @param [Hash] opts the optional parameters
|
|
7271
|
+
# @return [SfvbCommsSendingDomain]
|
|
7272
|
+
def insert_sfvb_comms_sending_domain(sending_domain, opts = {})
|
|
7273
|
+
data, _status_code, _headers = insert_sfvb_comms_sending_domain_with_http_info(sending_domain, opts)
|
|
7274
|
+
data
|
|
7275
|
+
end
|
|
7276
|
+
|
|
7277
|
+
# Add a sending domain
|
|
7278
|
+
# Adds a domain to send email from. An amazon domain starts verification with Amazon SES and returns the DNS records to publish; the person signed in also gets them by email. A mailgun domain needs mailgun_api_key as a secret handle made for the domain (POST secrets, sink mailgun.domain.api_key), never the key itself. UltraCart sets up its webhooks on the Mailgun domain with the key; if Mailgun refuses, nothing is saved and the handle is given back unused.
|
|
7279
|
+
# @param sending_domain [SfvbCommsSendingDomain] The sending domain
|
|
7280
|
+
# @param [Hash] opts the optional parameters
|
|
7281
|
+
# @return [Array<(SfvbCommsSendingDomain, Integer, Hash)>] SfvbCommsSendingDomain data, response status code and response headers
|
|
7282
|
+
def insert_sfvb_comms_sending_domain_with_http_info(sending_domain, opts = {})
|
|
7283
|
+
if @api_client.config.debugging
|
|
7284
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.insert_sfvb_comms_sending_domain ...'
|
|
7285
|
+
end
|
|
7286
|
+
# verify the required parameter 'sending_domain' is set
|
|
7287
|
+
if @api_client.config.client_side_validation && sending_domain.nil?
|
|
7288
|
+
fail ArgumentError, "Missing the required parameter 'sending_domain' when calling SfvbApi.insert_sfvb_comms_sending_domain"
|
|
7289
|
+
end
|
|
7290
|
+
# resource path
|
|
7291
|
+
local_var_path = '/sfvb/comms/sending_domains'
|
|
7292
|
+
|
|
7293
|
+
# query parameters
|
|
7294
|
+
query_params = opts[:query_params] || {}
|
|
7295
|
+
|
|
7296
|
+
# header parameters
|
|
7297
|
+
header_params = opts[:header_params] || {}
|
|
7298
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
7299
|
+
# HTTP header 'Accept' (if needed)
|
|
7300
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
7301
|
+
# HTTP header 'Content-Type'
|
|
7302
|
+
content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
|
|
7303
|
+
if !content_type.nil?
|
|
7304
|
+
header_params['Content-Type'] = content_type
|
|
7305
|
+
end
|
|
7306
|
+
|
|
7307
|
+
# form parameters
|
|
7308
|
+
form_params = opts[:form_params] || {}
|
|
7309
|
+
|
|
7310
|
+
# http body (model)
|
|
7311
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(sending_domain)
|
|
7312
|
+
|
|
7313
|
+
# return_type
|
|
7314
|
+
return_type = opts[:debug_return_type] || 'SfvbCommsSendingDomain'
|
|
7315
|
+
|
|
7316
|
+
# auth_names
|
|
7317
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
7318
|
+
|
|
7319
|
+
new_options = opts.merge(
|
|
7320
|
+
:operation => :"SfvbApi.insert_sfvb_comms_sending_domain",
|
|
7321
|
+
:header_params => header_params,
|
|
7322
|
+
:query_params => query_params,
|
|
7323
|
+
:form_params => form_params,
|
|
7324
|
+
:body => post_body,
|
|
7325
|
+
:auth_names => auth_names,
|
|
7326
|
+
:return_type => return_type
|
|
7327
|
+
)
|
|
7328
|
+
|
|
7329
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
7330
|
+
if @api_client.config.debugging
|
|
7331
|
+
@api_client.config.logger.debug "API called: SfvbApi#insert_sfvb_comms_sending_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
7332
|
+
end
|
|
7333
|
+
return data, status_code, headers
|
|
7334
|
+
end
|
|
7335
|
+
|
|
7336
|
+
# Connect the Twilio account
|
|
7337
|
+
# Connects the account's Twilio account with account_sid and auth_token. Send auth_token as a secret handle made for that account SID (POST secrets, sink twilio.account.auth_token), never the token itself. UltraCart checks the token with Twilio, then makes its API key, TwiML apps and voice encryption key on the account, as the admin does. If Twilio refuses, nothing is saved and the handle is given back unused. An account has at most one Twilio account, so this is refused when one exists; update it instead.
|
|
7338
|
+
# @param twilio_account [SfvbCommsTwilioAccount] The Twilio account
|
|
7339
|
+
# @param [Hash] opts the optional parameters
|
|
7340
|
+
# @return [SfvbCommsTwilioAccountResponse]
|
|
7341
|
+
def insert_sfvb_comms_twilio_account(twilio_account, opts = {})
|
|
7342
|
+
data, _status_code, _headers = insert_sfvb_comms_twilio_account_with_http_info(twilio_account, opts)
|
|
7343
|
+
data
|
|
7344
|
+
end
|
|
7345
|
+
|
|
7346
|
+
# Connect the Twilio account
|
|
7347
|
+
# Connects the account's Twilio account with account_sid and auth_token. Send auth_token as a secret handle made for that account SID (POST secrets, sink twilio.account.auth_token), never the token itself. UltraCart checks the token with Twilio, then makes its API key, TwiML apps and voice encryption key on the account, as the admin does. If Twilio refuses, nothing is saved and the handle is given back unused. An account has at most one Twilio account, so this is refused when one exists; update it instead.
|
|
7348
|
+
# @param twilio_account [SfvbCommsTwilioAccount] The Twilio account
|
|
7349
|
+
# @param [Hash] opts the optional parameters
|
|
7350
|
+
# @return [Array<(SfvbCommsTwilioAccountResponse, Integer, Hash)>] SfvbCommsTwilioAccountResponse data, response status code and response headers
|
|
7351
|
+
def insert_sfvb_comms_twilio_account_with_http_info(twilio_account, opts = {})
|
|
7352
|
+
if @api_client.config.debugging
|
|
7353
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.insert_sfvb_comms_twilio_account ...'
|
|
7354
|
+
end
|
|
7355
|
+
# verify the required parameter 'twilio_account' is set
|
|
7356
|
+
if @api_client.config.client_side_validation && twilio_account.nil?
|
|
7357
|
+
fail ArgumentError, "Missing the required parameter 'twilio_account' when calling SfvbApi.insert_sfvb_comms_twilio_account"
|
|
7358
|
+
end
|
|
7359
|
+
# resource path
|
|
7360
|
+
local_var_path = '/sfvb/comms/twilio_account'
|
|
7361
|
+
|
|
7362
|
+
# query parameters
|
|
7363
|
+
query_params = opts[:query_params] || {}
|
|
7364
|
+
|
|
7365
|
+
# header parameters
|
|
7366
|
+
header_params = opts[:header_params] || {}
|
|
7367
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
7368
|
+
# HTTP header 'Accept' (if needed)
|
|
7369
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
7370
|
+
# HTTP header 'Content-Type'
|
|
7371
|
+
content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
|
|
7372
|
+
if !content_type.nil?
|
|
7373
|
+
header_params['Content-Type'] = content_type
|
|
7374
|
+
end
|
|
7375
|
+
|
|
7376
|
+
# form parameters
|
|
7377
|
+
form_params = opts[:form_params] || {}
|
|
7378
|
+
|
|
7379
|
+
# http body (model)
|
|
7380
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(twilio_account)
|
|
7381
|
+
|
|
7382
|
+
# return_type
|
|
7383
|
+
return_type = opts[:debug_return_type] || 'SfvbCommsTwilioAccountResponse'
|
|
7384
|
+
|
|
7385
|
+
# auth_names
|
|
7386
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
7387
|
+
|
|
7388
|
+
new_options = opts.merge(
|
|
7389
|
+
:operation => :"SfvbApi.insert_sfvb_comms_twilio_account",
|
|
7390
|
+
:header_params => header_params,
|
|
7391
|
+
:query_params => query_params,
|
|
7392
|
+
:form_params => form_params,
|
|
7393
|
+
:body => post_body,
|
|
7394
|
+
:auth_names => auth_names,
|
|
7395
|
+
:return_type => return_type
|
|
7396
|
+
)
|
|
7397
|
+
|
|
7398
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
7399
|
+
if @api_client.config.debugging
|
|
7400
|
+
@api_client.config.logger.debug "API called: SfvbApi#insert_sfvb_comms_twilio_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
7401
|
+
end
|
|
7402
|
+
return data, status_code, headers
|
|
7403
|
+
end
|
|
7404
|
+
|
|
6895
7405
|
# Create a page
|
|
6896
7406
|
# Creates the page and its folder, the way the store admin's add page does. The parent page must already exist, and the last part of the path may only contain letters, digits, hyphens and underscores - it is refused, not cleaned. A path that already has a page is refused with a 409 and the code sfvb.page_exists. Without a group_template the page inherits its parent's templates, or catalog_group.vm directly under the root. Set attributes and images afterwards with the page attribute and image endpoints, and push the body to the page folder. Always needs sfvb_publish, because the page is live as soon as it exists. Deleting, moving and renaming pages stay in the store admin.
|
|
6897
7407
|
# @param storefront_oid [Integer]
|
|
@@ -10401,6 +10911,70 @@ module UltracartClient
|
|
|
10401
10911
|
return data, status_code, headers
|
|
10402
10912
|
end
|
|
10403
10913
|
|
|
10914
|
+
# Check a sending domain's verification
|
|
10915
|
+
# Asks Amazon SES again whether an amazon domain's DNS records are in place, and restarts a verification that failed (its records then change). A mailgun domain comes back as it is; Mailgun checks its own records.
|
|
10916
|
+
# @param domain [String]
|
|
10917
|
+
# @param [Hash] opts the optional parameters
|
|
10918
|
+
# @return [SfvbCommsSendingDomain]
|
|
10919
|
+
def refresh_sfvb_comms_sending_domain_status(domain, opts = {})
|
|
10920
|
+
data, _status_code, _headers = refresh_sfvb_comms_sending_domain_status_with_http_info(domain, opts)
|
|
10921
|
+
data
|
|
10922
|
+
end
|
|
10923
|
+
|
|
10924
|
+
# Check a sending domain's verification
|
|
10925
|
+
# Asks Amazon SES again whether an amazon domain's DNS records are in place, and restarts a verification that failed (its records then change). A mailgun domain comes back as it is; Mailgun checks its own records.
|
|
10926
|
+
# @param domain [String]
|
|
10927
|
+
# @param [Hash] opts the optional parameters
|
|
10928
|
+
# @return [Array<(SfvbCommsSendingDomain, Integer, Hash)>] SfvbCommsSendingDomain data, response status code and response headers
|
|
10929
|
+
def refresh_sfvb_comms_sending_domain_status_with_http_info(domain, opts = {})
|
|
10930
|
+
if @api_client.config.debugging
|
|
10931
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.refresh_sfvb_comms_sending_domain_status ...'
|
|
10932
|
+
end
|
|
10933
|
+
# verify the required parameter 'domain' is set
|
|
10934
|
+
if @api_client.config.client_side_validation && domain.nil?
|
|
10935
|
+
fail ArgumentError, "Missing the required parameter 'domain' when calling SfvbApi.refresh_sfvb_comms_sending_domain_status"
|
|
10936
|
+
end
|
|
10937
|
+
# resource path
|
|
10938
|
+
local_var_path = '/sfvb/comms/sending_domains/{domain}/status'.sub('{' + 'domain' + '}', CGI.escape(domain.to_s))
|
|
10939
|
+
|
|
10940
|
+
# query parameters
|
|
10941
|
+
query_params = opts[:query_params] || {}
|
|
10942
|
+
|
|
10943
|
+
# header parameters
|
|
10944
|
+
header_params = opts[:header_params] || {}
|
|
10945
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
10946
|
+
# HTTP header 'Accept' (if needed)
|
|
10947
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
10948
|
+
|
|
10949
|
+
# form parameters
|
|
10950
|
+
form_params = opts[:form_params] || {}
|
|
10951
|
+
|
|
10952
|
+
# http body (model)
|
|
10953
|
+
post_body = opts[:debug_body]
|
|
10954
|
+
|
|
10955
|
+
# return_type
|
|
10956
|
+
return_type = opts[:debug_return_type] || 'SfvbCommsSendingDomain'
|
|
10957
|
+
|
|
10958
|
+
# auth_names
|
|
10959
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
10960
|
+
|
|
10961
|
+
new_options = opts.merge(
|
|
10962
|
+
:operation => :"SfvbApi.refresh_sfvb_comms_sending_domain_status",
|
|
10963
|
+
:header_params => header_params,
|
|
10964
|
+
:query_params => query_params,
|
|
10965
|
+
:form_params => form_params,
|
|
10966
|
+
:body => post_body,
|
|
10967
|
+
:auth_names => auth_names,
|
|
10968
|
+
:return_type => return_type
|
|
10969
|
+
)
|
|
10970
|
+
|
|
10971
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
10972
|
+
if @api_client.config.debugging
|
|
10973
|
+
@api_client.config.logger.debug "API called: SfvbApi#refresh_sfvb_comms_sending_domain_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
10974
|
+
end
|
|
10975
|
+
return data, status_code, headers
|
|
10976
|
+
end
|
|
10977
|
+
|
|
10404
10978
|
# Drop one page's cached copy
|
|
10405
10979
|
# The next request renders the page fresh. Use it when a write succeeded, a read shows the new value, and the public page still shows the old one. Writes normally refresh the pages they affect, so a stale page after a write is a bug worth reporting with its URL. One page per request. The response says whether the page had a cached copy and whether anything was dropped.
|
|
10406
10980
|
# @param storefront_oid [Integer]
|
|
@@ -10640,6 +11214,168 @@ module UltracartClient
|
|
|
10640
11214
|
return data, status_code, headers
|
|
10641
11215
|
end
|
|
10642
11216
|
|
|
11217
|
+
# Render a flow or campaign email without sending it
|
|
11218
|
+
# Renders a flow or campaign email exactly as its send would, and returns the subject, preview text, HTML and text. Nothing is sent, saved or created. A unique coupon code, click id and magic link token are placeholders. A missing footer token, which a send skips the email for, is a warning. Give cjson to render an unsaved draft of the email container in place of the saved one. An order must be a test order. cart_item_ids fills the cart a cart flow email shows.
|
|
11219
|
+
# @param storefront_oid [Integer]
|
|
11220
|
+
# @param email_uuid [String]
|
|
11221
|
+
# @param email_render_request [SfvbEmailRenderRequest] What to render the email with
|
|
11222
|
+
# @param [Hash] opts the optional parameters
|
|
11223
|
+
# @return [SfvbEmailRenderResponse]
|
|
11224
|
+
def render_sfvb_email(storefront_oid, email_uuid, email_render_request, opts = {})
|
|
11225
|
+
data, _status_code, _headers = render_sfvb_email_with_http_info(storefront_oid, email_uuid, email_render_request, opts)
|
|
11226
|
+
data
|
|
11227
|
+
end
|
|
11228
|
+
|
|
11229
|
+
# Render a flow or campaign email without sending it
|
|
11230
|
+
# Renders a flow or campaign email exactly as its send would, and returns the subject, preview text, HTML and text. Nothing is sent, saved or created. A unique coupon code, click id and magic link token are placeholders. A missing footer token, which a send skips the email for, is a warning. Give cjson to render an unsaved draft of the email container in place of the saved one. An order must be a test order. cart_item_ids fills the cart a cart flow email shows.
|
|
11231
|
+
# @param storefront_oid [Integer]
|
|
11232
|
+
# @param email_uuid [String]
|
|
11233
|
+
# @param email_render_request [SfvbEmailRenderRequest] What to render the email with
|
|
11234
|
+
# @param [Hash] opts the optional parameters
|
|
11235
|
+
# @return [Array<(SfvbEmailRenderResponse, Integer, Hash)>] SfvbEmailRenderResponse data, response status code and response headers
|
|
11236
|
+
def render_sfvb_email_with_http_info(storefront_oid, email_uuid, email_render_request, opts = {})
|
|
11237
|
+
if @api_client.config.debugging
|
|
11238
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.render_sfvb_email ...'
|
|
11239
|
+
end
|
|
11240
|
+
# verify the required parameter 'storefront_oid' is set
|
|
11241
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
11242
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.render_sfvb_email"
|
|
11243
|
+
end
|
|
11244
|
+
# verify the required parameter 'email_uuid' is set
|
|
11245
|
+
if @api_client.config.client_side_validation && email_uuid.nil?
|
|
11246
|
+
fail ArgumentError, "Missing the required parameter 'email_uuid' when calling SfvbApi.render_sfvb_email"
|
|
11247
|
+
end
|
|
11248
|
+
# verify the required parameter 'email_render_request' is set
|
|
11249
|
+
if @api_client.config.client_side_validation && email_render_request.nil?
|
|
11250
|
+
fail ArgumentError, "Missing the required parameter 'email_render_request' when calling SfvbApi.render_sfvb_email"
|
|
11251
|
+
end
|
|
11252
|
+
# resource path
|
|
11253
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/emails/{email_uuid}/render'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'email_uuid' + '}', CGI.escape(email_uuid.to_s))
|
|
11254
|
+
|
|
11255
|
+
# query parameters
|
|
11256
|
+
query_params = opts[:query_params] || {}
|
|
11257
|
+
|
|
11258
|
+
# header parameters
|
|
11259
|
+
header_params = opts[:header_params] || {}
|
|
11260
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
11261
|
+
# HTTP header 'Accept' (if needed)
|
|
11262
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
11263
|
+
# HTTP header 'Content-Type'
|
|
11264
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
11265
|
+
if !content_type.nil?
|
|
11266
|
+
header_params['Content-Type'] = content_type
|
|
11267
|
+
end
|
|
11268
|
+
|
|
11269
|
+
# form parameters
|
|
11270
|
+
form_params = opts[:form_params] || {}
|
|
11271
|
+
|
|
11272
|
+
# http body (model)
|
|
11273
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(email_render_request)
|
|
11274
|
+
|
|
11275
|
+
# return_type
|
|
11276
|
+
return_type = opts[:debug_return_type] || 'SfvbEmailRenderResponse'
|
|
11277
|
+
|
|
11278
|
+
# auth_names
|
|
11279
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
11280
|
+
|
|
11281
|
+
new_options = opts.merge(
|
|
11282
|
+
:operation => :"SfvbApi.render_sfvb_email",
|
|
11283
|
+
:header_params => header_params,
|
|
11284
|
+
:query_params => query_params,
|
|
11285
|
+
:form_params => form_params,
|
|
11286
|
+
:body => post_body,
|
|
11287
|
+
:auth_names => auth_names,
|
|
11288
|
+
:return_type => return_type
|
|
11289
|
+
)
|
|
11290
|
+
|
|
11291
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
11292
|
+
if @api_client.config.debugging
|
|
11293
|
+
@api_client.config.logger.debug "API called: SfvbApi#render_sfvb_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
11294
|
+
end
|
|
11295
|
+
return data, status_code, headers
|
|
11296
|
+
end
|
|
11297
|
+
|
|
11298
|
+
# Render a transactional email without sending it
|
|
11299
|
+
# Renders a transactional email, such as the order receipt, exactly as it is sent, and returns the subject, HTML and text. Nothing is sent or saved. file_name is the template file, such as receipt_html.vm, or the display name. Give cjson to render an unsaved draft of the email's body container in place of the saved one. The order must be a test order. Without one the email renders with a made up order.
|
|
11300
|
+
# @param storefront_oid [Integer]
|
|
11301
|
+
# @param file_name [String]
|
|
11302
|
+
# @param email_render_request [SfvbEmailRenderRequest] What to render the email with
|
|
11303
|
+
# @param [Hash] opts the optional parameters
|
|
11304
|
+
# @return [SfvbEmailRenderResponse]
|
|
11305
|
+
def render_sfvb_transactional_email(storefront_oid, file_name, email_render_request, opts = {})
|
|
11306
|
+
data, _status_code, _headers = render_sfvb_transactional_email_with_http_info(storefront_oid, file_name, email_render_request, opts)
|
|
11307
|
+
data
|
|
11308
|
+
end
|
|
11309
|
+
|
|
11310
|
+
# Render a transactional email without sending it
|
|
11311
|
+
# Renders a transactional email, such as the order receipt, exactly as it is sent, and returns the subject, HTML and text. Nothing is sent or saved. file_name is the template file, such as receipt_html.vm, or the display name. Give cjson to render an unsaved draft of the email's body container in place of the saved one. The order must be a test order. Without one the email renders with a made up order.
|
|
11312
|
+
# @param storefront_oid [Integer]
|
|
11313
|
+
# @param file_name [String]
|
|
11314
|
+
# @param email_render_request [SfvbEmailRenderRequest] What to render the email with
|
|
11315
|
+
# @param [Hash] opts the optional parameters
|
|
11316
|
+
# @return [Array<(SfvbEmailRenderResponse, Integer, Hash)>] SfvbEmailRenderResponse data, response status code and response headers
|
|
11317
|
+
def render_sfvb_transactional_email_with_http_info(storefront_oid, file_name, email_render_request, opts = {})
|
|
11318
|
+
if @api_client.config.debugging
|
|
11319
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.render_sfvb_transactional_email ...'
|
|
11320
|
+
end
|
|
11321
|
+
# verify the required parameter 'storefront_oid' is set
|
|
11322
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
11323
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.render_sfvb_transactional_email"
|
|
11324
|
+
end
|
|
11325
|
+
# verify the required parameter 'file_name' is set
|
|
11326
|
+
if @api_client.config.client_side_validation && file_name.nil?
|
|
11327
|
+
fail ArgumentError, "Missing the required parameter 'file_name' when calling SfvbApi.render_sfvb_transactional_email"
|
|
11328
|
+
end
|
|
11329
|
+
# verify the required parameter 'email_render_request' is set
|
|
11330
|
+
if @api_client.config.client_side_validation && email_render_request.nil?
|
|
11331
|
+
fail ArgumentError, "Missing the required parameter 'email_render_request' when calling SfvbApi.render_sfvb_transactional_email"
|
|
11332
|
+
end
|
|
11333
|
+
# resource path
|
|
11334
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/transactional_emails/{file_name}/render'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'file_name' + '}', CGI.escape(file_name.to_s))
|
|
11335
|
+
|
|
11336
|
+
# query parameters
|
|
11337
|
+
query_params = opts[:query_params] || {}
|
|
11338
|
+
|
|
11339
|
+
# header parameters
|
|
11340
|
+
header_params = opts[:header_params] || {}
|
|
11341
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
11342
|
+
# HTTP header 'Accept' (if needed)
|
|
11343
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
11344
|
+
# HTTP header 'Content-Type'
|
|
11345
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
11346
|
+
if !content_type.nil?
|
|
11347
|
+
header_params['Content-Type'] = content_type
|
|
11348
|
+
end
|
|
11349
|
+
|
|
11350
|
+
# form parameters
|
|
11351
|
+
form_params = opts[:form_params] || {}
|
|
11352
|
+
|
|
11353
|
+
# http body (model)
|
|
11354
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(email_render_request)
|
|
11355
|
+
|
|
11356
|
+
# return_type
|
|
11357
|
+
return_type = opts[:debug_return_type] || 'SfvbEmailRenderResponse'
|
|
11358
|
+
|
|
11359
|
+
# auth_names
|
|
11360
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
11361
|
+
|
|
11362
|
+
new_options = opts.merge(
|
|
11363
|
+
:operation => :"SfvbApi.render_sfvb_transactional_email",
|
|
11364
|
+
:header_params => header_params,
|
|
11365
|
+
:query_params => query_params,
|
|
11366
|
+
:form_params => form_params,
|
|
11367
|
+
:body => post_body,
|
|
11368
|
+
:auth_names => auth_names,
|
|
11369
|
+
:return_type => return_type
|
|
11370
|
+
)
|
|
11371
|
+
|
|
11372
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
11373
|
+
if @api_client.config.debugging
|
|
11374
|
+
@api_client.config.logger.debug "API called: SfvbApi#render_sfvb_transactional_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
11375
|
+
end
|
|
11376
|
+
return data, status_code, headers
|
|
11377
|
+
end
|
|
11378
|
+
|
|
10643
11379
|
# Render a CJSON node to HTML
|
|
10644
11380
|
# Renders one node in the context of a theme and a page. Unlike compile this is stateful. Rendering resolves merchant data, so an element bound to an item renders wrongly, and silently, without a context item id. One node per call, so a node that fails to render fails on its own rather than taking a batch with it, and a failure says why. By default the node renders as a shopper sees it, with conditions, prices and sale state evaluated against the context item. Set edit_mode to render every branch the way the builder shows it, for styling content a shopper only sometimes sees.
|
|
10645
11381
|
# @param storefront_oid [Integer]
|
|
@@ -12101,6 +12837,150 @@ module UltracartClient
|
|
|
12101
12837
|
return data, status_code, headers
|
|
12102
12838
|
end
|
|
12103
12839
|
|
|
12840
|
+
# Update a sending domain
|
|
12841
|
+
# Only a mailgun domain's mailgun_api_key can change. Send it as a secret handle made for the domain to replace it, or as the mask it was read with to keep it. A new key sets up UltraCart's webhooks again with it; if Mailgun refuses, nothing is saved and the handle is given back unused.
|
|
12842
|
+
# @param domain [String]
|
|
12843
|
+
# @param sending_domain [SfvbCommsSendingDomain] The changes
|
|
12844
|
+
# @param [Hash] opts the optional parameters
|
|
12845
|
+
# @return [SfvbCommsSendingDomain]
|
|
12846
|
+
def update_sfvb_comms_sending_domain(domain, sending_domain, opts = {})
|
|
12847
|
+
data, _status_code, _headers = update_sfvb_comms_sending_domain_with_http_info(domain, sending_domain, opts)
|
|
12848
|
+
data
|
|
12849
|
+
end
|
|
12850
|
+
|
|
12851
|
+
# Update a sending domain
|
|
12852
|
+
# Only a mailgun domain's mailgun_api_key can change. Send it as a secret handle made for the domain to replace it, or as the mask it was read with to keep it. A new key sets up UltraCart's webhooks again with it; if Mailgun refuses, nothing is saved and the handle is given back unused.
|
|
12853
|
+
# @param domain [String]
|
|
12854
|
+
# @param sending_domain [SfvbCommsSendingDomain] The changes
|
|
12855
|
+
# @param [Hash] opts the optional parameters
|
|
12856
|
+
# @return [Array<(SfvbCommsSendingDomain, Integer, Hash)>] SfvbCommsSendingDomain data, response status code and response headers
|
|
12857
|
+
def update_sfvb_comms_sending_domain_with_http_info(domain, sending_domain, opts = {})
|
|
12858
|
+
if @api_client.config.debugging
|
|
12859
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.update_sfvb_comms_sending_domain ...'
|
|
12860
|
+
end
|
|
12861
|
+
# verify the required parameter 'domain' is set
|
|
12862
|
+
if @api_client.config.client_side_validation && domain.nil?
|
|
12863
|
+
fail ArgumentError, "Missing the required parameter 'domain' when calling SfvbApi.update_sfvb_comms_sending_domain"
|
|
12864
|
+
end
|
|
12865
|
+
# verify the required parameter 'sending_domain' is set
|
|
12866
|
+
if @api_client.config.client_side_validation && sending_domain.nil?
|
|
12867
|
+
fail ArgumentError, "Missing the required parameter 'sending_domain' when calling SfvbApi.update_sfvb_comms_sending_domain"
|
|
12868
|
+
end
|
|
12869
|
+
# resource path
|
|
12870
|
+
local_var_path = '/sfvb/comms/sending_domains/{domain}'.sub('{' + 'domain' + '}', CGI.escape(domain.to_s))
|
|
12871
|
+
|
|
12872
|
+
# query parameters
|
|
12873
|
+
query_params = opts[:query_params] || {}
|
|
12874
|
+
|
|
12875
|
+
# header parameters
|
|
12876
|
+
header_params = opts[:header_params] || {}
|
|
12877
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
12878
|
+
# HTTP header 'Accept' (if needed)
|
|
12879
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
12880
|
+
# HTTP header 'Content-Type'
|
|
12881
|
+
content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
|
|
12882
|
+
if !content_type.nil?
|
|
12883
|
+
header_params['Content-Type'] = content_type
|
|
12884
|
+
end
|
|
12885
|
+
|
|
12886
|
+
# form parameters
|
|
12887
|
+
form_params = opts[:form_params] || {}
|
|
12888
|
+
|
|
12889
|
+
# http body (model)
|
|
12890
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(sending_domain)
|
|
12891
|
+
|
|
12892
|
+
# return_type
|
|
12893
|
+
return_type = opts[:debug_return_type] || 'SfvbCommsSendingDomain'
|
|
12894
|
+
|
|
12895
|
+
# auth_names
|
|
12896
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
12897
|
+
|
|
12898
|
+
new_options = opts.merge(
|
|
12899
|
+
:operation => :"SfvbApi.update_sfvb_comms_sending_domain",
|
|
12900
|
+
:header_params => header_params,
|
|
12901
|
+
:query_params => query_params,
|
|
12902
|
+
:form_params => form_params,
|
|
12903
|
+
:body => post_body,
|
|
12904
|
+
:auth_names => auth_names,
|
|
12905
|
+
:return_type => return_type
|
|
12906
|
+
)
|
|
12907
|
+
|
|
12908
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
12909
|
+
if @api_client.config.debugging
|
|
12910
|
+
@api_client.config.logger.debug "API called: SfvbApi#update_sfvb_comms_sending_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
12911
|
+
end
|
|
12912
|
+
return data, status_code, headers
|
|
12913
|
+
end
|
|
12914
|
+
|
|
12915
|
+
# Update the Twilio account
|
|
12916
|
+
# Changes the account's Twilio account. Leave a field out to keep it. Send auth_token as the mask it was read with to keep it, or as a secret handle made for the account SID to replace it. A new account_sid needs a new auth_token with it. A new token is checked with Twilio and UltraCart's API key, TwiML apps and voice encryption key are made again; if Twilio refuses, nothing is saved and the handle is given back unused. phone_numbers, when sent, replaces the list.
|
|
12917
|
+
# @param twilio_account [SfvbCommsTwilioAccount] The changes
|
|
12918
|
+
# @param [Hash] opts the optional parameters
|
|
12919
|
+
# @return [SfvbCommsTwilioAccountResponse]
|
|
12920
|
+
def update_sfvb_comms_twilio_account(twilio_account, opts = {})
|
|
12921
|
+
data, _status_code, _headers = update_sfvb_comms_twilio_account_with_http_info(twilio_account, opts)
|
|
12922
|
+
data
|
|
12923
|
+
end
|
|
12924
|
+
|
|
12925
|
+
# Update the Twilio account
|
|
12926
|
+
# Changes the account's Twilio account. Leave a field out to keep it. Send auth_token as the mask it was read with to keep it, or as a secret handle made for the account SID to replace it. A new account_sid needs a new auth_token with it. A new token is checked with Twilio and UltraCart's API key, TwiML apps and voice encryption key are made again; if Twilio refuses, nothing is saved and the handle is given back unused. phone_numbers, when sent, replaces the list.
|
|
12927
|
+
# @param twilio_account [SfvbCommsTwilioAccount] The changes
|
|
12928
|
+
# @param [Hash] opts the optional parameters
|
|
12929
|
+
# @return [Array<(SfvbCommsTwilioAccountResponse, Integer, Hash)>] SfvbCommsTwilioAccountResponse data, response status code and response headers
|
|
12930
|
+
def update_sfvb_comms_twilio_account_with_http_info(twilio_account, opts = {})
|
|
12931
|
+
if @api_client.config.debugging
|
|
12932
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.update_sfvb_comms_twilio_account ...'
|
|
12933
|
+
end
|
|
12934
|
+
# verify the required parameter 'twilio_account' is set
|
|
12935
|
+
if @api_client.config.client_side_validation && twilio_account.nil?
|
|
12936
|
+
fail ArgumentError, "Missing the required parameter 'twilio_account' when calling SfvbApi.update_sfvb_comms_twilio_account"
|
|
12937
|
+
end
|
|
12938
|
+
# resource path
|
|
12939
|
+
local_var_path = '/sfvb/comms/twilio_account'
|
|
12940
|
+
|
|
12941
|
+
# query parameters
|
|
12942
|
+
query_params = opts[:query_params] || {}
|
|
12943
|
+
|
|
12944
|
+
# header parameters
|
|
12945
|
+
header_params = opts[:header_params] || {}
|
|
12946
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
12947
|
+
# HTTP header 'Accept' (if needed)
|
|
12948
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
12949
|
+
# HTTP header 'Content-Type'
|
|
12950
|
+
content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
|
|
12951
|
+
if !content_type.nil?
|
|
12952
|
+
header_params['Content-Type'] = content_type
|
|
12953
|
+
end
|
|
12954
|
+
|
|
12955
|
+
# form parameters
|
|
12956
|
+
form_params = opts[:form_params] || {}
|
|
12957
|
+
|
|
12958
|
+
# http body (model)
|
|
12959
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(twilio_account)
|
|
12960
|
+
|
|
12961
|
+
# return_type
|
|
12962
|
+
return_type = opts[:debug_return_type] || 'SfvbCommsTwilioAccountResponse'
|
|
12963
|
+
|
|
12964
|
+
# auth_names
|
|
12965
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
12966
|
+
|
|
12967
|
+
new_options = opts.merge(
|
|
12968
|
+
:operation => :"SfvbApi.update_sfvb_comms_twilio_account",
|
|
12969
|
+
:header_params => header_params,
|
|
12970
|
+
:query_params => query_params,
|
|
12971
|
+
:form_params => form_params,
|
|
12972
|
+
:body => post_body,
|
|
12973
|
+
:auth_names => auth_names,
|
|
12974
|
+
:return_type => return_type
|
|
12975
|
+
)
|
|
12976
|
+
|
|
12977
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
12978
|
+
if @api_client.config.debugging
|
|
12979
|
+
@api_client.config.logger.debug "API called: SfvbApi#update_sfvb_comms_twilio_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
12980
|
+
end
|
|
12981
|
+
return data, status_code, headers
|
|
12982
|
+
end
|
|
12983
|
+
|
|
12104
12984
|
# Change attributes across many items in one call
|
|
12105
12985
|
# Applies exactly the change rows of a dry run, given its plan_hash, each with its merchant_item_oid and current_sha256. Each item is saved once with all of its rows; a row whose value changed since the dry run is skipped as stale and never overwritten, and an item that cannot be saved does not stop the others. Only the named attributes change. Needs sfvb_publish and the approval of the person who signed in the CLI, an approved item.attribute_batch request for exactly these rows in the Approval-Id header.
|
|
12106
12986
|
# @param storefront_oid [Integer]
|