@wix/stores 1.0.134 → 1.0.136

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

@@ -1,425 +0,0 @@
-import { EventDefinition } from '@wix/sdk-types';
-export interface InventoryItemV2 {
-    /** Inventory item ID. */
-    _id?: string | null;
-    /**
-     * @internal
-     * @internal
-     * @readonly
-     */
-    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;
-    /**
-     * 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. */
-    message?: string | null;
-    /** Number of products that can be preordered after stock reaches zero. */
-    limit?: number | null;
-}
-export interface InventoryItemChanged {
-    /** Inventory item ID. */
-    inventoryItemId?: string;
-    /**
-     * @internal
-     * @internal */
-    externalId?: string;
-    /** Product ID. */
-    productId?: string;
-    /** Whether inventory is being tracked. */
-    trackInventory?: boolean;
-    /** Preorder information. */
-    preorderInfo?: PreorderInfo;
-    /** Date and time the inventory item was last updated. */
-    _updatedDate?: Date;
-}
-export interface InventoryVariantsChanged {
-    /** Inventory item ID. */
-    inventoryItemId?: string;
-    /**
-     * @internal
-     * @internal */
-    externalId?: string;
-    /** Product ID. */
-    productId?: string;
-    /** Information about changed variants. */
-    variants?: ChangedInventoryVariant[];
-    /** Date and time the inventory variant item was last updated. */
-    _updatedDate?: Date;
-}
-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 declare enum ReasonType {
-    UNKNOWN = "UNKNOWN",
-    ORDER = "ORDER",
-    MANUAL = "MANUAL",
-    REVERT_INVENTORY_CHANGE = "REVERT_INVENTORY_CHANGE"
-}
-export interface GetInventoryVariantsRequest extends GetInventoryVariantsRequestIdOneOf {
-    /** Inventory item ID. */
-    inventoryId: string;
-    /**
-     * @internal
-     * @internal */
-    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 */
-    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 */
-    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 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. See documentation [here](https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_defining-in-protobuf) */
-    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 */
-    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 */
-    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 {
-}
-export interface GetInventoryVariantsResponseNonNullableFields {
-    inventoryItem?: {
-        variants: {
-            variantId: string;
-            availableForPreorder: boolean;
-        }[];
-        numericId: string;
-        preorderInfo?: {
-            enabled: boolean;
-        };
-    };
-}
-export interface QueryInventoryResponseNonNullableFields {
-    inventoryItems: {
-        variants: {
-            variantId: string;
-            availableForPreorder: boolean;
-        }[];
-        numericId: string;
-        preorderInfo?: {
-            enabled: boolean;
-        };
-    }[];
-    metadata?: {
-        items: number;
-        offset: number;
-    };
-    totalResults: number;
-}
-export declare const onInventoryItemChanged: EventDefinition<InventoryItemChanged, "com.wix.ecommerce.inventory.api.v1.InventoryItemChanged">;
-export declare const onInventoryVariantsChanged: EventDefinition<InventoryVariantsChanged, "com.wix.ecommerce.inventory.api.v1.InventoryVariantsChanged">;
-/**
- * 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
- * @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
- */
-export declare function getInventoryVariants(inventoryId: string, options?: GetInventoryVariantsOptions): Promise<GetInventoryVariantsResponse & GetInventoryVariantsResponseNonNullableFields>;
-export interface GetInventoryVariantsOptions extends GetInventoryVariantsRequestIdOneOf {
-    /**
-     * @internal
-     * @internal */
-    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
- * @documentationMaturity preview
- * @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
- */
-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.
- *
- *
- * 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.
- * @permissionScope Manage Stores - all permissions
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
- * @permissionScope Manage Products
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
- * @applicableIdentity APP
- */
-export declare function updateInventoryVariants(productId: string | null, inventoryItem: UpdateInventoryVariantsInventoryItem): Promise<void>;
-export interface UpdateInventoryVariantsInventoryItem {
-    /** Inventory item ID. */
-    _id?: string | null;
-    /**
-     * @internal
-     * @internal
-     * @readonly
-     */
-    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;
-    /**
-     * 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
- * @permissionScope Manage Stores - all permissions
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
- * @permissionScope Manage Products
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
- * @applicableIdentity APP
- */
-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
- * @permissionScope Manage Stores - all permissions
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
- * @permissionScope Manage Products
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
- * @applicableIdentity APP
- */
-export declare function incrementInventory(incrementData: IncrementData[]): Promise<void>;