@wix/stores 1.0.66 → 1.0.68

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

@@ -4,7 +4,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;
@@ -14,9 +19,9 @@ export interface Product {
     productType?: ProductType;
     /** Product description. Accepts [rich text](https://dev.wix.com/api/rest/wix-stores/rich-text). */
     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.
@@ -73,7 +78,7 @@ export interface Product {
     customTextFields?: CustomTextField[];
     /** Whether variants are being managed for this product - enables unique SKU, price and weight per variant. Also affects inventory data. */
     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).
@@ -325,9 +330,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 {
@@ -336,9 +341,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
@@ -363,7 +368,11 @@ export interface PageUrl {
     path?: string;
 }
 export interface Discount {
-    /** Discount type: amount / percent */
+    /**
+     * Discount type:
+     * + `"AMOUNT"`
+     * + `"PERCENT"`
+     */
     type?: DiscountType;
     /** Discount value */
     value?: number;
@@ -476,7 +485,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 {
@@ -490,6 +499,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 {
@@ -524,7 +534,7 @@ 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 {
@@ -532,7 +542,7 @@ export interface AddProductsToCollectionResponse {
 export interface RemoveProductsFromCollectionRequest {
     /** Collection ID. Cannot be used to remove products from All 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 {
@@ -540,6 +550,7 @@ 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 {
@@ -548,9 +559,9 @@ export interface MediaDataForWrite extends MediaDataForWriteMediaSourceOneOf {
     /** Media external URL (for new media items). */
     url?: string;
     /**
-     * Optional - assign this media item to a specific product choice.
+     * 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
+     * You may clear existing media from choices with the [Remove Product Media From Choices](/catalog/products/remove-product-media-from-choices).
      */
     choice?: OptionAndChoice;
 }
@@ -562,7 +573,9 @@ export interface MediaDataForWriteMediaSourceOneOf {
     url?: string;
 }
 export interface OptionAndChoice {
+    /** Option to add the media to. */
     option?: string;
+    /** Choice to add the media to. */
     choice?: string;
 }
 export interface AddProductMediaResponse {
@@ -578,12 +591,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[];
@@ -591,15 +605,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 {
@@ -873,8 +887,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;
 }
@@ -1129,7 +1143,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;
 }
@@ -1148,7 +1162,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 {

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"}