ultracart_api 4.1.155 → 4.1.157

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24314cf0f18fc69b1c86c36bf3286ae46d625958a18800271a20d225ec797a9c
-  data.tar.gz: 03da8af5d356bdbe3d03ca56057f38a03deff2b2fe2a9cbe038666eb6a0cee54
+  metadata.gz: 9a92c02a477046100fa9bb81d90ce5912f2ef0f1f48683b51c98e34c1df71287
+  data.tar.gz: 9496625114b7bba219bc0198c389e5b84afcf52bb55704570f77db6122d24d36
 SHA512:
-  metadata.gz: 2a3f15bff02873f539363351665d678ee06534356f44851f5415ac69c71212c2a15f71a4715d540d5894311392183c2ad2b10d0dcb2ebbb7e50d941ae74f7491
-  data.tar.gz: f081572ef243c7c9690a7bc235763ae4249dc602005d36000326ff24d184ee7cda5e52f35297326149c3c951484e317ed2cdd52b4a60d86e63d2b9ccb39d5ce4
+  metadata.gz: fe801ea021b22c5d654b7f6e6ea21842c89a103d8923bb1ab65d33d14bfa4a03e105b34f4291734165736aa8ae14c9728e42d60aab45b0542b2319bb489adb32
+  data.tar.gz: cf281a37520c9c3885190f30e9c31e6367fa04e8c67512b413d81b3b3cb1c99bae3d12174bb4ffbad79a7ed84b8a8a0ee0bb4961addfdc3e8c7b9c1ddedab73c

data/README.md

@@ -7,7 +7,7 @@ Note: Every method has a sample for every language.  See https://github.com/Ultr
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 2.0.0
-- Package version: 4.1.155
+- Package version: 4.1.157
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 - For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
 
@@ -16,7 +16,7 @@ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-g
 gemfile:
 
 ```shell
-gem 'ultracart_api', '4.1.155'
+gem 'ultracart_api', '4.1.157'
 ```
 
 install:
@@ -487,6 +487,8 @@ Class | Method | HTTP request | Description
 *UltracartClient::SfvbApi* | [**get_sfvb_file_content**](docs/SfvbApi.md#get_sfvb_file_content) | **GET** /sfvb/storefronts/{storefront_oid}/files/content | Read a storefront file
 *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
 *UltracartClient::SfvbApi* | [**get_sfvb_library_entry**](docs/SfvbApi.md#get_sfvb_library_entry) | **GET** /sfvb/storefronts/{storefront_oid}/library/{library_oid} | Read one library entry including its CJSON
+*UltracartClient::SfvbApi* | [**get_sfvb_menu**](docs/SfvbApi.md#get_sfvb_menu) | **GET** /sfvb/storefronts/{storefront_oid}/menus/{code} | Read one store menu and its entries
+*UltracartClient::SfvbApi* | [**get_sfvb_menus**](docs/SfvbApi.md#get_sfvb_menus) | **GET** /sfvb/storefronts/{storefront_oid}/menus | List a storefront's store menus
 *UltracartClient::SfvbApi* | [**get_sfvb_page**](docs/SfvbApi.md#get_sfvb_page) | **GET** /sfvb/storefronts/{storefront_oid}/pages | Read a page's attributes and images
 *UltracartClient::SfvbApi* | [**get_sfvb_preview_url**](docs/SfvbApi.md#get_sfvb_preview_url) | **GET** /sfvb/storefronts/{storefront_oid}/preview_sessions/{preview_session_id}/url | URL that renders a preview session
 *UltracartClient::SfvbApi* | [**get_sfvb_theme**](docs/SfvbApi.md#get_sfvb_theme) | **GET** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid} | Get a theme
@@ -504,6 +506,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::SfvbApi* | [**list_sfvb_upsell_offers**](docs/SfvbApi.md#list_sfvb_upsell_offers) | **GET** /sfvb/storefronts/{storefront_oid}/upsell_offers | List upsell offers
 *UltracartClient::SfvbApi* | [**put_sfvb_container**](docs/SfvbApi.md#put_sfvb_container) | **PUT** /sfvb/storefronts/{storefront_oid}/containers/{owner_type}/{owner_object_id} | Write a container stored outside the file system
 *UltracartClient::SfvbApi* | [**put_sfvb_file_content**](docs/SfvbApi.md#put_sfvb_file_content) | **PUT** /sfvb/storefronts/{storefront_oid}/files/content | Write a storefront file
+*UltracartClient::SfvbApi* | [**put_sfvb_menu**](docs/SfvbApi.md#put_sfvb_menu) | **PUT** /sfvb/storefronts/{storefront_oid}/menus/{code} | Replace a store menu's entries
 *UltracartClient::SfvbApi* | [**put_sfvb_page_attributes**](docs/SfvbApi.md#put_sfvb_page_attributes) | **PUT** /sfvb/storefronts/{storefront_oid}/pages/attributes | Change a page's attributes
 *UltracartClient::SfvbApi* | [**put_sfvb_page_multimedia**](docs/SfvbApi.md#put_sfvb_page_multimedia) | **PUT** /sfvb/storefronts/{storefront_oid}/pages/multimedia | Attach an image to a page
 *UltracartClient::SfvbApi* | [**put_sfvb_preview_session**](docs/SfvbApi.md#put_sfvb_preview_session) | **PUT** /sfvb/storefronts/{storefront_oid}/preview_sessions/{preview_session_id} | Push containers into a preview session
@@ -1759,6 +1762,10 @@ Class | Method | HTTP request | Description
  - [UltracartClient::SfvbLibraryEntry](docs/SfvbLibraryEntry.md)
  - [UltracartClient::SfvbLibraryFacet](docs/SfvbLibraryFacet.md)
  - [UltracartClient::SfvbLibraryResponse](docs/SfvbLibraryResponse.md)
+ - [UltracartClient::SfvbMenu](docs/SfvbMenu.md)
+ - [UltracartClient::SfvbMenuItem](docs/SfvbMenuItem.md)
+ - [UltracartClient::SfvbMenuWriteRequest](docs/SfvbMenuWriteRequest.md)
+ - [UltracartClient::SfvbMenusResponse](docs/SfvbMenusResponse.md)
  - [UltracartClient::SfvbPageAttribute](docs/SfvbPageAttribute.md)
  - [UltracartClient::SfvbPageAttributeUpdate](docs/SfvbPageAttributeUpdate.md)
  - [UltracartClient::SfvbPageAttributeUpdateRequest](docs/SfvbPageAttributeUpdateRequest.md)
@@ -1955,6 +1962,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.157 | 09/18/2026 | sfvb internal testing |
+| 4.1.156 | 09/16/2026 | sfvb internal testing |
 | 4.1.155 | 09/15/2026 | sfvb internal testing |
 | 4.1.154 | 09/14/2026 | sfvb internal testing |
 | 4.1.153 | 09/14/2026 | sfvb internal testing |

data/docs/SfvbApi.md

@@ -19,6 +19,8 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**get_sfvb_file_content**](SfvbApi.md#get_sfvb_file_content) | **GET** /sfvb/storefronts/{storefront_oid}/files/content | Read a storefront file |
 | [**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 |
 | [**get_sfvb_library_entry**](SfvbApi.md#get_sfvb_library_entry) | **GET** /sfvb/storefronts/{storefront_oid}/library/{library_oid} | Read one library entry including its CJSON |
+| [**get_sfvb_menu**](SfvbApi.md#get_sfvb_menu) | **GET** /sfvb/storefronts/{storefront_oid}/menus/{code} | Read one store menu and its entries |
+| [**get_sfvb_menus**](SfvbApi.md#get_sfvb_menus) | **GET** /sfvb/storefronts/{storefront_oid}/menus | List a storefront's store menus |
 | [**get_sfvb_page**](SfvbApi.md#get_sfvb_page) | **GET** /sfvb/storefronts/{storefront_oid}/pages | Read a page's attributes and images |
 | [**get_sfvb_preview_url**](SfvbApi.md#get_sfvb_preview_url) | **GET** /sfvb/storefronts/{storefront_oid}/preview_sessions/{preview_session_id}/url | URL that renders a preview session |
 | [**get_sfvb_theme**](SfvbApi.md#get_sfvb_theme) | **GET** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid} | Get a theme |
@@ -36,6 +38,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**list_sfvb_upsell_offers**](SfvbApi.md#list_sfvb_upsell_offers) | **GET** /sfvb/storefronts/{storefront_oid}/upsell_offers | List upsell offers |
 | [**put_sfvb_container**](SfvbApi.md#put_sfvb_container) | **PUT** /sfvb/storefronts/{storefront_oid}/containers/{owner_type}/{owner_object_id} | Write a container stored outside the file system |
 | [**put_sfvb_file_content**](SfvbApi.md#put_sfvb_file_content) | **PUT** /sfvb/storefronts/{storefront_oid}/files/content | Write a storefront file |
+| [**put_sfvb_menu**](SfvbApi.md#put_sfvb_menu) | **PUT** /sfvb/storefronts/{storefront_oid}/menus/{code} | Replace a store menu's entries |
 | [**put_sfvb_page_attributes**](SfvbApi.md#put_sfvb_page_attributes) | **PUT** /sfvb/storefronts/{storefront_oid}/pages/attributes | Change a page's attributes |
 | [**put_sfvb_page_multimedia**](SfvbApi.md#put_sfvb_page_multimedia) | **PUT** /sfvb/storefronts/{storefront_oid}/pages/multimedia | Attach an image to a page |
 | [**put_sfvb_preview_session**](SfvbApi.md#put_sfvb_preview_session) | **PUT** /sfvb/storefronts/{storefront_oid}/preview_sessions/{preview_session_id} | Push containers into a preview session |
@@ -542,7 +545,7 @@ end
 
 Read a container stored outside the file system
 
-owner_type is one of upsell, email, postcardfront, postcardback or item.  Item containers also require container_name.  Theme and page containers are files; read those through files/content. 
+owner_type is one of upsell, email, postcardfront, postcardback, item or itemid.  It also says how owner_object_id is read - item and upsell take an oid, itemid takes a merchant item id, and the rest take an esp uuid.  itemid reaches the same containers as item and is the way to address one from a storefront, where data-context-item-id carries the merchant item id and the oid appears nowhere.  Item containers also require container_name.  Theme and page containers are files; read those through files/content. 
 
 
 ### Examples
@@ -598,7 +601,7 @@ end
 
 Read the CJSON stored in one container history entry
 
-Inspect or diff an earlier version without reverting to it.  The version is addressed through the container that owns it, so a history oid belonging to some other resource cannot be read through this route. 
+Inspect or diff an earlier version without reverting to it.  The version is addressed through the container that owns it, so a history oid belonging to some other resource cannot be read through this route.  owner_type also says how owner_object_id is read, and itemid addresses an item container by merchant item id. 
 
 
 ### Examples
@@ -865,6 +868,113 @@ end
 - **Accept**: application/json
 
 
+## get_sfvb_menu
+
+> <SfvbMenu> get_sfvb_menu(storefront_oid, code)
+
+Read one store menu and its entries
+
+The whole tree, in render order.  Page entries carry the page_path they resolve to and item entries the merchant_item_id, rather than the oids the storage keeps.  Menu item oids are not returned at all because a write regenerates every one of them.  Keep hash_sha256 - it is the If-Match a write needs. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the get_sfvb_menu_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SfvbMenu>, Integer, Hash)> get_sfvb_menu_with_http_info(storefront_oid, code)
+
+```ruby
+begin
+  # Read one store menu and its entries
+  data, status_code, headers = api_instance.get_sfvb_menu_with_http_info(storefront_oid, code)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SfvbMenu>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling SfvbApi->get_sfvb_menu_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **storefront_oid** | **Integer** |  |  |
+| **code** | **String** | Menu code, matched without regard to case |  |
+
+### Return type
+
+[**SfvbMenu**](SfvbMenu.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_sfvb_menus
+
+> <SfvbMenusResponse> get_sfvb_menus(storefront_oid)
+
+List a storefront's store menus
+
+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. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the get_sfvb_menus_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SfvbMenusResponse>, Integer, Hash)> get_sfvb_menus_with_http_info(storefront_oid)
+
+```ruby
+begin
+  # List a storefront's store menus
+  data, status_code, headers = api_instance.get_sfvb_menus_with_http_info(storefront_oid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SfvbMenusResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling SfvbApi->get_sfvb_menus_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **storefront_oid** | **Integer** |  |  |
+
+### Return type
+
+[**SfvbMenusResponse**](SfvbMenusResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_sfvb_page
 
 > <SfvbPageResponse> get_sfvb_page(storefront_oid, path)
@@ -1296,6 +1406,8 @@ end
 
 Version history for a container stored outside the file system
 
+Addressed the same way as the container itself, so owner_type also says how owner_object_id is read and itemid lists the history of the item container that merchant item id names. 
+
 
 ### Examples
 
@@ -1667,7 +1779,7 @@ end
 
 Write a container stored outside the file system
 
-Validation is mandatory and runs here regardless of whether the caller validated first.  The previous value is snapshotted before the write, so the change can be reverted.  Side effects the visual builder performs on save, such as upsell screenshot regeneration and email content review flagging, are applied too. 
+Validation is mandatory and runs here regardless of whether the caller validated first.  The previous value is snapshotted before the write, so the change can be reverted.  Side effects the visual builder performs on save, such as upsell screenshot regeneration and email content review flagging, are applied too.  owner_type also says how owner_object_id is read; send itemid to address an item container by merchant item id rather than by oid.  Either way the history records the one canonical address, so a container written under one spelling is listed and reverted under the other. 
 
 
 ### Examples
@@ -1775,6 +1887,62 @@ end
 - **Accept**: application/json
 
 
+## put_sfvb_menu
+
+> <SfvbMenu> put_sfvb_menu(storefront_oid, code, menu_write_request, opts)
+
+Replace a store menu's entries
+
+A whole menu replace, not a merge - what you send is what the menu holds afterwards, so read it, change the tree and send it back.  Omitting items changes only the title; sending an empty array empties the menu.  Writing a code that does not exist creates it.  Every entry is checked before any of it is written, including that a merchant_item_id and a page_path actually resolve, so a tree with one bad entry changes nothing.  Always needs sfvb_publish, because a menu is shared by every theme and there is no dormant copy to change instead. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the put_sfvb_menu_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SfvbMenu>, Integer, Hash)> put_sfvb_menu_with_http_info(storefront_oid, code, menu_write_request, opts)
+
+```ruby
+begin
+  # Replace a store menu's entries
+  data, status_code, headers = api_instance.put_sfvb_menu_with_http_info(storefront_oid, code, menu_write_request, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SfvbMenu>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling SfvbApi->put_sfvb_menu_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **storefront_oid** | **Integer** |  |  |
+| **code** | **String** | Menu code, matched without regard to case |  |
+| **menu_write_request** | [**SfvbMenuWriteRequest**](SfvbMenuWriteRequest.md) | The menu&#39;s replacement contents |  |
+| **if_match** | **String** | Content hash from the last read.  Required when the menu already exists; 428 when absent, 412 when stale. | [optional] |
+
+### Return type
+
+[**SfvbMenu**](SfvbMenu.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## put_sfvb_page_attributes
 
 > <SfvbPageResponse> put_sfvb_page_attributes(storefront_oid, path, page_attribute_update_request)
@@ -2111,7 +2279,7 @@ end
 
 Revert a container stored outside the file system
 
-The restore is itself snapshotted, so a revert can be undone in turn.  Reverting to an entry recorded before the container existed removes it again.  Addressed through the owning container and guarded by If-Match, because a revert overwrites live content just as much as an ordinary write does. 
+The restore is itself snapshotted, so a revert can be undone in turn.  Reverting to an entry recorded before the container existed removes it again.  Addressed through the owning container and guarded by If-Match, because a revert overwrites live content just as much as an ordinary write does.  owner_type also says how owner_object_id is read, so a version written by oid can be reverted by merchant item id and the other way round. 
 
 
 ### Examples

data/docs/SfvbContainerResponse.md

@@ -8,6 +8,7 @@
 | **container_name** | **String** | Container name. | [optional] |
 | **hash_sha256** | **String** | SHA-256 of the cjson.  Send back as If-Match when writing. | [optional] |
 | **last_modified** | **String** | When the container was last modified, in the store's own record of it.  Every owner type reports this.  It is absent only when the container has never been written since the store began recording it, so treat an absent value as unknown rather than as never modified.  Two behaviours worth knowing.  A postcard keeps one timestamp for both of its sides, so writing the front moves the value the back reports.  An upsell container that is rewritten with byte identical content keeps its original date rather than moving to now, because the timestamp tracks changes to the container and not writes to the offer. | [optional] |
+| **merchant_item_id** | **String** | The merchant item id of the owning item, for item containers only and absent for every other owner type.  owner_object_id is the item oid, which appears nowhere on a rendered storefront, so this is how a caller confirms which item an oid actually reached.  It is read fresh on every call and so reflects a renamed item.  A container's own id embeds this value, which is what a preview session keys an item container on. | [optional] |
 | **owner_object_id** | **String** | Identifier of the owning object within its store. | [optional] |
 | **owner_type** | **String** | Where this container lives. | [optional] |
 
@@ -21,6 +22,7 @@ instance = UltracartClient::SfvbContainerResponse.new(
   container_name: null,
   hash_sha256: null,
   last_modified: null,
+  merchant_item_id: null,
   owner_object_id: null,
   owner_type: null
 )

data/docs/SfvbMenu.md

@@ -0,0 +1,30 @@
+# UltracartClient::SfvbMenu
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** | The menu's code, which is the value a menu element's menuName refers to.  Compare case insensitively. | [optional] |
+| **hash_sha256** | **String** | Content hash of the menu as stored.  Send it back as If-Match when writing. | [optional] |
+| **item_count** | **Integer** | How many entries the menu holds in total, counting every level of the tree. | [optional] |
+| **items** | [**Array<SfvbMenuItem>**](SfvbMenuItem.md) | The menu's entries, in the order they render.  Omitted from the list endpoint, which returns each menu's identity and counts only. | [optional] |
+| **title** | **String** | The menu's own label, shown in the store admin rather than on the storefront.  Trimmed to 250 characters. | [optional] |
+| **unconfigured** | **Boolean** | True when a template names this code but no menu has been created for it.  Such a code renders an empty list today.  Write it to create it. | [optional] |
+| **undeclared** | **Boolean** | True when no template on the storefront names this code.  The menu is stored and editable, but nothing renders it, which usually means a menu element's menuName is misspelled. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbMenu.new(
+  code: null,
+  hash_sha256: null,
+  item_count: null,
+  items: null,
+  title: null,
+  unconfigured: null,
+  undeclared: null
+)
+```
+

data/docs/SfvbMenuItem.md

@@ -0,0 +1,36 @@
+# UltracartClient::SfvbMenuItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **catalog_group_oid** | **Integer** | The catalog group page_path resolved to.  Returned for reference and ignored on a write - send page_path, which is the identifier the rest of this API uses. | [optional] |
+| **description** | **String** | The link text, and the only field every type needs.  Required. | [optional] |
+| **items** | [**Array<SfvbMenuItem>**](SfvbMenuItem.md) | This entry's sub menu, in the order it renders.  Omit or send an empty array for a leaf. | [optional] |
+| **merchant_item_id** | **String** | The item an item entry opens, by merchant item id rather than by oid. | [optional] |
+| **open_in_new_window** | **Boolean** | True to open the link in a new window or tab. | [optional] |
+| **page_path** | **String** | The page a page entry opens, normalized to begin and end with a slash.  This is the same path the pages endpoints take.  Sent on a write and returned on a read. | [optional] |
+| **social_page_type** | **String** | Which social network a social entry opens.  The URL comes from the storefront's social settings. | [optional] |
+| **system_page_type** | **String** | Which built in page a system page entry opens.  The storefront resolves the URL, so these keep working when the checkout or account paths change. | [optional] |
+| **type** | **String** | What the entry points at, which decides which one of the other fields is required.  custom needs url, item needs merchant_item_id, page needs page_path, social needs social_page_type, and system page needs system_page_type.  The legacy spelling group is accepted and stored as page. | [optional] |
+| **url** | **String** | Where a custom entry goes.  Any URL the storefront can link to, absolute or site relative. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbMenuItem.new(
+  catalog_group_oid: null,
+  description: null,
+  items: null,
+  merchant_item_id: null,
+  open_in_new_window: null,
+  page_path: null,
+  social_page_type: null,
+  system_page_type: null,
+  type: null,
+  url: null
+)
+```
+

data/docs/SfvbMenuWriteRequest.md

@@ -0,0 +1,20 @@
+# UltracartClient::SfvbMenuWriteRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **items** | [**Array<SfvbMenuItem>**](SfvbMenuItem.md) | The entries the menu should hold, in render order.  Omit to leave the entries alone and change only the title. | [optional] |
+| **title** | **String** | The menu's label in the store admin.  Trimmed to 250 characters.  Leave it off to keep the current one. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbMenuWriteRequest.new(
+  items: null,
+  title: null
+)
+```
+

data/docs/SfvbMenusResponse.md

@@ -0,0 +1,18 @@
+# UltracartClient::SfvbMenusResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **menus** | [**Array<SfvbMenu>**](SfvbMenu.md) | The storefront's menus, sorted by code.  Entries are omitted here - read a single menu to get its tree. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbMenusResponse.new(
+  menus: null
+)
+```
+

data/docs/SfvbPreviewAccessResponse.md

@@ -8,7 +8,7 @@
 | **expires_in_seconds** | **Integer** | Seconds left to open access_url.  It stops working after that, and after its first use. | [optional] |
 | **path** | **String** | Storefront path the browser lands on, after reserved preview parameters are removed. | [optional] |
 | **preview_session_id** | **String** | The preview session applied, when one was requested. | [optional] |
-| **session_lifetime_seconds** | **Integer** | How long the browser stays in preview once access_url is opened.  The remaining life of the preview session, or eight hours when none was given.  The user and their storefront permission are checked again on every page, so removing either ends it sooner. | [optional] |
+| **session_lifetime_seconds** | **Integer** | How long the browser stays in preview once access_url is opened.  The remaining life of the preview session, or eight hours when none was given.  Ending the preview session ends preview in that browser at its next page.  The user and their storefront permission are checked again on every page, so removing either ends it sooner. | [optional] |
 | **single_use** | **Boolean** | Always true.  A second open of access_url returns 410. | [optional] |
 | **theme_oid** | **Integer** | The theme shown, when one was requested. | [optional] |
 | **usage_note** | **String** | Plain language instructions, safe to show a user. | [optional] |

data/docs/SfvbVersionResponse.md

@@ -11,6 +11,8 @@
 | **max_cjson_bytes** | **Integer** | Largest CJSON document that will be parsed, in bytes. | [optional] |
 | **max_directory_entries** | **Integer** | Most entries one directory listing returns.  Asking for more is silently reduced to this rather than refused, so compare against it instead of trusting that you got what you asked for.  The listing does set a truncated flag when it drops entries. | [optional] |
 | **max_library_results_per_page** | **Integer** | Most element library results one page returns.  Asking for more is silently reduced to this, and unlike the directory listing there is no truncation flag on the response, so this number is the only way to know a larger request was cut. | [optional] |
+| **max_menu_depth** | **Integer** | How deeply store menu entries can nest. | [optional] |
+| **max_menu_items** | **Integer** | Most entries one store menu can hold, counting every level of the tree.  A menu is navigation that renders on every page, so this is deliberately far below what the storage would physically accept. | [optional] |
 | **max_preview_session_bytes** | **Integer** | Largest payload one preview session may hold, in bytes. | [optional] |
 | **max_revertable_bytes** | **Integer** | Largest historical version files/revert will restore, in bytes.  Higher than max_text_read_bytes deliberately - putting back a version that is already stored is cheaper than serving it as JSON, so a version too large to read can still be reverted to. | [optional] |
 | **max_search_results** | **Integer** | Hard ceiling on file search results per page. | [optional] |
@@ -34,6 +36,8 @@ instance = UltracartClient::SfvbVersionResponse.new(
   max_cjson_bytes: null,
   max_directory_entries: null,
   max_library_results_per_page: null,
+  max_menu_depth: null,
+  max_menu_items: null,
   max_preview_session_bytes: null,
   max_revertable_bytes: null,
   max_search_results: null,