@wix/auto_sdk_stores_inventory 1.0.86 → 1.0.88

package/build/internal/es/index.typings.d.mts

@@ -68,6 +68,195 @@ interface PreorderInfo {
      */
     limit?: number | null;
 }
+interface UpdateInventoryVariantsRequest {
+    /** Inventory item. */
+    inventoryItem: InventoryItemV2;
+    /** @internal */
+    reason?: ReasonTypeWithLiterals;
+}
+declare enum ReasonType {
+    /** Unknown reason. */
+    UNKNOWN = "UNKNOWN",
+    /** Order related. */
+    ORDER = "ORDER",
+    /** Manual adjustment. */
+    MANUAL = "MANUAL",
+    /** Reverting an inventory change. */
+    REVERT_INVENTORY_CHANGE = "REVERT_INVENTORY_CHANGE"
+}
+/** @enumType */
+type ReasonTypeWithLiterals = ReasonType | 'UNKNOWN' | 'ORDER' | 'MANUAL' | 'REVERT_INVENTORY_CHANGE';
+interface UpdateInventoryVariantsResponse {
+}
+interface BulkUpdateInventoryVariantsRequest extends BulkUpdateInventoryVariantsRequestActionOneOf {
+    /** Change availability. */
+    setInStock?: boolean | null;
+    /** Set new quantity. */
+    setQuantity?: number | null;
+    /**
+     * Number to increment inventory by.
+     * @min 1
+     */
+    incrementBy?: number | null;
+    /**
+     * Number to decrement inventory by.
+     * @min 1
+     */
+    decrementBy?: number | null;
+    /** Variants filter. Learn more about [API query language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language). */
+    filter?: Record<string, any> | null;
+    /** @internal */
+    reason?: ReasonTypeWithLiterals;
+    /** @internal */
+    changeTrackingMethod?: boolean;
+}
+/** @oneof */
+interface BulkUpdateInventoryVariantsRequestActionOneOf {
+    /** Change availability. */
+    setInStock?: boolean | null;
+    /** Set new quantity. */
+    setQuantity?: number | null;
+    /**
+     * Number to increment inventory by.
+     * @min 1
+     */
+    incrementBy?: number | null;
+    /**
+     * Number to decrement inventory by.
+     * @min 1
+     */
+    decrementBy?: number | null;
+}
+interface BulkUpdateInventoryVariantsResponse {
+}
+interface BulkUpdateInventoryItemsRequest {
+    /** Variants filter */
+    variantsFilter?: Record<string, any> | null;
+    /** Whether inventory is being tracked. */
+    trackInventory?: boolean | null;
+}
+interface BulkUpdateInventoryItemsResponse {
+}
+interface DecrementInventoryRequest {
+    /**
+     * Item or product to decrement.
+     * @minSize 1
+     * @maxSize 300
+     */
+    decrementData?: DecrementData[];
+    /** @internal */
+    reason?: ReasonTypeWithLiterals;
+    /** @internal */
+    restrictInventoryValue?: boolean;
+}
+interface DecrementData extends DecrementDataIdOneOf {
+    /**
+     * Inventory item ID.
+     * @maxLength 36
+     */
+    inventoryId?: string;
+    /**
+     * @internal
+     * @internal
+     * @maxLength 36
+     * @deprecated Deprecated: use productId.
+     * @replacedBy product_id
+     * @targetRemovalDate 2024-12-31
+     */
+    externalId?: string;
+    /**
+     * Product ID.
+     * @maxLength 36
+     */
+    productId?: string;
+    /**
+     * Variant ID.
+     * @format GUID
+     */
+    variantId?: string;
+    /**
+     * Number to decrement inventory by.
+     * @min 1
+     */
+    decrementBy?: number;
+    /**
+     * Whether the request to decrement the item's inventory was made as part of a purchase that includes preorder items.
+     * If true and the item is available for preorder, we allow negative inventory.
+     * If false and the item is not available for preorder, we allow regular buy flow (no negative inventory).
+     */
+    preorderRequest?: boolean;
+}
+/** @oneof */
+interface DecrementDataIdOneOf {
+    /**
+     * Inventory item ID.
+     * @maxLength 36
+     */
+    inventoryId?: string;
+    /**
+     * @internal
+     * @internal
+     * @maxLength 36
+     * @deprecated Deprecated: use productId.
+     * @replacedBy product_id
+     * @targetRemovalDate 2024-12-31
+     */
+    externalId?: string;
+    /**
+     * Product ID.
+     * @maxLength 36
+     */
+    productId?: string;
+}
+interface DecrementInventoryResponse {
+}
+interface IncrementInventoryRequest {
+    /**
+     * Item or product to increment.
+     * @minSize 1
+     * @maxSize 300
+     */
+    incrementData?: IncrementData[];
+    /** @internal */
+    reason?: ReasonTypeWithLiterals;
+}
+interface IncrementData extends IncrementDataIdOneOf {
+    /**
+     * Inventory item ID.
+     * @maxLength 36
+     */
+    inventoryId?: string;
+    /**
+     * Product ID.
+     * @maxLength 36
+     */
+    productId?: string;
+    /**
+     * Variant ID.
+     * @format GUID
+     */
+    variantId?: string;
+    /**
+     * Number to increment inventory by.
+     * @min 1
+     */
+    incrementBy?: number;
+}
+/** @oneof */
+interface IncrementDataIdOneOf {
+    /**
+     * Inventory item ID.
+     * @maxLength 36
+     */
+    inventoryId?: string;
+    /**
+     * Product ID.
+     * @maxLength 36
+     */
+    productId?: string;
+}
+interface IncrementInventoryResponse {
+}
 interface InventoryItemChanged {
     /** Inventory item ID. */
     inventoryItemId?: string;
@@ -129,18 +318,6 @@ interface ChangedInventoryVariantData {
     /** Whether the variant is available for preorder. When `true`, the variant is out of stock and preorder is enabled on inventory level. */
     availableForPreorder?: boolean;
 }
-declare enum ReasonType {
-    /** Unknown reason. */
-    UNKNOWN = "UNKNOWN",
-    /** Order related. */
-    ORDER = "ORDER",
-    /** Manual adjustment. */
-    MANUAL = "MANUAL",
-    /** Reverting an inventory change. */
-    REVERT_INVENTORY_CHANGE = "REVERT_INVENTORY_CHANGE"
-}
-/** @enumType */
-type ReasonTypeWithLiterals = ReasonType | 'UNKNOWN' | 'ORDER' | 'MANUAL' | 'REVERT_INVENTORY_CHANGE';
 interface GetInventoryVariantsRequest extends GetInventoryVariantsRequestIdOneOf {
     /** Inventory item ID. */
     inventoryId: string;
@@ -310,183 +487,6 @@ interface AccountInfo {
      */
     siteId?: string | null;
 }
-interface UpdateInventoryVariantsRequest {
-    /** Inventory item. */
-    inventoryItem: InventoryItemV2;
-    /** @internal */
-    reason?: ReasonTypeWithLiterals;
-}
-interface UpdateInventoryVariantsResponse {
-}
-interface BulkUpdateInventoryVariantsRequest extends BulkUpdateInventoryVariantsRequestActionOneOf {
-    /** Change availability. */
-    setInStock?: boolean | null;
-    /** Set new quantity. */
-    setQuantity?: number | null;
-    /**
-     * Number to increment inventory by.
-     * @min 1
-     */
-    incrementBy?: number | null;
-    /**
-     * Number to decrement inventory by.
-     * @min 1
-     */
-    decrementBy?: number | null;
-    /** Variants filter. Learn more about [API query language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language). */
-    filter?: Record<string, any> | null;
-    /** @internal */
-    reason?: ReasonTypeWithLiterals;
-    /** @internal */
-    changeTrackingMethod?: boolean;
-}
-/** @oneof */
-interface BulkUpdateInventoryVariantsRequestActionOneOf {
-    /** Change availability. */
-    setInStock?: boolean | null;
-    /** Set new quantity. */
-    setQuantity?: number | null;
-    /**
-     * Number to increment inventory by.
-     * @min 1
-     */
-    incrementBy?: number | null;
-    /**
-     * Number to decrement inventory by.
-     * @min 1
-     */
-    decrementBy?: number | null;
-}
-interface BulkUpdateInventoryVariantsResponse {
-}
-interface BulkUpdateInventoryItemsRequest {
-    /** Variants filter */
-    variantsFilter?: Record<string, any> | null;
-    /** Whether inventory is being tracked. */
-    trackInventory?: boolean | null;
-}
-interface BulkUpdateInventoryItemsResponse {
-}
-interface DecrementInventoryRequest {
-    /**
-     * Item or product to decrement.
-     * @minSize 1
-     * @maxSize 300
-     */
-    decrementData?: DecrementData[];
-    /** @internal */
-    reason?: ReasonTypeWithLiterals;
-    /** @internal */
-    restrictInventoryValue?: boolean;
-}
-interface DecrementData extends DecrementDataIdOneOf {
-    /**
-     * Inventory item ID.
-     * @maxLength 36
-     */
-    inventoryId?: string;
-    /**
-     * @internal
-     * @internal
-     * @maxLength 36
-     * @deprecated Deprecated: use productId.
-     * @replacedBy product_id
-     * @targetRemovalDate 2024-12-31
-     */
-    externalId?: string;
-    /**
-     * Product ID.
-     * @maxLength 36
-     */
-    productId?: string;
-    /**
-     * Variant ID.
-     * @format GUID
-     */
-    variantId?: string;
-    /**
-     * Number to decrement inventory by.
-     * @min 1
-     */
-    decrementBy?: number;
-    /**
-     * Whether the request to decrement the item's inventory was made as part of a purchase that includes preorder items.
-     * If true and the item is available for preorder, we allow negative inventory.
-     * If false and the item is not available for preorder, we allow regular buy flow (no negative inventory).
-     */
-    preorderRequest?: boolean;
-}
-/** @oneof */
-interface DecrementDataIdOneOf {
-    /**
-     * Inventory item ID.
-     * @maxLength 36
-     */
-    inventoryId?: string;
-    /**
-     * @internal
-     * @internal
-     * @maxLength 36
-     * @deprecated Deprecated: use productId.
-     * @replacedBy product_id
-     * @targetRemovalDate 2024-12-31
-     */
-    externalId?: string;
-    /**
-     * Product ID.
-     * @maxLength 36
-     */
-    productId?: string;
-}
-interface DecrementInventoryResponse {
-}
-interface IncrementInventoryRequest {
-    /**
-     * Item or product to increment.
-     * @minSize 1
-     * @maxSize 300
-     */
-    incrementData?: IncrementData[];
-    /** @internal */
-    reason?: ReasonTypeWithLiterals;
-}
-interface IncrementData extends IncrementDataIdOneOf {
-    /**
-     * Inventory item ID.
-     * @maxLength 36
-     */
-    inventoryId?: string;
-    /**
-     * Product ID.
-     * @maxLength 36
-     */
-    productId?: string;
-    /**
-     * Variant ID.
-     * @format GUID
-     */
-    variantId?: string;
-    /**
-     * Number to increment inventory by.
-     * @min 1
-     */
-    incrementBy?: number;
-}
-/** @oneof */
-interface IncrementDataIdOneOf {
-    /**
-     * Inventory item ID.
-     * @maxLength 36
-     */
-    inventoryId?: string;
-    /**
-     * Product ID.
-     * @maxLength 36
-     */
-    productId?: string;
-}
-interface IncrementInventoryResponse {
-}
 interface BaseEventMetadata {
     /**
      * App instance ID.
@@ -549,59 +549,6 @@ interface InventoryVariantsChangedEnvelope {
  * @slug inventory_variants_changed
  */
 declare function onInventoryVariantsChanged(handler: (event: InventoryVariantsChangedEnvelope) => void | Promise<void>): void;
-/**
- * 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
- * @applicableIdentity APP
- * @fqn wix.inventory.api.v1.InventoryReadApi.GetInventoryVariants
- */
-declare function getInventoryVariants(inventoryId: string, options?: GetInventoryVariantsOptions): Promise<NonNullablePaths<GetInventoryVariantsResponse, `inventoryItem.variants` | `inventoryItem.variants.${number}.variantId` | `inventoryItem.variants.${number}.availableForPreorder` | `inventoryItem.numericId` | `inventoryItem.preorderInfo.enabled`, 3>>;
-interface GetInventoryVariantsOptions extends GetInventoryVariantsOptionsIdOneOf {
-    /**
-     * @internal
-     * @internal
-     * @deprecated Deprecated (use productID instead).
-     * @replacedBy product_id
-     * @targetRemovalDate 2024-12-31
-     */
-    externalId?: string;
-    /** Product ID. */
-    productId?: string;
-    /** Variant IDs to query for this inventory item (optional). */
-    variantIds?: string[];
-}
-/** @oneof */
-interface GetInventoryVariantsOptionsIdOneOf {
-    /** Inventory item ID. */
-    inventoryId?: string;
-    /**
-     * @internal
-     * @deprecated Deprecated (use productID instead).
-     * @replacedBy product_id
-     * @targetRemovalDate 2024-12-31
-     */
-    externalId?: string;
-    /** Product ID. */
-    productId?: string;
-}
-/**
- * Returns a list of inventory items, given the provided paging, sorting and filtering.
- * @public
- * @permissionId WIX_STORES.READ_INVENTORY
- * @applicableIdentity APP
- * @fqn wix.inventory.api.v1.InventoryReadApi.QueryInventory
- */
-declare function queryInventory(options?: QueryInventoryOptions): Promise<NonNullablePaths<QueryInventoryResponse, `inventoryItems` | `inventoryItems.${number}.numericId` | `inventoryItems.${number}.preorderInfo.enabled` | `metadata.items` | `metadata.offset` | `totalResults`, 3>>;
-interface QueryInventoryOptions {
-    /** Information about paging, filters, sorting. */
-    query?: Query;
-}
 /**
  * Updates product inventory, including total quantity, whether the product is in stock, and whether the product inventory is tracked.
  *
@@ -678,5 +625,58 @@ declare function decrementInventory(decrementData: DecrementData[]): Promise<voi
  * @fqn wix.inventory.api.v1.InventoryWriteApi.IncrementInventory
  */
 declare function incrementInventory(incrementData: IncrementData[]): Promise<void>;
+/**
+ * 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
+ * @applicableIdentity APP
+ * @fqn wix.inventory.api.v1.InventoryReadApi.GetInventoryVariants
+ */
+declare function getInventoryVariants(inventoryId: string, options?: GetInventoryVariantsOptions): Promise<NonNullablePaths<GetInventoryVariantsResponse, `inventoryItem.variants` | `inventoryItem.variants.${number}.variantId` | `inventoryItem.variants.${number}.availableForPreorder` | `inventoryItem.numericId` | `inventoryItem.preorderInfo.enabled`, 3>>;
+interface GetInventoryVariantsOptions extends GetInventoryVariantsOptionsIdOneOf {
+    /**
+     * @internal
+     * @internal
+     * @deprecated Deprecated (use productID instead).
+     * @replacedBy product_id
+     * @targetRemovalDate 2024-12-31
+     */
+    externalId?: string;
+    /** Product ID. */
+    productId?: string;
+    /** Variant IDs to query for this inventory item (optional). */
+    variantIds?: string[];
+}
+/** @oneof */
+interface GetInventoryVariantsOptionsIdOneOf {
+    /** Inventory item ID. */
+    inventoryId?: string;
+    /**
+     * @internal
+     * @deprecated Deprecated (use productID instead).
+     * @replacedBy product_id
+     * @targetRemovalDate 2024-12-31
+     */
+    externalId?: string;
+    /** Product ID. */
+    productId?: string;
+}
+/**
+ * Returns a list of inventory items, given the provided paging, sorting and filtering.
+ * @public
+ * @permissionId WIX_STORES.READ_INVENTORY
+ * @applicableIdentity APP
+ * @fqn wix.inventory.api.v1.InventoryReadApi.QueryInventory
+ */
+declare function queryInventory(options?: QueryInventoryOptions): Promise<NonNullablePaths<QueryInventoryResponse, `inventoryItems` | `inventoryItems.${number}.numericId` | `inventoryItems.${number}.preorderInfo.enabled` | `metadata.items` | `metadata.offset` | `totalResults`, 3>>;
+interface QueryInventoryOptions {
+    /** Information about paging, filters, sorting. */
+    query?: Query;
+}
 
 export { type AccountInfo, type BaseEventMetadata, type BulkUpdateInventoryItemsRequest, type BulkUpdateInventoryItemsResponse, type BulkUpdateInventoryVariantsRequest, type BulkUpdateInventoryVariantsRequestActionOneOf, type BulkUpdateInventoryVariantsResponse, type ChangedInventoryVariant, type ChangedInventoryVariantData, type DecrementData, type DecrementDataIdOneOf, type DecrementInventoryRequest, type DecrementInventoryResponse, type GetInventoryItemsRequest, type GetInventoryItemsResponse, type GetInventoryVariantsOptions, type GetInventoryVariantsOptionsIdOneOf, type GetInventoryVariantsRequest, type GetInventoryVariantsRequestIdOneOf, type GetInventoryVariantsResponse, type IdentificationData, type IdentificationDataIdOneOf, type IncrementData, type IncrementDataIdOneOf, type IncrementInventoryRequest, type IncrementInventoryResponse, type InventoryItemChanged, type InventoryItemChangedEnvelope, type InventoryItemV2, type InventoryVariantV2, type InventoryVariantsChanged, type InventoryVariantsChangedEnvelope, type MessageEnvelope, type Paging, type PagingMetadata, type PreorderInfo, type Query, type QueryInventoryOptions, type QueryInventoryRequest, type QueryInventoryResponse, ReasonType, type ReasonTypeWithLiterals, type UpdateInventoryVariantsInventoryItem, type UpdateInventoryVariantsRequest, type UpdateInventoryVariantsResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, decrementInventory, getInventoryVariants, incrementInventory, onInventoryItemChanged, onInventoryVariantsChanged, queryInventory, updateInventoryVariants };