@wix/auto_sdk_stores_inventory 1.0.0 → 1.0.2

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

@@ -49,11 +49,193 @@ export interface InventoryVariantV2 {
 export interface PreorderInfo {
     /** Whether the item is available for preorder. */
     enabled?: boolean;
-    /** A message the buyer will see when the item is out of stock and preorder is enabled. */
+    /**
+     * A message the buyer will see when the item is out of stock and preorder is enabled.
+     * @minLength 1
+     * @maxLength 250
+     */
     message?: string | null;
-    /** Number of products that can be preordered after stock reaches zero. */
+    /**
+     * Number of products that can be preordered after stock reaches zero.
+     * @max 100000
+     */
     limit?: number | null;
 }
+export interface UpdateInventoryVariantsRequest {
+    /** Inventory item. */
+    inventoryItem: InventoryItemV2;
+}
+export 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"
+}
+export interface UpdateInventoryVariantsResponse {
+}
+export 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;
+}
+/** @oneof */
+export 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;
+}
+export interface BulkUpdateInventoryVariantsResponse {
+}
+export interface BulkUpdateInventoryItemsRequest {
+    /** Variants filter */
+    variantsFilter?: Record<string, any> | null;
+    /** Whether inventory is being tracked. */
+    trackInventory?: boolean | null;
+}
+export interface BulkUpdateInventoryItemsResponse {
+}
+export interface DecrementInventoryRequest {
+    /**
+     * Item or product to decrement.
+     * @minSize 1
+     * @maxSize 300
+     */
+    decrementData?: DecrementData[];
+}
+export 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 */
+export 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;
+}
+export interface DecrementInventoryResponse {
+}
+export interface IncrementInventoryRequest {
+    /**
+     * Item or product to increment.
+     * @minSize 1
+     * @maxSize 300
+     */
+    incrementData?: IncrementData[];
+}
+export 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 */
+export interface IncrementDataIdOneOf {
+    /**
+     * Inventory item ID.
+     * @maxLength 36
+     */
+    inventoryId?: string;
+    /**
+     * Product ID.
+     * @maxLength 36
+     */
+    productId?: string;
+}
+export interface IncrementInventoryResponse {
+}
 export interface InventoryItemChanged {
     /** Inventory item ID. */
     inventoryItemId?: string;
@@ -110,16 +292,6 @@ export 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;
 }
-export 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"
-}
 export interface GetInventoryVariantsRequest extends GetInventoryVariantsRequestIdOneOf {
     /** Inventory item ID. */
     inventoryId: string;
@@ -176,7 +348,10 @@ export interface Query {
     sort?: string | null;
 }
 export interface Paging {
-    /** Amount of items to load per page */
+    /**
+     * Amount of items to load per page
+     * @max 100
+     */
     limit?: number | null;
     /** Number of items to skip in the display (relevant for all pages after the first) */
     offset?: number | null;
@@ -196,9 +371,15 @@ export interface PagingMetadata {
     offset?: number;
 }
 export interface MessageEnvelope {
-    /** App instance ID. */
+    /**
+     * App instance ID.
+     * @format GUID
+     */
     instanceId?: string | null;
-    /** Event type. */
+    /**
+     * Event type.
+     * @maxLength 150
+     */
     eventType?: string;
     /** The identification type and identity data. */
     identity?: IdentificationData;
@@ -206,26 +387,50 @@ export interface MessageEnvelope {
     data?: string;
 }
 export interface IdentificationData extends IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
     anonymousVisitorId?: string;
-    /** ID of a site visitor that has logged in to the site. */
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
     memberId?: string;
-    /** ID of a Wix user (site owner, contributor, etc.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
     /** @readonly */
     identityType?: WebhookIdentityType;
 }
 /** @oneof */
 export interface IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
     anonymousVisitorId?: string;
-    /** ID of a site visitor that has logged in to the site. */
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
     memberId?: string;
-    /** ID of a Wix user (site owner, contributor, etc.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
 }
 export declare enum WebhookIdentityType {
@@ -235,113 +440,6 @@ export declare enum WebhookIdentityType {
     WIX_USER = "WIX_USER",
     APP = "APP"
 }
-export interface UpdateInventoryVariantsRequest {
-    /** Inventory item. */
-    inventoryItem: InventoryItemV2;
-}
-export interface UpdateInventoryVariantsResponse {
-}
-export interface BulkUpdateInventoryVariantsRequest extends BulkUpdateInventoryVariantsRequestActionOneOf {
-    /** Change availability. */
-    setInStock?: boolean | null;
-    /** Set new quantity. */
-    setQuantity?: number | null;
-    /** Number to increment inventory by. */
-    incrementBy?: number | null;
-    /** Number to decrement inventory by. */
-    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;
-}
-/** @oneof */
-export interface BulkUpdateInventoryVariantsRequestActionOneOf {
-    /** Change availability. */
-    setInStock?: boolean | null;
-    /** Set new quantity. */
-    setQuantity?: number | null;
-    /** Number to increment inventory by. */
-    incrementBy?: number | null;
-    /** Number to decrement inventory by. */
-    decrementBy?: number | null;
-}
-export interface BulkUpdateInventoryVariantsResponse {
-}
-export interface BulkUpdateInventoryItemsRequest {
-    /** Variants filter */
-    variantsFilter?: Record<string, any> | null;
-    /** Whether inventory is being tracked. */
-    trackInventory?: boolean | null;
-}
-export interface BulkUpdateInventoryItemsResponse {
-}
-export interface DecrementInventoryRequest {
-    /** Item or product to decrement. */
-    decrementData?: DecrementData[];
-}
-export interface DecrementData extends DecrementDataIdOneOf {
-    /** Inventory item ID. */
-    inventoryId?: string;
-    /**
-     * @internal
-     * @internal
-     * @deprecated Deprecated: use productId.
-     * @replacedBy product_id
-     * @targetRemovalDate 2024-12-31
-     */
-    externalId?: string;
-    /** Product ID. */
-    productId?: string;
-    /** Variant ID. */
-    variantId?: string;
-    /** Number to decrement inventory by. */
-    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 */
-export interface DecrementDataIdOneOf {
-    /** Inventory item ID. */
-    inventoryId?: string;
-    /**
-     * @internal
-     * @internal
-     * @deprecated Deprecated: use productId.
-     * @replacedBy product_id
-     * @targetRemovalDate 2024-12-31
-     */
-    externalId?: string;
-    /** Product ID. */
-    productId?: string;
-}
-export interface DecrementInventoryResponse {
-}
-export interface IncrementInventoryRequest {
-    /** Item or product to increment. */
-    incrementData?: IncrementData[];
-}
-export interface IncrementData extends IncrementDataIdOneOf {
-    /** Inventory item ID. */
-    inventoryId?: string;
-    /** Product ID. */
-    productId?: string;
-    /** Variant ID. */
-    variantId?: string;
-    /** Number to increment inventory by. */
-    incrementBy?: number;
-}
-/** @oneof */
-export interface IncrementDataIdOneOf {
-    /** Inventory item ID. */
-    inventoryId?: string;
-    /** Product ID. */
-    productId?: string;
-}
-export interface IncrementInventoryResponse {
-}
 interface InventoryVariantV2NonNullableFields {
     variantId: string;
     availableForPreorder: boolean;
@@ -367,9 +465,15 @@ export interface QueryInventoryResponseNonNullableFields {
     totalResults: number;
 }
 export interface BaseEventMetadata {
-    /** App instance ID. */
+    /**
+     * App instance ID.
+     * @format GUID
+     */
     instanceId?: string | null;
-    /** Event type. */
+    /**
+     * Event type.
+     * @maxLength 150
+     */
     eventType?: string;
     /** The identification type and identity data. */
     identity?: IdentificationData;
@@ -391,6 +495,8 @@ export interface InventoryItemChangedEnvelope {
  * @permissionId WIX_STORES.READ_INVENTORY
  * @webhook
  * @eventType com.wix.ecommerce.inventory.api.v1.InventoryItemChanged
+ * @serviceIdentifier wix.inventory.api.v1.InventoryReadApi
+ * @slug inventory_item_changed
  */
 export declare function onInventoryItemChanged(handler: (event: InventoryItemChangedEnvelope) => void | Promise<void>): void;
 export interface InventoryVariantsChangedEnvelope {
@@ -410,65 +516,10 @@ export interface InventoryVariantsChangedEnvelope {
  * @permissionId WIX_STORES.READ_INVENTORY
  * @webhook
  * @eventType com.wix.ecommerce.inventory.api.v1.InventoryVariantsChanged
+ * @serviceIdentifier wix.inventory.api.v1.InventoryReadApi
+ * @slug inventory_variants_changed
  */
 export 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
- * @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 declare function getInventoryVariants(inventoryId: string, options?: GetInventoryVariantsOptions): Promise<GetInventoryVariantsResponse & GetInventoryVariantsResponseNonNullableFields>;
-export interface GetInventoryVariantsOptions extends GetInventoryVariantsRequestIdOneOf {
-    /**
-     * @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[];
-}
-/**
- * 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 declare function queryInventory(options?: QueryInventoryOptions): Promise<QueryInventoryResponse & QueryInventoryResponseNonNullableFields>;
-export 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.
  *
@@ -560,4 +611,75 @@ export declare function decrementInventory(decrementData: DecrementData[]): Prom
  * @fqn wix.inventory.api.v1.InventoryWriteApi.IncrementInventory
  */
 export 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
+ * @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 declare function getInventoryVariants(inventoryId: string, options?: GetInventoryVariantsOptions): Promise<GetInventoryVariantsResponse & GetInventoryVariantsResponseNonNullableFields>;
+export 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
+ * @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 declare function queryInventory(options?: QueryInventoryOptions): Promise<QueryInventoryResponse & QueryInventoryResponseNonNullableFields>;
+export interface QueryInventoryOptions {
+    /** Information about paging, filters, sorting. */
+    query?: Query;
+}
 export {};