@wix/stores 1.0.68 → 1.0.70

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

@@ -1142,7 +1142,7 @@ export interface QueryCollectionsPlatformizedResponse {
 }
 export interface GetCollectionRequest {
     /** Requested collection ID. */
-    _id: string;
+    _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`.
@@ -1387,6 +1387,7 @@ export interface AggregateProductsResponse {
  * @requiredField product.name
  * @requiredField product.priceData
  * @requiredField product.priceData.price
+ * @permissionScope Manage Products
  */
 export declare function createProduct(product: Product): Promise<CreateProductResponse>;
 /**
@@ -1399,6 +1400,7 @@ export declare function createProduct(product: Product): Promise<CreateProductRe
  * @requiredField _id
  * @requiredField product
  * @param product - Product info to update.
+ * @permissionScope Manage Products
  */
 export declare function updateProduct(_id: string, product: UpdateProduct): Promise<UpdateProductResponse>;
 export interface UpdateProduct {
@@ -1535,6 +1537,7 @@ export interface UpdateProduct {
  * @param _id - ID of the product to delete.
  * @public
  * @requiredField _id
+ * @permissionScope Manage Products
  */
 export declare function deleteProduct(_id: string): Promise<void>;
 /**
@@ -1547,6 +1550,7 @@ export declare function deleteProduct(_id: string): Promise<void>;
  * @documentationMaturity preview
  * @requiredField _id
  * @requiredField variants
+ * @permissionScope Manage Products
  */
 export declare function updateProductVariants(_id: string, variants: VariantOverride[]): Promise<UpdateVariantsResponse>;
 /**
@@ -1557,6 +1561,7 @@ export declare function updateProductVariants(_id: string, variants: VariantOver
  * @public
  * @documentationMaturity preview
  * @requiredField _id
+ * @permissionScope Manage Products
  */
 export declare function resetAllProductVariantData(_id: string): Promise<void>;
 /**
@@ -1568,6 +1573,7 @@ export declare function resetAllProductVariantData(_id: string): Promise<void>;
  * @public
  * @requiredField _id
  * @requiredField productIds
+ * @permissionScope Manage Products
  */
 export declare function addProductsToCollection(_id: string, productIds: string[]): Promise<void>;
 /**
@@ -1579,6 +1585,7 @@ export declare function addProductsToCollection(_id: string, productIds: string[
  * @public
  * @requiredField _id
  * @requiredField productIds
+ * @permissionScope Manage Products
  */
 export declare function removeProductsFromCollection(_id: string, productIds: string[]): Promise<void>;
 /**
@@ -1592,6 +1599,7 @@ export declare function removeProductsFromCollection(_id: string, productIds: st
  * @public
  * @requiredField _id
  * @requiredField media
+ * @permissionScope Manage Products
  */
 export declare function addProductMedia(_id: string, media: MediaDataForWrite[]): Promise<void>;
 /**
@@ -1604,6 +1612,7 @@ export declare function addProductMedia(_id: string, media: MediaDataForWrite[])
  * @public
  * @requiredField _id
  * @requiredField mediaIds
+ * @permissionScope Manage Products
  */
 export declare function removeProductMedia(_id: string, mediaIds: string[]): Promise<void>;
 /**
@@ -1621,6 +1630,7 @@ export declare function removeProductMedia(_id: string, mediaIds: string[]): Pro
  * @requiredField media
  * @requiredField media.choice
  * @requiredField media.option
+ * @permissionScope Manage Products
  */
 export declare function addProductMediaToChoices(_id: string, media: MediaAssignmentToChoice[]): Promise<void>;
 /**
@@ -1633,6 +1643,7 @@ export declare function addProductMediaToChoices(_id: string, media: MediaAssign
  * @public
  * @requiredField _id
  * @requiredField media
+ * @permissionScope Manage Products
  */
 export declare function removeProductMediaFromChoices(_id: string, media: MediaAssignmentToChoice[]): Promise<void>;
 /**
@@ -1642,6 +1653,7 @@ export declare function removeProductMediaFromChoices(_id: string, media: MediaA
  * @param _id - ID of the product with options to delete.
  * @public
  * @requiredField _id
+ * @permissionScope Manage Products
  */
 export declare function deleteProductOptions(_id: string): Promise<void>;
 /**
@@ -1652,6 +1664,7 @@ export declare function deleteProductOptions(_id: string): Promise<void>;
  * @public
  * @documentationMaturity preview
  * @requiredField _id
+ * @permissionScope Manage Products
  */
 export declare function removeBrand(_id: string): Promise<void>;
 /**
@@ -1663,6 +1676,7 @@ export declare function removeBrand(_id: string): Promise<void>;
  * @documentationMaturity preview
  * @requiredField collection
  * @requiredField collection.name
+ * @permissionScope Manage Products
  */
 export declare function createCollection(collection: Collection): Promise<CreateCollectionResponse>;
 /**
@@ -1675,6 +1689,7 @@ export declare function createCollection(collection: Collection): Promise<Create
  * @requiredField _id
  * @requiredField collection
  * @param collection - Collection info to update.
+ * @permissionScope Manage Products
  */
 export declare function updateCollection(_id: string | null, collection: UpdateCollection): Promise<UpdateCollectionResponse>;
 export interface UpdateCollection {
@@ -1710,6 +1725,7 @@ export interface UpdateCollection {
  * @documentationMaturity preview
  * @requiredField _id
  * @param _id - ID of the collection to delete.
+ * @permissionScope Manage Products
  */
 export declare function deleteCollection(_id: string): Promise<void>;
 /**
@@ -1720,40 +1736,39 @@ export declare function deleteCollection(_id: string): Promise<void>;
  * @public
  * @documentationMaturity preview
  * @requiredField _id
+ * @permissionScope Manage Products
  */
 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
- * @requiredField options
- * @requiredField options.ids
+ * @documentationMaturity preview
+ * @requiredField ids
  * @requiredField set
+ * @permissionScope Manage Products
  */
-export declare function bulkUpdateProducts(set: SetValue, options: BulkUpdateProductsOptions): Promise<BulkUpdateProductsResponse>;
-export interface BulkUpdateProductsOptions {
-    /** Product IDs. */
-    ids: string[];
-}
+export declare function bulkUpdateProductsProperty(ids: string[], set: SetValue): Promise<BulkUpdateProductsResponse>;
 /**
  * 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 adjust - Numerical property to adjust.
+ * @param ids - Product IDs.
  * @public
  * @documentationMaturity preview
  * @requiredField adjust
- * @requiredField options
- * @requiredField options.ids
+ * @requiredField ids
+ * @permissionScope Manage Products
  */
-export declare function bulkAdjustProductProperty(adjust: AdjustValue, options: BulkAdjustProductPropertyOptions): Promise<BulkAdjustProductPropertiesResponse>;
-export interface BulkAdjustProductPropertyOptions {
-    /** Product IDs. */
-    ids: string[];
-}
+export declare function bulkAdjustProductProperty(adjust: AdjustValue, ids: string[]): Promise<BulkAdjustProductPropertiesResponse>;
 /**
  * Returns a list of up to 100 products, given the provided paging, sorting and filtering.
  * @public
  * @documentationMaturity preview
+ * @permissionScope Manage Orders
+ * @permissionScope Manage Products
+ * @permissionScope Read Products
  */
 export declare function queryProducts(): ProductsQueryBuilder;
 interface QueryOffsetResult {
@@ -1841,46 +1856,23 @@ export interface ProductsQueryBuilder {
  * @public
  * @documentationMaturity preview
  * @requiredField _id
+ * @permissionScope Manage Orders
+ * @permissionScope Manage Products
+ * @permissionScope Read Products
  */
 export declare function getProduct(_id: string, options?: GetProductOptions): Promise<GetProductResponse>;
 export interface GetProductOptions {
     /** Whether merchant specific data, such as cost and profit data, should be included in the response. Requires permissions to manage products. */
     includeMerchantSpecificData?: boolean;
 }
-/**
- * Retrieves a list of up to 100 collections, given the provided paging, sorting and filtering.
- * See [Stores Pagination](https://dev.wix.com/api/rest/wix-stores/pagination) for more information.
- * @public
- * @documentationMaturity preview
- */
-export declare function queryCollections(options?: QueryCollectionsOptions): Promise<QueryCollectionsResponse>;
-export interface QueryCollectionsOptions {
-    /** Query options. */
-    query?: Query;
-    /** Whether number of products should be included in the response. */
-    includeNumberOfProducts?: boolean;
-    /** Wether to include collection description in the response. When `false` is passed, `collection.description` will return null. */
-    includeDescription?: boolean;
-}
-/**
- * Retrieves a collection with the provided ID.
- * @param _id - Requested collection ID.
- * @public
- * @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`.
-     */
-    includeNumberOfProducts?: boolean;
-}
 /**
  * Retrieves a collection with the provided slug.
  * @param slug - Slug of the collection to retrieve.
  * @public
  * @requiredField slug
+ * @permissionScope Manage Orders
+ * @permissionScope Manage Products
+ * @permissionScope Read Products
  */
 export declare function getCollectionBySlug(slug: string): Promise<GetCollectionBySlugResponse>;
 /**
@@ -1890,6 +1882,9 @@ export declare function getCollectionBySlug(slug: string): Promise<GetCollection
  * @public
  * @requiredField _id
  * @requiredField options
+ * @permissionScope Manage Orders
+ * @permissionScope Manage Products
+ * @permissionScope Read Products
  */
 export declare function getProductOptionsAvailability(_id: string, options: Record<string, string>): Promise<ProductOptionsAvailabilityResponse>;
 /**
@@ -1899,6 +1894,9 @@ export declare function getProductOptionsAvailability(_id: string, options: Reco
  * @public
  * @documentationMaturity preview
  * @requiredField _id
+ * @permissionScope Manage Orders
+ * @permissionScope Manage Products
+ * @permissionScope Read Products
  */
 export declare function queryProductVariants(_id: string, options?: QueryProductVariantsOptions): Promise<QueryProductVariantsResponse>;
 export interface QueryProductVariantsOptions {
@@ -1919,6 +1917,9 @@ export interface QueryProductVariantsOptions {
  * @public
  * @documentationMaturity preview
  * @requiredField query
+ * @permissionScope Manage Orders
+ * @permissionScope Manage Products
+ * @permissionScope Read Products
  */
 export declare function queryStoreVariants(query: PlatformQuery): Promise<QueryStoreVariantsResponse>;
 /**
@@ -1927,6 +1928,9 @@ export declare function queryStoreVariants(query: PlatformQuery): Promise<QueryS
  * @public
  * @documentationMaturity preview
  * @requiredField _id
+ * @permissionScope Manage Orders
+ * @permissionScope Manage Products
+ * @permissionScope Read Products
  */
 export declare function getStoreVariant(_id: string): Promise<GetStoreVariantResponse>;
 export {};