ultracart_api 4.1.252 → 4.1.254
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 +17 -2
- data/docs/SfvbApi.md +238 -12
- data/docs/SfvbApprovalParams.md +6 -0
- data/docs/SfvbFileContentResult.md +22 -0
- data/docs/SfvbFilesContentRequest.md +18 -0
- data/docs/SfvbFilesContentResponse.md +20 -0
- data/docs/SfvbMenusResponse.md +1 -1
- data/docs/SfvbPageListResponse.md +5 -1
- data/docs/SfvbPageMoveRequest.md +26 -0
- data/docs/SfvbPageMoveResponse.md +32 -0
- data/docs/SfvbPageResponse.md +6 -0
- data/docs/SfvbPageSettingsRequest.md +6 -0
- data/docs/SfvbPageSummary.md +4 -0
- data/docs/SfvbSearchFacet.md +26 -0
- data/docs/SfvbSearchFacetUpdate.md +24 -0
- data/docs/SfvbSearchFacetsRequest.md +22 -0
- data/docs/SfvbSearchFacetsResponse.md +30 -0
- data/lib/ultracart_api/api/sfvb_api.rb +326 -20
- data/lib/ultracart_api/models/sfvb_approval_create_request.rb +2 -2
- data/lib/ultracart_api/models/sfvb_approval_params.rb +31 -1
- data/lib/ultracart_api/models/sfvb_file_content_result.rb +238 -0
- data/lib/ultracart_api/models/sfvb_files_content_request.rb +222 -0
- data/lib/ultracart_api/models/sfvb_files_content_response.rb +234 -0
- data/lib/ultracart_api/models/sfvb_menus_response.rb +1 -1
- data/lib/ultracart_api/models/sfvb_page_list_response.rb +24 -4
- data/lib/ultracart_api/models/sfvb_page_move_request.rb +294 -0
- data/lib/ultracart_api/models/sfvb_page_move_response.rb +290 -0
- data/lib/ultracart_api/models/sfvb_page_response.rb +32 -1
- data/lib/ultracart_api/models/sfvb_page_settings_request.rb +65 -1
- data/lib/ultracart_api/models/sfvb_page_summary.rb +20 -1
- data/lib/ultracart_api/models/sfvb_search_facet.rb +260 -0
- data/lib/ultracart_api/models/sfvb_search_facet_update.rb +250 -0
- data/lib/ultracart_api/models/sfvb_search_facets_request.rb +244 -0
- data/lib/ultracart_api/models/sfvb_search_facets_response.rb +286 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +9 -0
- metadata +20 -2
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# UltracartClient::SfvbPageMoveResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **dry_run** | **Boolean** | True when nothing was moved. | [optional] |
|
|
8
|
+
| **new_path** | **String** | The page's path after the move. | [optional] |
|
|
9
|
+
| **page** | [**SfvbPageResponse**](SfvbPageResponse.md) | | [optional] |
|
|
10
|
+
| **pages_moved** | **Integer** | How many pages moved, the page itself included. | [optional] |
|
|
11
|
+
| **path** | **String** | The page's path before the move. | [optional] |
|
|
12
|
+
| **redirect** | [**SfvbRedirect**](SfvbRedirect.md) | | [optional] |
|
|
13
|
+
| **redirect_source** | **String** | The pattern the old addresses redirect from, when a redirect was asked for. | [optional] |
|
|
14
|
+
| **warnings** | [**Array<SfvbErrorDetail>**](SfvbErrorDetail.md) | Findings that did not block the move, such as a redirect chain. | [optional] |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'ultracart_api'
|
|
20
|
+
|
|
21
|
+
instance = UltracartClient::SfvbPageMoveResponse.new(
|
|
22
|
+
dry_run: null,
|
|
23
|
+
new_path: null,
|
|
24
|
+
page: null,
|
|
25
|
+
pages_moved: null,
|
|
26
|
+
path: null,
|
|
27
|
+
redirect: null,
|
|
28
|
+
redirect_source: null,
|
|
29
|
+
warnings: null
|
|
30
|
+
)
|
|
31
|
+
```
|
|
32
|
+
|
data/docs/SfvbPageResponse.md
CHANGED
|
@@ -6,6 +6,7 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **attributes** | [**Array<SfvbPageAttribute>**](SfvbPageAttribute.md) | Every attribute this page has, including ones a template declares but nothing has set yet. These are what the pageattribute element renders. Sorted by name. | [optional] |
|
|
8
8
|
| **blog_post_template** | **String** | Template that renders the blog posts under this page. Omitted when not set. | [optional] |
|
|
9
|
+
| **catalog_group_oid** | **Integer** | The page's id. It stays the same when the page is moved or renamed, where the path and the page folder's id do not. The page read accepts it in place of path. | [optional] |
|
|
9
10
|
| **description** | **String** | The page description, the text a page template renders as the page's description. Omitted when empty. | [optional] |
|
|
10
11
|
| **exclude_from_sitemap** | **Boolean** | True when the page is left out of the sitemap and marked noindex. | [optional] |
|
|
11
12
|
| **group_template** | **String** | Template file that renders the page itself, a bare .vm name found anywhere in the active theme. | [optional] |
|
|
@@ -14,6 +15,8 @@
|
|
|
14
15
|
| **multimedia** | [**Array<SfvbPageMultimedia>**](SfvbPageMultimedia.md) | The page's images, including codes a template declares but nothing has attached yet. These are what the pageimage element renders - the default image when pageImageCode is empty, otherwise the image with that code. The default image comes first. | [optional] |
|
|
15
16
|
| **page_type** | **String** | S for a static page, D for a dynamic one. | [optional] |
|
|
16
17
|
| **path** | **String** | The page path, normalized to begin and end with a slash. | [optional] |
|
|
18
|
+
| **redirect** | [**SfvbRedirect**](SfvbRedirect.md) | | [optional] |
|
|
19
|
+
| **redirect_warnings** | [**Array<SfvbErrorDetail>**](SfvbErrorDetail.md) | Findings on that redirect that did not block it, such as a chain. Left out when there are none. | [optional] |
|
|
17
20
|
| **review_template** | **String** | Template that renders the item review pages under this page. Omitted when not set. | [optional] |
|
|
18
21
|
| **sort_order** | **Integer** | Position among its siblings when the parent sorts child pages by a custom order. Omitted when not set. | [optional] |
|
|
19
22
|
| **sort_order_child_groups** | **String** | How the pages under this one are ordered. TA or TD by title, DA or DD by description, C custom. | [optional] |
|
|
@@ -30,6 +33,7 @@ require 'ultracart_api'
|
|
|
30
33
|
instance = UltracartClient::SfvbPageResponse.new(
|
|
31
34
|
attributes: null,
|
|
32
35
|
blog_post_template: null,
|
|
36
|
+
catalog_group_oid: null,
|
|
33
37
|
description: null,
|
|
34
38
|
exclude_from_sitemap: null,
|
|
35
39
|
group_template: null,
|
|
@@ -38,6 +42,8 @@ instance = UltracartClient::SfvbPageResponse.new(
|
|
|
38
42
|
multimedia: null,
|
|
39
43
|
page_type: null,
|
|
40
44
|
path: null,
|
|
45
|
+
redirect: null,
|
|
46
|
+
redirect_warnings: null,
|
|
41
47
|
review_template: null,
|
|
42
48
|
sort_order: null,
|
|
43
49
|
sort_order_child_groups: null,
|
|
@@ -11,6 +11,9 @@
|
|
|
11
11
|
| **item_template** | **String** | Template that renders the item pages under this page. | [optional] |
|
|
12
12
|
| **items_per_page** | **Integer** | Items per page on a template that paginates. Null returns to the template's default. | [optional] |
|
|
13
13
|
| **page_type** | **String** | S for a static page, D for a dynamic one. | [optional] |
|
|
14
|
+
| **redirect_note** | **String** | The note on that redirect rule. Up to 500 characters. A note naming the page is used when left out. | [optional] |
|
|
15
|
+
| **redirect_old_url** | **String** | 301 to redirect the page's address to redirect_target in the same call (#1102). Only with visible false, on a page that is visible now. The page is hidden and the rule added together, or neither. | [optional] |
|
|
16
|
+
| **redirect_target** | **String** | Where the hidden page's address redirects to, for example /lp/summer-sale/. Required with redirect_old_url, and checked like any redirect rule. | [optional] |
|
|
14
17
|
| **review_template** | **String** | Template that renders the item review pages under this page. | [optional] |
|
|
15
18
|
| **sort_order** | **Integer** | Position among its siblings when the parent sorts child pages by a custom order. Null clears it. | [optional] |
|
|
16
19
|
| **sort_order_child_groups** | **String** | How the pages under this one are ordered. TA or TD by title, DA or DD by description, C custom. | [optional] |
|
|
@@ -32,6 +35,9 @@ instance = UltracartClient::SfvbPageSettingsRequest.new(
|
|
|
32
35
|
item_template: null,
|
|
33
36
|
items_per_page: null,
|
|
34
37
|
page_type: null,
|
|
38
|
+
redirect_note: null,
|
|
39
|
+
redirect_old_url: null,
|
|
40
|
+
redirect_target: null,
|
|
35
41
|
review_template: null,
|
|
36
42
|
sort_order: null,
|
|
37
43
|
sort_order_child_groups: null,
|
data/docs/SfvbPageSummary.md
CHANGED
|
@@ -4,7 +4,9 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **catalog_group_oid** | **Integer** | The page's id. It stays the same when the page is moved or renamed, where the path and the page folder's id do not, and it is what a menu entry's catalog_group_oid names. | [optional] |
|
|
7
8
|
| **child_count** | **Integer** | Number of pages directly under this one. | [optional] |
|
|
9
|
+
| **detail** | [**SfvbPageResponse**](SfvbPageResponse.md) | | [optional] |
|
|
8
10
|
| **exclude_from_sitemap** | **Boolean** | True when the page is left out of the sitemap and marked noindex. | [optional] |
|
|
9
11
|
| **group_template** | **String** | Template file that renders the page itself, a bare .vm name found anywhere in the active theme. | [optional] |
|
|
10
12
|
| **item_count** | **Integer** | Number of items assigned to the page. The catalog stops counting at its per-page item ceiling. | [optional] |
|
|
@@ -25,7 +27,9 @@
|
|
|
25
27
|
require 'ultracart_api'
|
|
26
28
|
|
|
27
29
|
instance = UltracartClient::SfvbPageSummary.new(
|
|
30
|
+
catalog_group_oid: null,
|
|
28
31
|
child_count: null,
|
|
32
|
+
detail: null,
|
|
29
33
|
exclude_from_sitemap: null,
|
|
30
34
|
group_template: null,
|
|
31
35
|
item_count: null,
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# UltracartClient::SfvbSearchFacet
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **csv** | **Boolean** | True when the attribute values are comma separated lists, each value its own choice. | [optional] |
|
|
8
|
+
| **display_name** | **String** | The heading shoppers see for the facet. | [optional] |
|
|
9
|
+
| **enabled** | **Boolean** | True when the facet is offered to shoppers. | [optional] |
|
|
10
|
+
| **label** | **String** | What the facet is, such as Cost or Attribute color. Fixed. | [optional] |
|
|
11
|
+
| **name** | **String** | The facet key, such as facet_cost or facet_attrcolor. Fixed; this is how a change names the facet. | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'ultracart_api'
|
|
17
|
+
|
|
18
|
+
instance = UltracartClient::SfvbSearchFacet.new(
|
|
19
|
+
csv: null,
|
|
20
|
+
display_name: null,
|
|
21
|
+
enabled: null,
|
|
22
|
+
label: null,
|
|
23
|
+
name: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# UltracartClient::SfvbSearchFacetUpdate
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **csv** | **Boolean** | True when the attribute values are comma separated lists. | [optional] |
|
|
8
|
+
| **display_name** | **String** | The heading shoppers see, 1 to 100 characters, without angle brackets. | [optional] |
|
|
9
|
+
| **enabled** | **Boolean** | True to offer the facet to shoppers, false to stop. | [optional] |
|
|
10
|
+
| **name** | **String** | The facet to change, a name from GET search/facets. Required. | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'ultracart_api'
|
|
16
|
+
|
|
17
|
+
instance = UltracartClient::SfvbSearchFacetUpdate.new(
|
|
18
|
+
csv: null,
|
|
19
|
+
display_name: null,
|
|
20
|
+
enabled: null,
|
|
21
|
+
name: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# UltracartClient::SfvbSearchFacetsRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **cost_price_points** | **Array<Integer>** | The Cost facet price breaks, 1 to 20 whole amounts in the base currency, each 1 to 10,000,000, smallest first. Replaces the list. | [optional] |
|
|
8
|
+
| **dry_run** | **Boolean** | True to check the change and report it without saving. | [optional] |
|
|
9
|
+
| **facets** | [**Array<SfvbSearchFacetUpdate>**](SfvbSearchFacetUpdate.md) | The facets to change. | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'ultracart_api'
|
|
15
|
+
|
|
16
|
+
instance = UltracartClient::SfvbSearchFacetsRequest.new(
|
|
17
|
+
cost_price_points: null,
|
|
18
|
+
dry_run: null,
|
|
19
|
+
facets: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# UltracartClient::SfvbSearchFacetsResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **changed_facets** | **Array<String>** | After a change, the facets it changed. | [optional] |
|
|
8
|
+
| **cost_price_points** | **Array<Integer>** | The Cost facet price breaks, smallest first. | [optional] |
|
|
9
|
+
| **dry_run** | **Boolean** | True when nothing was saved. | [optional] |
|
|
10
|
+
| **facets** | [**Array<SfvbSearchFacet>**](SfvbSearchFacet.md) | Every facet the storefront can offer, in the fixed order shoppers see them. | [optional] |
|
|
11
|
+
| **hash_sha256** | **String** | Hash of the facets and price points. Send it as If-Match on a change. | [optional] |
|
|
12
|
+
| **price_points_changed** | **Boolean** | After a change, true when the price points changed. | [optional] |
|
|
13
|
+
| **rebuild** | **String** | After a change, the search index rebuild it started. none, quick (minutes, small catalogs), slow (the regular rebuild cycle) or failed (the change is saved but the rebuild could not be started; save again or contact support). | [optional] |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'ultracart_api'
|
|
19
|
+
|
|
20
|
+
instance = UltracartClient::SfvbSearchFacetsResponse.new(
|
|
21
|
+
changed_facets: null,
|
|
22
|
+
cost_price_points: null,
|
|
23
|
+
dry_run: null,
|
|
24
|
+
facets: null,
|
|
25
|
+
hash_sha256: null,
|
|
26
|
+
price_points_changed: null,
|
|
27
|
+
rebuild: null
|
|
28
|
+
)
|
|
29
|
+
```
|
|
30
|
+
|