@wix/auto_sdk_stores_inventory 1.0.77 → 1.0.78

package/build/internal/cjs/meta.d.ts

@@ -1,4 +1,4 @@
-import { UpdateInventoryVariantsRequest as UpdateInventoryVariantsRequest$1, UpdateInventoryVariantsResponse as UpdateInventoryVariantsResponse$1, DecrementInventoryRequest as DecrementInventoryRequest$1, DecrementInventoryResponse as DecrementInventoryResponse$1, IncrementInventoryRequest as IncrementInventoryRequest$1, IncrementInventoryResponse as IncrementInventoryResponse$1, GetInventoryVariantsRequest as GetInventoryVariantsRequest$1, GetInventoryVariantsResponse as GetInventoryVariantsResponse$1, QueryInventoryRequest as QueryInventoryRequest$1, QueryInventoryResponse as QueryInventoryResponse$1 } from './index.typings.js';
+import { GetInventoryVariantsRequest as GetInventoryVariantsRequest$1, GetInventoryVariantsResponse as GetInventoryVariantsResponse$1, QueryInventoryRequest as QueryInventoryRequest$1, QueryInventoryResponse as QueryInventoryResponse$1, UpdateInventoryVariantsRequest as UpdateInventoryVariantsRequest$1, UpdateInventoryVariantsResponse as UpdateInventoryVariantsResponse$1, DecrementInventoryRequest as DecrementInventoryRequest$1, DecrementInventoryResponse as DecrementInventoryResponse$1, IncrementInventoryRequest as IncrementInventoryRequest$1, IncrementInventoryResponse as IncrementInventoryResponse$1 } from './index.typings.js';
 import '@wix/sdk-types';
 
 interface InventoryItemV2 {
@@ -63,191 +63,6 @@ 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 {
-    /**
-     * @minSize 1
-     * @maxSize 300
-     */
-    decrementData?: DecrementData[];
-    /** @internal */
-    reason?: ReasonTypeWithLiterals;
-    /** @internal */
-    restrictInventoryValue?: boolean;
-}
-interface DecrementData extends DecrementDataIdOneOf {
-    /**
-     * Inventory item ID.
-     * @maxLength 36
-     */
-    inventoryId?: string;
-    /**
-     * Deprecated: use productId.
-     * @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;
-    /**
-     * Deprecated: use productId.
-     * @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 {
-    /**
-     * @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;
@@ -307,6 +122,18 @@ 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;
@@ -472,6 +299,179 @@ 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 {
+    /**
+     * @minSize 1
+     * @maxSize 300
+     */
+    decrementData?: DecrementData[];
+    /** @internal */
+    reason?: ReasonTypeWithLiterals;
+    /** @internal */
+    restrictInventoryValue?: boolean;
+}
+interface DecrementData extends DecrementDataIdOneOf {
+    /**
+     * Inventory item ID.
+     * @maxLength 36
+     */
+    inventoryId?: string;
+    /**
+     * Deprecated: use productId.
+     * @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;
+    /**
+     * Deprecated: use productId.
+     * @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 {
+    /**
+     * @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 {
+}
 
 type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
     getUrl: (context: any) => string;
@@ -483,14 +483,14 @@ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q
     __responseType: Q;
     __originalResponseType: R;
 };
+declare function getInventoryVariants(): __PublicMethodMetaInfo<'POST', {
+    inventoryId: string;
+}, GetInventoryVariantsRequest$1, GetInventoryVariantsRequest, GetInventoryVariantsResponse$1, GetInventoryVariantsResponse>;
+declare function queryInventory(): __PublicMethodMetaInfo<'POST', {}, QueryInventoryRequest$1, QueryInventoryRequest, QueryInventoryResponse$1, QueryInventoryResponse>;
 declare function updateInventoryVariants(): __PublicMethodMetaInfo<'PATCH', {
     inventoryItemProductId: string;
 }, UpdateInventoryVariantsRequest$1, UpdateInventoryVariantsRequest, UpdateInventoryVariantsResponse$1, UpdateInventoryVariantsResponse>;
 declare function decrementInventory(): __PublicMethodMetaInfo<'POST', {}, DecrementInventoryRequest$1, DecrementInventoryRequest, DecrementInventoryResponse$1, DecrementInventoryResponse>;
 declare function incrementInventory(): __PublicMethodMetaInfo<'POST', {}, IncrementInventoryRequest$1, IncrementInventoryRequest, IncrementInventoryResponse$1, IncrementInventoryResponse>;
-declare function getInventoryVariants(): __PublicMethodMetaInfo<'POST', {
-    inventoryId: string;
-}, GetInventoryVariantsRequest$1, GetInventoryVariantsRequest, GetInventoryVariantsResponse$1, GetInventoryVariantsResponse>;
-declare function queryInventory(): __PublicMethodMetaInfo<'POST', {}, QueryInventoryRequest$1, QueryInventoryRequest, QueryInventoryResponse$1, QueryInventoryResponse>;
 
 export { type AccountInfo as AccountInfoOriginal, type BulkUpdateInventoryItemsRequest as BulkUpdateInventoryItemsRequestOriginal, type BulkUpdateInventoryItemsResponse as BulkUpdateInventoryItemsResponseOriginal, type BulkUpdateInventoryVariantsRequestActionOneOf as BulkUpdateInventoryVariantsRequestActionOneOfOriginal, type BulkUpdateInventoryVariantsRequest as BulkUpdateInventoryVariantsRequestOriginal, type BulkUpdateInventoryVariantsResponse as BulkUpdateInventoryVariantsResponseOriginal, type ChangedInventoryVariantData as ChangedInventoryVariantDataOriginal, type ChangedInventoryVariant as ChangedInventoryVariantOriginal, type DecrementDataIdOneOf as DecrementDataIdOneOfOriginal, type DecrementData as DecrementDataOriginal, type DecrementInventoryRequest as DecrementInventoryRequestOriginal, type DecrementInventoryResponse as DecrementInventoryResponseOriginal, type GetInventoryItemsRequest as GetInventoryItemsRequestOriginal, type GetInventoryItemsResponse as GetInventoryItemsResponseOriginal, type GetInventoryVariantsRequestIdOneOf as GetInventoryVariantsRequestIdOneOfOriginal, type GetInventoryVariantsRequest as GetInventoryVariantsRequestOriginal, type GetInventoryVariantsResponse as GetInventoryVariantsResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type IncrementDataIdOneOf as IncrementDataIdOneOfOriginal, type IncrementData as IncrementDataOriginal, type IncrementInventoryRequest as IncrementInventoryRequestOriginal, type IncrementInventoryResponse as IncrementInventoryResponseOriginal, type InventoryItemChanged as InventoryItemChangedOriginal, type InventoryItemV2 as InventoryItemV2Original, type InventoryVariantV2 as InventoryVariantV2Original, type InventoryVariantsChanged as InventoryVariantsChangedOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type PagingMetadata as PagingMetadataOriginal, type Paging as PagingOriginal, type PreorderInfo as PreorderInfoOriginal, type QueryInventoryRequest as QueryInventoryRequestOriginal, type QueryInventoryResponse as QueryInventoryResponseOriginal, type Query as QueryOriginal, ReasonType as ReasonTypeOriginal, type ReasonTypeWithLiterals as ReasonTypeWithLiteralsOriginal, type UpdateInventoryVariantsRequest as UpdateInventoryVariantsRequestOriginal, type UpdateInventoryVariantsResponse as UpdateInventoryVariantsResponseOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, decrementInventory, getInventoryVariants, incrementInventory, queryInventory, updateInventoryVariants };

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

@@ -1,7 +1,25 @@
 import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
-import { UpdateInventoryVariantsInventoryItem, DecrementData, IncrementData, GetInventoryVariantsOptions, GetInventoryVariantsResponse, QueryInventoryOptions, QueryInventoryResponse, InventoryItemChangedEnvelope, InventoryVariantsChangedEnvelope } from './index.typings.mjs';
+import { GetInventoryVariantsOptions, GetInventoryVariantsResponse, QueryInventoryOptions, QueryInventoryResponse, UpdateInventoryVariantsInventoryItem, DecrementData, IncrementData, InventoryItemChangedEnvelope, InventoryVariantsChangedEnvelope } from './index.typings.mjs';
 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.mjs';
 
+declare function getInventoryVariants$1(httpClient: HttpClient): GetInventoryVariantsSignature;
+interface GetInventoryVariantsSignature {
+    /**
+     * 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 - Inventory item ID.
+     */
+    (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;
+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;
 interface UpdateInventoryVariantsSignature {
     /**
@@ -36,32 +54,14 @@ interface IncrementInventorySignature {
      */
     (incrementData: IncrementData[]): Promise<void>;
 }
-declare function getInventoryVariants$1(httpClient: HttpClient): GetInventoryVariantsSignature;
-interface GetInventoryVariantsSignature {
-    /**
-     * 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 - Inventory item ID.
-     */
-    (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;
-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 const onInventoryItemChanged$1: EventDefinition<InventoryItemChangedEnvelope, "com.wix.ecommerce.inventory.api.v1.InventoryItemChanged">;
 declare const onInventoryVariantsChanged$1: EventDefinition<InventoryVariantsChangedEnvelope, "com.wix.ecommerce.inventory.api.v1.InventoryVariantsChanged">;
 
+declare const getInventoryVariants: MaybeContext<BuildRESTFunction<typeof getInventoryVariants$1> & typeof getInventoryVariants$1>;
+declare const queryInventory: MaybeContext<BuildRESTFunction<typeof queryInventory$1> & typeof queryInventory$1>;
 declare const updateInventoryVariants: MaybeContext<BuildRESTFunction<typeof updateInventoryVariants$1> & typeof updateInventoryVariants$1>;
 declare const decrementInventory: MaybeContext<BuildRESTFunction<typeof decrementInventory$1> & typeof decrementInventory$1>;
 declare const incrementInventory: MaybeContext<BuildRESTFunction<typeof incrementInventory$1> & typeof incrementInventory$1>;
-declare const getInventoryVariants: MaybeContext<BuildRESTFunction<typeof getInventoryVariants$1> & typeof getInventoryVariants$1>;
-declare const queryInventory: MaybeContext<BuildRESTFunction<typeof queryInventory$1> & typeof queryInventory$1>;
 /**
  * Triggered when an inventory item is changed.
  */