ultracart_rest_api_v2_typescript 4.1.167 → 4.1.169

package/.openapi-generator/FILES

@@ -1026,6 +1026,8 @@ src/models/SfvbFileVersionsResponse.ts
 src/models/SfvbFileWriteRequest.ts
 src/models/SfvbFileWriteResponse.ts
 src/models/SfvbFilesResponse.ts
+src/models/SfvbItemContainer.ts
+src/models/SfvbItemContainersResponse.ts
 src/models/SfvbLibraryEntry.ts
 src/models/SfvbLibraryFacet.ts
 src/models/SfvbLibraryResponse.ts

package/README.md

@@ -1,12 +1,12 @@
 # UltraCart Typescript SDK
-## ultracart_rest_api_v2_typescript@4.1.167
+## ultracart_rest_api_v2_typescript@4.1.169
 
 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.167 --save
+npm install ultracart_rest_api_v2_typescript@4.1.169 --save
 ```
 
 ```typescript
@@ -84,6 +84,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.169 | 09/22/2026 | sfvb builder |
+| 4.1.168 | 09/21/2026 | further automation testing |
 | 4.1.167 | 09/21/2026 | automation test |
 | 4.1.165 | 09/21/2026 | automation testing |
 | 4.1.164 | 09/20/2026 | automation testing |

package/dist/apis/SfvbApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import { SfvbBlogPostsResponse, SfvbCompileRequest, SfvbCompileResponse, SfvbContainerResponse, SfvbContainerRevertRequest, SfvbContainerVersion, SfvbContainerVersionsResponse, SfvbContainerWriteRequest, SfvbElementSchemaResponse, SfvbElementsResponse, SfvbExperiment, SfvbExperimentEndRequest, SfvbExperimentObjectivesResponse, SfvbExperimentStartRequest, SfvbExperimentVariationUpdateRequest, SfvbExperimentsResponse, SfvbFileContentResponse, SfvbFileRevertRequest, SfvbFileSearchRequest, SfvbFileSearchResponse, SfvbFileUploadRequest, SfvbFileUploadUrlResponse, SfvbFileVersionsResponse, SfvbFileWriteRequest, SfvbFileWriteResponse, SfvbFilesResponse, SfvbLibraryEntry, SfvbLibraryResponse, SfvbMenu, SfvbMenuWriteRequest, SfvbMenusResponse, SfvbPageAttributeUpdateRequest, SfvbPageBlogPostsRequest, SfvbPageBlogPostsResponse, SfvbPageCreateRequest, SfvbPageDuplicateRequest, SfvbPageItemsAddRequest, SfvbPageItemsRemoveRequest, SfvbPageItemsResponse, SfvbPageListResponse, SfvbPageMultimediaRequest, SfvbPageResponse, SfvbPageSelectors, SfvbPageSettingsRequest, SfvbPreviewAccessRequest, SfvbPreviewAccessResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewUrlResponse, SfvbRenderRequest, SfvbRenderResponse, SfvbSiteAttributeUpdateRequest, SfvbSiteAttributesResponse, SfvbStorefrontsResponse, SfvbTemplatesResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbUpsellOffersResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
+import { SfvbBlogPostsResponse, SfvbCompileRequest, SfvbCompileResponse, SfvbContainerResponse, SfvbContainerRevertRequest, SfvbContainerVersion, SfvbContainerVersionsResponse, SfvbContainerWriteRequest, SfvbElementSchemaResponse, SfvbElementsResponse, SfvbExperiment, SfvbExperimentEndRequest, SfvbExperimentObjectivesResponse, SfvbExperimentStartRequest, SfvbExperimentVariationUpdateRequest, SfvbExperimentsResponse, SfvbFileContentResponse, SfvbFileRevertRequest, SfvbFileSearchRequest, SfvbFileSearchResponse, SfvbFileUploadRequest, SfvbFileUploadUrlResponse, SfvbFileVersionsResponse, SfvbFileWriteRequest, SfvbFileWriteResponse, SfvbFilesResponse, SfvbItemContainersResponse, SfvbLibraryEntry, SfvbLibraryResponse, SfvbMenu, SfvbMenuWriteRequest, SfvbMenusResponse, SfvbPageAttributeUpdateRequest, SfvbPageBlogPostsRequest, SfvbPageBlogPostsResponse, SfvbPageCreateRequest, SfvbPageDuplicateRequest, SfvbPageItemsAddRequest, SfvbPageItemsRemoveRequest, SfvbPageItemsResponse, SfvbPageListResponse, SfvbPageMultimediaRequest, SfvbPageResponse, SfvbPageSelectors, SfvbPageSettingsRequest, SfvbPreviewAccessRequest, SfvbPreviewAccessResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewUrlResponse, SfvbRenderRequest, SfvbRenderResponse, SfvbSiteAttributeUpdateRequest, SfvbSiteAttributesResponse, SfvbStorefrontsResponse, SfvbTemplatesResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbUpsellOffersResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
 export interface AddSfvbPageBlogPostsRequest {
     storefrontOid: number;
     path: string;
@@ -184,6 +184,14 @@ export interface ListSfvbFilesRequest {
     themeOid?: number;
     maxEntries?: number;
 }
+export interface ListSfvbItemContainersRequest {
+    storefrontOid: number;
+    merchantItemId?: string;
+    merchantItemOid?: number;
+    containerName?: string;
+    maxResults?: number;
+    offset?: number;
+}
 export interface ListSfvbPagesRequest {
     storefrontOid: number;
     under?: string;
@@ -965,6 +973,25 @@ export interface SfvbApiInterface {
      * List a storefront directory
      */
     listSfvbFiles(requestParameters: ListSfvbFilesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFilesResponse>;
+    /**
+     * An itemcontainer element renders nothing of its own.  It names a slot, and a separate container is resolved per item for that slot, so a catalog of five hundred products with three slots is fifteen hundred containers.  This says which of them exist.  Filter by container_name to find every item carrying one slot, or by merchant_item_id to see what one item has.  Which items are missing a slot is a set difference against pages/items, because a listing can only report containers that exist.  Each row carries hash_sha256, so a listing is enough to start an If-Match write without reading the container first.  Item containers are stored per account rather than per storefront, so storefront_oid identifies the caller\'s storefront but does not narrow the result.
+     * @summary List the item containers on the account
+     * @param {number} storefrontOid
+     * @param {string} [merchantItemId] Restrict to one item, by the merchant item id a storefront carries
+     * @param {number} [merchantItemOid] Restrict to one item, by oid.  Send this or merchant_item_id, not both
+     * @param {string} [containerName] Restrict to one slot name, matched without regard to case
+     * @param {number} [maxResults]
+     * @param {number} [offset]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SfvbApiInterface
+     */
+    listSfvbItemContainersRaw(requestParameters: ListSfvbItemContainersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbItemContainersResponse>>;
+    /**
+     * An itemcontainer element renders nothing of its own.  It names a slot, and a separate container is resolved per item for that slot, so a catalog of five hundred products with three slots is fifteen hundred containers.  This says which of them exist.  Filter by container_name to find every item carrying one slot, or by merchant_item_id to see what one item has.  Which items are missing a slot is a set difference against pages/items, because a listing can only report containers that exist.  Each row carries hash_sha256, so a listing is enough to start an If-Match write without reading the container first.  Item containers are stored per account rather than per storefront, so storefront_oid identifies the caller\'s storefront but does not narrow the result.
+     * List the item containers on the account
+     */
+    listSfvbItemContainers(requestParameters: ListSfvbItemContainersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbItemContainersResponse>;
     /**
      * Every page with its settings, sorted by path with the root first.  Hidden pages are included.  Pass under to list one page and everything below it.  Read from the same cached catalog the admin page tree uses, so a page created a moment ago can take a moment to appear here - read it directly with the single-page read to confirm a write.
      * @summary List the storefront\'s pages
@@ -1830,6 +1857,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
      * List a storefront directory
      */
     listSfvbFiles(requestParameters: ListSfvbFilesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFilesResponse>;
+    /**
+     * An itemcontainer element renders nothing of its own.  It names a slot, and a separate container is resolved per item for that slot, so a catalog of five hundred products with three slots is fifteen hundred containers.  This says which of them exist.  Filter by container_name to find every item carrying one slot, or by merchant_item_id to see what one item has.  Which items are missing a slot is a set difference against pages/items, because a listing can only report containers that exist.  Each row carries hash_sha256, so a listing is enough to start an If-Match write without reading the container first.  Item containers are stored per account rather than per storefront, so storefront_oid identifies the caller\'s storefront but does not narrow the result.
+     * List the item containers on the account
+     */
+    listSfvbItemContainersRaw(requestParameters: ListSfvbItemContainersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbItemContainersResponse>>;
+    /**
+     * An itemcontainer element renders nothing of its own.  It names a slot, and a separate container is resolved per item for that slot, so a catalog of five hundred products with three slots is fifteen hundred containers.  This says which of them exist.  Filter by container_name to find every item carrying one slot, or by merchant_item_id to see what one item has.  Which items are missing a slot is a set difference against pages/items, because a listing can only report containers that exist.  Each row carries hash_sha256, so a listing is enough to start an If-Match write without reading the container first.  Item containers are stored per account rather than per storefront, so storefront_oid identifies the caller\'s storefront but does not narrow the result.
+     * List the item containers on the account
+     */
+    listSfvbItemContainers(requestParameters: ListSfvbItemContainersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbItemContainersResponse>;
     /**
      * Every page with its settings, sorted by path with the root first.  Hidden pages are included.  Pass under to list one page and everything below it.  Read from the same cached catalog the admin page tree uses, so a page created a moment ago can take a moment to appear here - read it directly with the single-page read to confirm a write.
      * List the storefront\'s pages

package/dist/apis/SfvbApi.js

@@ -2738,6 +2738,80 @@ var SfvbApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * An itemcontainer element renders nothing of its own.  It names a slot, and a separate container is resolved per item for that slot, so a catalog of five hundred products with three slots is fifteen hundred containers.  This says which of them exist.  Filter by container_name to find every item carrying one slot, or by merchant_item_id to see what one item has.  Which items are missing a slot is a set difference against pages/items, because a listing can only report containers that exist.  Each row carries hash_sha256, so a listing is enough to start an If-Match write without reading the container first.  Item containers are stored per account rather than per storefront, so storefront_oid identifies the caller\'s storefront but does not narrow the result.
+     * List the item containers on the account
+     */
+    SfvbApi.prototype.listSfvbItemContainersRaw = 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 listSfvbItemContainers.');
+                        }
+                        queryParameters = {};
+                        if (requestParameters.merchantItemId !== undefined) {
+                            queryParameters['merchant_item_id'] = requestParameters.merchantItemId;
+                        }
+                        if (requestParameters.merchantItemOid !== undefined) {
+                            queryParameters['merchant_item_oid'] = requestParameters.merchantItemOid;
+                        }
+                        if (requestParameters.containerName !== undefined) {
+                            queryParameters['container_name'] = requestParameters.containerName;
+                        }
+                        if (requestParameters.maxResults !== undefined) {
+                            queryParameters['max_results'] = requestParameters.maxResults;
+                        }
+                        if (requestParameters.offset !== undefined) {
+                            queryParameters['offset'] = requestParameters.offset;
+                        }
+                        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}/item_containers".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.SfvbItemContainersResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * An itemcontainer element renders nothing of its own.  It names a slot, and a separate container is resolved per item for that slot, so a catalog of five hundred products with three slots is fifteen hundred containers.  This says which of them exist.  Filter by container_name to find every item carrying one slot, or by merchant_item_id to see what one item has.  Which items are missing a slot is a set difference against pages/items, because a listing can only report containers that exist.  Each row carries hash_sha256, so a listing is enough to start an If-Match write without reading the container first.  Item containers are stored per account rather than per storefront, so storefront_oid identifies the caller\'s storefront but does not narrow the result.
+     * List the item containers on the account
+     */
+    SfvbApi.prototype.listSfvbItemContainers = 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.listSfvbItemContainersRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * Every page with its settings, sorted by path with the root first.  Hidden pages are included.  Pass under to list one page and everything below it.  Read from the same cached catalog the admin page tree uses, so a page created a moment ago can take a moment to appear here - read it directly with the single-page read to confirm a write.
      * List the storefront\'s pages

package/dist/models/SfvbItemContainer.d.ts

@@ -0,0 +1,80 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface SfvbItemContainer
+ */
+export interface SfvbItemContainer {
+    /**
+     * Size of the CJSON in UTF-8 bytes, which is the same unit the container version size and the upsell offer cjson_size use.
+     * @type {number}
+     * @memberof SfvbItemContainer
+     */
+    cjson_size?: number;
+    /**
+     * The slot name.  This is the value an itemcontainer element's itemContainerName setting holds, which is what ties a container to the element that renders it.
+     * @type {string}
+     * @memberof SfvbItemContainer
+     */
+    container_name?: string;
+    /**
+     * SHA-256 of the container's CJSON.  Identical to the value a read of the container returns, so a listing is enough to start an If-Match write without reading first.
+     * @type {string}
+     * @memberof SfvbItemContainer
+     */
+    hash_sha256?: string;
+    /**
+     * When the container was last written.  Absent for a container untouched since the storage began recording the time, so read an absent value as unknown rather than as never modified.
+     * @type {string}
+     * @memberof SfvbItemContainer
+     */
+    last_modified?: string;
+    /**
+     * The owning item's merchant item id.  This is the identifier a storefront carries and a merchant recognizes; the oid appears nowhere on a rendered page.  Send it as owner_type itemid to address the same container without converting it first.
+     * @type {string}
+     * @memberof SfvbItemContainer
+     */
+    merchant_item_id?: string;
+    /**
+     * The merchant item oid, spelled the way containers/item/{owner_object_id} takes it.
+     * @type {string}
+     * @memberof SfvbItemContainer
+     */
+    owner_object_id?: string;
+    /**
+     * Always item.  Carried so a row is usable as an address without the caller having to know which listing it came from.
+     * @type {string}
+     * @memberof SfvbItemContainer
+     */
+    owner_type?: SfvbItemContainerOwnerTypeEnum;
+    /**
+     * The element types this container uses, recorded by the storage when it was written.  A large cjson_size beside a handful of element types is the signature of markup pasted into a single html element.  Absent on a container written before the storage began recording this.
+     * @type {Array<string>}
+     * @memberof SfvbItemContainer
+     */
+    used_elements?: Array<string>;
+}
+/**
+ * @export
+ */
+export declare const SfvbItemContainerOwnerTypeEnum: {
+    readonly Item: "item";
+};
+export type SfvbItemContainerOwnerTypeEnum = typeof SfvbItemContainerOwnerTypeEnum[keyof typeof SfvbItemContainerOwnerTypeEnum];
+/**
+ * Check if a given object implements the SfvbItemContainer interface.
+ */
+export declare function instanceOfSfvbItemContainer(value: object): boolean;
+export declare function SfvbItemContainerFromJSON(json: any): SfvbItemContainer;
+export declare function SfvbItemContainerFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbItemContainer;
+export declare function SfvbItemContainerToJSON(value?: SfvbItemContainer | null): any;

package/dist/models/SfvbItemContainer.js

@@ -0,0 +1,70 @@
+"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.SfvbItemContainerToJSON = exports.SfvbItemContainerFromJSONTyped = exports.SfvbItemContainerFromJSON = exports.instanceOfSfvbItemContainer = exports.SfvbItemContainerOwnerTypeEnum = void 0;
+var runtime_1 = require("../runtime");
+/**
+ * @export
+ */
+exports.SfvbItemContainerOwnerTypeEnum = {
+    Item: 'item'
+};
+/**
+ * Check if a given object implements the SfvbItemContainer interface.
+ */
+function instanceOfSfvbItemContainer(value) {
+    var isInstance = true;
+    return isInstance;
+}
+exports.instanceOfSfvbItemContainer = instanceOfSfvbItemContainer;
+function SfvbItemContainerFromJSON(json) {
+    return SfvbItemContainerFromJSONTyped(json, false);
+}
+exports.SfvbItemContainerFromJSON = SfvbItemContainerFromJSON;
+function SfvbItemContainerFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'cjson_size': !(0, runtime_1.exists)(json, 'cjson_size') ? undefined : json['cjson_size'],
+        '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'],
+        'used_elements': !(0, runtime_1.exists)(json, 'used_elements') ? undefined : json['used_elements'],
+    };
+}
+exports.SfvbItemContainerFromJSONTyped = SfvbItemContainerFromJSONTyped;
+function SfvbItemContainerToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'cjson_size': value.cjson_size,
+        '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,
+        'used_elements': value.used_elements,
+    };
+}
+exports.SfvbItemContainerToJSON = SfvbItemContainerToJSON;

package/dist/models/SfvbItemContainersResponse.d.ts

@@ -0,0 +1,74 @@
+/**
+ * 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 { SfvbItemContainer } from './SfvbItemContainer';
+/**
+ *
+ * @export
+ * @interface SfvbItemContainersResponse
+ */
+export interface SfvbItemContainersResponse {
+    /**
+     * The containers on this page, ordered by merchant item id then container name.
+     * @type {Array<SfvbItemContainer>}
+     * @memberof SfvbItemContainersResponse
+     */
+    item_containers?: Array<SfvbItemContainer>;
+    /**
+     * The cap that was applied.
+     * @type {number}
+     * @memberof SfvbItemContainersResponse
+     */
+    max_results?: number;
+    /**
+     * Offset to send for the next page.  Zero when truncated is false.  Never truncates without giving a way to continue.
+     * @type {number}
+     * @memberof SfvbItemContainersResponse
+     */
+    next_offset?: number;
+    /**
+     * Containers skipped to produce this page.
+     * @type {number}
+     * @memberof SfvbItemContainersResponse
+     */
+    offset?: number;
+    /**
+     * Number of containers returned on this page.
+     * @type {number}
+     * @memberof SfvbItemContainersResponse
+     */
+    result_count?: number;
+    /**
+     * Total containers matching the filter.  With container_name supplied this is the answer to how many items carry that slot.
+     * @type {number}
+     * @memberof SfvbItemContainersResponse
+     */
+    total_count?: number;
+    /**
+     * True when containers exist beyond this page.  next_offset is populated when it is.
+     * @type {boolean}
+     * @memberof SfvbItemContainersResponse
+     */
+    truncated?: boolean;
+    /**
+     * Advice for the caller when truncated is true.
+     * @type {string}
+     * @memberof SfvbItemContainersResponse
+     */
+    truncation_advice?: string;
+}
+/**
+ * Check if a given object implements the SfvbItemContainersResponse interface.
+ */
+export declare function instanceOfSfvbItemContainersResponse(value: object): boolean;
+export declare function SfvbItemContainersResponseFromJSON(json: any): SfvbItemContainersResponse;
+export declare function SfvbItemContainersResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbItemContainersResponse;
+export declare function SfvbItemContainersResponseToJSON(value?: SfvbItemContainersResponse | null): any;

package/dist/models/SfvbItemContainersResponse.js

@@ -0,0 +1,65 @@
+"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.SfvbItemContainersResponseToJSON = exports.SfvbItemContainersResponseFromJSONTyped = exports.SfvbItemContainersResponseFromJSON = exports.instanceOfSfvbItemContainersResponse = void 0;
+var runtime_1 = require("../runtime");
+var SfvbItemContainer_1 = require("./SfvbItemContainer");
+/**
+ * Check if a given object implements the SfvbItemContainersResponse interface.
+ */
+function instanceOfSfvbItemContainersResponse(value) {
+    var isInstance = true;
+    return isInstance;
+}
+exports.instanceOfSfvbItemContainersResponse = instanceOfSfvbItemContainersResponse;
+function SfvbItemContainersResponseFromJSON(json) {
+    return SfvbItemContainersResponseFromJSONTyped(json, false);
+}
+exports.SfvbItemContainersResponseFromJSON = SfvbItemContainersResponseFromJSON;
+function SfvbItemContainersResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'item_containers': !(0, runtime_1.exists)(json, 'item_containers') ? undefined : (json['item_containers'].map(SfvbItemContainer_1.SfvbItemContainerFromJSON)),
+        'max_results': !(0, runtime_1.exists)(json, 'max_results') ? undefined : json['max_results'],
+        'next_offset': !(0, runtime_1.exists)(json, 'next_offset') ? undefined : json['next_offset'],
+        'offset': !(0, runtime_1.exists)(json, 'offset') ? undefined : json['offset'],
+        'result_count': !(0, runtime_1.exists)(json, 'result_count') ? undefined : json['result_count'],
+        'total_count': !(0, runtime_1.exists)(json, 'total_count') ? undefined : json['total_count'],
+        'truncated': !(0, runtime_1.exists)(json, 'truncated') ? undefined : json['truncated'],
+        'truncation_advice': !(0, runtime_1.exists)(json, 'truncation_advice') ? undefined : json['truncation_advice'],
+    };
+}
+exports.SfvbItemContainersResponseFromJSONTyped = SfvbItemContainersResponseFromJSONTyped;
+function SfvbItemContainersResponseToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'item_containers': value.item_containers === undefined ? undefined : (value.item_containers.map(SfvbItemContainer_1.SfvbItemContainerToJSON)),
+        'max_results': value.max_results,
+        'next_offset': value.next_offset,
+        'offset': value.offset,
+        'result_count': value.result_count,
+        'total_count': value.total_count,
+        'truncated': value.truncated,
+        'truncation_advice': value.truncation_advice,
+    };
+}
+exports.SfvbItemContainersResponseToJSON = SfvbItemContainersResponseToJSON;

package/dist/models/index.d.ts

@@ -996,6 +996,8 @@ export * from './SfvbFileVersionsResponse';
 export * from './SfvbFileWriteRequest';
 export * from './SfvbFileWriteResponse';
 export * from './SfvbFilesResponse';
+export * from './SfvbItemContainer';
+export * from './SfvbItemContainersResponse';
 export * from './SfvbLibraryEntry';
 export * from './SfvbLibraryFacet';
 export * from './SfvbLibraryResponse';

package/dist/models/index.js

@@ -1014,6 +1014,8 @@ __exportStar(require("./SfvbFileVersionsResponse"), exports);
 __exportStar(require("./SfvbFileWriteRequest"), exports);
 __exportStar(require("./SfvbFileWriteResponse"), exports);
 __exportStar(require("./SfvbFilesResponse"), exports);
+__exportStar(require("./SfvbItemContainer"), exports);
+__exportStar(require("./SfvbItemContainersResponse"), exports);
 __exportStar(require("./SfvbLibraryEntry"), exports);
 __exportStar(require("./SfvbLibraryFacet"), exports);
 __exportStar(require("./SfvbLibraryResponse"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ultracart_rest_api_v2_typescript",
-  "version": "4.1.167",
+  "version": "4.1.169",
   "description": "UltraCart Rest TypeScript SDK",
   "author": "UltraCart",
   "repository": {

package/src/apis/SfvbApi.ts

@@ -96,6 +96,9 @@ import {
     SfvbFilesResponse,
     SfvbFilesResponseFromJSON,
     SfvbFilesResponseToJSON,
+    SfvbItemContainersResponse,
+    SfvbItemContainersResponseFromJSON,
+    SfvbItemContainersResponseToJSON,
     SfvbLibraryEntry,
     SfvbLibraryEntryFromJSON,
     SfvbLibraryEntryToJSON,
@@ -436,6 +439,15 @@ export interface ListSfvbFilesRequest {
     maxEntries?: number;
 }
 
+export interface ListSfvbItemContainersRequest {
+    storefrontOid: number;
+    merchantItemId?: string;
+    merchantItemOid?: number;
+    containerName?: string;
+    maxResults?: number;
+    offset?: number;
+}
+
 export interface ListSfvbPagesRequest {
     storefrontOid: number;
     under?: string;
@@ -1328,6 +1340,27 @@ export interface SfvbApiInterface {
      */
     listSfvbFiles(requestParameters: ListSfvbFilesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFilesResponse>;
 
+    /**
+     * An itemcontainer element renders nothing of its own.  It names a slot, and a separate container is resolved per item for that slot, so a catalog of five hundred products with three slots is fifteen hundred containers.  This says which of them exist.  Filter by container_name to find every item carrying one slot, or by merchant_item_id to see what one item has.  Which items are missing a slot is a set difference against pages/items, because a listing can only report containers that exist.  Each row carries hash_sha256, so a listing is enough to start an If-Match write without reading the container first.  Item containers are stored per account rather than per storefront, so storefront_oid identifies the caller\'s storefront but does not narrow the result. 
+     * @summary List the item containers on the account
+     * @param {number} storefrontOid 
+     * @param {string} [merchantItemId] Restrict to one item, by the merchant item id a storefront carries
+     * @param {number} [merchantItemOid] Restrict to one item, by oid.  Send this or merchant_item_id, not both
+     * @param {string} [containerName] Restrict to one slot name, matched without regard to case
+     * @param {number} [maxResults] 
+     * @param {number} [offset] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SfvbApiInterface
+     */
+    listSfvbItemContainersRaw(requestParameters: ListSfvbItemContainersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbItemContainersResponse>>;
+
+    /**
+     * An itemcontainer element renders nothing of its own.  It names a slot, and a separate container is resolved per item for that slot, so a catalog of five hundred products with three slots is fifteen hundred containers.  This says which of them exist.  Filter by container_name to find every item carrying one slot, or by merchant_item_id to see what one item has.  Which items are missing a slot is a set difference against pages/items, because a listing can only report containers that exist.  Each row carries hash_sha256, so a listing is enough to start an If-Match write without reading the container first.  Item containers are stored per account rather than per storefront, so storefront_oid identifies the caller\'s storefront but does not narrow the result. 
+     * List the item containers on the account
+     */
+    listSfvbItemContainers(requestParameters: ListSfvbItemContainersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbItemContainersResponse>;
+
     /**
      * Every page with its settings, sorted by path with the root first.  Hidden pages are included.  Pass under to list one page and everything below it.  Read from the same cached catalog the admin page tree uses, so a page created a moment ago can take a moment to appear here - read it directly with the single-page read to confirm a write. 
      * @summary List the storefront\'s pages
@@ -3813,6 +3846,67 @@ export class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface {
         return await response.value();
     }
 
+    /**
+     * An itemcontainer element renders nothing of its own.  It names a slot, and a separate container is resolved per item for that slot, so a catalog of five hundred products with three slots is fifteen hundred containers.  This says which of them exist.  Filter by container_name to find every item carrying one slot, or by merchant_item_id to see what one item has.  Which items are missing a slot is a set difference against pages/items, because a listing can only report containers that exist.  Each row carries hash_sha256, so a listing is enough to start an If-Match write without reading the container first.  Item containers are stored per account rather than per storefront, so storefront_oid identifies the caller\'s storefront but does not narrow the result. 
+     * List the item containers on the account
+     */
+    async listSfvbItemContainersRaw(requestParameters: ListSfvbItemContainersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbItemContainersResponse>> {
+        if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
+            throw new runtime.RequiredError('storefrontOid','Required parameter requestParameters.storefrontOid was null or undefined when calling listSfvbItemContainers.');
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters.merchantItemId !== undefined) {
+            queryParameters['merchant_item_id'] = requestParameters.merchantItemId;
+        }
+
+        if (requestParameters.merchantItemOid !== undefined) {
+            queryParameters['merchant_item_oid'] = requestParameters.merchantItemOid;
+        }
+
+        if (requestParameters.containerName !== undefined) {
+            queryParameters['container_name'] = requestParameters.containerName;
+        }
+
+        if (requestParameters.maxResults !== undefined) {
+            queryParameters['max_results'] = requestParameters.maxResults;
+        }
+
+        if (requestParameters.offset !== undefined) {
+            queryParameters['offset'] = requestParameters.offset;
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", []);
+        }
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+        }
+
+        const response = await this.request({
+            path: `/sfvb/storefronts/{storefront_oid}/item_containers`.replace(`{${"storefront_oid"}}`, encodeURIComponent(String(requestParameters.storefrontOid))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => SfvbItemContainersResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * An itemcontainer element renders nothing of its own.  It names a slot, and a separate container is resolved per item for that slot, so a catalog of five hundred products with three slots is fifteen hundred containers.  This says which of them exist.  Filter by container_name to find every item carrying one slot, or by merchant_item_id to see what one item has.  Which items are missing a slot is a set difference against pages/items, because a listing can only report containers that exist.  Each row carries hash_sha256, so a listing is enough to start an If-Match write without reading the container first.  Item containers are stored per account rather than per storefront, so storefront_oid identifies the caller\'s storefront but does not narrow the result. 
+     * List the item containers on the account
+     */
+    async listSfvbItemContainers(requestParameters: ListSfvbItemContainersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbItemContainersResponse> {
+        const response = await this.listSfvbItemContainersRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Every page with its settings, sorted by path with the root first.  Hidden pages are included.  Pass under to list one page and everything below it.  Read from the same cached catalog the admin page tree uses, so a page created a moment ago can take a moment to appear here - read it directly with the single-page read to confirm a write. 
      * List the storefront\'s pages

package/src/models/SfvbItemContainer.ts

@@ -0,0 +1,132 @@
+/* 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.
+ */
+
+import { exists, mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface SfvbItemContainer
+ */
+export interface SfvbItemContainer {
+    /**
+     * Size of the CJSON in UTF-8 bytes, which is the same unit the container version size and the upsell offer cjson_size use.
+     * @type {number}
+     * @memberof SfvbItemContainer
+     */
+    cjson_size?: number;
+    /**
+     * The slot name.  This is the value an itemcontainer element's itemContainerName setting holds, which is what ties a container to the element that renders it.
+     * @type {string}
+     * @memberof SfvbItemContainer
+     */
+    container_name?: string;
+    /**
+     * SHA-256 of the container's CJSON.  Identical to the value a read of the container returns, so a listing is enough to start an If-Match write without reading first.
+     * @type {string}
+     * @memberof SfvbItemContainer
+     */
+    hash_sha256?: string;
+    /**
+     * When the container was last written.  Absent for a container untouched since the storage began recording the time, so read an absent value as unknown rather than as never modified.
+     * @type {string}
+     * @memberof SfvbItemContainer
+     */
+    last_modified?: string;
+    /**
+     * The owning item's merchant item id.  This is the identifier a storefront carries and a merchant recognizes; the oid appears nowhere on a rendered page.  Send it as owner_type itemid to address the same container without converting it first.
+     * @type {string}
+     * @memberof SfvbItemContainer
+     */
+    merchant_item_id?: string;
+    /**
+     * The merchant item oid, spelled the way containers/item/{owner_object_id} takes it.
+     * @type {string}
+     * @memberof SfvbItemContainer
+     */
+    owner_object_id?: string;
+    /**
+     * Always item.  Carried so a row is usable as an address without the caller having to know which listing it came from.
+     * @type {string}
+     * @memberof SfvbItemContainer
+     */
+    owner_type?: SfvbItemContainerOwnerTypeEnum;
+    /**
+     * The element types this container uses, recorded by the storage when it was written.  A large cjson_size beside a handful of element types is the signature of markup pasted into a single html element.  Absent on a container written before the storage began recording this.
+     * @type {Array<string>}
+     * @memberof SfvbItemContainer
+     */
+    used_elements?: Array<string>;
+}
+
+
+
+/**
+ * @export
+ */
+export const SfvbItemContainerOwnerTypeEnum = {
+    Item: 'item'
+} as const;
+export type SfvbItemContainerOwnerTypeEnum = typeof SfvbItemContainerOwnerTypeEnum[keyof typeof SfvbItemContainerOwnerTypeEnum];
+
+
+/**
+ * Check if a given object implements the SfvbItemContainer interface.
+ */
+export function instanceOfSfvbItemContainer(value: object): boolean {
+    let isInstance = true;
+
+    return isInstance;
+}
+
+export function SfvbItemContainerFromJSON(json: any): SfvbItemContainer {
+    return SfvbItemContainerFromJSONTyped(json, false);
+}
+
+export function SfvbItemContainerFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbItemContainer {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'cjson_size': !exists(json, 'cjson_size') ? undefined : json['cjson_size'],
+        'container_name': !exists(json, 'container_name') ? undefined : json['container_name'],
+        'hash_sha256': !exists(json, 'hash_sha256') ? undefined : json['hash_sha256'],
+        'last_modified': !exists(json, 'last_modified') ? undefined : json['last_modified'],
+        'merchant_item_id': !exists(json, 'merchant_item_id') ? undefined : json['merchant_item_id'],
+        'owner_object_id': !exists(json, 'owner_object_id') ? undefined : json['owner_object_id'],
+        'owner_type': !exists(json, 'owner_type') ? undefined : json['owner_type'],
+        'used_elements': !exists(json, 'used_elements') ? undefined : json['used_elements'],
+    };
+}
+
+export function SfvbItemContainerToJSON(value?: SfvbItemContainer | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'cjson_size': value.cjson_size,
+        '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,
+        'used_elements': value.used_elements,
+    };
+}
+

package/src/models/SfvbItemContainersResponse.ts

@@ -0,0 +1,130 @@
+/* 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.
+ */
+
+import { exists, mapValues } from '../runtime';
+import {
+    SfvbItemContainer,
+    SfvbItemContainerFromJSON,
+    SfvbItemContainerFromJSONTyped,
+    SfvbItemContainerToJSON,
+} from './SfvbItemContainer';
+
+/**
+ * 
+ * @export
+ * @interface SfvbItemContainersResponse
+ */
+export interface SfvbItemContainersResponse {
+    /**
+     * The containers on this page, ordered by merchant item id then container name.
+     * @type {Array<SfvbItemContainer>}
+     * @memberof SfvbItemContainersResponse
+     */
+    item_containers?: Array<SfvbItemContainer>;
+    /**
+     * The cap that was applied.
+     * @type {number}
+     * @memberof SfvbItemContainersResponse
+     */
+    max_results?: number;
+    /**
+     * Offset to send for the next page.  Zero when truncated is false.  Never truncates without giving a way to continue.
+     * @type {number}
+     * @memberof SfvbItemContainersResponse
+     */
+    next_offset?: number;
+    /**
+     * Containers skipped to produce this page.
+     * @type {number}
+     * @memberof SfvbItemContainersResponse
+     */
+    offset?: number;
+    /**
+     * Number of containers returned on this page.
+     * @type {number}
+     * @memberof SfvbItemContainersResponse
+     */
+    result_count?: number;
+    /**
+     * Total containers matching the filter.  With container_name supplied this is the answer to how many items carry that slot.
+     * @type {number}
+     * @memberof SfvbItemContainersResponse
+     */
+    total_count?: number;
+    /**
+     * True when containers exist beyond this page.  next_offset is populated when it is.
+     * @type {boolean}
+     * @memberof SfvbItemContainersResponse
+     */
+    truncated?: boolean;
+    /**
+     * Advice for the caller when truncated is true.
+     * @type {string}
+     * @memberof SfvbItemContainersResponse
+     */
+    truncation_advice?: string;
+}
+
+
+
+/**
+ * Check if a given object implements the SfvbItemContainersResponse interface.
+ */
+export function instanceOfSfvbItemContainersResponse(value: object): boolean {
+    let isInstance = true;
+
+    return isInstance;
+}
+
+export function SfvbItemContainersResponseFromJSON(json: any): SfvbItemContainersResponse {
+    return SfvbItemContainersResponseFromJSONTyped(json, false);
+}
+
+export function SfvbItemContainersResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbItemContainersResponse {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'item_containers': !exists(json, 'item_containers') ? undefined : ((json['item_containers'] as Array<any>).map(SfvbItemContainerFromJSON)),
+        'max_results': !exists(json, 'max_results') ? undefined : json['max_results'],
+        'next_offset': !exists(json, 'next_offset') ? undefined : json['next_offset'],
+        'offset': !exists(json, 'offset') ? undefined : json['offset'],
+        'result_count': !exists(json, 'result_count') ? undefined : json['result_count'],
+        'total_count': !exists(json, 'total_count') ? undefined : json['total_count'],
+        'truncated': !exists(json, 'truncated') ? undefined : json['truncated'],
+        'truncation_advice': !exists(json, 'truncation_advice') ? undefined : json['truncation_advice'],
+    };
+}
+
+export function SfvbItemContainersResponseToJSON(value?: SfvbItemContainersResponse | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'item_containers': value.item_containers === undefined ? undefined : ((value.item_containers as Array<any>).map(SfvbItemContainerToJSON)),
+        'max_results': value.max_results,
+        'next_offset': value.next_offset,
+        'offset': value.offset,
+        'result_count': value.result_count,
+        'total_count': value.total_count,
+        'truncated': value.truncated,
+        'truncation_advice': value.truncation_advice,
+    };
+}
+

package/src/models/index.ts

@@ -998,6 +998,8 @@ export * from './SfvbFileVersionsResponse';
 export * from './SfvbFileWriteRequest';
 export * from './SfvbFileWriteResponse';
 export * from './SfvbFilesResponse';
+export * from './SfvbItemContainer';
+export * from './SfvbItemContainersResponse';
 export * from './SfvbLibraryEntry';
 export * from './SfvbLibraryFacet';
 export * from './SfvbLibraryResponse';