ultracart_rest_api_v2_typescript 4.1.156 → 4.1.158

package/.openapi-generator/FILES

@@ -1032,6 +1032,10 @@ src/models/SfvbPreviewSessionResponse.ts
 src/models/SfvbPreviewUrlResponse.ts
 src/models/SfvbRenderRequest.ts
 src/models/SfvbRenderResponse.ts
+src/models/SfvbSiteAttribute.ts
+src/models/SfvbSiteAttributeUpdate.ts
+src/models/SfvbSiteAttributeUpdateRequest.ts
+src/models/SfvbSiteAttributesResponse.ts
 src/models/SfvbStorefront.ts
 src/models/SfvbStorefrontsResponse.ts
 src/models/SfvbTheme.ts

package/README.md

@@ -1,12 +1,12 @@
 # UltraCart Typescript SDK
-## ultracart_rest_api_v2_typescript@4.1.156
+## ultracart_rest_api_v2_typescript@4.1.158
 
 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.156 --save
+npm install ultracart_rest_api_v2_typescript@4.1.158 --save
 ```
 
 ```typescript
@@ -85,6 +85,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.158 | 09/18/2026 | sfvb internal testing |
+| 4.1.157 | 09/18/2026 | sfvb internal testing |
 | 4.1.156 | 09/16/2026 | sfvb internal testing |
 | 4.1.155 | 09/15/2026 | sfvb internal testing |
 | 4.1.154 | 09/14/2026 | sfvb internal testing |

package/dist/apis/SfvbApi.d.ts

@@ -10,7 +10,7 @@
  * 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, 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';
+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, SfvbSiteAttributeUpdateRequest, SfvbSiteAttributesResponse, SfvbStorefrontsResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbUpsellOffersResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
 export interface CompileSfvbCjsonRequest {
     compileRequest: SfvbCompileRequest;
 }
@@ -93,6 +93,9 @@ export interface GetSfvbPreviewUrlRequest {
     previewSessionId: string;
     path?: string;
 }
+export interface GetSfvbSiteAttributesRequest {
+    storefrontOid: number;
+}
 export interface GetSfvbThemeRequest {
     storefrontOid: number;
     themeOid: number;
@@ -168,6 +171,10 @@ export interface PutSfvbPreviewSessionRequest {
     previewSession: SfvbPreviewSessionRequest;
     themeOid?: number;
 }
+export interface PutSfvbSiteAttributesRequest {
+    storefrontOid: number;
+    siteAttributeUpdateRequest: SfvbSiteAttributeUpdateRequest;
+}
 export interface PutSfvbThemeAttributesRequest {
     storefrontOid: number;
     themeOid: number;
@@ -362,7 +369,7 @@ export interface SfvbApiInterface {
      */
     getSfvbCjsonUsedElements(requestParameters: GetSfvbCjsonUsedElementsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbElementsResponse>;
     /**
-     * owner_type is one of upsell, email, postcardfront, postcardback or item.  Item containers also require container_name.  Theme and page containers are files; read those through files/content.
+     * owner_type is one of upsell, email, postcardfront, postcardback, item or itemid.  It also says how owner_object_id is read - item and upsell take an oid, itemid takes a merchant item id, and the rest take an esp uuid.  itemid reaches the same containers as item and is the way to address one from a storefront, where data-context-item-id carries the merchant item id and the oid appears nowhere.  Item containers also require container_name.  Theme and page containers are files; read those through files/content.
      * @summary Read a container stored outside the file system
      * @param {number} storefrontOid
      * @param {string} ownerType
@@ -374,12 +381,12 @@ export interface SfvbApiInterface {
      */
     getSfvbContainerRaw(requestParameters: GetSfvbContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbContainerResponse>>;
     /**
-     * owner_type is one of upsell, email, postcardfront, postcardback or item.  Item containers also require container_name.  Theme and page containers are files; read those through files/content.
+     * owner_type is one of upsell, email, postcardfront, postcardback, item or itemid.  It also says how owner_object_id is read - item and upsell take an oid, itemid takes a merchant item id, and the rest take an esp uuid.  itemid reaches the same containers as item and is the way to address one from a storefront, where data-context-item-id carries the merchant item id and the oid appears nowhere.  Item containers also require container_name.  Theme and page containers are files; read those through files/content.
      * Read a container stored outside the file system
      */
     getSfvbContainer(requestParameters: GetSfvbContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbContainerResponse>;
     /**
-     * Inspect or diff an earlier version without reverting to it.  The version is addressed through the container that owns it, so a history oid belonging to some other resource cannot be read through this route.
+     * Inspect or diff an earlier version without reverting to it.  The version is addressed through the container that owns it, so a history oid belonging to some other resource cannot be read through this route.  owner_type also says how owner_object_id is read, and itemid addresses an item container by merchant item id.
      * @summary Read the CJSON stored in one container history entry
      * @param {number} storefrontOid
      * @param {number} containerHistoryOid
@@ -392,7 +399,7 @@ export interface SfvbApiInterface {
      */
     getSfvbContainerVersionRaw(requestParameters: GetSfvbContainerVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbContainerVersion>>;
     /**
-     * Inspect or diff an earlier version without reverting to it.  The version is addressed through the container that owns it, so a history oid belonging to some other resource cannot be read through this route.
+     * Inspect or diff an earlier version without reverting to it.  The version is addressed through the container that owns it, so a history oid belonging to some other resource cannot be read through this route.  owner_type also says how owner_object_id is read, and itemid addresses an item container by merchant item id.
      * Read the CJSON stored in one container history entry
      */
     getSfvbContainerVersion(requestParameters: GetSfvbContainerVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbContainerVersion>;
@@ -516,6 +523,20 @@ export interface SfvbApiInterface {
      * URL that renders a preview session
      */
     getSfvbPreviewUrl(requestParameters: GetSfvbPreviewUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewUrlResponse>;
+    /**
+     * The values the siteattribute element and $site.attr render.  These are not in any file or theme.  Attributes a template declares but nothing has set are included with the template\'s default, so the response describes what the templates can render rather than only what has been saved.  Credentials stored as site attributes are never included.
+     * @summary Read a storefront\'s site attributes
+     * @param {number} storefrontOid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SfvbApiInterface
+     */
+    getSfvbSiteAttributesRaw(requestParameters: GetSfvbSiteAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSiteAttributesResponse>>;
+    /**
+     * The values the siteattribute element and $site.attr render.  These are not in any file or theme.  Attributes a template declares but nothing has set are included with the template\'s default, so the response describes what the templates can render rather than only what has been saved.  Credentials stored as site attributes are never included.
+     * Read a storefront\'s site attributes
+     */
+    getSfvbSiteAttributes(requestParameters: GetSfvbSiteAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSiteAttributesResponse>;
     /**
      *
      * @summary Get a theme
@@ -602,7 +623,7 @@ export interface SfvbApiInterface {
      */
     installSfvbLibraryEntry(requestParameters: InstallSfvbLibraryEntryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbLibraryEntry>;
     /**
-     *
+     * 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.
      * @summary Version history for a container stored outside the file system
      * @param {number} storefrontOid
      * @param {string} [ownerType]
@@ -614,6 +635,7 @@ export interface SfvbApiInterface {
      */
     listSfvbContainerVersionsRaw(requestParameters: ListSfvbContainerVersionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbContainerVersionsResponse>>;
     /**
+     * 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.
      * Version history for a container stored outside the file system
      */
     listSfvbContainerVersions(requestParameters: ListSfvbContainerVersionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbContainerVersionsResponse>;
@@ -704,7 +726,7 @@ export interface SfvbApiInterface {
      */
     listSfvbUpsellOffers(requestParameters: ListSfvbUpsellOffersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbUpsellOffersResponse>;
     /**
-     * Validation is mandatory and runs here regardless of whether the caller validated first.  The previous value is snapshotted before the write, so the change can be reverted.  Side effects the visual builder performs on save, such as upsell screenshot regeneration and email content review flagging, are applied too.
+     * Validation is mandatory and runs here regardless of whether the caller validated first.  The previous value is snapshotted before the write, so the change can be reverted.  Side effects the visual builder performs on save, such as upsell screenshot regeneration and email content review flagging, are applied too.  owner_type also says how owner_object_id is read; send itemid to address an item container by merchant item id rather than by oid.  Either way the history records the one canonical address, so a container written under one spelling is listed and reverted under the other.
      * @summary Write a container stored outside the file system
      * @param {number} storefrontOid
      * @param {string} ownerType
@@ -718,7 +740,7 @@ export interface SfvbApiInterface {
      */
     putSfvbContainerRaw(requestParameters: PutSfvbContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbContainerResponse>>;
     /**
-     * Validation is mandatory and runs here regardless of whether the caller validated first.  The previous value is snapshotted before the write, so the change can be reverted.  Side effects the visual builder performs on save, such as upsell screenshot regeneration and email content review flagging, are applied too.
+     * Validation is mandatory and runs here regardless of whether the caller validated first.  The previous value is snapshotted before the write, so the change can be reverted.  Side effects the visual builder performs on save, such as upsell screenshot regeneration and email content review flagging, are applied too.  owner_type also says how owner_object_id is read; send itemid to address an item container by merchant item id rather than by oid.  Either way the history records the one canonical address, so a container written under one spelling is listed and reverted under the other.
      * Write a container stored outside the file system
      */
     putSfvbContainer(requestParameters: PutSfvbContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbContainerResponse>;
@@ -805,6 +827,21 @@ export interface SfvbApiInterface {
      * Push containers into a preview session
      */
     putSfvbPreviewSession(requestParameters: PutSfvbPreviewSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewSessionResponse>;
+    /**
+     * A partial update.  Only the attributes you name are changed.  Every entry is checked before any is written.  List, video list, mailing list and item set attributes are refused, and so are the General screen settings other than the title, the SEO description and keywords and the social account names.  Credentials are refused.  Always needs sfvb_publish, because every theme reads the same attributes and there is no dormant copy to change instead.  The admin General screen saves the whole storefront, so a merchant with it open can still overwrite a change made here.
+     * @summary Change a storefront\'s site attributes
+     * @param {number} storefrontOid
+     * @param {SfvbSiteAttributeUpdateRequest} siteAttributeUpdateRequest Attributes to change
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SfvbApiInterface
+     */
+    putSfvbSiteAttributesRaw(requestParameters: PutSfvbSiteAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSiteAttributesResponse>>;
+    /**
+     * A partial update.  Only the attributes you name are changed.  Every entry is checked before any is written.  List, video list, mailing list and item set attributes are refused, and so are the General screen settings other than the title, the SEO description and keywords and the social account names.  Credentials are refused.  Always needs sfvb_publish, because every theme reads the same attributes and there is no dormant copy to change instead.  The admin General screen saves the whole storefront, so a merchant with it open can still overwrite a change made here.
+     * Change a storefront\'s site attributes
+     */
+    putSfvbSiteAttributes(requestParameters: PutSfvbSiteAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSiteAttributesResponse>;
     /**
      * A partial update.  Only the slots you name are changed and every other slot on the theme keeps its value, so there is no need to send the whole set back to change one color.  Send a whole palette in one call rather than one call per color - they are applied together, so the storefront never renders half of a change.  Needs sfvb_publish when the theme is the one serving live traffic, because a color is referenced by name from every template that uses it and one write repaints the whole storefront at once.  On a dormant theme sfvb_write is enough, which is what makes duplicate-then-restyle work.
      * @summary Change a theme\'s colors, fonts and settings
@@ -853,7 +890,7 @@ export interface SfvbApiInterface {
      */
     reserveSfvbWidgetIds(requestParameters: ReserveSfvbWidgetIdsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbWidgetIdsResponse>;
     /**
-     * The restore is itself snapshotted, so a revert can be undone in turn.  Reverting to an entry recorded before the container existed removes it again.  Addressed through the owning container and guarded by If-Match, because a revert overwrites live content just as much as an ordinary write does.
+     * The restore is itself snapshotted, so a revert can be undone in turn.  Reverting to an entry recorded before the container existed removes it again.  Addressed through the owning container and guarded by If-Match, because a revert overwrites live content just as much as an ordinary write does.  owner_type also says how owner_object_id is read, so a version written by oid can be reverted by merchant item id and the other way round.
      * @summary Revert a container stored outside the file system
      * @param {number} storefrontOid
      * @param {string} ownerType
@@ -867,7 +904,7 @@ export interface SfvbApiInterface {
      */
     revertSfvbContainerRaw(requestParameters: RevertSfvbContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbContainerResponse>>;
     /**
-     * The restore is itself snapshotted, so a revert can be undone in turn.  Reverting to an entry recorded before the container existed removes it again.  Addressed through the owning container and guarded by If-Match, because a revert overwrites live content just as much as an ordinary write does.
+     * The restore is itself snapshotted, so a revert can be undone in turn.  Reverting to an entry recorded before the container existed removes it again.  Addressed through the owning container and guarded by If-Match, because a revert overwrites live content just as much as an ordinary write does.  owner_type also says how owner_object_id is read, so a version written by oid can be reverted by merchant item id and the other way round.
      * Revert a container stored outside the file system
      */
     revertSfvbContainer(requestParameters: RevertSfvbContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbContainerResponse>;
@@ -1060,22 +1097,22 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
      */
     getSfvbCjsonUsedElements(requestParameters: GetSfvbCjsonUsedElementsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbElementsResponse>;
     /**
-     * owner_type is one of upsell, email, postcardfront, postcardback or item.  Item containers also require container_name.  Theme and page containers are files; read those through files/content.
+     * owner_type is one of upsell, email, postcardfront, postcardback, item or itemid.  It also says how owner_object_id is read - item and upsell take an oid, itemid takes a merchant item id, and the rest take an esp uuid.  itemid reaches the same containers as item and is the way to address one from a storefront, where data-context-item-id carries the merchant item id and the oid appears nowhere.  Item containers also require container_name.  Theme and page containers are files; read those through files/content.
      * Read a container stored outside the file system
      */
     getSfvbContainerRaw(requestParameters: GetSfvbContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbContainerResponse>>;
     /**
-     * owner_type is one of upsell, email, postcardfront, postcardback or item.  Item containers also require container_name.  Theme and page containers are files; read those through files/content.
+     * owner_type is one of upsell, email, postcardfront, postcardback, item or itemid.  It also says how owner_object_id is read - item and upsell take an oid, itemid takes a merchant item id, and the rest take an esp uuid.  itemid reaches the same containers as item and is the way to address one from a storefront, where data-context-item-id carries the merchant item id and the oid appears nowhere.  Item containers also require container_name.  Theme and page containers are files; read those through files/content.
      * Read a container stored outside the file system
      */
     getSfvbContainer(requestParameters: GetSfvbContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbContainerResponse>;
     /**
-     * Inspect or diff an earlier version without reverting to it.  The version is addressed through the container that owns it, so a history oid belonging to some other resource cannot be read through this route.
+     * Inspect or diff an earlier version without reverting to it.  The version is addressed through the container that owns it, so a history oid belonging to some other resource cannot be read through this route.  owner_type also says how owner_object_id is read, and itemid addresses an item container by merchant item id.
      * Read the CJSON stored in one container history entry
      */
     getSfvbContainerVersionRaw(requestParameters: GetSfvbContainerVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbContainerVersion>>;
     /**
-     * Inspect or diff an earlier version without reverting to it.  The version is addressed through the container that owns it, so a history oid belonging to some other resource cannot be read through this route.
+     * Inspect or diff an earlier version without reverting to it.  The version is addressed through the container that owns it, so a history oid belonging to some other resource cannot be read through this route.  owner_type also says how owner_object_id is read, and itemid addresses an item container by merchant item id.
      * Read the CJSON stored in one container history entry
      */
     getSfvbContainerVersion(requestParameters: GetSfvbContainerVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbContainerVersion>;
@@ -1159,6 +1196,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
      * URL that renders a preview session
      */
     getSfvbPreviewUrl(requestParameters: GetSfvbPreviewUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewUrlResponse>;
+    /**
+     * The values the siteattribute element and $site.attr render.  These are not in any file or theme.  Attributes a template declares but nothing has set are included with the template\'s default, so the response describes what the templates can render rather than only what has been saved.  Credentials stored as site attributes are never included.
+     * Read a storefront\'s site attributes
+     */
+    getSfvbSiteAttributesRaw(requestParameters: GetSfvbSiteAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSiteAttributesResponse>>;
+    /**
+     * The values the siteattribute element and $site.attr render.  These are not in any file or theme.  Attributes a template declares but nothing has set are included with the template\'s default, so the response describes what the templates can render rather than only what has been saved.  Credentials stored as site attributes are never included.
+     * Read a storefront\'s site attributes
+     */
+    getSfvbSiteAttributes(requestParameters: GetSfvbSiteAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSiteAttributesResponse>;
     /**
      * Get a theme
      */
@@ -1218,10 +1265,12 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
      */
     installSfvbLibraryEntry(requestParameters: InstallSfvbLibraryEntryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbLibraryEntry>;
     /**
+     * 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.
      * Version history for a container stored outside the file system
      */
     listSfvbContainerVersionsRaw(requestParameters: ListSfvbContainerVersionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbContainerVersionsResponse>>;
     /**
+     * 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.
      * Version history for a container stored outside the file system
      */
     listSfvbContainerVersions(requestParameters: ListSfvbContainerVersionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbContainerVersionsResponse>;
@@ -1284,12 +1333,12 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
      */
     listSfvbUpsellOffers(requestParameters: ListSfvbUpsellOffersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbUpsellOffersResponse>;
     /**
-     * Validation is mandatory and runs here regardless of whether the caller validated first.  The previous value is snapshotted before the write, so the change can be reverted.  Side effects the visual builder performs on save, such as upsell screenshot regeneration and email content review flagging, are applied too.
+     * Validation is mandatory and runs here regardless of whether the caller validated first.  The previous value is snapshotted before the write, so the change can be reverted.  Side effects the visual builder performs on save, such as upsell screenshot regeneration and email content review flagging, are applied too.  owner_type also says how owner_object_id is read; send itemid to address an item container by merchant item id rather than by oid.  Either way the history records the one canonical address, so a container written under one spelling is listed and reverted under the other.
      * Write a container stored outside the file system
      */
     putSfvbContainerRaw(requestParameters: PutSfvbContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbContainerResponse>>;
     /**
-     * Validation is mandatory and runs here regardless of whether the caller validated first.  The previous value is snapshotted before the write, so the change can be reverted.  Side effects the visual builder performs on save, such as upsell screenshot regeneration and email content review flagging, are applied too.
+     * Validation is mandatory and runs here regardless of whether the caller validated first.  The previous value is snapshotted before the write, so the change can be reverted.  Side effects the visual builder performs on save, such as upsell screenshot regeneration and email content review flagging, are applied too.  owner_type also says how owner_object_id is read; send itemid to address an item container by merchant item id rather than by oid.  Either way the history records the one canonical address, so a container written under one spelling is listed and reverted under the other.
      * Write a container stored outside the file system
      */
     putSfvbContainer(requestParameters: PutSfvbContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbContainerResponse>;
@@ -1343,6 +1392,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
      * Push containers into a preview session
      */
     putSfvbPreviewSession(requestParameters: PutSfvbPreviewSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewSessionResponse>;
+    /**
+     * A partial update.  Only the attributes you name are changed.  Every entry is checked before any is written.  List, video list, mailing list and item set attributes are refused, and so are the General screen settings other than the title, the SEO description and keywords and the social account names.  Credentials are refused.  Always needs sfvb_publish, because every theme reads the same attributes and there is no dormant copy to change instead.  The admin General screen saves the whole storefront, so a merchant with it open can still overwrite a change made here.
+     * Change a storefront\'s site attributes
+     */
+    putSfvbSiteAttributesRaw(requestParameters: PutSfvbSiteAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSiteAttributesResponse>>;
+    /**
+     * A partial update.  Only the attributes you name are changed.  Every entry is checked before any is written.  List, video list, mailing list and item set attributes are refused, and so are the General screen settings other than the title, the SEO description and keywords and the social account names.  Credentials are refused.  Always needs sfvb_publish, because every theme reads the same attributes and there is no dormant copy to change instead.  The admin General screen saves the whole storefront, so a merchant with it open can still overwrite a change made here.
+     * Change a storefront\'s site attributes
+     */
+    putSfvbSiteAttributes(requestParameters: PutSfvbSiteAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSiteAttributesResponse>;
     /**
      * A partial update.  Only the slots you name are changed and every other slot on the theme keeps its value, so there is no need to send the whole set back to change one color.  Send a whole palette in one call rather than one call per color - they are applied together, so the storefront never renders half of a change.  Needs sfvb_publish when the theme is the one serving live traffic, because a color is referenced by name from every template that uses it and one write repaints the whole storefront at once.  On a dormant theme sfvb_write is enough, which is what makes duplicate-then-restyle work.
      * Change a theme\'s colors, fonts and settings
@@ -1374,12 +1433,12 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
      */
     reserveSfvbWidgetIds(requestParameters: ReserveSfvbWidgetIdsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbWidgetIdsResponse>;
     /**
-     * The restore is itself snapshotted, so a revert can be undone in turn.  Reverting to an entry recorded before the container existed removes it again.  Addressed through the owning container and guarded by If-Match, because a revert overwrites live content just as much as an ordinary write does.
+     * The restore is itself snapshotted, so a revert can be undone in turn.  Reverting to an entry recorded before the container existed removes it again.  Addressed through the owning container and guarded by If-Match, because a revert overwrites live content just as much as an ordinary write does.  owner_type also says how owner_object_id is read, so a version written by oid can be reverted by merchant item id and the other way round.
      * Revert a container stored outside the file system
      */
     revertSfvbContainerRaw(requestParameters: RevertSfvbContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbContainerResponse>>;
     /**
-     * The restore is itself snapshotted, so a revert can be undone in turn.  Reverting to an entry recorded before the container existed removes it again.  Addressed through the owning container and guarded by If-Match, because a revert overwrites live content just as much as an ordinary write does.
+     * The restore is itself snapshotted, so a revert can be undone in turn.  Reverting to an entry recorded before the container existed removes it again.  Addressed through the owning container and guarded by If-Match, because a revert overwrites live content just as much as an ordinary write does.  owner_type also says how owner_object_id is read, so a version written by oid can be reverted by merchant item id and the other way round.
      * Revert a container stored outside the file system
      */
     revertSfvbContainer(requestParameters: RevertSfvbContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbContainerResponse>;

package/dist/apis/SfvbApi.js

@@ -640,7 +640,7 @@ var SfvbApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * owner_type is one of upsell, email, postcardfront, postcardback or item.  Item containers also require container_name.  Theme and page containers are files; read those through files/content.
+     * owner_type is one of upsell, email, postcardfront, postcardback, item or itemid.  It also says how owner_object_id is read - item and upsell take an oid, itemid takes a merchant item id, and the rest take an esp uuid.  itemid reaches the same containers as item and is the way to address one from a storefront, where data-context-item-id carries the merchant item id and the oid appears nowhere.  Item containers also require container_name.  Theme and page containers are files; read those through files/content.
      * Read a container stored outside the file system
      */
     SfvbApi.prototype.getSfvbContainerRaw = function (requestParameters, initOverrides) {
@@ -690,7 +690,7 @@ var SfvbApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * owner_type is one of upsell, email, postcardfront, postcardback or item.  Item containers also require container_name.  Theme and page containers are files; read those through files/content.
+     * owner_type is one of upsell, email, postcardfront, postcardback, item or itemid.  It also says how owner_object_id is read - item and upsell take an oid, itemid takes a merchant item id, and the rest take an esp uuid.  itemid reaches the same containers as item and is the way to address one from a storefront, where data-context-item-id carries the merchant item id and the oid appears nowhere.  Item containers also require container_name.  Theme and page containers are files; read those through files/content.
      * Read a container stored outside the file system
      */
     SfvbApi.prototype.getSfvbContainer = function (requestParameters, initOverrides) {
@@ -708,7 +708,7 @@ var SfvbApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * Inspect or diff an earlier version without reverting to it.  The version is addressed through the container that owns it, so a history oid belonging to some other resource cannot be read through this route.
+     * Inspect or diff an earlier version without reverting to it.  The version is addressed through the container that owns it, so a history oid belonging to some other resource cannot be read through this route.  owner_type also says how owner_object_id is read, and itemid addresses an item container by merchant item id.
      * Read the CJSON stored in one container history entry
      */
     SfvbApi.prototype.getSfvbContainerVersionRaw = function (requestParameters, initOverrides) {
@@ -761,7 +761,7 @@ var SfvbApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * Inspect or diff an earlier version without reverting to it.  The version is addressed through the container that owns it, so a history oid belonging to some other resource cannot be read through this route.
+     * Inspect or diff an earlier version without reverting to it.  The version is addressed through the container that owns it, so a history oid belonging to some other resource cannot be read through this route.  owner_type also says how owner_object_id is read, and itemid addresses an item container by merchant item id.
      * Read the CJSON stored in one container history entry
      */
     SfvbApi.prototype.getSfvbContainerVersion = function (requestParameters, initOverrides) {
@@ -1277,6 +1277,65 @@ var SfvbApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * The values the siteattribute element and $site.attr render.  These are not in any file or theme.  Attributes a template declares but nothing has set are included with the template\'s default, so the response describes what the templates can render rather than only what has been saved.  Credentials stored as site attributes are never included.
+     * Read a storefront\'s site attributes
+     */
+    SfvbApi.prototype.getSfvbSiteAttributesRaw = 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 getSfvbSiteAttributes.');
+                        }
+                        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}/attributes".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.SfvbSiteAttributesResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * The values the siteattribute element and $site.attr render.  These are not in any file or theme.  Attributes a template declares but nothing has set are included with the template\'s default, so the response describes what the templates can render rather than only what has been saved.  Credentials stored as site attributes are never included.
+     * Read a storefront\'s site attributes
+     */
+    SfvbApi.prototype.getSfvbSiteAttributes = 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.getSfvbSiteAttributesRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * Get a theme
      */
@@ -1636,6 +1695,7 @@ var SfvbApi = /** @class */ (function (_super) {
         });
     };
     /**
+     * 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.
      * Version history for a container stored outside the file system
      */
     SfvbApi.prototype.listSfvbContainerVersionsRaw = function (requestParameters, initOverrides) {
@@ -1685,6 +1745,7 @@ var SfvbApi = /** @class */ (function (_super) {
         });
     };
     /**
+     * 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.
      * Version history for a container stored outside the file system
      */
     SfvbApi.prototype.listSfvbContainerVersions = function (requestParameters, initOverrides) {
@@ -2063,7 +2124,7 @@ var SfvbApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * Validation is mandatory and runs here regardless of whether the caller validated first.  The previous value is snapshotted before the write, so the change can be reverted.  Side effects the visual builder performs on save, such as upsell screenshot regeneration and email content review flagging, are applied too.
+     * Validation is mandatory and runs here regardless of whether the caller validated first.  The previous value is snapshotted before the write, so the change can be reverted.  Side effects the visual builder performs on save, such as upsell screenshot regeneration and email content review flagging, are applied too.  owner_type also says how owner_object_id is read; send itemid to address an item container by merchant item id rather than by oid.  Either way the history records the one canonical address, so a container written under one spelling is listed and reverted under the other.
      * Write a container stored outside the file system
      */
     SfvbApi.prototype.putSfvbContainerRaw = function (requestParameters, initOverrides) {
@@ -2124,7 +2185,7 @@ var SfvbApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * Validation is mandatory and runs here regardless of whether the caller validated first.  The previous value is snapshotted before the write, so the change can be reverted.  Side effects the visual builder performs on save, such as upsell screenshot regeneration and email content review flagging, are applied too.
+     * Validation is mandatory and runs here regardless of whether the caller validated first.  The previous value is snapshotted before the write, so the change can be reverted.  Side effects the visual builder performs on save, such as upsell screenshot regeneration and email content review flagging, are applied too.  owner_type also says how owner_object_id is read; send itemid to address an item container by merchant item id rather than by oid.  Either way the history records the one canonical address, so a container written under one spelling is listed and reverted under the other.
      * Write a container stored outside the file system
      */
     SfvbApi.prototype.putSfvbContainer = function (requestParameters, initOverrides) {
@@ -2494,6 +2555,70 @@ var SfvbApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * A partial update.  Only the attributes you name are changed.  Every entry is checked before any is written.  List, video list, mailing list and item set attributes are refused, and so are the General screen settings other than the title, the SEO description and keywords and the social account names.  Credentials are refused.  Always needs sfvb_publish, because every theme reads the same attributes and there is no dormant copy to change instead.  The admin General screen saves the whole storefront, so a merchant with it open can still overwrite a change made here.
+     * Change a storefront\'s site attributes
+     */
+    SfvbApi.prototype.putSfvbSiteAttributesRaw = 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 putSfvbSiteAttributes.');
+                        }
+                        if (requestParameters.siteAttributeUpdateRequest === null || requestParameters.siteAttributeUpdateRequest === undefined) {
+                            throw new runtime.RequiredError('siteAttributeUpdateRequest', 'Required parameter requestParameters.siteAttributeUpdateRequest was null or undefined when calling putSfvbSiteAttributes.');
+                        }
+                        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}/attributes".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))),
+                                method: 'PUT',
+                                headers: headerParameters,
+                                query: queryParameters,
+                                body: (0, models_1.SfvbSiteAttributeUpdateRequestToJSON)(requestParameters.siteAttributeUpdateRequest),
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.SfvbSiteAttributesResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * A partial update.  Only the attributes you name are changed.  Every entry is checked before any is written.  List, video list, mailing list and item set attributes are refused, and so are the General screen settings other than the title, the SEO description and keywords and the social account names.  Credentials are refused.  Always needs sfvb_publish, because every theme reads the same attributes and there is no dormant copy to change instead.  The admin General screen saves the whole storefront, so a merchant with it open can still overwrite a change made here.
+     * Change a storefront\'s site attributes
+     */
+    SfvbApi.prototype.putSfvbSiteAttributes = 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.putSfvbSiteAttributesRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * A partial update.  Only the slots you name are changed and every other slot on the theme keeps its value, so there is no need to send the whole set back to change one color.  Send a whole palette in one call rather than one call per color - they are applied together, so the storefront never renders half of a change.  Needs sfvb_publish when the theme is the one serving live traffic, because a color is referenced by name from every template that uses it and one write repaints the whole storefront at once.  On a dormant theme sfvb_write is enough, which is what makes duplicate-then-restyle work.
      * Change a theme\'s colors, fonts and settings
@@ -2691,7 +2816,7 @@ var SfvbApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * The restore is itself snapshotted, so a revert can be undone in turn.  Reverting to an entry recorded before the container existed removes it again.  Addressed through the owning container and guarded by If-Match, because a revert overwrites live content just as much as an ordinary write does.
+     * The restore is itself snapshotted, so a revert can be undone in turn.  Reverting to an entry recorded before the container existed removes it again.  Addressed through the owning container and guarded by If-Match, because a revert overwrites live content just as much as an ordinary write does.  owner_type also says how owner_object_id is read, so a version written by oid can be reverted by merchant item id and the other way round.
      * Revert a container stored outside the file system
      */
     SfvbApi.prototype.revertSfvbContainerRaw = function (requestParameters, initOverrides) {
@@ -2752,7 +2877,7 @@ var SfvbApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * The restore is itself snapshotted, so a revert can be undone in turn.  Reverting to an entry recorded before the container existed removes it again.  Addressed through the owning container and guarded by If-Match, because a revert overwrites live content just as much as an ordinary write does.
+     * The restore is itself snapshotted, so a revert can be undone in turn.  Reverting to an entry recorded before the container existed removes it again.  Addressed through the owning container and guarded by If-Match, because a revert overwrites live content just as much as an ordinary write does.  owner_type also says how owner_object_id is read, so a version written by oid can be reverted by merchant item id and the other way round.
      * Revert a container stored outside the file system
      */
     SfvbApi.prototype.revertSfvbContainer = function (requestParameters, initOverrides) {

package/dist/models/SfvbContainerResponse.d.ts

@@ -39,6 +39,12 @@ export interface SfvbContainerResponse {
      * @memberof SfvbContainerResponse
      */
     last_modified?: string;
+    /**
+     * The merchant item id of the owning item, for item containers only and absent for every other owner type.  owner_object_id is the item oid, which appears nowhere on a rendered storefront, so this is how a caller confirms which item an oid actually reached.  It is read fresh on every call and so reflects a renamed item.  A container's own id embeds this value, which is what a preview session keys an item container on.
+     * @type {string}
+     * @memberof SfvbContainerResponse
+     */
+    merchant_item_id?: string;
     /**
      * Identifier of the owning object within its store.
      * @type {string}

package/dist/models/SfvbContainerResponse.js

@@ -47,6 +47,7 @@ function SfvbContainerResponseFromJSONTyped(json, ignoreDiscriminator) {
         'container_name': !(0, runtime_1.exists)(json, 'container_name') ? undefined : json['container_name'],
         'hash_sha256': !(0, runtime_1.exists)(json, 'hash_sha256') ? undefined : json['hash_sha256'],
         'last_modified': !(0, runtime_1.exists)(json, 'last_modified') ? undefined : json['last_modified'],
+        'merchant_item_id': !(0, runtime_1.exists)(json, 'merchant_item_id') ? undefined : json['merchant_item_id'],
         'owner_object_id': !(0, runtime_1.exists)(json, 'owner_object_id') ? undefined : json['owner_object_id'],
         'owner_type': !(0, runtime_1.exists)(json, 'owner_type') ? undefined : json['owner_type'],
     };
@@ -64,6 +65,7 @@ function SfvbContainerResponseToJSON(value) {
         'container_name': value.container_name,
         'hash_sha256': value.hash_sha256,
         'last_modified': value.last_modified,
+        'merchant_item_id': value.merchant_item_id,
         'owner_object_id': value.owner_object_id,
         'owner_type': value.owner_type,
     };