ultracart_api 4.1.252 → 4.1.253
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 +12 -2
- data/docs/SfvbApi.md +168 -2
- data/docs/SfvbApprovalParams.md +6 -0
- data/docs/SfvbPageMoveRequest.md +26 -0
- data/docs/SfvbPageMoveResponse.md +32 -0
- data/docs/SfvbPageResponse.md +4 -0
- data/docs/SfvbPageSettingsRequest.md +6 -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 +224 -4
- 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_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 +22 -1
- data/lib/ultracart_api/models/sfvb_page_settings_request.rb +65 -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 +6 -0
- metadata +14 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: f8041bae71529098837d7bb7fc97a6985ccb38e6a9748eb5209cc2b7794e0a6e
|
|
4
|
+
data.tar.gz: 5bb9a1bed5212ddf1d0bb298584e539fb315561ebf345ed13fc621ada646d36a
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 468a8add5aba8c7163ae989b151deb20838c4ff793f0842dad50a29f36d067cfe3edfeb647254c42f878447c08cf7e6a6eaf808ff5b8b31f50c8acb996fb1987
|
|
7
|
+
data.tar.gz: 68a10eb2595bd3362e0de875c2672d1f6b8db240ca250fe934e7083f70bda32df41369ec770deda579c9766975eb9f074a3d52ad1d78888075540e3ce9f83c84
|
data/README.md
CHANGED
|
@@ -7,7 +7,7 @@ Note: Every method has a sample for every language. See https://github.com/Ultr
|
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
8
8
|
|
|
9
9
|
- API version: 2.0.0
|
|
10
|
-
- Package version: 4.1.
|
|
10
|
+
- Package version: 4.1.253
|
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
12
12
|
- For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
|
|
13
13
|
|
|
@@ -16,7 +16,7 @@ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-g
|
|
|
16
16
|
gemfile:
|
|
17
17
|
|
|
18
18
|
```shell
|
|
19
|
-
gem 'ultracart_api', '4.1.
|
|
19
|
+
gem 'ultracart_api', '4.1.253'
|
|
20
20
|
```
|
|
21
21
|
|
|
22
22
|
install:
|
|
@@ -614,6 +614,7 @@ Class | Method | HTTP request | Description
|
|
|
614
614
|
*UltracartClient::SfvbApi* | [**get_sfvb_recording_settings**](docs/SfvbApi.md#get_sfvb_recording_settings) | **GET** /sfvb/storefronts/{storefront_oid}/recording_settings | Get the storefront's screen recording settings
|
|
615
615
|
*UltracartClient::SfvbApi* | [**get_sfvb_redirect**](docs/SfvbApi.md#get_sfvb_redirect) | **GET** /sfvb/storefronts/{storefront_oid}/redirects/{redirect_id} | Read one redirect rule
|
|
616
616
|
*UltracartClient::SfvbApi* | [**get_sfvb_redirects**](docs/SfvbApi.md#get_sfvb_redirects) | **GET** /sfvb/storefronts/{storefront_oid}/redirects | List the storefront's redirect rules
|
|
617
|
+
*UltracartClient::SfvbApi* | [**get_sfvb_search_facets**](docs/SfvbApi.md#get_sfvb_search_facets) | **GET** /sfvb/storefronts/{storefront_oid}/search/facets | Read the storefront's faceted search configuration
|
|
617
618
|
*UltracartClient::SfvbApi* | [**get_sfvb_secret_kinds**](docs/SfvbApi.md#get_sfvb_secret_kinds) | **GET** /sfvb/secrets/kinds | List the secrets this server collects
|
|
618
619
|
*UltracartClient::SfvbApi* | [**get_sfvb_secret_request**](docs/SfvbApi.md#get_sfvb_secret_request) | **GET** /sfvb/secrets/{request_id} | Read one secret request
|
|
619
620
|
*UltracartClient::SfvbApi* | [**get_sfvb_secret_requests**](docs/SfvbApi.md#get_sfvb_secret_requests) | **GET** /sfvb/secrets | List this sign-in's secret requests
|
|
@@ -687,6 +688,7 @@ Class | Method | HTTP request | Description
|
|
|
687
688
|
*UltracartClient::SfvbApi* | [**list_sfvb_themes**](docs/SfvbApi.md#list_sfvb_themes) | **GET** /sfvb/storefronts/{storefront_oid}/themes | List themes for a storefront
|
|
688
689
|
*UltracartClient::SfvbApi* | [**list_sfvb_upsell_offers**](docs/SfvbApi.md#list_sfvb_upsell_offers) | **GET** /sfvb/storefronts/{storefront_oid}/upsell_offers | List upsell offers
|
|
689
690
|
*UltracartClient::SfvbApi* | [**list_sfvb_upsell_paths**](docs/SfvbApi.md#list_sfvb_upsell_paths) | **GET** /sfvb/storefronts/{storefront_oid}/upsell_paths | List upsell paths
|
|
691
|
+
*UltracartClient::SfvbApi* | [**move_sfvb_page**](docs/SfvbApi.md#move_sfvb_page) | **POST** /sfvb/storefronts/{storefront_oid}/pages/move | Move or rename a page
|
|
690
692
|
*UltracartClient::SfvbApi* | [**move_sfvb_sequence_step**](docs/SfvbApi.md#move_sfvb_sequence_step) | **POST** /sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid}/steps/{step_uuid}/move | Move one step
|
|
691
693
|
*UltracartClient::SfvbApi* | [**move_sfvb_upsell_path**](docs/SfvbApi.md#move_sfvb_upsell_path) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid}/move | Move an upsell path
|
|
692
694
|
*UltracartClient::SfvbApi* | [**proof_sfvb_sequence_postcard**](docs/SfvbApi.md#proof_sfvb_sequence_postcard) | **POST** /sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid}/steps/{step_uuid}/postcard_proof | Proof a postcard step without mailing it
|
|
@@ -764,6 +766,7 @@ Class | Method | HTTP request | Description
|
|
|
764
766
|
*UltracartClient::SfvbApi* | [**update_sfvb_item_default_page**](docs/SfvbApi.md#update_sfvb_item_default_page) | **POST** /sfvb/storefronts/{storefront_oid}/items/default_page | Move items' default (canonical) pages
|
|
765
767
|
*UltracartClient::SfvbApi* | [**update_sfvb_library_entry**](docs/SfvbApi.md#update_sfvb_library_entry) | **PUT** /sfvb/storefronts/{storefront_oid}/library/{library_oid} | Update a library entry's draft
|
|
766
768
|
*UltracartClient::SfvbApi* | [**update_sfvb_redirect**](docs/SfvbApi.md#update_sfvb_redirect) | **PUT** /sfvb/storefronts/{storefront_oid}/redirects/{redirect_id} | Change a redirect rule
|
|
769
|
+
*UltracartClient::SfvbApi* | [**update_sfvb_search_facets**](docs/SfvbApi.md#update_sfvb_search_facets) | **PUT** /sfvb/storefronts/{storefront_oid}/search/facets | Change the storefront's faceted search configuration
|
|
767
770
|
*UltracartClient::SfvbApi* | [**update_sfvb_sequence_step**](docs/SfvbApi.md#update_sfvb_sequence_step) | **PUT** /sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid}/steps/{step_uuid} | Change one step's settings or audience filter
|
|
768
771
|
*UltracartClient::SfvbApi* | [**update_sfvb_site_seo**](docs/SfvbApi.md#update_sfvb_site_seo) | **PUT** /sfvb/storefronts/{storefront_oid}/seo | Change a storefront's search engine settings
|
|
769
772
|
*UltracartClient::SfvbApi* | [**update_sfvb_smart_attribution**](docs/SfvbApi.md#update_sfvb_smart_attribution) | **PUT** /sfvb/storefronts/{storefront_oid}/smart_attribution | Change a storefront's Smart Attribution configuration
|
|
@@ -2253,6 +2256,8 @@ Class | Method | HTTP request | Description
|
|
|
2253
2256
|
- [UltracartClient::SfvbPageItemsRemoveRequest](docs/SfvbPageItemsRemoveRequest.md)
|
|
2254
2257
|
- [UltracartClient::SfvbPageItemsResponse](docs/SfvbPageItemsResponse.md)
|
|
2255
2258
|
- [UltracartClient::SfvbPageListResponse](docs/SfvbPageListResponse.md)
|
|
2259
|
+
- [UltracartClient::SfvbPageMoveRequest](docs/SfvbPageMoveRequest.md)
|
|
2260
|
+
- [UltracartClient::SfvbPageMoveResponse](docs/SfvbPageMoveResponse.md)
|
|
2256
2261
|
- [UltracartClient::SfvbPageMultimedia](docs/SfvbPageMultimedia.md)
|
|
2257
2262
|
- [UltracartClient::SfvbPageMultimediaRequest](docs/SfvbPageMultimediaRequest.md)
|
|
2258
2263
|
- [UltracartClient::SfvbPageRefreshRequest](docs/SfvbPageRefreshRequest.md)
|
|
@@ -2301,6 +2306,10 @@ Class | Method | HTTP request | Description
|
|
|
2301
2306
|
- [UltracartClient::SfvbRenderRequest](docs/SfvbRenderRequest.md)
|
|
2302
2307
|
- [UltracartClient::SfvbRenderResponse](docs/SfvbRenderResponse.md)
|
|
2303
2308
|
- [UltracartClient::SfvbRobotsTxt](docs/SfvbRobotsTxt.md)
|
|
2309
|
+
- [UltracartClient::SfvbSearchFacet](docs/SfvbSearchFacet.md)
|
|
2310
|
+
- [UltracartClient::SfvbSearchFacetUpdate](docs/SfvbSearchFacetUpdate.md)
|
|
2311
|
+
- [UltracartClient::SfvbSearchFacetsRequest](docs/SfvbSearchFacetsRequest.md)
|
|
2312
|
+
- [UltracartClient::SfvbSearchFacetsResponse](docs/SfvbSearchFacetsResponse.md)
|
|
2304
2313
|
- [UltracartClient::SfvbSecretHandle](docs/SfvbSecretHandle.md)
|
|
2305
2314
|
- [UltracartClient::SfvbSecretKind](docs/SfvbSecretKind.md)
|
|
2306
2315
|
- [UltracartClient::SfvbSecretKindsResponse](docs/SfvbSecretKindsResponse.md)
|
|
@@ -2585,6 +2594,7 @@ Not every change is committed to every SDK.
|
|
|
2585
2594
|
|
|
2586
2595
|
| Version | Date | Comments |
|
|
2587
2596
|
| --: | :-: | --- |
|
|
2597
|
+
| 4.1.253 | 11/13/2026 | sfvb internal testing |
|
|
2588
2598
|
| 4.1.252 | 11/12/2026 | sfvb internal testing |
|
|
2589
2599
|
| 4.1.251 | 11/12/2026 | sfvb internal test |
|
|
2590
2600
|
| 4.1.250 | 11/12/2026 | sfvb internal testing |
|
data/docs/SfvbApi.md
CHANGED
|
@@ -142,6 +142,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
142
142
|
| [**get_sfvb_recording_settings**](SfvbApi.md#get_sfvb_recording_settings) | **GET** /sfvb/storefronts/{storefront_oid}/recording_settings | Get the storefront's screen recording settings |
|
|
143
143
|
| [**get_sfvb_redirect**](SfvbApi.md#get_sfvb_redirect) | **GET** /sfvb/storefronts/{storefront_oid}/redirects/{redirect_id} | Read one redirect rule |
|
|
144
144
|
| [**get_sfvb_redirects**](SfvbApi.md#get_sfvb_redirects) | **GET** /sfvb/storefronts/{storefront_oid}/redirects | List the storefront's redirect rules |
|
|
145
|
+
| [**get_sfvb_search_facets**](SfvbApi.md#get_sfvb_search_facets) | **GET** /sfvb/storefronts/{storefront_oid}/search/facets | Read the storefront's faceted search configuration |
|
|
145
146
|
| [**get_sfvb_secret_kinds**](SfvbApi.md#get_sfvb_secret_kinds) | **GET** /sfvb/secrets/kinds | List the secrets this server collects |
|
|
146
147
|
| [**get_sfvb_secret_request**](SfvbApi.md#get_sfvb_secret_request) | **GET** /sfvb/secrets/{request_id} | Read one secret request |
|
|
147
148
|
| [**get_sfvb_secret_requests**](SfvbApi.md#get_sfvb_secret_requests) | **GET** /sfvb/secrets | List this sign-in's secret requests |
|
|
@@ -215,6 +216,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
215
216
|
| [**list_sfvb_themes**](SfvbApi.md#list_sfvb_themes) | **GET** /sfvb/storefronts/{storefront_oid}/themes | List themes for a storefront |
|
|
216
217
|
| [**list_sfvb_upsell_offers**](SfvbApi.md#list_sfvb_upsell_offers) | **GET** /sfvb/storefronts/{storefront_oid}/upsell_offers | List upsell offers |
|
|
217
218
|
| [**list_sfvb_upsell_paths**](SfvbApi.md#list_sfvb_upsell_paths) | **GET** /sfvb/storefronts/{storefront_oid}/upsell_paths | List upsell paths |
|
|
219
|
+
| [**move_sfvb_page**](SfvbApi.md#move_sfvb_page) | **POST** /sfvb/storefronts/{storefront_oid}/pages/move | Move or rename a page |
|
|
218
220
|
| [**move_sfvb_sequence_step**](SfvbApi.md#move_sfvb_sequence_step) | **POST** /sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid}/steps/{step_uuid}/move | Move one step |
|
|
219
221
|
| [**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 |
|
|
220
222
|
| [**proof_sfvb_sequence_postcard**](SfvbApi.md#proof_sfvb_sequence_postcard) | **POST** /sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid}/steps/{step_uuid}/postcard_proof | Proof a postcard step without mailing it |
|
|
@@ -292,6 +294,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
292
294
|
| [**update_sfvb_item_default_page**](SfvbApi.md#update_sfvb_item_default_page) | **POST** /sfvb/storefronts/{storefront_oid}/items/default_page | Move items' default (canonical) pages |
|
|
293
295
|
| [**update_sfvb_library_entry**](SfvbApi.md#update_sfvb_library_entry) | **PUT** /sfvb/storefronts/{storefront_oid}/library/{library_oid} | Update a library entry's draft |
|
|
294
296
|
| [**update_sfvb_redirect**](SfvbApi.md#update_sfvb_redirect) | **PUT** /sfvb/storefronts/{storefront_oid}/redirects/{redirect_id} | Change a redirect rule |
|
|
297
|
+
| [**update_sfvb_search_facets**](SfvbApi.md#update_sfvb_search_facets) | **PUT** /sfvb/storefronts/{storefront_oid}/search/facets | Change the storefront's faceted search configuration |
|
|
295
298
|
| [**update_sfvb_sequence_step**](SfvbApi.md#update_sfvb_sequence_step) | **PUT** /sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid}/steps/{step_uuid} | Change one step's settings or audience filter |
|
|
296
299
|
| [**update_sfvb_site_seo**](SfvbApi.md#update_sfvb_site_seo) | **PUT** /sfvb/storefronts/{storefront_oid}/seo | Change a storefront's search engine settings |
|
|
297
300
|
| [**update_sfvb_smart_attribution**](SfvbApi.md#update_sfvb_smart_attribution) | **PUT** /sfvb/storefronts/{storefront_oid}/smart_attribution | Change a storefront's Smart Attribution configuration |
|
|
@@ -7812,6 +7815,59 @@ end
|
|
|
7812
7815
|
- **Accept**: application/json
|
|
7813
7816
|
|
|
7814
7817
|
|
|
7818
|
+
## get_sfvb_search_facets
|
|
7819
|
+
|
|
7820
|
+
> <SfvbSearchFacetsResponse> get_sfvb_search_facets(storefront_oid)
|
|
7821
|
+
|
|
7822
|
+
Read the storefront's faceted search configuration
|
|
7823
|
+
|
|
7824
|
+
Every facet the storefront can offer shoppers - the standard ones and one per item attribute on the storefront - with its heading and whether it is on, in the fixed order shoppers see them, and the Cost facet's price breaks. The same settings as the store admin's Faceted Search Results. Send hash_sha256 as If-Match to change them.
|
|
7825
|
+
|
|
7826
|
+
|
|
7827
|
+
### Examples
|
|
7828
|
+
|
|
7829
|
+
|
|
7830
|
+
(No example for this operation).
|
|
7831
|
+
|
|
7832
|
+
|
|
7833
|
+
#### Using the get_sfvb_search_facets_with_http_info variant
|
|
7834
|
+
|
|
7835
|
+
This returns an Array which contains the response data, status code and headers.
|
|
7836
|
+
|
|
7837
|
+
> <Array(<SfvbSearchFacetsResponse>, Integer, Hash)> get_sfvb_search_facets_with_http_info(storefront_oid)
|
|
7838
|
+
|
|
7839
|
+
```ruby
|
|
7840
|
+
begin
|
|
7841
|
+
# Read the storefront's faceted search configuration
|
|
7842
|
+
data, status_code, headers = api_instance.get_sfvb_search_facets_with_http_info(storefront_oid)
|
|
7843
|
+
p status_code # => 2xx
|
|
7844
|
+
p headers # => { ... }
|
|
7845
|
+
p data # => <SfvbSearchFacetsResponse>
|
|
7846
|
+
rescue UltracartClient::ApiError => e
|
|
7847
|
+
puts "Error when calling SfvbApi->get_sfvb_search_facets_with_http_info: #{e}"
|
|
7848
|
+
end
|
|
7849
|
+
```
|
|
7850
|
+
|
|
7851
|
+
### Parameters
|
|
7852
|
+
|
|
7853
|
+
| Name | Type | Description | Notes |
|
|
7854
|
+
| ---- | ---- | ----------- | ----- |
|
|
7855
|
+
| **storefront_oid** | **Integer** | | |
|
|
7856
|
+
|
|
7857
|
+
### Return type
|
|
7858
|
+
|
|
7859
|
+
[**SfvbSearchFacetsResponse**](SfvbSearchFacetsResponse.md)
|
|
7860
|
+
|
|
7861
|
+
### Authorization
|
|
7862
|
+
|
|
7863
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
7864
|
+
|
|
7865
|
+
### HTTP request headers
|
|
7866
|
+
|
|
7867
|
+
- **Content-Type**: Not defined
|
|
7868
|
+
- **Accept**: application/json
|
|
7869
|
+
|
|
7870
|
+
|
|
7815
7871
|
## get_sfvb_secret_kinds
|
|
7816
7872
|
|
|
7817
7873
|
> <SfvbSecretKindsResponse> get_sfvb_secret_kinds
|
|
@@ -11781,6 +11837,61 @@ end
|
|
|
11781
11837
|
- **Accept**: application/json
|
|
11782
11838
|
|
|
11783
11839
|
|
|
11840
|
+
## move_sfvb_page
|
|
11841
|
+
|
|
11842
|
+
> <SfvbPageMoveResponse> move_sfvb_page(storefront_oid, page_move_request, opts)
|
|
11843
|
+
|
|
11844
|
+
Move or rename a page
|
|
11845
|
+
|
|
11846
|
+
Moves a page to a new path - a new parent, a new last part, or both, so a rename is a move under the same parent. Its sub-pages, their items and the page folder with its body move with it. Refused for the root page, a path inside the page itself, a path where a page or folder already exists, a parent that does not exist, and a page whose folder holds a started experiment. With redirect_old_url 301 the same call adds one pattern redirect from the old path to the new one, so every old address, sub-pages and items included, keeps working; the redirect is checked before anything moves, and if it is refused after the move the move is undone, so the page moves with its redirect or not at all. dry_run runs every check and reports what would move. Needs sfvb_publish, plus the approval of the person who signed in the CLI, as an approved page.move request for exactly this path, new path and redirect in the Approval-Id header.
|
|
11847
|
+
|
|
11848
|
+
|
|
11849
|
+
### Examples
|
|
11850
|
+
|
|
11851
|
+
|
|
11852
|
+
(No example for this operation).
|
|
11853
|
+
|
|
11854
|
+
|
|
11855
|
+
#### Using the move_sfvb_page_with_http_info variant
|
|
11856
|
+
|
|
11857
|
+
This returns an Array which contains the response data, status code and headers.
|
|
11858
|
+
|
|
11859
|
+
> <Array(<SfvbPageMoveResponse>, Integer, Hash)> move_sfvb_page_with_http_info(storefront_oid, page_move_request, opts)
|
|
11860
|
+
|
|
11861
|
+
```ruby
|
|
11862
|
+
begin
|
|
11863
|
+
# Move or rename a page
|
|
11864
|
+
data, status_code, headers = api_instance.move_sfvb_page_with_http_info(storefront_oid, page_move_request, opts)
|
|
11865
|
+
p status_code # => 2xx
|
|
11866
|
+
p headers # => { ... }
|
|
11867
|
+
p data # => <SfvbPageMoveResponse>
|
|
11868
|
+
rescue UltracartClient::ApiError => e
|
|
11869
|
+
puts "Error when calling SfvbApi->move_sfvb_page_with_http_info: #{e}"
|
|
11870
|
+
end
|
|
11871
|
+
```
|
|
11872
|
+
|
|
11873
|
+
### Parameters
|
|
11874
|
+
|
|
11875
|
+
| Name | Type | Description | Notes |
|
|
11876
|
+
| ---- | ---- | ----------- | ----- |
|
|
11877
|
+
| **storefront_oid** | **Integer** | | |
|
|
11878
|
+
| **page_move_request** | [**SfvbPageMoveRequest**](SfvbPageMoveRequest.md) | The page and where it goes | |
|
|
11879
|
+
| **approval_id** | **String** | The approval_id of an approved page.move request for exactly this path, new path and redirect. Required unless dry_run. See POST /sfvb/approvals. | [optional] |
|
|
11880
|
+
|
|
11881
|
+
### Return type
|
|
11882
|
+
|
|
11883
|
+
[**SfvbPageMoveResponse**](SfvbPageMoveResponse.md)
|
|
11884
|
+
|
|
11885
|
+
### Authorization
|
|
11886
|
+
|
|
11887
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
11888
|
+
|
|
11889
|
+
### HTTP request headers
|
|
11890
|
+
|
|
11891
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
11892
|
+
- **Accept**: application/json
|
|
11893
|
+
|
|
11894
|
+
|
|
11784
11895
|
## move_sfvb_sequence_step
|
|
11785
11896
|
|
|
11786
11897
|
> <SfvbSequenceStepMoveResponse> move_sfvb_sequence_step(storefront_oid, sequence_uuid, step_uuid, if_match, sequence_step_move_request, opts)
|
|
@@ -13084,7 +13195,7 @@ end
|
|
|
13084
13195
|
|
|
13085
13196
|
Change a page's settings
|
|
13086
13197
|
|
|
13087
|
-
A partial update. Only the fields you send change - title, description, templates, visibility, sitemap exclusion, sort orders, items per page and page type. Unlike the store admin's page save, the page's attributes, images, items, selectors and permissions are left exactly as they are. Fields that would move or rename the page, and fields this endpoint does not know, are refused. The root page cannot be hidden. Always needs sfvb_publish, because page settings are live.
|
|
13198
|
+
A partial update. Only the fields you send change - title, description, templates, visibility, sitemap exclusion, sort orders, items per page and page type. Unlike the store admin's page save, the page's attributes, images, items, selectors and permissions are left exactly as they are. Fields that would move or rename the page, and fields this endpoint does not know, are refused. The root page cannot be hidden. Always needs sfvb_publish, because page settings are live. Hiding a page with redirect_old_url 301 and redirect_target also adds a 301 redirect from its address, checked first like any redirect rule. The page is hidden and the rule added together, or neither.
|
|
13088
13199
|
|
|
13089
13200
|
|
|
13090
13201
|
### Examples
|
|
@@ -14157,7 +14268,7 @@ end
|
|
|
14157
14268
|
| **storefront_oid** | **Integer** | | |
|
|
14158
14269
|
| **owner_type** | **String** | | |
|
|
14159
14270
|
| **owner_object_id** | **String** | | |
|
|
14160
|
-
| **if_match** | **String** | CJSON hash of the container being reverted. Required; 428 when absent, 412 when stale. | |
|
|
14271
|
+
| **if_match** | **String** | CJSON hash of the container being reverted. Required while the container holds content; 428 when absent, 412 when stale. Leave it out when the container has been removed, since there is nothing to match. | |
|
|
14161
14272
|
| **container_revert_request** | [**SfvbContainerRevertRequest**](SfvbContainerRevertRequest.md) | Version to revert the container to | |
|
|
14162
14273
|
| **container_name** | **String** | | [optional] |
|
|
14163
14274
|
|
|
@@ -16059,6 +16170,61 @@ end
|
|
|
16059
16170
|
- **Accept**: application/json
|
|
16060
16171
|
|
|
16061
16172
|
|
|
16173
|
+
## update_sfvb_search_facets
|
|
16174
|
+
|
|
16175
|
+
> <SfvbSearchFacetsResponse> update_sfvb_search_facets(storefront_oid, search_facets_request, opts)
|
|
16176
|
+
|
|
16177
|
+
Change the storefront's faceted search configuration
|
|
16178
|
+
|
|
16179
|
+
A partial update. Turn facets on or off, change their headings, and replace the Cost facet's price breaks; facets left out and every other search setting are unchanged. Facets cannot be reordered - the order is fixed. Turning facets on or off, or changing the price breaks, starts a search index rebuild, reported in rebuild. dry_run checks the change and reports it, and the rebuild it would start, without saving. Needs sfvb_publish, because facets show on every search and category page at once.
|
|
16180
|
+
|
|
16181
|
+
|
|
16182
|
+
### Examples
|
|
16183
|
+
|
|
16184
|
+
|
|
16185
|
+
(No example for this operation).
|
|
16186
|
+
|
|
16187
|
+
|
|
16188
|
+
#### Using the update_sfvb_search_facets_with_http_info variant
|
|
16189
|
+
|
|
16190
|
+
This returns an Array which contains the response data, status code and headers.
|
|
16191
|
+
|
|
16192
|
+
> <Array(<SfvbSearchFacetsResponse>, Integer, Hash)> update_sfvb_search_facets_with_http_info(storefront_oid, search_facets_request, opts)
|
|
16193
|
+
|
|
16194
|
+
```ruby
|
|
16195
|
+
begin
|
|
16196
|
+
# Change the storefront's faceted search configuration
|
|
16197
|
+
data, status_code, headers = api_instance.update_sfvb_search_facets_with_http_info(storefront_oid, search_facets_request, opts)
|
|
16198
|
+
p status_code # => 2xx
|
|
16199
|
+
p headers # => { ... }
|
|
16200
|
+
p data # => <SfvbSearchFacetsResponse>
|
|
16201
|
+
rescue UltracartClient::ApiError => e
|
|
16202
|
+
puts "Error when calling SfvbApi->update_sfvb_search_facets_with_http_info: #{e}"
|
|
16203
|
+
end
|
|
16204
|
+
```
|
|
16205
|
+
|
|
16206
|
+
### Parameters
|
|
16207
|
+
|
|
16208
|
+
| Name | Type | Description | Notes |
|
|
16209
|
+
| ---- | ---- | ----------- | ----- |
|
|
16210
|
+
| **storefront_oid** | **Integer** | | |
|
|
16211
|
+
| **search_facets_request** | [**SfvbSearchFacetsRequest**](SfvbSearchFacetsRequest.md) | The facets and price breaks to change | |
|
|
16212
|
+
| **if_match** | **String** | hash_sha256 from the last read. Required unless dry_run; 428 when absent, 412 when stale. | [optional] |
|
|
16213
|
+
|
|
16214
|
+
### Return type
|
|
16215
|
+
|
|
16216
|
+
[**SfvbSearchFacetsResponse**](SfvbSearchFacetsResponse.md)
|
|
16217
|
+
|
|
16218
|
+
### Authorization
|
|
16219
|
+
|
|
16220
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
16221
|
+
|
|
16222
|
+
### HTTP request headers
|
|
16223
|
+
|
|
16224
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
16225
|
+
- **Accept**: application/json
|
|
16226
|
+
|
|
16227
|
+
|
|
16062
16228
|
## update_sfvb_sequence_step
|
|
16063
16229
|
|
|
16064
16230
|
> <SfvbSequenceStepUpdateResponse> update_sfvb_sequence_step(storefront_oid, sequence_uuid, step_uuid, if_match, sequence_step_update_request, opts)
|
data/docs/SfvbApprovalParams.md
CHANGED
|
@@ -15,7 +15,10 @@
|
|
|
15
15
|
| **experiment_oid** | **Integer** | For experiment.end, the experiment to end. | [optional] |
|
|
16
16
|
| **item_count** | **Integer** | For item.attribute_batch, how many items the batch would change when it was requested. Set by the server. | [optional] |
|
|
17
17
|
| **merchant_item_oid** | **Integer** | For item.pricing, the item whose pricing changes. | [optional] |
|
|
18
|
+
| **new_path** | **String** | For page.move, where the page goes, exactly as the move will send it. path is the page as it is now. | [optional] |
|
|
19
|
+
| **pages_moved** | **Integer** | For page.move, how many pages move, the page itself included, when it was requested. Set by the server. | [optional] |
|
|
18
20
|
| **path** | **String** | The file path, for file.delete, file.put_script and file.put_template, or the page path for experiment.start of a page experiment. Exactly as the gated call will send it. | [optional] |
|
|
21
|
+
| **redirect_old_url** | **String** | For page.move, 301 when the move also redirects the old addresses, as the move will send it. Left out or none for no redirect. | [optional] |
|
|
19
22
|
| **request_sha256** | **String** | For experiment.start of a url experiment, the hash of the checked experiment approved, for item.pricing, tracking_provider.change and affiliate_network.change the hash of the change, and for smart_attribution.change the hash of the configuration the change would store. Set by the server. The gated call must send the same. | [optional] |
|
|
20
23
|
| **rows_sha256** | **String** | For redirect.delete_batch and item.attribute_batch, the plan_hash of the exact rows approved. Set by the server. The batch must send rows with this hash. | [optional] |
|
|
21
24
|
| **rule_count** | **Integer** | For redirect.delete_batch, how many rules the batch would delete when it was requested. Set by the server. | [optional] |
|
|
@@ -48,7 +51,10 @@ instance = UltracartClient::SfvbApprovalParams.new(
|
|
|
48
51
|
experiment_oid: null,
|
|
49
52
|
item_count: null,
|
|
50
53
|
merchant_item_oid: null,
|
|
54
|
+
new_path: null,
|
|
55
|
+
pages_moved: null,
|
|
51
56
|
path: null,
|
|
57
|
+
redirect_old_url: null,
|
|
52
58
|
request_sha256: null,
|
|
53
59
|
rows_sha256: null,
|
|
54
60
|
rule_count: null,
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# UltracartClient::SfvbPageMoveRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **dry_run** | **Boolean** | True to run every check and report what would move, without moving anything or needing an approval. | [optional] |
|
|
8
|
+
| **new_path** | **String** | Where the page goes, for example /lp/summer-sale/ or /sale/spring/. Its parent page must exist, and nothing may be at this path yet. | [optional] |
|
|
9
|
+
| **path** | **String** | The page to move, for example /lp/spring-sale/. | [optional] |
|
|
10
|
+
| **redirect_note** | **String** | The note on that redirect rule. Up to 500 characters. A note naming the move is used when left out. | [optional] |
|
|
11
|
+
| **redirect_old_url** | **String** | 301 to add one pattern redirect from the old path, sub-pages and items included, to the new one in the same call. Leave it out to add none, and the old addresses answer 404. | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'ultracart_api'
|
|
17
|
+
|
|
18
|
+
instance = UltracartClient::SfvbPageMoveRequest.new(
|
|
19
|
+
dry_run: null,
|
|
20
|
+
new_path: null,
|
|
21
|
+
path: null,
|
|
22
|
+
redirect_note: null,
|
|
23
|
+
redirect_old_url: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -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
|
@@ -14,6 +14,8 @@
|
|
|
14
14
|
| **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
15
|
| **page_type** | **String** | S for a static page, D for a dynamic one. | [optional] |
|
|
16
16
|
| **path** | **String** | The page path, normalized to begin and end with a slash. | [optional] |
|
|
17
|
+
| **redirect** | [**SfvbRedirect**](SfvbRedirect.md) | | [optional] |
|
|
18
|
+
| **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
19
|
| **review_template** | **String** | Template that renders the item review pages under this page. Omitted when not set. | [optional] |
|
|
18
20
|
| **sort_order** | **Integer** | Position among its siblings when the parent sorts child pages by a custom order. Omitted when not set. | [optional] |
|
|
19
21
|
| **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] |
|
|
@@ -38,6 +40,8 @@ instance = UltracartClient::SfvbPageResponse.new(
|
|
|
38
40
|
multimedia: null,
|
|
39
41
|
page_type: null,
|
|
40
42
|
path: null,
|
|
43
|
+
redirect: null,
|
|
44
|
+
redirect_warnings: null,
|
|
41
45
|
review_template: null,
|
|
42
46
|
sort_order: null,
|
|
43
47
|
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,
|
|
@@ -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
|
+
|