@wix/auto_sdk_stores_inventory 1.0.11 → 1.0.13

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

@@ -1,683 +0,0 @@
-import { NonNullablePaths } from '@wix/sdk-types';
-export interface InventoryItemV2 {
-    /** Inventory item ID. */
-    _id?: string | null;
-    /**
-     * @internal
-     * @internal
-     * @readonly
-     * @deprecated Deprecated: use productId.
-     * @replacedBy product_id
-     * @targetRemovalDate 2024-12-31
-     */
-    externalId?: string | null;
-    /**
-     * Product ID.
-     * @readonly
-     */
-    productId?: string | null;
-    /** Whether quantity is being tracked. */
-    trackQuantity?: boolean | null;
-    /** Variants associated with this inventory item. */
-    variants?: InventoryVariantV2[];
-    /**
-     * Last updated timestamp.
-     * @readonly
-     */
-    lastUpdated?: Date | null;
-    /**
-     * Inventory’s unique numeric ID (assigned in ascending order).
-     * Primarily for sorting and filtering when crawling all inventories.
-     * @readonly
-     */
-    numericId?: string;
-    /** Preorder information. */
-    preorderInfo?: PreorderInfo;
-}
-export interface InventoryVariantV2 {
-    /** Variant ID. */
-    variantId?: string;
-    /** Whether the product is listed as in stock. */
-    inStock?: boolean | null;
-    /** Quantity currently left in inventory. */
-    quantity?: number | null;
-    /**
-     * Whether the variant is available for preorder. When `true`, the variant is out of stock and preorder is enabled on inventory level.
-     * @readonly
-     */
-    availableForPreorder?: boolean;
-}
-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.
-     * @minLength 1
-     * @maxLength 250
-     */
-    message?: string | null;
-    /**
-     * 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"
-}
-/** @enumType */
-export type ReasonTypeWithLiterals = ReasonType | 'UNKNOWN' | 'ORDER' | 'MANUAL' | '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;
-    /**
-     * @internal
-     * @internal
-     * @deprecated Deprecated: use productId.
-     * @replacedBy product_id
-     * @targetRemovalDate 2024-12-31
-     */
-    externalId?: string;
-    /** Product ID. */
-    productId?: string;
-    /** Whether inventory is being tracked. */
-    trackInventory?: boolean;
-    /** Preorder information. */
-    preorderInfo?: PreorderInfo;
-    /** Field mask of updated fields. */
-    fieldMask?: string[];
-    /** Date and time the inventory item was last updated. */
-    _updatedDate?: Date | null;
-}
-export interface InventoryVariantsChanged {
-    /** Inventory item ID. */
-    inventoryItemId?: string;
-    /**
-     * @internal
-     * @internal
-     * @deprecated Deprecated: use productId.
-     * @replacedBy product_id
-     * @targetRemovalDate 2024-12-31
-     */
-    externalId?: string;
-    /** Product ID. */
-    productId?: string;
-    /** Information about changed variants. */
-    variants?: ChangedInventoryVariant[];
-    /** Date and time the inventory variant item was last updated. */
-    _updatedDate?: Date | null;
-}
-export interface ChangedInventoryVariant {
-    /** Variant ID. */
-    _id?: string;
-    /** Previous inventory variant data. */
-    oldValue?: ChangedInventoryVariantData;
-    /** Current inventory variant data. */
-    newValue?: ChangedInventoryVariantData;
-}
-export interface ChangedInventoryVariantData {
-    /** Inventory variant quantity. */
-    quantity?: number | null;
-    /** Whether the product variant is in stock. */
-    inStock?: boolean;
-    /** 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 interface GetInventoryVariantsRequest extends GetInventoryVariantsRequestIdOneOf {
-    /** Inventory item ID. */
-    inventoryId: string;
-    /**
-     * @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 */
-export interface GetInventoryVariantsRequestIdOneOf {
-    /** Inventory item ID. */
-    inventoryId?: string;
-    /**
-     * @internal
-     * @internal
-     * @deprecated Deprecated (use productID instead).
-     * @replacedBy product_id
-     * @targetRemovalDate 2024-12-31
-     */
-    externalId?: string;
-    /** Product ID. */
-    productId?: string;
-}
-export interface GetInventoryVariantsResponse {
-    /** Inventory item. */
-    inventoryItem?: InventoryItemV2;
-}
-export interface GetInventoryItemsRequest {
-    /** Product IDs */
-    productIds?: string[];
-}
-export interface GetInventoryItemsResponse {
-    /** Inventory items. */
-    inventoryItems?: InventoryItemV2[];
-}
-export interface QueryInventoryRequest {
-    /** Information about paging, filters, sorting. */
-    query?: Query;
-}
-export interface Query {
-    /** Paging options to limit and skip the number of items. */
-    paging?: Paging;
-    /** Filter string */
-    filter?: string | null;
-    /** Sort string */
-    sort?: string | null;
-}
-export interface Paging {
-    /**
-     * 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;
-}
-export interface QueryInventoryResponse {
-    /** Inventory items. */
-    inventoryItems?: InventoryItemV2[];
-    /** Display metadata. */
-    metadata?: PagingMetadata;
-    /** Number of total results. */
-    totalResults?: number;
-}
-export interface PagingMetadata {
-    /** Amount of items to load per page */
-    items?: number;
-    /** Number of items to skip in the display (relevant for all pages after the first) */
-    offset?: number;
-}
-export interface MessageEnvelope {
-    /**
-     * App instance ID.
-     * @format GUID
-     */
-    instanceId?: string | null;
-    /**
-     * Event type.
-     * @maxLength 150
-     */
-    eventType?: string;
-    /** The identification type and identity data. */
-    identity?: IdentificationData;
-    /** Stringify payload. */
-    data?: string;
-}
-export interface IdentificationData extends IdentificationDataIdOneOf {
-    /**
-     * 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.
-     * @format GUID
-     */
-    memberId?: string;
-    /**
-     * ID of a Wix user (site owner, contributor, etc.).
-     * @format GUID
-     */
-    wixUserId?: string;
-    /**
-     * ID of an app.
-     * @format GUID
-     */
-    appId?: string;
-    /** @readonly */
-    identityType?: WebhookIdentityTypeWithLiterals;
-}
-/** @oneof */
-export interface IdentificationDataIdOneOf {
-    /**
-     * 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.
-     * @format GUID
-     */
-    memberId?: string;
-    /**
-     * ID of a Wix user (site owner, contributor, etc.).
-     * @format GUID
-     */
-    wixUserId?: string;
-    /**
-     * ID of an app.
-     * @format GUID
-     */
-    appId?: string;
-}
-export declare enum WebhookIdentityType {
-    UNKNOWN = "UNKNOWN",
-    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
-    MEMBER = "MEMBER",
-    WIX_USER = "WIX_USER",
-    APP = "APP"
-}
-/** @enumType */
-export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
-export interface BaseEventMetadata {
-    /**
-     * App instance ID.
-     * @format GUID
-     */
-    instanceId?: string | null;
-    /**
-     * Event type.
-     * @maxLength 150
-     */
-    eventType?: string;
-    /** The identification type and identity data. */
-    identity?: IdentificationData;
-}
-export interface InventoryItemChangedEnvelope {
-    data: InventoryItemChanged;
-    metadata: BaseEventMetadata;
-}
-/**
- * Triggered when an inventory item is changed.
- * @permissionScope Manage Stores - all permissions
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
- * @permissionScope Manage Stores
- * @permissionScopeId SCOPE.STORES.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
- * @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 {
-    data: InventoryVariantsChanged;
-    metadata: BaseEventMetadata;
-}
-/**
- * Triggered when inventory variants are changed.
- * @permissionScope Manage Stores - all permissions
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
- * @permissionScope Manage Stores
- * @permissionScopeId SCOPE.STORES.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
- * @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;
-type InventoryNonNullablePaths = `variants` | `variants.${number}.variantId` | `variants.${number}.availableForPreorder` | `numericId` | `preorderInfo.enabled`;
-/**
- * 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 Stores
- * @permissionScopeId SCOPE.STORES.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 declare function updateInventoryVariants(productId: string, inventoryItem: UpdateInventoryVariantsInventoryItem): Promise<void>;
-export interface UpdateInventoryVariantsInventoryItem {
-    /** Inventory item ID. */
-    _id?: string | null;
-    /**
-     * @internal
-     * @internal
-     * @readonly
-     * @deprecated Deprecated: use productId.
-     * @replacedBy product_id
-     * @targetRemovalDate 2024-12-31
-     */
-    externalId?: string | null;
-    /** Whether quantity is being tracked. */
-    trackQuantity?: boolean | null;
-    /** Variants associated with this inventory item. */
-    variants?: InventoryVariantV2[];
-    /**
-     * Last updated timestamp.
-     * @readonly
-     */
-    lastUpdated?: Date | null;
-    /**
-     * Inventory’s unique numeric ID (assigned in ascending order).
-     * Primarily for sorting and filtering when crawling all inventories.
-     * @readonly
-     */
-    numericId?: string;
-    /** Preorder information. */
-    preorderInfo?: PreorderInfo;
-}
-/**
- * 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
- * @requiredField decrementData
- * @permissionId WIX_STORES.MODIFY_INVENTORY
- * @permissionScope Manage Stores - all permissions
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
- * @permissionScope Manage Stores
- * @permissionScopeId SCOPE.STORES.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 declare function decrementInventory(decrementData: DecrementData[]): Promise<void>;
-/**
- * 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
- * @requiredField incrementData
- * @permissionId WIX_STORES.MODIFY_INVENTORY
- * @permissionScope Manage Stores - all permissions
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
- * @permissionScope Manage Stores
- * @permissionScopeId SCOPE.STORES.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 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 Stores
- * @permissionScopeId SCOPE.STORES.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<NonNullablePaths<GetInventoryVariantsResponse, {
-    [P in InventoryNonNullablePaths]: `inventoryItem.${P}`;
-}[InventoryNonNullablePaths]>>;
-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 */
-export 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 Stores
- * @permissionScopeId SCOPE.STORES.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<NonNullablePaths<QueryInventoryResponse, {
-    [P in InventoryNonNullablePaths]: `inventoryItems.${number}.${P}`;
-}[InventoryNonNullablePaths] | `metadata.items` | `metadata.offset` | `totalResults`>>;
-export interface QueryInventoryOptions {
-    /** Information about paging, filters, sorting. */
-    query?: Query;
-}
-export {};