ultracart_api 4.1.190 → 4.1.192
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 +34 -2
- data/docs/SfvbApi.md +782 -2
- data/docs/SfvbNotFoundEntry.md +38 -0
- data/docs/SfvbNotFoundEntryResponse.md +20 -0
- data/docs/SfvbNotFoundHit.md +24 -0
- data/docs/SfvbNotFoundPage.md +28 -0
- data/docs/SfvbNotFoundResponse.md +20 -0
- data/docs/SfvbRedirect.md +42 -0
- data/docs/SfvbRedirectCheckResponse.md +26 -0
- data/docs/SfvbRedirectImportRequest.md +20 -0
- data/docs/SfvbRedirectImportResponse.md +32 -0
- data/docs/SfvbRedirectImportRow.md +22 -0
- data/docs/SfvbRedirectImportRowResult.md +26 -0
- data/docs/SfvbRedirectRequest.md +26 -0
- data/docs/SfvbRedirectResolveResponse.md +28 -0
- data/docs/SfvbRedirectResolveStep.md +22 -0
- data/docs/SfvbRedirectResponse.md +20 -0
- data/docs/SfvbRedirectsResponse.md +22 -0
- data/docs/SfvbRenderRequest.md +1 -1
- data/lib/ultracart_api/api/sfvb_api.rb +1132 -98
- data/lib/ultracart_api/models/sfvb_not_found_entry.rb +322 -0
- data/lib/ultracart_api/models/sfvb_not_found_entry_response.rb +231 -0
- data/lib/ultracart_api/models/sfvb_not_found_hit.rb +250 -0
- data/lib/ultracart_api/models/sfvb_not_found_page.rb +270 -0
- data/lib/ultracart_api/models/sfvb_not_found_response.rb +232 -0
- data/lib/ultracart_api/models/sfvb_redirect.rb +340 -0
- data/lib/ultracart_api/models/sfvb_redirect_check_response.rb +264 -0
- data/lib/ultracart_api/models/sfvb_redirect_import_request.rb +232 -0
- data/lib/ultracart_api/models/sfvb_redirect_import_response.rb +292 -0
- data/lib/ultracart_api/models/sfvb_redirect_import_row.rb +240 -0
- data/lib/ultracart_api/models/sfvb_redirect_import_row_result.rb +264 -0
- data/lib/ultracart_api/models/sfvb_redirect_request.rb +260 -0
- data/lib/ultracart_api/models/sfvb_redirect_resolve_response.rb +272 -0
- data/lib/ultracart_api/models/sfvb_redirect_resolve_step.rb +240 -0
- data/lib/ultracart_api/models/sfvb_redirect_response.rb +231 -0
- data/lib/ultracart_api/models/sfvb_redirects_response.rb +242 -0
- data/lib/ultracart_api/models/sfvb_render_request.rb +1 -1
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +16 -0
- metadata +33 -1
|
@@ -347,6 +347,81 @@ module UltracartClient
|
|
|
347
347
|
return data, status_code, headers
|
|
348
348
|
end
|
|
349
349
|
|
|
350
|
+
# Check a redirect rule without creating it
|
|
351
|
+
# Runs every check a create runs (loops, chains, duplicates, missing or external targets, system paths, live pages, the rule limit) and returns the findings. Writes nothing.
|
|
352
|
+
# @param storefront_oid [Integer]
|
|
353
|
+
# @param redirect_request [SfvbRedirectRequest] The request
|
|
354
|
+
# @param [Hash] opts the optional parameters
|
|
355
|
+
# @return [SfvbRedirectCheckResponse]
|
|
356
|
+
def check_sfvb_redirect(storefront_oid, redirect_request, opts = {})
|
|
357
|
+
data, _status_code, _headers = check_sfvb_redirect_with_http_info(storefront_oid, redirect_request, opts)
|
|
358
|
+
data
|
|
359
|
+
end
|
|
360
|
+
|
|
361
|
+
# Check a redirect rule without creating it
|
|
362
|
+
# Runs every check a create runs (loops, chains, duplicates, missing or external targets, system paths, live pages, the rule limit) and returns the findings. Writes nothing.
|
|
363
|
+
# @param storefront_oid [Integer]
|
|
364
|
+
# @param redirect_request [SfvbRedirectRequest] The request
|
|
365
|
+
# @param [Hash] opts the optional parameters
|
|
366
|
+
# @return [Array<(SfvbRedirectCheckResponse, Integer, Hash)>] SfvbRedirectCheckResponse data, response status code and response headers
|
|
367
|
+
def check_sfvb_redirect_with_http_info(storefront_oid, redirect_request, opts = {})
|
|
368
|
+
if @api_client.config.debugging
|
|
369
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.check_sfvb_redirect ...'
|
|
370
|
+
end
|
|
371
|
+
# verify the required parameter 'storefront_oid' is set
|
|
372
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
373
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.check_sfvb_redirect"
|
|
374
|
+
end
|
|
375
|
+
# verify the required parameter 'redirect_request' is set
|
|
376
|
+
if @api_client.config.client_side_validation && redirect_request.nil?
|
|
377
|
+
fail ArgumentError, "Missing the required parameter 'redirect_request' when calling SfvbApi.check_sfvb_redirect"
|
|
378
|
+
end
|
|
379
|
+
# resource path
|
|
380
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/redirects/check'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
|
|
381
|
+
|
|
382
|
+
# query parameters
|
|
383
|
+
query_params = opts[:query_params] || {}
|
|
384
|
+
|
|
385
|
+
# header parameters
|
|
386
|
+
header_params = opts[:header_params] || {}
|
|
387
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
388
|
+
# HTTP header 'Accept' (if needed)
|
|
389
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
390
|
+
# HTTP header 'Content-Type'
|
|
391
|
+
content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
|
|
392
|
+
if !content_type.nil?
|
|
393
|
+
header_params['Content-Type'] = content_type
|
|
394
|
+
end
|
|
395
|
+
|
|
396
|
+
# form parameters
|
|
397
|
+
form_params = opts[:form_params] || {}
|
|
398
|
+
|
|
399
|
+
# http body (model)
|
|
400
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(redirect_request)
|
|
401
|
+
|
|
402
|
+
# return_type
|
|
403
|
+
return_type = opts[:debug_return_type] || 'SfvbRedirectCheckResponse'
|
|
404
|
+
|
|
405
|
+
# auth_names
|
|
406
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
407
|
+
|
|
408
|
+
new_options = opts.merge(
|
|
409
|
+
:operation => :"SfvbApi.check_sfvb_redirect",
|
|
410
|
+
:header_params => header_params,
|
|
411
|
+
:query_params => query_params,
|
|
412
|
+
:form_params => form_params,
|
|
413
|
+
:body => post_body,
|
|
414
|
+
:auth_names => auth_names,
|
|
415
|
+
:return_type => return_type
|
|
416
|
+
)
|
|
417
|
+
|
|
418
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
419
|
+
if @api_client.config.debugging
|
|
420
|
+
@api_client.config.logger.debug "API called: SfvbApi#check_sfvb_redirect\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
421
|
+
end
|
|
422
|
+
return data, status_code, headers
|
|
423
|
+
end
|
|
424
|
+
|
|
350
425
|
# Remove a library entry's screenshot
|
|
351
426
|
# Owner only, with the draft's hash_sha256 as If-Match. Clears the screenshot and thumbnail. Published revisions and copies that used the image keep it.
|
|
352
427
|
# @param storefront_oid [Integer]
|
|
@@ -1224,6 +1299,83 @@ module UltracartClient
|
|
|
1224
1299
|
return data, status_code, headers
|
|
1225
1300
|
end
|
|
1226
1301
|
|
|
1302
|
+
# Delete a redirect rule
|
|
1303
|
+
# Deletes one rule. The source path answers again as it would without the rule. Send the hash_sha256 you read as If-Match. Always needs sfvb_publish.
|
|
1304
|
+
# @param storefront_oid [Integer]
|
|
1305
|
+
# @param redirect_id [Integer]
|
|
1306
|
+
# @param if_match [String] hash_sha256 from the last read. 428 when absent, 412 when stale.
|
|
1307
|
+
# @param [Hash] opts the optional parameters
|
|
1308
|
+
# @return [nil]
|
|
1309
|
+
def delete_sfvb_redirect(storefront_oid, redirect_id, if_match, opts = {})
|
|
1310
|
+
delete_sfvb_redirect_with_http_info(storefront_oid, redirect_id, if_match, opts)
|
|
1311
|
+
nil
|
|
1312
|
+
end
|
|
1313
|
+
|
|
1314
|
+
# Delete a redirect rule
|
|
1315
|
+
# Deletes one rule. The source path answers again as it would without the rule. Send the hash_sha256 you read as If-Match. Always needs sfvb_publish.
|
|
1316
|
+
# @param storefront_oid [Integer]
|
|
1317
|
+
# @param redirect_id [Integer]
|
|
1318
|
+
# @param if_match [String] hash_sha256 from the last read. 428 when absent, 412 when stale.
|
|
1319
|
+
# @param [Hash] opts the optional parameters
|
|
1320
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
1321
|
+
def delete_sfvb_redirect_with_http_info(storefront_oid, redirect_id, if_match, opts = {})
|
|
1322
|
+
if @api_client.config.debugging
|
|
1323
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.delete_sfvb_redirect ...'
|
|
1324
|
+
end
|
|
1325
|
+
# verify the required parameter 'storefront_oid' is set
|
|
1326
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
1327
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.delete_sfvb_redirect"
|
|
1328
|
+
end
|
|
1329
|
+
# verify the required parameter 'redirect_id' is set
|
|
1330
|
+
if @api_client.config.client_side_validation && redirect_id.nil?
|
|
1331
|
+
fail ArgumentError, "Missing the required parameter 'redirect_id' when calling SfvbApi.delete_sfvb_redirect"
|
|
1332
|
+
end
|
|
1333
|
+
# verify the required parameter 'if_match' is set
|
|
1334
|
+
if @api_client.config.client_side_validation && if_match.nil?
|
|
1335
|
+
fail ArgumentError, "Missing the required parameter 'if_match' when calling SfvbApi.delete_sfvb_redirect"
|
|
1336
|
+
end
|
|
1337
|
+
# resource path
|
|
1338
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/redirects/{redirect_id}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'redirect_id' + '}', CGI.escape(redirect_id.to_s))
|
|
1339
|
+
|
|
1340
|
+
# query parameters
|
|
1341
|
+
query_params = opts[:query_params] || {}
|
|
1342
|
+
|
|
1343
|
+
# header parameters
|
|
1344
|
+
header_params = opts[:header_params] || {}
|
|
1345
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
1346
|
+
# HTTP header 'Accept' (if needed)
|
|
1347
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1348
|
+
header_params[:'If-Match'] = if_match
|
|
1349
|
+
|
|
1350
|
+
# form parameters
|
|
1351
|
+
form_params = opts[:form_params] || {}
|
|
1352
|
+
|
|
1353
|
+
# http body (model)
|
|
1354
|
+
post_body = opts[:debug_body]
|
|
1355
|
+
|
|
1356
|
+
# return_type
|
|
1357
|
+
return_type = opts[:debug_return_type]
|
|
1358
|
+
|
|
1359
|
+
# auth_names
|
|
1360
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
1361
|
+
|
|
1362
|
+
new_options = opts.merge(
|
|
1363
|
+
:operation => :"SfvbApi.delete_sfvb_redirect",
|
|
1364
|
+
:header_params => header_params,
|
|
1365
|
+
:query_params => query_params,
|
|
1366
|
+
:form_params => form_params,
|
|
1367
|
+
:body => post_body,
|
|
1368
|
+
:auth_names => auth_names,
|
|
1369
|
+
:return_type => return_type
|
|
1370
|
+
)
|
|
1371
|
+
|
|
1372
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
1373
|
+
if @api_client.config.debugging
|
|
1374
|
+
@api_client.config.logger.debug "API called: SfvbApi#delete_sfvb_redirect\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1375
|
+
end
|
|
1376
|
+
return data, status_code, headers
|
|
1377
|
+
end
|
|
1378
|
+
|
|
1227
1379
|
# Detach an image from a blog post
|
|
1228
1380
|
# Name exactly one of default_image, code or blog_post_multimedia_oid. Removes the image from the post and deletes its stored copy. Take it out of the body too, or the body keeps a broken image. A post that is not a draft needs sfvb_publish.
|
|
1229
1381
|
# @param storefront_oid [Integer]
|
|
@@ -1589,6 +1741,81 @@ module UltracartClient
|
|
|
1589
1741
|
return data, status_code, headers
|
|
1590
1742
|
end
|
|
1591
1743
|
|
|
1744
|
+
# Check a redirect import without writing it
|
|
1745
|
+
# Checks up to 5,000 rows against the existing rules and each other, and returns the findings per row with a plan_hash. Writes nothing. Rows are merged with the existing rules; nothing is ever deleted.
|
|
1746
|
+
# @param storefront_oid [Integer]
|
|
1747
|
+
# @param redirect_import_request [SfvbRedirectImportRequest] The request
|
|
1748
|
+
# @param [Hash] opts the optional parameters
|
|
1749
|
+
# @return [SfvbRedirectImportResponse]
|
|
1750
|
+
def dry_run_sfvb_redirect_import(storefront_oid, redirect_import_request, opts = {})
|
|
1751
|
+
data, _status_code, _headers = dry_run_sfvb_redirect_import_with_http_info(storefront_oid, redirect_import_request, opts)
|
|
1752
|
+
data
|
|
1753
|
+
end
|
|
1754
|
+
|
|
1755
|
+
# Check a redirect import without writing it
|
|
1756
|
+
# Checks up to 5,000 rows against the existing rules and each other, and returns the findings per row with a plan_hash. Writes nothing. Rows are merged with the existing rules; nothing is ever deleted.
|
|
1757
|
+
# @param storefront_oid [Integer]
|
|
1758
|
+
# @param redirect_import_request [SfvbRedirectImportRequest] The request
|
|
1759
|
+
# @param [Hash] opts the optional parameters
|
|
1760
|
+
# @return [Array<(SfvbRedirectImportResponse, Integer, Hash)>] SfvbRedirectImportResponse data, response status code and response headers
|
|
1761
|
+
def dry_run_sfvb_redirect_import_with_http_info(storefront_oid, redirect_import_request, opts = {})
|
|
1762
|
+
if @api_client.config.debugging
|
|
1763
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.dry_run_sfvb_redirect_import ...'
|
|
1764
|
+
end
|
|
1765
|
+
# verify the required parameter 'storefront_oid' is set
|
|
1766
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
1767
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.dry_run_sfvb_redirect_import"
|
|
1768
|
+
end
|
|
1769
|
+
# verify the required parameter 'redirect_import_request' is set
|
|
1770
|
+
if @api_client.config.client_side_validation && redirect_import_request.nil?
|
|
1771
|
+
fail ArgumentError, "Missing the required parameter 'redirect_import_request' when calling SfvbApi.dry_run_sfvb_redirect_import"
|
|
1772
|
+
end
|
|
1773
|
+
# resource path
|
|
1774
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/redirects/import/dry_run'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
|
|
1775
|
+
|
|
1776
|
+
# query parameters
|
|
1777
|
+
query_params = opts[:query_params] || {}
|
|
1778
|
+
|
|
1779
|
+
# header parameters
|
|
1780
|
+
header_params = opts[:header_params] || {}
|
|
1781
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
1782
|
+
# HTTP header 'Accept' (if needed)
|
|
1783
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1784
|
+
# HTTP header 'Content-Type'
|
|
1785
|
+
content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
|
|
1786
|
+
if !content_type.nil?
|
|
1787
|
+
header_params['Content-Type'] = content_type
|
|
1788
|
+
end
|
|
1789
|
+
|
|
1790
|
+
# form parameters
|
|
1791
|
+
form_params = opts[:form_params] || {}
|
|
1792
|
+
|
|
1793
|
+
# http body (model)
|
|
1794
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(redirect_import_request)
|
|
1795
|
+
|
|
1796
|
+
# return_type
|
|
1797
|
+
return_type = opts[:debug_return_type] || 'SfvbRedirectImportResponse'
|
|
1798
|
+
|
|
1799
|
+
# auth_names
|
|
1800
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
1801
|
+
|
|
1802
|
+
new_options = opts.merge(
|
|
1803
|
+
:operation => :"SfvbApi.dry_run_sfvb_redirect_import",
|
|
1804
|
+
:header_params => header_params,
|
|
1805
|
+
:query_params => query_params,
|
|
1806
|
+
:form_params => form_params,
|
|
1807
|
+
:body => post_body,
|
|
1808
|
+
:auth_names => auth_names,
|
|
1809
|
+
:return_type => return_type
|
|
1810
|
+
)
|
|
1811
|
+
|
|
1812
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
1813
|
+
if @api_client.config.debugging
|
|
1814
|
+
@api_client.config.logger.debug "API called: SfvbApi#dry_run_sfvb_redirect_import\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1815
|
+
end
|
|
1816
|
+
return data, status_code, headers
|
|
1817
|
+
end
|
|
1818
|
+
|
|
1592
1819
|
# Copy a library entry into a new private entry
|
|
1593
1820
|
# The copy is owned by the calling user and private. From an entry you own it copies the draft; from one shared with you it copies the published revision. It is scanned on its own and inherits nothing but content, its images and its screenshot.
|
|
1594
1821
|
# @param storefront_oid [Integer]
|
|
@@ -3658,41 +3885,52 @@ module UltracartClient
|
|
|
3658
3885
|
return data, status_code, headers
|
|
3659
3886
|
end
|
|
3660
3887
|
|
|
3661
|
-
#
|
|
3662
|
-
#
|
|
3888
|
+
# List the paths that answered 404
|
|
3889
|
+
# The paths shoppers asked for that answered 404, most hits first or by last_seen. Paths only, never query strings. Bots are left out unless include_bots. Token-like path segments show as {token} unless include_tokens. limit is 1 to 100, default 50.
|
|
3663
3890
|
# @param storefront_oid [Integer]
|
|
3664
|
-
# @param path [String] Page path, for example /catalog/dispensers/
|
|
3665
3891
|
# @param [Hash] opts the optional parameters
|
|
3666
|
-
# @
|
|
3667
|
-
|
|
3668
|
-
|
|
3892
|
+
# @option opts [String] :since
|
|
3893
|
+
# @option opts [String] :sort
|
|
3894
|
+
# @option opts [Boolean] :include_bots
|
|
3895
|
+
# @option opts [Boolean] :include_tokens
|
|
3896
|
+
# @option opts [String] :q
|
|
3897
|
+
# @option opts [Integer] :limit
|
|
3898
|
+
# @return [SfvbNotFoundResponse]
|
|
3899
|
+
def get_sfvb_not_found(storefront_oid, opts = {})
|
|
3900
|
+
data, _status_code, _headers = get_sfvb_not_found_with_http_info(storefront_oid, opts)
|
|
3669
3901
|
data
|
|
3670
3902
|
end
|
|
3671
3903
|
|
|
3672
|
-
#
|
|
3673
|
-
#
|
|
3904
|
+
# List the paths that answered 404
|
|
3905
|
+
# The paths shoppers asked for that answered 404, most hits first or by last_seen. Paths only, never query strings. Bots are left out unless include_bots. Token-like path segments show as {token} unless include_tokens. limit is 1 to 100, default 50.
|
|
3674
3906
|
# @param storefront_oid [Integer]
|
|
3675
|
-
# @param path [String] Page path, for example /catalog/dispensers/
|
|
3676
3907
|
# @param [Hash] opts the optional parameters
|
|
3677
|
-
# @
|
|
3678
|
-
|
|
3908
|
+
# @option opts [String] :since
|
|
3909
|
+
# @option opts [String] :sort
|
|
3910
|
+
# @option opts [Boolean] :include_bots
|
|
3911
|
+
# @option opts [Boolean] :include_tokens
|
|
3912
|
+
# @option opts [String] :q
|
|
3913
|
+
# @option opts [Integer] :limit
|
|
3914
|
+
# @return [Array<(SfvbNotFoundResponse, Integer, Hash)>] SfvbNotFoundResponse data, response status code and response headers
|
|
3915
|
+
def get_sfvb_not_found_with_http_info(storefront_oid, opts = {})
|
|
3679
3916
|
if @api_client.config.debugging
|
|
3680
|
-
@api_client.config.logger.debug 'Calling API: SfvbApi.
|
|
3917
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_not_found ...'
|
|
3681
3918
|
end
|
|
3682
3919
|
# verify the required parameter 'storefront_oid' is set
|
|
3683
3920
|
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
3684
|
-
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.
|
|
3685
|
-
end
|
|
3686
|
-
# verify the required parameter 'path' is set
|
|
3687
|
-
if @api_client.config.client_side_validation && path.nil?
|
|
3688
|
-
fail ArgumentError, "Missing the required parameter 'path' when calling SfvbApi.get_sfvb_page"
|
|
3921
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_not_found"
|
|
3689
3922
|
end
|
|
3690
3923
|
# resource path
|
|
3691
|
-
local_var_path = '/sfvb/storefronts/{storefront_oid}/
|
|
3924
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/not_found'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
|
|
3692
3925
|
|
|
3693
3926
|
# query parameters
|
|
3694
3927
|
query_params = opts[:query_params] || {}
|
|
3695
|
-
query_params[:'
|
|
3928
|
+
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
|
3929
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
|
3930
|
+
query_params[:'include_bots'] = opts[:'include_bots'] if !opts[:'include_bots'].nil?
|
|
3931
|
+
query_params[:'include_tokens'] = opts[:'include_tokens'] if !opts[:'include_tokens'].nil?
|
|
3932
|
+
query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
|
|
3933
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
|
3696
3934
|
|
|
3697
3935
|
# header parameters
|
|
3698
3936
|
header_params = opts[:header_params] || {}
|
|
@@ -3707,13 +3945,13 @@ module UltracartClient
|
|
|
3707
3945
|
post_body = opts[:debug_body]
|
|
3708
3946
|
|
|
3709
3947
|
# return_type
|
|
3710
|
-
return_type = opts[:debug_return_type] || '
|
|
3948
|
+
return_type = opts[:debug_return_type] || 'SfvbNotFoundResponse'
|
|
3711
3949
|
|
|
3712
3950
|
# auth_names
|
|
3713
3951
|
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
3714
3952
|
|
|
3715
3953
|
new_options = opts.merge(
|
|
3716
|
-
:operation => :"SfvbApi.
|
|
3954
|
+
:operation => :"SfvbApi.get_sfvb_not_found",
|
|
3717
3955
|
:header_params => header_params,
|
|
3718
3956
|
:query_params => query_params,
|
|
3719
3957
|
:form_params => form_params,
|
|
@@ -3724,46 +3962,48 @@ module UltracartClient
|
|
|
3724
3962
|
|
|
3725
3963
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
3726
3964
|
if @api_client.config.debugging
|
|
3727
|
-
@api_client.config.logger.debug "API called: SfvbApi#
|
|
3965
|
+
@api_client.config.logger.debug "API called: SfvbApi#get_sfvb_not_found\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
3728
3966
|
end
|
|
3729
3967
|
return data, status_code, headers
|
|
3730
3968
|
end
|
|
3731
3969
|
|
|
3732
|
-
# Read
|
|
3733
|
-
#
|
|
3970
|
+
# Read one 404 path with its recent hits
|
|
3971
|
+
# One entry with up to 100 recent hits, each with its time, the linking host, the user agent and whether it was a bot. Client IP addresses are never returned.
|
|
3734
3972
|
# @param storefront_oid [Integer]
|
|
3735
|
-
# @param
|
|
3973
|
+
# @param not_found_id [String]
|
|
3736
3974
|
# @param [Hash] opts the optional parameters
|
|
3737
|
-
# @
|
|
3738
|
-
|
|
3739
|
-
|
|
3975
|
+
# @option opts [Boolean] :include_tokens
|
|
3976
|
+
# @return [SfvbNotFoundEntryResponse]
|
|
3977
|
+
def get_sfvb_not_found_entry(storefront_oid, not_found_id, opts = {})
|
|
3978
|
+
data, _status_code, _headers = get_sfvb_not_found_entry_with_http_info(storefront_oid, not_found_id, opts)
|
|
3740
3979
|
data
|
|
3741
3980
|
end
|
|
3742
3981
|
|
|
3743
|
-
# Read
|
|
3744
|
-
#
|
|
3982
|
+
# Read one 404 path with its recent hits
|
|
3983
|
+
# One entry with up to 100 recent hits, each with its time, the linking host, the user agent and whether it was a bot. Client IP addresses are never returned.
|
|
3745
3984
|
# @param storefront_oid [Integer]
|
|
3746
|
-
# @param
|
|
3985
|
+
# @param not_found_id [String]
|
|
3747
3986
|
# @param [Hash] opts the optional parameters
|
|
3748
|
-
# @
|
|
3749
|
-
|
|
3987
|
+
# @option opts [Boolean] :include_tokens
|
|
3988
|
+
# @return [Array<(SfvbNotFoundEntryResponse, Integer, Hash)>] SfvbNotFoundEntryResponse data, response status code and response headers
|
|
3989
|
+
def get_sfvb_not_found_entry_with_http_info(storefront_oid, not_found_id, opts = {})
|
|
3750
3990
|
if @api_client.config.debugging
|
|
3751
|
-
@api_client.config.logger.debug 'Calling API: SfvbApi.
|
|
3991
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_not_found_entry ...'
|
|
3752
3992
|
end
|
|
3753
3993
|
# verify the required parameter 'storefront_oid' is set
|
|
3754
3994
|
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
3755
|
-
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.
|
|
3995
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_not_found_entry"
|
|
3756
3996
|
end
|
|
3757
|
-
# verify the required parameter '
|
|
3758
|
-
if @api_client.config.client_side_validation &&
|
|
3759
|
-
fail ArgumentError, "Missing the required parameter '
|
|
3997
|
+
# verify the required parameter 'not_found_id' is set
|
|
3998
|
+
if @api_client.config.client_side_validation && not_found_id.nil?
|
|
3999
|
+
fail ArgumentError, "Missing the required parameter 'not_found_id' when calling SfvbApi.get_sfvb_not_found_entry"
|
|
3760
4000
|
end
|
|
3761
4001
|
# resource path
|
|
3762
|
-
local_var_path = '/sfvb/storefronts/{storefront_oid}/
|
|
4002
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/not_found/{not_found_id}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'not_found_id' + '}', CGI.escape(not_found_id.to_s))
|
|
3763
4003
|
|
|
3764
4004
|
# query parameters
|
|
3765
4005
|
query_params = opts[:query_params] || {}
|
|
3766
|
-
query_params[:'
|
|
4006
|
+
query_params[:'include_tokens'] = opts[:'include_tokens'] if !opts[:'include_tokens'].nil?
|
|
3767
4007
|
|
|
3768
4008
|
# header parameters
|
|
3769
4009
|
header_params = opts[:header_params] || {}
|
|
@@ -3778,13 +4018,13 @@ module UltracartClient
|
|
|
3778
4018
|
post_body = opts[:debug_body]
|
|
3779
4019
|
|
|
3780
4020
|
# return_type
|
|
3781
|
-
return_type = opts[:debug_return_type] || '
|
|
4021
|
+
return_type = opts[:debug_return_type] || 'SfvbNotFoundEntryResponse'
|
|
3782
4022
|
|
|
3783
4023
|
# auth_names
|
|
3784
4024
|
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
3785
4025
|
|
|
3786
4026
|
new_options = opts.merge(
|
|
3787
|
-
:operation => :"SfvbApi.
|
|
4027
|
+
:operation => :"SfvbApi.get_sfvb_not_found_entry",
|
|
3788
4028
|
:header_params => header_params,
|
|
3789
4029
|
:query_params => query_params,
|
|
3790
4030
|
:form_params => form_params,
|
|
@@ -3795,46 +4035,39 @@ module UltracartClient
|
|
|
3795
4035
|
|
|
3796
4036
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
3797
4037
|
if @api_client.config.debugging
|
|
3798
|
-
@api_client.config.logger.debug "API called: SfvbApi#
|
|
4038
|
+
@api_client.config.logger.debug "API called: SfvbApi#get_sfvb_not_found_entry\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
3799
4039
|
end
|
|
3800
4040
|
return data, status_code, headers
|
|
3801
4041
|
end
|
|
3802
4042
|
|
|
3803
|
-
#
|
|
3804
|
-
# The
|
|
4043
|
+
# What renders the storefront's 404 page
|
|
4044
|
+
# The site_404.vm the active theme renders for a 404, found the way the storefront finds it, and whether it exists. Without it the storefront serves a plain fallback. Edit it with the file endpoints.
|
|
3805
4045
|
# @param storefront_oid [Integer]
|
|
3806
|
-
# @param path [String] Page path, for example /lp/spring-sale/
|
|
3807
4046
|
# @param [Hash] opts the optional parameters
|
|
3808
|
-
# @return [
|
|
3809
|
-
def
|
|
3810
|
-
data, _status_code, _headers =
|
|
4047
|
+
# @return [SfvbNotFoundPage]
|
|
4048
|
+
def get_sfvb_not_found_page(storefront_oid, opts = {})
|
|
4049
|
+
data, _status_code, _headers = get_sfvb_not_found_page_with_http_info(storefront_oid, opts)
|
|
3811
4050
|
data
|
|
3812
4051
|
end
|
|
3813
4052
|
|
|
3814
|
-
#
|
|
3815
|
-
# The
|
|
4053
|
+
# What renders the storefront's 404 page
|
|
4054
|
+
# The site_404.vm the active theme renders for a 404, found the way the storefront finds it, and whether it exists. Without it the storefront serves a plain fallback. Edit it with the file endpoints.
|
|
3816
4055
|
# @param storefront_oid [Integer]
|
|
3817
|
-
# @param path [String] Page path, for example /lp/spring-sale/
|
|
3818
4056
|
# @param [Hash] opts the optional parameters
|
|
3819
|
-
# @return [Array<(
|
|
3820
|
-
def
|
|
4057
|
+
# @return [Array<(SfvbNotFoundPage, Integer, Hash)>] SfvbNotFoundPage data, response status code and response headers
|
|
4058
|
+
def get_sfvb_not_found_page_with_http_info(storefront_oid, opts = {})
|
|
3821
4059
|
if @api_client.config.debugging
|
|
3822
|
-
@api_client.config.logger.debug 'Calling API: SfvbApi.
|
|
4060
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_not_found_page ...'
|
|
3823
4061
|
end
|
|
3824
4062
|
# verify the required parameter 'storefront_oid' is set
|
|
3825
4063
|
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
3826
|
-
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.
|
|
3827
|
-
end
|
|
3828
|
-
# verify the required parameter 'path' is set
|
|
3829
|
-
if @api_client.config.client_side_validation && path.nil?
|
|
3830
|
-
fail ArgumentError, "Missing the required parameter 'path' when calling SfvbApi.get_sfvb_page_items"
|
|
4064
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_not_found_page"
|
|
3831
4065
|
end
|
|
3832
4066
|
# resource path
|
|
3833
|
-
local_var_path = '/sfvb/storefronts/{storefront_oid}/
|
|
4067
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/not_found_page'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
|
|
3834
4068
|
|
|
3835
4069
|
# query parameters
|
|
3836
4070
|
query_params = opts[:query_params] || {}
|
|
3837
|
-
query_params[:'path'] = path
|
|
3838
4071
|
|
|
3839
4072
|
# header parameters
|
|
3840
4073
|
header_params = opts[:header_params] || {}
|
|
@@ -3849,13 +4082,13 @@ module UltracartClient
|
|
|
3849
4082
|
post_body = opts[:debug_body]
|
|
3850
4083
|
|
|
3851
4084
|
# return_type
|
|
3852
|
-
return_type = opts[:debug_return_type] || '
|
|
4085
|
+
return_type = opts[:debug_return_type] || 'SfvbNotFoundPage'
|
|
3853
4086
|
|
|
3854
4087
|
# auth_names
|
|
3855
4088
|
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
3856
4089
|
|
|
3857
4090
|
new_options = opts.merge(
|
|
3858
|
-
:operation => :"SfvbApi.
|
|
4091
|
+
:operation => :"SfvbApi.get_sfvb_not_found_page",
|
|
3859
4092
|
:header_params => header_params,
|
|
3860
4093
|
:query_params => query_params,
|
|
3861
4094
|
:form_params => form_params,
|
|
@@ -3866,26 +4099,239 @@ module UltracartClient
|
|
|
3866
4099
|
|
|
3867
4100
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
3868
4101
|
if @api_client.config.debugging
|
|
3869
|
-
@api_client.config.logger.debug "API called: SfvbApi#
|
|
4102
|
+
@api_client.config.logger.debug "API called: SfvbApi#get_sfvb_not_found_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
3870
4103
|
end
|
|
3871
4104
|
return data, status_code, headers
|
|
3872
4105
|
end
|
|
3873
4106
|
|
|
3874
|
-
# Read a page's
|
|
3875
|
-
#
|
|
4107
|
+
# Read a page's attributes and images
|
|
4108
|
+
# What the pageattribute and pageimage elements render for this page. These are not in any file, which is why a page folder can be empty and its elements still render something. Attributes and image codes a template declares but nothing has set are included, so the response describes what the page can show rather than only what has been saved.
|
|
3876
4109
|
# @param storefront_oid [Integer]
|
|
3877
|
-
# @param path [String] Page path, for example /
|
|
4110
|
+
# @param path [String] Page path, for example /catalog/dispensers/
|
|
3878
4111
|
# @param [Hash] opts the optional parameters
|
|
3879
|
-
# @return [
|
|
3880
|
-
def
|
|
3881
|
-
data, _status_code, _headers =
|
|
4112
|
+
# @return [SfvbPageResponse]
|
|
4113
|
+
def get_sfvb_page(storefront_oid, path, opts = {})
|
|
4114
|
+
data, _status_code, _headers = get_sfvb_page_with_http_info(storefront_oid, path, opts)
|
|
3882
4115
|
data
|
|
3883
4116
|
end
|
|
3884
4117
|
|
|
3885
|
-
# Read a page's
|
|
3886
|
-
#
|
|
4118
|
+
# Read a page's attributes and images
|
|
4119
|
+
# What the pageattribute and pageimage elements render for this page. These are not in any file, which is why a page folder can be empty and its elements still render something. Attributes and image codes a template declares but nothing has set are included, so the response describes what the page can show rather than only what has been saved.
|
|
3887
4120
|
# @param storefront_oid [Integer]
|
|
3888
|
-
# @param path [String] Page path, for example /
|
|
4121
|
+
# @param path [String] Page path, for example /catalog/dispensers/
|
|
4122
|
+
# @param [Hash] opts the optional parameters
|
|
4123
|
+
# @return [Array<(SfvbPageResponse, Integer, Hash)>] SfvbPageResponse data, response status code and response headers
|
|
4124
|
+
def get_sfvb_page_with_http_info(storefront_oid, path, opts = {})
|
|
4125
|
+
if @api_client.config.debugging
|
|
4126
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_page ...'
|
|
4127
|
+
end
|
|
4128
|
+
# verify the required parameter 'storefront_oid' is set
|
|
4129
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
4130
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_page"
|
|
4131
|
+
end
|
|
4132
|
+
# verify the required parameter 'path' is set
|
|
4133
|
+
if @api_client.config.client_side_validation && path.nil?
|
|
4134
|
+
fail ArgumentError, "Missing the required parameter 'path' when calling SfvbApi.get_sfvb_page"
|
|
4135
|
+
end
|
|
4136
|
+
# resource path
|
|
4137
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/pages'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
|
|
4138
|
+
|
|
4139
|
+
# query parameters
|
|
4140
|
+
query_params = opts[:query_params] || {}
|
|
4141
|
+
query_params[:'path'] = path
|
|
4142
|
+
|
|
4143
|
+
# header parameters
|
|
4144
|
+
header_params = opts[:header_params] || {}
|
|
4145
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
4146
|
+
# HTTP header 'Accept' (if needed)
|
|
4147
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
4148
|
+
|
|
4149
|
+
# form parameters
|
|
4150
|
+
form_params = opts[:form_params] || {}
|
|
4151
|
+
|
|
4152
|
+
# http body (model)
|
|
4153
|
+
post_body = opts[:debug_body]
|
|
4154
|
+
|
|
4155
|
+
# return_type
|
|
4156
|
+
return_type = opts[:debug_return_type] || 'SfvbPageResponse'
|
|
4157
|
+
|
|
4158
|
+
# auth_names
|
|
4159
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
4160
|
+
|
|
4161
|
+
new_options = opts.merge(
|
|
4162
|
+
:operation => :"SfvbApi.get_sfvb_page",
|
|
4163
|
+
:header_params => header_params,
|
|
4164
|
+
:query_params => query_params,
|
|
4165
|
+
:form_params => form_params,
|
|
4166
|
+
:body => post_body,
|
|
4167
|
+
:auth_names => auth_names,
|
|
4168
|
+
:return_type => return_type
|
|
4169
|
+
)
|
|
4170
|
+
|
|
4171
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
4172
|
+
if @api_client.config.debugging
|
|
4173
|
+
@api_client.config.logger.debug "API called: SfvbApi#get_sfvb_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
4174
|
+
end
|
|
4175
|
+
return data, status_code, headers
|
|
4176
|
+
end
|
|
4177
|
+
|
|
4178
|
+
# Read the blog posts assigned to a page
|
|
4179
|
+
# The posts the page shows. uses_selectors is true when the page's blog post selectors choose them instead.
|
|
4180
|
+
# @param storefront_oid [Integer]
|
|
4181
|
+
# @param path [String] Page path, for example /blog/
|
|
4182
|
+
# @param [Hash] opts the optional parameters
|
|
4183
|
+
# @return [SfvbPageBlogPostsResponse]
|
|
4184
|
+
def get_sfvb_page_blog_posts(storefront_oid, path, opts = {})
|
|
4185
|
+
data, _status_code, _headers = get_sfvb_page_blog_posts_with_http_info(storefront_oid, path, opts)
|
|
4186
|
+
data
|
|
4187
|
+
end
|
|
4188
|
+
|
|
4189
|
+
# Read the blog posts assigned to a page
|
|
4190
|
+
# The posts the page shows. uses_selectors is true when the page's blog post selectors choose them instead.
|
|
4191
|
+
# @param storefront_oid [Integer]
|
|
4192
|
+
# @param path [String] Page path, for example /blog/
|
|
4193
|
+
# @param [Hash] opts the optional parameters
|
|
4194
|
+
# @return [Array<(SfvbPageBlogPostsResponse, Integer, Hash)>] SfvbPageBlogPostsResponse data, response status code and response headers
|
|
4195
|
+
def get_sfvb_page_blog_posts_with_http_info(storefront_oid, path, opts = {})
|
|
4196
|
+
if @api_client.config.debugging
|
|
4197
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_page_blog_posts ...'
|
|
4198
|
+
end
|
|
4199
|
+
# verify the required parameter 'storefront_oid' is set
|
|
4200
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
4201
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_page_blog_posts"
|
|
4202
|
+
end
|
|
4203
|
+
# verify the required parameter 'path' is set
|
|
4204
|
+
if @api_client.config.client_side_validation && path.nil?
|
|
4205
|
+
fail ArgumentError, "Missing the required parameter 'path' when calling SfvbApi.get_sfvb_page_blog_posts"
|
|
4206
|
+
end
|
|
4207
|
+
# resource path
|
|
4208
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/pages/blog_posts'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
|
|
4209
|
+
|
|
4210
|
+
# query parameters
|
|
4211
|
+
query_params = opts[:query_params] || {}
|
|
4212
|
+
query_params[:'path'] = path
|
|
4213
|
+
|
|
4214
|
+
# header parameters
|
|
4215
|
+
header_params = opts[:header_params] || {}
|
|
4216
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
4217
|
+
# HTTP header 'Accept' (if needed)
|
|
4218
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
4219
|
+
|
|
4220
|
+
# form parameters
|
|
4221
|
+
form_params = opts[:form_params] || {}
|
|
4222
|
+
|
|
4223
|
+
# http body (model)
|
|
4224
|
+
post_body = opts[:debug_body]
|
|
4225
|
+
|
|
4226
|
+
# return_type
|
|
4227
|
+
return_type = opts[:debug_return_type] || 'SfvbPageBlogPostsResponse'
|
|
4228
|
+
|
|
4229
|
+
# auth_names
|
|
4230
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
4231
|
+
|
|
4232
|
+
new_options = opts.merge(
|
|
4233
|
+
:operation => :"SfvbApi.get_sfvb_page_blog_posts",
|
|
4234
|
+
:header_params => header_params,
|
|
4235
|
+
:query_params => query_params,
|
|
4236
|
+
:form_params => form_params,
|
|
4237
|
+
:body => post_body,
|
|
4238
|
+
:auth_names => auth_names,
|
|
4239
|
+
:return_type => return_type
|
|
4240
|
+
)
|
|
4241
|
+
|
|
4242
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
4243
|
+
if @api_client.config.debugging
|
|
4244
|
+
@api_client.config.logger.debug "API called: SfvbApi#get_sfvb_page_blog_posts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
4245
|
+
end
|
|
4246
|
+
return data, status_code, headers
|
|
4247
|
+
end
|
|
4248
|
+
|
|
4249
|
+
# Read the items assigned to a page
|
|
4250
|
+
# The items on the page with their sort order and url part. uses_selectors is true when the page's selectors choose its items instead.
|
|
4251
|
+
# @param storefront_oid [Integer]
|
|
4252
|
+
# @param path [String] Page path, for example /lp/spring-sale/
|
|
4253
|
+
# @param [Hash] opts the optional parameters
|
|
4254
|
+
# @return [SfvbPageItemsResponse]
|
|
4255
|
+
def get_sfvb_page_items(storefront_oid, path, opts = {})
|
|
4256
|
+
data, _status_code, _headers = get_sfvb_page_items_with_http_info(storefront_oid, path, opts)
|
|
4257
|
+
data
|
|
4258
|
+
end
|
|
4259
|
+
|
|
4260
|
+
# Read the items assigned to a page
|
|
4261
|
+
# The items on the page with their sort order and url part. uses_selectors is true when the page's selectors choose its items instead.
|
|
4262
|
+
# @param storefront_oid [Integer]
|
|
4263
|
+
# @param path [String] Page path, for example /lp/spring-sale/
|
|
4264
|
+
# @param [Hash] opts the optional parameters
|
|
4265
|
+
# @return [Array<(SfvbPageItemsResponse, Integer, Hash)>] SfvbPageItemsResponse data, response status code and response headers
|
|
4266
|
+
def get_sfvb_page_items_with_http_info(storefront_oid, path, opts = {})
|
|
4267
|
+
if @api_client.config.debugging
|
|
4268
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_page_items ...'
|
|
4269
|
+
end
|
|
4270
|
+
# verify the required parameter 'storefront_oid' is set
|
|
4271
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
4272
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_page_items"
|
|
4273
|
+
end
|
|
4274
|
+
# verify the required parameter 'path' is set
|
|
4275
|
+
if @api_client.config.client_side_validation && path.nil?
|
|
4276
|
+
fail ArgumentError, "Missing the required parameter 'path' when calling SfvbApi.get_sfvb_page_items"
|
|
4277
|
+
end
|
|
4278
|
+
# resource path
|
|
4279
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/pages/items'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
|
|
4280
|
+
|
|
4281
|
+
# query parameters
|
|
4282
|
+
query_params = opts[:query_params] || {}
|
|
4283
|
+
query_params[:'path'] = path
|
|
4284
|
+
|
|
4285
|
+
# header parameters
|
|
4286
|
+
header_params = opts[:header_params] || {}
|
|
4287
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
4288
|
+
# HTTP header 'Accept' (if needed)
|
|
4289
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
4290
|
+
|
|
4291
|
+
# form parameters
|
|
4292
|
+
form_params = opts[:form_params] || {}
|
|
4293
|
+
|
|
4294
|
+
# http body (model)
|
|
4295
|
+
post_body = opts[:debug_body]
|
|
4296
|
+
|
|
4297
|
+
# return_type
|
|
4298
|
+
return_type = opts[:debug_return_type] || 'SfvbPageItemsResponse'
|
|
4299
|
+
|
|
4300
|
+
# auth_names
|
|
4301
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
4302
|
+
|
|
4303
|
+
new_options = opts.merge(
|
|
4304
|
+
:operation => :"SfvbApi.get_sfvb_page_items",
|
|
4305
|
+
:header_params => header_params,
|
|
4306
|
+
:query_params => query_params,
|
|
4307
|
+
:form_params => form_params,
|
|
4308
|
+
:body => post_body,
|
|
4309
|
+
:auth_names => auth_names,
|
|
4310
|
+
:return_type => return_type
|
|
4311
|
+
)
|
|
4312
|
+
|
|
4313
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
4314
|
+
if @api_client.config.debugging
|
|
4315
|
+
@api_client.config.logger.debug "API called: SfvbApi#get_sfvb_page_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
4316
|
+
end
|
|
4317
|
+
return data, status_code, headers
|
|
4318
|
+
end
|
|
4319
|
+
|
|
4320
|
+
# Read a page's selectors
|
|
4321
|
+
# The conditions that choose the page's items and blog posts, and whether each set must all match.
|
|
4322
|
+
# @param storefront_oid [Integer]
|
|
4323
|
+
# @param path [String] Page path, for example /lp/spring-sale/
|
|
4324
|
+
# @param [Hash] opts the optional parameters
|
|
4325
|
+
# @return [SfvbPageSelectors]
|
|
4326
|
+
def get_sfvb_page_selectors(storefront_oid, path, opts = {})
|
|
4327
|
+
data, _status_code, _headers = get_sfvb_page_selectors_with_http_info(storefront_oid, path, opts)
|
|
4328
|
+
data
|
|
4329
|
+
end
|
|
4330
|
+
|
|
4331
|
+
# Read a page's selectors
|
|
4332
|
+
# The conditions that choose the page's items and blog posts, and whether each set must all match.
|
|
4333
|
+
# @param storefront_oid [Integer]
|
|
4334
|
+
# @param path [String] Page path, for example /lp/spring-sale/
|
|
3889
4335
|
# @param [Hash] opts the optional parameters
|
|
3890
4336
|
# @return [Array<(SfvbPageSelectors, Integer, Hash)>] SfvbPageSelectors data, response status code and response headers
|
|
3891
4337
|
def get_sfvb_page_selectors_with_http_info(storefront_oid, path, opts = {})
|
|
@@ -4225,6 +4671,149 @@ module UltracartClient
|
|
|
4225
4671
|
return data, status_code, headers
|
|
4226
4672
|
end
|
|
4227
4673
|
|
|
4674
|
+
# Read one redirect rule
|
|
4675
|
+
# One rule, with the hash_sha256 to send as If-Match when updating or deleting it.
|
|
4676
|
+
# @param storefront_oid [Integer]
|
|
4677
|
+
# @param redirect_id [Integer]
|
|
4678
|
+
# @param [Hash] opts the optional parameters
|
|
4679
|
+
# @return [SfvbRedirect]
|
|
4680
|
+
def get_sfvb_redirect(storefront_oid, redirect_id, opts = {})
|
|
4681
|
+
data, _status_code, _headers = get_sfvb_redirect_with_http_info(storefront_oid, redirect_id, opts)
|
|
4682
|
+
data
|
|
4683
|
+
end
|
|
4684
|
+
|
|
4685
|
+
# Read one redirect rule
|
|
4686
|
+
# One rule, with the hash_sha256 to send as If-Match when updating or deleting it.
|
|
4687
|
+
# @param storefront_oid [Integer]
|
|
4688
|
+
# @param redirect_id [Integer]
|
|
4689
|
+
# @param [Hash] opts the optional parameters
|
|
4690
|
+
# @return [Array<(SfvbRedirect, Integer, Hash)>] SfvbRedirect data, response status code and response headers
|
|
4691
|
+
def get_sfvb_redirect_with_http_info(storefront_oid, redirect_id, opts = {})
|
|
4692
|
+
if @api_client.config.debugging
|
|
4693
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_redirect ...'
|
|
4694
|
+
end
|
|
4695
|
+
# verify the required parameter 'storefront_oid' is set
|
|
4696
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
4697
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_redirect"
|
|
4698
|
+
end
|
|
4699
|
+
# verify the required parameter 'redirect_id' is set
|
|
4700
|
+
if @api_client.config.client_side_validation && redirect_id.nil?
|
|
4701
|
+
fail ArgumentError, "Missing the required parameter 'redirect_id' when calling SfvbApi.get_sfvb_redirect"
|
|
4702
|
+
end
|
|
4703
|
+
# resource path
|
|
4704
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/redirects/{redirect_id}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'redirect_id' + '}', CGI.escape(redirect_id.to_s))
|
|
4705
|
+
|
|
4706
|
+
# query parameters
|
|
4707
|
+
query_params = opts[:query_params] || {}
|
|
4708
|
+
|
|
4709
|
+
# header parameters
|
|
4710
|
+
header_params = opts[:header_params] || {}
|
|
4711
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
4712
|
+
# HTTP header 'Accept' (if needed)
|
|
4713
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
4714
|
+
|
|
4715
|
+
# form parameters
|
|
4716
|
+
form_params = opts[:form_params] || {}
|
|
4717
|
+
|
|
4718
|
+
# http body (model)
|
|
4719
|
+
post_body = opts[:debug_body]
|
|
4720
|
+
|
|
4721
|
+
# return_type
|
|
4722
|
+
return_type = opts[:debug_return_type] || 'SfvbRedirect'
|
|
4723
|
+
|
|
4724
|
+
# auth_names
|
|
4725
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
4726
|
+
|
|
4727
|
+
new_options = opts.merge(
|
|
4728
|
+
:operation => :"SfvbApi.get_sfvb_redirect",
|
|
4729
|
+
:header_params => header_params,
|
|
4730
|
+
:query_params => query_params,
|
|
4731
|
+
:form_params => form_params,
|
|
4732
|
+
:body => post_body,
|
|
4733
|
+
:auth_names => auth_names,
|
|
4734
|
+
:return_type => return_type
|
|
4735
|
+
)
|
|
4736
|
+
|
|
4737
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
4738
|
+
if @api_client.config.debugging
|
|
4739
|
+
@api_client.config.logger.debug "API called: SfvbApi#get_sfvb_redirect\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
4740
|
+
end
|
|
4741
|
+
return data, status_code, headers
|
|
4742
|
+
end
|
|
4743
|
+
|
|
4744
|
+
# List the storefront's redirect rules
|
|
4745
|
+
# Every redirect rule, exact and pattern. Filter with q (searches source, target and note), type (exact or pattern) and status (301, 302 or rewrite). count and limit say how close the storefront is to its rule limit.
|
|
4746
|
+
# @param storefront_oid [Integer]
|
|
4747
|
+
# @param [Hash] opts the optional parameters
|
|
4748
|
+
# @option opts [String] :q
|
|
4749
|
+
# @option opts [String] :type
|
|
4750
|
+
# @option opts [String] :status
|
|
4751
|
+
# @return [SfvbRedirectsResponse]
|
|
4752
|
+
def get_sfvb_redirects(storefront_oid, opts = {})
|
|
4753
|
+
data, _status_code, _headers = get_sfvb_redirects_with_http_info(storefront_oid, opts)
|
|
4754
|
+
data
|
|
4755
|
+
end
|
|
4756
|
+
|
|
4757
|
+
# List the storefront's redirect rules
|
|
4758
|
+
# Every redirect rule, exact and pattern. Filter with q (searches source, target and note), type (exact or pattern) and status (301, 302 or rewrite). count and limit say how close the storefront is to its rule limit.
|
|
4759
|
+
# @param storefront_oid [Integer]
|
|
4760
|
+
# @param [Hash] opts the optional parameters
|
|
4761
|
+
# @option opts [String] :q
|
|
4762
|
+
# @option opts [String] :type
|
|
4763
|
+
# @option opts [String] :status
|
|
4764
|
+
# @return [Array<(SfvbRedirectsResponse, Integer, Hash)>] SfvbRedirectsResponse data, response status code and response headers
|
|
4765
|
+
def get_sfvb_redirects_with_http_info(storefront_oid, opts = {})
|
|
4766
|
+
if @api_client.config.debugging
|
|
4767
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_redirects ...'
|
|
4768
|
+
end
|
|
4769
|
+
# verify the required parameter 'storefront_oid' is set
|
|
4770
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
4771
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_redirects"
|
|
4772
|
+
end
|
|
4773
|
+
# resource path
|
|
4774
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/redirects'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
|
|
4775
|
+
|
|
4776
|
+
# query parameters
|
|
4777
|
+
query_params = opts[:query_params] || {}
|
|
4778
|
+
query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
|
|
4779
|
+
query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
|
|
4780
|
+
query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
|
|
4781
|
+
|
|
4782
|
+
# header parameters
|
|
4783
|
+
header_params = opts[:header_params] || {}
|
|
4784
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
4785
|
+
# HTTP header 'Accept' (if needed)
|
|
4786
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
4787
|
+
|
|
4788
|
+
# form parameters
|
|
4789
|
+
form_params = opts[:form_params] || {}
|
|
4790
|
+
|
|
4791
|
+
# http body (model)
|
|
4792
|
+
post_body = opts[:debug_body]
|
|
4793
|
+
|
|
4794
|
+
# return_type
|
|
4795
|
+
return_type = opts[:debug_return_type] || 'SfvbRedirectsResponse'
|
|
4796
|
+
|
|
4797
|
+
# auth_names
|
|
4798
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
4799
|
+
|
|
4800
|
+
new_options = opts.merge(
|
|
4801
|
+
:operation => :"SfvbApi.get_sfvb_redirects",
|
|
4802
|
+
:header_params => header_params,
|
|
4803
|
+
:query_params => query_params,
|
|
4804
|
+
:form_params => form_params,
|
|
4805
|
+
:body => post_body,
|
|
4806
|
+
:auth_names => auth_names,
|
|
4807
|
+
:return_type => return_type
|
|
4808
|
+
)
|
|
4809
|
+
|
|
4810
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
4811
|
+
if @api_client.config.debugging
|
|
4812
|
+
@api_client.config.logger.debug "API called: SfvbApi#get_sfvb_redirects\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
4813
|
+
end
|
|
4814
|
+
return data, status_code, headers
|
|
4815
|
+
end
|
|
4816
|
+
|
|
4228
4817
|
# Get one storefront render log
|
|
4229
4818
|
# One render's server log with its lines, each with a level, a category such as VELOCITY or FLOW, and the message. log_id comes from the list, or from the X-UltraCart-Storefront-Log-Id header a page sends inside an SFVB preview session. min_level is debug, info, warn or error, default debug.
|
|
4230
4819
|
# @param storefront_oid [Integer]
|
|
@@ -4746,13 +5335,141 @@ module UltracartClient
|
|
|
4746
5335
|
# Compiler version for this merchant
|
|
4747
5336
|
# The visual builder release channel is per merchant, so a CLI holding cached schema or element data should compare against this to know when it has gone stale.
|
|
4748
5337
|
# @param [Hash] opts the optional parameters
|
|
4749
|
-
# @return [Array<(SfvbVersionResponse, Integer, Hash)>] SfvbVersionResponse data, response status code and response headers
|
|
4750
|
-
def get_sfvb_version_with_http_info(opts = {})
|
|
5338
|
+
# @return [Array<(SfvbVersionResponse, Integer, Hash)>] SfvbVersionResponse data, response status code and response headers
|
|
5339
|
+
def get_sfvb_version_with_http_info(opts = {})
|
|
5340
|
+
if @api_client.config.debugging
|
|
5341
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_version ...'
|
|
5342
|
+
end
|
|
5343
|
+
# resource path
|
|
5344
|
+
local_var_path = '/sfvb/version'
|
|
5345
|
+
|
|
5346
|
+
# query parameters
|
|
5347
|
+
query_params = opts[:query_params] || {}
|
|
5348
|
+
|
|
5349
|
+
# header parameters
|
|
5350
|
+
header_params = opts[:header_params] || {}
|
|
5351
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
5352
|
+
# HTTP header 'Accept' (if needed)
|
|
5353
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
5354
|
+
|
|
5355
|
+
# form parameters
|
|
5356
|
+
form_params = opts[:form_params] || {}
|
|
5357
|
+
|
|
5358
|
+
# http body (model)
|
|
5359
|
+
post_body = opts[:debug_body]
|
|
5360
|
+
|
|
5361
|
+
# return_type
|
|
5362
|
+
return_type = opts[:debug_return_type] || 'SfvbVersionResponse'
|
|
5363
|
+
|
|
5364
|
+
# auth_names
|
|
5365
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
5366
|
+
|
|
5367
|
+
new_options = opts.merge(
|
|
5368
|
+
:operation => :"SfvbApi.get_sfvb_version",
|
|
5369
|
+
:header_params => header_params,
|
|
5370
|
+
:query_params => query_params,
|
|
5371
|
+
:form_params => form_params,
|
|
5372
|
+
:body => post_body,
|
|
5373
|
+
:auth_names => auth_names,
|
|
5374
|
+
:return_type => return_type
|
|
5375
|
+
)
|
|
5376
|
+
|
|
5377
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
5378
|
+
if @api_client.config.debugging
|
|
5379
|
+
@api_client.config.logger.debug "API called: SfvbApi#get_sfvb_version\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
5380
|
+
end
|
|
5381
|
+
return data, status_code, headers
|
|
5382
|
+
end
|
|
5383
|
+
|
|
5384
|
+
# Who this token is
|
|
5385
|
+
# Returns the merchant, user, granted scopes and reachable storefronts for the calling token. Declared for any scope so an application can always discover which account it is connected to.
|
|
5386
|
+
# @param [Hash] opts the optional parameters
|
|
5387
|
+
# @return [SfvbWhoamiResponse]
|
|
5388
|
+
def get_sfvb_whoami(opts = {})
|
|
5389
|
+
data, _status_code, _headers = get_sfvb_whoami_with_http_info(opts)
|
|
5390
|
+
data
|
|
5391
|
+
end
|
|
5392
|
+
|
|
5393
|
+
# Who this token is
|
|
5394
|
+
# Returns the merchant, user, granted scopes and reachable storefronts for the calling token. Declared for any scope so an application can always discover which account it is connected to.
|
|
5395
|
+
# @param [Hash] opts the optional parameters
|
|
5396
|
+
# @return [Array<(SfvbWhoamiResponse, Integer, Hash)>] SfvbWhoamiResponse data, response status code and response headers
|
|
5397
|
+
def get_sfvb_whoami_with_http_info(opts = {})
|
|
5398
|
+
if @api_client.config.debugging
|
|
5399
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_whoami ...'
|
|
5400
|
+
end
|
|
5401
|
+
# resource path
|
|
5402
|
+
local_var_path = '/sfvb/whoami'
|
|
5403
|
+
|
|
5404
|
+
# query parameters
|
|
5405
|
+
query_params = opts[:query_params] || {}
|
|
5406
|
+
|
|
5407
|
+
# header parameters
|
|
5408
|
+
header_params = opts[:header_params] || {}
|
|
5409
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
5410
|
+
# HTTP header 'Accept' (if needed)
|
|
5411
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
5412
|
+
|
|
5413
|
+
# form parameters
|
|
5414
|
+
form_params = opts[:form_params] || {}
|
|
5415
|
+
|
|
5416
|
+
# http body (model)
|
|
5417
|
+
post_body = opts[:debug_body]
|
|
5418
|
+
|
|
5419
|
+
# return_type
|
|
5420
|
+
return_type = opts[:debug_return_type] || 'SfvbWhoamiResponse'
|
|
5421
|
+
|
|
5422
|
+
# auth_names
|
|
5423
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
5424
|
+
|
|
5425
|
+
new_options = opts.merge(
|
|
5426
|
+
:operation => :"SfvbApi.get_sfvb_whoami",
|
|
5427
|
+
:header_params => header_params,
|
|
5428
|
+
:query_params => query_params,
|
|
5429
|
+
:form_params => form_params,
|
|
5430
|
+
:body => post_body,
|
|
5431
|
+
:auth_names => auth_names,
|
|
5432
|
+
:return_type => return_type
|
|
5433
|
+
)
|
|
5434
|
+
|
|
5435
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
5436
|
+
if @api_client.config.debugging
|
|
5437
|
+
@api_client.config.logger.debug "API called: SfvbApi#get_sfvb_whoami\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
5438
|
+
end
|
|
5439
|
+
return data, status_code, headers
|
|
5440
|
+
end
|
|
5441
|
+
|
|
5442
|
+
# Ignore a 404 path
|
|
5443
|
+
# Hides one path from the list and stops counting its hits, for example scanner noise. Reversible.
|
|
5444
|
+
# @param storefront_oid [Integer]
|
|
5445
|
+
# @param not_found_id [String]
|
|
5446
|
+
# @param [Hash] opts the optional parameters
|
|
5447
|
+
# @return [SfvbNotFoundEntry]
|
|
5448
|
+
def ignore_sfvb_not_found_entry(storefront_oid, not_found_id, opts = {})
|
|
5449
|
+
data, _status_code, _headers = ignore_sfvb_not_found_entry_with_http_info(storefront_oid, not_found_id, opts)
|
|
5450
|
+
data
|
|
5451
|
+
end
|
|
5452
|
+
|
|
5453
|
+
# Ignore a 404 path
|
|
5454
|
+
# Hides one path from the list and stops counting its hits, for example scanner noise. Reversible.
|
|
5455
|
+
# @param storefront_oid [Integer]
|
|
5456
|
+
# @param not_found_id [String]
|
|
5457
|
+
# @param [Hash] opts the optional parameters
|
|
5458
|
+
# @return [Array<(SfvbNotFoundEntry, Integer, Hash)>] SfvbNotFoundEntry data, response status code and response headers
|
|
5459
|
+
def ignore_sfvb_not_found_entry_with_http_info(storefront_oid, not_found_id, opts = {})
|
|
4751
5460
|
if @api_client.config.debugging
|
|
4752
|
-
@api_client.config.logger.debug 'Calling API: SfvbApi.
|
|
5461
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.ignore_sfvb_not_found_entry ...'
|
|
5462
|
+
end
|
|
5463
|
+
# verify the required parameter 'storefront_oid' is set
|
|
5464
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
5465
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.ignore_sfvb_not_found_entry"
|
|
5466
|
+
end
|
|
5467
|
+
# verify the required parameter 'not_found_id' is set
|
|
5468
|
+
if @api_client.config.client_side_validation && not_found_id.nil?
|
|
5469
|
+
fail ArgumentError, "Missing the required parameter 'not_found_id' when calling SfvbApi.ignore_sfvb_not_found_entry"
|
|
4753
5470
|
end
|
|
4754
5471
|
# resource path
|
|
4755
|
-
local_var_path = '/sfvb/
|
|
5472
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/not_found/{not_found_id}/ignore'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'not_found_id' + '}', CGI.escape(not_found_id.to_s))
|
|
4756
5473
|
|
|
4757
5474
|
# query parameters
|
|
4758
5475
|
query_params = opts[:query_params] || {}
|
|
@@ -4770,13 +5487,13 @@ module UltracartClient
|
|
|
4770
5487
|
post_body = opts[:debug_body]
|
|
4771
5488
|
|
|
4772
5489
|
# return_type
|
|
4773
|
-
return_type = opts[:debug_return_type] || '
|
|
5490
|
+
return_type = opts[:debug_return_type] || 'SfvbNotFoundEntry'
|
|
4774
5491
|
|
|
4775
5492
|
# auth_names
|
|
4776
5493
|
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
4777
5494
|
|
|
4778
5495
|
new_options = opts.merge(
|
|
4779
|
-
:operation => :"SfvbApi.
|
|
5496
|
+
:operation => :"SfvbApi.ignore_sfvb_not_found_entry",
|
|
4780
5497
|
:header_params => header_params,
|
|
4781
5498
|
:query_params => query_params,
|
|
4782
5499
|
:form_params => form_params,
|
|
@@ -4785,32 +5502,44 @@ module UltracartClient
|
|
|
4785
5502
|
:return_type => return_type
|
|
4786
5503
|
)
|
|
4787
5504
|
|
|
4788
|
-
data, status_code, headers = @api_client.call_api(:
|
|
5505
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
4789
5506
|
if @api_client.config.debugging
|
|
4790
|
-
@api_client.config.logger.debug "API called: SfvbApi#
|
|
5507
|
+
@api_client.config.logger.debug "API called: SfvbApi#ignore_sfvb_not_found_entry\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
4791
5508
|
end
|
|
4792
5509
|
return data, status_code, headers
|
|
4793
5510
|
end
|
|
4794
5511
|
|
|
4795
|
-
#
|
|
4796
|
-
#
|
|
5512
|
+
# Apply a reviewed redirect import
|
|
5513
|
+
# Applies exactly the rows of a dry run, given its plan_hash, in one transaction. Refused with 412 when the rows or the storefront's rules changed since the dry run, and refused when any row has a blocking finding. Always needs sfvb_publish.
|
|
5514
|
+
# @param storefront_oid [Integer]
|
|
5515
|
+
# @param redirect_import_request [SfvbRedirectImportRequest] The request
|
|
4797
5516
|
# @param [Hash] opts the optional parameters
|
|
4798
|
-
# @return [
|
|
4799
|
-
def
|
|
4800
|
-
data, _status_code, _headers =
|
|
5517
|
+
# @return [SfvbRedirectImportResponse]
|
|
5518
|
+
def import_sfvb_redirects(storefront_oid, redirect_import_request, opts = {})
|
|
5519
|
+
data, _status_code, _headers = import_sfvb_redirects_with_http_info(storefront_oid, redirect_import_request, opts)
|
|
4801
5520
|
data
|
|
4802
5521
|
end
|
|
4803
5522
|
|
|
4804
|
-
#
|
|
4805
|
-
#
|
|
5523
|
+
# Apply a reviewed redirect import
|
|
5524
|
+
# Applies exactly the rows of a dry run, given its plan_hash, in one transaction. Refused with 412 when the rows or the storefront's rules changed since the dry run, and refused when any row has a blocking finding. Always needs sfvb_publish.
|
|
5525
|
+
# @param storefront_oid [Integer]
|
|
5526
|
+
# @param redirect_import_request [SfvbRedirectImportRequest] The request
|
|
4806
5527
|
# @param [Hash] opts the optional parameters
|
|
4807
|
-
# @return [Array<(
|
|
4808
|
-
def
|
|
5528
|
+
# @return [Array<(SfvbRedirectImportResponse, Integer, Hash)>] SfvbRedirectImportResponse data, response status code and response headers
|
|
5529
|
+
def import_sfvb_redirects_with_http_info(storefront_oid, redirect_import_request, opts = {})
|
|
4809
5530
|
if @api_client.config.debugging
|
|
4810
|
-
@api_client.config.logger.debug 'Calling API: SfvbApi.
|
|
5531
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.import_sfvb_redirects ...'
|
|
5532
|
+
end
|
|
5533
|
+
# verify the required parameter 'storefront_oid' is set
|
|
5534
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
5535
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.import_sfvb_redirects"
|
|
5536
|
+
end
|
|
5537
|
+
# verify the required parameter 'redirect_import_request' is set
|
|
5538
|
+
if @api_client.config.client_side_validation && redirect_import_request.nil?
|
|
5539
|
+
fail ArgumentError, "Missing the required parameter 'redirect_import_request' when calling SfvbApi.import_sfvb_redirects"
|
|
4811
5540
|
end
|
|
4812
5541
|
# resource path
|
|
4813
|
-
local_var_path = '/sfvb/
|
|
5542
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/redirects/import'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
|
|
4814
5543
|
|
|
4815
5544
|
# query parameters
|
|
4816
5545
|
query_params = opts[:query_params] || {}
|
|
@@ -4820,21 +5549,26 @@ module UltracartClient
|
|
|
4820
5549
|
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
4821
5550
|
# HTTP header 'Accept' (if needed)
|
|
4822
5551
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
5552
|
+
# HTTP header 'Content-Type'
|
|
5553
|
+
content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
|
|
5554
|
+
if !content_type.nil?
|
|
5555
|
+
header_params['Content-Type'] = content_type
|
|
5556
|
+
end
|
|
4823
5557
|
|
|
4824
5558
|
# form parameters
|
|
4825
5559
|
form_params = opts[:form_params] || {}
|
|
4826
5560
|
|
|
4827
5561
|
# http body (model)
|
|
4828
|
-
post_body = opts[:debug_body]
|
|
5562
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(redirect_import_request)
|
|
4829
5563
|
|
|
4830
5564
|
# return_type
|
|
4831
|
-
return_type = opts[:debug_return_type] || '
|
|
5565
|
+
return_type = opts[:debug_return_type] || 'SfvbRedirectImportResponse'
|
|
4832
5566
|
|
|
4833
5567
|
# auth_names
|
|
4834
5568
|
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
4835
5569
|
|
|
4836
5570
|
new_options = opts.merge(
|
|
4837
|
-
:operation => :"SfvbApi.
|
|
5571
|
+
:operation => :"SfvbApi.import_sfvb_redirects",
|
|
4838
5572
|
:header_params => header_params,
|
|
4839
5573
|
:query_params => query_params,
|
|
4840
5574
|
:form_params => form_params,
|
|
@@ -4843,9 +5577,9 @@ module UltracartClient
|
|
|
4843
5577
|
:return_type => return_type
|
|
4844
5578
|
)
|
|
4845
5579
|
|
|
4846
|
-
data, status_code, headers = @api_client.call_api(:
|
|
5580
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
4847
5581
|
if @api_client.config.debugging
|
|
4848
|
-
@api_client.config.logger.debug "API called: SfvbApi#
|
|
5582
|
+
@api_client.config.logger.debug "API called: SfvbApi#import_sfvb_redirects\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
4849
5583
|
end
|
|
4850
5584
|
return data, status_code, headers
|
|
4851
5585
|
end
|
|
@@ -5000,6 +5734,81 @@ module UltracartClient
|
|
|
5000
5734
|
return data, status_code, headers
|
|
5001
5735
|
end
|
|
5002
5736
|
|
|
5737
|
+
# Create a 301 redirect rule
|
|
5738
|
+
# Creates one permanent (301) redirect, live for shoppers at once. Refused for a loop, a chain longer than the storefront follows, a duplicate source, a target that is missing or on another site, a system path, a live page (unless over_live_page) and a full storefront. A chain is allowed with a warning naming the final target. Always needs sfvb_publish.
|
|
5739
|
+
# @param storefront_oid [Integer]
|
|
5740
|
+
# @param redirect_request [SfvbRedirectRequest] The request
|
|
5741
|
+
# @param [Hash] opts the optional parameters
|
|
5742
|
+
# @return [SfvbRedirectResponse]
|
|
5743
|
+
def insert_sfvb_redirect(storefront_oid, redirect_request, opts = {})
|
|
5744
|
+
data, _status_code, _headers = insert_sfvb_redirect_with_http_info(storefront_oid, redirect_request, opts)
|
|
5745
|
+
data
|
|
5746
|
+
end
|
|
5747
|
+
|
|
5748
|
+
# Create a 301 redirect rule
|
|
5749
|
+
# Creates one permanent (301) redirect, live for shoppers at once. Refused for a loop, a chain longer than the storefront follows, a duplicate source, a target that is missing or on another site, a system path, a live page (unless over_live_page) and a full storefront. A chain is allowed with a warning naming the final target. Always needs sfvb_publish.
|
|
5750
|
+
# @param storefront_oid [Integer]
|
|
5751
|
+
# @param redirect_request [SfvbRedirectRequest] The request
|
|
5752
|
+
# @param [Hash] opts the optional parameters
|
|
5753
|
+
# @return [Array<(SfvbRedirectResponse, Integer, Hash)>] SfvbRedirectResponse data, response status code and response headers
|
|
5754
|
+
def insert_sfvb_redirect_with_http_info(storefront_oid, redirect_request, opts = {})
|
|
5755
|
+
if @api_client.config.debugging
|
|
5756
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.insert_sfvb_redirect ...'
|
|
5757
|
+
end
|
|
5758
|
+
# verify the required parameter 'storefront_oid' is set
|
|
5759
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
5760
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.insert_sfvb_redirect"
|
|
5761
|
+
end
|
|
5762
|
+
# verify the required parameter 'redirect_request' is set
|
|
5763
|
+
if @api_client.config.client_side_validation && redirect_request.nil?
|
|
5764
|
+
fail ArgumentError, "Missing the required parameter 'redirect_request' when calling SfvbApi.insert_sfvb_redirect"
|
|
5765
|
+
end
|
|
5766
|
+
# resource path
|
|
5767
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/redirects'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
|
|
5768
|
+
|
|
5769
|
+
# query parameters
|
|
5770
|
+
query_params = opts[:query_params] || {}
|
|
5771
|
+
|
|
5772
|
+
# header parameters
|
|
5773
|
+
header_params = opts[:header_params] || {}
|
|
5774
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
5775
|
+
# HTTP header 'Accept' (if needed)
|
|
5776
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
5777
|
+
# HTTP header 'Content-Type'
|
|
5778
|
+
content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
|
|
5779
|
+
if !content_type.nil?
|
|
5780
|
+
header_params['Content-Type'] = content_type
|
|
5781
|
+
end
|
|
5782
|
+
|
|
5783
|
+
# form parameters
|
|
5784
|
+
form_params = opts[:form_params] || {}
|
|
5785
|
+
|
|
5786
|
+
# http body (model)
|
|
5787
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(redirect_request)
|
|
5788
|
+
|
|
5789
|
+
# return_type
|
|
5790
|
+
return_type = opts[:debug_return_type] || 'SfvbRedirectResponse'
|
|
5791
|
+
|
|
5792
|
+
# auth_names
|
|
5793
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
5794
|
+
|
|
5795
|
+
new_options = opts.merge(
|
|
5796
|
+
:operation => :"SfvbApi.insert_sfvb_redirect",
|
|
5797
|
+
:header_params => header_params,
|
|
5798
|
+
:query_params => query_params,
|
|
5799
|
+
:form_params => form_params,
|
|
5800
|
+
:body => post_body,
|
|
5801
|
+
:auth_names => auth_names,
|
|
5802
|
+
:return_type => return_type
|
|
5803
|
+
)
|
|
5804
|
+
|
|
5805
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
5806
|
+
if @api_client.config.debugging
|
|
5807
|
+
@api_client.config.logger.debug "API called: SfvbApi#insert_sfvb_redirect\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
5808
|
+
end
|
|
5809
|
+
return data, status_code, headers
|
|
5810
|
+
end
|
|
5811
|
+
|
|
5003
5812
|
# Create an upsell offer
|
|
5004
5813
|
# Every item it names must exist, and every shipping method, payment method and loyalty tier must be one the merchant has. Put it on a path with a path update to have it shown. Creating it switched on, or with upsell_item_id_javascript or offsite_content_url, needs sfvb_publish. Its page content is its container, written with the container endpoints and owner type upsell.
|
|
5005
5814
|
# @param storefront_oid [Integer]
|
|
@@ -8494,6 +9303,73 @@ module UltracartClient
|
|
|
8494
9303
|
return data, status_code, headers
|
|
8495
9304
|
end
|
|
8496
9305
|
|
|
9306
|
+
# What a shopper gets for a path
|
|
9307
|
+
# Follows the redirect rules for a path exactly as the storefront does and reports each step, the final path, its status and what it lands on (a live page, a hidden page, an item, a 404 or something else). Read only. Use it to check every change.
|
|
9308
|
+
# @param storefront_oid [Integer]
|
|
9309
|
+
# @param [Hash] opts the optional parameters
|
|
9310
|
+
# @option opts [String] :path
|
|
9311
|
+
# @return [SfvbRedirectResolveResponse]
|
|
9312
|
+
def resolve_sfvb_redirect(storefront_oid, opts = {})
|
|
9313
|
+
data, _status_code, _headers = resolve_sfvb_redirect_with_http_info(storefront_oid, opts)
|
|
9314
|
+
data
|
|
9315
|
+
end
|
|
9316
|
+
|
|
9317
|
+
# What a shopper gets for a path
|
|
9318
|
+
# Follows the redirect rules for a path exactly as the storefront does and reports each step, the final path, its status and what it lands on (a live page, a hidden page, an item, a 404 or something else). Read only. Use it to check every change.
|
|
9319
|
+
# @param storefront_oid [Integer]
|
|
9320
|
+
# @param [Hash] opts the optional parameters
|
|
9321
|
+
# @option opts [String] :path
|
|
9322
|
+
# @return [Array<(SfvbRedirectResolveResponse, Integer, Hash)>] SfvbRedirectResolveResponse data, response status code and response headers
|
|
9323
|
+
def resolve_sfvb_redirect_with_http_info(storefront_oid, opts = {})
|
|
9324
|
+
if @api_client.config.debugging
|
|
9325
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.resolve_sfvb_redirect ...'
|
|
9326
|
+
end
|
|
9327
|
+
# verify the required parameter 'storefront_oid' is set
|
|
9328
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
9329
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.resolve_sfvb_redirect"
|
|
9330
|
+
end
|
|
9331
|
+
# resource path
|
|
9332
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/redirects/resolve'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
|
|
9333
|
+
|
|
9334
|
+
# query parameters
|
|
9335
|
+
query_params = opts[:query_params] || {}
|
|
9336
|
+
query_params[:'path'] = opts[:'path'] if !opts[:'path'].nil?
|
|
9337
|
+
|
|
9338
|
+
# header parameters
|
|
9339
|
+
header_params = opts[:header_params] || {}
|
|
9340
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
9341
|
+
# HTTP header 'Accept' (if needed)
|
|
9342
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
9343
|
+
|
|
9344
|
+
# form parameters
|
|
9345
|
+
form_params = opts[:form_params] || {}
|
|
9346
|
+
|
|
9347
|
+
# http body (model)
|
|
9348
|
+
post_body = opts[:debug_body]
|
|
9349
|
+
|
|
9350
|
+
# return_type
|
|
9351
|
+
return_type = opts[:debug_return_type] || 'SfvbRedirectResolveResponse'
|
|
9352
|
+
|
|
9353
|
+
# auth_names
|
|
9354
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
9355
|
+
|
|
9356
|
+
new_options = opts.merge(
|
|
9357
|
+
:operation => :"SfvbApi.resolve_sfvb_redirect",
|
|
9358
|
+
:header_params => header_params,
|
|
9359
|
+
:query_params => query_params,
|
|
9360
|
+
:form_params => form_params,
|
|
9361
|
+
:body => post_body,
|
|
9362
|
+
:auth_names => auth_names,
|
|
9363
|
+
:return_type => return_type
|
|
9364
|
+
)
|
|
9365
|
+
|
|
9366
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
9367
|
+
if @api_client.config.debugging
|
|
9368
|
+
@api_client.config.logger.debug "API called: SfvbApi#resolve_sfvb_redirect\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
9369
|
+
end
|
|
9370
|
+
return data, status_code, headers
|
|
9371
|
+
end
|
|
9372
|
+
|
|
8497
9373
|
# Resolve a template name to the file a page renders
|
|
8498
9374
|
# A page stores only its template's file name. This runs the storefront's own template search for that name and returns the file a page naming it renders, relative to the theme. It also lists the theme's resource paths in search order with every file of that name below each, so a theme copy overriding a shared core copy, or a copy in a snippets folder that is never used, is visible. exists is false when a page naming the template cannot render.
|
|
8499
9375
|
# @param storefront_oid [Integer]
|
|
@@ -9282,6 +10158,76 @@ module UltracartClient
|
|
|
9282
10158
|
return data, status_code, headers
|
|
9283
10159
|
end
|
|
9284
10160
|
|
|
10161
|
+
# Stop ignoring a 404 path
|
|
10162
|
+
# The path lists and counts hits again.
|
|
10163
|
+
# @param storefront_oid [Integer]
|
|
10164
|
+
# @param not_found_id [String]
|
|
10165
|
+
# @param [Hash] opts the optional parameters
|
|
10166
|
+
# @return [SfvbNotFoundEntry]
|
|
10167
|
+
def unignore_sfvb_not_found_entry(storefront_oid, not_found_id, opts = {})
|
|
10168
|
+
data, _status_code, _headers = unignore_sfvb_not_found_entry_with_http_info(storefront_oid, not_found_id, opts)
|
|
10169
|
+
data
|
|
10170
|
+
end
|
|
10171
|
+
|
|
10172
|
+
# Stop ignoring a 404 path
|
|
10173
|
+
# The path lists and counts hits again.
|
|
10174
|
+
# @param storefront_oid [Integer]
|
|
10175
|
+
# @param not_found_id [String]
|
|
10176
|
+
# @param [Hash] opts the optional parameters
|
|
10177
|
+
# @return [Array<(SfvbNotFoundEntry, Integer, Hash)>] SfvbNotFoundEntry data, response status code and response headers
|
|
10178
|
+
def unignore_sfvb_not_found_entry_with_http_info(storefront_oid, not_found_id, opts = {})
|
|
10179
|
+
if @api_client.config.debugging
|
|
10180
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.unignore_sfvb_not_found_entry ...'
|
|
10181
|
+
end
|
|
10182
|
+
# verify the required parameter 'storefront_oid' is set
|
|
10183
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
10184
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.unignore_sfvb_not_found_entry"
|
|
10185
|
+
end
|
|
10186
|
+
# verify the required parameter 'not_found_id' is set
|
|
10187
|
+
if @api_client.config.client_side_validation && not_found_id.nil?
|
|
10188
|
+
fail ArgumentError, "Missing the required parameter 'not_found_id' when calling SfvbApi.unignore_sfvb_not_found_entry"
|
|
10189
|
+
end
|
|
10190
|
+
# resource path
|
|
10191
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/not_found/{not_found_id}/ignore'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'not_found_id' + '}', CGI.escape(not_found_id.to_s))
|
|
10192
|
+
|
|
10193
|
+
# query parameters
|
|
10194
|
+
query_params = opts[:query_params] || {}
|
|
10195
|
+
|
|
10196
|
+
# header parameters
|
|
10197
|
+
header_params = opts[:header_params] || {}
|
|
10198
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
10199
|
+
# HTTP header 'Accept' (if needed)
|
|
10200
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
10201
|
+
|
|
10202
|
+
# form parameters
|
|
10203
|
+
form_params = opts[:form_params] || {}
|
|
10204
|
+
|
|
10205
|
+
# http body (model)
|
|
10206
|
+
post_body = opts[:debug_body]
|
|
10207
|
+
|
|
10208
|
+
# return_type
|
|
10209
|
+
return_type = opts[:debug_return_type] || 'SfvbNotFoundEntry'
|
|
10210
|
+
|
|
10211
|
+
# auth_names
|
|
10212
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
10213
|
+
|
|
10214
|
+
new_options = opts.merge(
|
|
10215
|
+
:operation => :"SfvbApi.unignore_sfvb_not_found_entry",
|
|
10216
|
+
:header_params => header_params,
|
|
10217
|
+
:query_params => query_params,
|
|
10218
|
+
:form_params => form_params,
|
|
10219
|
+
:body => post_body,
|
|
10220
|
+
:auth_names => auth_names,
|
|
10221
|
+
:return_type => return_type
|
|
10222
|
+
)
|
|
10223
|
+
|
|
10224
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
10225
|
+
if @api_client.config.debugging
|
|
10226
|
+
@api_client.config.logger.debug "API called: SfvbApi#unignore_sfvb_not_found_entry\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
10227
|
+
end
|
|
10228
|
+
return data, status_code, headers
|
|
10229
|
+
end
|
|
10230
|
+
|
|
9285
10231
|
# Narrow who can see a library entry
|
|
9286
10232
|
# Sets visibility to shared or private. Owner only, and always needs sfvb_publish. Published revisions are kept and storefronts that already installed the entry keep their copies.
|
|
9287
10233
|
# @param storefront_oid [Integer]
|
|
@@ -9608,6 +10554,94 @@ module UltracartClient
|
|
|
9608
10554
|
return data, status_code, headers
|
|
9609
10555
|
end
|
|
9610
10556
|
|
|
10557
|
+
# Change a redirect rule
|
|
10558
|
+
# Changes the source, target or note, and can turn an admin rule into a 301. Fields left out keep their value. A changed source or target is checked like a new rule. Send the hash_sha256 you read as If-Match. Always needs sfvb_publish.
|
|
10559
|
+
# @param storefront_oid [Integer]
|
|
10560
|
+
# @param redirect_id [Integer]
|
|
10561
|
+
# @param if_match [String] hash_sha256 from the last read. 428 when absent, 412 when stale.
|
|
10562
|
+
# @param redirect_request [SfvbRedirectRequest] The request
|
|
10563
|
+
# @param [Hash] opts the optional parameters
|
|
10564
|
+
# @return [SfvbRedirectResponse]
|
|
10565
|
+
def update_sfvb_redirect(storefront_oid, redirect_id, if_match, redirect_request, opts = {})
|
|
10566
|
+
data, _status_code, _headers = update_sfvb_redirect_with_http_info(storefront_oid, redirect_id, if_match, redirect_request, opts)
|
|
10567
|
+
data
|
|
10568
|
+
end
|
|
10569
|
+
|
|
10570
|
+
# Change a redirect rule
|
|
10571
|
+
# Changes the source, target or note, and can turn an admin rule into a 301. Fields left out keep their value. A changed source or target is checked like a new rule. Send the hash_sha256 you read as If-Match. Always needs sfvb_publish.
|
|
10572
|
+
# @param storefront_oid [Integer]
|
|
10573
|
+
# @param redirect_id [Integer]
|
|
10574
|
+
# @param if_match [String] hash_sha256 from the last read. 428 when absent, 412 when stale.
|
|
10575
|
+
# @param redirect_request [SfvbRedirectRequest] The request
|
|
10576
|
+
# @param [Hash] opts the optional parameters
|
|
10577
|
+
# @return [Array<(SfvbRedirectResponse, Integer, Hash)>] SfvbRedirectResponse data, response status code and response headers
|
|
10578
|
+
def update_sfvb_redirect_with_http_info(storefront_oid, redirect_id, if_match, redirect_request, opts = {})
|
|
10579
|
+
if @api_client.config.debugging
|
|
10580
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.update_sfvb_redirect ...'
|
|
10581
|
+
end
|
|
10582
|
+
# verify the required parameter 'storefront_oid' is set
|
|
10583
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
10584
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.update_sfvb_redirect"
|
|
10585
|
+
end
|
|
10586
|
+
# verify the required parameter 'redirect_id' is set
|
|
10587
|
+
if @api_client.config.client_side_validation && redirect_id.nil?
|
|
10588
|
+
fail ArgumentError, "Missing the required parameter 'redirect_id' when calling SfvbApi.update_sfvb_redirect"
|
|
10589
|
+
end
|
|
10590
|
+
# verify the required parameter 'if_match' is set
|
|
10591
|
+
if @api_client.config.client_side_validation && if_match.nil?
|
|
10592
|
+
fail ArgumentError, "Missing the required parameter 'if_match' when calling SfvbApi.update_sfvb_redirect"
|
|
10593
|
+
end
|
|
10594
|
+
# verify the required parameter 'redirect_request' is set
|
|
10595
|
+
if @api_client.config.client_side_validation && redirect_request.nil?
|
|
10596
|
+
fail ArgumentError, "Missing the required parameter 'redirect_request' when calling SfvbApi.update_sfvb_redirect"
|
|
10597
|
+
end
|
|
10598
|
+
# resource path
|
|
10599
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/redirects/{redirect_id}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'redirect_id' + '}', CGI.escape(redirect_id.to_s))
|
|
10600
|
+
|
|
10601
|
+
# query parameters
|
|
10602
|
+
query_params = opts[:query_params] || {}
|
|
10603
|
+
|
|
10604
|
+
# header parameters
|
|
10605
|
+
header_params = opts[:header_params] || {}
|
|
10606
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
10607
|
+
# HTTP header 'Accept' (if needed)
|
|
10608
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
10609
|
+
# HTTP header 'Content-Type'
|
|
10610
|
+
content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
|
|
10611
|
+
if !content_type.nil?
|
|
10612
|
+
header_params['Content-Type'] = content_type
|
|
10613
|
+
end
|
|
10614
|
+
header_params[:'If-Match'] = if_match
|
|
10615
|
+
|
|
10616
|
+
# form parameters
|
|
10617
|
+
form_params = opts[:form_params] || {}
|
|
10618
|
+
|
|
10619
|
+
# http body (model)
|
|
10620
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(redirect_request)
|
|
10621
|
+
|
|
10622
|
+
# return_type
|
|
10623
|
+
return_type = opts[:debug_return_type] || 'SfvbRedirectResponse'
|
|
10624
|
+
|
|
10625
|
+
# auth_names
|
|
10626
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
10627
|
+
|
|
10628
|
+
new_options = opts.merge(
|
|
10629
|
+
:operation => :"SfvbApi.update_sfvb_redirect",
|
|
10630
|
+
:header_params => header_params,
|
|
10631
|
+
:query_params => query_params,
|
|
10632
|
+
:form_params => form_params,
|
|
10633
|
+
:body => post_body,
|
|
10634
|
+
:auth_names => auth_names,
|
|
10635
|
+
:return_type => return_type
|
|
10636
|
+
)
|
|
10637
|
+
|
|
10638
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
10639
|
+
if @api_client.config.debugging
|
|
10640
|
+
@api_client.config.logger.debug "API called: SfvbApi#update_sfvb_redirect\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
10641
|
+
end
|
|
10642
|
+
return data, status_code, headers
|
|
10643
|
+
end
|
|
10644
|
+
|
|
9611
10645
|
# Update an upsell offer
|
|
9612
10646
|
# A full replace. Send back the whole offer you read, changed, with its hash_sha256 in If-Match. Read only fields are ignored and a writable field left out is cleared. Changing an offer that is switched on, switching one on, or changing upsell_item_id_javascript or offsite_content_url needs sfvb_publish. Settings the API does not show, such as the offer's screenshots, are kept.
|
|
9613
10647
|
# @param storefront_oid [Integer]
|