ultracart_rest_api_v2_typescript 3.10.208 → 3.10.209

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@3.10.208
+## ultracart_rest_api_v2_typescript@3.10.209
 
 This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install ultracart_rest_api_v2_typescript@3.10.208 --save
+npm install ultracart_rest_api_v2_typescript@3.10.209 --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.209 | 05/31/2024 | ItemApi.getInventorySnapshot method |
 | 3.10.208 | 05/30/2024 | add adult sig req. to the merchant item destination markup for items |
 | 3.10.207 | 05/29/2024 | added methods getEmailCommseqRateLimiters, resetEmailCommseqRateLimiters |
 | 3.10.206 | 05/28/2024 | added property to OrderQuery object to allow querying from cache |

package/api.ts

@@ -28042,6 +28042,126 @@ export interface ItemInternal {
     memo?: string;
 }
 
+/**
+ * 
+ * @export
+ * @interface ItemInventorySnapshot
+ */
+export interface ItemInventorySnapshot {
+    /**
+     * 
+     * @type {number}
+     * @memberof ItemInventorySnapshot
+     */
+    allocated_to_placed_orders?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ItemInventorySnapshot
+     */
+    allocated_to_shopping_carts?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ItemInventorySnapshot
+     */
+    available_to_allocate?: number;
+    /**
+     * 
+     * @type {Array<ItemInventorySnapshotDistributionCenter>}
+     * @memberof ItemInventorySnapshot
+     */
+    distribution_centers?: Array<ItemInventorySnapshotDistributionCenter>;
+    /**
+     * 
+     * @type {string}
+     * @memberof ItemInventorySnapshot
+     */
+    merchant_item_id?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof ItemInventorySnapshot
+     */
+    quantity?: number;
+}
+
+/**
+ * 
+ * @export
+ * @interface ItemInventorySnapshotDistributionCenter
+ */
+export interface ItemInventorySnapshotDistributionCenter {
+    /**
+     * 
+     * @type {number}
+     * @memberof ItemInventorySnapshotDistributionCenter
+     */
+    allocated_to_placed_orders?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ItemInventorySnapshotDistributionCenter
+     */
+    allocated_to_shopping_carts?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ItemInventorySnapshotDistributionCenter
+     */
+    available_to_allocate?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof ItemInventorySnapshotDistributionCenter
+     */
+    code?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof ItemInventorySnapshotDistributionCenter
+     */
+    quantity?: number;
+}
+
+/**
+ * 
+ * @export
+ * @interface ItemInventorySnapshotResponse
+ */
+export interface ItemInventorySnapshotResponse {
+    /**
+     * 
+     * @type {ModelError}
+     * @memberof ItemInventorySnapshotResponse
+     */
+    error?: ModelError;
+    /**
+     * inventories
+     * @type {Array<ItemInventorySnapshot>}
+     * @memberof ItemInventorySnapshotResponse
+     */
+    inventories?: Array<ItemInventorySnapshot>;
+    /**
+     * 
+     * @type {ResponseMetadata}
+     * @memberof ItemInventorySnapshotResponse
+     */
+    metadata?: ResponseMetadata;
+    /**
+     * Indicates if API call was successful
+     * @type {boolean}
+     * @memberof ItemInventorySnapshotResponse
+     */
+    success?: boolean;
+    /**
+     * 
+     * @type {Warning}
+     * @memberof ItemInventorySnapshotResponse
+     */
+    warning?: Warning;
+}
+
 /**
  * 
  * @export
@@ -69574,6 +69694,52 @@ export const ItemApiFetchParamCreator = function (configuration?: Configuration)
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Retrieves a list of item inventories. 
+         * @summary Retrieve a list of item inventories
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        restItemInventorySnapshotResponse(options: any = {}): FetchArgs {
+            const localVarPath = `/item/items/inventory_snapshot`;
+            const localVarUrlObj = url.parse(localVarPath, true);
+            const localVarRequestOptions = Object.assign({ method: 'GET' }, options);
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+    if(configuration && configuration.apiVersion) {
+      localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
+    }
+
+
+
+            // authentication ultraCartOauth required
+            // oauth required
+            if (configuration && configuration.accessToken) {
+				const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
+					? configuration.accessToken("ultraCartOauth", ["item_read"])
+					: configuration.accessToken;
+                localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
+            }
+
+            // authentication ultraCartSimpleApiKey required
+            if (configuration && configuration.apiKey) {
+                const localVarApiKeyValue = typeof configuration.apiKey === 'function'
+					? configuration.apiKey("x-ultracart-simple-key")
+					: configuration.apiKey;
+                localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
+            }
+
+            localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
+            // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
+            delete localVarUrlObj.search;
+            localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
+
+            return {
+                url: url.format(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Updates a file within the digital library.  This does not update an item, but updates a digital file available and selectable as part (or all) of an item. 
          * @summary Updates a file within the digital library
@@ -70295,6 +70461,26 @@ export const ItemApiFp = function(configuration?: Configuration) {
                 });
             };
         },
+        /**
+         * Retrieves a list of item inventories. 
+         * @summary Retrieve a list of item inventories
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        restItemInventorySnapshotResponse(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ItemInventorySnapshotResponse> {
+            const localVarFetchArgs = ItemApiFetchParamCreator(configuration).restItemInventorySnapshotResponse(options);
+            return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
+                return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
+
+                    if (response.status >= 200 && response.status < 300) {
+                      return response.json();
+                      
+                    } else {
+                        throw response;
+                    }
+                });
+            };
+        },
         /**
          * Updates a file within the digital library.  This does not update an item, but updates a digital file available and selectable as part (or all) of an item. 
          * @summary Updates a file within the digital library
@@ -70615,6 +70801,15 @@ export const ItemApiFactory = function (configuration?: Configuration, fetch?: F
         insertUpdateItemContentAttribute(item_attribute: ItemContentAttribute, merchant_item_oid: number, options?: any) {
             return ItemApiFp(configuration).insertUpdateItemContentAttribute(item_attribute, merchant_item_oid, options)(fetch, basePath);
         },
+        /**
+         * Retrieves a list of item inventories. 
+         * @summary Retrieve a list of item inventories
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        restItemInventorySnapshotResponse(options?: any) {
+            return ItemApiFp(configuration).restItemInventorySnapshotResponse(options)(fetch, basePath);
+        },
         /**
          * Updates a file within the digital library.  This does not update an item, but updates a digital file available and selectable as part (or all) of an item. 
          * @summary Updates a file within the digital library
@@ -70880,6 +71075,15 @@ export interface ItemApiInterface {
      */
     insertUpdateItemContentAttribute(item_attribute: ItemContentAttribute, merchant_item_oid: number, options?: any): Promise<{}>;
 
+    /**
+     * Retrieves a list of item inventories. 
+     * @summary Retrieve a list of item inventories
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ItemApiInterface
+     */
+    restItemInventorySnapshotResponse(options?: any): Promise<ItemInventorySnapshotResponse>;
+
     /**
      * Updates a file within the digital library.  This does not update an item, but updates a digital file available and selectable as part (or all) of an item. 
      * @summary Updates a file within the digital library
@@ -71179,6 +71383,17 @@ export class ItemApi extends BaseAPI implements ItemApiInterface {
         return ItemApiFp(this.configuration).insertUpdateItemContentAttribute(item_attribute, merchant_item_oid, options)(this.fetch, this.basePath);
     }
 
+    /**
+     * Retrieves a list of item inventories. 
+     * @summary Retrieve a list of item inventories
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ItemApi
+     */
+    public restItemInventorySnapshotResponse(options?: any) {
+        return ItemApiFp(this.configuration).restItemInventorySnapshotResponse(options)(this.fetch, this.basePath);
+    }
+
     /**
      * Updates a file within the digital library.  This does not update an item, but updates a digital file available and selectable as part (or all) of an item. 
      * @summary Updates a file within the digital library

package/dist/api.d.ts

@@ -27450,6 +27450,123 @@ export interface ItemInternal {
      */
     memo?: string;
 }
+/**
+ *
+ * @export
+ * @interface ItemInventorySnapshot
+ */
+export interface ItemInventorySnapshot {
+    /**
+     *
+     * @type {number}
+     * @memberof ItemInventorySnapshot
+     */
+    allocated_to_placed_orders?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ItemInventorySnapshot
+     */
+    allocated_to_shopping_carts?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ItemInventorySnapshot
+     */
+    available_to_allocate?: number;
+    /**
+     *
+     * @type {Array<ItemInventorySnapshotDistributionCenter>}
+     * @memberof ItemInventorySnapshot
+     */
+    distribution_centers?: Array<ItemInventorySnapshotDistributionCenter>;
+    /**
+     *
+     * @type {string}
+     * @memberof ItemInventorySnapshot
+     */
+    merchant_item_id?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof ItemInventorySnapshot
+     */
+    quantity?: number;
+}
+/**
+ *
+ * @export
+ * @interface ItemInventorySnapshotDistributionCenter
+ */
+export interface ItemInventorySnapshotDistributionCenter {
+    /**
+     *
+     * @type {number}
+     * @memberof ItemInventorySnapshotDistributionCenter
+     */
+    allocated_to_placed_orders?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ItemInventorySnapshotDistributionCenter
+     */
+    allocated_to_shopping_carts?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ItemInventorySnapshotDistributionCenter
+     */
+    available_to_allocate?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof ItemInventorySnapshotDistributionCenter
+     */
+    code?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof ItemInventorySnapshotDistributionCenter
+     */
+    quantity?: number;
+}
+/**
+ *
+ * @export
+ * @interface ItemInventorySnapshotResponse
+ */
+export interface ItemInventorySnapshotResponse {
+    /**
+     *
+     * @type {ModelError}
+     * @memberof ItemInventorySnapshotResponse
+     */
+    error?: ModelError;
+    /**
+     * inventories
+     * @type {Array<ItemInventorySnapshot>}
+     * @memberof ItemInventorySnapshotResponse
+     */
+    inventories?: Array<ItemInventorySnapshot>;
+    /**
+     *
+     * @type {ResponseMetadata}
+     * @memberof ItemInventorySnapshotResponse
+     */
+    metadata?: ResponseMetadata;
+    /**
+     * Indicates if API call was successful
+     * @type {boolean}
+     * @memberof ItemInventorySnapshotResponse
+     */
+    success?: boolean;
+    /**
+     *
+     * @type {Warning}
+     * @memberof ItemInventorySnapshotResponse
+     */
+    warning?: Warning;
+}
 /**
  *
  * @export
@@ -53774,6 +53891,13 @@ export declare const ItemApiFetchParamCreator: (configuration?: Configuration) =
      * @throws {RequiredError}
      */
     insertUpdateItemContentAttribute(item_attribute: ItemContentAttribute, merchant_item_oid: number, options?: any): FetchArgs;
+    /**
+     * Retrieves a list of item inventories.
+     * @summary Retrieve a list of item inventories
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    restItemInventorySnapshotResponse(options?: any): FetchArgs;
     /**
      * Updates a file within the digital library.  This does not update an item, but updates a digital file available and selectable as part (or all) of an item.
      * @summary Updates a file within the digital library
@@ -53992,6 +54116,13 @@ export declare const ItemApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     insertUpdateItemContentAttribute(item_attribute: ItemContentAttribute, merchant_item_oid: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response>;
+    /**
+     * Retrieves a list of item inventories.
+     * @summary Retrieve a list of item inventories
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    restItemInventorySnapshotResponse(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ItemInventorySnapshotResponse>;
     /**
      * Updates a file within the digital library.  This does not update an item, but updates a digital file available and selectable as part (or all) of an item.
      * @summary Updates a file within the digital library
@@ -54210,6 +54341,13 @@ export declare const ItemApiFactory: (configuration?: Configuration, fetch?: Fet
      * @throws {RequiredError}
      */
     insertUpdateItemContentAttribute(item_attribute: ItemContentAttribute, merchant_item_oid: number, options?: any): Promise<Response>;
+    /**
+     * Retrieves a list of item inventories.
+     * @summary Retrieve a list of item inventories
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    restItemInventorySnapshotResponse(options?: any): Promise<ItemInventorySnapshotResponse>;
     /**
      * Updates a file within the digital library.  This does not update an item, but updates a digital file available and selectable as part (or all) of an item.
      * @summary Updates a file within the digital library
@@ -54446,6 +54584,14 @@ export interface ItemApiInterface {
      * @memberof ItemApiInterface
      */
     insertUpdateItemContentAttribute(item_attribute: ItemContentAttribute, merchant_item_oid: number, options?: any): Promise<{}>;
+    /**
+     * Retrieves a list of item inventories.
+     * @summary Retrieve a list of item inventories
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ItemApiInterface
+     */
+    restItemInventorySnapshotResponse(options?: any): Promise<ItemInventorySnapshotResponse>;
     /**
      * Updates a file within the digital library.  This does not update an item, but updates a digital file available and selectable as part (or all) of an item.
      * @summary Updates a file within the digital library
@@ -54688,6 +54834,14 @@ export declare class ItemApi extends BaseAPI implements ItemApiInterface {
      * @memberof ItemApi
      */
     insertUpdateItemContentAttribute(item_attribute: ItemContentAttribute, merchant_item_oid: number, options?: any): Promise<Response>;
+    /**
+     * Retrieves a list of item inventories.
+     * @summary Retrieve a list of item inventories
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ItemApi
+     */
+    restItemInventorySnapshotResponse(options?: any): Promise<ItemInventorySnapshotResponse>;
     /**
      * Updates a file within the digital library.  This does not update an item, but updates a digital file available and selectable as part (or all) of an item.
      * @summary Updates a file within the digital library

package/dist/api.js

@@ -22742,6 +22742,46 @@ var ItemApiFetchParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Retrieves a list of item inventories.
+         * @summary Retrieve a list of item inventories
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        restItemInventorySnapshotResponse: function (options) {
+            if (options === void 0) { options = {}; }
+            var localVarPath = "/item/items/inventory_snapshot";
+            var localVarUrlObj = url.parse(localVarPath, true);
+            var localVarRequestOptions = Object.assign({ method: 'GET' }, options);
+            var localVarHeaderParameter = {};
+            var localVarQueryParameter = {};
+            if (configuration && configuration.apiVersion) {
+                localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
+            }
+            // authentication ultraCartOauth required
+            // oauth required
+            if (configuration && configuration.accessToken) {
+                var localVarAccessTokenValue = typeof configuration.accessToken === 'function'
+                    ? configuration.accessToken("ultraCartOauth", ["item_read"])
+                    : configuration.accessToken;
+                localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
+            }
+            // authentication ultraCartSimpleApiKey required
+            if (configuration && configuration.apiKey) {
+                var localVarApiKeyValue = typeof configuration.apiKey === 'function'
+                    ? configuration.apiKey("x-ultracart-simple-key")
+                    : configuration.apiKey;
+                localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
+            }
+            localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
+            // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
+            delete localVarUrlObj.search;
+            localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
+            return {
+                url: url.format(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Updates a file within the digital library.  This does not update an item, but updates a digital file available and selectable as part (or all) of an item.
          * @summary Updates a file within the digital library
@@ -23439,6 +23479,27 @@ var ItemApiFp = function (configuration) {
                 });
             };
         },
+        /**
+         * Retrieves a list of item inventories.
+         * @summary Retrieve a list of item inventories
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        restItemInventorySnapshotResponse: function (options) {
+            var localVarFetchArgs = (0, exports.ItemApiFetchParamCreator)(configuration).restItemInventorySnapshotResponse(options);
+            return function (fetch, basePath) {
+                if (fetch === void 0) { fetch = portableFetch; }
+                if (basePath === void 0) { basePath = BASE_PATH; }
+                return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then(function (response) {
+                    if (response.status >= 200 && response.status < 300) {
+                        return response.json();
+                    }
+                    else {
+                        throw response;
+                    }
+                });
+            };
+        },
         /**
          * Updates a file within the digital library.  This does not update an item, but updates a digital file available and selectable as part (or all) of an item.
          * @summary Updates a file within the digital library
@@ -23764,6 +23825,15 @@ var ItemApiFactory = function (configuration, fetch, basePath) {
         insertUpdateItemContentAttribute: function (item_attribute, merchant_item_oid, options) {
             return (0, exports.ItemApiFp)(configuration).insertUpdateItemContentAttribute(item_attribute, merchant_item_oid, options)(fetch, basePath);
         },
+        /**
+         * Retrieves a list of item inventories.
+         * @summary Retrieve a list of item inventories
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        restItemInventorySnapshotResponse: function (options) {
+            return (0, exports.ItemApiFp)(configuration).restItemInventorySnapshotResponse(options)(fetch, basePath);
+        },
         /**
          * Updates a file within the digital library.  This does not update an item, but updates a digital file available and selectable as part (or all) of an item.
          * @summary Updates a file within the digital library
@@ -24051,6 +24121,16 @@ var ItemApi = /** @class */ (function (_super) {
     ItemApi.prototype.insertUpdateItemContentAttribute = function (item_attribute, merchant_item_oid, options) {
         return (0, exports.ItemApiFp)(this.configuration).insertUpdateItemContentAttribute(item_attribute, merchant_item_oid, options)(this.fetch, this.basePath);
     };
+    /**
+     * Retrieves a list of item inventories.
+     * @summary Retrieve a list of item inventories
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ItemApi
+     */
+    ItemApi.prototype.restItemInventorySnapshotResponse = function (options) {
+        return (0, exports.ItemApiFp)(this.configuration).restItemInventorySnapshotResponse(options)(this.fetch, this.basePath);
+    };
     /**
      * Updates a file within the digital library.  This does not update an item, but updates a digital file available and selectable as part (or all) of an item.
      * @summary Updates a file within the digital library

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ultracart_rest_api_v2_typescript",
-  "version": "3.10.208",
+  "version": "3.10.209",
   "description": "UltraCart Rest TypeScript SDK",
   "author": "UltraCart",
   "keywords": [