ultracart_api 4.1.155 → 4.1.156

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24314cf0f18fc69b1c86c36bf3286ae46d625958a18800271a20d225ec797a9c
-  data.tar.gz: 03da8af5d356bdbe3d03ca56057f38a03deff2b2fe2a9cbe038666eb6a0cee54
+  metadata.gz: 4eb86992bc479fd054fc72958e6622d59bd4cb72f2dbb13f7db9e69ef2517e0e
+  data.tar.gz: bf9953831d56669b3c62cf555be9631ec74e78bae97a83e0cbc5f67397ac8d1c
 SHA512:
-  metadata.gz: 2a3f15bff02873f539363351665d678ee06534356f44851f5415ac69c71212c2a15f71a4715d540d5894311392183c2ad2b10d0dcb2ebbb7e50d941ae74f7491
-  data.tar.gz: f081572ef243c7c9690a7bc235763ae4249dc602005d36000326ff24d184ee7cda5e52f35297326149c3c951484e317ed2cdd52b4a60d86e63d2b9ccb39d5ce4
+  metadata.gz: d28e46f9455289b3b14ae48c7a4dbe5494208704671bbd17fd9ebf11c2a31ca18ce8d2249967b0c9ee9aa4411d30eecf5e8bcd2209f0bac4a27dd808d30be23c
+  data.tar.gz: 5292805e1e2d9213267e48623ed2fdba79e332dfcfd3b9cf7ab91b082b8f6f7cdd4bb167d8becfc655499b84c857a40f48aa7467cb07f2a77cd9bb73293d4484

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.156
 - 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.156'
 ```
 
 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,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 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 |
@@ -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)
@@ -1775,6 +1885,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)

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,

data/lib/ultracart_api/api/sfvb_api.rb

@@ -1104,6 +1104,140 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # 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. 
+    # @param storefront_oid [Integer] 
+    # @param code [String] Menu code, matched without regard to case
+    # @param [Hash] opts the optional parameters
+    # @return [SfvbMenu]
+    def get_sfvb_menu(storefront_oid, code, opts = {})
+      data, _status_code, _headers = get_sfvb_menu_with_http_info(storefront_oid, code, opts)
+      data
+    end
+
+    # 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. 
+    # @param storefront_oid [Integer] 
+    # @param code [String] Menu code, matched without regard to case
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SfvbMenu, Integer, Hash)>] SfvbMenu data, response status code and response headers
+    def get_sfvb_menu_with_http_info(storefront_oid, code, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_menu ...'
+      end
+      # verify the required parameter 'storefront_oid' is set
+      if @api_client.config.client_side_validation && storefront_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_menu"
+      end
+      # verify the required parameter 'code' is set
+      if @api_client.config.client_side_validation && code.nil?
+        fail ArgumentError, "Missing the required parameter 'code' when calling SfvbApi.get_sfvb_menu"
+      end
+      # resource path
+      local_var_path = '/sfvb/storefronts/{storefront_oid}/menus/{code}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'code' + '}', CGI.escape(code.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SfvbMenu'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"SfvbApi.get_sfvb_menu",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_menu\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # 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. 
+    # @param storefront_oid [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @return [SfvbMenusResponse]
+    def get_sfvb_menus(storefront_oid, opts = {})
+      data, _status_code, _headers = get_sfvb_menus_with_http_info(storefront_oid, opts)
+      data
+    end
+
+    # List a storefront&#39;s store menus
+    # 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. 
+    # @param storefront_oid [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SfvbMenusResponse, Integer, Hash)>] SfvbMenusResponse data, response status code and response headers
+    def get_sfvb_menus_with_http_info(storefront_oid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_menus ...'
+      end
+      # verify the required parameter 'storefront_oid' is set
+      if @api_client.config.client_side_validation && storefront_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_menus"
+      end
+      # resource path
+      local_var_path = '/sfvb/storefronts/{storefront_oid}/menus'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SfvbMenusResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"SfvbApi.get_sfvb_menus",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_menus\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Read a page's attributes and images
     # 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. 
     # @param storefront_oid [Integer] 
@@ -2280,6 +2414,90 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # 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. 
+    # @param storefront_oid [Integer] 
+    # @param code [String] Menu code, matched without regard to case
+    # @param menu_write_request [SfvbMenuWriteRequest] The menu&#39;s replacement contents
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :if_match Content hash from the last read.  Required when the menu already exists; 428 when absent, 412 when stale.
+    # @return [SfvbMenu]
+    def put_sfvb_menu(storefront_oid, code, menu_write_request, opts = {})
+      data, _status_code, _headers = put_sfvb_menu_with_http_info(storefront_oid, code, menu_write_request, opts)
+      data
+    end
+
+    # Replace a store menu&#39;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. 
+    # @param storefront_oid [Integer] 
+    # @param code [String] Menu code, matched without regard to case
+    # @param menu_write_request [SfvbMenuWriteRequest] The menu&#39;s replacement contents
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :if_match Content hash from the last read.  Required when the menu already exists; 428 when absent, 412 when stale.
+    # @return [Array<(SfvbMenu, Integer, Hash)>] SfvbMenu data, response status code and response headers
+    def put_sfvb_menu_with_http_info(storefront_oid, code, menu_write_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SfvbApi.put_sfvb_menu ...'
+      end
+      # verify the required parameter 'storefront_oid' is set
+      if @api_client.config.client_side_validation && storefront_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.put_sfvb_menu"
+      end
+      # verify the required parameter 'code' is set
+      if @api_client.config.client_side_validation && code.nil?
+        fail ArgumentError, "Missing the required parameter 'code' when calling SfvbApi.put_sfvb_menu"
+      end
+      # verify the required parameter 'menu_write_request' is set
+      if @api_client.config.client_side_validation && menu_write_request.nil?
+        fail ArgumentError, "Missing the required parameter 'menu_write_request' when calling SfvbApi.put_sfvb_menu"
+      end
+      # resource path
+      local_var_path = '/sfvb/storefronts/{storefront_oid}/menus/{code}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'code' + '}', CGI.escape(code.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+      header_params[:'If-Match'] = opts[:'if_match'] if !opts[:'if_match'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(menu_write_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SfvbMenu'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"SfvbApi.put_sfvb_menu",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SfvbApi#put_sfvb_menu\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Change a page's attributes
     # A partial update.  Only the attributes you name are changed.  Every entry is checked before any is written.  List, slider, item set, page collection and video list attributes are refused - edit those in the page editor.  Always needs sfvb_publish, because a page's attributes are shared by every theme and there is no dormant copy to change instead. 
     # @param storefront_oid [Integer]