ultracart_rest_api_v2_typescript 4.0.245 → 4.1.0

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@4.0.245
+## ultracart_rest_api_v2_typescript@4.1.0
 
 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@4.0.245 --save
+npm install ultracart_rest_api_v2_typescript@4.1.0 --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.0 | 02/21/2025 | ItemApi.getInventorySnapshot had bad nickname causing bad sdk method name |
 | 4.0.245 | 02/20/2025 | automation fix |
 | 4.0.244 | 02/20/2025 | no change, revving sdk to troubleshoot java deployment automation |
 | 4.0.243 | 02/20/2025 | no change, revving sdk to troubleshoot java deployment automation |

package/dist/apis/ItemApi.d.ts

@@ -210,6 +210,19 @@ export interface ItemApiInterface {
      * Retrieves digital items from the digital library (which are digital files that may be attached to normal items) that having a matching external id
      */
     getDigitalItemsByExternalId(requestParameters: GetDigitalItemsByExternalIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemDigitalItemsResponse>;
+    /**
+     * Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response.
+     * @summary Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ItemApiInterface
+     */
+    getInventorySnapshotRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemInventorySnapshotResponse>>;
+    /**
+     * Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response.
+     * Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response.
+     */
+    getInventorySnapshot(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemInventorySnapshotResponse>;
     /**
      * Retrieves a single item using the specified item oid.
      * @summary Retrieve an item
@@ -385,19 +398,6 @@ export interface ItemApiInterface {
      * Upsert an item content attribute
      */
     insertUpdateItemContentAttribute(requestParameters: InsertUpdateItemContentAttributeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
-    /**
-     * Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response.
-     * @summary Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof ItemApiInterface
-     */
-    restItemInventorySnapshotResponseRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemInventorySnapshotResponse>>;
-    /**
-     * Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response.
-     * Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response.
-     */
-    restItemInventorySnapshotResponse(initOverrides?: RequestInit | runtime.InitOverrideFunction): 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
@@ -542,6 +542,16 @@ export declare class ItemApi extends runtime.BaseAPI implements ItemApiInterface
      * Retrieves digital items from the digital library (which are digital files that may be attached to normal items) that having a matching external id
      */
     getDigitalItemsByExternalId(requestParameters: GetDigitalItemsByExternalIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemDigitalItemsResponse>;
+    /**
+     * Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response.
+     * Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response.
+     */
+    getInventorySnapshotRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemInventorySnapshotResponse>>;
+    /**
+     * Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response.
+     * Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response.
+     */
+    getInventorySnapshot(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemInventorySnapshotResponse>;
     /**
      * Retrieves a single item using the specified item oid.
      * Retrieve an item
@@ -652,16 +662,6 @@ export declare class ItemApi extends runtime.BaseAPI implements ItemApiInterface
      * Upsert an item content attribute
      */
     insertUpdateItemContentAttribute(requestParameters: InsertUpdateItemContentAttributeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
-    /**
-     * Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response.
-     * Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response.
-     */
-    restItemInventorySnapshotResponseRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemInventorySnapshotResponse>>;
-    /**
-     * Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response.
-     * Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response.
-     */
-    restItemInventorySnapshotResponse(initOverrides?: RequestInit | runtime.InitOverrideFunction): 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.
      * Updates a file within the digital library

package/dist/apis/ItemApi.js

@@ -442,6 +442,62 @@ var ItemApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response.
+     * Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response.
+     */
+    ItemApi.prototype.getInventorySnapshotRaw = function (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:
+                        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", ["item_read"])];
+                    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: "/item/items/inventory_snapshot",
+                                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.ItemInventorySnapshotResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response.
+     * Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response.
+     */
+    ItemApi.prototype.getInventorySnapshot = function (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.getInventorySnapshotRaw(initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * Retrieves a single item using the specified item oid.
      * Retrieve an item
@@ -1163,62 +1219,6 @@ var ItemApi = /** @class */ (function (_super) {
             });
         });
     };
-    /**
-     * Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response.
-     * Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response.
-     */
-    ItemApi.prototype.restItemInventorySnapshotResponseRaw = function (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:
-                        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", ["item_read"])];
-                    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: "/item/items/inventory_snapshot",
-                                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.ItemInventorySnapshotResponseFromJSON)(jsonValue); })];
-                }
-            });
-        });
-    };
-    /**
-     * Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response.
-     * Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response.
-     */
-    ItemApi.prototype.restItemInventorySnapshotResponse = function (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.restItemInventorySnapshotResponseRaw(initOverrides)];
-                    case 1:
-                        response = _a.sent();
-                        return [4 /*yield*/, response.value()];
-                    case 2: return [2 /*return*/, _a.sent()];
-                }
-            });
-        });
-    };
     /**
      * 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.
      * Updates a file within the digital library

package/package.json

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

package/src/apis/ItemApi.ts

@@ -295,6 +295,21 @@ export interface ItemApiInterface {
      */
     getDigitalItemsByExternalId(requestParameters: GetDigitalItemsByExternalIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemDigitalItemsResponse>;
 
+    /**
+     * Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response. 
+     * @summary Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ItemApiInterface
+     */
+    getInventorySnapshotRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemInventorySnapshotResponse>>;
+
+    /**
+     * Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response. 
+     * Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response.
+     */
+    getInventorySnapshot(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemInventorySnapshotResponse>;
+
     /**
      * Retrieves a single item using the specified item oid. 
      * @summary Retrieve an item
@@ -492,21 +507,6 @@ export interface ItemApiInterface {
      */
     insertUpdateItemContentAttribute(requestParameters: InsertUpdateItemContentAttributeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
 
-    /**
-     * Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response. 
-     * @summary Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof ItemApiInterface
-     */
-    restItemInventorySnapshotResponseRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemInventorySnapshotResponse>>;
-
-    /**
-     * Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response. 
-     * Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response.
-     */
-    restItemInventorySnapshotResponse(initOverrides?: RequestInit | runtime.InitOverrideFunction): 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
@@ -870,6 +870,43 @@ export class ItemApi extends runtime.BaseAPI implements ItemApiInterface {
         return await response.value();
     }
 
+    /**
+     * Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response. 
+     * Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response.
+     */
+    async getInventorySnapshotRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemInventorySnapshotResponse>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", ["item_read"]);
+        }
+
+        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: `/item/items/inventory_snapshot`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ItemInventorySnapshotResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response. 
+     * Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response.
+     */
+    async getInventorySnapshot(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemInventorySnapshotResponse> {
+        const response = await this.getInventorySnapshotRaw(initOverrides);
+        return await response.value();
+    }
+
     /**
      * Retrieves a single item using the specified item oid. 
      * Retrieve an item
@@ -1416,43 +1453,6 @@ export class ItemApi extends runtime.BaseAPI implements ItemApiInterface {
         await this.insertUpdateItemContentAttributeRaw(requestParameters, initOverrides);
     }
 
-    /**
-     * Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response. 
-     * Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response.
-     */
-    async restItemInventorySnapshotResponseRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemInventorySnapshotResponse>> {
-        const queryParameters: any = {};
-
-        const headerParameters: runtime.HTTPHeaders = {};
-
-        if (this.configuration && this.configuration.accessToken) {
-            // oauth required
-            headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", ["item_read"]);
-        }
-
-        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: `/item/items/inventory_snapshot`,
-            method: 'GET',
-            headers: headerParameters,
-            query: queryParameters,
-        }, initOverrides);
-
-        return new runtime.JSONApiResponse(response, (jsonValue) => ItemInventorySnapshotResponseFromJSON(jsonValue));
-    }
-
-    /**
-     * Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response. 
-     * Retrieve a list of item inventories.  This method may be called once every 15 minutes.  More than that will result in a 429 response.
-     */
-    async restItemInventorySnapshotResponse(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemInventorySnapshotResponse> {
-        const response = await this.restItemInventorySnapshotResponseRaw(initOverrides);
-        return await response.value();
-    }
-
     /**
      * 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. 
      * Updates a file within the digital library