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
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 42d685924ad17c46598a304075febe9a3904bd694c2305181a6bc9637055744d
|
|
4
|
+
data.tar.gz: 52c6a1cfd85fd4bef13748d38c68390c533110231f55cafc3784e129d14a1d47
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: bb24259c7d3f32abff75df743339ec0903bd3d4cfa6e6af9087fb8958f0c2966b93be48fd32d4307a03326d4346a88d8f0efe854e78e70af0bd1fb54f869d1b1
|
|
7
|
+
data.tar.gz: 65b75bbb659dc43019066328075e72a010814fac034d99e8b7a1069ba2184867b0bfbe84d4a4a98dd9154f8ae3bda9ba4ba74cf97acc377ccc6e9bd5cd892eda
|
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.254
|
|
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.254'
|
|
20
20
|
```
|
|
21
21
|
|
|
22
22
|
install:
|
|
@@ -579,6 +579,7 @@ Class | Method | HTTP request | Description
|
|
|
579
579
|
*UltracartClient::SfvbApi* | [**get_sfvb_experiment**](docs/SfvbApi.md#get_sfvb_experiment) | **GET** /sfvb/storefronts/{storefront_oid}/experiments/{experiment_oid} | Read one experiment and its statistics
|
|
580
580
|
*UltracartClient::SfvbApi* | [**get_sfvb_experiment_objectives**](docs/SfvbApi.md#get_sfvb_experiment_objectives) | **GET** /sfvb/storefronts/{storefront_oid}/experiments/objectives | List the objectives an experiment can optimize
|
|
581
581
|
*UltracartClient::SfvbApi* | [**get_sfvb_file_content**](docs/SfvbApi.md#get_sfvb_file_content) | **GET** /sfvb/storefronts/{storefront_oid}/files/content | Read a storefront file
|
|
582
|
+
*UltracartClient::SfvbApi* | [**get_sfvb_file_contents**](docs/SfvbApi.md#get_sfvb_file_contents) | **POST** /sfvb/storefronts/{storefront_oid}/files/content | Read several storefront files
|
|
582
583
|
*UltracartClient::SfvbApi* | [**get_sfvb_file_upload_url**](docs/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
|
|
583
584
|
*UltracartClient::SfvbApi* | [**get_sfvb_flow**](docs/SfvbApi.md#get_sfvb_flow) | **GET** /sfvb/storefronts/{storefront_oid}/flows/{flow_uuid} | Get a flow
|
|
584
585
|
*UltracartClient::SfvbApi* | [**get_sfvb_i18n_glossary**](docs/SfvbApi.md#get_sfvb_i18n_glossary) | **GET** /sfvb/storefronts/{storefront_oid}/i18n/glossary | Read the storefront's translation glossary
|
|
@@ -614,6 +615,7 @@ Class | Method | HTTP request | Description
|
|
|
614
615
|
*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
616
|
*UltracartClient::SfvbApi* | [**get_sfvb_redirect**](docs/SfvbApi.md#get_sfvb_redirect) | **GET** /sfvb/storefronts/{storefront_oid}/redirects/{redirect_id} | Read one redirect rule
|
|
616
617
|
*UltracartClient::SfvbApi* | [**get_sfvb_redirects**](docs/SfvbApi.md#get_sfvb_redirects) | **GET** /sfvb/storefronts/{storefront_oid}/redirects | List the storefront's redirect rules
|
|
618
|
+
*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
619
|
*UltracartClient::SfvbApi* | [**get_sfvb_secret_kinds**](docs/SfvbApi.md#get_sfvb_secret_kinds) | **GET** /sfvb/secrets/kinds | List the secrets this server collects
|
|
618
620
|
*UltracartClient::SfvbApi* | [**get_sfvb_secret_request**](docs/SfvbApi.md#get_sfvb_secret_request) | **GET** /sfvb/secrets/{request_id} | Read one secret request
|
|
619
621
|
*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 +689,7 @@ Class | Method | HTTP request | Description
|
|
|
687
689
|
*UltracartClient::SfvbApi* | [**list_sfvb_themes**](docs/SfvbApi.md#list_sfvb_themes) | **GET** /sfvb/storefronts/{storefront_oid}/themes | List themes for a storefront
|
|
688
690
|
*UltracartClient::SfvbApi* | [**list_sfvb_upsell_offers**](docs/SfvbApi.md#list_sfvb_upsell_offers) | **GET** /sfvb/storefronts/{storefront_oid}/upsell_offers | List upsell offers
|
|
689
691
|
*UltracartClient::SfvbApi* | [**list_sfvb_upsell_paths**](docs/SfvbApi.md#list_sfvb_upsell_paths) | **GET** /sfvb/storefronts/{storefront_oid}/upsell_paths | List upsell paths
|
|
692
|
+
*UltracartClient::SfvbApi* | [**move_sfvb_page**](docs/SfvbApi.md#move_sfvb_page) | **POST** /sfvb/storefronts/{storefront_oid}/pages/move | Move or rename a page
|
|
690
693
|
*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
694
|
*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
695
|
*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 +767,7 @@ Class | Method | HTTP request | Description
|
|
|
764
767
|
*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
768
|
*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
769
|
*UltracartClient::SfvbApi* | [**update_sfvb_redirect**](docs/SfvbApi.md#update_sfvb_redirect) | **PUT** /sfvb/storefronts/{storefront_oid}/redirects/{redirect_id} | Change a redirect rule
|
|
770
|
+
*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
771
|
*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
772
|
*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
773
|
*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
|
|
@@ -2126,6 +2130,7 @@ Class | Method | HTTP request | Description
|
|
|
2126
2130
|
- [UltracartClient::SfvbExperimentVariationUpdateRequest](docs/SfvbExperimentVariationUpdateRequest.md)
|
|
2127
2131
|
- [UltracartClient::SfvbExperimentsResponse](docs/SfvbExperimentsResponse.md)
|
|
2128
2132
|
- [UltracartClient::SfvbFileContentResponse](docs/SfvbFileContentResponse.md)
|
|
2133
|
+
- [UltracartClient::SfvbFileContentResult](docs/SfvbFileContentResult.md)
|
|
2129
2134
|
- [UltracartClient::SfvbFileEntry](docs/SfvbFileEntry.md)
|
|
2130
2135
|
- [UltracartClient::SfvbFileRevertRequest](docs/SfvbFileRevertRequest.md)
|
|
2131
2136
|
- [UltracartClient::SfvbFileSearchRequest](docs/SfvbFileSearchRequest.md)
|
|
@@ -2136,6 +2141,8 @@ Class | Method | HTTP request | Description
|
|
|
2136
2141
|
- [UltracartClient::SfvbFileVersionsResponse](docs/SfvbFileVersionsResponse.md)
|
|
2137
2142
|
- [UltracartClient::SfvbFileWriteRequest](docs/SfvbFileWriteRequest.md)
|
|
2138
2143
|
- [UltracartClient::SfvbFileWriteResponse](docs/SfvbFileWriteResponse.md)
|
|
2144
|
+
- [UltracartClient::SfvbFilesContentRequest](docs/SfvbFilesContentRequest.md)
|
|
2145
|
+
- [UltracartClient::SfvbFilesContentResponse](docs/SfvbFilesContentResponse.md)
|
|
2139
2146
|
- [UltracartClient::SfvbFilesResponse](docs/SfvbFilesResponse.md)
|
|
2140
2147
|
- [UltracartClient::SfvbFlow](docs/SfvbFlow.md)
|
|
2141
2148
|
- [UltracartClient::SfvbFlowBackfillRequest](docs/SfvbFlowBackfillRequest.md)
|
|
@@ -2253,6 +2260,8 @@ Class | Method | HTTP request | Description
|
|
|
2253
2260
|
- [UltracartClient::SfvbPageItemsRemoveRequest](docs/SfvbPageItemsRemoveRequest.md)
|
|
2254
2261
|
- [UltracartClient::SfvbPageItemsResponse](docs/SfvbPageItemsResponse.md)
|
|
2255
2262
|
- [UltracartClient::SfvbPageListResponse](docs/SfvbPageListResponse.md)
|
|
2263
|
+
- [UltracartClient::SfvbPageMoveRequest](docs/SfvbPageMoveRequest.md)
|
|
2264
|
+
- [UltracartClient::SfvbPageMoveResponse](docs/SfvbPageMoveResponse.md)
|
|
2256
2265
|
- [UltracartClient::SfvbPageMultimedia](docs/SfvbPageMultimedia.md)
|
|
2257
2266
|
- [UltracartClient::SfvbPageMultimediaRequest](docs/SfvbPageMultimediaRequest.md)
|
|
2258
2267
|
- [UltracartClient::SfvbPageRefreshRequest](docs/SfvbPageRefreshRequest.md)
|
|
@@ -2301,6 +2310,10 @@ Class | Method | HTTP request | Description
|
|
|
2301
2310
|
- [UltracartClient::SfvbRenderRequest](docs/SfvbRenderRequest.md)
|
|
2302
2311
|
- [UltracartClient::SfvbRenderResponse](docs/SfvbRenderResponse.md)
|
|
2303
2312
|
- [UltracartClient::SfvbRobotsTxt](docs/SfvbRobotsTxt.md)
|
|
2313
|
+
- [UltracartClient::SfvbSearchFacet](docs/SfvbSearchFacet.md)
|
|
2314
|
+
- [UltracartClient::SfvbSearchFacetUpdate](docs/SfvbSearchFacetUpdate.md)
|
|
2315
|
+
- [UltracartClient::SfvbSearchFacetsRequest](docs/SfvbSearchFacetsRequest.md)
|
|
2316
|
+
- [UltracartClient::SfvbSearchFacetsResponse](docs/SfvbSearchFacetsResponse.md)
|
|
2304
2317
|
- [UltracartClient::SfvbSecretHandle](docs/SfvbSecretHandle.md)
|
|
2305
2318
|
- [UltracartClient::SfvbSecretKind](docs/SfvbSecretKind.md)
|
|
2306
2319
|
- [UltracartClient::SfvbSecretKindsResponse](docs/SfvbSecretKindsResponse.md)
|
|
@@ -2585,6 +2598,8 @@ Not every change is committed to every SDK.
|
|
|
2585
2598
|
|
|
2586
2599
|
| Version | Date | Comments |
|
|
2587
2600
|
| --: | :-: | --- |
|
|
2601
|
+
| 4.1.254 | 11/15/2026 | sfvb internal testing |
|
|
2602
|
+
| 4.1.253 | 11/13/2026 | sfvb internal testing |
|
|
2588
2603
|
| 4.1.252 | 11/12/2026 | sfvb internal testing |
|
|
2589
2604
|
| 4.1.251 | 11/12/2026 | sfvb internal test |
|
|
2590
2605
|
| 4.1.250 | 11/12/2026 | sfvb internal testing |
|
data/docs/SfvbApi.md
CHANGED
|
@@ -107,6 +107,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
107
107
|
| [**get_sfvb_experiment**](SfvbApi.md#get_sfvb_experiment) | **GET** /sfvb/storefronts/{storefront_oid}/experiments/{experiment_oid} | Read one experiment and its statistics |
|
|
108
108
|
| [**get_sfvb_experiment_objectives**](SfvbApi.md#get_sfvb_experiment_objectives) | **GET** /sfvb/storefronts/{storefront_oid}/experiments/objectives | List the objectives an experiment can optimize |
|
|
109
109
|
| [**get_sfvb_file_content**](SfvbApi.md#get_sfvb_file_content) | **GET** /sfvb/storefronts/{storefront_oid}/files/content | Read a storefront file |
|
|
110
|
+
| [**get_sfvb_file_contents**](SfvbApi.md#get_sfvb_file_contents) | **POST** /sfvb/storefronts/{storefront_oid}/files/content | Read several storefront files |
|
|
110
111
|
| [**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 |
|
|
111
112
|
| [**get_sfvb_flow**](SfvbApi.md#get_sfvb_flow) | **GET** /sfvb/storefronts/{storefront_oid}/flows/{flow_uuid} | Get a flow |
|
|
112
113
|
| [**get_sfvb_i18n_glossary**](SfvbApi.md#get_sfvb_i18n_glossary) | **GET** /sfvb/storefronts/{storefront_oid}/i18n/glossary | Read the storefront's translation glossary |
|
|
@@ -142,6 +143,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
142
143
|
| [**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
144
|
| [**get_sfvb_redirect**](SfvbApi.md#get_sfvb_redirect) | **GET** /sfvb/storefronts/{storefront_oid}/redirects/{redirect_id} | Read one redirect rule |
|
|
144
145
|
| [**get_sfvb_redirects**](SfvbApi.md#get_sfvb_redirects) | **GET** /sfvb/storefronts/{storefront_oid}/redirects | List the storefront's redirect rules |
|
|
146
|
+
| [**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
147
|
| [**get_sfvb_secret_kinds**](SfvbApi.md#get_sfvb_secret_kinds) | **GET** /sfvb/secrets/kinds | List the secrets this server collects |
|
|
146
148
|
| [**get_sfvb_secret_request**](SfvbApi.md#get_sfvb_secret_request) | **GET** /sfvb/secrets/{request_id} | Read one secret request |
|
|
147
149
|
| [**get_sfvb_secret_requests**](SfvbApi.md#get_sfvb_secret_requests) | **GET** /sfvb/secrets | List this sign-in's secret requests |
|
|
@@ -215,6 +217,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
215
217
|
| [**list_sfvb_themes**](SfvbApi.md#list_sfvb_themes) | **GET** /sfvb/storefronts/{storefront_oid}/themes | List themes for a storefront |
|
|
216
218
|
| [**list_sfvb_upsell_offers**](SfvbApi.md#list_sfvb_upsell_offers) | **GET** /sfvb/storefronts/{storefront_oid}/upsell_offers | List upsell offers |
|
|
217
219
|
| [**list_sfvb_upsell_paths**](SfvbApi.md#list_sfvb_upsell_paths) | **GET** /sfvb/storefronts/{storefront_oid}/upsell_paths | List upsell paths |
|
|
220
|
+
| [**move_sfvb_page**](SfvbApi.md#move_sfvb_page) | **POST** /sfvb/storefronts/{storefront_oid}/pages/move | Move or rename a page |
|
|
218
221
|
| [**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
222
|
| [**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
223
|
| [**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 +295,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
292
295
|
| [**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
296
|
| [**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
297
|
| [**update_sfvb_redirect**](SfvbApi.md#update_sfvb_redirect) | **PUT** /sfvb/storefronts/{storefront_oid}/redirects/{redirect_id} | Change a redirect rule |
|
|
298
|
+
| [**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
299
|
| [**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
300
|
| [**update_sfvb_site_seo**](SfvbApi.md#update_sfvb_site_seo) | **PUT** /sfvb/storefronts/{storefront_oid}/seo | Change a storefront's search engine settings |
|
|
297
301
|
| [**update_sfvb_smart_attribution**](SfvbApi.md#update_sfvb_smart_attribution) | **PUT** /sfvb/storefronts/{storefront_oid}/smart_attribution | Change a storefront's Smart Attribution configuration |
|
|
@@ -5904,6 +5908,60 @@ end
|
|
|
5904
5908
|
- **Accept**: application/json
|
|
5905
5909
|
|
|
5906
5910
|
|
|
5911
|
+
## get_sfvb_file_contents
|
|
5912
|
+
|
|
5913
|
+
> <SfvbFilesContentResponse> get_sfvb_file_contents(storefront_oid, files_request)
|
|
5914
|
+
|
|
5915
|
+
Read several storefront files
|
|
5916
|
+
|
|
5917
|
+
The current content of up to 50 files in one call, each answered exactly as the single file read answers it. A file that can't be read carries its own error and the others are still read. When the response reaches its size limit, the paths not yet read come back in remaining_paths; send them again. Only reads - a POST because the list of paths can be long.
|
|
5918
|
+
|
|
5919
|
+
|
|
5920
|
+
### Examples
|
|
5921
|
+
|
|
5922
|
+
|
|
5923
|
+
(No example for this operation).
|
|
5924
|
+
|
|
5925
|
+
|
|
5926
|
+
#### Using the get_sfvb_file_contents_with_http_info variant
|
|
5927
|
+
|
|
5928
|
+
This returns an Array which contains the response data, status code and headers.
|
|
5929
|
+
|
|
5930
|
+
> <Array(<SfvbFilesContentResponse>, Integer, Hash)> get_sfvb_file_contents_with_http_info(storefront_oid, files_request)
|
|
5931
|
+
|
|
5932
|
+
```ruby
|
|
5933
|
+
begin
|
|
5934
|
+
# Read several storefront files
|
|
5935
|
+
data, status_code, headers = api_instance.get_sfvb_file_contents_with_http_info(storefront_oid, files_request)
|
|
5936
|
+
p status_code # => 2xx
|
|
5937
|
+
p headers # => { ... }
|
|
5938
|
+
p data # => <SfvbFilesContentResponse>
|
|
5939
|
+
rescue UltracartClient::ApiError => e
|
|
5940
|
+
puts "Error when calling SfvbApi->get_sfvb_file_contents_with_http_info: #{e}"
|
|
5941
|
+
end
|
|
5942
|
+
```
|
|
5943
|
+
|
|
5944
|
+
### Parameters
|
|
5945
|
+
|
|
5946
|
+
| Name | Type | Description | Notes |
|
|
5947
|
+
| ---- | ---- | ----------- | ----- |
|
|
5948
|
+
| **storefront_oid** | **Integer** | | |
|
|
5949
|
+
| **files_request** | [**SfvbFilesContentRequest**](SfvbFilesContentRequest.md) | The files to read | |
|
|
5950
|
+
|
|
5951
|
+
### Return type
|
|
5952
|
+
|
|
5953
|
+
[**SfvbFilesContentResponse**](SfvbFilesContentResponse.md)
|
|
5954
|
+
|
|
5955
|
+
### Authorization
|
|
5956
|
+
|
|
5957
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
5958
|
+
|
|
5959
|
+
### HTTP request headers
|
|
5960
|
+
|
|
5961
|
+
- **Content-Type**: application/json
|
|
5962
|
+
- **Accept**: application/json
|
|
5963
|
+
|
|
5964
|
+
|
|
5907
5965
|
## get_sfvb_file_upload_url
|
|
5908
5966
|
|
|
5909
5967
|
> <SfvbFileUploadUrlResponse> get_sfvb_file_upload_url(storefront_oid, extension)
|
|
@@ -6940,11 +6998,11 @@ end
|
|
|
6940
6998
|
|
|
6941
6999
|
## get_sfvb_menus
|
|
6942
7000
|
|
|
6943
|
-
> <SfvbMenusResponse> get_sfvb_menus(storefront_oid)
|
|
7001
|
+
> <SfvbMenusResponse> get_sfvb_menus(storefront_oid, opts)
|
|
6944
7002
|
|
|
6945
7003
|
List a storefront's store menus
|
|
6946
7004
|
|
|
6947
|
-
The menus a menu element's menuName can name, sorted by code
|
|
7005
|
+
The menus a menu element's menuName can name, sorted by code. Without include_entries each menu is listed without its entries; with include_entries=true each carries the tree the single-menu read returns, so one call reads every menu. 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.
|
|
6948
7006
|
|
|
6949
7007
|
|
|
6950
7008
|
### Examples
|
|
@@ -6957,12 +7015,12 @@ The menus a menu element's menuName can name, sorted by code and without their e
|
|
|
6957
7015
|
|
|
6958
7016
|
This returns an Array which contains the response data, status code and headers.
|
|
6959
7017
|
|
|
6960
|
-
> <Array(<SfvbMenusResponse>, Integer, Hash)> get_sfvb_menus_with_http_info(storefront_oid)
|
|
7018
|
+
> <Array(<SfvbMenusResponse>, Integer, Hash)> get_sfvb_menus_with_http_info(storefront_oid, opts)
|
|
6961
7019
|
|
|
6962
7020
|
```ruby
|
|
6963
7021
|
begin
|
|
6964
7022
|
# List a storefront's store menus
|
|
6965
|
-
data, status_code, headers = api_instance.get_sfvb_menus_with_http_info(storefront_oid)
|
|
7023
|
+
data, status_code, headers = api_instance.get_sfvb_menus_with_http_info(storefront_oid, opts)
|
|
6966
7024
|
p status_code # => 2xx
|
|
6967
7025
|
p headers # => { ... }
|
|
6968
7026
|
p data # => <SfvbMenusResponse>
|
|
@@ -6976,6 +7034,7 @@ end
|
|
|
6976
7034
|
| Name | Type | Description | Notes |
|
|
6977
7035
|
| ---- | ---- | ----------- | ----- |
|
|
6978
7036
|
| **storefront_oid** | **Integer** | | |
|
|
7037
|
+
| **include_entries** | **Boolean** | True to include each menu's entries | [optional] |
|
|
6979
7038
|
|
|
6980
7039
|
### Return type
|
|
6981
7040
|
|
|
@@ -7214,11 +7273,11 @@ end
|
|
|
7214
7273
|
|
|
7215
7274
|
## get_sfvb_page
|
|
7216
7275
|
|
|
7217
|
-
> <SfvbPageResponse> get_sfvb_page(storefront_oid,
|
|
7276
|
+
> <SfvbPageResponse> get_sfvb_page(storefront_oid, opts)
|
|
7218
7277
|
|
|
7219
7278
|
Read a page's attributes and images
|
|
7220
7279
|
|
|
7221
|
-
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.
|
|
7280
|
+
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. Name the page by path or by catalog_group_oid, not both. The oid is the id the page list and menu reads return, and it stays the same when the page moves.
|
|
7222
7281
|
|
|
7223
7282
|
|
|
7224
7283
|
### Examples
|
|
@@ -7231,12 +7290,12 @@ What the pageattribute and pageimage elements render for this page. These are n
|
|
|
7231
7290
|
|
|
7232
7291
|
This returns an Array which contains the response data, status code and headers.
|
|
7233
7292
|
|
|
7234
|
-
> <Array(<SfvbPageResponse>, Integer, Hash)> get_sfvb_page_with_http_info(storefront_oid,
|
|
7293
|
+
> <Array(<SfvbPageResponse>, Integer, Hash)> get_sfvb_page_with_http_info(storefront_oid, opts)
|
|
7235
7294
|
|
|
7236
7295
|
```ruby
|
|
7237
7296
|
begin
|
|
7238
7297
|
# Read a page's attributes and images
|
|
7239
|
-
data, status_code, headers = api_instance.get_sfvb_page_with_http_info(storefront_oid,
|
|
7298
|
+
data, status_code, headers = api_instance.get_sfvb_page_with_http_info(storefront_oid, opts)
|
|
7240
7299
|
p status_code # => 2xx
|
|
7241
7300
|
p headers # => { ... }
|
|
7242
7301
|
p data # => <SfvbPageResponse>
|
|
@@ -7250,7 +7309,8 @@ end
|
|
|
7250
7309
|
| Name | Type | Description | Notes |
|
|
7251
7310
|
| ---- | ---- | ----------- | ----- |
|
|
7252
7311
|
| **storefront_oid** | **Integer** | | |
|
|
7253
|
-
| **path** | **String** | Page path, for example /catalog/dispensers
|
|
7312
|
+
| **path** | **String** | Page path, for example /catalog/dispensers/. Required unless catalog_group_oid is given. | [optional] |
|
|
7313
|
+
| **catalog_group_oid** | **Integer** | The page's id, in place of path | [optional] |
|
|
7254
7314
|
|
|
7255
7315
|
### Return type
|
|
7256
7316
|
|
|
@@ -7812,6 +7872,59 @@ end
|
|
|
7812
7872
|
- **Accept**: application/json
|
|
7813
7873
|
|
|
7814
7874
|
|
|
7875
|
+
## get_sfvb_search_facets
|
|
7876
|
+
|
|
7877
|
+
> <SfvbSearchFacetsResponse> get_sfvb_search_facets(storefront_oid)
|
|
7878
|
+
|
|
7879
|
+
Read the storefront's faceted search configuration
|
|
7880
|
+
|
|
7881
|
+
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.
|
|
7882
|
+
|
|
7883
|
+
|
|
7884
|
+
### Examples
|
|
7885
|
+
|
|
7886
|
+
|
|
7887
|
+
(No example for this operation).
|
|
7888
|
+
|
|
7889
|
+
|
|
7890
|
+
#### Using the get_sfvb_search_facets_with_http_info variant
|
|
7891
|
+
|
|
7892
|
+
This returns an Array which contains the response data, status code and headers.
|
|
7893
|
+
|
|
7894
|
+
> <Array(<SfvbSearchFacetsResponse>, Integer, Hash)> get_sfvb_search_facets_with_http_info(storefront_oid)
|
|
7895
|
+
|
|
7896
|
+
```ruby
|
|
7897
|
+
begin
|
|
7898
|
+
# Read the storefront's faceted search configuration
|
|
7899
|
+
data, status_code, headers = api_instance.get_sfvb_search_facets_with_http_info(storefront_oid)
|
|
7900
|
+
p status_code # => 2xx
|
|
7901
|
+
p headers # => { ... }
|
|
7902
|
+
p data # => <SfvbSearchFacetsResponse>
|
|
7903
|
+
rescue UltracartClient::ApiError => e
|
|
7904
|
+
puts "Error when calling SfvbApi->get_sfvb_search_facets_with_http_info: #{e}"
|
|
7905
|
+
end
|
|
7906
|
+
```
|
|
7907
|
+
|
|
7908
|
+
### Parameters
|
|
7909
|
+
|
|
7910
|
+
| Name | Type | Description | Notes |
|
|
7911
|
+
| ---- | ---- | ----------- | ----- |
|
|
7912
|
+
| **storefront_oid** | **Integer** | | |
|
|
7913
|
+
|
|
7914
|
+
### Return type
|
|
7915
|
+
|
|
7916
|
+
[**SfvbSearchFacetsResponse**](SfvbSearchFacetsResponse.md)
|
|
7917
|
+
|
|
7918
|
+
### Authorization
|
|
7919
|
+
|
|
7920
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
7921
|
+
|
|
7922
|
+
### HTTP request headers
|
|
7923
|
+
|
|
7924
|
+
- **Content-Type**: Not defined
|
|
7925
|
+
- **Accept**: application/json
|
|
7926
|
+
|
|
7927
|
+
|
|
7815
7928
|
## get_sfvb_secret_kinds
|
|
7816
7929
|
|
|
7817
7930
|
> <SfvbSecretKindsResponse> get_sfvb_secret_kinds
|
|
@@ -11401,7 +11514,7 @@ end
|
|
|
11401
11514
|
|
|
11402
11515
|
List the storefront's pages
|
|
11403
11516
|
|
|
11404
|
-
Every page with its settings, sorted by path with the root first. Hidden pages are included. Pass under to list one page and everything below it. Read from the same cached catalog the admin page tree uses, so a page created a moment ago can take a moment to appear here - read it directly with the single-page read to confirm a write.
|
|
11517
|
+
Every page with its settings, sorted by path with the root first. Hidden pages are included. Pass under to list one page and everything below it. Read from the same cached catalog the admin page tree uses, so a page created a moment ago can take a moment to appear here - read it directly with the single-page read to confirm a write. Pass detail=true to get each page's single-page read in detail as well, at most 25 pages a call. Page through with offset and limit, following next_offset until it is omitted.
|
|
11405
11518
|
|
|
11406
11519
|
|
|
11407
11520
|
### Examples
|
|
@@ -11434,6 +11547,9 @@ end
|
|
|
11434
11547
|
| ---- | ---- | ----------- | ----- |
|
|
11435
11548
|
| **storefront_oid** | **Integer** | | |
|
|
11436
11549
|
| **under** | **String** | Only this page and the pages below it, for example /lp/ | [optional] |
|
|
11550
|
+
| **detail** | **Boolean** | True to include each page's single-page read, a window at a time | [optional] |
|
|
11551
|
+
| **offset** | **Integer** | Where the window starts, with detail=true. Default 0. | [optional] |
|
|
11552
|
+
| **limit** | **Integer** | Pages in the window, 1 to 25, with detail=true. Default 25. | [optional] |
|
|
11437
11553
|
|
|
11438
11554
|
### Return type
|
|
11439
11555
|
|
|
@@ -11781,6 +11897,61 @@ end
|
|
|
11781
11897
|
- **Accept**: application/json
|
|
11782
11898
|
|
|
11783
11899
|
|
|
11900
|
+
## move_sfvb_page
|
|
11901
|
+
|
|
11902
|
+
> <SfvbPageMoveResponse> move_sfvb_page(storefront_oid, page_move_request, opts)
|
|
11903
|
+
|
|
11904
|
+
Move or rename a page
|
|
11905
|
+
|
|
11906
|
+
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.
|
|
11907
|
+
|
|
11908
|
+
|
|
11909
|
+
### Examples
|
|
11910
|
+
|
|
11911
|
+
|
|
11912
|
+
(No example for this operation).
|
|
11913
|
+
|
|
11914
|
+
|
|
11915
|
+
#### Using the move_sfvb_page_with_http_info variant
|
|
11916
|
+
|
|
11917
|
+
This returns an Array which contains the response data, status code and headers.
|
|
11918
|
+
|
|
11919
|
+
> <Array(<SfvbPageMoveResponse>, Integer, Hash)> move_sfvb_page_with_http_info(storefront_oid, page_move_request, opts)
|
|
11920
|
+
|
|
11921
|
+
```ruby
|
|
11922
|
+
begin
|
|
11923
|
+
# Move or rename a page
|
|
11924
|
+
data, status_code, headers = api_instance.move_sfvb_page_with_http_info(storefront_oid, page_move_request, opts)
|
|
11925
|
+
p status_code # => 2xx
|
|
11926
|
+
p headers # => { ... }
|
|
11927
|
+
p data # => <SfvbPageMoveResponse>
|
|
11928
|
+
rescue UltracartClient::ApiError => e
|
|
11929
|
+
puts "Error when calling SfvbApi->move_sfvb_page_with_http_info: #{e}"
|
|
11930
|
+
end
|
|
11931
|
+
```
|
|
11932
|
+
|
|
11933
|
+
### Parameters
|
|
11934
|
+
|
|
11935
|
+
| Name | Type | Description | Notes |
|
|
11936
|
+
| ---- | ---- | ----------- | ----- |
|
|
11937
|
+
| **storefront_oid** | **Integer** | | |
|
|
11938
|
+
| **page_move_request** | [**SfvbPageMoveRequest**](SfvbPageMoveRequest.md) | The page and where it goes | |
|
|
11939
|
+
| **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] |
|
|
11940
|
+
|
|
11941
|
+
### Return type
|
|
11942
|
+
|
|
11943
|
+
[**SfvbPageMoveResponse**](SfvbPageMoveResponse.md)
|
|
11944
|
+
|
|
11945
|
+
### Authorization
|
|
11946
|
+
|
|
11947
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
11948
|
+
|
|
11949
|
+
### HTTP request headers
|
|
11950
|
+
|
|
11951
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
11952
|
+
- **Accept**: application/json
|
|
11953
|
+
|
|
11954
|
+
|
|
11784
11955
|
## move_sfvb_sequence_step
|
|
11785
11956
|
|
|
11786
11957
|
> <SfvbSequenceStepMoveResponse> move_sfvb_sequence_step(storefront_oid, sequence_uuid, step_uuid, if_match, sequence_step_move_request, opts)
|
|
@@ -13084,7 +13255,7 @@ end
|
|
|
13084
13255
|
|
|
13085
13256
|
Change a page's settings
|
|
13086
13257
|
|
|
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.
|
|
13258
|
+
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
13259
|
|
|
13089
13260
|
|
|
13090
13261
|
### Examples
|
|
@@ -14157,7 +14328,7 @@ end
|
|
|
14157
14328
|
| **storefront_oid** | **Integer** | | |
|
|
14158
14329
|
| **owner_type** | **String** | | |
|
|
14159
14330
|
| **owner_object_id** | **String** | | |
|
|
14160
|
-
| **if_match** | **String** | CJSON hash of the container being reverted. Required; 428 when absent, 412 when stale. | |
|
|
14331
|
+
| **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
14332
|
| **container_revert_request** | [**SfvbContainerRevertRequest**](SfvbContainerRevertRequest.md) | Version to revert the container to | |
|
|
14162
14333
|
| **container_name** | **String** | | [optional] |
|
|
14163
14334
|
|
|
@@ -16059,6 +16230,61 @@ end
|
|
|
16059
16230
|
- **Accept**: application/json
|
|
16060
16231
|
|
|
16061
16232
|
|
|
16233
|
+
## update_sfvb_search_facets
|
|
16234
|
+
|
|
16235
|
+
> <SfvbSearchFacetsResponse> update_sfvb_search_facets(storefront_oid, search_facets_request, opts)
|
|
16236
|
+
|
|
16237
|
+
Change the storefront's faceted search configuration
|
|
16238
|
+
|
|
16239
|
+
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. Changes are limited to 30 an hour and 100 a day per storefront, and those that start a rebuild to 6 an hour and 20 a day (429, nothing saved).
|
|
16240
|
+
|
|
16241
|
+
|
|
16242
|
+
### Examples
|
|
16243
|
+
|
|
16244
|
+
|
|
16245
|
+
(No example for this operation).
|
|
16246
|
+
|
|
16247
|
+
|
|
16248
|
+
#### Using the update_sfvb_search_facets_with_http_info variant
|
|
16249
|
+
|
|
16250
|
+
This returns an Array which contains the response data, status code and headers.
|
|
16251
|
+
|
|
16252
|
+
> <Array(<SfvbSearchFacetsResponse>, Integer, Hash)> update_sfvb_search_facets_with_http_info(storefront_oid, search_facets_request, opts)
|
|
16253
|
+
|
|
16254
|
+
```ruby
|
|
16255
|
+
begin
|
|
16256
|
+
# Change the storefront's faceted search configuration
|
|
16257
|
+
data, status_code, headers = api_instance.update_sfvb_search_facets_with_http_info(storefront_oid, search_facets_request, opts)
|
|
16258
|
+
p status_code # => 2xx
|
|
16259
|
+
p headers # => { ... }
|
|
16260
|
+
p data # => <SfvbSearchFacetsResponse>
|
|
16261
|
+
rescue UltracartClient::ApiError => e
|
|
16262
|
+
puts "Error when calling SfvbApi->update_sfvb_search_facets_with_http_info: #{e}"
|
|
16263
|
+
end
|
|
16264
|
+
```
|
|
16265
|
+
|
|
16266
|
+
### Parameters
|
|
16267
|
+
|
|
16268
|
+
| Name | Type | Description | Notes |
|
|
16269
|
+
| ---- | ---- | ----------- | ----- |
|
|
16270
|
+
| **storefront_oid** | **Integer** | | |
|
|
16271
|
+
| **search_facets_request** | [**SfvbSearchFacetsRequest**](SfvbSearchFacetsRequest.md) | The facets and price breaks to change | |
|
|
16272
|
+
| **if_match** | **String** | hash_sha256 from the last read. Required unless dry_run; 428 when absent, 412 when stale. | [optional] |
|
|
16273
|
+
|
|
16274
|
+
### Return type
|
|
16275
|
+
|
|
16276
|
+
[**SfvbSearchFacetsResponse**](SfvbSearchFacetsResponse.md)
|
|
16277
|
+
|
|
16278
|
+
### Authorization
|
|
16279
|
+
|
|
16280
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
16281
|
+
|
|
16282
|
+
### HTTP request headers
|
|
16283
|
+
|
|
16284
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
16285
|
+
- **Accept**: application/json
|
|
16286
|
+
|
|
16287
|
+
|
|
16062
16288
|
## update_sfvb_sequence_step
|
|
16063
16289
|
|
|
16064
16290
|
> <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,22 @@
|
|
|
1
|
+
# UltracartClient::SfvbFileContentResult
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **error** | [**SfvbErrorDetail**](SfvbErrorDetail.md) | | [optional] |
|
|
8
|
+
| **file** | [**SfvbFileContentResponse**](SfvbFileContentResponse.md) | | [optional] |
|
|
9
|
+
| **path** | **String** | The path as it was asked for. | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'ultracart_api'
|
|
15
|
+
|
|
16
|
+
instance = UltracartClient::SfvbFileContentResult.new(
|
|
17
|
+
error: null,
|
|
18
|
+
file: null,
|
|
19
|
+
path: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# UltracartClient::SfvbFilesContentRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **paths** | **Array<String>** | Paths of the files to read, the same paths the single file read takes. At most 50. A path given twice is answered once. | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'ultracart_api'
|
|
13
|
+
|
|
14
|
+
instance = UltracartClient::SfvbFilesContentRequest.new(
|
|
15
|
+
paths: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# UltracartClient::SfvbFilesContentResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **files** | [**Array<SfvbFileContentResult>**](SfvbFileContentResult.md) | One entry per path read, in the order asked. | [optional] |
|
|
8
|
+
| **remaining_paths** | **Array<String>** | Paths not read because the response reached its size limit, in the order asked. Send them again to read them. Omitted when every path was read. | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'ultracart_api'
|
|
14
|
+
|
|
15
|
+
instance = UltracartClient::SfvbFilesContentResponse.new(
|
|
16
|
+
files: null,
|
|
17
|
+
remaining_paths: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
data/docs/SfvbMenusResponse.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **menus** | [**Array<SfvbMenu>**](SfvbMenu.md) | The storefront's menus, sorted by code. Entries are omitted
|
|
7
|
+
| **menus** | [**Array<SfvbMenu>**](SfvbMenu.md) | The storefront's menus, sorted by code. Entries are omitted unless include_entries=true was passed, in which case each menu carries the same tree the single-menu read returns. | [optional] |
|
|
8
8
|
|
|
9
9
|
## Example
|
|
10
10
|
|
|
@@ -4,7 +4,9 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **next_offset** | **Integer** | The offset of the next window, omitted on the last one. Only with detail=true. | [optional] |
|
|
7
8
|
| **pages** | [**Array<SfvbPageSummary>**](SfvbPageSummary.md) | Pages sorted by path, the root first. Hidden pages are included. | [optional] |
|
|
9
|
+
| **total** | **Integer** | How many pages the whole list has. Only with detail=true. | [optional] |
|
|
8
10
|
|
|
9
11
|
## Example
|
|
10
12
|
|
|
@@ -12,7 +14,9 @@
|
|
|
12
14
|
require 'ultracart_api'
|
|
13
15
|
|
|
14
16
|
instance = UltracartClient::SfvbPageListResponse.new(
|
|
15
|
-
|
|
17
|
+
next_offset: null,
|
|
18
|
+
pages: null,
|
|
19
|
+
total: null
|
|
16
20
|
)
|
|
17
21
|
```
|
|
18
22
|
|
|
@@ -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
|
+
|