@wix/auto_sdk_stores_inventory 1.0.11 → 1.0.13

package/build/internal/meta.d.mts

@@ -0,0 +1,268 @@
+import { g as UpdateInventoryVariantsRequest$1, h as UpdateInventoryVariantsResponse$1, m as DecrementInventoryRequest$1, o as DecrementInventoryResponse$1, p as IncrementInventoryRequest$1, r as IncrementInventoryResponse$1, v as GetInventoryVariantsRequest$1, a as GetInventoryVariantsResponse$1, z as QueryInventoryRequest$1, b as QueryInventoryResponse$1 } from './stores-v2-inventory-inventory.universal-CAYc4_b7.mjs';
+
+interface InventoryItemV2 {
+    /** Inventory item ID. */
+    id?: string | null;
+    /**
+     * Deprecated: use productId.
+     * @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;
+}
+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;
+}
+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;
+}
+interface UpdateInventoryVariantsRequest {
+    /** Inventory item. */
+    inventoryItem: InventoryItemV2;
+}
+interface UpdateInventoryVariantsResponse {
+}
+interface DecrementInventoryRequest {
+    /**
+     * @minSize 1
+     * @maxSize 300
+     */
+    decrementData?: DecrementData[];
+}
+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[];
+}
+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 GetInventoryVariantsRequest extends GetInventoryVariantsRequestIdOneOf {
+    /** Inventory item ID. */
+    inventoryId: string;
+    /**
+     * Deprecated (use productID instead).
+     * @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 GetInventoryVariantsRequestIdOneOf {
+    /** Inventory item ID. */
+    inventoryId?: string;
+    /**
+     * Deprecated (use productID instead).
+     * @deprecated Deprecated (use productID instead).
+     * @replacedBy product_id
+     * @targetRemovalDate 2024-12-31
+     */
+    externalId?: string;
+    /** Product ID. */
+    productId?: string;
+}
+interface GetInventoryVariantsResponse {
+    /** Inventory item. */
+    inventoryItem?: InventoryItemV2;
+}
+interface QueryInventoryRequest {
+    query?: Query;
+}
+interface Query {
+    paging?: Paging;
+    /** Filter string */
+    filter?: string | null;
+    /** Sort string */
+    sort?: string | null;
+}
+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;
+}
+interface QueryInventoryResponse {
+    /** Inventory items. */
+    inventoryItems?: InventoryItemV2[];
+    /** Display metadata. */
+    metadata?: PagingMetadata;
+    /** Number of total results. */
+    totalResults?: number;
+}
+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;
+}
+
+type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
+    getUrl: (context: any) => string;
+    httpMethod: K;
+    path: string;
+    pathParams: M;
+    __requestType: T;
+    __originalRequestType: S;
+    __responseType: Q;
+    __originalResponseType: R;
+};
+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 __PublicMethodMetaInfo, decrementInventory, getInventoryVariants, incrementInventory, queryInventory, updateInventoryVariants };

package/build/internal/meta.d.ts

@@ -0,0 +1,268 @@
+import { g as UpdateInventoryVariantsRequest$1, h as UpdateInventoryVariantsResponse$1, m as DecrementInventoryRequest$1, o as DecrementInventoryResponse$1, p as IncrementInventoryRequest$1, r as IncrementInventoryResponse$1, v as GetInventoryVariantsRequest$1, a as GetInventoryVariantsResponse$1, z as QueryInventoryRequest$1, b as QueryInventoryResponse$1 } from './stores-v2-inventory-inventory.universal-CAYc4_b7.js';
+
+interface InventoryItemV2 {
+    /** Inventory item ID. */
+    id?: string | null;
+    /**
+     * Deprecated: use productId.
+     * @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;
+}
+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;
+}
+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;
+}
+interface UpdateInventoryVariantsRequest {
+    /** Inventory item. */
+    inventoryItem: InventoryItemV2;
+}
+interface UpdateInventoryVariantsResponse {
+}
+interface DecrementInventoryRequest {
+    /**
+     * @minSize 1
+     * @maxSize 300
+     */
+    decrementData?: DecrementData[];
+}
+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[];
+}
+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 GetInventoryVariantsRequest extends GetInventoryVariantsRequestIdOneOf {
+    /** Inventory item ID. */
+    inventoryId: string;
+    /**
+     * Deprecated (use productID instead).
+     * @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 GetInventoryVariantsRequestIdOneOf {
+    /** Inventory item ID. */
+    inventoryId?: string;
+    /**
+     * Deprecated (use productID instead).
+     * @deprecated Deprecated (use productID instead).
+     * @replacedBy product_id
+     * @targetRemovalDate 2024-12-31
+     */
+    externalId?: string;
+    /** Product ID. */
+    productId?: string;
+}
+interface GetInventoryVariantsResponse {
+    /** Inventory item. */
+    inventoryItem?: InventoryItemV2;
+}
+interface QueryInventoryRequest {
+    query?: Query;
+}
+interface Query {
+    paging?: Paging;
+    /** Filter string */
+    filter?: string | null;
+    /** Sort string */
+    sort?: string | null;
+}
+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;
+}
+interface QueryInventoryResponse {
+    /** Inventory items. */
+    inventoryItems?: InventoryItemV2[];
+    /** Display metadata. */
+    metadata?: PagingMetadata;
+    /** Number of total results. */
+    totalResults?: number;
+}
+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;
+}
+
+type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
+    getUrl: (context: any) => string;
+    httpMethod: K;
+    path: string;
+    pathParams: M;
+    __requestType: T;
+    __originalRequestType: S;
+    __responseType: Q;
+    __originalResponseType: R;
+};
+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 __PublicMethodMetaInfo, decrementInventory, getInventoryVariants, incrementInventory, queryInventory, updateInventoryVariants };