@wix/auto_sdk_stores_inventory 1.0.64 → 1.0.65

package/build/cjs/index.d.ts

@@ -2,7 +2,9 @@ import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTF
 import { GetInventoryVariantsOptions, GetInventoryVariantsResponse, QueryInventoryOptions, QueryInventoryResponse, UpdateInventoryVariantsInventoryItem, DecrementData, IncrementData, InventoryItemChangedEnvelope, InventoryVariantsChangedEnvelope } from './index.typings.js';
 export { AccountInfo, BaseEventMetadata, BulkUpdateInventoryItemsRequest, BulkUpdateInventoryItemsResponse, BulkUpdateInventoryVariantsRequest, BulkUpdateInventoryVariantsRequestActionOneOf, BulkUpdateInventoryVariantsResponse, ChangedInventoryVariant, ChangedInventoryVariantData, DecrementDataIdOneOf, DecrementInventoryRequest, DecrementInventoryResponse, GetInventoryItemsRequest, GetInventoryItemsResponse, GetInventoryVariantsOptionsIdOneOf, GetInventoryVariantsRequest, GetInventoryVariantsRequestIdOneOf, IdentificationData, IdentificationDataIdOneOf, IncrementDataIdOneOf, IncrementInventoryRequest, IncrementInventoryResponse, InventoryItemChanged, InventoryItemV2, InventoryVariantV2, InventoryVariantsChanged, MessageEnvelope, Paging, PagingMetadata, PreorderInfo, Query, QueryInventoryRequest, ReasonType, ReasonTypeWithLiterals, UpdateInventoryVariantsRequest, UpdateInventoryVariantsResponse, WebhookIdentityType, WebhookIdentityTypeWithLiterals } from './index.typings.js';
 
-declare function getInventoryVariants$1(httpClient: HttpClient): GetInventoryVariantsSignature;
+declare function getInventoryVariants$1(httpClient: HttpClient, __options?: {
+    validateRequestSchema?: boolean;
+}): GetInventoryVariantsSignature;
 interface GetInventoryVariantsSignature {
     /**
      * Gets inventory variant information based on the specified option choices.
@@ -13,14 +15,18 @@ interface GetInventoryVariantsSignature {
      */
     (inventoryId: string, options?: GetInventoryVariantsOptions): Promise<NonNullablePaths<GetInventoryVariantsResponse, `inventoryItem.variants` | `inventoryItem.variants.${number}.variantId` | `inventoryItem.variants.${number}.availableForPreorder` | `inventoryItem.numericId` | `inventoryItem.preorderInfo.enabled`, 5>>;
 }
-declare function queryInventory$1(httpClient: HttpClient): QueryInventorySignature;
+declare function queryInventory$1(httpClient: HttpClient, __options?: {
+    validateRequestSchema?: boolean;
+}): QueryInventorySignature;
 interface QueryInventorySignature {
     /**
      * Returns a list of inventory items, given the provided paging, sorting and filtering.
      */
     (options?: QueryInventoryOptions): Promise<NonNullablePaths<QueryInventoryResponse, `inventoryItems` | `inventoryItems.${number}.numericId` | `inventoryItems.${number}.preorderInfo.enabled` | `metadata.items` | `metadata.offset` | `totalResults`, 5>>;
 }
-declare function updateInventoryVariants$1(httpClient: HttpClient): UpdateInventoryVariantsSignature;
+declare function updateInventoryVariants$1(httpClient: HttpClient, __options?: {
+    validateRequestSchema?: boolean;
+}): UpdateInventoryVariantsSignature;
 interface UpdateInventoryVariantsSignature {
     /**
      * Updates product inventory, including total quantity, whether the product is in stock, and whether the product inventory is tracked.
@@ -32,7 +38,9 @@ interface UpdateInventoryVariantsSignature {
      */
     (productId: string, inventoryItem: UpdateInventoryVariantsInventoryItem): Promise<void>;
 }
-declare function decrementInventory$1(httpClient: HttpClient): DecrementInventorySignature;
+declare function decrementInventory$1(httpClient: HttpClient, __options?: {
+    validateRequestSchema?: boolean;
+}): DecrementInventorySignature;
 interface DecrementInventorySignature {
     /**
      * Subtracts a set number of items from inventory.
@@ -43,7 +51,9 @@ interface DecrementInventorySignature {
      */
     (decrementData: DecrementData[]): Promise<void>;
 }
-declare function incrementInventory$1(httpClient: HttpClient): IncrementInventorySignature;
+declare function incrementInventory$1(httpClient: HttpClient, __options?: {
+    validateRequestSchema?: boolean;
+}): IncrementInventorySignature;
 interface IncrementInventorySignature {
     /**
      * Adds a set number of items to inventory.

package/build/cjs/index.js

@@ -1,7 +1,9 @@
 "use strict";
+var __create = Object.create;
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
 var __export = (target, all) => {
   for (var name in all)
@@ -15,6 +17,14 @@ var __copyProps = (to, from, except, desc) => {
   }
   return to;
 };
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // index.ts
@@ -317,6 +327,222 @@ function incrementInventory(payload) {
   return __incrementInventory;
 }
 
+// src/stores-v2-inventory-inventory.schemas.ts
+var z = __toESM(require("zod"));
+var GetInventoryVariantsRequest = z.object({
+  inventoryId: z.string().describe("Inventory item ID."),
+  options: z.intersection(
+    z.object({ variantIds: z.array(z.string()).optional() }),
+    z.xor([
+      z.object({
+        inventoryId: z.never().optional(),
+        externalId: z.never().optional(),
+        productId: z.never().optional()
+      }),
+      z.object({
+        externalId: z.never().optional(),
+        productId: z.never().optional(),
+        inventoryId: z.string().describe("Inventory item ID.")
+      }),
+      z.object({
+        inventoryId: z.never().optional(),
+        productId: z.never().optional(),
+        externalId: z.string().describe("Deprecated (use productID instead).")
+      }),
+      z.object({
+        inventoryId: z.never().optional(),
+        externalId: z.never().optional(),
+        productId: z.string().describe("Product ID.")
+      })
+    ])
+  ).optional()
+});
+var GetInventoryVariantsResponse = z.object({
+  inventoryItem: z.object({
+    _id: z.string().describe("Inventory item ID.").optional().nullable(),
+    externalId: z.string().describe("Deprecated: use productId.").optional().nullable(),
+    productId: z.string().describe("Product ID.").optional().nullable(),
+    trackQuantity: z.boolean().describe("Whether quantity is being tracked.").optional().nullable(),
+    variants: z.array(
+      z.object({
+        variantId: z.string().describe("Variant ID.").optional(),
+        inStock: z.boolean().describe("Whether the product is listed as in stock.").optional().nullable(),
+        quantity: z.number().int().describe("Quantity currently left in inventory.").min(0).optional().nullable(),
+        availableForPreorder: z.boolean().describe(
+          "Whether the variant is available for preorder. When `true`, the variant is out of stock and preorder is enabled on inventory level."
+        ).optional()
+      })
+    ).optional(),
+    lastUpdated: z.date().describe("Last updated timestamp.").optional().nullable(),
+    numericId: z.string().regex(/^\d+$/, "Must be a valid UInt64 string").describe(
+      "Inventory\u2019s unique numeric ID (assigned in ascending order).\nPrimarily for sorting and filtering when crawling all inventories."
+    ).optional(),
+    preorderInfo: z.object({
+      enabled: z.boolean().describe("Whether the item is available for preorder.").optional(),
+      message: z.string().describe(
+        "A message the buyer will see when the item is out of stock and preorder is enabled."
+      ).min(1).max(250).optional().nullable(),
+      limit: z.number().int().describe(
+        "Number of products that can be preordered after stock reaches zero."
+      ).min(0).max(1e5).optional().nullable()
+    }).describe("Preorder information.").optional()
+  }).describe("Inventory item.").optional()
+});
+var QueryInventoryRequest = z.object({
+  options: z.object({
+    query: z.object({
+      paging: z.object({
+        limit: z.number().int().describe("Amount of items to load per page").min(0).max(100).optional().nullable(),
+        offset: z.number().int().describe(
+          "Number of items to skip in the display (relevant for all pages after the first)"
+        ).min(0).optional().nullable()
+      }).optional(),
+      filter: z.string().describe("Filter string").optional().nullable(),
+      sort: z.string().describe("Sort string").optional().nullable()
+    }).optional()
+  }).optional()
+});
+var QueryInventoryResponse = z.object({
+  inventoryItems: z.array(
+    z.object({
+      _id: z.string().describe("Inventory item ID.").optional().nullable(),
+      externalId: z.string().describe("Deprecated: use productId.").optional().nullable(),
+      productId: z.string().describe("Product ID.").optional().nullable(),
+      trackQuantity: z.boolean().describe("Whether quantity is being tracked.").optional().nullable(),
+      variants: z.array(
+        z.object({
+          variantId: z.string().describe("Variant ID.").optional(),
+          inStock: z.boolean().describe("Whether the product is listed as in stock.").optional().nullable(),
+          quantity: z.number().int().describe("Quantity currently left in inventory.").min(0).optional().nullable(),
+          availableForPreorder: z.boolean().describe(
+            "Whether the variant is available for preorder. When `true`, the variant is out of stock and preorder is enabled on inventory level."
+          ).optional()
+        })
+      ).optional(),
+      lastUpdated: z.date().describe("Last updated timestamp.").optional().nullable(),
+      numericId: z.string().regex(/^\d+$/, "Must be a valid UInt64 string").describe(
+        "Inventory\u2019s unique numeric ID (assigned in ascending order).\nPrimarily for sorting and filtering when crawling all inventories."
+      ).optional(),
+      preorderInfo: z.object({
+        enabled: z.boolean().describe("Whether the item is available for preorder.").optional(),
+        message: z.string().describe(
+          "A message the buyer will see when the item is out of stock and preorder is enabled."
+        ).min(1).max(250).optional().nullable(),
+        limit: z.number().int().describe(
+          "Number of products that can be preordered after stock reaches zero."
+        ).min(0).max(1e5).optional().nullable()
+      }).describe("Preorder information.").optional()
+    })
+  ).optional(),
+  metadata: z.object({
+    items: z.number().int().describe("Amount of items to load per page").optional(),
+    offset: z.number().int().describe(
+      "Number of items to skip in the display (relevant for all pages after the first)"
+    ).optional()
+  }).describe("Display metadata.").optional(),
+  totalResults: z.number().int().describe("Number of total results.").optional()
+});
+var UpdateInventoryVariantsRequest = z.object({
+  productId: z.string().describe("Product ID."),
+  inventoryItem: z.object({
+    _id: z.string().describe("Inventory item ID.").optional().nullable(),
+    externalId: z.string().describe("Deprecated: use productId.").optional().nullable(),
+    productId: z.string().describe("Product ID.").optional().nullable(),
+    trackQuantity: z.boolean().describe("Whether quantity is being tracked.").optional().nullable(),
+    variants: z.array(
+      z.object({
+        variantId: z.string().describe("Variant ID.").optional(),
+        inStock: z.boolean().describe("Whether the product is listed as in stock.").optional().nullable(),
+        quantity: z.number().int().describe("Quantity currently left in inventory.").min(0).optional().nullable(),
+        availableForPreorder: z.boolean().describe(
+          "Whether the variant is available for preorder. When `true`, the variant is out of stock and preorder is enabled on inventory level."
+        ).optional()
+      })
+    ).optional(),
+    lastUpdated: z.date().describe("Last updated timestamp.").optional().nullable(),
+    numericId: z.string().regex(/^\d+$/, "Must be a valid UInt64 string").describe(
+      "Inventory\u2019s unique numeric ID (assigned in ascending order).\nPrimarily for sorting and filtering when crawling all inventories."
+    ).optional(),
+    preorderInfo: z.object({
+      enabled: z.boolean().describe("Whether the item is available for preorder.").optional(),
+      message: z.string().describe(
+        "A message the buyer will see when the item is out of stock and preorder is enabled."
+      ).min(1).max(250).optional().nullable(),
+      limit: z.number().int().describe(
+        "Number of products that can be preordered after stock reaches zero."
+      ).min(0).max(1e5).optional().nullable()
+    }).describe("Preorder information.").optional()
+  }).describe("Inventory item to update.")
+});
+var UpdateInventoryVariantsResponse = z.object({});
+var DecrementInventoryRequest = z.object({
+  decrementData: z.array(
+    z.intersection(
+      z.object({
+        variantId: z.string().describe("Variant ID.").regex(
+          /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+          "Must be a valid GUID"
+        ).optional(),
+        decrementBy: z.number().int().describe("Number to decrement inventory by.").min(1).optional(),
+        preorderRequest: z.boolean().describe(
+          "Whether the request to decrement the item's inventory was made as part of a purchase that includes preorder items.\nIf true and the item is available for preorder, we allow negative inventory.\nIf false and the item is not available for preorder, we allow regular buy flow (no negative inventory)."
+        ).optional()
+      }),
+      z.xor([
+        z.object({
+          inventoryId: z.never().optional(),
+          externalId: z.never().optional(),
+          productId: z.never().optional()
+        }),
+        z.object({
+          externalId: z.never().optional(),
+          productId: z.never().optional(),
+          inventoryId: z.string().describe("Inventory item ID.").max(36)
+        }),
+        z.object({
+          inventoryId: z.never().optional(),
+          productId: z.never().optional(),
+          externalId: z.string().describe("Deprecated: use productId.").max(36)
+        }),
+        z.object({
+          inventoryId: z.never().optional(),
+          externalId: z.never().optional(),
+          productId: z.string().describe("Product ID.").max(36)
+        })
+      ])
+    )
+  ).min(1).max(300)
+});
+var DecrementInventoryResponse = z.object({});
+var IncrementInventoryRequest = z.object({
+  incrementData: z.array(
+    z.intersection(
+      z.object({
+        variantId: z.string().describe("Variant ID.").regex(
+          /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+          "Must be a valid GUID"
+        ).optional(),
+        incrementBy: z.number().int().describe("Number to increment inventory by.").min(1).optional()
+      }),
+      z.xor([
+        z.object({
+          inventoryId: z.never().optional(),
+          productId: z.never().optional()
+        }),
+        z.object({
+          productId: z.never().optional(),
+          inventoryId: z.string().describe("Inventory item ID.").max(36)
+        }),
+        z.object({
+          inventoryId: z.never().optional(),
+          productId: z.string().describe("Product ID.").max(36)
+        })
+      ])
+    )
+  ).min(1).max(300)
+});
+var IncrementInventoryResponse = z.object({});
+
 // src/stores-v2-inventory-inventory.universal.ts
 var ReasonType = /* @__PURE__ */ ((ReasonType2) => {
   ReasonType2["UNKNOWN"] = "UNKNOWN";
@@ -334,7 +560,10 @@ var WebhookIdentityType = /* @__PURE__ */ ((WebhookIdentityType2) => {
   return WebhookIdentityType2;
 })(WebhookIdentityType || {});
 async function getInventoryVariants2(inventoryId, options) {
-  const { httpClient, sideEffects } = arguments[2];
+  const { httpClient, sideEffects, validateRequestSchema } = arguments[2];
+  if (validateRequestSchema) {
+    GetInventoryVariantsRequest.parse({ inventoryId, options });
+  }
   const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
     inventoryId,
     externalId: options?.externalId,
@@ -367,7 +596,10 @@ async function getInventoryVariants2(inventoryId, options) {
   }
 }
 async function queryInventory2(options) {
-  const { httpClient, sideEffects } = arguments[1];
+  const { httpClient, sideEffects, validateRequestSchema } = arguments[1];
+  if (validateRequestSchema) {
+    QueryInventoryRequest.parse({ options });
+  }
   const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
     query: options?.query
   });
@@ -392,7 +624,10 @@ async function queryInventory2(options) {
   }
 }
 async function updateInventoryVariants2(productId, inventoryItem) {
-  const { httpClient, sideEffects } = arguments[2];
+  const { httpClient, sideEffects, validateRequestSchema } = arguments[2];
+  if (validateRequestSchema) {
+    UpdateInventoryVariantsRequest.parse({ productId, inventoryItem });
+  }
   const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
     inventoryItem: { ...inventoryItem, productId }
   });
@@ -416,7 +651,10 @@ async function updateInventoryVariants2(productId, inventoryItem) {
   }
 }
 async function decrementInventory2(decrementData) {
-  const { httpClient, sideEffects } = arguments[1];
+  const { httpClient, sideEffects, validateRequestSchema } = arguments[1];
+  if (validateRequestSchema) {
+    DecrementInventoryRequest.parse({ decrementData });
+  }
   const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
     decrementData
   });
@@ -440,7 +678,10 @@ async function decrementInventory2(decrementData) {
   }
 }
 async function incrementInventory2(incrementData) {
-  const { httpClient, sideEffects } = arguments[1];
+  const { httpClient, sideEffects, validateRequestSchema } = arguments[1];
+  if (validateRequestSchema) {
+    IncrementInventoryRequest.parse({ incrementData });
+  }
   const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
     incrementData
   });
@@ -465,41 +706,41 @@ async function incrementInventory2(incrementData) {
 }
 
 // src/stores-v2-inventory-inventory.public.ts
-function getInventoryVariants3(httpClient) {
+function getInventoryVariants3(httpClient, __options) {
   return (inventoryId, options) => getInventoryVariants2(
     inventoryId,
     options,
     // @ts-ignore
-    { httpClient }
+    { httpClient, validateRequestSchema: __options?.validateRequestSchema }
   );
 }
-function queryInventory3(httpClient) {
+function queryInventory3(httpClient, __options) {
   return (options) => queryInventory2(
     options,
     // @ts-ignore
-    { httpClient }
+    { httpClient, validateRequestSchema: __options?.validateRequestSchema }
   );
 }
-function updateInventoryVariants3(httpClient) {
+function updateInventoryVariants3(httpClient, __options) {
   return (productId, inventoryItem) => updateInventoryVariants2(
     productId,
     inventoryItem,
     // @ts-ignore
-    { httpClient }
+    { httpClient, validateRequestSchema: __options?.validateRequestSchema }
   );
 }
-function decrementInventory3(httpClient) {
+function decrementInventory3(httpClient, __options) {
   return (decrementData) => decrementInventory2(
     decrementData,
     // @ts-ignore
-    { httpClient }
+    { httpClient, validateRequestSchema: __options?.validateRequestSchema }
   );
 }
-function incrementInventory3(httpClient) {
+function incrementInventory3(httpClient, __options) {
   return (incrementData) => incrementInventory2(
     incrementData,
     // @ts-ignore
-    { httpClient }
+    { httpClient, validateRequestSchema: __options?.validateRequestSchema }
   );
 }
 var onInventoryItemChanged = (0, import_sdk_types.EventDefinition)(