ultracart_api 4.1.183 → 4.1.185
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 +40 -2
- data/docs/AutoOrderApi.md +28 -1
- data/docs/OrderApi.md +107 -3
- data/docs/SfvbApi.md +941 -50
- data/docs/SfvbLibraryAiReview.md +28 -0
- data/docs/SfvbLibraryContentManifest.md +26 -0
- data/docs/SfvbLibraryDeleteResult.md +20 -0
- data/docs/SfvbLibraryEntry.md +28 -0
- data/docs/SfvbLibraryEntryRequest.md +30 -0
- data/docs/SfvbLibraryFacet.md +2 -2
- data/docs/SfvbLibraryHistoryEntry.md +24 -0
- data/docs/SfvbLibraryHistoryResponse.md +18 -0
- data/docs/SfvbLibraryInstallConflict.md +22 -0
- data/docs/SfvbLibraryInstallReceipt.md +32 -0
- data/docs/SfvbLibraryInstallRecord.md +32 -0
- data/docs/SfvbLibraryInstallRequest.md +22 -0
- data/docs/SfvbLibraryInstallsResponse.md +18 -0
- data/docs/SfvbLibraryParameter.md +26 -0
- data/docs/SfvbLibraryPublishRequest.md +20 -0
- data/docs/SfvbLibraryScreenshotRequest.md +22 -0
- data/docs/SfvbLibraryShareRequest.md +18 -0
- data/docs/SfvbLibraryShareTarget.md +20 -0
- data/docs/SfvbLibraryShareTargetsResponse.md +18 -0
- data/docs/SfvbLibraryTaxonomy.md +24 -0
- data/docs/SfvbLibraryTaxonomyCatalog.md +18 -0
- data/docs/SfvbLibraryUnshareResult.md +22 -0
- data/docs/SfvbWhoamiResponse.md +2 -0
- data/lib/ultracart_api/api/sfvb_api.rb +1334 -118
- data/lib/ultracart_api/models/sfvb_library_ai_review.rb +304 -0
- data/lib/ultracart_api/models/sfvb_library_content_manifest.rb +259 -0
- data/lib/ultracart_api/models/sfvb_library_delete_result.rb +264 -0
- data/lib/ultracart_api/models/sfvb_library_entry.rb +177 -1
- data/lib/ultracart_api/models/sfvb_library_entry_request.rb +280 -0
- data/lib/ultracart_api/models/sfvb_library_facet.rb +2 -2
- data/lib/ultracart_api/models/sfvb_library_history_entry.rb +250 -0
- data/lib/ultracart_api/models/sfvb_library_history_response.rb +222 -0
- data/lib/ultracart_api/models/sfvb_library_install_conflict.rb +240 -0
- data/lib/ultracart_api/models/sfvb_library_install_receipt.rb +297 -0
- data/lib/ultracart_api/models/sfvb_library_install_record.rb +290 -0
- data/lib/ultracart_api/models/sfvb_library_install_request.rb +274 -0
- data/lib/ultracart_api/models/sfvb_library_installs_response.rb +222 -0
- data/lib/ultracart_api/models/sfvb_library_parameter.rb +260 -0
- data/lib/ultracart_api/models/sfvb_library_publish_request.rb +264 -0
- data/lib/ultracart_api/models/sfvb_library_screenshot_request.rb +274 -0
- data/lib/ultracart_api/models/sfvb_library_share_request.rb +220 -0
- data/lib/ultracart_api/models/sfvb_library_share_target.rb +230 -0
- data/lib/ultracart_api/models/sfvb_library_share_targets_response.rb +222 -0
- data/lib/ultracart_api/models/sfvb_library_taxonomy.rb +258 -0
- data/lib/ultracart_api/models/sfvb_library_taxonomy_catalog.rb +220 -0
- data/lib/ultracart_api/models/sfvb_library_unshare_result.rb +242 -0
- data/lib/ultracart_api/models/sfvb_whoami_response.rb +11 -1
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +20 -0
- metadata +41 -1
data/docs/SfvbApi.md
CHANGED
|
@@ -8,24 +8,29 @@ 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
|
+
| [**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 |
|
|
11
12
|
| [**compile_sfvb_cjson**](SfvbApi.md#compile_sfvb_cjson) | **POST** /sfvb/cjson/compile | Compile CJSON to Velocity |
|
|
13
|
+
| [**create_sfvb_library_entry**](SfvbApi.md#create_sfvb_library_entry) | **POST** /sfvb/storefronts/{storefront_oid}/library | Save a fragment to the library |
|
|
12
14
|
| [**create_sfvb_preview_access**](SfvbApi.md#create_sfvb_preview_access) | **POST** /sfvb/storefronts/{storefront_oid}/preview_access | One time link that opens a preview in a browser with no UltraCart login |
|
|
13
15
|
| [**create_sfvb_preview_session**](SfvbApi.md#create_sfvb_preview_session) | **POST** /sfvb/storefronts/{storefront_oid}/preview_sessions | Create a preview session |
|
|
14
16
|
| [**delete_sfvb_blog_post**](SfvbApi.md#delete_sfvb_blog_post) | **DELETE** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid} | Delete a blog post |
|
|
15
17
|
| [**delete_sfvb_file**](SfvbApi.md#delete_sfvb_file) | **DELETE** /sfvb/storefronts/{storefront_oid}/files | Delete a storefront file |
|
|
16
18
|
| [**delete_sfvb_item_attribute**](SfvbApi.md#delete_sfvb_item_attribute) | **DELETE** /sfvb/storefronts/{storefront_oid}/items/attributes | Delete an attribute from an item |
|
|
17
19
|
| [**delete_sfvb_item_multimedia**](SfvbApi.md#delete_sfvb_item_multimedia) | **DELETE** /sfvb/storefronts/{storefront_oid}/items/multimedia | Detach an image from an item |
|
|
20
|
+
| [**delete_sfvb_library_entry**](SfvbApi.md#delete_sfvb_library_entry) | **DELETE** /sfvb/storefronts/{storefront_oid}/library/{library_oid} | Delete or retire a library entry |
|
|
18
21
|
| [**delete_sfvb_page_multimedia**](SfvbApi.md#delete_sfvb_page_multimedia) | **DELETE** /sfvb/storefronts/{storefront_oid}/pages/multimedia | Detach an image from a page |
|
|
19
22
|
| [**delete_sfvb_preview_session**](SfvbApi.md#delete_sfvb_preview_session) | **DELETE** /sfvb/storefronts/{storefront_oid}/preview_sessions/{preview_session_id} | Delete a preview session |
|
|
20
23
|
| [**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 |
|
|
21
24
|
| [**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 |
|
|
22
25
|
| [**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 |
|
|
23
26
|
| [**download_sfvb_file**](SfvbApi.md#download_sfvb_file) | **GET** /sfvb/storefronts/{storefront_oid}/files/download | Read a storefront file's raw bytes |
|
|
27
|
+
| [**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 |
|
|
24
28
|
| [**duplicate_sfvb_page**](SfvbApi.md#duplicate_sfvb_page) | **POST** /sfvb/storefronts/{storefront_oid}/pages/duplicate | Copy a page to a new path |
|
|
25
29
|
| [**duplicate_sfvb_theme**](SfvbApi.md#duplicate_sfvb_theme) | **POST** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/duplicate | Duplicate a theme |
|
|
26
30
|
| [**duplicate_sfvb_upsell_offer**](SfvbApi.md#duplicate_sfvb_upsell_offer) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_offers/{upsell_offer_oid}/duplicate | Duplicate an upsell offer |
|
|
27
31
|
| [**duplicate_sfvb_upsell_path**](SfvbApi.md#duplicate_sfvb_upsell_path) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid}/duplicate | Duplicate an upsell path or one of its variations |
|
|
28
32
|
| [**end_sfvb_experiment**](SfvbApi.md#end_sfvb_experiment) | **POST** /sfvb/storefronts/{storefront_oid}/experiments/{experiment_oid}/end | End an experiment |
|
|
33
|
+
| [**favorite_sfvb_library_entry**](SfvbApi.md#favorite_sfvb_library_entry) | **PUT** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/favorite | Favorite a library entry |
|
|
29
34
|
| [**get_sfvb_blog_post**](SfvbApi.md#get_sfvb_blog_post) | **GET** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid} | Read a blog post |
|
|
30
35
|
| [**get_sfvb_cjson_used_elements**](SfvbApi.md#get_sfvb_cjson_used_elements) | **POST** /sfvb/cjson/elements | Element types used by a container |
|
|
31
36
|
| [**get_sfvb_container**](SfvbApi.md#get_sfvb_container) | **GET** /sfvb/storefronts/{storefront_oid}/containers/{owner_type}/{owner_object_id} | Read a container stored outside the file system |
|
|
@@ -37,6 +42,9 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
37
42
|
| [**get_sfvb_file_upload_url**](SfvbApi.md#get_sfvb_file_upload_url) | **GET** /sfvb/storefronts/{storefront_oid}/files/upload_url/{extension} | Get a URL to upload a binary asset to |
|
|
38
43
|
| [**get_sfvb_item**](SfvbApi.md#get_sfvb_item) | **GET** /sfvb/storefronts/{storefront_oid}/items | Read an item's storefront facing content |
|
|
39
44
|
| [**get_sfvb_library_entry**](SfvbApi.md#get_sfvb_library_entry) | **GET** /sfvb/storefronts/{storefront_oid}/library/{library_oid} | Read one library entry including its CJSON |
|
|
45
|
+
| [**get_sfvb_library_history**](SfvbApi.md#get_sfvb_library_history) | **GET** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/history | List a library entry's published revisions |
|
|
46
|
+
| [**get_sfvb_library_share_targets**](SfvbApi.md#get_sfvb_library_share_targets) | **GET** /sfvb/storefronts/{storefront_oid}/library/share_targets | List the accounts a library entry can be shared with |
|
|
47
|
+
| [**get_sfvb_library_taxonomy**](SfvbApi.md#get_sfvb_library_taxonomy) | **GET** /sfvb/storefronts/{storefront_oid}/library/taxonomy | List the allowed library tags |
|
|
40
48
|
| [**get_sfvb_menu**](SfvbApi.md#get_sfvb_menu) | **GET** /sfvb/storefronts/{storefront_oid}/menus/{code} | Read one store menu and its entries |
|
|
41
49
|
| [**get_sfvb_menus**](SfvbApi.md#get_sfvb_menus) | **GET** /sfvb/storefronts/{storefront_oid}/menus | List a storefront's store menus |
|
|
42
50
|
| [**get_sfvb_page**](SfvbApi.md#get_sfvb_page) | **GET** /sfvb/storefronts/{storefront_oid}/pages | Read a page's attributes and images |
|
|
@@ -68,6 +76,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
68
76
|
| [**list_sfvb_file_versions**](SfvbApi.md#list_sfvb_file_versions) | **GET** /sfvb/storefronts/{storefront_oid}/files/versions | Version history for a storefront file |
|
|
69
77
|
| [**list_sfvb_files**](SfvbApi.md#list_sfvb_files) | **GET** /sfvb/storefronts/{storefront_oid}/files | List a storefront directory |
|
|
70
78
|
| [**list_sfvb_item_containers**](SfvbApi.md#list_sfvb_item_containers) | **GET** /sfvb/storefronts/{storefront_oid}/item_containers | List the item containers on the account |
|
|
79
|
+
| [**list_sfvb_library_installs**](SfvbApi.md#list_sfvb_library_installs) | **GET** /sfvb/storefronts/{storefront_oid}/library/installs | List the library entries installed on a storefront |
|
|
71
80
|
| [**list_sfvb_pages**](SfvbApi.md#list_sfvb_pages) | **GET** /sfvb/storefronts/{storefront_oid}/pages/list | List the storefront's pages |
|
|
72
81
|
| [**list_sfvb_server_logs**](SfvbApi.md#list_sfvb_server_logs) | **GET** /sfvb/storefronts/{storefront_oid}/logs | List recent storefront render logs |
|
|
73
82
|
| [**list_sfvb_storefronts**](SfvbApi.md#list_sfvb_storefronts) | **GET** /sfvb/storefronts | List storefronts |
|
|
@@ -76,6 +85,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
76
85
|
| [**list_sfvb_upsell_offers**](SfvbApi.md#list_sfvb_upsell_offers) | **GET** /sfvb/storefronts/{storefront_oid}/upsell_offers | List upsell offers |
|
|
77
86
|
| [**list_sfvb_upsell_paths**](SfvbApi.md#list_sfvb_upsell_paths) | **GET** /sfvb/storefronts/{storefront_oid}/upsell_paths | List upsell paths |
|
|
78
87
|
| [**move_sfvb_upsell_path**](SfvbApi.md#move_sfvb_upsell_path) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid}/move | Move an upsell path |
|
|
88
|
+
| [**publish_sfvb_library_entry**](SfvbApi.md#publish_sfvb_library_entry) | **POST** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/publish | Publish a library entry's draft |
|
|
79
89
|
| [**put_sfvb_container**](SfvbApi.md#put_sfvb_container) | **PUT** /sfvb/storefronts/{storefront_oid}/containers/{owner_type}/{owner_object_id} | Write a container stored outside the file system |
|
|
80
90
|
| [**put_sfvb_experiment_variation**](SfvbApi.md#put_sfvb_experiment_variation) | **PUT** /sfvb/storefronts/{storefront_oid}/experiments/{experiment_oid}/variations/{variation_number} | Pause or resume a variation |
|
|
81
91
|
| [**put_sfvb_file_content**](SfvbApi.md#put_sfvb_file_content) | **PUT** /sfvb/storefronts/{storefront_oid}/files/content | Write a storefront file |
|
|
@@ -102,9 +112,15 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
102
112
|
| [**revert_sfvb_file**](SfvbApi.md#revert_sfvb_file) | **POST** /sfvb/storefronts/{storefront_oid}/files/revert | Revert a storefront file to an earlier version |
|
|
103
113
|
| [**search_sfvb_files**](SfvbApi.md#search_sfvb_files) | **POST** /sfvb/storefronts/{storefront_oid}/files/search | Search storefront files |
|
|
104
114
|
| [**search_sfvb_library**](SfvbApi.md#search_sfvb_library) | **GET** /sfvb/storefronts/{storefront_oid}/library | Search the element library |
|
|
115
|
+
| [**set_sfvb_library_screenshot**](SfvbApi.md#set_sfvb_library_screenshot) | **PUT** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/screenshot | Set a library entry's screenshot |
|
|
116
|
+
| [**share_sfvb_library_entry**](SfvbApi.md#share_sfvb_library_entry) | **POST** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/shares | Share a published library entry with a linked account |
|
|
105
117
|
| [**start_sfvb_experiment**](SfvbApi.md#start_sfvb_experiment) | **POST** /sfvb/storefronts/{storefront_oid}/experiments | Start an experiment |
|
|
106
118
|
| [**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 |
|
|
119
|
+
| [**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 |
|
|
120
|
+
| [**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 |
|
|
121
|
+
| [**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 |
|
|
107
122
|
| [**update_sfvb_blog_post**](SfvbApi.md#update_sfvb_blog_post) | **PUT** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid} | Change a blog post |
|
|
123
|
+
| [**update_sfvb_library_entry**](SfvbApi.md#update_sfvb_library_entry) | **PUT** /sfvb/storefronts/{storefront_oid}/library/{library_oid} | Update a library entry's draft |
|
|
108
124
|
| [**update_sfvb_upsell_offer**](SfvbApi.md#update_sfvb_upsell_offer) | **PUT** /sfvb/storefronts/{storefront_oid}/upsell_offers/{upsell_offer_oid} | Update an upsell offer |
|
|
109
125
|
| [**update_sfvb_upsell_path**](SfvbApi.md#update_sfvb_upsell_path) | **PUT** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid} | Update an upsell path |
|
|
110
126
|
| [**upload_sfvb_file**](SfvbApi.md#upload_sfvb_file) | **POST** /sfvb/storefronts/{storefront_oid}/files/upload | Store a binary asset that was already uploaded |
|
|
@@ -331,6 +347,61 @@ end
|
|
|
331
347
|
- **Accept**: application/json
|
|
332
348
|
|
|
333
349
|
|
|
350
|
+
## clear_sfvb_library_screenshot
|
|
351
|
+
|
|
352
|
+
> <SfvbLibraryEntry> clear_sfvb_library_screenshot(storefront_oid, library_oid, if_match)
|
|
353
|
+
|
|
354
|
+
Remove a library entry's screenshot
|
|
355
|
+
|
|
356
|
+
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.
|
|
357
|
+
|
|
358
|
+
|
|
359
|
+
### Examples
|
|
360
|
+
|
|
361
|
+
|
|
362
|
+
(No example for this operation).
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
#### Using the clear_sfvb_library_screenshot_with_http_info variant
|
|
366
|
+
|
|
367
|
+
This returns an Array which contains the response data, status code and headers.
|
|
368
|
+
|
|
369
|
+
> <Array(<SfvbLibraryEntry>, Integer, Hash)> clear_sfvb_library_screenshot_with_http_info(storefront_oid, library_oid, if_match)
|
|
370
|
+
|
|
371
|
+
```ruby
|
|
372
|
+
begin
|
|
373
|
+
# Remove a library entry's screenshot
|
|
374
|
+
data, status_code, headers = api_instance.clear_sfvb_library_screenshot_with_http_info(storefront_oid, library_oid, if_match)
|
|
375
|
+
p status_code # => 2xx
|
|
376
|
+
p headers # => { ... }
|
|
377
|
+
p data # => <SfvbLibraryEntry>
|
|
378
|
+
rescue UltracartClient::ApiError => e
|
|
379
|
+
puts "Error when calling SfvbApi->clear_sfvb_library_screenshot_with_http_info: #{e}"
|
|
380
|
+
end
|
|
381
|
+
```
|
|
382
|
+
|
|
383
|
+
### Parameters
|
|
384
|
+
|
|
385
|
+
| Name | Type | Description | Notes |
|
|
386
|
+
| ---- | ---- | ----------- | ----- |
|
|
387
|
+
| **storefront_oid** | **Integer** | | |
|
|
388
|
+
| **library_oid** | **Integer** | | |
|
|
389
|
+
| **if_match** | **String** | hash_sha256 from the last read. Required; 428 when absent, 412 when stale. | |
|
|
390
|
+
|
|
391
|
+
### Return type
|
|
392
|
+
|
|
393
|
+
[**SfvbLibraryEntry**](SfvbLibraryEntry.md)
|
|
394
|
+
|
|
395
|
+
### Authorization
|
|
396
|
+
|
|
397
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
398
|
+
|
|
399
|
+
### HTTP request headers
|
|
400
|
+
|
|
401
|
+
- **Content-Type**: Not defined
|
|
402
|
+
- **Accept**: application/json
|
|
403
|
+
|
|
404
|
+
|
|
334
405
|
## compile_sfvb_cjson
|
|
335
406
|
|
|
336
407
|
> <SfvbCompileResponse> compile_sfvb_cjson(compile_request)
|
|
@@ -384,6 +455,60 @@ end
|
|
|
384
455
|
- **Accept**: application/json
|
|
385
456
|
|
|
386
457
|
|
|
458
|
+
## create_sfvb_library_entry
|
|
459
|
+
|
|
460
|
+
> <SfvbLibraryEntry> create_sfvb_library_entry(storefront_oid, library_entry)
|
|
461
|
+
|
|
462
|
+
Save a fragment to the library
|
|
463
|
+
|
|
464
|
+
Creates a private draft owned by the calling user. The fragment is one widget and its children, and it must validate. Images it references on this storefront are copied into the entry before this returns, so it installs anywhere with its images. The fragment is scanned; card skimming or obfuscation signals are refused outright. Nothing other merchants or shoppers see changes, so sfvb_write is enough. Publish it to share it. An optional screenshot takes a staged PNG key, exactly as the library screenshot endpoint does; a refused screenshot refuses the whole create.
|
|
465
|
+
|
|
466
|
+
|
|
467
|
+
### Examples
|
|
468
|
+
|
|
469
|
+
|
|
470
|
+
(No example for this operation).
|
|
471
|
+
|
|
472
|
+
|
|
473
|
+
#### Using the create_sfvb_library_entry_with_http_info variant
|
|
474
|
+
|
|
475
|
+
This returns an Array which contains the response data, status code and headers.
|
|
476
|
+
|
|
477
|
+
> <Array(<SfvbLibraryEntry>, Integer, Hash)> create_sfvb_library_entry_with_http_info(storefront_oid, library_entry)
|
|
478
|
+
|
|
479
|
+
```ruby
|
|
480
|
+
begin
|
|
481
|
+
# Save a fragment to the library
|
|
482
|
+
data, status_code, headers = api_instance.create_sfvb_library_entry_with_http_info(storefront_oid, library_entry)
|
|
483
|
+
p status_code # => 2xx
|
|
484
|
+
p headers # => { ... }
|
|
485
|
+
p data # => <SfvbLibraryEntry>
|
|
486
|
+
rescue UltracartClient::ApiError => e
|
|
487
|
+
puts "Error when calling SfvbApi->create_sfvb_library_entry_with_http_info: #{e}"
|
|
488
|
+
end
|
|
489
|
+
```
|
|
490
|
+
|
|
491
|
+
### Parameters
|
|
492
|
+
|
|
493
|
+
| Name | Type | Description | Notes |
|
|
494
|
+
| ---- | ---- | ----------- | ----- |
|
|
495
|
+
| **storefront_oid** | **Integer** | | |
|
|
496
|
+
| **library_entry** | [**SfvbLibraryEntryRequest**](SfvbLibraryEntryRequest.md) | The entry | |
|
|
497
|
+
|
|
498
|
+
### Return type
|
|
499
|
+
|
|
500
|
+
[**SfvbLibraryEntry**](SfvbLibraryEntry.md)
|
|
501
|
+
|
|
502
|
+
### Authorization
|
|
503
|
+
|
|
504
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
505
|
+
|
|
506
|
+
### HTTP request headers
|
|
507
|
+
|
|
508
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
509
|
+
- **Accept**: application/json
|
|
510
|
+
|
|
511
|
+
|
|
387
512
|
## create_sfvb_preview_access
|
|
388
513
|
|
|
389
514
|
> <SfvbPreviewAccessResponse> create_sfvb_preview_access(storefront_oid, opts)
|
|
@@ -713,6 +838,61 @@ end
|
|
|
713
838
|
- **Accept**: application/json
|
|
714
839
|
|
|
715
840
|
|
|
841
|
+
## delete_sfvb_library_entry
|
|
842
|
+
|
|
843
|
+
> <SfvbLibraryDeleteResult> delete_sfvb_library_entry(storefront_oid, library_oid, if_match)
|
|
844
|
+
|
|
845
|
+
Delete or retire a library entry
|
|
846
|
+
|
|
847
|
+
Owner only, with the draft's hash_sha256 as If-Match. An entry that was never published, installed or shared is deleted. Anything else is retired - kept so the storefronts that installed it still resolve, but out of search and refusing new installs and publishes. The result says which happened.
|
|
848
|
+
|
|
849
|
+
|
|
850
|
+
### Examples
|
|
851
|
+
|
|
852
|
+
|
|
853
|
+
(No example for this operation).
|
|
854
|
+
|
|
855
|
+
|
|
856
|
+
#### Using the delete_sfvb_library_entry_with_http_info variant
|
|
857
|
+
|
|
858
|
+
This returns an Array which contains the response data, status code and headers.
|
|
859
|
+
|
|
860
|
+
> <Array(<SfvbLibraryDeleteResult>, Integer, Hash)> delete_sfvb_library_entry_with_http_info(storefront_oid, library_oid, if_match)
|
|
861
|
+
|
|
862
|
+
```ruby
|
|
863
|
+
begin
|
|
864
|
+
# Delete or retire a library entry
|
|
865
|
+
data, status_code, headers = api_instance.delete_sfvb_library_entry_with_http_info(storefront_oid, library_oid, if_match)
|
|
866
|
+
p status_code # => 2xx
|
|
867
|
+
p headers # => { ... }
|
|
868
|
+
p data # => <SfvbLibraryDeleteResult>
|
|
869
|
+
rescue UltracartClient::ApiError => e
|
|
870
|
+
puts "Error when calling SfvbApi->delete_sfvb_library_entry_with_http_info: #{e}"
|
|
871
|
+
end
|
|
872
|
+
```
|
|
873
|
+
|
|
874
|
+
### Parameters
|
|
875
|
+
|
|
876
|
+
| Name | Type | Description | Notes |
|
|
877
|
+
| ---- | ---- | ----------- | ----- |
|
|
878
|
+
| **storefront_oid** | **Integer** | | |
|
|
879
|
+
| **library_oid** | **Integer** | | |
|
|
880
|
+
| **if_match** | **String** | hash_sha256 from the last read. Required; 428 when absent, 412 when stale. | |
|
|
881
|
+
|
|
882
|
+
### Return type
|
|
883
|
+
|
|
884
|
+
[**SfvbLibraryDeleteResult**](SfvbLibraryDeleteResult.md)
|
|
885
|
+
|
|
886
|
+
### Authorization
|
|
887
|
+
|
|
888
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
889
|
+
|
|
890
|
+
### HTTP request headers
|
|
891
|
+
|
|
892
|
+
- **Content-Type**: Not defined
|
|
893
|
+
- **Accept**: application/json
|
|
894
|
+
|
|
895
|
+
|
|
716
896
|
## delete_sfvb_page_multimedia
|
|
717
897
|
|
|
718
898
|
> <SfvbPageResponse> delete_sfvb_page_multimedia(storefront_oid, path, opts)
|
|
@@ -1040,6 +1220,61 @@ nil (empty response body)
|
|
|
1040
1220
|
- **Accept**: application/octet-stream
|
|
1041
1221
|
|
|
1042
1222
|
|
|
1223
|
+
## duplicate_sfvb_library_entry
|
|
1224
|
+
|
|
1225
|
+
> <SfvbLibraryEntry> duplicate_sfvb_library_entry(storefront_oid, library_oid, opts)
|
|
1226
|
+
|
|
1227
|
+
Copy a library entry into a new private entry
|
|
1228
|
+
|
|
1229
|
+
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.
|
|
1230
|
+
|
|
1231
|
+
|
|
1232
|
+
### Examples
|
|
1233
|
+
|
|
1234
|
+
|
|
1235
|
+
(No example for this operation).
|
|
1236
|
+
|
|
1237
|
+
|
|
1238
|
+
#### Using the duplicate_sfvb_library_entry_with_http_info variant
|
|
1239
|
+
|
|
1240
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1241
|
+
|
|
1242
|
+
> <Array(<SfvbLibraryEntry>, Integer, Hash)> duplicate_sfvb_library_entry_with_http_info(storefront_oid, library_oid, opts)
|
|
1243
|
+
|
|
1244
|
+
```ruby
|
|
1245
|
+
begin
|
|
1246
|
+
# Copy a library entry into a new private entry
|
|
1247
|
+
data, status_code, headers = api_instance.duplicate_sfvb_library_entry_with_http_info(storefront_oid, library_oid, opts)
|
|
1248
|
+
p status_code # => 2xx
|
|
1249
|
+
p headers # => { ... }
|
|
1250
|
+
p data # => <SfvbLibraryEntry>
|
|
1251
|
+
rescue UltracartClient::ApiError => e
|
|
1252
|
+
puts "Error when calling SfvbApi->duplicate_sfvb_library_entry_with_http_info: #{e}"
|
|
1253
|
+
end
|
|
1254
|
+
```
|
|
1255
|
+
|
|
1256
|
+
### Parameters
|
|
1257
|
+
|
|
1258
|
+
| Name | Type | Description | Notes |
|
|
1259
|
+
| ---- | ---- | ----------- | ----- |
|
|
1260
|
+
| **storefront_oid** | **Integer** | | |
|
|
1261
|
+
| **library_oid** | **Integer** | | |
|
|
1262
|
+
| **name** | **String** | Name for the copy. Defaults to Copy of and the source name. | [optional] |
|
|
1263
|
+
|
|
1264
|
+
### Return type
|
|
1265
|
+
|
|
1266
|
+
[**SfvbLibraryEntry**](SfvbLibraryEntry.md)
|
|
1267
|
+
|
|
1268
|
+
### Authorization
|
|
1269
|
+
|
|
1270
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
1271
|
+
|
|
1272
|
+
### HTTP request headers
|
|
1273
|
+
|
|
1274
|
+
- **Content-Type**: Not defined
|
|
1275
|
+
- **Accept**: application/json
|
|
1276
|
+
|
|
1277
|
+
|
|
1043
1278
|
## duplicate_sfvb_page
|
|
1044
1279
|
|
|
1045
1280
|
> <SfvbPageResponse> duplicate_sfvb_page(storefront_oid, page_duplicate_request)
|
|
@@ -1313,6 +1548,60 @@ end
|
|
|
1313
1548
|
- **Accept**: application/json
|
|
1314
1549
|
|
|
1315
1550
|
|
|
1551
|
+
## favorite_sfvb_library_entry
|
|
1552
|
+
|
|
1553
|
+
> favorite_sfvb_library_entry(storefront_oid, library_oid)
|
|
1554
|
+
|
|
1555
|
+
Favorite a library entry
|
|
1556
|
+
|
|
1557
|
+
Bookmarks the entry for the calling user. Idempotent. Owner or anyone the entry is shared with.
|
|
1558
|
+
|
|
1559
|
+
|
|
1560
|
+
### Examples
|
|
1561
|
+
|
|
1562
|
+
|
|
1563
|
+
(No example for this operation).
|
|
1564
|
+
|
|
1565
|
+
|
|
1566
|
+
#### Using the favorite_sfvb_library_entry_with_http_info variant
|
|
1567
|
+
|
|
1568
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
1569
|
+
|
|
1570
|
+
> <Array(nil, Integer, Hash)> favorite_sfvb_library_entry_with_http_info(storefront_oid, library_oid)
|
|
1571
|
+
|
|
1572
|
+
```ruby
|
|
1573
|
+
begin
|
|
1574
|
+
# Favorite a library entry
|
|
1575
|
+
data, status_code, headers = api_instance.favorite_sfvb_library_entry_with_http_info(storefront_oid, library_oid)
|
|
1576
|
+
p status_code # => 2xx
|
|
1577
|
+
p headers # => { ... }
|
|
1578
|
+
p data # => nil
|
|
1579
|
+
rescue UltracartClient::ApiError => e
|
|
1580
|
+
puts "Error when calling SfvbApi->favorite_sfvb_library_entry_with_http_info: #{e}"
|
|
1581
|
+
end
|
|
1582
|
+
```
|
|
1583
|
+
|
|
1584
|
+
### Parameters
|
|
1585
|
+
|
|
1586
|
+
| Name | Type | Description | Notes |
|
|
1587
|
+
| ---- | ---- | ----------- | ----- |
|
|
1588
|
+
| **storefront_oid** | **Integer** | | |
|
|
1589
|
+
| **library_oid** | **Integer** | | |
|
|
1590
|
+
|
|
1591
|
+
### Return type
|
|
1592
|
+
|
|
1593
|
+
nil (empty response body)
|
|
1594
|
+
|
|
1595
|
+
### Authorization
|
|
1596
|
+
|
|
1597
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
1598
|
+
|
|
1599
|
+
### HTTP request headers
|
|
1600
|
+
|
|
1601
|
+
- **Content-Type**: Not defined
|
|
1602
|
+
- **Accept**: application/json
|
|
1603
|
+
|
|
1604
|
+
|
|
1316
1605
|
## get_sfvb_blog_post
|
|
1317
1606
|
|
|
1318
1607
|
> <SfvbBlogPostDetail> get_sfvb_blog_post(storefront_oid, blog_post_oid)
|
|
@@ -1858,11 +2147,11 @@ end
|
|
|
1858
2147
|
|
|
1859
2148
|
## get_sfvb_library_entry
|
|
1860
2149
|
|
|
1861
|
-
> <SfvbLibraryEntry> get_sfvb_library_entry(storefront_oid, library_oid)
|
|
2150
|
+
> <SfvbLibraryEntry> get_sfvb_library_entry(storefront_oid, library_oid, opts)
|
|
1862
2151
|
|
|
1863
2152
|
Read one library entry including its CJSON
|
|
1864
2153
|
|
|
1865
|
-
|
|
2154
|
+
The owner gets the draft with its hash_sha256, which an update, delete or publish sends back as If-Match. Everyone else gets the latest published revision. Pin a published revision with revision_number. Read content_manifest before installing. If the fragment references images or other storefront files those paths will not resolve on this storefront until the entry is installed, so use install rather than this when the intent is to place the fragment.
|
|
1866
2155
|
|
|
1867
2156
|
|
|
1868
2157
|
### Examples
|
|
@@ -1875,12 +2164,12 @@ Returns the fragment as authored. If it references images or other storefront f
|
|
|
1875
2164
|
|
|
1876
2165
|
This returns an Array which contains the response data, status code and headers.
|
|
1877
2166
|
|
|
1878
|
-
> <Array(<SfvbLibraryEntry>, Integer, Hash)> get_sfvb_library_entry_with_http_info(storefront_oid, library_oid)
|
|
2167
|
+
> <Array(<SfvbLibraryEntry>, Integer, Hash)> get_sfvb_library_entry_with_http_info(storefront_oid, library_oid, opts)
|
|
1879
2168
|
|
|
1880
2169
|
```ruby
|
|
1881
2170
|
begin
|
|
1882
2171
|
# Read one library entry including its CJSON
|
|
1883
|
-
data, status_code, headers = api_instance.get_sfvb_library_entry_with_http_info(storefront_oid, library_oid)
|
|
2172
|
+
data, status_code, headers = api_instance.get_sfvb_library_entry_with_http_info(storefront_oid, library_oid, opts)
|
|
1884
2173
|
p status_code # => 2xx
|
|
1885
2174
|
p headers # => { ... }
|
|
1886
2175
|
p data # => <SfvbLibraryEntry>
|
|
@@ -1895,6 +2184,7 @@ end
|
|
|
1895
2184
|
| ---- | ---- | ----------- | ----- |
|
|
1896
2185
|
| **storefront_oid** | **Integer** | | |
|
|
1897
2186
|
| **library_oid** | **Integer** | | |
|
|
2187
|
+
| **revision_number** | **Integer** | A published revision to read instead of the default. | [optional] |
|
|
1898
2188
|
|
|
1899
2189
|
### Return type
|
|
1900
2190
|
|
|
@@ -1910,13 +2200,13 @@ end
|
|
|
1910
2200
|
- **Accept**: application/json
|
|
1911
2201
|
|
|
1912
2202
|
|
|
1913
|
-
##
|
|
2203
|
+
## get_sfvb_library_history
|
|
1914
2204
|
|
|
1915
|
-
> <
|
|
2205
|
+
> <SfvbLibraryHistoryResponse> get_sfvb_library_history(storefront_oid, library_oid)
|
|
1916
2206
|
|
|
1917
|
-
|
|
2207
|
+
List a library entry's published revisions
|
|
1918
2208
|
|
|
1919
|
-
|
|
2209
|
+
Newest first, each with its release notes and hash. Read one with getSfvbLibraryEntry and revision_number. The owner and anyone the entry is shared with can list it.
|
|
1920
2210
|
|
|
1921
2211
|
|
|
1922
2212
|
### Examples
|
|
@@ -1925,21 +2215,21 @@ The whole tree, in render order. Page entries carry the page_path they resolve
|
|
|
1925
2215
|
(No example for this operation).
|
|
1926
2216
|
|
|
1927
2217
|
|
|
1928
|
-
#### Using the
|
|
2218
|
+
#### Using the get_sfvb_library_history_with_http_info variant
|
|
1929
2219
|
|
|
1930
2220
|
This returns an Array which contains the response data, status code and headers.
|
|
1931
2221
|
|
|
1932
|
-
> <Array(<
|
|
2222
|
+
> <Array(<SfvbLibraryHistoryResponse>, Integer, Hash)> get_sfvb_library_history_with_http_info(storefront_oid, library_oid)
|
|
1933
2223
|
|
|
1934
2224
|
```ruby
|
|
1935
2225
|
begin
|
|
1936
|
-
#
|
|
1937
|
-
data, status_code, headers = api_instance.
|
|
2226
|
+
# List a library entry's published revisions
|
|
2227
|
+
data, status_code, headers = api_instance.get_sfvb_library_history_with_http_info(storefront_oid, library_oid)
|
|
1938
2228
|
p status_code # => 2xx
|
|
1939
2229
|
p headers # => { ... }
|
|
1940
|
-
p data # => <
|
|
2230
|
+
p data # => <SfvbLibraryHistoryResponse>
|
|
1941
2231
|
rescue UltracartClient::ApiError => e
|
|
1942
|
-
puts "Error when calling SfvbApi->
|
|
2232
|
+
puts "Error when calling SfvbApi->get_sfvb_library_history_with_http_info: #{e}"
|
|
1943
2233
|
end
|
|
1944
2234
|
```
|
|
1945
2235
|
|
|
@@ -1948,11 +2238,11 @@ end
|
|
|
1948
2238
|
| Name | Type | Description | Notes |
|
|
1949
2239
|
| ---- | ---- | ----------- | ----- |
|
|
1950
2240
|
| **storefront_oid** | **Integer** | | |
|
|
1951
|
-
| **
|
|
2241
|
+
| **library_oid** | **Integer** | | |
|
|
1952
2242
|
|
|
1953
2243
|
### Return type
|
|
1954
2244
|
|
|
1955
|
-
[**
|
|
2245
|
+
[**SfvbLibraryHistoryResponse**](SfvbLibraryHistoryResponse.md)
|
|
1956
2246
|
|
|
1957
2247
|
### Authorization
|
|
1958
2248
|
|
|
@@ -1964,13 +2254,13 @@ end
|
|
|
1964
2254
|
- **Accept**: application/json
|
|
1965
2255
|
|
|
1966
2256
|
|
|
1967
|
-
##
|
|
2257
|
+
## get_sfvb_library_share_targets
|
|
1968
2258
|
|
|
1969
|
-
> <
|
|
2259
|
+
> <SfvbLibraryShareTargetsResponse> get_sfvb_library_share_targets(storefront_oid)
|
|
1970
2260
|
|
|
1971
|
-
List a
|
|
2261
|
+
List the accounts a library entry can be shared with
|
|
1972
2262
|
|
|
1973
|
-
The
|
|
2263
|
+
The calling account's linked accounts, each with its merchant id and company. These are the only merchants a share can name.
|
|
1974
2264
|
|
|
1975
2265
|
|
|
1976
2266
|
### Examples
|
|
@@ -1979,21 +2269,21 @@ The menus a menu element's menuName can name, sorted by code and without their e
|
|
|
1979
2269
|
(No example for this operation).
|
|
1980
2270
|
|
|
1981
2271
|
|
|
1982
|
-
#### Using the
|
|
2272
|
+
#### Using the get_sfvb_library_share_targets_with_http_info variant
|
|
1983
2273
|
|
|
1984
2274
|
This returns an Array which contains the response data, status code and headers.
|
|
1985
2275
|
|
|
1986
|
-
> <Array(<
|
|
2276
|
+
> <Array(<SfvbLibraryShareTargetsResponse>, Integer, Hash)> get_sfvb_library_share_targets_with_http_info(storefront_oid)
|
|
1987
2277
|
|
|
1988
2278
|
```ruby
|
|
1989
2279
|
begin
|
|
1990
|
-
# List a
|
|
1991
|
-
data, status_code, headers = api_instance.
|
|
2280
|
+
# List the accounts a library entry can be shared with
|
|
2281
|
+
data, status_code, headers = api_instance.get_sfvb_library_share_targets_with_http_info(storefront_oid)
|
|
1992
2282
|
p status_code # => 2xx
|
|
1993
2283
|
p headers # => { ... }
|
|
1994
|
-
p data # => <
|
|
2284
|
+
p data # => <SfvbLibraryShareTargetsResponse>
|
|
1995
2285
|
rescue UltracartClient::ApiError => e
|
|
1996
|
-
puts "Error when calling SfvbApi->
|
|
2286
|
+
puts "Error when calling SfvbApi->get_sfvb_library_share_targets_with_http_info: #{e}"
|
|
1997
2287
|
end
|
|
1998
2288
|
```
|
|
1999
2289
|
|
|
@@ -2005,7 +2295,7 @@ end
|
|
|
2005
2295
|
|
|
2006
2296
|
### Return type
|
|
2007
2297
|
|
|
2008
|
-
[**
|
|
2298
|
+
[**SfvbLibraryShareTargetsResponse**](SfvbLibraryShareTargetsResponse.md)
|
|
2009
2299
|
|
|
2010
2300
|
### Authorization
|
|
2011
2301
|
|
|
@@ -2017,13 +2307,13 @@ end
|
|
|
2017
2307
|
- **Accept**: application/json
|
|
2018
2308
|
|
|
2019
2309
|
|
|
2020
|
-
##
|
|
2310
|
+
## get_sfvb_library_taxonomy
|
|
2021
2311
|
|
|
2022
|
-
> <
|
|
2312
|
+
> <SfvbLibraryTaxonomyCatalog> get_sfvb_library_taxonomy(storefront_oid)
|
|
2023
2313
|
|
|
2024
|
-
|
|
2314
|
+
List the allowed library tags
|
|
2025
2315
|
|
|
2026
|
-
|
|
2316
|
+
The fixed tag list for purpose, section, industry and style, each tag with a one line description. Saving an entry refuses any tag not on it with sfvb.library_taxonomy_unknown, naming the closest one. The same tags are the facet_purpose, facet_section, facet_industry and facet_style search facets.
|
|
2027
2317
|
|
|
2028
2318
|
|
|
2029
2319
|
### Examples
|
|
@@ -2032,16 +2322,176 @@ What the pageattribute and pageimage elements render for this page. These are n
|
|
|
2032
2322
|
(No example for this operation).
|
|
2033
2323
|
|
|
2034
2324
|
|
|
2035
|
-
#### Using the
|
|
2325
|
+
#### Using the get_sfvb_library_taxonomy_with_http_info variant
|
|
2036
2326
|
|
|
2037
2327
|
This returns an Array which contains the response data, status code and headers.
|
|
2038
2328
|
|
|
2039
|
-
> <Array(<
|
|
2329
|
+
> <Array(<SfvbLibraryTaxonomyCatalog>, Integer, Hash)> get_sfvb_library_taxonomy_with_http_info(storefront_oid)
|
|
2040
2330
|
|
|
2041
2331
|
```ruby
|
|
2042
2332
|
begin
|
|
2043
|
-
#
|
|
2044
|
-
data, status_code, headers = api_instance.
|
|
2333
|
+
# List the allowed library tags
|
|
2334
|
+
data, status_code, headers = api_instance.get_sfvb_library_taxonomy_with_http_info(storefront_oid)
|
|
2335
|
+
p status_code # => 2xx
|
|
2336
|
+
p headers # => { ... }
|
|
2337
|
+
p data # => <SfvbLibraryTaxonomyCatalog>
|
|
2338
|
+
rescue UltracartClient::ApiError => e
|
|
2339
|
+
puts "Error when calling SfvbApi->get_sfvb_library_taxonomy_with_http_info: #{e}"
|
|
2340
|
+
end
|
|
2341
|
+
```
|
|
2342
|
+
|
|
2343
|
+
### Parameters
|
|
2344
|
+
|
|
2345
|
+
| Name | Type | Description | Notes |
|
|
2346
|
+
| ---- | ---- | ----------- | ----- |
|
|
2347
|
+
| **storefront_oid** | **Integer** | | |
|
|
2348
|
+
|
|
2349
|
+
### Return type
|
|
2350
|
+
|
|
2351
|
+
[**SfvbLibraryTaxonomyCatalog**](SfvbLibraryTaxonomyCatalog.md)
|
|
2352
|
+
|
|
2353
|
+
### Authorization
|
|
2354
|
+
|
|
2355
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
2356
|
+
|
|
2357
|
+
### HTTP request headers
|
|
2358
|
+
|
|
2359
|
+
- **Content-Type**: Not defined
|
|
2360
|
+
- **Accept**: application/json
|
|
2361
|
+
|
|
2362
|
+
|
|
2363
|
+
## get_sfvb_menu
|
|
2364
|
+
|
|
2365
|
+
> <SfvbMenu> get_sfvb_menu(storefront_oid, code)
|
|
2366
|
+
|
|
2367
|
+
Read one store menu and its entries
|
|
2368
|
+
|
|
2369
|
+
The whole tree, in render order. Page entries carry the page_path they resolve to and item entries the merchant_item_id, rather than the oids the storage keeps. Menu item oids are not returned at all because a write regenerates every one of them. Keep hash_sha256 - it is the If-Match a write needs.
|
|
2370
|
+
|
|
2371
|
+
|
|
2372
|
+
### Examples
|
|
2373
|
+
|
|
2374
|
+
|
|
2375
|
+
(No example for this operation).
|
|
2376
|
+
|
|
2377
|
+
|
|
2378
|
+
#### Using the get_sfvb_menu_with_http_info variant
|
|
2379
|
+
|
|
2380
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2381
|
+
|
|
2382
|
+
> <Array(<SfvbMenu>, Integer, Hash)> get_sfvb_menu_with_http_info(storefront_oid, code)
|
|
2383
|
+
|
|
2384
|
+
```ruby
|
|
2385
|
+
begin
|
|
2386
|
+
# Read one store menu and its entries
|
|
2387
|
+
data, status_code, headers = api_instance.get_sfvb_menu_with_http_info(storefront_oid, code)
|
|
2388
|
+
p status_code # => 2xx
|
|
2389
|
+
p headers # => { ... }
|
|
2390
|
+
p data # => <SfvbMenu>
|
|
2391
|
+
rescue UltracartClient::ApiError => e
|
|
2392
|
+
puts "Error when calling SfvbApi->get_sfvb_menu_with_http_info: #{e}"
|
|
2393
|
+
end
|
|
2394
|
+
```
|
|
2395
|
+
|
|
2396
|
+
### Parameters
|
|
2397
|
+
|
|
2398
|
+
| Name | Type | Description | Notes |
|
|
2399
|
+
| ---- | ---- | ----------- | ----- |
|
|
2400
|
+
| **storefront_oid** | **Integer** | | |
|
|
2401
|
+
| **code** | **String** | Menu code, matched without regard to case | |
|
|
2402
|
+
|
|
2403
|
+
### Return type
|
|
2404
|
+
|
|
2405
|
+
[**SfvbMenu**](SfvbMenu.md)
|
|
2406
|
+
|
|
2407
|
+
### Authorization
|
|
2408
|
+
|
|
2409
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
2410
|
+
|
|
2411
|
+
### HTTP request headers
|
|
2412
|
+
|
|
2413
|
+
- **Content-Type**: Not defined
|
|
2414
|
+
- **Accept**: application/json
|
|
2415
|
+
|
|
2416
|
+
|
|
2417
|
+
## get_sfvb_menus
|
|
2418
|
+
|
|
2419
|
+
> <SfvbMenusResponse> get_sfvb_menus(storefront_oid)
|
|
2420
|
+
|
|
2421
|
+
List a storefront's store menus
|
|
2422
|
+
|
|
2423
|
+
The menus a menu element's menuName can name, sorted by code and without their entries. A code the active theme's templates ask for but nothing has created is included with unconfigured true - that code renders an empty list today, and writing it creates it. A menu no template names is marked undeclared, which usually means a menuName is misspelled.
|
|
2424
|
+
|
|
2425
|
+
|
|
2426
|
+
### Examples
|
|
2427
|
+
|
|
2428
|
+
|
|
2429
|
+
(No example for this operation).
|
|
2430
|
+
|
|
2431
|
+
|
|
2432
|
+
#### Using the get_sfvb_menus_with_http_info variant
|
|
2433
|
+
|
|
2434
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2435
|
+
|
|
2436
|
+
> <Array(<SfvbMenusResponse>, Integer, Hash)> get_sfvb_menus_with_http_info(storefront_oid)
|
|
2437
|
+
|
|
2438
|
+
```ruby
|
|
2439
|
+
begin
|
|
2440
|
+
# List a storefront's store menus
|
|
2441
|
+
data, status_code, headers = api_instance.get_sfvb_menus_with_http_info(storefront_oid)
|
|
2442
|
+
p status_code # => 2xx
|
|
2443
|
+
p headers # => { ... }
|
|
2444
|
+
p data # => <SfvbMenusResponse>
|
|
2445
|
+
rescue UltracartClient::ApiError => e
|
|
2446
|
+
puts "Error when calling SfvbApi->get_sfvb_menus_with_http_info: #{e}"
|
|
2447
|
+
end
|
|
2448
|
+
```
|
|
2449
|
+
|
|
2450
|
+
### Parameters
|
|
2451
|
+
|
|
2452
|
+
| Name | Type | Description | Notes |
|
|
2453
|
+
| ---- | ---- | ----------- | ----- |
|
|
2454
|
+
| **storefront_oid** | **Integer** | | |
|
|
2455
|
+
|
|
2456
|
+
### Return type
|
|
2457
|
+
|
|
2458
|
+
[**SfvbMenusResponse**](SfvbMenusResponse.md)
|
|
2459
|
+
|
|
2460
|
+
### Authorization
|
|
2461
|
+
|
|
2462
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
2463
|
+
|
|
2464
|
+
### HTTP request headers
|
|
2465
|
+
|
|
2466
|
+
- **Content-Type**: Not defined
|
|
2467
|
+
- **Accept**: application/json
|
|
2468
|
+
|
|
2469
|
+
|
|
2470
|
+
## get_sfvb_page
|
|
2471
|
+
|
|
2472
|
+
> <SfvbPageResponse> get_sfvb_page(storefront_oid, path)
|
|
2473
|
+
|
|
2474
|
+
Read a page's attributes and images
|
|
2475
|
+
|
|
2476
|
+
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.
|
|
2477
|
+
|
|
2478
|
+
|
|
2479
|
+
### Examples
|
|
2480
|
+
|
|
2481
|
+
|
|
2482
|
+
(No example for this operation).
|
|
2483
|
+
|
|
2484
|
+
|
|
2485
|
+
#### Using the get_sfvb_page_with_http_info variant
|
|
2486
|
+
|
|
2487
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2488
|
+
|
|
2489
|
+
> <Array(<SfvbPageResponse>, Integer, Hash)> get_sfvb_page_with_http_info(storefront_oid, path)
|
|
2490
|
+
|
|
2491
|
+
```ruby
|
|
2492
|
+
begin
|
|
2493
|
+
# Read a page's attributes and images
|
|
2494
|
+
data, status_code, headers = api_instance.get_sfvb_page_with_http_info(storefront_oid, path)
|
|
2045
2495
|
p status_code # => 2xx
|
|
2046
2496
|
p headers # => { ... }
|
|
2047
2497
|
p data # => <SfvbPageResponse>
|
|
@@ -3154,11 +3604,11 @@ end
|
|
|
3154
3604
|
|
|
3155
3605
|
## install_sfvb_library_entry
|
|
3156
3606
|
|
|
3157
|
-
> <
|
|
3607
|
+
> <SfvbLibraryInstallReceipt> install_sfvb_library_entry(storefront_oid, library_oid, opts)
|
|
3158
3608
|
|
|
3159
3609
|
Install a library entry into a storefront
|
|
3160
3610
|
|
|
3161
|
-
Copies the fragment's referenced
|
|
3611
|
+
Copies the fragment's referenced files into the storefront file system and returns a receipt with the CJSON's paths resolved, ready to place. It never places the CJSON. Read content_manifest first; executable content needs acknowledge_executable true. A file that already exists with different content is a conflict - on_conflict fail (the default) refuses with 409 and writes nothing, skip keeps the existing file, overwrite replaces it. A recipient installs a published revision. This writes, which is why it is a POST, and it requires sfvb_publish because the files land in the shared storefront file system, which is served to shoppers whichever theme is active.
|
|
3162
3612
|
|
|
3163
3613
|
|
|
3164
3614
|
### Examples
|
|
@@ -3171,15 +3621,15 @@ Copies the fragment's referenced assets into the storefront file system and retu
|
|
|
3171
3621
|
|
|
3172
3622
|
This returns an Array which contains the response data, status code and headers.
|
|
3173
3623
|
|
|
3174
|
-
> <Array(<
|
|
3624
|
+
> <Array(<SfvbLibraryInstallReceipt>, Integer, Hash)> install_sfvb_library_entry_with_http_info(storefront_oid, library_oid, opts)
|
|
3175
3625
|
|
|
3176
3626
|
```ruby
|
|
3177
3627
|
begin
|
|
3178
3628
|
# Install a library entry into a storefront
|
|
3179
|
-
data, status_code, headers = api_instance.install_sfvb_library_entry_with_http_info(storefront_oid, library_oid)
|
|
3629
|
+
data, status_code, headers = api_instance.install_sfvb_library_entry_with_http_info(storefront_oid, library_oid, opts)
|
|
3180
3630
|
p status_code # => 2xx
|
|
3181
3631
|
p headers # => { ... }
|
|
3182
|
-
p data # => <
|
|
3632
|
+
p data # => <SfvbLibraryInstallReceipt>
|
|
3183
3633
|
rescue UltracartClient::ApiError => e
|
|
3184
3634
|
puts "Error when calling SfvbApi->install_sfvb_library_entry_with_http_info: #{e}"
|
|
3185
3635
|
end
|
|
@@ -3191,10 +3641,11 @@ end
|
|
|
3191
3641
|
| ---- | ---- | ----------- | ----- |
|
|
3192
3642
|
| **storefront_oid** | **Integer** | | |
|
|
3193
3643
|
| **library_oid** | **Integer** | | |
|
|
3644
|
+
| **install_request** | [**SfvbLibraryInstallRequest**](SfvbLibraryInstallRequest.md) | Revision, conflict handling and acknowledgement | [optional] |
|
|
3194
3645
|
|
|
3195
3646
|
### Return type
|
|
3196
3647
|
|
|
3197
|
-
[**
|
|
3648
|
+
[**SfvbLibraryInstallReceipt**](SfvbLibraryInstallReceipt.md)
|
|
3198
3649
|
|
|
3199
3650
|
### Authorization
|
|
3200
3651
|
|
|
@@ -3202,7 +3653,7 @@ end
|
|
|
3202
3653
|
|
|
3203
3654
|
### HTTP request headers
|
|
3204
3655
|
|
|
3205
|
-
- **Content-Type**:
|
|
3656
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
3206
3657
|
- **Accept**: application/json
|
|
3207
3658
|
|
|
3208
3659
|
|
|
@@ -3594,6 +4045,59 @@ end
|
|
|
3594
4045
|
- **Accept**: application/json
|
|
3595
4046
|
|
|
3596
4047
|
|
|
4048
|
+
## list_sfvb_library_installs
|
|
4049
|
+
|
|
4050
|
+
> <SfvbLibraryInstallsResponse> list_sfvb_library_installs(storefront_oid)
|
|
4051
|
+
|
|
4052
|
+
List the library entries installed on a storefront
|
|
4053
|
+
|
|
4054
|
+
Each entry's most recently installed revision, its latest published revision and update_available. Nothing updates automatically. An entry this account can no longer see is listed without its name.
|
|
4055
|
+
|
|
4056
|
+
|
|
4057
|
+
### Examples
|
|
4058
|
+
|
|
4059
|
+
|
|
4060
|
+
(No example for this operation).
|
|
4061
|
+
|
|
4062
|
+
|
|
4063
|
+
#### Using the list_sfvb_library_installs_with_http_info variant
|
|
4064
|
+
|
|
4065
|
+
This returns an Array which contains the response data, status code and headers.
|
|
4066
|
+
|
|
4067
|
+
> <Array(<SfvbLibraryInstallsResponse>, Integer, Hash)> list_sfvb_library_installs_with_http_info(storefront_oid)
|
|
4068
|
+
|
|
4069
|
+
```ruby
|
|
4070
|
+
begin
|
|
4071
|
+
# List the library entries installed on a storefront
|
|
4072
|
+
data, status_code, headers = api_instance.list_sfvb_library_installs_with_http_info(storefront_oid)
|
|
4073
|
+
p status_code # => 2xx
|
|
4074
|
+
p headers # => { ... }
|
|
4075
|
+
p data # => <SfvbLibraryInstallsResponse>
|
|
4076
|
+
rescue UltracartClient::ApiError => e
|
|
4077
|
+
puts "Error when calling SfvbApi->list_sfvb_library_installs_with_http_info: #{e}"
|
|
4078
|
+
end
|
|
4079
|
+
```
|
|
4080
|
+
|
|
4081
|
+
### Parameters
|
|
4082
|
+
|
|
4083
|
+
| Name | Type | Description | Notes |
|
|
4084
|
+
| ---- | ---- | ----------- | ----- |
|
|
4085
|
+
| **storefront_oid** | **Integer** | | |
|
|
4086
|
+
|
|
4087
|
+
### Return type
|
|
4088
|
+
|
|
4089
|
+
[**SfvbLibraryInstallsResponse**](SfvbLibraryInstallsResponse.md)
|
|
4090
|
+
|
|
4091
|
+
### Authorization
|
|
4092
|
+
|
|
4093
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
4094
|
+
|
|
4095
|
+
### HTTP request headers
|
|
4096
|
+
|
|
4097
|
+
- **Content-Type**: Not defined
|
|
4098
|
+
- **Accept**: application/json
|
|
4099
|
+
|
|
4100
|
+
|
|
3597
4101
|
## list_sfvb_pages
|
|
3598
4102
|
|
|
3599
4103
|
> <SfvbPageListResponse> list_sfvb_pages(storefront_oid, opts)
|
|
@@ -4035,6 +4539,62 @@ end
|
|
|
4035
4539
|
- **Accept**: application/json
|
|
4036
4540
|
|
|
4037
4541
|
|
|
4542
|
+
## publish_sfvb_library_entry
|
|
4543
|
+
|
|
4544
|
+
> <SfvbLibraryEntry> publish_sfvb_library_entry(storefront_oid, library_oid, if_match, publish_request)
|
|
4545
|
+
|
|
4546
|
+
Publish a library entry's draft
|
|
4547
|
+
|
|
4548
|
+
Freezes the draft as a published revision at its revision_number and sets who can see it. Owner only, with the draft's hash_sha256 as If-Match. Always needs sfvb_publish, because it changes what other merchants can install. Images, fonts, stylesheets and media must be relative paths, and credential shaped strings are refused. Public also needs the library publisher property on the account and no executable content at all - no script, html, embed, css or velocity elements. After those checks an automated AI review reads the fragment, which can take up to about a minute. A clear violation both of its models agree on refuses any publish with sfvb.library_ai_review_blocked. A public publish also needs its approval, otherwise sfvb.library_ai_review_inconclusive. The result is in content_manifest.ai_review.
|
|
4549
|
+
|
|
4550
|
+
|
|
4551
|
+
### Examples
|
|
4552
|
+
|
|
4553
|
+
|
|
4554
|
+
(No example for this operation).
|
|
4555
|
+
|
|
4556
|
+
|
|
4557
|
+
#### Using the publish_sfvb_library_entry_with_http_info variant
|
|
4558
|
+
|
|
4559
|
+
This returns an Array which contains the response data, status code and headers.
|
|
4560
|
+
|
|
4561
|
+
> <Array(<SfvbLibraryEntry>, Integer, Hash)> publish_sfvb_library_entry_with_http_info(storefront_oid, library_oid, if_match, publish_request)
|
|
4562
|
+
|
|
4563
|
+
```ruby
|
|
4564
|
+
begin
|
|
4565
|
+
# Publish a library entry's draft
|
|
4566
|
+
data, status_code, headers = api_instance.publish_sfvb_library_entry_with_http_info(storefront_oid, library_oid, if_match, publish_request)
|
|
4567
|
+
p status_code # => 2xx
|
|
4568
|
+
p headers # => { ... }
|
|
4569
|
+
p data # => <SfvbLibraryEntry>
|
|
4570
|
+
rescue UltracartClient::ApiError => e
|
|
4571
|
+
puts "Error when calling SfvbApi->publish_sfvb_library_entry_with_http_info: #{e}"
|
|
4572
|
+
end
|
|
4573
|
+
```
|
|
4574
|
+
|
|
4575
|
+
### Parameters
|
|
4576
|
+
|
|
4577
|
+
| Name | Type | Description | Notes |
|
|
4578
|
+
| ---- | ---- | ----------- | ----- |
|
|
4579
|
+
| **storefront_oid** | **Integer** | | |
|
|
4580
|
+
| **library_oid** | **Integer** | | |
|
|
4581
|
+
| **if_match** | **String** | hash_sha256 from the last read. Required; 428 when absent, 412 when stale. | |
|
|
4582
|
+
| **publish_request** | [**SfvbLibraryPublishRequest**](SfvbLibraryPublishRequest.md) | Visibility and release notes | |
|
|
4583
|
+
|
|
4584
|
+
### Return type
|
|
4585
|
+
|
|
4586
|
+
[**SfvbLibraryEntry**](SfvbLibraryEntry.md)
|
|
4587
|
+
|
|
4588
|
+
### Authorization
|
|
4589
|
+
|
|
4590
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
4591
|
+
|
|
4592
|
+
### HTTP request headers
|
|
4593
|
+
|
|
4594
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
4595
|
+
- **Accept**: application/json
|
|
4596
|
+
|
|
4597
|
+
|
|
4038
4598
|
## put_sfvb_container
|
|
4039
4599
|
|
|
4040
4600
|
> <SfvbContainerResponse> put_sfvb_container(storefront_oid, owner_type, owner_object_id, if_match, container_write_request, opts)
|
|
@@ -5425,7 +5985,7 @@ end
|
|
|
5425
5985
|
|
|
5426
5986
|
Search the element library
|
|
5427
5987
|
|
|
5428
|
-
Known-good CJSON fragments a human already built out of real elements. This is what a lint warning about a monolithic html element should point at - a warning that names a fragment solving the same problem is an instruction, where a warning on its own is only criticism. Results are terse; fetch a single entry for its CJSON. Narrow with
|
|
5988
|
+
Known-good CJSON fragments a human already built out of real elements. This is what a lint warning about a monolithic html element should point at - a warning that names a fragment solving the same problem is an instruction, where a warning on its own is only criticism. Results are terse; fetch a single entry for its CJSON. Narrow with a query parameter named after a facet, such as facet_purpose, whose value is the facet name, a colon and one of its options. Besides element type and author, the facets include purpose, section, industry and style from library/taxonomy, and the search text matches those tags too. Results follow the same rules as reading one entry, so others see published revisions only.
|
|
5429
5989
|
|
|
5430
5990
|
|
|
5431
5991
|
### Examples
|
|
@@ -5476,13 +6036,13 @@ end
|
|
|
5476
6036
|
- **Accept**: application/json
|
|
5477
6037
|
|
|
5478
6038
|
|
|
5479
|
-
##
|
|
6039
|
+
## set_sfvb_library_screenshot
|
|
5480
6040
|
|
|
5481
|
-
> <
|
|
6041
|
+
> <SfvbLibraryEntry> set_sfvb_library_screenshot(storefront_oid, library_oid, if_match, screenshot_request)
|
|
5482
6042
|
|
|
5483
|
-
|
|
6043
|
+
Set a library entry's screenshot
|
|
5484
6044
|
|
|
5485
|
-
|
|
6045
|
+
Three calls, like the other uploads. Request an upload URL with files/upload_url/png, PUT the PNG bytes to it, then call this with the key, the sha256 of those bytes and where the image came from. Owner only, with the draft's hash_sha256 as If-Match. The PNG must be at most 5 MB and 4096 pixels a side; it is re-encoded, which drops any metadata, and a thumbnail is made from it before this returns. Capture it with test data only. A refused image leaves the previous screenshot in place. Other merchants see a new screenshot only after the next publish, whose review checks it.
|
|
5486
6046
|
|
|
5487
6047
|
|
|
5488
6048
|
### Examples
|
|
@@ -5491,15 +6051,126 @@ type page starts an experiment element already saved in a page body - send path,
|
|
|
5491
6051
|
(No example for this operation).
|
|
5492
6052
|
|
|
5493
6053
|
|
|
5494
|
-
#### Using the
|
|
6054
|
+
#### Using the set_sfvb_library_screenshot_with_http_info variant
|
|
5495
6055
|
|
|
5496
6056
|
This returns an Array which contains the response data, status code and headers.
|
|
5497
6057
|
|
|
5498
|
-
> <Array(<
|
|
6058
|
+
> <Array(<SfvbLibraryEntry>, Integer, Hash)> set_sfvb_library_screenshot_with_http_info(storefront_oid, library_oid, if_match, screenshot_request)
|
|
5499
6059
|
|
|
5500
6060
|
```ruby
|
|
5501
6061
|
begin
|
|
5502
|
-
#
|
|
6062
|
+
# Set a library entry's screenshot
|
|
6063
|
+
data, status_code, headers = api_instance.set_sfvb_library_screenshot_with_http_info(storefront_oid, library_oid, if_match, screenshot_request)
|
|
6064
|
+
p status_code # => 2xx
|
|
6065
|
+
p headers # => { ... }
|
|
6066
|
+
p data # => <SfvbLibraryEntry>
|
|
6067
|
+
rescue UltracartClient::ApiError => e
|
|
6068
|
+
puts "Error when calling SfvbApi->set_sfvb_library_screenshot_with_http_info: #{e}"
|
|
6069
|
+
end
|
|
6070
|
+
```
|
|
6071
|
+
|
|
6072
|
+
### Parameters
|
|
6073
|
+
|
|
6074
|
+
| Name | Type | Description | Notes |
|
|
6075
|
+
| ---- | ---- | ----------- | ----- |
|
|
6076
|
+
| **storefront_oid** | **Integer** | | |
|
|
6077
|
+
| **library_oid** | **Integer** | | |
|
|
6078
|
+
| **if_match** | **String** | hash_sha256 from the last read. Required; 428 when absent, 412 when stale. | |
|
|
6079
|
+
| **screenshot_request** | [**SfvbLibraryScreenshotRequest**](SfvbLibraryScreenshotRequest.md) | The staged PNG | |
|
|
6080
|
+
|
|
6081
|
+
### Return type
|
|
6082
|
+
|
|
6083
|
+
[**SfvbLibraryEntry**](SfvbLibraryEntry.md)
|
|
6084
|
+
|
|
6085
|
+
### Authorization
|
|
6086
|
+
|
|
6087
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
6088
|
+
|
|
6089
|
+
### HTTP request headers
|
|
6090
|
+
|
|
6091
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
6092
|
+
- **Accept**: application/json
|
|
6093
|
+
|
|
6094
|
+
|
|
6095
|
+
## share_sfvb_library_entry
|
|
6096
|
+
|
|
6097
|
+
> <SfvbLibraryEntry> share_sfvb_library_entry(storefront_oid, library_oid, share_request)
|
|
6098
|
+
|
|
6099
|
+
Share a published library entry with a linked account
|
|
6100
|
+
|
|
6101
|
+
Owner only, and always needs sfvb_publish. The merchant must be one share_targets lists, and the entry must have a published revision, which is what the recipient sees. The published revision is checked again for absolute asset URLs and credentials. Idempotent.
|
|
6102
|
+
|
|
6103
|
+
|
|
6104
|
+
### Examples
|
|
6105
|
+
|
|
6106
|
+
|
|
6107
|
+
(No example for this operation).
|
|
6108
|
+
|
|
6109
|
+
|
|
6110
|
+
#### Using the share_sfvb_library_entry_with_http_info variant
|
|
6111
|
+
|
|
6112
|
+
This returns an Array which contains the response data, status code and headers.
|
|
6113
|
+
|
|
6114
|
+
> <Array(<SfvbLibraryEntry>, Integer, Hash)> share_sfvb_library_entry_with_http_info(storefront_oid, library_oid, share_request)
|
|
6115
|
+
|
|
6116
|
+
```ruby
|
|
6117
|
+
begin
|
|
6118
|
+
# Share a published library entry with a linked account
|
|
6119
|
+
data, status_code, headers = api_instance.share_sfvb_library_entry_with_http_info(storefront_oid, library_oid, share_request)
|
|
6120
|
+
p status_code # => 2xx
|
|
6121
|
+
p headers # => { ... }
|
|
6122
|
+
p data # => <SfvbLibraryEntry>
|
|
6123
|
+
rescue UltracartClient::ApiError => e
|
|
6124
|
+
puts "Error when calling SfvbApi->share_sfvb_library_entry_with_http_info: #{e}"
|
|
6125
|
+
end
|
|
6126
|
+
```
|
|
6127
|
+
|
|
6128
|
+
### Parameters
|
|
6129
|
+
|
|
6130
|
+
| Name | Type | Description | Notes |
|
|
6131
|
+
| ---- | ---- | ----------- | ----- |
|
|
6132
|
+
| **storefront_oid** | **Integer** | | |
|
|
6133
|
+
| **library_oid** | **Integer** | | |
|
|
6134
|
+
| **share_request** | [**SfvbLibraryShareRequest**](SfvbLibraryShareRequest.md) | The linked account | |
|
|
6135
|
+
|
|
6136
|
+
### Return type
|
|
6137
|
+
|
|
6138
|
+
[**SfvbLibraryEntry**](SfvbLibraryEntry.md)
|
|
6139
|
+
|
|
6140
|
+
### Authorization
|
|
6141
|
+
|
|
6142
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
6143
|
+
|
|
6144
|
+
### HTTP request headers
|
|
6145
|
+
|
|
6146
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
6147
|
+
- **Accept**: application/json
|
|
6148
|
+
|
|
6149
|
+
|
|
6150
|
+
## start_sfvb_experiment
|
|
6151
|
+
|
|
6152
|
+
> <SfvbExperiment> start_sfvb_experiment(storefront_oid, experiment_start_request)
|
|
6153
|
+
|
|
6154
|
+
Start an experiment
|
|
6155
|
+
|
|
6156
|
+
type page starts an experiment element already saved in a page body - send path, slot and widget_id, and its name, objective, duration and variations are read from the element with the builder's rules (2 to 5 variations numbered 0 up with no gaps, 3 to 90 days, traffic on all or none adding up to 100). The new id is written into the element and the body is saved, so pull it again before the next edit. type url splits visitors between existing pages at router_url, and always ends by itself after duration_days. Always needs sfvb_publish, because visitors are split as soon as it starts.
|
|
6157
|
+
|
|
6158
|
+
|
|
6159
|
+
### Examples
|
|
6160
|
+
|
|
6161
|
+
|
|
6162
|
+
(No example for this operation).
|
|
6163
|
+
|
|
6164
|
+
|
|
6165
|
+
#### Using the start_sfvb_experiment_with_http_info variant
|
|
6166
|
+
|
|
6167
|
+
This returns an Array which contains the response data, status code and headers.
|
|
6168
|
+
|
|
6169
|
+
> <Array(<SfvbExperiment>, Integer, Hash)> start_sfvb_experiment_with_http_info(storefront_oid, experiment_start_request)
|
|
6170
|
+
|
|
6171
|
+
```ruby
|
|
6172
|
+
begin
|
|
6173
|
+
# Start an experiment
|
|
5503
6174
|
data, status_code, headers = api_instance.start_sfvb_experiment_with_http_info(storefront_oid, experiment_start_request)
|
|
5504
6175
|
p status_code # => 2xx
|
|
5505
6176
|
p headers # => { ... }
|
|
@@ -5584,6 +6255,170 @@ end
|
|
|
5584
6255
|
- **Accept**: application/json
|
|
5585
6256
|
|
|
5586
6257
|
|
|
6258
|
+
## unfavorite_sfvb_library_entry
|
|
6259
|
+
|
|
6260
|
+
> unfavorite_sfvb_library_entry(storefront_oid, library_oid)
|
|
6261
|
+
|
|
6262
|
+
Remove a library entry from favorites
|
|
6263
|
+
|
|
6264
|
+
Removes the calling user's bookmark. Idempotent.
|
|
6265
|
+
|
|
6266
|
+
|
|
6267
|
+
### Examples
|
|
6268
|
+
|
|
6269
|
+
|
|
6270
|
+
(No example for this operation).
|
|
6271
|
+
|
|
6272
|
+
|
|
6273
|
+
#### Using the unfavorite_sfvb_library_entry_with_http_info variant
|
|
6274
|
+
|
|
6275
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
6276
|
+
|
|
6277
|
+
> <Array(nil, Integer, Hash)> unfavorite_sfvb_library_entry_with_http_info(storefront_oid, library_oid)
|
|
6278
|
+
|
|
6279
|
+
```ruby
|
|
6280
|
+
begin
|
|
6281
|
+
# Remove a library entry from favorites
|
|
6282
|
+
data, status_code, headers = api_instance.unfavorite_sfvb_library_entry_with_http_info(storefront_oid, library_oid)
|
|
6283
|
+
p status_code # => 2xx
|
|
6284
|
+
p headers # => { ... }
|
|
6285
|
+
p data # => nil
|
|
6286
|
+
rescue UltracartClient::ApiError => e
|
|
6287
|
+
puts "Error when calling SfvbApi->unfavorite_sfvb_library_entry_with_http_info: #{e}"
|
|
6288
|
+
end
|
|
6289
|
+
```
|
|
6290
|
+
|
|
6291
|
+
### Parameters
|
|
6292
|
+
|
|
6293
|
+
| Name | Type | Description | Notes |
|
|
6294
|
+
| ---- | ---- | ----------- | ----- |
|
|
6295
|
+
| **storefront_oid** | **Integer** | | |
|
|
6296
|
+
| **library_oid** | **Integer** | | |
|
|
6297
|
+
|
|
6298
|
+
### Return type
|
|
6299
|
+
|
|
6300
|
+
nil (empty response body)
|
|
6301
|
+
|
|
6302
|
+
### Authorization
|
|
6303
|
+
|
|
6304
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
6305
|
+
|
|
6306
|
+
### HTTP request headers
|
|
6307
|
+
|
|
6308
|
+
- **Content-Type**: Not defined
|
|
6309
|
+
- **Accept**: application/json
|
|
6310
|
+
|
|
6311
|
+
|
|
6312
|
+
## unpublish_sfvb_library_entry
|
|
6313
|
+
|
|
6314
|
+
> <SfvbLibraryEntry> unpublish_sfvb_library_entry(storefront_oid, library_oid, unpublish_request)
|
|
6315
|
+
|
|
6316
|
+
Narrow who can see a library entry
|
|
6317
|
+
|
|
6318
|
+
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.
|
|
6319
|
+
|
|
6320
|
+
|
|
6321
|
+
### Examples
|
|
6322
|
+
|
|
6323
|
+
|
|
6324
|
+
(No example for this operation).
|
|
6325
|
+
|
|
6326
|
+
|
|
6327
|
+
#### Using the unpublish_sfvb_library_entry_with_http_info variant
|
|
6328
|
+
|
|
6329
|
+
This returns an Array which contains the response data, status code and headers.
|
|
6330
|
+
|
|
6331
|
+
> <Array(<SfvbLibraryEntry>, Integer, Hash)> unpublish_sfvb_library_entry_with_http_info(storefront_oid, library_oid, unpublish_request)
|
|
6332
|
+
|
|
6333
|
+
```ruby
|
|
6334
|
+
begin
|
|
6335
|
+
# Narrow who can see a library entry
|
|
6336
|
+
data, status_code, headers = api_instance.unpublish_sfvb_library_entry_with_http_info(storefront_oid, library_oid, unpublish_request)
|
|
6337
|
+
p status_code # => 2xx
|
|
6338
|
+
p headers # => { ... }
|
|
6339
|
+
p data # => <SfvbLibraryEntry>
|
|
6340
|
+
rescue UltracartClient::ApiError => e
|
|
6341
|
+
puts "Error when calling SfvbApi->unpublish_sfvb_library_entry_with_http_info: #{e}"
|
|
6342
|
+
end
|
|
6343
|
+
```
|
|
6344
|
+
|
|
6345
|
+
### Parameters
|
|
6346
|
+
|
|
6347
|
+
| Name | Type | Description | Notes |
|
|
6348
|
+
| ---- | ---- | ----------- | ----- |
|
|
6349
|
+
| **storefront_oid** | **Integer** | | |
|
|
6350
|
+
| **library_oid** | **Integer** | | |
|
|
6351
|
+
| **unpublish_request** | [**SfvbLibraryPublishRequest**](SfvbLibraryPublishRequest.md) | The narrower visibility | |
|
|
6352
|
+
|
|
6353
|
+
### Return type
|
|
6354
|
+
|
|
6355
|
+
[**SfvbLibraryEntry**](SfvbLibraryEntry.md)
|
|
6356
|
+
|
|
6357
|
+
### Authorization
|
|
6358
|
+
|
|
6359
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
6360
|
+
|
|
6361
|
+
### HTTP request headers
|
|
6362
|
+
|
|
6363
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
6364
|
+
- **Accept**: application/json
|
|
6365
|
+
|
|
6366
|
+
|
|
6367
|
+
## unshare_sfvb_library_entry
|
|
6368
|
+
|
|
6369
|
+
> <SfvbLibraryUnshareResult> unshare_sfvb_library_entry(storefront_oid, library_oid, merchant_id)
|
|
6370
|
+
|
|
6371
|
+
Stop sharing a library entry with an account
|
|
6372
|
+
|
|
6373
|
+
Owner only, and always needs sfvb_publish. Stops further installs by that account. Its existing installs keep their copies and are listed in the result. Idempotent, and still works while the library is turned off.
|
|
6374
|
+
|
|
6375
|
+
|
|
6376
|
+
### Examples
|
|
6377
|
+
|
|
6378
|
+
|
|
6379
|
+
(No example for this operation).
|
|
6380
|
+
|
|
6381
|
+
|
|
6382
|
+
#### Using the unshare_sfvb_library_entry_with_http_info variant
|
|
6383
|
+
|
|
6384
|
+
This returns an Array which contains the response data, status code and headers.
|
|
6385
|
+
|
|
6386
|
+
> <Array(<SfvbLibraryUnshareResult>, Integer, Hash)> unshare_sfvb_library_entry_with_http_info(storefront_oid, library_oid, merchant_id)
|
|
6387
|
+
|
|
6388
|
+
```ruby
|
|
6389
|
+
begin
|
|
6390
|
+
# Stop sharing a library entry with an account
|
|
6391
|
+
data, status_code, headers = api_instance.unshare_sfvb_library_entry_with_http_info(storefront_oid, library_oid, merchant_id)
|
|
6392
|
+
p status_code # => 2xx
|
|
6393
|
+
p headers # => { ... }
|
|
6394
|
+
p data # => <SfvbLibraryUnshareResult>
|
|
6395
|
+
rescue UltracartClient::ApiError => e
|
|
6396
|
+
puts "Error when calling SfvbApi->unshare_sfvb_library_entry_with_http_info: #{e}"
|
|
6397
|
+
end
|
|
6398
|
+
```
|
|
6399
|
+
|
|
6400
|
+
### Parameters
|
|
6401
|
+
|
|
6402
|
+
| Name | Type | Description | Notes |
|
|
6403
|
+
| ---- | ---- | ----------- | ----- |
|
|
6404
|
+
| **storefront_oid** | **Integer** | | |
|
|
6405
|
+
| **library_oid** | **Integer** | | |
|
|
6406
|
+
| **merchant_id** | **String** | | |
|
|
6407
|
+
|
|
6408
|
+
### Return type
|
|
6409
|
+
|
|
6410
|
+
[**SfvbLibraryUnshareResult**](SfvbLibraryUnshareResult.md)
|
|
6411
|
+
|
|
6412
|
+
### Authorization
|
|
6413
|
+
|
|
6414
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
6415
|
+
|
|
6416
|
+
### HTTP request headers
|
|
6417
|
+
|
|
6418
|
+
- **Content-Type**: Not defined
|
|
6419
|
+
- **Accept**: application/json
|
|
6420
|
+
|
|
6421
|
+
|
|
5587
6422
|
## update_sfvb_blog_post
|
|
5588
6423
|
|
|
5589
6424
|
> <SfvbBlogPostDetail> update_sfvb_blog_post(storefront_oid, blog_post_oid, blog_post_request)
|
|
@@ -5639,6 +6474,62 @@ end
|
|
|
5639
6474
|
- **Accept**: application/json
|
|
5640
6475
|
|
|
5641
6476
|
|
|
6477
|
+
## update_sfvb_library_entry
|
|
6478
|
+
|
|
6479
|
+
> <SfvbLibraryEntry> update_sfvb_library_entry(storefront_oid, library_oid, if_match, library_entry)
|
|
6480
|
+
|
|
6481
|
+
Update a library entry's draft
|
|
6482
|
+
|
|
6483
|
+
A full replace of the draft's fields. Owner only. Send the hash_sha256 you read as If-Match. Every save increments revision_number; nothing other merchants see changes until the draft is published. A changed fragment is re-scanned and its images copied again, and screenshot_stale tells you to retake the screenshot.
|
|
6484
|
+
|
|
6485
|
+
|
|
6486
|
+
### Examples
|
|
6487
|
+
|
|
6488
|
+
|
|
6489
|
+
(No example for this operation).
|
|
6490
|
+
|
|
6491
|
+
|
|
6492
|
+
#### Using the update_sfvb_library_entry_with_http_info variant
|
|
6493
|
+
|
|
6494
|
+
This returns an Array which contains the response data, status code and headers.
|
|
6495
|
+
|
|
6496
|
+
> <Array(<SfvbLibraryEntry>, Integer, Hash)> update_sfvb_library_entry_with_http_info(storefront_oid, library_oid, if_match, library_entry)
|
|
6497
|
+
|
|
6498
|
+
```ruby
|
|
6499
|
+
begin
|
|
6500
|
+
# Update a library entry's draft
|
|
6501
|
+
data, status_code, headers = api_instance.update_sfvb_library_entry_with_http_info(storefront_oid, library_oid, if_match, library_entry)
|
|
6502
|
+
p status_code # => 2xx
|
|
6503
|
+
p headers # => { ... }
|
|
6504
|
+
p data # => <SfvbLibraryEntry>
|
|
6505
|
+
rescue UltracartClient::ApiError => e
|
|
6506
|
+
puts "Error when calling SfvbApi->update_sfvb_library_entry_with_http_info: #{e}"
|
|
6507
|
+
end
|
|
6508
|
+
```
|
|
6509
|
+
|
|
6510
|
+
### Parameters
|
|
6511
|
+
|
|
6512
|
+
| Name | Type | Description | Notes |
|
|
6513
|
+
| ---- | ---- | ----------- | ----- |
|
|
6514
|
+
| **storefront_oid** | **Integer** | | |
|
|
6515
|
+
| **library_oid** | **Integer** | | |
|
|
6516
|
+
| **if_match** | **String** | hash_sha256 from the last read. Required; 428 when absent, 412 when stale. | |
|
|
6517
|
+
| **library_entry** | [**SfvbLibraryEntryRequest**](SfvbLibraryEntryRequest.md) | The whole entry | |
|
|
6518
|
+
|
|
6519
|
+
### Return type
|
|
6520
|
+
|
|
6521
|
+
[**SfvbLibraryEntry**](SfvbLibraryEntry.md)
|
|
6522
|
+
|
|
6523
|
+
### Authorization
|
|
6524
|
+
|
|
6525
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
6526
|
+
|
|
6527
|
+
### HTTP request headers
|
|
6528
|
+
|
|
6529
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
6530
|
+
- **Accept**: application/json
|
|
6531
|
+
|
|
6532
|
+
|
|
5642
6533
|
## update_sfvb_upsell_offer
|
|
5643
6534
|
|
|
5644
6535
|
> <SfvbUpsellOffer> update_sfvb_upsell_offer(storefront_oid, upsell_offer_oid, if_match, upsell_offer)
|