@wix/stores 1.0.67 → 1.0.68

package/build/cjs/src/stores-catalog-v1-product.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"stores-catalog-v1-product.types.js","sourceRoot":"","sources":["../../../src/stores-catalog-v1-product.types.ts"],"names":[],"mappings":";;;AA2HA,IAAY,WAIX;AAJD,WAAY,WAAW;IACrB,oEAAqD,CAAA;IACrD,oCAAqB,CAAA;IACrB,kCAAmB,CAAA;AACrB,CAAC,EAJW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAItB;AA4BD,IAAY,eAIX;AAJD,WAAY,eAAe;IACzB,wCAAqB,CAAA;IACrB,gDAA6B,CAAA;IAC7B,oEAAiD,CAAA;AACnD,CAAC,EAJW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAI1B;AA4ED,IAAY,eAuBX;AAvBD,WAAY,eAAe;IACzB,8CAA2B,CAAA;IAC3B,4BAAS,CAAA;IACT,4BAAS,CAAA;IACT,0BAAO,CAAA;IACP,8BAAW,CAAA;IACX,4BAAS,CAAA;IACT,0BAAO,CAAA;IACP,4BAAS,CAAA;IACT,4BAAS,CAAA;IACT,4BAAS,CAAA;IACT,0BAAO,CAAA;IACP,8BAAW,CAAA;IACX,4BAAS,CAAA;IACT,4BAAS,CAAA;IACT,gCAAa,CAAA;IACb,4BAAS,CAAA;IACT,4BAAS,CAAA;IACT,8BAAW,CAAA;IACX,4BAAS,CAAA;IACT,4BAAS,CAAA;IACT,4BAAS,CAAA;IACT,gCAAa,CAAA;AACf,CAAC,EAvBW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAuB1B;AAyDD,IAAY,aAOX;AAPD,WAAY,aAAa;IACvB,4EAA2D,CAAA;IAC3D,gCAAe,CAAA;IACf,gCAAe,CAAA;IACf,gCAAe,CAAA;IACf,sCAAqB,CAAA;IACrB,4BAAW,CAAA;AACb,CAAC,EAPW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAOxB;AA8BD,IAAY,UAIX;AAJD,WAAY,UAAU;IACpB,iEAAmD,CAAA;IACnD,qCAAuB,CAAA;IACvB,6BAAe,CAAA;AACjB,CAAC,EAJW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAIrB;AAsCD,IAAY,YAMX;AAND,WAAY,YAAY;IACtB,uCAAuB,CAAA;IACvB,kBAAkB;IAClB,6BAAa,CAAA;IACb,iCAAiB,CAAA;IACjB,mCAAmB,CAAA;AACrB,CAAC,EANW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAMvB;AAotBD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAGpB"}
+{"version":3,"file":"stores-catalog-v1-product.types.js","sourceRoot":"","sources":["../../../src/stores-catalog-v1-product.types.ts"],"names":[],"mappings":";;;AAgIA,IAAY,WAIX;AAJD,WAAY,WAAW;IACrB,oEAAqD,CAAA;IACrD,oCAAqB,CAAA;IACrB,kCAAmB,CAAA;AACrB,CAAC,EAJW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAItB;AA4BD,IAAY,eAIX;AAJD,WAAY,eAAe;IACzB,wCAAqB,CAAA;IACrB,gDAA6B,CAAA;IAC7B,oEAAiD,CAAA;AACnD,CAAC,EAJW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAI1B;AA4ED,IAAY,eAuBX;AAvBD,WAAY,eAAe;IACzB,8CAA2B,CAAA;IAC3B,4BAAS,CAAA;IACT,4BAAS,CAAA;IACT,0BAAO,CAAA;IACP,8BAAW,CAAA;IACX,4BAAS,CAAA;IACT,0BAAO,CAAA;IACP,4BAAS,CAAA;IACT,4BAAS,CAAA;IACT,4BAAS,CAAA;IACT,0BAAO,CAAA;IACP,8BAAW,CAAA;IACX,4BAAS,CAAA;IACT,4BAAS,CAAA;IACT,gCAAa,CAAA;IACb,4BAAS,CAAA;IACT,4BAAS,CAAA;IACT,8BAAW,CAAA;IACX,4BAAS,CAAA;IACT,4BAAS,CAAA;IACT,4BAAS,CAAA;IACT,gCAAa,CAAA;AACf,CAAC,EAvBW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAuB1B;AAyDD,IAAY,aAOX;AAPD,WAAY,aAAa;IACvB,4EAA2D,CAAA;IAC3D,gCAAe,CAAA;IACf,gCAAe,CAAA;IACf,gCAAe,CAAA;IACf,sCAAqB,CAAA;IACrB,4BAAW,CAAA;AACb,CAAC,EAPW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAOxB;AA8BD,IAAY,UAIX;AAJD,WAAY,UAAU;IACpB,iEAAmD,CAAA;IACnD,qCAAuB,CAAA;IACvB,6BAAe,CAAA;AACjB,CAAC,EAJW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAIrB;AA0CD,IAAY,YAMX;AAND,WAAY,YAAY;IACtB,uCAAuB,CAAA;IACvB,kBAAkB;IAClB,6BAAa,CAAA;IACb,iCAAiB,CAAA;IACjB,mCAAmB,CAAA;AACrB,CAAC,EANW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAMvB;AAytBD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAGpB"}

package/build/cjs/src/stores-catalog-v1-product.universal.d.ts

@@ -10,7 +10,12 @@ export interface Product {
      * @readonly
      */
     _id?: string;
-    /** Product name. */
+    /**
+     * Product name.
+     *
+     * Min: 1 character
+     * Max: 80 characters
+     */
     name?: string | null;
     /** A friendly URL name (generated automatically by the catalog when a product is created), can be updated. */
     slug?: string;
@@ -18,11 +23,11 @@ export interface Product {
     visible?: boolean | null;
     /** Currently, only creating physical products ( `"productType": "physical"` ) is supported via the API. */
     productType?: ProductType;
-    /** Product description. Accepts [rich text](https://dev.wix.com/api/rest/wix-stores/rich-text). */
+    /** Product description. */
     description?: string | null;
-    /** Stock keeping unit (if variant management is enabled, SKUs will be set per variant, and this field will be empty). */
+    /** Stock keeping unit. If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled, SKUs will be set per variant, and this field will be empty. */
     sku?: string | null;
-    /** Product weight (if variant management is enabled, weight will be set per variant, and this field will be empty). */
+    /** Product weight. If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled, weight will be set per variant, and this field will be empty. */
     weight?: number | null;
     /**
      * Product weight range. The minimum and maximum weights of all the variants.
@@ -77,9 +82,9 @@ export interface Product {
      * @readonly
      */
     customTextFields?: CustomTextField[];
-    /** Whether variants are being managed for this product - enables unique SKU, price and weight per variant. Also affects inventory data. */
+    /** Whether variants are being managed for this product - enables unique SKU, price and weight per variant. Also affects inventory data. Once set to `true`, can be reset to `false` only if no variants exist. You cannot set `manageVariants` to `true` if more than 300 variants are defined. */
     manageVariants?: boolean | null;
-    /** Options (color, size, etc) for this product. */
+    /** Options for this product. */
     productOptions?: ProductOption[];
     /**
      * Product page URL for this product (generated automatically by the server).
@@ -331,9 +336,9 @@ export interface ProductOption {
      * @readonly
      */
     optionType?: OptionType;
-    /** Option name (e.g., color, size) */
+    /** Option name. */
     name?: string;
-    /** Choices available for this option */
+    /** Choices available for this option. */
     choices?: Choice[];
 }
 export declare enum OptionType {
@@ -342,9 +347,9 @@ export declare enum OptionType {
     color = "color"
 }
 export interface Choice {
-    /** Color hex value or choice name */
+    /** Choice value. */
     value?: string;
-    /** Choice name */
+    /** Choice description. */
     description?: string;
     /**
      * Media items (images, videos) associated with this choice
@@ -369,7 +374,11 @@ export interface PageUrl {
     path?: string;
 }
 export interface Discount {
-    /** Discount type: amount / percent */
+    /**
+     * Discount type:
+     * + `"AMOUNT"`
+     * + `"PERCENT"`
+     */
     type?: DiscountType;
     /** Discount value */
     value?: number;
@@ -482,7 +491,7 @@ export interface UpdateProductResponse {
     product?: Product;
 }
 export interface DeleteProductRequest {
-    /** ID of the product to be deleted. */
+    /** ID of the product to delete. */
     _id: string;
 }
 export interface DeleteProductResponse {
@@ -496,6 +505,7 @@ export interface BulkDeleteProductsResponse {
 export interface UpdateVariantsRequest {
     /** ID of the product with managed variants. */
     _id: string;
+    /** Variant info to update. */
     variants?: VariantOverride[];
 }
 export interface VariantOverride {
@@ -530,15 +540,15 @@ export interface ResetAllVariantDataResponse {
 export interface AddProductsToCollectionRequest {
     /** Collection ID. Cannot be used to add products to All Products */
     _id: string;
-    /** IDs of the products to add to the collection. */
+    /** IDs of the products to add to the collection, separated by commas. */
     productIds?: string[];
 }
 export interface AddProductsToCollectionResponse {
 }
 export interface RemoveProductsFromCollectionRequest {
-    /** Collection ID. Cannot be used to remove products from All Products */
+    /** ID of the collection from which to remove products. */
     _id: string;
-    /** IDs of the products that will be deleted from the collection. */
+    /** IDs of the products to remove from the collection. */
     productIds: string[];
 }
 export interface RemoveProductsFromCollectionResponse {
@@ -546,29 +556,28 @@ export interface RemoveProductsFromCollectionResponse {
 export interface AddProductMediaRequest {
     /** Product ID. */
     _id: string;
+    /** Sources of media items already uploaded to the Wix site. */
     media?: MediaDataForWrite[];
 }
 export interface MediaDataForWrite extends MediaDataForWriteMediaSourceOneOf {
-    /** Media ID. For media items previously saved in Wix Media, the media ID is returned in the Query Product response. */
+    /** Media ID. */
     mediaId?: string;
     /** Media external URL (for new media items). */
     url?: string;
-    /**
-     * Optional - assign this media item to a specific product choice.
-     * Note that you may set media items for choices under only one option (e.g., if Colors blue, green, and red have media items, Sizes S, M, and L can't have media items assigned to them).
-     * You may clear existing media from choices via the Remove Product Media From Choices endpoint
-     */
+    /** Assign this media item to a specific product choice. Note that you may set media items for choices under only one option (e.g., if Colors blue, green, and red have media items, Sizes S, M, and L can't have media items assigned to them). You may clear existing media from choices with the [Remove Product Media From Choices](#removeproductmediafromchoices). */
     choice?: OptionAndChoice;
 }
 /** @oneof */
 export interface MediaDataForWriteMediaSourceOneOf {
-    /** Media ID. For media items previously saved in Wix Media, the media ID is returned in the Query Product response. */
+    /** Media ID. */
     mediaId?: string;
     /** Media external URL (for new media items). */
     url?: string;
 }
 export interface OptionAndChoice {
+    /** Option to add the media to. */
     option?: string;
+    /** Choice to add the media to. */
     choice?: string;
 }
 export interface AddProductMediaResponse {
@@ -584,12 +593,13 @@ export interface RemoveProductMediaResponse {
 export interface AddProductMediaToChoicesRequest {
     /** Product ID. */
     _id: string;
+    /** Product media items and the choices to add the media to. */
     media?: MediaAssignmentToChoice[];
 }
 export interface MediaAssignmentToChoice {
-    /** Product option. For example, color or size. */
+    /** Option name. */
     option?: string;
-    /** Choice within the option. For example, red or L. */
+    /** Choice name. */
     choice?: string;
     /** Media IDs (available via the Query Product endpoint). */
     mediaIds?: string[];
@@ -597,15 +607,15 @@ export interface MediaAssignmentToChoice {
 export interface AddProductMediaToChoicesResponse {
 }
 export interface RemoveProductMediaFromChoicesRequest {
-    /** Product ID. */
+    /** Product ID from whose choices to remove media items. */
     _id: string;
-    /** Optional - if an empty array is passed, all media will be removed from all choices. */
+    /** Media to remove from choices. If an empty array is passed, all media will be removed from all choices for the given product. */
     media?: MediaAssignmentToChoice[];
 }
 export interface RemoveProductMediaFromChoicesResponse {
 }
 export interface DeleteProductOptionsRequest {
-    /** Product ID. */
+    /** ID of the product with options to delete. */
     _id: string;
 }
 export interface DeleteProductOptionsResponse {
@@ -690,7 +700,7 @@ export interface UpdateCollectionResponse {
     collection?: Collection;
 }
 export interface DeleteCollectionRequest {
-    /** ID of the collection to delete. Cannot be used to delete All Products */
+    /** ID of the collection to delete. */
     _id: string;
 }
 export interface DeleteCollectionResponse {
@@ -879,8 +889,8 @@ export interface PercentageData {
      */
     roundToInt?: boolean;
     /**
-     * Percentage value, as a whole number (integer) between -100 and 1000.
-     * For example, pass 100 to increase value by 100% (multiply original value by 2).
+     * Percentage value, as a whole number (integer) between `-100`` and `1000``.
+     * For example, pass `100`` to increase value by 100% (multiply original value by 2).
      */
     rate?: number;
 }
@@ -1135,7 +1145,7 @@ export interface GetCollectionRequest {
     _id: string;
     /**
      * Whether to return the `collection.numberOfProducts` field in the response.
-     * Defaults to false, in which case the value of `collection.numberOfProducts` will be 0.
+     * Defaults to `false`, in which case the value of `collection.numberOfProducts` will be `0`.
      */
     includeNumberOfProducts?: boolean;
 }
@@ -1154,7 +1164,7 @@ export interface GetCollectionBySlugResponse {
 export interface ProductOptionsAvailabilityRequest {
     /** Requested product ID. */
     _id: string;
-    /** Array containing the selected options (e.g, color: Blue, size: Large). */
+    /** Set of key-value pairs. Array containing the selected options (e.g, color: Blue, size: Large). */
     options?: Record<string, string>;
 }
 export interface ProductOptionsAvailabilityResponse {
@@ -1367,25 +1377,28 @@ export interface AggregateProductsResponse {
 }
 /**
  * Creates a new product.
+ *
+ * This function is not a universal function and runs only on the backend.
+ * @param product - Product information.
  * @public
  * @documentationMaturity preview
- * @requiredField options.product.costAndProfitData.itemCost
- * @requiredField options.product.name
- * @requiredField options.product.priceData
- * @requiredField options.product.priceData.price
+ * @requiredField product
+ * @requiredField product.costAndProfitData.itemCost
+ * @requiredField product.name
+ * @requiredField product.priceData
+ * @requiredField product.priceData.price
  */
-export declare function createProduct(options?: CreateProductOptions): Promise<CreateProductResponse>;
-export interface CreateProductOptions {
-    /** Product information. */
-    product?: Product;
-}
+export declare function createProduct(product: Product): Promise<CreateProductResponse>;
 /**
  * Updates specified fields in a product.
+ *
+ * This function is not a universal function and runs only on the backend.
  * @param _id - Product ID (generated automatically by the catalog).
  * @public
  * @documentationMaturity preview
  * @requiredField _id
  * @requiredField product
+ * @param product - Product info to update.
  */
 export declare function updateProduct(_id: string, product: UpdateProduct): Promise<UpdateProductResponse>;
 export interface UpdateProduct {
@@ -1394,7 +1407,12 @@ export interface UpdateProduct {
      * @readonly
      */
     _id?: string;
-    /** Product name. */
+    /**
+     * Product name.
+     *
+     * Min: 1 character
+     * Max: 80 characters
+     */
     name?: string | null;
     /** A friendly URL name (generated automatically by the catalog when a product is created), can be updated. */
     slug?: string;
@@ -1402,11 +1420,11 @@ export interface UpdateProduct {
     visible?: boolean | null;
     /** Currently, only creating physical products ( `"productType": "physical"` ) is supported via the API. */
     productType?: ProductType;
-    /** Product description. Accepts [rich text](https://dev.wix.com/api/rest/wix-stores/rich-text). */
+    /** Product description. */
     description?: string | null;
-    /** Stock keeping unit (if variant management is enabled, SKUs will be set per variant, and this field will be empty). */
+    /** Stock keeping unit. If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled, SKUs will be set per variant, and this field will be empty. */
     sku?: string | null;
-    /** Product weight (if variant management is enabled, weight will be set per variant, and this field will be empty). */
+    /** Product weight. If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled, weight will be set per variant, and this field will be empty. */
     weight?: number | null;
     /**
      * Product weight range. The minimum and maximum weights of all the variants.
@@ -1461,9 +1479,9 @@ export interface UpdateProduct {
      * @readonly
      */
     customTextFields?: CustomTextField[];
-    /** Whether variants are being managed for this product - enables unique SKU, price and weight per variant. Also affects inventory data. */
+    /** Whether variants are being managed for this product - enables unique SKU, price and weight per variant. Also affects inventory data. Once set to `true`, can be reset to `false` only if no variants exist. You cannot set `manageVariants` to `true` if more than 300 variants are defined. */
     manageVariants?: boolean | null;
-    /** Options (color, size, etc) for this product. */
+    /** Options for this product. */
     productOptions?: ProductOption[];
     /**
      * Product page URL for this product (generated automatically by the server).
@@ -1512,117 +1530,124 @@ export interface UpdateProduct {
 }
 /**
  * Deletes a product.
- * @param _id - ID of the product to be deleted.
+ *
+ * This function is not a universal function and runs only on the backend.
+ * @param _id - ID of the product to delete.
  * @public
- * @documentationMaturity preview
  * @requiredField _id
  */
 export declare function deleteProduct(_id: string): Promise<void>;
 /**
  * Updates variants of a specified product.
+ *
+ * This function is not a universal function and runs only on the backend.
  * @param _id - ID of the product with managed variants.
+ * @param variants - Variant info to update.
  * @public
  * @documentationMaturity preview
  * @requiredField _id
+ * @requiredField variants
  */
-export declare function updateVariants(_id: string, options?: UpdateVariantsOptions): Promise<UpdateVariantsResponse>;
-export interface UpdateVariantsOptions {
-    variants?: VariantOverride[];
-}
+export declare function updateProductVariants(_id: string, variants: VariantOverride[]): Promise<UpdateVariantsResponse>;
 /**
- * Resets all variant information to default values (price = current product price; weight = current product weight; SKU = current product SKU; visibility = true).
+ * Resets the data (such as the price and the weight) of all variants for a given product to their default values.
+ *
+ * This function is not a universal function and runs only on the backend.
  * @param _id - Product ID.
  * @public
  * @documentationMaturity preview
  * @requiredField _id
  */
-export declare function resetAllVariantData(_id: string): Promise<void>;
+export declare function resetAllProductVariantData(_id: string): Promise<void>;
 /**
  * Adds products to a specified collection.
+ *
+ * This function is not a universal function and runs only on the backend.
  * @param _id - Collection ID. Cannot be used to add products to All Products
+ * @param productIds - IDs of the products to add to the collection, separated by commas.
  * @public
- * @documentationMaturity preview
  * @requiredField _id
+ * @requiredField productIds
  */
-export declare function addProductsToCollection(_id: string, options?: AddProductsToCollectionOptions): Promise<void>;
-export interface AddProductsToCollectionOptions {
-    /** IDs of the products to add to the collection. */
-    productIds?: string[];
-}
+export declare function addProductsToCollection(_id: string, productIds: string[]): Promise<void>;
 /**
  * Deletes products from a specified collection.
- * @param _id - Collection ID. Cannot be used to remove products from All Products
- * @param productIds - IDs of the products that will be deleted from the collection.
+ *
+ * This function is not a universal function and runs only on the backend.
+ * @param _id - ID of the collection from which to remove products.
+ * @param productIds - IDs of the products to remove from the collection.
  * @public
- * @documentationMaturity preview
  * @requiredField _id
  * @requiredField productIds
  */
 export declare function removeProductsFromCollection(_id: string, productIds: string[]): Promise<void>;
 /**
  * Adds media items to a specified product, either via URL or existing media ID.
+ *
+ * > **NOTE:** The URL is not validated and no event is triggered to indicate if the media was added successfully.
+ *
+ * This function is not a universal function and runs only on the backend.
  * @param _id - Product ID.
+ * @param media - Sources of media items already uploaded to the Wix site.
  * @public
- * @documentationMaturity preview
  * @requiredField _id
+ * @requiredField media
  */
-export declare function addProductMedia(_id: string, options?: AddProductMediaOptions): Promise<void>;
-export interface AddProductMediaOptions {
-    media?: MediaDataForWrite[];
-}
+export declare function addProductMedia(_id: string, media: MediaDataForWrite[]): Promise<void>;
 /**
  * Removes specified media items from a product.
  * Pass an empty array to remove all media items.
+ *
+ * This function is not a universal function and runs only on the backend.
  * @param _id - Product ID.
+ * @param mediaIds - List of media IDs to remove. Pass an empty array to delete all media items for the product.
  * @public
- * @documentationMaturity preview
  * @requiredField _id
+ * @requiredField mediaIds
  */
-export declare function removeProductMedia(_id: string, options?: RemoveProductMediaOptions): Promise<void>;
-export interface RemoveProductMediaOptions {
-    /** List of media IDs to remove. Pass an empty array to delete all media items for the product. */
-    mediaIds?: string[];
-}
+export declare function removeProductMedia(_id: string, mediaIds: string[]): Promise<void>;
 /**
  * Links media items that are already associated with a specific product to a choice within the same product.
  *
  * Media items can only be set for choices within one option at a time - e.g., if you set media items for some or all of the choices within the Colors option (blue, green, and red), you won't be able to also assign media items to choices within the Size option (S, M, and L).
  *
  * To remove all existing media items, call the [Remove Product Media From Choices](https://dev.wix.com/api/rest/wix-stores/catalog/products/remove-product-media-from-choices) endpoint.
+ *
+ * This function is not a universal function and runs only on the backend.
  * @param _id - Product ID.
+ * @param media - Product media items and the choices to add the media to.
  * @public
- * @documentationMaturity preview
  * @requiredField _id
- * @requiredField options.media.choice
- * @requiredField options.media.option
+ * @requiredField media
+ * @requiredField media.choice
+ * @requiredField media.option
  */
-export declare function addProductMediaToChoices(_id: string, options?: AddProductMediaToChoicesOptions): Promise<void>;
-export interface AddProductMediaToChoicesOptions {
-    media?: MediaAssignmentToChoice[];
-}
+export declare function addProductMediaToChoices(_id: string, media: MediaAssignmentToChoice[]): Promise<void>;
 /**
  * Removes media items from all or some of a product's choices.
  * (Media items can only be set for choices within one option at a time - e.g., if you set media items for some or all of the choices within the Colors option (blue, green, and red), you won't be able to also assign media items to choices within the Size option (S, M, and L).)
- * @param _id - Product ID.
+ *
+ * This function is not a universal function and runs only on the backend.
+ * @param _id - Product ID from whose choices to remove media items.
+ * @param media - Media to remove from choices. If an empty array is passed, all media will be removed from all choices for the given product.
  * @public
- * @documentationMaturity preview
  * @requiredField _id
+ * @requiredField media
  */
-export declare function removeProductMediaFromChoices(_id: string, options?: RemoveProductMediaFromChoicesOptions): Promise<void>;
-export interface RemoveProductMediaFromChoicesOptions {
-    /** Optional - if an empty array is passed, all media will be removed from all choices. */
-    media?: MediaAssignmentToChoice[];
-}
+export declare function removeProductMediaFromChoices(_id: string, media: MediaAssignmentToChoice[]): Promise<void>;
 /**
- * Delete all options from a specific product (only available when variant management is disabled).
- * @param _id - Product ID.
+ * Delete all options from a specific product. Only available when [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is disabled.
+ *
+ * This function is not a universal function and runs only on the backend.
+ * @param _id - ID of the product with options to delete.
  * @public
- * @documentationMaturity preview
  * @requiredField _id
  */
 export declare function deleteProductOptions(_id: string): Promise<void>;
 /**
  * Deletes a product's brand.
+ *
+ * This function is not a universal function and runs only on the backend.
  * @param _id - Product ID.
  * @public
  * @documentationMaturity preview
@@ -1631,6 +1656,8 @@ export declare function deleteProductOptions(_id: string): Promise<void>;
 export declare function removeBrand(_id: string): Promise<void>;
 /**
  * Creates a new collection.
+ *
+ * This function is not a universal function and runs only on the backend.
  * @param collection - Collection info.
  * @public
  * @documentationMaturity preview
@@ -1639,13 +1666,15 @@ export declare function removeBrand(_id: string): Promise<void>;
  */
 export declare function createCollection(collection: Collection): Promise<CreateCollectionResponse>;
 /**
- * Updates specified properties of a collection.
- * To add products to a collection, call the [Add Products to Collection](https://dev.wix.com/api/rest/wix-stores/catalog/collection/add-products-to-collection) endpoint.
+ * Updates specified properties of a collection. To add products to a collection, call the [addProductsToCollection](#addproductstocollection) function.
+ *
+ * This function is not a universal function and runs only on the backend.
  * @param _id - Collection ID (generated automatically by the catalog).
  * @public
  * @documentationMaturity preview
  * @requiredField _id
  * @requiredField collection
+ * @param collection - Collection info to update.
  */
 export declare function updateCollection(_id: string | null, collection: UpdateCollection): Promise<UpdateCollectionResponse>;
 export interface UpdateCollection {
@@ -1675,14 +1704,18 @@ export interface UpdateCollection {
 }
 /**
  * Deletes a collection.
- * @param _id - ID of the collection to delete. Cannot be used to delete All Products
+ *
+ * This function is not a universal function and runs only on the backend.
  * @public
  * @documentationMaturity preview
  * @requiredField _id
+ * @param _id - ID of the collection to delete.
  */
 export declare function deleteCollection(_id: string): Promise<void>;
 /**
  * Deletes a product's ribbon.
+ *
+ * This function is not a universal function and runs only on the backend.
  * @param _id - Product ID.
  * @public
  * @documentationMaturity preview
@@ -1691,28 +1724,31 @@ export declare function deleteCollection(_id: string): Promise<void>;
 export declare function removeRibbon(_id: string): Promise<void>;
 /**
  * Updates a specified property for up to 100 products at a time.
- * @param ids - Product IDs.
+ * @param set - Field to update.
  * @public
- * @documentationMaturity preview
- * @requiredField ids
+ * @requiredField options
+ * @requiredField options.ids
+ * @requiredField set
  */
-export declare function bulkUpdateProducts(ids: string[], options?: BulkUpdateProductsOptions): Promise<BulkUpdateProductsResponse>;
+export declare function bulkUpdateProducts(set: SetValue, options: BulkUpdateProductsOptions): Promise<BulkUpdateProductsResponse>;
 export interface BulkUpdateProductsOptions {
-    /** Field to update. */
-    set?: SetValue;
+    /** Product IDs. */
+    ids: string[];
 }
 /**
  * Adjusts a specified numerical property for up to 100 products at a time.
  * The property can be increased or decreased either by percentage or amount.
- * @param ids - Product IDs.
+ * @param adjust - Numerical property to adjust.
  * @public
  * @documentationMaturity preview
- * @requiredField ids
+ * @requiredField adjust
+ * @requiredField options
+ * @requiredField options.ids
  */
-export declare function bulkAdjustProductProperties(ids: string[], options?: BulkAdjustProductPropertiesOptions): Promise<BulkAdjustProductPropertiesResponse>;
-export interface BulkAdjustProductPropertiesOptions {
-    /** Numerical property to adjust. */
-    adjust?: AdjustValue;
+export declare function bulkAdjustProductProperty(adjust: AdjustValue, options: BulkAdjustProductPropertyOptions): Promise<BulkAdjustProductPropertiesResponse>;
+export interface BulkAdjustProductPropertyOptions {
+    /** Product IDs. */
+    ids: string[];
 }
 /**
  * Returns a list of up to 100 products, given the provided paging, sorting and filtering.
@@ -1830,14 +1866,13 @@ export interface QueryCollectionsOptions {
  * Retrieves a collection with the provided ID.
  * @param _id - Requested collection ID.
  * @public
- * @documentationMaturity preview
  * @requiredField _id
  */
 export declare function getCollection(_id: string, options?: GetCollectionOptions): Promise<GetCollectionResponse>;
 export interface GetCollectionOptions {
     /**
      * Whether to return the `collection.numberOfProducts` field in the response.
-     * Defaults to false, in which case the value of `collection.numberOfProducts` will be 0.
+     * Defaults to `false`, in which case the value of `collection.numberOfProducts` will be `0`.
      */
     includeNumberOfProducts?: boolean;
 }
@@ -1845,22 +1880,18 @@ export interface GetCollectionOptions {
  * Retrieves a collection with the provided slug.
  * @param slug - Slug of the collection to retrieve.
  * @public
- * @documentationMaturity preview
  * @requiredField slug
  */
 export declare function getCollectionBySlug(slug: string): Promise<GetCollectionBySlugResponse>;
 /**
  * Gets the availability of relevant product variants based on the product ID and selections provided. See [Use Cases](https://dev.wix.com/api/rest/wix-stores/catalog/use-cases) for an example.
  * @param _id - Requested product ID.
+ * @param options - Set of key-value pairs. Array containing the selected options (e.g, color: Blue, size: Large).
  * @public
- * @documentationMaturity preview
  * @requiredField _id
+ * @requiredField options
  */
-export declare function getProductOptionsAvailability(_id: string, options?: GetProductOptionsAvailabilityOptions): Promise<ProductOptionsAvailabilityResponse>;
-export interface GetProductOptionsAvailabilityOptions {
-    /** Array containing the selected options (e.g, color: Blue, size: Large). */
-    options?: Record<string, string>;
-}
+export declare function getProductOptionsAvailability(_id: string, options: Record<string, string>): Promise<ProductOptionsAvailabilityResponse>;
 /**
  * Retrieves product variants, based on either choices (option-choice key-value pairs) or variant IDs.
  * See [Stores Pagination](https://dev.wix.com/api/rest/wix-stores/pagination) for more information.
@@ -1884,14 +1915,12 @@ export interface QueryProductVariantsOptions {
 }
 /**
  * Retrieves up to 100 store variants, given the provided paging, filtering, and sorting.
+ * @param query - Query options.
  * @public
  * @documentationMaturity preview
+ * @requiredField query
  */
-export declare function queryStoreVariants(options?: QueryStoreVariantsOptions): Promise<QueryStoreVariantsResponse>;
-export interface QueryStoreVariantsOptions {
-    /** Query options. */
-    query?: PlatformQuery;
-}
+export declare function queryStoreVariants(query: PlatformQuery): Promise<QueryStoreVariantsResponse>;
 /**
  * Retrieves a store variant with the provided ID.
  * @param _id - Store variant ID. Comprised of the `productId` and the `variantId`, separated by a hyphen. For example, `{productId}-{variantId}`.