ultracart_api 4.1.191 → 4.1.193
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/docs/SfvbRenderResponse.md +2 -0
- 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/models/sfvb_render_response.rb +11 -1
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +16 -0
- metadata +33 -1
data/docs/SfvbApi.md
CHANGED
|
@@ -8,6 +8,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
8
8
|
| [**add_sfvb_page_items**](SfvbApi.md#add_sfvb_page_items) | **POST** /sfvb/storefronts/{storefront_oid}/pages/items/add | Assign items to a page |
|
|
9
9
|
| [**archive_sfvb_upsell_path**](SfvbApi.md#archive_sfvb_upsell_path) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid}/archive | Archive an upsell path |
|
|
10
10
|
| [**attach_sfvb_blog_post_image**](SfvbApi.md#attach_sfvb_blog_post_image) | **POST** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid}/images/attach | Attach an image to a blog post |
|
|
11
|
+
| [**check_sfvb_redirect**](SfvbApi.md#check_sfvb_redirect) | **POST** /sfvb/storefronts/{storefront_oid}/redirects/check | Check a redirect rule without creating it |
|
|
11
12
|
| [**clear_sfvb_library_screenshot**](SfvbApi.md#clear_sfvb_library_screenshot) | **DELETE** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/screenshot | Remove a library entry's screenshot |
|
|
12
13
|
| [**compile_sfvb_cjson**](SfvbApi.md#compile_sfvb_cjson) | **POST** /sfvb/cjson/compile | Compile CJSON to Velocity |
|
|
13
14
|
| [**create_sfvb_library_entry**](SfvbApi.md#create_sfvb_library_entry) | **POST** /sfvb/storefronts/{storefront_oid}/library | Save a fragment to the library |
|
|
@@ -20,11 +21,13 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
20
21
|
| [**delete_sfvb_library_entry**](SfvbApi.md#delete_sfvb_library_entry) | **DELETE** /sfvb/storefronts/{storefront_oid}/library/{library_oid} | Delete or retire a library entry |
|
|
21
22
|
| [**delete_sfvb_page_multimedia**](SfvbApi.md#delete_sfvb_page_multimedia) | **DELETE** /sfvb/storefronts/{storefront_oid}/pages/multimedia | Detach an image from a page |
|
|
22
23
|
| [**delete_sfvb_preview_session**](SfvbApi.md#delete_sfvb_preview_session) | **DELETE** /sfvb/storefronts/{storefront_oid}/preview_sessions/{preview_session_id} | Delete a preview session |
|
|
24
|
+
| [**delete_sfvb_redirect**](SfvbApi.md#delete_sfvb_redirect) | **DELETE** /sfvb/storefronts/{storefront_oid}/redirects/{redirect_id} | Delete a redirect rule |
|
|
23
25
|
| [**detach_sfvb_blog_post_image**](SfvbApi.md#detach_sfvb_blog_post_image) | **POST** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid}/images/detach | Detach an image from a blog post |
|
|
24
26
|
| [**disable_sfvb_i18n_language**](SfvbApi.md#disable_sfvb_i18n_language) | **POST** /sfvb/storefronts/{storefront_oid}/i18n/languages/{code}/disable | Disable a language |
|
|
25
27
|
| [**disable_sfvb_upsell_offer**](SfvbApi.md#disable_sfvb_upsell_offer) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_offers/{upsell_offer_oid}/disable | Disable an upsell offer |
|
|
26
28
|
| [**disable_sfvb_upsell_path**](SfvbApi.md#disable_sfvb_upsell_path) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid}/disable | Disable an upsell path |
|
|
27
29
|
| [**download_sfvb_file**](SfvbApi.md#download_sfvb_file) | **GET** /sfvb/storefronts/{storefront_oid}/files/download | Read a storefront file's raw bytes |
|
|
30
|
+
| [**dry_run_sfvb_redirect_import**](SfvbApi.md#dry_run_sfvb_redirect_import) | **POST** /sfvb/storefronts/{storefront_oid}/redirects/import/dry_run | Check a redirect import without writing it |
|
|
28
31
|
| [**duplicate_sfvb_library_entry**](SfvbApi.md#duplicate_sfvb_library_entry) | **POST** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/duplicate | Copy a library entry into a new private entry |
|
|
29
32
|
| [**duplicate_sfvb_page**](SfvbApi.md#duplicate_sfvb_page) | **POST** /sfvb/storefronts/{storefront_oid}/pages/duplicate | Copy a page to a new path |
|
|
30
33
|
| [**duplicate_sfvb_theme**](SfvbApi.md#duplicate_sfvb_theme) | **POST** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/duplicate | Duplicate a theme |
|
|
@@ -54,6 +57,9 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
54
57
|
| [**get_sfvb_library_taxonomy**](SfvbApi.md#get_sfvb_library_taxonomy) | **GET** /sfvb/storefronts/{storefront_oid}/library/taxonomy | List the allowed library tags |
|
|
55
58
|
| [**get_sfvb_menu**](SfvbApi.md#get_sfvb_menu) | **GET** /sfvb/storefronts/{storefront_oid}/menus/{code} | Read one store menu and its entries |
|
|
56
59
|
| [**get_sfvb_menus**](SfvbApi.md#get_sfvb_menus) | **GET** /sfvb/storefronts/{storefront_oid}/menus | List a storefront's store menus |
|
|
60
|
+
| [**get_sfvb_not_found**](SfvbApi.md#get_sfvb_not_found) | **GET** /sfvb/storefronts/{storefront_oid}/not_found | List the paths that answered 404 |
|
|
61
|
+
| [**get_sfvb_not_found_entry**](SfvbApi.md#get_sfvb_not_found_entry) | **GET** /sfvb/storefronts/{storefront_oid}/not_found/{not_found_id} | Read one 404 path with its recent hits |
|
|
62
|
+
| [**get_sfvb_not_found_page**](SfvbApi.md#get_sfvb_not_found_page) | **GET** /sfvb/storefronts/{storefront_oid}/not_found_page | What renders the storefront's 404 page |
|
|
57
63
|
| [**get_sfvb_page**](SfvbApi.md#get_sfvb_page) | **GET** /sfvb/storefronts/{storefront_oid}/pages | Read a page's attributes and images |
|
|
58
64
|
| [**get_sfvb_page_blog_posts**](SfvbApi.md#get_sfvb_page_blog_posts) | **GET** /sfvb/storefronts/{storefront_oid}/pages/blog_posts | Read the blog posts assigned to a page |
|
|
59
65
|
| [**get_sfvb_page_items**](SfvbApi.md#get_sfvb_page_items) | **GET** /sfvb/storefronts/{storefront_oid}/pages/items | Read the items assigned to a page |
|
|
@@ -62,6 +68,8 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
62
68
|
| [**get_sfvb_recording**](SfvbApi.md#get_sfvb_recording) | **GET** /sfvb/storefronts/{storefront_oid}/recordings/{screen_recording_uuid} | Get a screen recording |
|
|
63
69
|
| [**get_sfvb_recording_page_view_events**](SfvbApi.md#get_sfvb_recording_page_view_events) | **GET** /sfvb/storefronts/{storefront_oid}/recordings/{screen_recording_uuid}/page_views/{screen_recording_page_view_uuid}/events | Get one recorded page view's replay events |
|
|
64
70
|
| [**get_sfvb_recording_settings**](SfvbApi.md#get_sfvb_recording_settings) | **GET** /sfvb/storefronts/{storefront_oid}/recording_settings | Get the storefront's screen recording settings |
|
|
71
|
+
| [**get_sfvb_redirect**](SfvbApi.md#get_sfvb_redirect) | **GET** /sfvb/storefronts/{storefront_oid}/redirects/{redirect_id} | Read one redirect rule |
|
|
72
|
+
| [**get_sfvb_redirects**](SfvbApi.md#get_sfvb_redirects) | **GET** /sfvb/storefronts/{storefront_oid}/redirects | List the storefront's redirect rules |
|
|
65
73
|
| [**get_sfvb_server_log**](SfvbApi.md#get_sfvb_server_log) | **GET** /sfvb/storefronts/{storefront_oid}/logs/{log_id} | Get one storefront render log |
|
|
66
74
|
| [**get_sfvb_site_attributes**](SfvbApi.md#get_sfvb_site_attributes) | **GET** /sfvb/storefronts/{storefront_oid}/attributes | Read a storefront's site attributes |
|
|
67
75
|
| [**get_sfvb_theme**](SfvbApi.md#get_sfvb_theme) | **GET** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid} | Get a theme |
|
|
@@ -71,8 +79,11 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
71
79
|
| [**get_sfvb_upsell_path**](SfvbApi.md#get_sfvb_upsell_path) | **GET** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid} | Get an upsell path |
|
|
72
80
|
| [**get_sfvb_version**](SfvbApi.md#get_sfvb_version) | **GET** /sfvb/version | Compiler version for this merchant |
|
|
73
81
|
| [**get_sfvb_whoami**](SfvbApi.md#get_sfvb_whoami) | **GET** /sfvb/whoami | Who this token is |
|
|
82
|
+
| [**ignore_sfvb_not_found_entry**](SfvbApi.md#ignore_sfvb_not_found_entry) | **POST** /sfvb/storefronts/{storefront_oid}/not_found/{not_found_id}/ignore | Ignore a 404 path |
|
|
83
|
+
| [**import_sfvb_redirects**](SfvbApi.md#import_sfvb_redirects) | **POST** /sfvb/storefronts/{storefront_oid}/redirects/import | Apply a reviewed redirect import |
|
|
74
84
|
| [**insert_sfvb_blog_post**](SfvbApi.md#insert_sfvb_blog_post) | **POST** /sfvb/storefronts/{storefront_oid}/blog_posts | Create a blog post |
|
|
75
85
|
| [**insert_sfvb_page**](SfvbApi.md#insert_sfvb_page) | **POST** /sfvb/storefronts/{storefront_oid}/pages | Create a page |
|
|
86
|
+
| [**insert_sfvb_redirect**](SfvbApi.md#insert_sfvb_redirect) | **POST** /sfvb/storefronts/{storefront_oid}/redirects | Create a 301 redirect rule |
|
|
76
87
|
| [**insert_sfvb_upsell_offer**](SfvbApi.md#insert_sfvb_upsell_offer) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_offers | Create an upsell offer |
|
|
77
88
|
| [**insert_sfvb_upsell_path**](SfvbApi.md#insert_sfvb_upsell_path) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_paths | Create an upsell path |
|
|
78
89
|
| [**install_sfvb_library_entry**](SfvbApi.md#install_sfvb_library_entry) | **POST** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/install | Install a library entry into a storefront |
|
|
@@ -118,6 +129,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
118
129
|
| [**render_sfvb_widgets**](SfvbApi.md#render_sfvb_widgets) | **POST** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/render | Render a CJSON node to HTML |
|
|
119
130
|
| [**reserve_sfvb_widget_ids**](SfvbApi.md#reserve_sfvb_widget_ids) | **POST** /sfvb/storefronts/{storefront_oid}/widget_ids | Reserve a block of widget ids |
|
|
120
131
|
| [**reset_sfvb_i18n_message**](SfvbApi.md#reset_sfvb_i18n_message) | **DELETE** /sfvb/storefronts/{storefront_oid}/i18n/messages/{key} | Reset one built-in message |
|
|
132
|
+
| [**resolve_sfvb_redirect**](SfvbApi.md#resolve_sfvb_redirect) | **GET** /sfvb/storefronts/{storefront_oid}/redirects/resolve | What a shopper gets for a path |
|
|
121
133
|
| [**resolve_sfvb_template**](SfvbApi.md#resolve_sfvb_template) | **GET** /sfvb/storefronts/{storefront_oid}/templates/resolve | Resolve a template name to the file a page renders |
|
|
122
134
|
| [**revert_sfvb_container**](SfvbApi.md#revert_sfvb_container) | **POST** /sfvb/storefronts/{storefront_oid}/containers/{owner_type}/{owner_object_id}/revert | Revert a container stored outside the file system |
|
|
123
135
|
| [**revert_sfvb_file**](SfvbApi.md#revert_sfvb_file) | **POST** /sfvb/storefronts/{storefront_oid}/files/revert | Revert a storefront file to an earlier version |
|
|
@@ -128,10 +140,12 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
128
140
|
| [**start_sfvb_experiment**](SfvbApi.md#start_sfvb_experiment) | **POST** /sfvb/storefronts/{storefront_oid}/experiments | Start an experiment |
|
|
129
141
|
| [**unarchive_sfvb_upsell_path**](SfvbApi.md#unarchive_sfvb_upsell_path) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid}/unarchive | Unarchive an upsell path |
|
|
130
142
|
| [**unfavorite_sfvb_library_entry**](SfvbApi.md#unfavorite_sfvb_library_entry) | **DELETE** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/favorite | Remove a library entry from favorites |
|
|
143
|
+
| [**unignore_sfvb_not_found_entry**](SfvbApi.md#unignore_sfvb_not_found_entry) | **DELETE** /sfvb/storefronts/{storefront_oid}/not_found/{not_found_id}/ignore | Stop ignoring a 404 path |
|
|
131
144
|
| [**unpublish_sfvb_library_entry**](SfvbApi.md#unpublish_sfvb_library_entry) | **POST** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/unpublish | Narrow who can see a library entry |
|
|
132
145
|
| [**unshare_sfvb_library_entry**](SfvbApi.md#unshare_sfvb_library_entry) | **DELETE** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/shares/{merchant_id} | Stop sharing a library entry with an account |
|
|
133
146
|
| [**update_sfvb_blog_post**](SfvbApi.md#update_sfvb_blog_post) | **PUT** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid} | Change a blog post |
|
|
134
147
|
| [**update_sfvb_library_entry**](SfvbApi.md#update_sfvb_library_entry) | **PUT** /sfvb/storefronts/{storefront_oid}/library/{library_oid} | Update a library entry's draft |
|
|
148
|
+
| [**update_sfvb_redirect**](SfvbApi.md#update_sfvb_redirect) | **PUT** /sfvb/storefronts/{storefront_oid}/redirects/{redirect_id} | Change a redirect rule |
|
|
135
149
|
| [**update_sfvb_upsell_offer**](SfvbApi.md#update_sfvb_upsell_offer) | **PUT** /sfvb/storefronts/{storefront_oid}/upsell_offers/{upsell_offer_oid} | Update an upsell offer |
|
|
136
150
|
| [**update_sfvb_upsell_path**](SfvbApi.md#update_sfvb_upsell_path) | **PUT** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid} | Update an upsell path |
|
|
137
151
|
| [**upload_sfvb_file**](SfvbApi.md#upload_sfvb_file) | **POST** /sfvb/storefronts/{storefront_oid}/files/upload | Store a binary asset that was already uploaded |
|
|
@@ -358,6 +372,60 @@ end
|
|
|
358
372
|
- **Accept**: application/json
|
|
359
373
|
|
|
360
374
|
|
|
375
|
+
## check_sfvb_redirect
|
|
376
|
+
|
|
377
|
+
> <SfvbRedirectCheckResponse> check_sfvb_redirect(storefront_oid, redirect_request)
|
|
378
|
+
|
|
379
|
+
Check a redirect rule without creating it
|
|
380
|
+
|
|
381
|
+
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.
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
### Examples
|
|
385
|
+
|
|
386
|
+
|
|
387
|
+
(No example for this operation).
|
|
388
|
+
|
|
389
|
+
|
|
390
|
+
#### Using the check_sfvb_redirect_with_http_info variant
|
|
391
|
+
|
|
392
|
+
This returns an Array which contains the response data, status code and headers.
|
|
393
|
+
|
|
394
|
+
> <Array(<SfvbRedirectCheckResponse>, Integer, Hash)> check_sfvb_redirect_with_http_info(storefront_oid, redirect_request)
|
|
395
|
+
|
|
396
|
+
```ruby
|
|
397
|
+
begin
|
|
398
|
+
# Check a redirect rule without creating it
|
|
399
|
+
data, status_code, headers = api_instance.check_sfvb_redirect_with_http_info(storefront_oid, redirect_request)
|
|
400
|
+
p status_code # => 2xx
|
|
401
|
+
p headers # => { ... }
|
|
402
|
+
p data # => <SfvbRedirectCheckResponse>
|
|
403
|
+
rescue UltracartClient::ApiError => e
|
|
404
|
+
puts "Error when calling SfvbApi->check_sfvb_redirect_with_http_info: #{e}"
|
|
405
|
+
end
|
|
406
|
+
```
|
|
407
|
+
|
|
408
|
+
### Parameters
|
|
409
|
+
|
|
410
|
+
| Name | Type | Description | Notes |
|
|
411
|
+
| ---- | ---- | ----------- | ----- |
|
|
412
|
+
| **storefront_oid** | **Integer** | | |
|
|
413
|
+
| **redirect_request** | [**SfvbRedirectRequest**](SfvbRedirectRequest.md) | The request | |
|
|
414
|
+
|
|
415
|
+
### Return type
|
|
416
|
+
|
|
417
|
+
[**SfvbRedirectCheckResponse**](SfvbRedirectCheckResponse.md)
|
|
418
|
+
|
|
419
|
+
### Authorization
|
|
420
|
+
|
|
421
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
422
|
+
|
|
423
|
+
### HTTP request headers
|
|
424
|
+
|
|
425
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
426
|
+
- **Accept**: application/json
|
|
427
|
+
|
|
428
|
+
|
|
361
429
|
## clear_sfvb_library_screenshot
|
|
362
430
|
|
|
363
431
|
> <SfvbLibraryEntry> clear_sfvb_library_screenshot(storefront_oid, library_oid, if_match)
|
|
@@ -1014,6 +1082,61 @@ nil (empty response body)
|
|
|
1014
1082
|
- **Accept**: application/json
|
|
1015
1083
|
|
|
1016
1084
|
|
|
1085
|
+
## delete_sfvb_redirect
|
|
1086
|
+
|
|
1087
|
+
> delete_sfvb_redirect(storefront_oid, redirect_id, if_match)
|
|
1088
|
+
|
|
1089
|
+
Delete a redirect rule
|
|
1090
|
+
|
|
1091
|
+
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.
|
|
1092
|
+
|
|
1093
|
+
|
|
1094
|
+
### Examples
|
|
1095
|
+
|
|
1096
|
+
|
|
1097
|
+
(No example for this operation).
|
|
1098
|
+
|
|
1099
|
+
|
|
1100
|
+
#### Using the delete_sfvb_redirect_with_http_info variant
|
|
1101
|
+
|
|
1102
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
1103
|
+
|
|
1104
|
+
> <Array(nil, Integer, Hash)> delete_sfvb_redirect_with_http_info(storefront_oid, redirect_id, if_match)
|
|
1105
|
+
|
|
1106
|
+
```ruby
|
|
1107
|
+
begin
|
|
1108
|
+
# Delete a redirect rule
|
|
1109
|
+
data, status_code, headers = api_instance.delete_sfvb_redirect_with_http_info(storefront_oid, redirect_id, if_match)
|
|
1110
|
+
p status_code # => 2xx
|
|
1111
|
+
p headers # => { ... }
|
|
1112
|
+
p data # => nil
|
|
1113
|
+
rescue UltracartClient::ApiError => e
|
|
1114
|
+
puts "Error when calling SfvbApi->delete_sfvb_redirect_with_http_info: #{e}"
|
|
1115
|
+
end
|
|
1116
|
+
```
|
|
1117
|
+
|
|
1118
|
+
### Parameters
|
|
1119
|
+
|
|
1120
|
+
| Name | Type | Description | Notes |
|
|
1121
|
+
| ---- | ---- | ----------- | ----- |
|
|
1122
|
+
| **storefront_oid** | **Integer** | | |
|
|
1123
|
+
| **redirect_id** | **Integer** | | |
|
|
1124
|
+
| **if_match** | **String** | hash_sha256 from the last read. 428 when absent, 412 when stale. | |
|
|
1125
|
+
|
|
1126
|
+
### Return type
|
|
1127
|
+
|
|
1128
|
+
nil (empty response body)
|
|
1129
|
+
|
|
1130
|
+
### Authorization
|
|
1131
|
+
|
|
1132
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
1133
|
+
|
|
1134
|
+
### HTTP request headers
|
|
1135
|
+
|
|
1136
|
+
- **Content-Type**: Not defined
|
|
1137
|
+
- **Accept**: application/json
|
|
1138
|
+
|
|
1139
|
+
|
|
1017
1140
|
## detach_sfvb_blog_post_image
|
|
1018
1141
|
|
|
1019
1142
|
> <SfvbBlogPostDetail> detach_sfvb_blog_post_image(storefront_oid, blog_post_oid, blog_post_image_request)
|
|
@@ -1286,6 +1409,60 @@ nil (empty response body)
|
|
|
1286
1409
|
- **Accept**: application/octet-stream
|
|
1287
1410
|
|
|
1288
1411
|
|
|
1412
|
+
## dry_run_sfvb_redirect_import
|
|
1413
|
+
|
|
1414
|
+
> <SfvbRedirectImportResponse> dry_run_sfvb_redirect_import(storefront_oid, redirect_import_request)
|
|
1415
|
+
|
|
1416
|
+
Check a redirect import without writing it
|
|
1417
|
+
|
|
1418
|
+
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.
|
|
1419
|
+
|
|
1420
|
+
|
|
1421
|
+
### Examples
|
|
1422
|
+
|
|
1423
|
+
|
|
1424
|
+
(No example for this operation).
|
|
1425
|
+
|
|
1426
|
+
|
|
1427
|
+
#### Using the dry_run_sfvb_redirect_import_with_http_info variant
|
|
1428
|
+
|
|
1429
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1430
|
+
|
|
1431
|
+
> <Array(<SfvbRedirectImportResponse>, Integer, Hash)> dry_run_sfvb_redirect_import_with_http_info(storefront_oid, redirect_import_request)
|
|
1432
|
+
|
|
1433
|
+
```ruby
|
|
1434
|
+
begin
|
|
1435
|
+
# Check a redirect import without writing it
|
|
1436
|
+
data, status_code, headers = api_instance.dry_run_sfvb_redirect_import_with_http_info(storefront_oid, redirect_import_request)
|
|
1437
|
+
p status_code # => 2xx
|
|
1438
|
+
p headers # => { ... }
|
|
1439
|
+
p data # => <SfvbRedirectImportResponse>
|
|
1440
|
+
rescue UltracartClient::ApiError => e
|
|
1441
|
+
puts "Error when calling SfvbApi->dry_run_sfvb_redirect_import_with_http_info: #{e}"
|
|
1442
|
+
end
|
|
1443
|
+
```
|
|
1444
|
+
|
|
1445
|
+
### Parameters
|
|
1446
|
+
|
|
1447
|
+
| Name | Type | Description | Notes |
|
|
1448
|
+
| ---- | ---- | ----------- | ----- |
|
|
1449
|
+
| **storefront_oid** | **Integer** | | |
|
|
1450
|
+
| **redirect_import_request** | [**SfvbRedirectImportRequest**](SfvbRedirectImportRequest.md) | The request | |
|
|
1451
|
+
|
|
1452
|
+
### Return type
|
|
1453
|
+
|
|
1454
|
+
[**SfvbRedirectImportResponse**](SfvbRedirectImportResponse.md)
|
|
1455
|
+
|
|
1456
|
+
### Authorization
|
|
1457
|
+
|
|
1458
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
1459
|
+
|
|
1460
|
+
### HTTP request headers
|
|
1461
|
+
|
|
1462
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
1463
|
+
- **Accept**: application/json
|
|
1464
|
+
|
|
1465
|
+
|
|
1289
1466
|
## duplicate_sfvb_library_entry
|
|
1290
1467
|
|
|
1291
1468
|
> <SfvbLibraryEntry> duplicate_sfvb_library_entry(storefront_oid, library_oid, opts)
|
|
@@ -2861,6 +3038,173 @@ end
|
|
|
2861
3038
|
- **Accept**: application/json
|
|
2862
3039
|
|
|
2863
3040
|
|
|
3041
|
+
## get_sfvb_not_found
|
|
3042
|
+
|
|
3043
|
+
> <SfvbNotFoundResponse> get_sfvb_not_found(storefront_oid, opts)
|
|
3044
|
+
|
|
3045
|
+
List the paths that answered 404
|
|
3046
|
+
|
|
3047
|
+
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.
|
|
3048
|
+
|
|
3049
|
+
|
|
3050
|
+
### Examples
|
|
3051
|
+
|
|
3052
|
+
|
|
3053
|
+
(No example for this operation).
|
|
3054
|
+
|
|
3055
|
+
|
|
3056
|
+
#### Using the get_sfvb_not_found_with_http_info variant
|
|
3057
|
+
|
|
3058
|
+
This returns an Array which contains the response data, status code and headers.
|
|
3059
|
+
|
|
3060
|
+
> <Array(<SfvbNotFoundResponse>, Integer, Hash)> get_sfvb_not_found_with_http_info(storefront_oid, opts)
|
|
3061
|
+
|
|
3062
|
+
```ruby
|
|
3063
|
+
begin
|
|
3064
|
+
# List the paths that answered 404
|
|
3065
|
+
data, status_code, headers = api_instance.get_sfvb_not_found_with_http_info(storefront_oid, opts)
|
|
3066
|
+
p status_code # => 2xx
|
|
3067
|
+
p headers # => { ... }
|
|
3068
|
+
p data # => <SfvbNotFoundResponse>
|
|
3069
|
+
rescue UltracartClient::ApiError => e
|
|
3070
|
+
puts "Error when calling SfvbApi->get_sfvb_not_found_with_http_info: #{e}"
|
|
3071
|
+
end
|
|
3072
|
+
```
|
|
3073
|
+
|
|
3074
|
+
### Parameters
|
|
3075
|
+
|
|
3076
|
+
| Name | Type | Description | Notes |
|
|
3077
|
+
| ---- | ---- | ----------- | ----- |
|
|
3078
|
+
| **storefront_oid** | **Integer** | | |
|
|
3079
|
+
| **since** | **String** | | [optional] |
|
|
3080
|
+
| **sort** | **String** | | [optional] |
|
|
3081
|
+
| **include_bots** | **Boolean** | | [optional] |
|
|
3082
|
+
| **include_tokens** | **Boolean** | | [optional] |
|
|
3083
|
+
| **q** | **String** | | [optional] |
|
|
3084
|
+
| **limit** | **Integer** | | [optional] |
|
|
3085
|
+
|
|
3086
|
+
### Return type
|
|
3087
|
+
|
|
3088
|
+
[**SfvbNotFoundResponse**](SfvbNotFoundResponse.md)
|
|
3089
|
+
|
|
3090
|
+
### Authorization
|
|
3091
|
+
|
|
3092
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
3093
|
+
|
|
3094
|
+
### HTTP request headers
|
|
3095
|
+
|
|
3096
|
+
- **Content-Type**: Not defined
|
|
3097
|
+
- **Accept**: application/json
|
|
3098
|
+
|
|
3099
|
+
|
|
3100
|
+
## get_sfvb_not_found_entry
|
|
3101
|
+
|
|
3102
|
+
> <SfvbNotFoundEntryResponse> get_sfvb_not_found_entry(storefront_oid, not_found_id, opts)
|
|
3103
|
+
|
|
3104
|
+
Read one 404 path with its recent hits
|
|
3105
|
+
|
|
3106
|
+
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.
|
|
3107
|
+
|
|
3108
|
+
|
|
3109
|
+
### Examples
|
|
3110
|
+
|
|
3111
|
+
|
|
3112
|
+
(No example for this operation).
|
|
3113
|
+
|
|
3114
|
+
|
|
3115
|
+
#### Using the get_sfvb_not_found_entry_with_http_info variant
|
|
3116
|
+
|
|
3117
|
+
This returns an Array which contains the response data, status code and headers.
|
|
3118
|
+
|
|
3119
|
+
> <Array(<SfvbNotFoundEntryResponse>, Integer, Hash)> get_sfvb_not_found_entry_with_http_info(storefront_oid, not_found_id, opts)
|
|
3120
|
+
|
|
3121
|
+
```ruby
|
|
3122
|
+
begin
|
|
3123
|
+
# Read one 404 path with its recent hits
|
|
3124
|
+
data, status_code, headers = api_instance.get_sfvb_not_found_entry_with_http_info(storefront_oid, not_found_id, opts)
|
|
3125
|
+
p status_code # => 2xx
|
|
3126
|
+
p headers # => { ... }
|
|
3127
|
+
p data # => <SfvbNotFoundEntryResponse>
|
|
3128
|
+
rescue UltracartClient::ApiError => e
|
|
3129
|
+
puts "Error when calling SfvbApi->get_sfvb_not_found_entry_with_http_info: #{e}"
|
|
3130
|
+
end
|
|
3131
|
+
```
|
|
3132
|
+
|
|
3133
|
+
### Parameters
|
|
3134
|
+
|
|
3135
|
+
| Name | Type | Description | Notes |
|
|
3136
|
+
| ---- | ---- | ----------- | ----- |
|
|
3137
|
+
| **storefront_oid** | **Integer** | | |
|
|
3138
|
+
| **not_found_id** | **String** | | |
|
|
3139
|
+
| **include_tokens** | **Boolean** | | [optional] |
|
|
3140
|
+
|
|
3141
|
+
### Return type
|
|
3142
|
+
|
|
3143
|
+
[**SfvbNotFoundEntryResponse**](SfvbNotFoundEntryResponse.md)
|
|
3144
|
+
|
|
3145
|
+
### Authorization
|
|
3146
|
+
|
|
3147
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
3148
|
+
|
|
3149
|
+
### HTTP request headers
|
|
3150
|
+
|
|
3151
|
+
- **Content-Type**: Not defined
|
|
3152
|
+
- **Accept**: application/json
|
|
3153
|
+
|
|
3154
|
+
|
|
3155
|
+
## get_sfvb_not_found_page
|
|
3156
|
+
|
|
3157
|
+
> <SfvbNotFoundPage> get_sfvb_not_found_page(storefront_oid)
|
|
3158
|
+
|
|
3159
|
+
What renders the storefront's 404 page
|
|
3160
|
+
|
|
3161
|
+
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.
|
|
3162
|
+
|
|
3163
|
+
|
|
3164
|
+
### Examples
|
|
3165
|
+
|
|
3166
|
+
|
|
3167
|
+
(No example for this operation).
|
|
3168
|
+
|
|
3169
|
+
|
|
3170
|
+
#### Using the get_sfvb_not_found_page_with_http_info variant
|
|
3171
|
+
|
|
3172
|
+
This returns an Array which contains the response data, status code and headers.
|
|
3173
|
+
|
|
3174
|
+
> <Array(<SfvbNotFoundPage>, Integer, Hash)> get_sfvb_not_found_page_with_http_info(storefront_oid)
|
|
3175
|
+
|
|
3176
|
+
```ruby
|
|
3177
|
+
begin
|
|
3178
|
+
# What renders the storefront's 404 page
|
|
3179
|
+
data, status_code, headers = api_instance.get_sfvb_not_found_page_with_http_info(storefront_oid)
|
|
3180
|
+
p status_code # => 2xx
|
|
3181
|
+
p headers # => { ... }
|
|
3182
|
+
p data # => <SfvbNotFoundPage>
|
|
3183
|
+
rescue UltracartClient::ApiError => e
|
|
3184
|
+
puts "Error when calling SfvbApi->get_sfvb_not_found_page_with_http_info: #{e}"
|
|
3185
|
+
end
|
|
3186
|
+
```
|
|
3187
|
+
|
|
3188
|
+
### Parameters
|
|
3189
|
+
|
|
3190
|
+
| Name | Type | Description | Notes |
|
|
3191
|
+
| ---- | ---- | ----------- | ----- |
|
|
3192
|
+
| **storefront_oid** | **Integer** | | |
|
|
3193
|
+
|
|
3194
|
+
### Return type
|
|
3195
|
+
|
|
3196
|
+
[**SfvbNotFoundPage**](SfvbNotFoundPage.md)
|
|
3197
|
+
|
|
3198
|
+
### Authorization
|
|
3199
|
+
|
|
3200
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
3201
|
+
|
|
3202
|
+
### HTTP request headers
|
|
3203
|
+
|
|
3204
|
+
- **Content-Type**: Not defined
|
|
3205
|
+
- **Accept**: application/json
|
|
3206
|
+
|
|
3207
|
+
|
|
2864
3208
|
## get_sfvb_page
|
|
2865
3209
|
|
|
2866
3210
|
> <SfvbPageResponse> get_sfvb_page(storefront_oid, path)
|
|
@@ -3270,7 +3614,114 @@ begin
|
|
|
3270
3614
|
p headers # => { ... }
|
|
3271
3615
|
p data # => <SfvbRecordingSettingsResponse>
|
|
3272
3616
|
rescue UltracartClient::ApiError => e
|
|
3273
|
-
puts "Error when calling SfvbApi->get_sfvb_recording_settings_with_http_info: #{e}"
|
|
3617
|
+
puts "Error when calling SfvbApi->get_sfvb_recording_settings_with_http_info: #{e}"
|
|
3618
|
+
end
|
|
3619
|
+
```
|
|
3620
|
+
|
|
3621
|
+
### Parameters
|
|
3622
|
+
|
|
3623
|
+
| Name | Type | Description | Notes |
|
|
3624
|
+
| ---- | ---- | ----------- | ----- |
|
|
3625
|
+
| **storefront_oid** | **Integer** | | |
|
|
3626
|
+
|
|
3627
|
+
### Return type
|
|
3628
|
+
|
|
3629
|
+
[**SfvbRecordingSettingsResponse**](SfvbRecordingSettingsResponse.md)
|
|
3630
|
+
|
|
3631
|
+
### Authorization
|
|
3632
|
+
|
|
3633
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
3634
|
+
|
|
3635
|
+
### HTTP request headers
|
|
3636
|
+
|
|
3637
|
+
- **Content-Type**: Not defined
|
|
3638
|
+
- **Accept**: application/json
|
|
3639
|
+
|
|
3640
|
+
|
|
3641
|
+
## get_sfvb_redirect
|
|
3642
|
+
|
|
3643
|
+
> <SfvbRedirect> get_sfvb_redirect(storefront_oid, redirect_id)
|
|
3644
|
+
|
|
3645
|
+
Read one redirect rule
|
|
3646
|
+
|
|
3647
|
+
One rule, with the hash_sha256 to send as If-Match when updating or deleting it.
|
|
3648
|
+
|
|
3649
|
+
|
|
3650
|
+
### Examples
|
|
3651
|
+
|
|
3652
|
+
|
|
3653
|
+
(No example for this operation).
|
|
3654
|
+
|
|
3655
|
+
|
|
3656
|
+
#### Using the get_sfvb_redirect_with_http_info variant
|
|
3657
|
+
|
|
3658
|
+
This returns an Array which contains the response data, status code and headers.
|
|
3659
|
+
|
|
3660
|
+
> <Array(<SfvbRedirect>, Integer, Hash)> get_sfvb_redirect_with_http_info(storefront_oid, redirect_id)
|
|
3661
|
+
|
|
3662
|
+
```ruby
|
|
3663
|
+
begin
|
|
3664
|
+
# Read one redirect rule
|
|
3665
|
+
data, status_code, headers = api_instance.get_sfvb_redirect_with_http_info(storefront_oid, redirect_id)
|
|
3666
|
+
p status_code # => 2xx
|
|
3667
|
+
p headers # => { ... }
|
|
3668
|
+
p data # => <SfvbRedirect>
|
|
3669
|
+
rescue UltracartClient::ApiError => e
|
|
3670
|
+
puts "Error when calling SfvbApi->get_sfvb_redirect_with_http_info: #{e}"
|
|
3671
|
+
end
|
|
3672
|
+
```
|
|
3673
|
+
|
|
3674
|
+
### Parameters
|
|
3675
|
+
|
|
3676
|
+
| Name | Type | Description | Notes |
|
|
3677
|
+
| ---- | ---- | ----------- | ----- |
|
|
3678
|
+
| **storefront_oid** | **Integer** | | |
|
|
3679
|
+
| **redirect_id** | **Integer** | | |
|
|
3680
|
+
|
|
3681
|
+
### Return type
|
|
3682
|
+
|
|
3683
|
+
[**SfvbRedirect**](SfvbRedirect.md)
|
|
3684
|
+
|
|
3685
|
+
### Authorization
|
|
3686
|
+
|
|
3687
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
3688
|
+
|
|
3689
|
+
### HTTP request headers
|
|
3690
|
+
|
|
3691
|
+
- **Content-Type**: Not defined
|
|
3692
|
+
- **Accept**: application/json
|
|
3693
|
+
|
|
3694
|
+
|
|
3695
|
+
## get_sfvb_redirects
|
|
3696
|
+
|
|
3697
|
+
> <SfvbRedirectsResponse> get_sfvb_redirects(storefront_oid, opts)
|
|
3698
|
+
|
|
3699
|
+
List the storefront's redirect rules
|
|
3700
|
+
|
|
3701
|
+
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.
|
|
3702
|
+
|
|
3703
|
+
|
|
3704
|
+
### Examples
|
|
3705
|
+
|
|
3706
|
+
|
|
3707
|
+
(No example for this operation).
|
|
3708
|
+
|
|
3709
|
+
|
|
3710
|
+
#### Using the get_sfvb_redirects_with_http_info variant
|
|
3711
|
+
|
|
3712
|
+
This returns an Array which contains the response data, status code and headers.
|
|
3713
|
+
|
|
3714
|
+
> <Array(<SfvbRedirectsResponse>, Integer, Hash)> get_sfvb_redirects_with_http_info(storefront_oid, opts)
|
|
3715
|
+
|
|
3716
|
+
```ruby
|
|
3717
|
+
begin
|
|
3718
|
+
# List the storefront's redirect rules
|
|
3719
|
+
data, status_code, headers = api_instance.get_sfvb_redirects_with_http_info(storefront_oid, opts)
|
|
3720
|
+
p status_code # => 2xx
|
|
3721
|
+
p headers # => { ... }
|
|
3722
|
+
p data # => <SfvbRedirectsResponse>
|
|
3723
|
+
rescue UltracartClient::ApiError => e
|
|
3724
|
+
puts "Error when calling SfvbApi->get_sfvb_redirects_with_http_info: #{e}"
|
|
3274
3725
|
end
|
|
3275
3726
|
```
|
|
3276
3727
|
|
|
@@ -3279,10 +3730,13 @@ end
|
|
|
3279
3730
|
| Name | Type | Description | Notes |
|
|
3280
3731
|
| ---- | ---- | ----------- | ----- |
|
|
3281
3732
|
| **storefront_oid** | **Integer** | | |
|
|
3733
|
+
| **q** | **String** | | [optional] |
|
|
3734
|
+
| **type** | **String** | | [optional] |
|
|
3735
|
+
| **status** | **String** | | [optional] |
|
|
3282
3736
|
|
|
3283
3737
|
### Return type
|
|
3284
3738
|
|
|
3285
|
-
[**
|
|
3739
|
+
[**SfvbRedirectsResponse**](SfvbRedirectsResponse.md)
|
|
3286
3740
|
|
|
3287
3741
|
### Authorization
|
|
3288
3742
|
|
|
@@ -3780,6 +4234,114 @@ This endpoint does not need any parameter.
|
|
|
3780
4234
|
- **Accept**: application/json
|
|
3781
4235
|
|
|
3782
4236
|
|
|
4237
|
+
## ignore_sfvb_not_found_entry
|
|
4238
|
+
|
|
4239
|
+
> <SfvbNotFoundEntry> ignore_sfvb_not_found_entry(storefront_oid, not_found_id)
|
|
4240
|
+
|
|
4241
|
+
Ignore a 404 path
|
|
4242
|
+
|
|
4243
|
+
Hides one path from the list and stops counting its hits, for example scanner noise. Reversible.
|
|
4244
|
+
|
|
4245
|
+
|
|
4246
|
+
### Examples
|
|
4247
|
+
|
|
4248
|
+
|
|
4249
|
+
(No example for this operation).
|
|
4250
|
+
|
|
4251
|
+
|
|
4252
|
+
#### Using the ignore_sfvb_not_found_entry_with_http_info variant
|
|
4253
|
+
|
|
4254
|
+
This returns an Array which contains the response data, status code and headers.
|
|
4255
|
+
|
|
4256
|
+
> <Array(<SfvbNotFoundEntry>, Integer, Hash)> ignore_sfvb_not_found_entry_with_http_info(storefront_oid, not_found_id)
|
|
4257
|
+
|
|
4258
|
+
```ruby
|
|
4259
|
+
begin
|
|
4260
|
+
# Ignore a 404 path
|
|
4261
|
+
data, status_code, headers = api_instance.ignore_sfvb_not_found_entry_with_http_info(storefront_oid, not_found_id)
|
|
4262
|
+
p status_code # => 2xx
|
|
4263
|
+
p headers # => { ... }
|
|
4264
|
+
p data # => <SfvbNotFoundEntry>
|
|
4265
|
+
rescue UltracartClient::ApiError => e
|
|
4266
|
+
puts "Error when calling SfvbApi->ignore_sfvb_not_found_entry_with_http_info: #{e}"
|
|
4267
|
+
end
|
|
4268
|
+
```
|
|
4269
|
+
|
|
4270
|
+
### Parameters
|
|
4271
|
+
|
|
4272
|
+
| Name | Type | Description | Notes |
|
|
4273
|
+
| ---- | ---- | ----------- | ----- |
|
|
4274
|
+
| **storefront_oid** | **Integer** | | |
|
|
4275
|
+
| **not_found_id** | **String** | | |
|
|
4276
|
+
|
|
4277
|
+
### Return type
|
|
4278
|
+
|
|
4279
|
+
[**SfvbNotFoundEntry**](SfvbNotFoundEntry.md)
|
|
4280
|
+
|
|
4281
|
+
### Authorization
|
|
4282
|
+
|
|
4283
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
4284
|
+
|
|
4285
|
+
### HTTP request headers
|
|
4286
|
+
|
|
4287
|
+
- **Content-Type**: Not defined
|
|
4288
|
+
- **Accept**: application/json
|
|
4289
|
+
|
|
4290
|
+
|
|
4291
|
+
## import_sfvb_redirects
|
|
4292
|
+
|
|
4293
|
+
> <SfvbRedirectImportResponse> import_sfvb_redirects(storefront_oid, redirect_import_request)
|
|
4294
|
+
|
|
4295
|
+
Apply a reviewed redirect import
|
|
4296
|
+
|
|
4297
|
+
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.
|
|
4298
|
+
|
|
4299
|
+
|
|
4300
|
+
### Examples
|
|
4301
|
+
|
|
4302
|
+
|
|
4303
|
+
(No example for this operation).
|
|
4304
|
+
|
|
4305
|
+
|
|
4306
|
+
#### Using the import_sfvb_redirects_with_http_info variant
|
|
4307
|
+
|
|
4308
|
+
This returns an Array which contains the response data, status code and headers.
|
|
4309
|
+
|
|
4310
|
+
> <Array(<SfvbRedirectImportResponse>, Integer, Hash)> import_sfvb_redirects_with_http_info(storefront_oid, redirect_import_request)
|
|
4311
|
+
|
|
4312
|
+
```ruby
|
|
4313
|
+
begin
|
|
4314
|
+
# Apply a reviewed redirect import
|
|
4315
|
+
data, status_code, headers = api_instance.import_sfvb_redirects_with_http_info(storefront_oid, redirect_import_request)
|
|
4316
|
+
p status_code # => 2xx
|
|
4317
|
+
p headers # => { ... }
|
|
4318
|
+
p data # => <SfvbRedirectImportResponse>
|
|
4319
|
+
rescue UltracartClient::ApiError => e
|
|
4320
|
+
puts "Error when calling SfvbApi->import_sfvb_redirects_with_http_info: #{e}"
|
|
4321
|
+
end
|
|
4322
|
+
```
|
|
4323
|
+
|
|
4324
|
+
### Parameters
|
|
4325
|
+
|
|
4326
|
+
| Name | Type | Description | Notes |
|
|
4327
|
+
| ---- | ---- | ----------- | ----- |
|
|
4328
|
+
| **storefront_oid** | **Integer** | | |
|
|
4329
|
+
| **redirect_import_request** | [**SfvbRedirectImportRequest**](SfvbRedirectImportRequest.md) | The request | |
|
|
4330
|
+
|
|
4331
|
+
### Return type
|
|
4332
|
+
|
|
4333
|
+
[**SfvbRedirectImportResponse**](SfvbRedirectImportResponse.md)
|
|
4334
|
+
|
|
4335
|
+
### Authorization
|
|
4336
|
+
|
|
4337
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
4338
|
+
|
|
4339
|
+
### HTTP request headers
|
|
4340
|
+
|
|
4341
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
4342
|
+
- **Accept**: application/json
|
|
4343
|
+
|
|
4344
|
+
|
|
3783
4345
|
## insert_sfvb_blog_post
|
|
3784
4346
|
|
|
3785
4347
|
> <SfvbBlogPostDetail> insert_sfvb_blog_post(storefront_oid, blog_post_request)
|
|
@@ -3888,6 +4450,60 @@ end
|
|
|
3888
4450
|
- **Accept**: application/json
|
|
3889
4451
|
|
|
3890
4452
|
|
|
4453
|
+
## insert_sfvb_redirect
|
|
4454
|
+
|
|
4455
|
+
> <SfvbRedirectResponse> insert_sfvb_redirect(storefront_oid, redirect_request)
|
|
4456
|
+
|
|
4457
|
+
Create a 301 redirect rule
|
|
4458
|
+
|
|
4459
|
+
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.
|
|
4460
|
+
|
|
4461
|
+
|
|
4462
|
+
### Examples
|
|
4463
|
+
|
|
4464
|
+
|
|
4465
|
+
(No example for this operation).
|
|
4466
|
+
|
|
4467
|
+
|
|
4468
|
+
#### Using the insert_sfvb_redirect_with_http_info variant
|
|
4469
|
+
|
|
4470
|
+
This returns an Array which contains the response data, status code and headers.
|
|
4471
|
+
|
|
4472
|
+
> <Array(<SfvbRedirectResponse>, Integer, Hash)> insert_sfvb_redirect_with_http_info(storefront_oid, redirect_request)
|
|
4473
|
+
|
|
4474
|
+
```ruby
|
|
4475
|
+
begin
|
|
4476
|
+
# Create a 301 redirect rule
|
|
4477
|
+
data, status_code, headers = api_instance.insert_sfvb_redirect_with_http_info(storefront_oid, redirect_request)
|
|
4478
|
+
p status_code # => 2xx
|
|
4479
|
+
p headers # => { ... }
|
|
4480
|
+
p data # => <SfvbRedirectResponse>
|
|
4481
|
+
rescue UltracartClient::ApiError => e
|
|
4482
|
+
puts "Error when calling SfvbApi->insert_sfvb_redirect_with_http_info: #{e}"
|
|
4483
|
+
end
|
|
4484
|
+
```
|
|
4485
|
+
|
|
4486
|
+
### Parameters
|
|
4487
|
+
|
|
4488
|
+
| Name | Type | Description | Notes |
|
|
4489
|
+
| ---- | ---- | ----------- | ----- |
|
|
4490
|
+
| **storefront_oid** | **Integer** | | |
|
|
4491
|
+
| **redirect_request** | [**SfvbRedirectRequest**](SfvbRedirectRequest.md) | The request | |
|
|
4492
|
+
|
|
4493
|
+
### Return type
|
|
4494
|
+
|
|
4495
|
+
[**SfvbRedirectResponse**](SfvbRedirectResponse.md)
|
|
4496
|
+
|
|
4497
|
+
### Authorization
|
|
4498
|
+
|
|
4499
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
4500
|
+
|
|
4501
|
+
### HTTP request headers
|
|
4502
|
+
|
|
4503
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
4504
|
+
- **Accept**: application/json
|
|
4505
|
+
|
|
4506
|
+
|
|
3891
4507
|
## insert_sfvb_upsell_offer
|
|
3892
4508
|
|
|
3893
4509
|
> <SfvbUpsellOffer> insert_sfvb_upsell_offer(storefront_oid, upsell_offer)
|
|
@@ -6378,6 +6994,60 @@ end
|
|
|
6378
6994
|
- **Accept**: application/json
|
|
6379
6995
|
|
|
6380
6996
|
|
|
6997
|
+
## resolve_sfvb_redirect
|
|
6998
|
+
|
|
6999
|
+
> <SfvbRedirectResolveResponse> resolve_sfvb_redirect(storefront_oid, opts)
|
|
7000
|
+
|
|
7001
|
+
What a shopper gets for a path
|
|
7002
|
+
|
|
7003
|
+
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.
|
|
7004
|
+
|
|
7005
|
+
|
|
7006
|
+
### Examples
|
|
7007
|
+
|
|
7008
|
+
|
|
7009
|
+
(No example for this operation).
|
|
7010
|
+
|
|
7011
|
+
|
|
7012
|
+
#### Using the resolve_sfvb_redirect_with_http_info variant
|
|
7013
|
+
|
|
7014
|
+
This returns an Array which contains the response data, status code and headers.
|
|
7015
|
+
|
|
7016
|
+
> <Array(<SfvbRedirectResolveResponse>, Integer, Hash)> resolve_sfvb_redirect_with_http_info(storefront_oid, opts)
|
|
7017
|
+
|
|
7018
|
+
```ruby
|
|
7019
|
+
begin
|
|
7020
|
+
# What a shopper gets for a path
|
|
7021
|
+
data, status_code, headers = api_instance.resolve_sfvb_redirect_with_http_info(storefront_oid, opts)
|
|
7022
|
+
p status_code # => 2xx
|
|
7023
|
+
p headers # => { ... }
|
|
7024
|
+
p data # => <SfvbRedirectResolveResponse>
|
|
7025
|
+
rescue UltracartClient::ApiError => e
|
|
7026
|
+
puts "Error when calling SfvbApi->resolve_sfvb_redirect_with_http_info: #{e}"
|
|
7027
|
+
end
|
|
7028
|
+
```
|
|
7029
|
+
|
|
7030
|
+
### Parameters
|
|
7031
|
+
|
|
7032
|
+
| Name | Type | Description | Notes |
|
|
7033
|
+
| ---- | ---- | ----------- | ----- |
|
|
7034
|
+
| **storefront_oid** | **Integer** | | |
|
|
7035
|
+
| **path** | **String** | | [optional] |
|
|
7036
|
+
|
|
7037
|
+
### Return type
|
|
7038
|
+
|
|
7039
|
+
[**SfvbRedirectResolveResponse**](SfvbRedirectResolveResponse.md)
|
|
7040
|
+
|
|
7041
|
+
### Authorization
|
|
7042
|
+
|
|
7043
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
7044
|
+
|
|
7045
|
+
### HTTP request headers
|
|
7046
|
+
|
|
7047
|
+
- **Content-Type**: Not defined
|
|
7048
|
+
- **Accept**: application/json
|
|
7049
|
+
|
|
7050
|
+
|
|
6381
7051
|
## resolve_sfvb_template
|
|
6382
7052
|
|
|
6383
7053
|
> <SfvbTemplateResolveResponse> resolve_sfvb_template(storefront_oid, name, opts)
|
|
@@ -6930,6 +7600,60 @@ nil (empty response body)
|
|
|
6930
7600
|
- **Accept**: application/json
|
|
6931
7601
|
|
|
6932
7602
|
|
|
7603
|
+
## unignore_sfvb_not_found_entry
|
|
7604
|
+
|
|
7605
|
+
> <SfvbNotFoundEntry> unignore_sfvb_not_found_entry(storefront_oid, not_found_id)
|
|
7606
|
+
|
|
7607
|
+
Stop ignoring a 404 path
|
|
7608
|
+
|
|
7609
|
+
The path lists and counts hits again.
|
|
7610
|
+
|
|
7611
|
+
|
|
7612
|
+
### Examples
|
|
7613
|
+
|
|
7614
|
+
|
|
7615
|
+
(No example for this operation).
|
|
7616
|
+
|
|
7617
|
+
|
|
7618
|
+
#### Using the unignore_sfvb_not_found_entry_with_http_info variant
|
|
7619
|
+
|
|
7620
|
+
This returns an Array which contains the response data, status code and headers.
|
|
7621
|
+
|
|
7622
|
+
> <Array(<SfvbNotFoundEntry>, Integer, Hash)> unignore_sfvb_not_found_entry_with_http_info(storefront_oid, not_found_id)
|
|
7623
|
+
|
|
7624
|
+
```ruby
|
|
7625
|
+
begin
|
|
7626
|
+
# Stop ignoring a 404 path
|
|
7627
|
+
data, status_code, headers = api_instance.unignore_sfvb_not_found_entry_with_http_info(storefront_oid, not_found_id)
|
|
7628
|
+
p status_code # => 2xx
|
|
7629
|
+
p headers # => { ... }
|
|
7630
|
+
p data # => <SfvbNotFoundEntry>
|
|
7631
|
+
rescue UltracartClient::ApiError => e
|
|
7632
|
+
puts "Error when calling SfvbApi->unignore_sfvb_not_found_entry_with_http_info: #{e}"
|
|
7633
|
+
end
|
|
7634
|
+
```
|
|
7635
|
+
|
|
7636
|
+
### Parameters
|
|
7637
|
+
|
|
7638
|
+
| Name | Type | Description | Notes |
|
|
7639
|
+
| ---- | ---- | ----------- | ----- |
|
|
7640
|
+
| **storefront_oid** | **Integer** | | |
|
|
7641
|
+
| **not_found_id** | **String** | | |
|
|
7642
|
+
|
|
7643
|
+
### Return type
|
|
7644
|
+
|
|
7645
|
+
[**SfvbNotFoundEntry**](SfvbNotFoundEntry.md)
|
|
7646
|
+
|
|
7647
|
+
### Authorization
|
|
7648
|
+
|
|
7649
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
7650
|
+
|
|
7651
|
+
### HTTP request headers
|
|
7652
|
+
|
|
7653
|
+
- **Content-Type**: Not defined
|
|
7654
|
+
- **Accept**: application/json
|
|
7655
|
+
|
|
7656
|
+
|
|
6933
7657
|
## unpublish_sfvb_library_entry
|
|
6934
7658
|
|
|
6935
7659
|
> <SfvbLibraryEntry> unpublish_sfvb_library_entry(storefront_oid, library_oid, unpublish_request)
|
|
@@ -7151,6 +7875,62 @@ end
|
|
|
7151
7875
|
- **Accept**: application/json
|
|
7152
7876
|
|
|
7153
7877
|
|
|
7878
|
+
## update_sfvb_redirect
|
|
7879
|
+
|
|
7880
|
+
> <SfvbRedirectResponse> update_sfvb_redirect(storefront_oid, redirect_id, if_match, redirect_request)
|
|
7881
|
+
|
|
7882
|
+
Change a redirect rule
|
|
7883
|
+
|
|
7884
|
+
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.
|
|
7885
|
+
|
|
7886
|
+
|
|
7887
|
+
### Examples
|
|
7888
|
+
|
|
7889
|
+
|
|
7890
|
+
(No example for this operation).
|
|
7891
|
+
|
|
7892
|
+
|
|
7893
|
+
#### Using the update_sfvb_redirect_with_http_info variant
|
|
7894
|
+
|
|
7895
|
+
This returns an Array which contains the response data, status code and headers.
|
|
7896
|
+
|
|
7897
|
+
> <Array(<SfvbRedirectResponse>, Integer, Hash)> update_sfvb_redirect_with_http_info(storefront_oid, redirect_id, if_match, redirect_request)
|
|
7898
|
+
|
|
7899
|
+
```ruby
|
|
7900
|
+
begin
|
|
7901
|
+
# Change a redirect rule
|
|
7902
|
+
data, status_code, headers = api_instance.update_sfvb_redirect_with_http_info(storefront_oid, redirect_id, if_match, redirect_request)
|
|
7903
|
+
p status_code # => 2xx
|
|
7904
|
+
p headers # => { ... }
|
|
7905
|
+
p data # => <SfvbRedirectResponse>
|
|
7906
|
+
rescue UltracartClient::ApiError => e
|
|
7907
|
+
puts "Error when calling SfvbApi->update_sfvb_redirect_with_http_info: #{e}"
|
|
7908
|
+
end
|
|
7909
|
+
```
|
|
7910
|
+
|
|
7911
|
+
### Parameters
|
|
7912
|
+
|
|
7913
|
+
| Name | Type | Description | Notes |
|
|
7914
|
+
| ---- | ---- | ----------- | ----- |
|
|
7915
|
+
| **storefront_oid** | **Integer** | | |
|
|
7916
|
+
| **redirect_id** | **Integer** | | |
|
|
7917
|
+
| **if_match** | **String** | hash_sha256 from the last read. 428 when absent, 412 when stale. | |
|
|
7918
|
+
| **redirect_request** | [**SfvbRedirectRequest**](SfvbRedirectRequest.md) | The request | |
|
|
7919
|
+
|
|
7920
|
+
### Return type
|
|
7921
|
+
|
|
7922
|
+
[**SfvbRedirectResponse**](SfvbRedirectResponse.md)
|
|
7923
|
+
|
|
7924
|
+
### Authorization
|
|
7925
|
+
|
|
7926
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
7927
|
+
|
|
7928
|
+
### HTTP request headers
|
|
7929
|
+
|
|
7930
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
7931
|
+
- **Accept**: application/json
|
|
7932
|
+
|
|
7933
|
+
|
|
7154
7934
|
## update_sfvb_upsell_offer
|
|
7155
7935
|
|
|
7156
7936
|
> <SfvbUpsellOffer> update_sfvb_upsell_offer(storefront_oid, upsell_offer_oid, if_match, upsell_offer)
|