ultracart_api 4.1.253 → 4.1.255
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 +11 -2
- data/docs/SfvbApi.md +177 -11
- data/docs/SfvbApprovalParams.md +2 -0
- data/docs/SfvbCliLocation.md +20 -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/SfvbPageResponse.md +2 -0
- data/docs/SfvbPageSummary.md +4 -0
- data/docs/SfvbWhoamiResponse.md +2 -0
- data/lib/ultracart_api/api/sfvb_api.rb +223 -18
- data/lib/ultracart_api/models/sfvb_approval_create_request.rb +2 -2
- data/lib/ultracart_api/models/sfvb_approval_params.rb +11 -1
- data/lib/ultracart_api/models/sfvb_cli_location.rb +230 -0
- 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_response.rb +11 -1
- data/lib/ultracart_api/models/sfvb_page_summary.rb +20 -1
- data/lib/ultracart_api/models/sfvb_whoami_response.rb +10 -1
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +4 -0
- metadata +10 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: de20369b5d49262419ae7c545016a4591e4b8a69f194debf5e4bb5b70962677c
|
|
4
|
+
data.tar.gz: 2756b34d5d7d7673826bfdc64b971ea33829f4f4b34e6e8e6f769d914a657090
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 57fc697e759445ea80f13a132316f6fb55c4d7acc80ed02a70cb1dcab6e6ef5cf610795194a6f8fb1af8af74483ce1277f5621d0b4dbf3d142b3455d9f08ecb3
|
|
7
|
+
data.tar.gz: e7c95d5ecf5368c14e56ac75190dd3e23517cc0b0305d6291aa26ac73959100589de5316582a94d7731499d318fc0d14413d4ba8b67059ca3e5695bd62175d77
|
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.255
|
|
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.255'
|
|
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
|
|
@@ -659,6 +660,8 @@ Class | Method | HTTP request | Description
|
|
|
659
660
|
*UltracartClient::SfvbApi* | [**insert_sfvb_comms_twilio_account**](docs/SfvbApi.md#insert_sfvb_comms_twilio_account) | **POST** /sfvb/comms/twilio_account | Connect the Twilio account
|
|
660
661
|
*UltracartClient::SfvbApi* | [**insert_sfvb_docs_gap**](docs/SfvbApi.md#insert_sfvb_docs_gap) | **POST** /sfvb/docs/gaps | Send UltraCart a documentation-gap report
|
|
661
662
|
*UltracartClient::SfvbApi* | [**insert_sfvb_item_child**](docs/SfvbApi.md#insert_sfvb_item_child) | **POST** /sfvb/storefronts/{storefront_oid}/items/children | Create a child item for a parent's variations
|
|
663
|
+
*UltracartClient::SfvbApi* | [**insert_sfvb_location**](docs/SfvbApi.md#insert_sfvb_location) | **POST** /sfvb/location | Add the caller's address to this StoreFront CLI sign-in
|
|
664
|
+
*UltracartClient::SfvbApi* | [**insert_sfvb_location_approval**](docs/SfvbApi.md#insert_sfvb_location_approval) | **POST** /sfvb/location/approval | Ask to use this StoreFront CLI sign-in from the caller's address
|
|
662
665
|
*UltracartClient::SfvbApi* | [**insert_sfvb_page**](docs/SfvbApi.md#insert_sfvb_page) | **POST** /sfvb/storefronts/{storefront_oid}/pages | Create a page
|
|
663
666
|
*UltracartClient::SfvbApi* | [**insert_sfvb_redirect**](docs/SfvbApi.md#insert_sfvb_redirect) | **POST** /sfvb/storefronts/{storefront_oid}/redirects | Create a 301 redirect rule
|
|
664
667
|
*UltracartClient::SfvbApi* | [**insert_sfvb_secret_request**](docs/SfvbApi.md#insert_sfvb_secret_request) | **POST** /sfvb/secrets | Ask a person to enter secret values
|
|
@@ -2030,6 +2033,7 @@ Class | Method | HTTP request | Description
|
|
|
2030
2033
|
- [UltracartClient::SfvbCampaignWriteRequest](docs/SfvbCampaignWriteRequest.md)
|
|
2031
2034
|
- [UltracartClient::SfvbCampaignsResponse](docs/SfvbCampaignsResponse.md)
|
|
2032
2035
|
- [UltracartClient::SfvbCliAccess](docs/SfvbCliAccess.md)
|
|
2036
|
+
- [UltracartClient::SfvbCliLocation](docs/SfvbCliLocation.md)
|
|
2033
2037
|
- [UltracartClient::SfvbCliVersion](docs/SfvbCliVersion.md)
|
|
2034
2038
|
- [UltracartClient::SfvbCodeLibraryEmail](docs/SfvbCodeLibraryEmail.md)
|
|
2035
2039
|
- [UltracartClient::SfvbCodeLibraryEmailsResponse](docs/SfvbCodeLibraryEmailsResponse.md)
|
|
@@ -2129,6 +2133,7 @@ Class | Method | HTTP request | Description
|
|
|
2129
2133
|
- [UltracartClient::SfvbExperimentVariationUpdateRequest](docs/SfvbExperimentVariationUpdateRequest.md)
|
|
2130
2134
|
- [UltracartClient::SfvbExperimentsResponse](docs/SfvbExperimentsResponse.md)
|
|
2131
2135
|
- [UltracartClient::SfvbFileContentResponse](docs/SfvbFileContentResponse.md)
|
|
2136
|
+
- [UltracartClient::SfvbFileContentResult](docs/SfvbFileContentResult.md)
|
|
2132
2137
|
- [UltracartClient::SfvbFileEntry](docs/SfvbFileEntry.md)
|
|
2133
2138
|
- [UltracartClient::SfvbFileRevertRequest](docs/SfvbFileRevertRequest.md)
|
|
2134
2139
|
- [UltracartClient::SfvbFileSearchRequest](docs/SfvbFileSearchRequest.md)
|
|
@@ -2139,6 +2144,8 @@ Class | Method | HTTP request | Description
|
|
|
2139
2144
|
- [UltracartClient::SfvbFileVersionsResponse](docs/SfvbFileVersionsResponse.md)
|
|
2140
2145
|
- [UltracartClient::SfvbFileWriteRequest](docs/SfvbFileWriteRequest.md)
|
|
2141
2146
|
- [UltracartClient::SfvbFileWriteResponse](docs/SfvbFileWriteResponse.md)
|
|
2147
|
+
- [UltracartClient::SfvbFilesContentRequest](docs/SfvbFilesContentRequest.md)
|
|
2148
|
+
- [UltracartClient::SfvbFilesContentResponse](docs/SfvbFilesContentResponse.md)
|
|
2142
2149
|
- [UltracartClient::SfvbFilesResponse](docs/SfvbFilesResponse.md)
|
|
2143
2150
|
- [UltracartClient::SfvbFlow](docs/SfvbFlow.md)
|
|
2144
2151
|
- [UltracartClient::SfvbFlowBackfillRequest](docs/SfvbFlowBackfillRequest.md)
|
|
@@ -2594,6 +2601,8 @@ Not every change is committed to every SDK.
|
|
|
2594
2601
|
|
|
2595
2602
|
| Version | Date | Comments |
|
|
2596
2603
|
| --: | :-: | --- |
|
|
2604
|
+
| 4.1.255 | 11/17/2026 | sfvb internal testing |
|
|
2605
|
+
| 4.1.254 | 11/15/2026 | sfvb internal testing |
|
|
2597
2606
|
| 4.1.253 | 11/13/2026 | sfvb internal testing |
|
|
2598
2607
|
| 4.1.252 | 11/12/2026 | sfvb internal testing |
|
|
2599
2608
|
| 4.1.251 | 11/12/2026 | sfvb internal test |
|
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 |
|
|
@@ -187,6 +188,8 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
187
188
|
| [**insert_sfvb_comms_twilio_account**](SfvbApi.md#insert_sfvb_comms_twilio_account) | **POST** /sfvb/comms/twilio_account | Connect the Twilio account |
|
|
188
189
|
| [**insert_sfvb_docs_gap**](SfvbApi.md#insert_sfvb_docs_gap) | **POST** /sfvb/docs/gaps | Send UltraCart a documentation-gap report |
|
|
189
190
|
| [**insert_sfvb_item_child**](SfvbApi.md#insert_sfvb_item_child) | **POST** /sfvb/storefronts/{storefront_oid}/items/children | Create a child item for a parent's variations |
|
|
191
|
+
| [**insert_sfvb_location**](SfvbApi.md#insert_sfvb_location) | **POST** /sfvb/location | Add the caller's address to this StoreFront CLI sign-in |
|
|
192
|
+
| [**insert_sfvb_location_approval**](SfvbApi.md#insert_sfvb_location_approval) | **POST** /sfvb/location/approval | Ask to use this StoreFront CLI sign-in from the caller's address |
|
|
190
193
|
| [**insert_sfvb_page**](SfvbApi.md#insert_sfvb_page) | **POST** /sfvb/storefronts/{storefront_oid}/pages | Create a page |
|
|
191
194
|
| [**insert_sfvb_redirect**](SfvbApi.md#insert_sfvb_redirect) | **POST** /sfvb/storefronts/{storefront_oid}/redirects | Create a 301 redirect rule |
|
|
192
195
|
| [**insert_sfvb_secret_request**](SfvbApi.md#insert_sfvb_secret_request) | **POST** /sfvb/secrets | Ask a person to enter secret values |
|
|
@@ -5907,6 +5910,60 @@ end
|
|
|
5907
5910
|
- **Accept**: application/json
|
|
5908
5911
|
|
|
5909
5912
|
|
|
5913
|
+
## get_sfvb_file_contents
|
|
5914
|
+
|
|
5915
|
+
> <SfvbFilesContentResponse> get_sfvb_file_contents(storefront_oid, files_request)
|
|
5916
|
+
|
|
5917
|
+
Read several storefront files
|
|
5918
|
+
|
|
5919
|
+
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.
|
|
5920
|
+
|
|
5921
|
+
|
|
5922
|
+
### Examples
|
|
5923
|
+
|
|
5924
|
+
|
|
5925
|
+
(No example for this operation).
|
|
5926
|
+
|
|
5927
|
+
|
|
5928
|
+
#### Using the get_sfvb_file_contents_with_http_info variant
|
|
5929
|
+
|
|
5930
|
+
This returns an Array which contains the response data, status code and headers.
|
|
5931
|
+
|
|
5932
|
+
> <Array(<SfvbFilesContentResponse>, Integer, Hash)> get_sfvb_file_contents_with_http_info(storefront_oid, files_request)
|
|
5933
|
+
|
|
5934
|
+
```ruby
|
|
5935
|
+
begin
|
|
5936
|
+
# Read several storefront files
|
|
5937
|
+
data, status_code, headers = api_instance.get_sfvb_file_contents_with_http_info(storefront_oid, files_request)
|
|
5938
|
+
p status_code # => 2xx
|
|
5939
|
+
p headers # => { ... }
|
|
5940
|
+
p data # => <SfvbFilesContentResponse>
|
|
5941
|
+
rescue UltracartClient::ApiError => e
|
|
5942
|
+
puts "Error when calling SfvbApi->get_sfvb_file_contents_with_http_info: #{e}"
|
|
5943
|
+
end
|
|
5944
|
+
```
|
|
5945
|
+
|
|
5946
|
+
### Parameters
|
|
5947
|
+
|
|
5948
|
+
| Name | Type | Description | Notes |
|
|
5949
|
+
| ---- | ---- | ----------- | ----- |
|
|
5950
|
+
| **storefront_oid** | **Integer** | | |
|
|
5951
|
+
| **files_request** | [**SfvbFilesContentRequest**](SfvbFilesContentRequest.md) | The files to read | |
|
|
5952
|
+
|
|
5953
|
+
### Return type
|
|
5954
|
+
|
|
5955
|
+
[**SfvbFilesContentResponse**](SfvbFilesContentResponse.md)
|
|
5956
|
+
|
|
5957
|
+
### Authorization
|
|
5958
|
+
|
|
5959
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
5960
|
+
|
|
5961
|
+
### HTTP request headers
|
|
5962
|
+
|
|
5963
|
+
- **Content-Type**: application/json
|
|
5964
|
+
- **Accept**: application/json
|
|
5965
|
+
|
|
5966
|
+
|
|
5910
5967
|
## get_sfvb_file_upload_url
|
|
5911
5968
|
|
|
5912
5969
|
> <SfvbFileUploadUrlResponse> get_sfvb_file_upload_url(storefront_oid, extension)
|
|
@@ -6943,11 +7000,11 @@ end
|
|
|
6943
7000
|
|
|
6944
7001
|
## get_sfvb_menus
|
|
6945
7002
|
|
|
6946
|
-
> <SfvbMenusResponse> get_sfvb_menus(storefront_oid)
|
|
7003
|
+
> <SfvbMenusResponse> get_sfvb_menus(storefront_oid, opts)
|
|
6947
7004
|
|
|
6948
7005
|
List a storefront's store menus
|
|
6949
7006
|
|
|
6950
|
-
The menus a menu element's menuName can name, sorted by code
|
|
7007
|
+
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.
|
|
6951
7008
|
|
|
6952
7009
|
|
|
6953
7010
|
### Examples
|
|
@@ -6960,12 +7017,12 @@ The menus a menu element's menuName can name, sorted by code and without their e
|
|
|
6960
7017
|
|
|
6961
7018
|
This returns an Array which contains the response data, status code and headers.
|
|
6962
7019
|
|
|
6963
|
-
> <Array(<SfvbMenusResponse>, Integer, Hash)> get_sfvb_menus_with_http_info(storefront_oid)
|
|
7020
|
+
> <Array(<SfvbMenusResponse>, Integer, Hash)> get_sfvb_menus_with_http_info(storefront_oid, opts)
|
|
6964
7021
|
|
|
6965
7022
|
```ruby
|
|
6966
7023
|
begin
|
|
6967
7024
|
# List a storefront's store menus
|
|
6968
|
-
data, status_code, headers = api_instance.get_sfvb_menus_with_http_info(storefront_oid)
|
|
7025
|
+
data, status_code, headers = api_instance.get_sfvb_menus_with_http_info(storefront_oid, opts)
|
|
6969
7026
|
p status_code # => 2xx
|
|
6970
7027
|
p headers # => { ... }
|
|
6971
7028
|
p data # => <SfvbMenusResponse>
|
|
@@ -6979,6 +7036,7 @@ end
|
|
|
6979
7036
|
| Name | Type | Description | Notes |
|
|
6980
7037
|
| ---- | ---- | ----------- | ----- |
|
|
6981
7038
|
| **storefront_oid** | **Integer** | | |
|
|
7039
|
+
| **include_entries** | **Boolean** | True to include each menu's entries | [optional] |
|
|
6982
7040
|
|
|
6983
7041
|
### Return type
|
|
6984
7042
|
|
|
@@ -7217,11 +7275,11 @@ end
|
|
|
7217
7275
|
|
|
7218
7276
|
## get_sfvb_page
|
|
7219
7277
|
|
|
7220
|
-
> <SfvbPageResponse> get_sfvb_page(storefront_oid,
|
|
7278
|
+
> <SfvbPageResponse> get_sfvb_page(storefront_oid, opts)
|
|
7221
7279
|
|
|
7222
7280
|
Read a page's attributes and images
|
|
7223
7281
|
|
|
7224
|
-
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.
|
|
7282
|
+
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.
|
|
7225
7283
|
|
|
7226
7284
|
|
|
7227
7285
|
### Examples
|
|
@@ -7234,12 +7292,12 @@ What the pageattribute and pageimage elements render for this page. These are n
|
|
|
7234
7292
|
|
|
7235
7293
|
This returns an Array which contains the response data, status code and headers.
|
|
7236
7294
|
|
|
7237
|
-
> <Array(<SfvbPageResponse>, Integer, Hash)> get_sfvb_page_with_http_info(storefront_oid,
|
|
7295
|
+
> <Array(<SfvbPageResponse>, Integer, Hash)> get_sfvb_page_with_http_info(storefront_oid, opts)
|
|
7238
7296
|
|
|
7239
7297
|
```ruby
|
|
7240
7298
|
begin
|
|
7241
7299
|
# Read a page's attributes and images
|
|
7242
|
-
data, status_code, headers = api_instance.get_sfvb_page_with_http_info(storefront_oid,
|
|
7300
|
+
data, status_code, headers = api_instance.get_sfvb_page_with_http_info(storefront_oid, opts)
|
|
7243
7301
|
p status_code # => 2xx
|
|
7244
7302
|
p headers # => { ... }
|
|
7245
7303
|
p data # => <SfvbPageResponse>
|
|
@@ -7253,7 +7311,8 @@ end
|
|
|
7253
7311
|
| Name | Type | Description | Notes |
|
|
7254
7312
|
| ---- | ---- | ----------- | ----- |
|
|
7255
7313
|
| **storefront_oid** | **Integer** | | |
|
|
7256
|
-
| **path** | **String** | Page path, for example /catalog/dispensers
|
|
7314
|
+
| **path** | **String** | Page path, for example /catalog/dispensers/. Required unless catalog_group_oid is given. | [optional] |
|
|
7315
|
+
| **catalog_group_oid** | **Integer** | The page's id, in place of path | [optional] |
|
|
7257
7316
|
|
|
7258
7317
|
### Return type
|
|
7259
7318
|
|
|
@@ -10243,6 +10302,110 @@ end
|
|
|
10243
10302
|
- **Accept**: application/json
|
|
10244
10303
|
|
|
10245
10304
|
|
|
10305
|
+
## insert_sfvb_location
|
|
10306
|
+
|
|
10307
|
+
> insert_sfvb_location(opts)
|
|
10308
|
+
|
|
10309
|
+
Add the caller's address to this StoreFront CLI sign-in
|
|
10310
|
+
|
|
10311
|
+
Spends an approved cli.location approval, named in the Approval-Id header, from the address it was asked for. From then on the sign-in may be used from that address until it ends. An approval asked for from another address is refused with sfvb.approval_mismatch.
|
|
10312
|
+
|
|
10313
|
+
|
|
10314
|
+
### Examples
|
|
10315
|
+
|
|
10316
|
+
|
|
10317
|
+
(No example for this operation).
|
|
10318
|
+
|
|
10319
|
+
|
|
10320
|
+
#### Using the insert_sfvb_location_with_http_info variant
|
|
10321
|
+
|
|
10322
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
10323
|
+
|
|
10324
|
+
> <Array(nil, Integer, Hash)> insert_sfvb_location_with_http_info(opts)
|
|
10325
|
+
|
|
10326
|
+
```ruby
|
|
10327
|
+
begin
|
|
10328
|
+
# Add the caller's address to this StoreFront CLI sign-in
|
|
10329
|
+
data, status_code, headers = api_instance.insert_sfvb_location_with_http_info(opts)
|
|
10330
|
+
p status_code # => 2xx
|
|
10331
|
+
p headers # => { ... }
|
|
10332
|
+
p data # => nil
|
|
10333
|
+
rescue UltracartClient::ApiError => e
|
|
10334
|
+
puts "Error when calling SfvbApi->insert_sfvb_location_with_http_info: #{e}"
|
|
10335
|
+
end
|
|
10336
|
+
```
|
|
10337
|
+
|
|
10338
|
+
### Parameters
|
|
10339
|
+
|
|
10340
|
+
| Name | Type | Description | Notes |
|
|
10341
|
+
| ---- | ---- | ----------- | ----- |
|
|
10342
|
+
| **approval_id** | **String** | The approval_id of an approved cli.location request asked for from this address. See POST /sfvb/location/approval. | [optional] |
|
|
10343
|
+
|
|
10344
|
+
### Return type
|
|
10345
|
+
|
|
10346
|
+
nil (empty response body)
|
|
10347
|
+
|
|
10348
|
+
### Authorization
|
|
10349
|
+
|
|
10350
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
10351
|
+
|
|
10352
|
+
### HTTP request headers
|
|
10353
|
+
|
|
10354
|
+
- **Content-Type**: Not defined
|
|
10355
|
+
- **Accept**: application/json
|
|
10356
|
+
|
|
10357
|
+
|
|
10358
|
+
## insert_sfvb_location_approval
|
|
10359
|
+
|
|
10360
|
+
> <SfvbApproval> insert_sfvb_location_approval
|
|
10361
|
+
|
|
10362
|
+
Ask to use this StoreFront CLI sign-in from the caller's address
|
|
10363
|
+
|
|
10364
|
+
For a StoreFront CLI sign-in refused with sfvb.location_approval_required. Asks the person who signed in to approve the address this call comes from (a cli.location approval). Show them approval_url and user_code, poll GET approvals/{approval_id}, and once it is approved call POST location from the same address with the approval_id in the Approval-Id header. Asking again returns the pending request (200). The person is also emailed, so a request they didn't expect warns them.
|
|
10365
|
+
|
|
10366
|
+
|
|
10367
|
+
### Examples
|
|
10368
|
+
|
|
10369
|
+
|
|
10370
|
+
(No example for this operation).
|
|
10371
|
+
|
|
10372
|
+
|
|
10373
|
+
#### Using the insert_sfvb_location_approval_with_http_info variant
|
|
10374
|
+
|
|
10375
|
+
This returns an Array which contains the response data, status code and headers.
|
|
10376
|
+
|
|
10377
|
+
> <Array(<SfvbApproval>, Integer, Hash)> insert_sfvb_location_approval_with_http_info
|
|
10378
|
+
|
|
10379
|
+
```ruby
|
|
10380
|
+
begin
|
|
10381
|
+
# Ask to use this StoreFront CLI sign-in from the caller's address
|
|
10382
|
+
data, status_code, headers = api_instance.insert_sfvb_location_approval_with_http_info
|
|
10383
|
+
p status_code # => 2xx
|
|
10384
|
+
p headers # => { ... }
|
|
10385
|
+
p data # => <SfvbApproval>
|
|
10386
|
+
rescue UltracartClient::ApiError => e
|
|
10387
|
+
puts "Error when calling SfvbApi->insert_sfvb_location_approval_with_http_info: #{e}"
|
|
10388
|
+
end
|
|
10389
|
+
```
|
|
10390
|
+
|
|
10391
|
+
### Parameters
|
|
10392
|
+
|
|
10393
|
+
This endpoint does not need any parameter.
|
|
10394
|
+
|
|
10395
|
+
### Return type
|
|
10396
|
+
|
|
10397
|
+
[**SfvbApproval**](SfvbApproval.md)
|
|
10398
|
+
|
|
10399
|
+
### Authorization
|
|
10400
|
+
|
|
10401
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
10402
|
+
|
|
10403
|
+
### HTTP request headers
|
|
10404
|
+
|
|
10405
|
+
- **Content-Type**: Not defined
|
|
10406
|
+
- **Accept**: application/json
|
|
10407
|
+
|
|
10408
|
+
|
|
10246
10409
|
## insert_sfvb_page
|
|
10247
10410
|
|
|
10248
10411
|
> <SfvbPageResponse> insert_sfvb_page(storefront_oid, page_create_request)
|
|
@@ -11457,7 +11620,7 @@ end
|
|
|
11457
11620
|
|
|
11458
11621
|
List the storefront's pages
|
|
11459
11622
|
|
|
11460
|
-
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.
|
|
11623
|
+
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.
|
|
11461
11624
|
|
|
11462
11625
|
|
|
11463
11626
|
### Examples
|
|
@@ -11490,6 +11653,9 @@ end
|
|
|
11490
11653
|
| ---- | ---- | ----------- | ----- |
|
|
11491
11654
|
| **storefront_oid** | **Integer** | | |
|
|
11492
11655
|
| **under** | **String** | Only this page and the pages below it, for example /lp/ | [optional] |
|
|
11656
|
+
| **detail** | **Boolean** | True to include each page's single-page read, a window at a time | [optional] |
|
|
11657
|
+
| **offset** | **Integer** | Where the window starts, with detail=true. Default 0. | [optional] |
|
|
11658
|
+
| **limit** | **Integer** | Pages in the window, 1 to 25, with detail=true. Default 25. | [optional] |
|
|
11493
11659
|
|
|
11494
11660
|
### Return type
|
|
11495
11661
|
|
|
@@ -16176,7 +16342,7 @@ end
|
|
|
16176
16342
|
|
|
16177
16343
|
Change the storefront's faceted search configuration
|
|
16178
16344
|
|
|
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.
|
|
16345
|
+
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).
|
|
16180
16346
|
|
|
16181
16347
|
|
|
16182
16348
|
### Examples
|
data/docs/SfvbApprovalParams.md
CHANGED
|
@@ -13,6 +13,7 @@
|
|
|
13
13
|
| **domain** | **String** | For sending_domain.delete, the sending domain. | [optional] |
|
|
14
14
|
| **esp_twilio_uuid** | **String** | For twilio_account.delete, the Twilio account's esp_twilio_uuid, as GET comms/twilio_account returns it. | [optional] |
|
|
15
15
|
| **experiment_oid** | **Integer** | For experiment.end, the experiment to end. | [optional] |
|
|
16
|
+
| **ip** | **String** | For cli.location, the IPv4 address the StoreFront CLI sign-in asks to be used from. Set by the server from the caller's own address, never by the caller. | [optional] |
|
|
16
17
|
| **item_count** | **Integer** | For item.attribute_batch, how many items the batch would change when it was requested. Set by the server. | [optional] |
|
|
17
18
|
| **merchant_item_oid** | **Integer** | For item.pricing, the item whose pricing changes. | [optional] |
|
|
18
19
|
| **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] |
|
|
@@ -49,6 +50,7 @@ instance = UltracartClient::SfvbApprovalParams.new(
|
|
|
49
50
|
domain: null,
|
|
50
51
|
esp_twilio_uuid: null,
|
|
51
52
|
experiment_oid: null,
|
|
53
|
+
ip: null,
|
|
52
54
|
item_count: null,
|
|
53
55
|
merchant_item_oid: null,
|
|
54
56
|
new_path: null,
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# UltracartClient::SfvbCliLocation
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **ip** | **String** | The IPv4 address this call came from, as UltraCart sees it. | [optional] |
|
|
8
|
+
| **trusted** | **Boolean** | True when the sign-in may be used from this address. When false (omitted), ask for approval with POST /sfvb/location/approval. | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'ultracart_api'
|
|
14
|
+
|
|
15
|
+
instance = UltracartClient::SfvbCliLocation.new(
|
|
16
|
+
ip: null,
|
|
17
|
+
trusted: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -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
|
|
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] |
|
|
@@ -32,6 +33,7 @@ require 'ultracart_api'
|
|
|
32
33
|
instance = UltracartClient::SfvbPageResponse.new(
|
|
33
34
|
attributes: null,
|
|
34
35
|
blog_post_template: null,
|
|
36
|
+
catalog_group_oid: null,
|
|
35
37
|
description: null,
|
|
36
38
|
exclude_from_sitemap: null,
|
|
37
39
|
group_template: 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,
|
data/docs/SfvbWhoamiResponse.md
CHANGED
|
@@ -14,6 +14,7 @@
|
|
|
14
14
|
| **can_read_items** | **Boolean** | True when this token may read item data - the item, its pricing, pre-order and related items. Needs can_read, and the UltraCart user behind the token must hold View Items or Edit Items. A token with no user is judged on its scopes alone. | [optional] |
|
|
15
15
|
| **can_write** | **Boolean** | True when this token may write. Writing a target that is not currently live needs only this. | [optional] |
|
|
16
16
|
| **cli_access** | [**SfvbCliAccess**](SfvbCliAccess.md) | | [optional] |
|
|
17
|
+
| **cli_location** | [**SfvbCliLocation**](SfvbCliLocation.md) | | [optional] |
|
|
17
18
|
| **cli_version** | [**SfvbCliVersion**](SfvbCliVersion.md) | | [optional] |
|
|
18
19
|
| **device_scope** | **String** | Device scope name, when this is a device flow token. | [optional] |
|
|
19
20
|
| **login** | **String** | Login of the user who approved this token. Populated for device flow tokens; null for plain API key credentials. | [optional] |
|
|
@@ -39,6 +40,7 @@ instance = UltracartClient::SfvbWhoamiResponse.new(
|
|
|
39
40
|
can_read_items: null,
|
|
40
41
|
can_write: null,
|
|
41
42
|
cli_access: null,
|
|
43
|
+
cli_location: null,
|
|
42
44
|
cli_version: null,
|
|
43
45
|
device_scope: null,
|
|
44
46
|
login: null,
|