ultracart_api 4.1.253 → 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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: f8041bae71529098837d7bb7fc97a6985ccb38e6a9748eb5209cc2b7794e0a6e
4
- data.tar.gz: 5bb9a1bed5212ddf1d0bb298584e539fb315561ebf345ed13fc621ada646d36a
3
+ metadata.gz: 42d685924ad17c46598a304075febe9a3904bd694c2305181a6bc9637055744d
4
+ data.tar.gz: 52c6a1cfd85fd4bef13748d38c68390c533110231f55cafc3784e129d14a1d47
5
5
  SHA512:
6
- metadata.gz: 468a8add5aba8c7163ae989b151deb20838c4ff793f0842dad50a29f36d067cfe3edfeb647254c42f878447c08cf7e6a6eaf808ff5b8b31f50c8acb996fb1987
7
- data.tar.gz: 68a10eb2595bd3362e0de875c2672d1f6b8db240ca250fe934e7083f70bda32df41369ec770deda579c9766975eb9f074a3d52ad1d78888075540e3ce9f83c84
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.253
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.253'
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
@@ -2129,6 +2130,7 @@ Class | Method | HTTP request | Description
2129
2130
  - [UltracartClient::SfvbExperimentVariationUpdateRequest](docs/SfvbExperimentVariationUpdateRequest.md)
2130
2131
  - [UltracartClient::SfvbExperimentsResponse](docs/SfvbExperimentsResponse.md)
2131
2132
  - [UltracartClient::SfvbFileContentResponse](docs/SfvbFileContentResponse.md)
2133
+ - [UltracartClient::SfvbFileContentResult](docs/SfvbFileContentResult.md)
2132
2134
  - [UltracartClient::SfvbFileEntry](docs/SfvbFileEntry.md)
2133
2135
  - [UltracartClient::SfvbFileRevertRequest](docs/SfvbFileRevertRequest.md)
2134
2136
  - [UltracartClient::SfvbFileSearchRequest](docs/SfvbFileSearchRequest.md)
@@ -2139,6 +2141,8 @@ Class | Method | HTTP request | Description
2139
2141
  - [UltracartClient::SfvbFileVersionsResponse](docs/SfvbFileVersionsResponse.md)
2140
2142
  - [UltracartClient::SfvbFileWriteRequest](docs/SfvbFileWriteRequest.md)
2141
2143
  - [UltracartClient::SfvbFileWriteResponse](docs/SfvbFileWriteResponse.md)
2144
+ - [UltracartClient::SfvbFilesContentRequest](docs/SfvbFilesContentRequest.md)
2145
+ - [UltracartClient::SfvbFilesContentResponse](docs/SfvbFilesContentResponse.md)
2142
2146
  - [UltracartClient::SfvbFilesResponse](docs/SfvbFilesResponse.md)
2143
2147
  - [UltracartClient::SfvbFlow](docs/SfvbFlow.md)
2144
2148
  - [UltracartClient::SfvbFlowBackfillRequest](docs/SfvbFlowBackfillRequest.md)
@@ -2594,6 +2598,7 @@ Not every change is committed to every SDK.
2594
2598
 
2595
2599
  | Version | Date | Comments |
2596
2600
  | --: | :-: | --- |
2601
+ | 4.1.254 | 11/15/2026 | sfvb internal testing |
2597
2602
  | 4.1.253 | 11/13/2026 | sfvb internal testing |
2598
2603
  | 4.1.252 | 11/12/2026 | sfvb internal testing |
2599
2604
  | 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 |
@@ -5907,6 +5908,60 @@ end
5907
5908
  - **Accept**: application/json
5908
5909
 
5909
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
+
5910
5965
  ## get_sfvb_file_upload_url
5911
5966
 
5912
5967
  > <SfvbFileUploadUrlResponse> get_sfvb_file_upload_url(storefront_oid, extension)
@@ -6943,11 +6998,11 @@ end
6943
6998
 
6944
6999
  ## get_sfvb_menus
6945
7000
 
6946
- > <SfvbMenusResponse> get_sfvb_menus(storefront_oid)
7001
+ > <SfvbMenusResponse> get_sfvb_menus(storefront_oid, opts)
6947
7002
 
6948
7003
  List a storefront's store menus
6949
7004
 
6950
- The menus a menu element's menuName can name, sorted by code and without their entries. A code the active theme's templates ask for but nothing has created is included with unconfigured true - that code renders an empty list today, and writing it creates it. A menu no template names is marked undeclared, which usually means a menuName is misspelled.
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.
6951
7006
 
6952
7007
 
6953
7008
  ### Examples
@@ -6960,12 +7015,12 @@ The menus a menu element's menuName can name, sorted by code and without their e
6960
7015
 
6961
7016
  This returns an Array which contains the response data, status code and headers.
6962
7017
 
6963
- > <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)
6964
7019
 
6965
7020
  ```ruby
6966
7021
  begin
6967
7022
  # List a storefront's store menus
6968
- 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)
6969
7024
  p status_code # => 2xx
6970
7025
  p headers # => { ... }
6971
7026
  p data # => <SfvbMenusResponse>
@@ -6979,6 +7034,7 @@ end
6979
7034
  | Name | Type | Description | Notes |
6980
7035
  | ---- | ---- | ----------- | ----- |
6981
7036
  | **storefront_oid** | **Integer** | | |
7037
+ | **include_entries** | **Boolean** | True to include each menu&#39;s entries | [optional] |
6982
7038
 
6983
7039
  ### Return type
6984
7040
 
@@ -7217,11 +7273,11 @@ end
7217
7273
 
7218
7274
  ## get_sfvb_page
7219
7275
 
7220
- > <SfvbPageResponse> get_sfvb_page(storefront_oid, path)
7276
+ > <SfvbPageResponse> get_sfvb_page(storefront_oid, opts)
7221
7277
 
7222
7278
  Read a page's attributes and images
7223
7279
 
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.
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.
7225
7281
 
7226
7282
 
7227
7283
  ### Examples
@@ -7234,12 +7290,12 @@ What the pageattribute and pageimage elements render for this page. These are n
7234
7290
 
7235
7291
  This returns an Array which contains the response data, status code and headers.
7236
7292
 
7237
- > <Array(<SfvbPageResponse>, Integer, Hash)> get_sfvb_page_with_http_info(storefront_oid, path)
7293
+ > <Array(<SfvbPageResponse>, Integer, Hash)> get_sfvb_page_with_http_info(storefront_oid, opts)
7238
7294
 
7239
7295
  ```ruby
7240
7296
  begin
7241
7297
  # Read a page's attributes and images
7242
- data, status_code, headers = api_instance.get_sfvb_page_with_http_info(storefront_oid, path)
7298
+ data, status_code, headers = api_instance.get_sfvb_page_with_http_info(storefront_oid, opts)
7243
7299
  p status_code # => 2xx
7244
7300
  p headers # => { ... }
7245
7301
  p data # => <SfvbPageResponse>
@@ -7253,7 +7309,8 @@ end
7253
7309
  | Name | Type | Description | Notes |
7254
7310
  | ---- | ---- | ----------- | ----- |
7255
7311
  | **storefront_oid** | **Integer** | | |
7256
- | **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&#39;s id, in place of path | [optional] |
7257
7314
 
7258
7315
  ### Return type
7259
7316
 
@@ -11457,7 +11514,7 @@ end
11457
11514
 
11458
11515
  List the storefront's pages
11459
11516
 
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.
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.
11461
11518
 
11462
11519
 
11463
11520
  ### Examples
@@ -11490,6 +11547,9 @@ end
11490
11547
  | ---- | ---- | ----------- | ----- |
11491
11548
  | **storefront_oid** | **Integer** | | |
11492
11549
  | **under** | **String** | Only this page and the pages below it, for example /lp/ | [optional] |
11550
+ | **detail** | **Boolean** | True to include each page&#39;s single-page read, a window at a time | [optional] |
11551
+ | **offset** | **Integer** | Where the window starts, with detail&#x3D;true. Default 0. | [optional] |
11552
+ | **limit** | **Integer** | Pages in the window, 1 to 25, with detail&#x3D;true. Default 25. | [optional] |
11493
11553
 
11494
11554
  ### Return type
11495
11555
 
@@ -16176,7 +16236,7 @@ end
16176
16236
 
16177
16237
  Change the storefront's faceted search configuration
16178
16238
 
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.
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).
16180
16240
 
16181
16241
 
16182
16242
  ### Examples
@@ -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&lt;String&gt;** | 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&lt;SfvbFileContentResult&gt;**](SfvbFileContentResult.md) | One entry per path read, in the order asked. | [optional] |
8
+ | **remaining_paths** | **Array&lt;String&gt;** | 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
+
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **menus** | [**Array&lt;SfvbMenu&gt;**](SfvbMenu.md) | The storefront&#39;s menus, sorted by code. Entries are omitted here - read a single menu to get its tree. | [optional] |
7
+ | **menus** | [**Array&lt;SfvbMenu&gt;**](SfvbMenu.md) | The storefront&#39;s menus, sorted by code. Entries are omitted unless include_entries&#x3D;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&#x3D;true. | [optional] |
7
8
  | **pages** | [**Array&lt;SfvbPageSummary&gt;**](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&#x3D;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
- pages: null
17
+ next_offset: null,
18
+ pages: null,
19
+ total: null
16
20
  )
17
21
  ```
18
22
 
@@ -6,6 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **attributes** | [**Array&lt;SfvbPageAttribute&gt;**](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&#39;s id. It stays the same when the page is moved or renamed, where the path and the page folder&#39;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&#39;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,
@@ -4,7 +4,9 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
+ | **catalog_group_oid** | **Integer** | The page&#39;s id. It stays the same when the page is moved or renamed, where the path and the page folder&#39;s id do not, and it is what a menu entry&#39;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,
@@ -7466,6 +7466,81 @@ module UltracartClient
7466
7466
  return data, status_code, headers
7467
7467
  end
7468
7468
 
7469
+ # Read several storefront files
7470
+ # 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.
7471
+ # @param storefront_oid [Integer]
7472
+ # @param files_request [SfvbFilesContentRequest] The files to read
7473
+ # @param [Hash] opts the optional parameters
7474
+ # @return [SfvbFilesContentResponse]
7475
+ def get_sfvb_file_contents(storefront_oid, files_request, opts = {})
7476
+ data, _status_code, _headers = get_sfvb_file_contents_with_http_info(storefront_oid, files_request, opts)
7477
+ data
7478
+ end
7479
+
7480
+ # Read several storefront files
7481
+ # 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&#39;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.
7482
+ # @param storefront_oid [Integer]
7483
+ # @param files_request [SfvbFilesContentRequest] The files to read
7484
+ # @param [Hash] opts the optional parameters
7485
+ # @return [Array<(SfvbFilesContentResponse, Integer, Hash)>] SfvbFilesContentResponse data, response status code and response headers
7486
+ def get_sfvb_file_contents_with_http_info(storefront_oid, files_request, opts = {})
7487
+ if @api_client.config.debugging
7488
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_file_contents ...'
7489
+ end
7490
+ # verify the required parameter 'storefront_oid' is set
7491
+ if @api_client.config.client_side_validation && storefront_oid.nil?
7492
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_file_contents"
7493
+ end
7494
+ # verify the required parameter 'files_request' is set
7495
+ if @api_client.config.client_side_validation && files_request.nil?
7496
+ fail ArgumentError, "Missing the required parameter 'files_request' when calling SfvbApi.get_sfvb_file_contents"
7497
+ end
7498
+ # resource path
7499
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/files/content'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
7500
+
7501
+ # query parameters
7502
+ query_params = opts[:query_params] || {}
7503
+
7504
+ # header parameters
7505
+ header_params = opts[:header_params] || {}
7506
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
7507
+ # HTTP header 'Accept' (if needed)
7508
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
7509
+ # HTTP header 'Content-Type'
7510
+ content_type = @api_client.select_header_content_type(['application/json'])
7511
+ if !content_type.nil?
7512
+ header_params['Content-Type'] = content_type
7513
+ end
7514
+
7515
+ # form parameters
7516
+ form_params = opts[:form_params] || {}
7517
+
7518
+ # http body (model)
7519
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(files_request)
7520
+
7521
+ # return_type
7522
+ return_type = opts[:debug_return_type] || 'SfvbFilesContentResponse'
7523
+
7524
+ # auth_names
7525
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
7526
+
7527
+ new_options = opts.merge(
7528
+ :operation => :"SfvbApi.get_sfvb_file_contents",
7529
+ :header_params => header_params,
7530
+ :query_params => query_params,
7531
+ :form_params => form_params,
7532
+ :body => post_body,
7533
+ :auth_names => auth_names,
7534
+ :return_type => return_type
7535
+ )
7536
+
7537
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
7538
+ if @api_client.config.debugging
7539
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_file_contents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7540
+ end
7541
+ return data, status_code, headers
7542
+ end
7543
+
7469
7544
  # Get a URL to upload a binary asset to
7470
7545
  # Binary content does not travel through this API as JSON, so uploading an image, font, video or PDF is two steps. Ask here for a URL, PUT the raw bytes straight to it, then call uploadSfvbFile quoting the key you were given. The bytes never pass through the API server. The extension is checked against the accepted type list before a URL is issued, so an unsupported type fails here rather than after you have sent the file. The URL is short lived and the key is bound to your account.
7471
7546
  # @param storefront_oid [Integer]
@@ -8785,9 +8860,10 @@ module UltracartClient
8785
8860
  end
8786
8861
 
8787
8862
  # List a storefront's store menus
8788
- # The menus a menu element's menuName can name, sorted by code and without their entries. A code the active theme's templates ask for but nothing has created is included with unconfigured true - that code renders an empty list today, and writing it creates it. A menu no template names is marked undeclared, which usually means a menuName is misspelled.
8863
+ # 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.
8789
8864
  # @param storefront_oid [Integer]
8790
8865
  # @param [Hash] opts the optional parameters
8866
+ # @option opts [Boolean] :include_entries True to include each menu&#39;s entries
8791
8867
  # @return [SfvbMenusResponse]
8792
8868
  def get_sfvb_menus(storefront_oid, opts = {})
8793
8869
  data, _status_code, _headers = get_sfvb_menus_with_http_info(storefront_oid, opts)
@@ -8795,9 +8871,10 @@ module UltracartClient
8795
8871
  end
8796
8872
 
8797
8873
  # List a storefront&#39;s store menus
8798
- # The menus a menu element&#39;s menuName can name, sorted by code and without their entries. A code the active theme&#39;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.
8874
+ # The menus a menu element&#39;s menuName can name, sorted by code. Without include_entries each menu is listed without its entries; with include_entries&#x3D;true each carries the tree the single-menu read returns, so one call reads every menu. A code the active theme&#39;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.
8799
8875
  # @param storefront_oid [Integer]
8800
8876
  # @param [Hash] opts the optional parameters
8877
+ # @option opts [Boolean] :include_entries True to include each menu&#39;s entries
8801
8878
  # @return [Array<(SfvbMenusResponse, Integer, Hash)>] SfvbMenusResponse data, response status code and response headers
8802
8879
  def get_sfvb_menus_with_http_info(storefront_oid, opts = {})
8803
8880
  if @api_client.config.debugging
@@ -8812,6 +8889,7 @@ module UltracartClient
8812
8889
 
8813
8890
  # query parameters
8814
8891
  query_params = opts[:query_params] || {}
8892
+ query_params[:'include_entries'] = opts[:'include_entries'] if !opts[:'include_entries'].nil?
8815
8893
 
8816
8894
  # header parameters
8817
8895
  header_params = opts[:header_params] || {}
@@ -9135,23 +9213,25 @@ module UltracartClient
9135
9213
  end
9136
9214
 
9137
9215
  # Read a page's attributes and images
9138
- # 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.
9216
+ # 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.
9139
9217
  # @param storefront_oid [Integer]
9140
- # @param path [String] Page path, for example /catalog/dispensers/
9141
9218
  # @param [Hash] opts the optional parameters
9219
+ # @option opts [String] :path Page path, for example /catalog/dispensers/. Required unless catalog_group_oid is given.
9220
+ # @option opts [Integer] :catalog_group_oid The page&#39;s id, in place of path
9142
9221
  # @return [SfvbPageResponse]
9143
- def get_sfvb_page(storefront_oid, path, opts = {})
9144
- data, _status_code, _headers = get_sfvb_page_with_http_info(storefront_oid, path, opts)
9222
+ def get_sfvb_page(storefront_oid, opts = {})
9223
+ data, _status_code, _headers = get_sfvb_page_with_http_info(storefront_oid, opts)
9145
9224
  data
9146
9225
  end
9147
9226
 
9148
9227
  # Read a page&#39;s attributes and images
9149
- # 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.
9228
+ # 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.
9150
9229
  # @param storefront_oid [Integer]
9151
- # @param path [String] Page path, for example /catalog/dispensers/
9152
9230
  # @param [Hash] opts the optional parameters
9231
+ # @option opts [String] :path Page path, for example /catalog/dispensers/. Required unless catalog_group_oid is given.
9232
+ # @option opts [Integer] :catalog_group_oid The page&#39;s id, in place of path
9153
9233
  # @return [Array<(SfvbPageResponse, Integer, Hash)>] SfvbPageResponse data, response status code and response headers
9154
- def get_sfvb_page_with_http_info(storefront_oid, path, opts = {})
9234
+ def get_sfvb_page_with_http_info(storefront_oid, opts = {})
9155
9235
  if @api_client.config.debugging
9156
9236
  @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_page ...'
9157
9237
  end
@@ -9159,16 +9239,13 @@ module UltracartClient
9159
9239
  if @api_client.config.client_side_validation && storefront_oid.nil?
9160
9240
  fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_page"
9161
9241
  end
9162
- # verify the required parameter 'path' is set
9163
- if @api_client.config.client_side_validation && path.nil?
9164
- fail ArgumentError, "Missing the required parameter 'path' when calling SfvbApi.get_sfvb_page"
9165
- end
9166
9242
  # resource path
9167
9243
  local_var_path = '/sfvb/storefronts/{storefront_oid}/pages'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
9168
9244
 
9169
9245
  # query parameters
9170
9246
  query_params = opts[:query_params] || {}
9171
- query_params[:'path'] = path
9247
+ query_params[:'path'] = opts[:'path'] if !opts[:'path'].nil?
9248
+ query_params[:'catalog_group_oid'] = opts[:'catalog_group_oid'] if !opts[:'catalog_group_oid'].nil?
9172
9249
 
9173
9250
  # header parameters
9174
9251
  header_params = opts[:header_params] || {}
@@ -14687,10 +14764,13 @@ module UltracartClient
14687
14764
  end
14688
14765
 
14689
14766
  # List the storefront's pages
14690
- # 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.
14767
+ # 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.
14691
14768
  # @param storefront_oid [Integer]
14692
14769
  # @param [Hash] opts the optional parameters
14693
14770
  # @option opts [String] :under Only this page and the pages below it, for example /lp/
14771
+ # @option opts [Boolean] :detail True to include each page&#39;s single-page read, a window at a time
14772
+ # @option opts [Integer] :offset Where the window starts, with detail&#x3D;true. Default 0.
14773
+ # @option opts [Integer] :limit Pages in the window, 1 to 25, with detail&#x3D;true. Default 25.
14694
14774
  # @return [SfvbPageListResponse]
14695
14775
  def list_sfvb_pages(storefront_oid, opts = {})
14696
14776
  data, _status_code, _headers = list_sfvb_pages_with_http_info(storefront_oid, opts)
@@ -14698,10 +14778,13 @@ module UltracartClient
14698
14778
  end
14699
14779
 
14700
14780
  # List the storefront&#39;s pages
14701
- # 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.
14781
+ # 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&#x3D;true to get each page&#39;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.
14702
14782
  # @param storefront_oid [Integer]
14703
14783
  # @param [Hash] opts the optional parameters
14704
14784
  # @option opts [String] :under Only this page and the pages below it, for example /lp/
14785
+ # @option opts [Boolean] :detail True to include each page&#39;s single-page read, a window at a time
14786
+ # @option opts [Integer] :offset Where the window starts, with detail&#x3D;true. Default 0.
14787
+ # @option opts [Integer] :limit Pages in the window, 1 to 25, with detail&#x3D;true. Default 25.
14705
14788
  # @return [Array<(SfvbPageListResponse, Integer, Hash)>] SfvbPageListResponse data, response status code and response headers
14706
14789
  def list_sfvb_pages_with_http_info(storefront_oid, opts = {})
14707
14790
  if @api_client.config.debugging
@@ -14717,6 +14800,9 @@ module UltracartClient
14717
14800
  # query parameters
14718
14801
  query_params = opts[:query_params] || {}
14719
14802
  query_params[:'under'] = opts[:'under'] if !opts[:'under'].nil?
14803
+ query_params[:'detail'] = opts[:'detail'] if !opts[:'detail'].nil?
14804
+ query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
14805
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
14720
14806
 
14721
14807
  # header parameters
14722
14808
  header_params = opts[:header_params] || {}
@@ -21588,7 +21674,7 @@ module UltracartClient
21588
21674
  end
21589
21675
 
21590
21676
  # Change the storefront's faceted search configuration
21591
- # 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.
21677
+ # 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).
21592
21678
  # @param storefront_oid [Integer]
21593
21679
  # @param search_facets_request [SfvbSearchFacetsRequest] The facets and price breaks to change
21594
21680
  # @param [Hash] opts the optional parameters
@@ -21600,7 +21686,7 @@ module UltracartClient
21600
21686
  end
21601
21687
 
21602
21688
  # Change the storefront&#39;s faceted search configuration
21603
- # A partial update. Turn facets on or off, change their headings, and replace the Cost facet&#39;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.
21689
+ # A partial update. Turn facets on or off, change their headings, and replace the Cost facet&#39;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).
21604
21690
  # @param storefront_oid [Integer]
21605
21691
  # @param search_facets_request [SfvbSearchFacetsRequest] The facets and price breaks to change
21606
21692
  # @param [Hash] opts the optional parameters