ultracart_rest_api_v2_typescript 4.1.155 → 4.1.157

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1015,6 +1015,10 @@ src/models/SfvbFilesResponse.ts
1015
1015
  src/models/SfvbLibraryEntry.ts
1016
1016
  src/models/SfvbLibraryFacet.ts
1017
1017
  src/models/SfvbLibraryResponse.ts
1018
+ src/models/SfvbMenu.ts
1019
+ src/models/SfvbMenuItem.ts
1020
+ src/models/SfvbMenuWriteRequest.ts
1021
+ src/models/SfvbMenusResponse.ts
1018
1022
  src/models/SfvbPageAttribute.ts
1019
1023
  src/models/SfvbPageAttributeUpdate.ts
1020
1024
  src/models/SfvbPageAttributeUpdateRequest.ts
package/README.md CHANGED
@@ -1,12 +1,12 @@
1
1
  # UltraCart Typescript SDK
2
- ## ultracart_rest_api_v2_typescript@4.1.155
2
+ ## ultracart_rest_api_v2_typescript@4.1.157
3
3
 
4
4
  Every API method call has a sample for every language SDK. See https://github.com/UltraCart/sdk_samples
5
5
 
6
6
  Installation
7
7
 
8
8
  ```
9
- npm install ultracart_rest_api_v2_typescript@4.1.155 --save
9
+ npm install ultracart_rest_api_v2_typescript@4.1.157 --save
10
10
  ```
11
11
 
12
12
  ```typescript
@@ -85,6 +85,8 @@ Not every change is committed to every SDK.
85
85
 
86
86
  | Version | Date | Comments |
87
87
  | --: | :-: | --- |
88
+ | 4.1.157 | 09/18/2026 | sfvb internal testing |
89
+ | 4.1.156 | 09/16/2026 | sfvb internal testing |
88
90
  | 4.1.155 | 09/15/2026 | sfvb internal testing |
89
91
  | 4.1.154 | 09/14/2026 | sfvb internal testing |
90
92
  | 4.1.153 | 09/14/2026 | sfvb internal testing |
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- 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, SfvbPreviewAccessRequest, SfvbPreviewAccessResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewUrlResponse, SfvbRenderRequest, SfvbRenderResponse, SfvbStorefrontsResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbUpsellOffersResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
13
+ 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';
14
14
  export interface CompileSfvbCjsonRequest {
15
15
  compileRequest: SfvbCompileRequest;
16
16
  }
@@ -77,6 +77,13 @@ export interface GetSfvbLibraryEntryRequest {
77
77
  storefrontOid: number;
78
78
  libraryOid: number;
79
79
  }
80
+ export interface GetSfvbMenuRequest {
81
+ storefrontOid: number;
82
+ code: string;
83
+ }
84
+ export interface GetSfvbMenusRequest {
85
+ storefrontOid: number;
86
+ }
80
87
  export interface GetSfvbPageRequest {
81
88
  storefrontOid: number;
82
89
  path: string;
@@ -139,6 +146,12 @@ export interface PutSfvbFileContentRequest {
139
146
  fileWriteRequest: SfvbFileWriteRequest;
140
147
  path?: string;
141
148
  }
149
+ export interface PutSfvbMenuRequest {
150
+ storefrontOid: number;
151
+ code: string;
152
+ menuWriteRequest: SfvbMenuWriteRequest;
153
+ ifMatch?: string;
154
+ }
142
155
  export interface PutSfvbPageAttributesRequest {
143
156
  storefrontOid: number;
144
157
  path: string;
@@ -349,7 +362,7 @@ export interface SfvbApiInterface {
349
362
  */
350
363
  getSfvbCjsonUsedElements(requestParameters: GetSfvbCjsonUsedElementsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbElementsResponse>;
351
364
  /**
352
- * 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.
365
+ * 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.
353
366
  * @summary Read a container stored outside the file system
354
367
  * @param {number} storefrontOid
355
368
  * @param {string} ownerType
@@ -361,12 +374,12 @@ export interface SfvbApiInterface {
361
374
  */
362
375
  getSfvbContainerRaw(requestParameters: GetSfvbContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbContainerResponse>>;
363
376
  /**
364
- * 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.
377
+ * 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.
365
378
  * Read a container stored outside the file system
366
379
  */
367
380
  getSfvbContainer(requestParameters: GetSfvbContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbContainerResponse>;
368
381
  /**
369
- * 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.
382
+ * 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.
370
383
  * @summary Read the CJSON stored in one container history entry
371
384
  * @param {number} storefrontOid
372
385
  * @param {number} containerHistoryOid
@@ -379,7 +392,7 @@ export interface SfvbApiInterface {
379
392
  */
380
393
  getSfvbContainerVersionRaw(requestParameters: GetSfvbContainerVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbContainerVersion>>;
381
394
  /**
382
- * 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.
395
+ * 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.
383
396
  * Read the CJSON stored in one container history entry
384
397
  */
385
398
  getSfvbContainerVersion(requestParameters: GetSfvbContainerVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbContainerVersion>;
@@ -443,6 +456,35 @@ export interface SfvbApiInterface {
443
456
  * Read one library entry including its CJSON
444
457
  */
445
458
  getSfvbLibraryEntry(requestParameters: GetSfvbLibraryEntryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbLibraryEntry>;
459
+ /**
460
+ * 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.
461
+ * @summary Read one store menu and its entries
462
+ * @param {number} storefrontOid
463
+ * @param {string} code Menu code, matched without regard to case
464
+ * @param {*} [options] Override http request option.
465
+ * @throws {RequiredError}
466
+ * @memberof SfvbApiInterface
467
+ */
468
+ getSfvbMenuRaw(requestParameters: GetSfvbMenuRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbMenu>>;
469
+ /**
470
+ * 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.
471
+ * Read one store menu and its entries
472
+ */
473
+ getSfvbMenu(requestParameters: GetSfvbMenuRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbMenu>;
474
+ /**
475
+ * 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.
476
+ * @summary List a storefront\'s store menus
477
+ * @param {number} storefrontOid
478
+ * @param {*} [options] Override http request option.
479
+ * @throws {RequiredError}
480
+ * @memberof SfvbApiInterface
481
+ */
482
+ getSfvbMenusRaw(requestParameters: GetSfvbMenusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbMenusResponse>>;
483
+ /**
484
+ * 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.
485
+ * List a storefront\'s store menus
486
+ */
487
+ getSfvbMenus(requestParameters: GetSfvbMenusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbMenusResponse>;
446
488
  /**
447
489
  * 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.
448
490
  * @summary Read a page\'s attributes and images
@@ -560,7 +602,7 @@ export interface SfvbApiInterface {
560
602
  */
561
603
  installSfvbLibraryEntry(requestParameters: InstallSfvbLibraryEntryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbLibraryEntry>;
562
604
  /**
563
- *
605
+ * 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.
564
606
  * @summary Version history for a container stored outside the file system
565
607
  * @param {number} storefrontOid
566
608
  * @param {string} [ownerType]
@@ -572,6 +614,7 @@ export interface SfvbApiInterface {
572
614
  */
573
615
  listSfvbContainerVersionsRaw(requestParameters: ListSfvbContainerVersionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbContainerVersionsResponse>>;
574
616
  /**
617
+ * 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.
575
618
  * Version history for a container stored outside the file system
576
619
  */
577
620
  listSfvbContainerVersions(requestParameters: ListSfvbContainerVersionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbContainerVersionsResponse>;
@@ -662,7 +705,7 @@ export interface SfvbApiInterface {
662
705
  */
663
706
  listSfvbUpsellOffers(requestParameters: ListSfvbUpsellOffersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbUpsellOffersResponse>;
664
707
  /**
665
- * 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.
708
+ * 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.
666
709
  * @summary Write a container stored outside the file system
667
710
  * @param {number} storefrontOid
668
711
  * @param {string} ownerType
@@ -676,7 +719,7 @@ export interface SfvbApiInterface {
676
719
  */
677
720
  putSfvbContainerRaw(requestParameters: PutSfvbContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbContainerResponse>>;
678
721
  /**
679
- * 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.
722
+ * 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.
680
723
  * Write a container stored outside the file system
681
724
  */
682
725
  putSfvbContainer(requestParameters: PutSfvbContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbContainerResponse>;
@@ -697,6 +740,23 @@ export interface SfvbApiInterface {
697
740
  * Write a storefront file
698
741
  */
699
742
  putSfvbFileContent(requestParameters: PutSfvbFileContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFileWriteResponse>;
743
+ /**
744
+ * 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.
745
+ * @summary Replace a store menu\'s entries
746
+ * @param {number} storefrontOid
747
+ * @param {string} code Menu code, matched without regard to case
748
+ * @param {SfvbMenuWriteRequest} menuWriteRequest The menu\&#39;s replacement contents
749
+ * @param {string} [ifMatch] Content hash from the last read. Required when the menu already exists; 428 when absent, 412 when stale.
750
+ * @param {*} [options] Override http request option.
751
+ * @throws {RequiredError}
752
+ * @memberof SfvbApiInterface
753
+ */
754
+ putSfvbMenuRaw(requestParameters: PutSfvbMenuRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbMenu>>;
755
+ /**
756
+ * 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.
757
+ * Replace a store menu\'s entries
758
+ */
759
+ putSfvbMenu(requestParameters: PutSfvbMenuRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbMenu>;
700
760
  /**
701
761
  * 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.
702
762
  * @summary Change a page\'s attributes
@@ -794,7 +854,7 @@ export interface SfvbApiInterface {
794
854
  */
795
855
  reserveSfvbWidgetIds(requestParameters: ReserveSfvbWidgetIdsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbWidgetIdsResponse>;
796
856
  /**
797
- * 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.
857
+ * 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.
798
858
  * @summary Revert a container stored outside the file system
799
859
  * @param {number} storefrontOid
800
860
  * @param {string} ownerType
@@ -808,7 +868,7 @@ export interface SfvbApiInterface {
808
868
  */
809
869
  revertSfvbContainerRaw(requestParameters: RevertSfvbContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbContainerResponse>>;
810
870
  /**
811
- * 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.
871
+ * 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.
812
872
  * Revert a container stored outside the file system
813
873
  */
814
874
  revertSfvbContainer(requestParameters: RevertSfvbContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbContainerResponse>;
@@ -1001,22 +1061,22 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
1001
1061
  */
1002
1062
  getSfvbCjsonUsedElements(requestParameters: GetSfvbCjsonUsedElementsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbElementsResponse>;
1003
1063
  /**
1004
- * 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.
1064
+ * 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.
1005
1065
  * Read a container stored outside the file system
1006
1066
  */
1007
1067
  getSfvbContainerRaw(requestParameters: GetSfvbContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbContainerResponse>>;
1008
1068
  /**
1009
- * 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.
1069
+ * 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.
1010
1070
  * Read a container stored outside the file system
1011
1071
  */
1012
1072
  getSfvbContainer(requestParameters: GetSfvbContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbContainerResponse>;
1013
1073
  /**
1014
- * 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.
1074
+ * 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.
1015
1075
  * Read the CJSON stored in one container history entry
1016
1076
  */
1017
1077
  getSfvbContainerVersionRaw(requestParameters: GetSfvbContainerVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbContainerVersion>>;
1018
1078
  /**
1019
- * 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.
1079
+ * 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.
1020
1080
  * Read the CJSON stored in one container history entry
1021
1081
  */
1022
1082
  getSfvbContainerVersion(requestParameters: GetSfvbContainerVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbContainerVersion>;
@@ -1060,6 +1120,26 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
1060
1120
  * Read one library entry including its CJSON
1061
1121
  */
1062
1122
  getSfvbLibraryEntry(requestParameters: GetSfvbLibraryEntryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbLibraryEntry>;
1123
+ /**
1124
+ * 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.
1125
+ * Read one store menu and its entries
1126
+ */
1127
+ getSfvbMenuRaw(requestParameters: GetSfvbMenuRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbMenu>>;
1128
+ /**
1129
+ * 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.
1130
+ * Read one store menu and its entries
1131
+ */
1132
+ getSfvbMenu(requestParameters: GetSfvbMenuRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbMenu>;
1133
+ /**
1134
+ * 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.
1135
+ * List a storefront\'s store menus
1136
+ */
1137
+ getSfvbMenusRaw(requestParameters: GetSfvbMenusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbMenusResponse>>;
1138
+ /**
1139
+ * 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.
1140
+ * List a storefront\'s store menus
1141
+ */
1142
+ getSfvbMenus(requestParameters: GetSfvbMenusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbMenusResponse>;
1063
1143
  /**
1064
1144
  * 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.
1065
1145
  * Read a page\'s attributes and images
@@ -1139,10 +1219,12 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
1139
1219
  */
1140
1220
  installSfvbLibraryEntry(requestParameters: InstallSfvbLibraryEntryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbLibraryEntry>;
1141
1221
  /**
1222
+ * 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.
1142
1223
  * Version history for a container stored outside the file system
1143
1224
  */
1144
1225
  listSfvbContainerVersionsRaw(requestParameters: ListSfvbContainerVersionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbContainerVersionsResponse>>;
1145
1226
  /**
1227
+ * 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.
1146
1228
  * Version history for a container stored outside the file system
1147
1229
  */
1148
1230
  listSfvbContainerVersions(requestParameters: ListSfvbContainerVersionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbContainerVersionsResponse>;
@@ -1205,12 +1287,12 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
1205
1287
  */
1206
1288
  listSfvbUpsellOffers(requestParameters: ListSfvbUpsellOffersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbUpsellOffersResponse>;
1207
1289
  /**
1208
- * 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.
1290
+ * 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.
1209
1291
  * Write a container stored outside the file system
1210
1292
  */
1211
1293
  putSfvbContainerRaw(requestParameters: PutSfvbContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbContainerResponse>>;
1212
1294
  /**
1213
- * 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.
1295
+ * 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.
1214
1296
  * Write a container stored outside the file system
1215
1297
  */
1216
1298
  putSfvbContainer(requestParameters: PutSfvbContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbContainerResponse>;
@@ -1224,6 +1306,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
1224
1306
  * Write a storefront file
1225
1307
  */
1226
1308
  putSfvbFileContent(requestParameters: PutSfvbFileContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFileWriteResponse>;
1309
+ /**
1310
+ * 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.
1311
+ * Replace a store menu\'s entries
1312
+ */
1313
+ putSfvbMenuRaw(requestParameters: PutSfvbMenuRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbMenu>>;
1314
+ /**
1315
+ * 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.
1316
+ * Replace a store menu\'s entries
1317
+ */
1318
+ putSfvbMenu(requestParameters: PutSfvbMenuRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbMenu>;
1227
1319
  /**
1228
1320
  * 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.
1229
1321
  * Change a page\'s attributes
@@ -1285,12 +1377,12 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
1285
1377
  */
1286
1378
  reserveSfvbWidgetIds(requestParameters: ReserveSfvbWidgetIdsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbWidgetIdsResponse>;
1287
1379
  /**
1288
- * 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.
1380
+ * 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.
1289
1381
  * Revert a container stored outside the file system
1290
1382
  */
1291
1383
  revertSfvbContainerRaw(requestParameters: RevertSfvbContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbContainerResponse>>;
1292
1384
  /**
1293
- * 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.
1385
+ * 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.
1294
1386
  * Revert a container stored outside the file system
1295
1387
  */
1296
1388
  revertSfvbContainer(requestParameters: RevertSfvbContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbContainerResponse>;