ultracart_rest_api_v2_typescript 4.1.154 → 4.1.156

package/.openapi-generator/FILES

@@ -1015,12 +1015,18 @@ src/models/SfvbFilesResponse.ts
 src/models/SfvbLibraryEntry.ts
 src/models/SfvbLibraryFacet.ts
 src/models/SfvbLibraryResponse.ts
+src/models/SfvbMenu.ts
+src/models/SfvbMenuItem.ts
+src/models/SfvbMenuWriteRequest.ts
+src/models/SfvbMenusResponse.ts
 src/models/SfvbPageAttribute.ts
 src/models/SfvbPageAttributeUpdate.ts
 src/models/SfvbPageAttributeUpdateRequest.ts
 src/models/SfvbPageMultimedia.ts
 src/models/SfvbPageMultimediaRequest.ts
 src/models/SfvbPageResponse.ts
+src/models/SfvbPreviewAccessRequest.ts
+src/models/SfvbPreviewAccessResponse.ts
 src/models/SfvbPreviewSessionRequest.ts
 src/models/SfvbPreviewSessionResponse.ts
 src/models/SfvbPreviewUrlResponse.ts

package/README.md

@@ -1,12 +1,12 @@
 # UltraCart Typescript SDK
-## ultracart_rest_api_v2_typescript@4.1.154
+## ultracart_rest_api_v2_typescript@4.1.156
 
 Every API method call has a sample for every language SDK.  See https://github.com/UltraCart/sdk_samples
 
 Installation
 
 ```
-npm install ultracart_rest_api_v2_typescript@4.1.154 --save
+npm install ultracart_rest_api_v2_typescript@4.1.156 --save
 ```
 
 ```typescript
@@ -85,6 +85,8 @@ 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 |
 | 4.1.152 | 09/09/2026 | sfvb - internal testing |

package/dist/apis/SfvbApi.d.ts

@@ -10,10 +10,14 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import { SfvbCompileRequest, SfvbCompileResponse, SfvbContainerResponse, SfvbContainerRevertRequest, SfvbContainerVersion, SfvbContainerVersionsResponse, SfvbContainerWriteRequest, SfvbElementSchemaResponse, SfvbElementsResponse, SfvbFileContentResponse, SfvbFileRevertRequest, SfvbFileSearchRequest, SfvbFileSearchResponse, SfvbFileUploadRequest, SfvbFileUploadUrlResponse, SfvbFileVersionsResponse, SfvbFileWriteRequest, SfvbFileWriteResponse, SfvbFilesResponse, SfvbLibraryEntry, SfvbLibraryResponse, SfvbPageAttributeUpdateRequest, SfvbPageMultimediaRequest, SfvbPageResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewUrlResponse, SfvbRenderRequest, SfvbRenderResponse, SfvbStorefrontsResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbUpsellOffersResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
+import { SfvbCompileRequest, SfvbCompileResponse, SfvbContainerResponse, SfvbContainerRevertRequest, SfvbContainerVersion, SfvbContainerVersionsResponse, SfvbContainerWriteRequest, SfvbElementSchemaResponse, SfvbElementsResponse, SfvbFileContentResponse, SfvbFileRevertRequest, SfvbFileSearchRequest, SfvbFileSearchResponse, SfvbFileUploadRequest, SfvbFileUploadUrlResponse, SfvbFileVersionsResponse, SfvbFileWriteRequest, SfvbFileWriteResponse, SfvbFilesResponse, SfvbLibraryEntry, SfvbLibraryResponse, SfvbMenu, SfvbMenuWriteRequest, SfvbMenusResponse, SfvbPageAttributeUpdateRequest, SfvbPageMultimediaRequest, SfvbPageResponse, SfvbPreviewAccessRequest, SfvbPreviewAccessResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewUrlResponse, SfvbRenderRequest, SfvbRenderResponse, SfvbStorefrontsResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbUpsellOffersResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
 export interface CompileSfvbCjsonRequest {
     compileRequest: SfvbCompileRequest;
 }
+export interface CreateSfvbPreviewAccessRequest {
+    storefrontOid: number;
+    previewAccess?: SfvbPreviewAccessRequest;
+}
 export interface CreateSfvbPreviewSessionRequest {
     storefrontOid: number;
 }
@@ -73,6 +77,13 @@ export interface GetSfvbLibraryEntryRequest {
     storefrontOid: number;
     libraryOid: number;
 }
+export interface GetSfvbMenuRequest {
+    storefrontOid: number;
+    code: string;
+}
+export interface GetSfvbMenusRequest {
+    storefrontOid: number;
+}
 export interface GetSfvbPageRequest {
     storefrontOid: number;
     path: string;
@@ -135,6 +146,12 @@ export interface PutSfvbFileContentRequest {
     fileWriteRequest: SfvbFileWriteRequest;
     path?: string;
 }
+export interface PutSfvbMenuRequest {
+    storefrontOid: number;
+    code: string;
+    menuWriteRequest: SfvbMenuWriteRequest;
+    ifMatch?: string;
+}
 export interface PutSfvbPageAttributesRequest {
     storefrontOid: number;
     path: string;
@@ -223,6 +240,21 @@ export interface SfvbApiInterface {
      * Compile CJSON to Velocity
      */
     compileSfvbCjson(requestParameters: CompileSfvbCjsonRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCompileResponse>;
+    /**
+     * The preview URL only works in a browser already signed in to UltraCart on the storefront\'s own host, and an agent\'s built in browser never is.  This returns a single use access_url on the storefront host instead.  Opening it gets past the storefront lock, shows the requested theme and applies the requested preview session for the rest of that browser session, then redirects to path.  It expires two minutes after issue or on first use.  Pages opened afterwards carry an X-UltraCart-Preview header of applied or not-applied.  Requires a token that resolves to a user, so use the device authorization flow.
+     * @summary One time link that opens a preview in a browser with no UltraCart login
+     * @param {number} storefrontOid
+     * @param {SfvbPreviewAccessRequest} [previewAccess] What the browser should see
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SfvbApiInterface
+     */
+    createSfvbPreviewAccessRaw(requestParameters: CreateSfvbPreviewAccessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbPreviewAccessResponse>>;
+    /**
+     * The preview URL only works in a browser already signed in to UltraCart on the storefront\'s own host, and an agent\'s built in browser never is.  This returns a single use access_url on the storefront host instead.  Opening it gets past the storefront lock, shows the requested theme and applies the requested preview session for the rest of that browser session, then redirects to path.  It expires two minutes after issue or on first use.  Pages opened afterwards carry an X-UltraCart-Preview header of applied or not-applied.  Requires a token that resolves to a user, so use the device authorization flow.
+     * One time link that opens a preview in a browser with no UltraCart login
+     */
+    createSfvbPreviewAccess(requestParameters: CreateSfvbPreviewAccessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewAccessResponse>;
     /**
      * Returns a server generated session id to push containers into, and opens the session so that id exists rather than merely being random.  The id is not caller supplied, because concurrent agents choosing their own would be free to collide, and the browser editor\'s habit of minting one with Math.random is not a property worth carrying into an API.  Expires after eight hours and can be deleted sooner.  Requires a token that resolves to a user, so use the device authorization flow.
      * @summary Create a preview session
@@ -424,6 +456,35 @@ export interface SfvbApiInterface {
      * Read one library entry including its CJSON
      */
     getSfvbLibraryEntry(requestParameters: GetSfvbLibraryEntryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbLibraryEntry>;
+    /**
+     * 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.
+     * @summary Read one store menu and its entries
+     * @param {number} storefrontOid
+     * @param {string} code Menu code, matched without regard to case
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SfvbApiInterface
+     */
+    getSfvbMenuRaw(requestParameters: GetSfvbMenuRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbMenu>>;
+    /**
+     * 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.
+     * Read one store menu and its entries
+     */
+    getSfvbMenu(requestParameters: GetSfvbMenuRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbMenu>;
+    /**
+     * 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.
+     * @summary List a storefront\'s store menus
+     * @param {number} storefrontOid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SfvbApiInterface
+     */
+    getSfvbMenusRaw(requestParameters: GetSfvbMenusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbMenusResponse>>;
+    /**
+     * 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.
+     * List a storefront\'s store menus
+     */
+    getSfvbMenus(requestParameters: GetSfvbMenusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbMenusResponse>;
     /**
      * 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.
      * @summary Read a page\'s attributes and images
@@ -678,6 +739,23 @@ export interface SfvbApiInterface {
      * Write a storefront file
      */
     putSfvbFileContent(requestParameters: PutSfvbFileContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFileWriteResponse>;
+    /**
+     * 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.
+     * @summary Replace a store menu\'s entries
+     * @param {number} storefrontOid
+     * @param {string} code Menu code, matched without regard to case
+     * @param {SfvbMenuWriteRequest} menuWriteRequest The menu\&#39;s replacement contents
+     * @param {string} [ifMatch] Content hash from the last read.  Required when the menu already exists; 428 when absent, 412 when stale.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SfvbApiInterface
+     */
+    putSfvbMenuRaw(requestParameters: PutSfvbMenuRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbMenu>>;
+    /**
+     * 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.
+     * Replace a store menu\'s entries
+     */
+    putSfvbMenu(requestParameters: PutSfvbMenuRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbMenu>;
     /**
      * 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.
      * @summary Change a page\'s attributes
@@ -903,6 +981,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
      * Compile CJSON to Velocity
      */
     compileSfvbCjson(requestParameters: CompileSfvbCjsonRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCompileResponse>;
+    /**
+     * The preview URL only works in a browser already signed in to UltraCart on the storefront\'s own host, and an agent\'s built in browser never is.  This returns a single use access_url on the storefront host instead.  Opening it gets past the storefront lock, shows the requested theme and applies the requested preview session for the rest of that browser session, then redirects to path.  It expires two minutes after issue or on first use.  Pages opened afterwards carry an X-UltraCart-Preview header of applied or not-applied.  Requires a token that resolves to a user, so use the device authorization flow.
+     * One time link that opens a preview in a browser with no UltraCart login
+     */
+    createSfvbPreviewAccessRaw(requestParameters: CreateSfvbPreviewAccessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbPreviewAccessResponse>>;
+    /**
+     * The preview URL only works in a browser already signed in to UltraCart on the storefront\'s own host, and an agent\'s built in browser never is.  This returns a single use access_url on the storefront host instead.  Opening it gets past the storefront lock, shows the requested theme and applies the requested preview session for the rest of that browser session, then redirects to path.  It expires two minutes after issue or on first use.  Pages opened afterwards carry an X-UltraCart-Preview header of applied or not-applied.  Requires a token that resolves to a user, so use the device authorization flow.
+     * One time link that opens a preview in a browser with no UltraCart login
+     */
+    createSfvbPreviewAccess(requestParameters: CreateSfvbPreviewAccessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewAccessResponse>;
     /**
      * Returns a server generated session id to push containers into, and opens the session so that id exists rather than merely being random.  The id is not caller supplied, because concurrent agents choosing their own would be free to collide, and the browser editor\'s habit of minting one with Math.random is not a property worth carrying into an API.  Expires after eight hours and can be deleted sooner.  Requires a token that resolves to a user, so use the device authorization flow.
      * Create a preview session
@@ -1031,6 +1119,26 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
      * Read one library entry including its CJSON
      */
     getSfvbLibraryEntry(requestParameters: GetSfvbLibraryEntryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbLibraryEntry>;
+    /**
+     * 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.
+     * Read one store menu and its entries
+     */
+    getSfvbMenuRaw(requestParameters: GetSfvbMenuRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbMenu>>;
+    /**
+     * 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.
+     * Read one store menu and its entries
+     */
+    getSfvbMenu(requestParameters: GetSfvbMenuRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbMenu>;
+    /**
+     * 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.
+     * List a storefront\'s store menus
+     */
+    getSfvbMenusRaw(requestParameters: GetSfvbMenusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbMenusResponse>>;
+    /**
+     * 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.
+     * List a storefront\'s store menus
+     */
+    getSfvbMenus(requestParameters: GetSfvbMenusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbMenusResponse>;
     /**
      * 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.
      * Read a page\'s attributes and images
@@ -1195,6 +1303,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
      * Write a storefront file
      */
     putSfvbFileContent(requestParameters: PutSfvbFileContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFileWriteResponse>;
+    /**
+     * 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.
+     * Replace a store menu\'s entries
+     */
+    putSfvbMenuRaw(requestParameters: PutSfvbMenuRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbMenu>>;
+    /**
+     * 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.
+     * Replace a store menu\'s entries
+     */
+    putSfvbMenu(requestParameters: PutSfvbMenuRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbMenu>;
     /**
      * 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.
      * Change a page\'s attributes

package/dist/apis/SfvbApi.js

@@ -136,6 +136,67 @@ var SfvbApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * The preview URL only works in a browser already signed in to UltraCart on the storefront\'s own host, and an agent\'s built in browser never is.  This returns a single use access_url on the storefront host instead.  Opening it gets past the storefront lock, shows the requested theme and applies the requested preview session for the rest of that browser session, then redirects to path.  It expires two minutes after issue or on first use.  Pages opened afterwards carry an X-UltraCart-Preview header of applied or not-applied.  Requires a token that resolves to a user, so use the device authorization flow.
+     * One time link that opens a preview in a browser with no UltraCart login
+     */
+    SfvbApi.prototype.createSfvbPreviewAccessRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, _a, _b, response;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
+                            throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling createSfvbPreviewAccess.');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        headerParameters['Content-Type'] = 'application/json';
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        // oauth required
+                        _a = headerParameters;
+                        _b = "Authorization";
+                        return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
+                    case 1:
+                        // oauth required
+                        _a[_b] = _c.sent();
+                        _c.label = 2;
+                    case 2:
+                        if (this.configuration && this.configuration.apiKey) {
+                            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+                        }
+                        return [4 /*yield*/, this.request({
+                                path: "/sfvb/storefronts/{storefront_oid}/preview_access".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))),
+                                method: 'POST',
+                                headers: headerParameters,
+                                query: queryParameters,
+                                body: (0, models_1.SfvbPreviewAccessRequestToJSON)(requestParameters.previewAccess),
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.SfvbPreviewAccessResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * The preview URL only works in a browser already signed in to UltraCart on the storefront\'s own host, and an agent\'s built in browser never is.  This returns a single use access_url on the storefront host instead.  Opening it gets past the storefront lock, shows the requested theme and applies the requested preview session for the rest of that browser session, then redirects to path.  It expires two minutes after issue or on first use.  Pages opened afterwards carry an X-UltraCart-Preview header of applied or not-applied.  Requires a token that resolves to a user, so use the device authorization flow.
+     * One time link that opens a preview in a browser with no UltraCart login
+     */
+    SfvbApi.prototype.createSfvbPreviewAccess = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.createSfvbPreviewAccessRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * Returns a server generated session id to push containers into, and opens the session so that id exists rather than merely being random.  The id is not caller supplied, because concurrent agents choosing their own would be free to collide, and the browser editor\'s habit of minting one with Math.random is not a property worth carrying into an API.  Expires after eight hours and can be deleted sooner.  Requires a token that resolves to a user, so use the device authorization flow.
      * Create a preview session
@@ -965,6 +1026,127 @@ var SfvbApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * 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.
+     * Read one store menu and its entries
+     */
+    SfvbApi.prototype.getSfvbMenuRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, _a, _b, response;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
+                            throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling getSfvbMenu.');
+                        }
+                        if (requestParameters.code === null || requestParameters.code === undefined) {
+                            throw new runtime.RequiredError('code', 'Required parameter requestParameters.code was null or undefined when calling getSfvbMenu.');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        // oauth required
+                        _a = headerParameters;
+                        _b = "Authorization";
+                        return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
+                    case 1:
+                        // oauth required
+                        _a[_b] = _c.sent();
+                        _c.label = 2;
+                    case 2:
+                        if (this.configuration && this.configuration.apiKey) {
+                            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+                        }
+                        return [4 /*yield*/, this.request({
+                                path: "/sfvb/storefronts/{storefront_oid}/menus/{code}".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))).replace("{".concat("code", "}"), encodeURIComponent(String(requestParameters.code))),
+                                method: 'GET',
+                                headers: headerParameters,
+                                query: queryParameters,
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.SfvbMenuFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * 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.
+     * Read one store menu and its entries
+     */
+    SfvbApi.prototype.getSfvbMenu = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.getSfvbMenuRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    /**
+     * 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.
+     * List a storefront\'s store menus
+     */
+    SfvbApi.prototype.getSfvbMenusRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, _a, _b, response;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
+                            throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling getSfvbMenus.');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        // oauth required
+                        _a = headerParameters;
+                        _b = "Authorization";
+                        return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
+                    case 1:
+                        // oauth required
+                        _a[_b] = _c.sent();
+                        _c.label = 2;
+                    case 2:
+                        if (this.configuration && this.configuration.apiKey) {
+                            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+                        }
+                        return [4 /*yield*/, this.request({
+                                path: "/sfvb/storefronts/{storefront_oid}/menus".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))),
+                                method: 'GET',
+                                headers: headerParameters,
+                                query: queryParameters,
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.SfvbMenusResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * 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.
+     * List a storefront\'s store menus
+     */
+    SfvbApi.prototype.getSfvbMenus = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.getSfvbMenusRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * 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.
      * Read a page\'s attributes and images
@@ -2032,6 +2214,76 @@ var SfvbApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * 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.
+     * Replace a store menu\'s entries
+     */
+    SfvbApi.prototype.putSfvbMenuRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, _a, _b, response;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
+                            throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling putSfvbMenu.');
+                        }
+                        if (requestParameters.code === null || requestParameters.code === undefined) {
+                            throw new runtime.RequiredError('code', 'Required parameter requestParameters.code was null or undefined when calling putSfvbMenu.');
+                        }
+                        if (requestParameters.menuWriteRequest === null || requestParameters.menuWriteRequest === undefined) {
+                            throw new runtime.RequiredError('menuWriteRequest', 'Required parameter requestParameters.menuWriteRequest was null or undefined when calling putSfvbMenu.');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        headerParameters['Content-Type'] = 'application/json';
+                        if (requestParameters.ifMatch !== undefined && requestParameters.ifMatch !== null) {
+                            headerParameters['If-Match'] = String(requestParameters.ifMatch);
+                        }
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        // oauth required
+                        _a = headerParameters;
+                        _b = "Authorization";
+                        return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
+                    case 1:
+                        // oauth required
+                        _a[_b] = _c.sent();
+                        _c.label = 2;
+                    case 2:
+                        if (this.configuration && this.configuration.apiKey) {
+                            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+                        }
+                        return [4 /*yield*/, this.request({
+                                path: "/sfvb/storefronts/{storefront_oid}/menus/{code}".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))).replace("{".concat("code", "}"), encodeURIComponent(String(requestParameters.code))),
+                                method: 'PUT',
+                                headers: headerParameters,
+                                query: queryParameters,
+                                body: (0, models_1.SfvbMenuWriteRequestToJSON)(requestParameters.menuWriteRequest),
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.SfvbMenuFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * 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.
+     * Replace a store menu\'s entries
+     */
+    SfvbApi.prototype.putSfvbMenu = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.putSfvbMenuRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * 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.
      * Change a page\'s attributes

package/dist/models/SfvbMenu.d.ts

@@ -0,0 +1,68 @@
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { SfvbMenuItem } from './SfvbMenuItem';
+/**
+ *
+ * @export
+ * @interface SfvbMenu
+ */
+export interface SfvbMenu {
+    /**
+     * The menu's code, which is the value a menu element's menuName refers to.  Compare case insensitively.
+     * @type {string}
+     * @memberof SfvbMenu
+     */
+    code?: string;
+    /**
+     * Content hash of the menu as stored.  Send it back as If-Match when writing.
+     * @type {string}
+     * @memberof SfvbMenu
+     */
+    hash_sha256?: string;
+    /**
+     * How many entries the menu holds in total, counting every level of the tree.
+     * @type {number}
+     * @memberof SfvbMenu
+     */
+    item_count?: number;
+    /**
+     * The menu's entries, in the order they render.  Omitted from the list endpoint, which returns each menu's identity and counts only.
+     * @type {Array<SfvbMenuItem>}
+     * @memberof SfvbMenu
+     */
+    items?: Array<SfvbMenuItem>;
+    /**
+     * The menu's own label, shown in the store admin rather than on the storefront.  Trimmed to 250 characters.
+     * @type {string}
+     * @memberof SfvbMenu
+     */
+    title?: string;
+    /**
+     * 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.
+     * @type {boolean}
+     * @memberof SfvbMenu
+     */
+    unconfigured?: 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.
+     * @type {boolean}
+     * @memberof SfvbMenu
+     */
+    undeclared?: boolean;
+}
+/**
+ * Check if a given object implements the SfvbMenu interface.
+ */
+export declare function instanceOfSfvbMenu(value: object): boolean;
+export declare function SfvbMenuFromJSON(json: any): SfvbMenu;
+export declare function SfvbMenuFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbMenu;
+export declare function SfvbMenuToJSON(value?: SfvbMenu | null): any;

package/dist/models/SfvbMenu.js

@@ -0,0 +1,63 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SfvbMenuToJSON = exports.SfvbMenuFromJSONTyped = exports.SfvbMenuFromJSON = exports.instanceOfSfvbMenu = void 0;
+var runtime_1 = require("../runtime");
+var SfvbMenuItem_1 = require("./SfvbMenuItem");
+/**
+ * Check if a given object implements the SfvbMenu interface.
+ */
+function instanceOfSfvbMenu(value) {
+    var isInstance = true;
+    return isInstance;
+}
+exports.instanceOfSfvbMenu = instanceOfSfvbMenu;
+function SfvbMenuFromJSON(json) {
+    return SfvbMenuFromJSONTyped(json, false);
+}
+exports.SfvbMenuFromJSON = SfvbMenuFromJSON;
+function SfvbMenuFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'code': !(0, runtime_1.exists)(json, 'code') ? undefined : json['code'],
+        'hash_sha256': !(0, runtime_1.exists)(json, 'hash_sha256') ? undefined : json['hash_sha256'],
+        'item_count': !(0, runtime_1.exists)(json, 'item_count') ? undefined : json['item_count'],
+        'items': !(0, runtime_1.exists)(json, 'items') ? undefined : (json['items'].map(SfvbMenuItem_1.SfvbMenuItemFromJSON)),
+        'title': !(0, runtime_1.exists)(json, 'title') ? undefined : json['title'],
+        'unconfigured': !(0, runtime_1.exists)(json, 'unconfigured') ? undefined : json['unconfigured'],
+        'undeclared': !(0, runtime_1.exists)(json, 'undeclared') ? undefined : json['undeclared'],
+    };
+}
+exports.SfvbMenuFromJSONTyped = SfvbMenuFromJSONTyped;
+function SfvbMenuToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'code': value.code,
+        'hash_sha256': value.hash_sha256,
+        'item_count': value.item_count,
+        'items': value.items === undefined ? undefined : (value.items.map(SfvbMenuItem_1.SfvbMenuItemToJSON)),
+        'title': value.title,
+        'unconfigured': value.unconfigured,
+        'undeclared': value.undeclared,
+    };
+}
+exports.SfvbMenuToJSON = SfvbMenuToJSON;