@wix/auto_sdk_stores_inventory 1.0.0

package/build/internal/es/src/stores-v2-inventory-inventory.universal.js

@@ -0,0 +1,238 @@
+import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';
+import { renameKeysFromSDKRequestToRESTRequest, renameKeysFromRESTResponseToSDKResponse, } from '@wix/sdk-runtime/rename-all-nested-keys';
+import * as ambassadorWixStoresV2Inventory from './stores-v2-inventory-inventory.http.js';
+export var ReasonType;
+(function (ReasonType) {
+    /** Unknown reason. */
+    ReasonType["UNKNOWN"] = "UNKNOWN";
+    /** Order related. */
+    ReasonType["ORDER"] = "ORDER";
+    /** Manual adjustment. */
+    ReasonType["MANUAL"] = "MANUAL";
+    /** Reverting an inventory change. */
+    ReasonType["REVERT_INVENTORY_CHANGE"] = "REVERT_INVENTORY_CHANGE";
+})(ReasonType || (ReasonType = {}));
+export var WebhookIdentityType;
+(function (WebhookIdentityType) {
+    WebhookIdentityType["UNKNOWN"] = "UNKNOWN";
+    WebhookIdentityType["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
+    WebhookIdentityType["MEMBER"] = "MEMBER";
+    WebhookIdentityType["WIX_USER"] = "WIX_USER";
+    WebhookIdentityType["APP"] = "APP";
+})(WebhookIdentityType || (WebhookIdentityType = {}));
+/**
+ * Gets inventory variant information based on the specified option choices.
+ *
+ *
+ * The `getInventoryVariants()` function returns a Promise that resolves to the specified inventory variant information.
+ * @param inventoryId - Inventory item ID.
+ * @public
+ * @requiredField inventoryId
+ * @permissionId WIX_STORES.READ_INVENTORY
+ * @permissionScope Manage Stores - all permissions
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage Products
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
+ * @permissionScope Read Stores - all read permissions
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
+ * @permissionScope Read Products
+ * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn wix.inventory.api.v1.InventoryReadApi.GetInventoryVariants
+ */
+export async function getInventoryVariants(inventoryId, options) {
+    // @ts-ignore
+    const { httpClient, sideEffects } = arguments[2];
+    const payload = renameKeysFromSDKRequestToRESTRequest({
+        inventoryId: inventoryId,
+        externalId: options?.externalId,
+        productId: options?.productId,
+        variantIds: options?.variantIds,
+    });
+    const reqOpts = ambassadorWixStoresV2Inventory.getInventoryVariants(payload);
+    sideEffects?.onSiteCall?.();
+    try {
+        const result = await httpClient.request(reqOpts);
+        sideEffects?.onSuccess?.(result);
+        return renameKeysFromRESTResponseToSDKResponse(result.data);
+    }
+    catch (err) {
+        const transformedError = sdkTransformError(err, {
+            spreadPathsToArguments: {},
+            explicitPathsToArguments: {
+                inventoryId: '$[0]',
+                externalId: '$[1].externalId',
+                productId: '$[1].productId',
+                variantIds: '$[1].variantIds',
+            },
+            singleArgumentUnchanged: false,
+        }, ['inventoryId', 'options']);
+        sideEffects?.onError?.(err);
+        throw transformedError;
+    }
+}
+/**
+ * Returns a list of inventory items, given the provided paging, sorting and filtering.
+ * @public
+ * @permissionId WIX_STORES.READ_INVENTORY
+ * @permissionScope Manage Stores - all permissions
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage Products
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
+ * @permissionScope Read Stores - all read permissions
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
+ * @permissionScope Read Products
+ * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn wix.inventory.api.v1.InventoryReadApi.QueryInventory
+ */
+export async function queryInventory(options) {
+    // @ts-ignore
+    const { httpClient, sideEffects } = arguments[1];
+    const payload = renameKeysFromSDKRequestToRESTRequest({
+        query: options?.query,
+    });
+    const reqOpts = ambassadorWixStoresV2Inventory.queryInventory(payload);
+    sideEffects?.onSiteCall?.();
+    try {
+        const result = await httpClient.request(reqOpts);
+        sideEffects?.onSuccess?.(result);
+        return renameKeysFromRESTResponseToSDKResponse(result.data);
+    }
+    catch (err) {
+        const transformedError = sdkTransformError(err, {
+            spreadPathsToArguments: {},
+            explicitPathsToArguments: { query: '$[0].query' },
+            singleArgumentUnchanged: false,
+        }, ['options']);
+        sideEffects?.onError?.(err);
+        throw transformedError;
+    }
+}
+/**
+ * Updates product inventory, including total quantity, whether the product is in stock, and whether the product inventory is tracked.
+ *
+ *
+ * The `updateInventoryVariants()` function is a Promise that resolves to the updated inventory variant data.
+ * @param productId - Product ID.
+ * @public
+ * @requiredField inventoryItem
+ * @requiredField productId
+ * @param inventoryItem - Inventory item to update.
+ * @permissionId WIX_STORES.MODIFY_INVENTORY
+ * @permissionScope Manage Stores - all permissions
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage Products
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @applicableIdentity APP
+ * @fqn wix.inventory.api.v1.InventoryWriteApi.UpdateInventoryVariants
+ */
+export async function updateInventoryVariants(productId, inventoryItem) {
+    // @ts-ignore
+    const { httpClient, sideEffects } = arguments[2];
+    const payload = renameKeysFromSDKRequestToRESTRequest({
+        inventoryItem: { ...inventoryItem, productId: productId },
+    });
+    const reqOpts = ambassadorWixStoresV2Inventory.updateInventoryVariants(payload);
+    sideEffects?.onSiteCall?.();
+    try {
+        const result = await httpClient.request(reqOpts);
+        sideEffects?.onSuccess?.(result);
+    }
+    catch (err) {
+        const transformedError = sdkTransformError(err, {
+            spreadPathsToArguments: { inventoryItem: '$[1]' },
+            explicitPathsToArguments: { 'inventoryItem.productId': '$[0]' },
+            singleArgumentUnchanged: false,
+        }, ['productId', 'inventoryItem']);
+        sideEffects?.onError?.(err);
+        throw transformedError;
+    }
+}
+/**
+ * Subtracts a set number of items from inventory.
+ *
+ *
+ * The `decrementInventory()` function returns a Promise that is resolved when the specified item's quantity has been updated in the inventory.
+ * @param decrementData - Item or product to decrement.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField decrementData
+ * @permissionId WIX_STORES.MODIFY_INVENTORY
+ * @permissionScope Manage Stores - all permissions
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage Products
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @applicableIdentity APP
+ * @fqn wix.inventory.api.v1.InventoryWriteApi.DecrementInventory
+ */
+export async function decrementInventory(decrementData) {
+    // @ts-ignore
+    const { httpClient, sideEffects } = arguments[1];
+    const payload = renameKeysFromSDKRequestToRESTRequest({
+        decrementData: decrementData,
+    });
+    const reqOpts = ambassadorWixStoresV2Inventory.decrementInventory(payload);
+    sideEffects?.onSiteCall?.();
+    try {
+        const result = await httpClient.request(reqOpts);
+        sideEffects?.onSuccess?.(result);
+    }
+    catch (err) {
+        const transformedError = sdkTransformError(err, {
+            spreadPathsToArguments: {},
+            explicitPathsToArguments: { decrementData: '$[0]' },
+            singleArgumentUnchanged: false,
+        }, ['decrementData']);
+        sideEffects?.onError?.(err);
+        throw transformedError;
+    }
+}
+/**
+ * Adds a set number of items to inventory.
+ *
+ *
+ * The `incrementInventory()` function returns a Promise that is resolved when the specified item's quantity has been updated in the inventory.
+ * @param incrementData - Item or product to increment.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField incrementData
+ * @permissionId WIX_STORES.MODIFY_INVENTORY
+ * @permissionScope Manage Stores - all permissions
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage Products
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @applicableIdentity APP
+ * @fqn wix.inventory.api.v1.InventoryWriteApi.IncrementInventory
+ */
+export async function incrementInventory(incrementData) {
+    // @ts-ignore
+    const { httpClient, sideEffects } = arguments[1];
+    const payload = renameKeysFromSDKRequestToRESTRequest({
+        incrementData: incrementData,
+    });
+    const reqOpts = ambassadorWixStoresV2Inventory.incrementInventory(payload);
+    sideEffects?.onSiteCall?.();
+    try {
+        const result = await httpClient.request(reqOpts);
+        sideEffects?.onSuccess?.(result);
+    }
+    catch (err) {
+        const transformedError = sdkTransformError(err, {
+            spreadPathsToArguments: {},
+            explicitPathsToArguments: { incrementData: '$[0]' },
+            singleArgumentUnchanged: false,
+        }, ['incrementData']);
+        sideEffects?.onError?.(err);
+        throw transformedError;
+    }
+}
+//# sourceMappingURL=stores-v2-inventory-inventory.universal.js.map

package/build/internal/es/src/stores-v2-inventory-inventory.universal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stores-v2-inventory-inventory.universal.js","sourceRoot":"","sources":["../../../../src/stores-v2-inventory-inventory.universal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,IAAI,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACvF,OAAO,EACL,qCAAqC,EACrC,uCAAuC,GACxC,MAAM,yCAAyC,CAAC;AAEjD,OAAO,KAAK,8BAA8B,MAAM,yCAAyC,CAAC;AAyH1F,MAAM,CAAN,IAAY,UASX;AATD,WAAY,UAAU;IACpB,sBAAsB;IACtB,iCAAmB,CAAA;IACnB,qBAAqB;IACrB,6BAAe,CAAA;IACf,yBAAyB;IACzB,+BAAiB,CAAA;IACjB,qCAAqC;IACrC,iEAAmD,CAAA;AACrD,CAAC,EATW,UAAU,KAAV,UAAU,QASrB;AA4HD,MAAM,CAAN,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,KAAnB,mBAAmB,QAM9B;AA6MD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,WAAmB,EACnB,OAAqC;IAIrC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;QACpD,WAAW,EAAE,WAAW;QACxB,UAAU,EAAE,OAAO,EAAE,UAAU;QAC/B,SAAS,EAAE,OAAO,EAAE,SAAS;QAC7B,UAAU,EAAE,OAAO,EAAE,UAAU;KAChC,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,8BAA8B,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;IAE7E,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE;gBACxB,WAAW,EAAE,MAAM;gBACnB,UAAU,EAAE,iBAAiB;gBAC7B,SAAS,EAAE,gBAAgB;gBAC3B,UAAU,EAAE,iBAAiB;aAC9B;YACD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,aAAa,EAAE,SAAS,CAAC,CAC3B,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAkBD;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,OAA+B;IAE/B,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;QACpD,KAAK,EAAE,OAAO,EAAE,KAAK;KACtB,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,8BAA8B,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IAEvE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE;YACjD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,SAAS,CAAC,CACZ,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAOD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAC3C,SAAwB,EACxB,aAAmD;IAEnD,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;QACpD,aAAa,EAAE,EAAE,GAAG,aAAa,EAAE,SAAS,EAAE,SAAS,EAAE;KAC1D,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,8BAA8B,CAAC,uBAAuB,CAAC,OAAO,CAAC,CAAC;IAElE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE,aAAa,EAAE,MAAM,EAAE;YACjD,wBAAwB,EAAE,EAAE,yBAAyB,EAAE,MAAM,EAAE;YAC/D,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,WAAW,EAAE,eAAe,CAAC,CAC/B,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAiCD;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,aAA8B;IAE9B,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;QACpD,aAAa,EAAE,aAAa;KAC7B,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,8BAA8B,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;IAE3E,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,aAAa,EAAE,MAAM,EAAE;YACnD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,eAAe,CAAC,CAClB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,aAA8B;IAE9B,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;QACpD,aAAa,EAAE,aAAa;KAC7B,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,8BAA8B,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;IAE3E,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,aAAa,EAAE,MAAM,EAAE;YACnD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,eAAe,CAAC,CAClB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC"}

package/meta/package.json

@@ -0,0 +1,3 @@
+{
+  "main": "../build/cjs/meta.js"
+}

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@wix/auto_sdk_stores_inventory",
+  "version": "1.0.0",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "keywords": [],
+  "sideEffects": false,
+  "main": "./build/cjs/index.js",
+  "types": "./build/es/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./build/es/index.js",
+      "require": "./build/cjs/index.js",
+      "types": "./build/es/index.d.ts"
+    },
+    "./package.json": "./package.json",
+    "./meta": {
+      "import": "./build/es/meta.js",
+      "require": "./build/cjs/meta.js",
+      "types": "./build/es/meta.d.ts"
+    }
+  },
+  "files": [
+    "build",
+    "meta",
+    "service-plugins"
+  ],
+  "dependencies": {
+    "@wix/sdk-runtime": "^0.3.35",
+    "@wix/sdk-types": "^1.12.4"
+  },
+  "devDependencies": {
+    "typescript": "^5.3.2"
+  },
+  "scripts": {
+    "build": "tsc -b tsconfig.json tsconfig.esm.json tsconfig.internal.json tsconfig.internal.esm.json",
+    "test": ":"
+  },
+  "wix": {
+    "artifact": {
+      "artifactId": "auto-sdk-stores-inventory",
+      "groupId": "com.wixpress.public-sdk-dependencies"
+    },
+    "sdkDependency": {
+      "fqdnNamespace": "inventory",
+      "fqdn": "wix.stores.v2.inventory"
+    }
+  },
+  "falconPackageHash": "93ce0774b69fd4ca36b49f9dd7e7a07547385c7f2cdc0c1707f08532"
+}