@wix/ditto-codegen-public 1.0.162 → 1.0.164

package/dist/docs-output/api-docs/stores-collections-queryCollections-doc.txt

@@ -0,0 +1,209 @@
+<stores_collections_queryCollections>
+<description>
+# Method name:
+
+stores.collections.queryCollections()
+
+# Method Link:
+
+https://dev.wix.com/docs/sdk/backend-modules/stores/collections/query-collections
+
+# Method Description:
+
+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.
+
+
+|PROPERTY	|SUPPORTED FILTERS & SORTING	
+|:---:|:---:|
+|`_id`|[`eq()`](/collections-query-builder/eq),[`ne()`](/collections-query-builder/ne),[`exists()`](/collections-query-builder/exists),[`in()`](/collections-query-builder/in),[`hasSome()`](/collections-query-builder/has-some),[`startsWith()`](/collections-query-builder/starts-with),[`gt()`](/collections-query-builder/gt),[`lt()`](/collections-query-builder/lt),[`le()`](/collections-query-builder/le),[`ge()`](/collections-query-builder/ge),[`ascending()`](/collections-query-builder/ascending),[`descending()`](/collections-query-builder/descending)|
+|`name`|[`eq()`](/collections-query-builder/eq),[`ne()`](/collections-query-builder/ne),[`exists()`](/collections-query-builder/exists),[`in()`](/collections-query-builder/in),[`hasSome()`](/collections-query-builder/has-some),[`startsWith()`](/collections-query-builder/starts-with),[`gt()`](/collections-query-builder/gt),[`lt()`](/collections-query-builder/lt),[`le()`](/collections-query-builder/le),[`ge()`](/collections-query-builder/ge),[`ascending()`](/collections-query-builder/ascending),[`descending()`](/collections-query-builder/descending)|
+
+# Method Permissions:
+
+
+
+# Method Permissions Scopes IDs:
+
+undefined
+
+
+
+# Method Code Examples:
+
+## queryCollections
+
+```javascript
+import { collections } from '@wix/stores';
+
+async function queryCollections() {
+ const { items } = await collections.queryCollections().find();
+};
+```
+
+## queryCollections (with elevated permissions)
+
+```javascript
+import { collections } from '@wix/stores';
+import { auth } from '@wix/essentials';
+
+async function myQueryCollectionsMethod(query) {
+ const elevatedQueryCollections = auth.elevate(collections.queryCollections);
+ const response = await elevatedQueryCollections(query);
+}
+```
+
+
+
+## default
+
+```javascript
+try {
+     const { items } = await collections.queryCollections().find();
+     return items;
+   } catch (error) {
+     console.error(error);
+     throw error;
+  }
+```
+</description>
+<type_definition>
+```
+Method: stores.collections.queryCollections()
+Description: 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.   |PROPERTY	|SUPPORTED FILTERS & SORTING	 |:---:|:---:| |`_id`|[`eq()`](/collections-query-builder/eq),[`ne()`](/collections-query-builder/ne),[`exists()`](/collections-query-builder/exists),[`in()`](/collections-query-builder/in),[`hasSome()`](/collections-query-builder/has-some),[`startsWith()`](/collections-query-builder/starts-with),[`gt()`](/collections-query-builder/gt),[`lt()`](/collections-query-builder/lt),[`le()`](/collections-query-builder/le),[`ge()`](/collections-query-builder/ge),[`ascending()`](/collections-query-builder/ascending),[`descending()`](/collections-query-builder/descending)| |`name`|[`eq()`](/collections-query-builder/eq),[`ne()`](/collections-query-builder/ne),[`exists()`](/collections-query-builder/exists),[`in()`](/collections-query-builder/in),[`hasSome()`](/collections-query-builder/has-some),[`startsWith()`](/collections-query-builder/starts-with),[`gt()`](/collections-query-builder/gt),[`lt()`](/collections-query-builder/lt),[`le()`](/collections-query-builder/le),[`ge()`](/collections-query-builder/ge),[`ascending()`](/collections-query-builder/ascending),[`descending()`](/collections-query-builder/descending)|
+Return type: REFERENCE<CollectionsQueryBuilder>
+    Method: stores.collections.queryCollections().ascending(propertyNames)
+    Description: Adds a sort to a query, sorting by the specified properties in ascending order.  The `ascending()` function refines a `CollectionsQueryBuilder` to sort by the value of `propertyName` in ascending order. You can specify multiple properties for sorting in ascending order by passing each property name as an additional argument. `ascending()` sorts the results in the order the properties are passed. You can sort the following types: - Number: Sorts numerically. - Date: Sorts by date and time. - String: Sorts lexicographically, so `'abc'` comes after `'XYZ'`. If a property contains a number stored as a string (for example, `'0'`), that value is sorted alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.
+    Method parameters:
+      param name:  propertyNames | type: Array<string> | description:  Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. 
+    Return type: REFERENCE<CollectionsQueryBuilder>
+    Method: stores.collections.queryCollections().descending(propertyNames)
+    Description: Adds a sort to a query, sorting by the specified properties in descending order.  The `descending()` function refines a `CollectionsQueryBuilder` to sort by the value of `propertyName` in descending order. You can specify multiple properties for sorting in descending order by passing each property name as an additional argument. `descending()` sorts the results in the order the properties are passed. You can sort the following types: - Number: Sorts numerically. - Date: Sorts by date and time. - String: Sorts lexicographically, so `'abc'` comes after `'XYZ'`. If a property contains a number stored as a string (for example, `'0'`), that value is sorted alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.
+    Method parameters:
+      param name:  propertyNames | type: Array<string> | description:  Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. 
+    Return type: REFERENCE<CollectionsQueryBuilder>
+    Method: stores.collections.queryCollections().eq(propertyName, value)
+    Description: Refines a query to match items where the specified property equals the specified value.  The `eq()` function refines a `CollectionsQueryBuilder` to match only items where the value of the specified `propertyName` equals the specified `value`. `eq()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string. Matching strings with `eq()` is case-sensitive, so `'text'` isn't equal to `'Text'`.
+    Method parameters:
+      param name:  propertyName | type: string | description:  Property whose value is compared with `value`. 
+      param name:  value | type: any | description:  Value to compare against. 
+    Return type: REFERENCE<CollectionsQueryBuilder>
+    Method: stores.collections.queryCollections().exists(propertyName, value)
+    Description: Refines a query to match items where the specified property contains a value.  The `exists()` function refines a `CollectionsQueryBuilder` to only match items where the value of the specified `propertyName` doesn't equal null or undefined.  `exists()` checks for either existence or non-existence based on the boolean parameter. Note that `exists()` does match items where the value of the specified `propertyName` is an empty string or an invalid value. `exists()` is only useful for properties which don't contain default values and therefore their values may be unassigned.
+    Method parameters:
+      param name:  propertyName | type: string | description:  none 
+      param name:  value | type: boolean | description:  none 
+    Return type: REFERENCE<CollectionsQueryBuilder>
+    Method: stores.collections.queryCollections().find()
+    Description: Returns the query results.  The `find()` function returns a Promise that resolves to the query results and metadata. The Promise is rejected if `find()` is called with insufficient permissions or if any of the previous functions used to refine the query are invalid.
+    Return type: PROMISE<CollectionsQueryResult>
+          - name: currentPage  | type: number | description:  Returns the index of the current page of results.  `currentPage` is a zero-based index of the current page of results, meaning the 1st page is `0`, the 2nd page is `1`, and so on. If no results match the query, `currentPage` is undefined. The page size is defined by the [`limit()`](/collections-query-builder/limit) function and can be retrieved using the [`pageSize`](#page-size) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `collections` to navigate the pages of a query result. 
+          - name: items  | type: Array<Collection> | description:  Returns an array of `collections` items that match the query.  `items` contains the current page of results retrieved by the query. If no results match the query, `items` is an empty array. The page size is defined by the [`limit()`](/collections-query-builder/limit) function and can be retrieved using the [`pageSize`](#page-size) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `collections` to navigate the pages of a query result. 
+                - name: items[]._id  | type: string | description:  Collection GUID (generated automatically by the catalog). 
+                - name: items[].description  | type: string | description:  Collection description. 
+                - name: items[].media  | type: Media | description:  Media items (images, videos etc) associated with this collection. Read only. 
+                    - name: items[].media.items  | type: Array<MediaItem> | description:  Media (images, videos etc) associated with this product. 
+                          - name: items[].media.items[]._id  | type: string | description:  Media GUID (for example, `"nsplsh_306d666a123a4a74306459~mv2_d_4517_2992_s_4_2.jpg"`). 
+                          - name: items[].media.items[].mediaType  | type: MediaItemType | description:  Media item type (image, video, etc.). 
+                              enum: 
+                                   audio: Audio media type.
+                                   document: Document media type.
+                                   image: Image media type.
+                                 unspecified_media_item_type,   video: Video media type.
+                                   zip: Zip media type.
+                          - name: items[].media.items[].thumbnail  | type: MediaItemUrlAndSize | description:  Media item thumbnail details. 
+                              - name: items[].media.items[].thumbnail.altText  | type: string | description:  Alt text. This text will be shown in case the image is not available. 
+                              - name: items[].media.items[].thumbnail.format  | type: string | description:  Media format (mp4, png, etc.). 
+                              - name: items[].media.items[].thumbnail.height  | type: number | description:  Media item height. 
+                              - name: items[].media.items[].thumbnail.url  | type: string | description:  Media item URL. 
+                              - name: items[].media.items[].thumbnail.width  | type: number | description:  Media item width. 
+                          - name: items[].media.items[].title  | type: string | description:  Media item title. 
+                          - ONE-OF: 
+                            - name: items[].media.items[].image  | type: MediaItemUrlAndSize | description:  Image data (URL, size). 
+                            - name: items[].media.items[].video  | type: MediaItemVideo | description:  Video data (URL, size). 
+                                - name: items[].media.items[].video.files  | type: Array<MediaItemUrlAndSize> | description:  Data (URL, size) about each resolution for which this video is available. 
+                                - name: items[].media.items[].video.stillFrameMediaId  | type: string | description:  GUID of an image taken from the video. Used primarily for Wix Search indexing. For example, `"nsplsh_306d666a123a4a74306459~mv2_d_4517_2992_s_4_2.jpg"`. 
+                    - name: items[].media.mainMedia  | type: MediaItem | description:  Primary media (image, video etc) associated with this product. 
+                - name: items[].name  | type: string | description:  Collection name. 
+                - name: items[].numberOfProducts  | type: number | description:  Number of products in the collection. Read only. 
+                - name: items[].slug  | type: string | description:  Collection slug. 
+                - name: items[].visible  | type: boolean | description:  Collection visibility. Only impacts dynamic pages, no impact on static pages. Default: `true`. 
+          - name: length  | type: number | description:  Returns the number of items in the current page of results.  `length` returns just the number of items in the current page, not the total number of items that match the query. For the total number of items that match the query, see [`totalCount`](#total-count). The page size is defined by the [`limit()`](/collections-query-builder/limit) function and can be retrieved using the [`pageSize`](#page-size) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `collections` to navigate the pages of a query result. 
+          - name: pageSize  | type: number | description:  Returns the requested page size.  `pageSize` returns the page size set in [`limit()`](/collections-query-builder/limit) in `CollectionsQueryBuilder`. 
+          - name: query  | type: CollectionsQueryBuilder | description:  Returns the `CollectionsQueryBuilder` object used to get the current results.  Use `query` to create and run a new query by chaining additional `CollectionsQueryBuilder` functions to it. You can filter only on properties that haven't already been used in the previous `CollectionsQueryBuilder`. 
+          - name: totalCount  | type: number | description:  Returns the total number of items that match the query.  `totalCount` returns the total number of items that match the query, not just the number of items in the current page. For the number of items in the current page, see [`length`](#length). 
+          - name: totalPages  | type: number | description:  Returns the total number of pages the query produced.  The page size is defined by the [`limit()`](/collections-query-builder/limit) function and can be retrieved using the [`pageSize`](page-size) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `collections` to navigate the pages of a query result. 
+          Method: stores.collections.hasNext()
+          Description: Indicates whether the query has more results.  You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `collections` to navigate the pages of a query result.
+          Return type: PRIMITIVE<boolean>
+          Method: stores.collections.hasPrev()
+          Description: Indicates whether the query has previous results.  You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `collections` to navigate the pages of a query result.
+          Return type: PRIMITIVE<boolean>
+          Method: stores.collections.queryCollections().next()
+          Description: Retrieves the next page of query results.  The `next()` function retrieves the next page of query results. The page size is defined by the [`limit()`](/collections-query-builder/limit) function and can be retrieved using the [`pageSize`](#page-size) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `collections` to navigate the pages of a query result. If items are added or removed between calls to `next()`, the values returned by `CollectionsQueryBuilder` may change.
+          Return type: PROMISE<CollectionsQueryResult>
+          Method: stores.collections.queryCollections().prev()
+          Description: Retrieves the previous page of query results.  The `prev()` function retrieves the previous page of query results. The page size is defined by the [`limit()`](/collections-query-builder/limit) function and can be retrieved using the [`pageSize`](#page-size) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `collections` to navigate the pages of a query result. If items are added or removed between calls to `prev()`, the values returned may change.
+          Return type: PROMISE<CollectionsQueryResult>
+    Method: stores.collections.queryCollections().ge(propertyName, value)
+    Description: Refines a query to match items where the specified property is greater than or equal to the specified value.  The `ge()` function refines a `CollectionsQueryBuilder` to match only items where the value of the specified `propertyName` is greater than or equal to the specified `value`. `ge()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string. If a property contains a number stored as a string (for example, `'0'`), that value is compared alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest. The following types of properties can be compared: - Number: Compares numerically. - Date: Compares JavaScript Date objects.  - String: Compares lexicographically, so `'abc'` is greater than `'ABC'`.
+    Method parameters:
+      param name:  propertyName | type: string | description:  Property whose value is compared with `value`. 
+      param name:  value | type: any | description:  Value to compare against. 
+    Return type: REFERENCE<CollectionsQueryBuilder>
+    Method: stores.collections.queryCollections().gt(propertyName, value)
+    Description: Refines a query to match items where the specified property is greater than the specified value.  The `gt()` function refines a `CollectionsQueryBuilder` to match only items where the value of the specified `propertyName` is greater than the specified `value`. `gt()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string. If a property contains a number stored as a string (for example, `'0'`), that value is compared alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest. The following types of properties can be compared: - Number: Compares numerically. - Date: Compares JavaScript Date objects.  - String: Compares lexicographically, so `'abc'` is greater than `'ABC'`.
+    Method parameters:
+      param name:  propertyName | type: string | description:  Property whose value is compared with `value`. 
+      param name:  value | type: any | description:  Value to compare against. 
+    Return type: REFERENCE<CollectionsQueryBuilder>
+    Method: stores.collections.queryCollections().hasSome(propertyName, value)
+    Description: Refines a query to match items whose specified property contains any of the specified values.  The `hasSome()` function refines a `CollectionsQueryBuilder` to match only items where the value of the specified `propertyName` equals any of the specified `values`. Matching strings with `hasSome()` is case-sensitive, so `'text'` isn't equal to `'Text'`. If the specified property is an array, `hasSome()` matches if any of that array's elements equal any of the specified values.
+    Method parameters:
+      param name:  propertyName | type: string | description:  Property whose value is compared with `values`. 
+      param name:  value | type: Array<any> | description:  none 
+    Return type: REFERENCE<CollectionsQueryBuilder>
+    Method: stores.collections.queryCollections().in(propertyName, value)
+    Description: Refines a query to only match items where the specified property contains any of the values in the provided array of values.  The `in()` function refines a `CollectionsQueryBuilder` to match only items where the specified `propertyName` is equal to any of the values in the provided array. Matching strings with `in()` is case-sensitive, so `'text'` isn't equal to `'Text'`.
+    Method parameters:
+      param name:  propertyName | type: string | description:  none 
+      param name:  value | type: any | description:  none 
+    Return type: REFERENCE<CollectionsQueryBuilder>
+    Method: stores.collections.queryCollections().le(propertyName, value)
+    Description: Refines a query to match items where the specified property is less than or equal to the specified value.  The `le()` function refines a `CollectionsQueryBuilder` to match only items where the value of the specified `propertyName` is less than or equal to the specified `value`. `le()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string. If a property contains a number stored as a string (for example, `'0'`), that value is compared alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest. The following types of properties can be compared: - Number: Compares numerically. - Date: Compares JavaScript Date objects.  - String: Compares lexicographically, so `'ABC'` is less than `'abc'`.
+    Method parameters:
+      param name:  propertyName | type: string | description:  Property whose value is compared with `value`. 
+      param name:  value | type: any | description:  Value to compare against. 
+    Return type: REFERENCE<CollectionsQueryBuilder>
+    Method: stores.collections.queryCollections().limit(limit)
+    Description: Limits the number of items the query returns.  The `limit()` function defines the number of results a query returns in each page. Only one page of results is retrieved at a time. You can use the `next()` and `prev()` functions to navigate the pages of a query result.
+    Method parameters:
+      param name:  limit | type: number | description:  Number of items to return, which is also the `pageSize` of the results object. 
+    Return type: REFERENCE<CollectionsQueryBuilder>
+    Method: stores.collections.queryCollections().lt(propertyName, value)
+    Description: Refines a query to match items where the specified property is less than the specified value.  The `le()` function refines a `CollectionsQueryBuilder` to match only items where the value of the specified `propertyName` is less than the specified `value`. `le()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string. If a property contains a number stored as a string (for example, `'0'`), that value is compared alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest. The following types of properties can be compared: - Number: Compares numerically. - Date: Compares JavaScript Date objects.  - String: Compares lexicographically, so `'ABC'` is less than `'abc'`.
+    Method parameters:
+      param name:  propertyName | type: string | description:  Property whose value is compared with `value`. 
+      param name:  value | type: any | description:  Value to compare against. 
+    Return type: REFERENCE<CollectionsQueryBuilder>
+    Method: stores.collections.queryCollections().ne(propertyName, value)
+    Description: Refines a query to match items where the specified property doesn't equal the specified value.  The `ne()` function refines a `CollectionsQueryBuilder` to match only items where the value of the specified `propertyName` doesn't equal the specified `value`. `ne()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string. Matching strings with `ne()` is case-sensitive, so `'text'` isn't equal to `'Text'`.
+    Method parameters:
+      param name:  propertyName | type: string | description:  Property whose value is compared with `value`. 
+      param name:  value | type: any | description:  Value to compare against. 
+    Return type: REFERENCE<CollectionsQueryBuilder>
+    Method: stores.collections.queryCollections().skip(skip)
+    Description: Sets the number of items to skip before returning query results.  The `skip()` function defines the number of results to skip before returning new query results. For example, if you query a collection and 50 items match your query, but you set `skip()` to `10`, the first 10 items that match are ignored, and the 11th through 50th items are returned.
+    Method parameters:
+      param name:  skip | type: number | description:  Number of items to skip in the query results before returning the results. 
+    Return type: REFERENCE<CollectionsQueryBuilder>
+    Method: stores.collections.queryCollections().startsWith(propertyName, value)
+    Description: Refines a query to match items where the specified property starts with the specified value.  The `startsWith()` function refines a `CollectionsQueryBuilder` to match only items where the value of the specified `propertyName` starts with the specified `string`. Matching with `startsWith()` is case-sensitive, so `'TEXT'` doesn't start with `'text'`. You can only use `startsWith()` with a property whose value is a string.
+    Method parameters:
+      param name:  propertyName | type: string | description:  Property whose value is compared with `string`. 
+      param name:  value | type: string | description:  none 
+    Return type: REFERENCE<CollectionsQueryBuilder>
+
+```
+</type_definition>
+</stores_collections_queryCollections>

package/dist/docs-output/api-docs/stores-collections-removeProductsFromCollection-doc.txt

@@ -0,0 +1,86 @@
+<stores_collections_removeProductsFromCollection>
+<description>
+# Method name:
+
+stores.products.removeProductsFromCollection(_id: string, productIds: Array<string>)
+
+# Method Link:
+
+https://dev.wix.com/docs/sdk/backend-modules/stores/products/remove-products-from-collection
+
+# Method Description:
+
+Deletes products from a specified collection.
+
+# Method Permissions:
+
+- WIX_STORES.MODIFY_PRODUCTS
+
+# Method Permissions Scopes IDs:
+
+undefined
+
+
+
+# Method Code Examples:
+
+## Remove products from a product collection 
+
+```javascript
+/**************************************
+* Backend code - products.web.js/ts *
+**************************************/
+
+import { Permissions, webMethod } from '@wix/web-methods';
+import { products } from '@wix/stores';
+
+export const removeProductsFromCollection = webMethod(Permissions.Anyone, (_id, productIds) => {
+ return products.removeProductsFromCollection(_id, productIds);
+});
+
+/*************
+* Page code *
+*************/
+
+import { removeProductsFromCollection } from 'backend/products.web';
+
+// ...
+
+const _id =  ... // get collection ID
+const productIds = ["id1", "id2", "id3"];
+
+removeProductsFromCollection(_id, productIds)
+ .then(() => {
+   // products removed from the collection 
+ })
+ .catch((error) => {
+   // products not removed from the collection 
+ });
+```
+
+
+
+## default
+
+```javascript
+try {
+     const result = await products.removeProductsFromCollection("4d87a788-6d4a-436e-9775-14f747d55784", ["7bb38a7a-70b7-9cf3-fc80-584205694465"]);
+     return result;
+   } catch (error) {
+     console.error(error);
+     throw error;
+  }
+```
+</description>
+<type_definition>
+```
+Method: stores.products.removeProductsFromCollection(_id, productIds)
+Description: Deletes products from a specified collection.
+Method parameters:
+  param name:  _id | type: string | description:  GUID of the collection from which to remove products. | required: true
+  param name:  productIds | type: Array<string> | description:  IDs of the products to remove from the collection. | required: true
+Return type: PROMISE<void>
+
+```
+</type_definition>
+</stores_collections_removeProductsFromCollection>

package/dist/docs-output/api-docs/stores-collections-updateCollection-doc.txt

@@ -0,0 +1,110 @@
+<stores_collections_updateCollection>
+<description>
+# Method name:
+
+stores.products.updateCollection(_id: string, collection: UpdateCollection)
+
+# Method Link:
+
+https://dev.wix.com/docs/sdk/backend-modules/stores/products/update-collection
+
+# Method Description:
+
+Updates specified properties of a collection. To add products to a collection, call the [addProductsToCollection](#addproductstocollection) function.
+
+# Method Permissions:
+
+- WIX_STORES.MODIFY_PRODUCTS
+
+# Method Permissions Scopes IDs:
+
+undefined
+
+
+
+# Method Code Examples:
+
+## updateCollection
+
+```javascript
+import { products } from '@wix/stores';
+
+async function updateCollection(id, collection) {
+ const response = await products.updateCollection(id, collection);
+};
+```
+
+## updateCollection (with elevated permissions)
+
+```javascript
+import { products } from '@wix/stores';
+import { auth } from '@wix/essentials';
+
+async function myUpdateCollectionMethod(id, collection) {
+ const elevatedUpdateCollection = auth.elevate(products.updateCollection);
+ const response = await elevatedUpdateCollection(id, collection);
+}
+```
+
+
+
+## default
+
+```javascript
+try {
+ const result = await products.updateCollection("f582efb2-c3d8-44e0-8cb2-26d5e58bda64", {
+   name: "Updated Collection " + Math.random()
+ });
+ return result;
+} catch (error) {
+ console.error(error);
+ throw error;
+}
+```
+</description>
+<type_definition>
+```
+Method: stores.products.updateCollection(_id, collection)
+Description: Updates specified properties of a collection. To add products to a collection, call the [addProductsToCollection](#addproductstocollection) function.
+Method parameters:
+  param name:  _id | type: string | description:  Collection GUID (generated automatically by the catalog). | required: true
+  param name:  collection | type: UpdateCollection | description:  Collection info to update. | required: true
+      - name: description  | type: string | description:  Collection description. 
+      - name: name  | type: string | description:  Collection name. 
+      - name: slug  | type: string | description:  Collection slug. 
+      - name: visible  | type: boolean | description:  Collection visibility. Only impacts dynamic pages, no impact on static pages. Default: `true`. 
+Return type: PROMISE<UpdateCollectionResponse>
+      - name: collection  | type: Collection | description:  Updated collection. 
+          - name: collection._id  | type: string | description:  Collection GUID (generated automatically by the catalog). 
+          - name: collection.description  | type: string | description:  Collection description. 
+          - name: collection.media  | type: Media | description:  Media items (images, videos etc) associated with this collection. Read only. 
+              - name: collection.media.items  | type: Array<MediaItem> | description:  Media (images, videos etc) associated with this product. 
+                    - name: collection.media.items[]._id  | type: string | description:  Media GUID (for example, `"nsplsh_306d666a123a4a74306459~mv2_d_4517_2992_s_4_2.jpg"`). 
+                    - name: collection.media.items[].mediaType  | type: MediaItemType | description:  Media item type (image, video, etc.). 
+                        enum: 
+                             audio: Audio media type.
+                             document: Document media type.
+                             image: Image media type.
+                           unspecified_media_item_type,   video: Video media type.
+                             zip: Zip media type.
+                    - name: collection.media.items[].thumbnail  | type: MediaItemUrlAndSize | description:  Media item thumbnail details. 
+                        - name: collection.media.items[].thumbnail.altText  | type: string | description:  Alt text. This text will be shown in case the image is not available. 
+                        - name: collection.media.items[].thumbnail.format  | type: string | description:  Media format (mp4, png, etc.). 
+                        - name: collection.media.items[].thumbnail.height  | type: number | description:  Media item height. 
+                        - name: collection.media.items[].thumbnail.url  | type: string | description:  Media item URL. 
+                        - name: collection.media.items[].thumbnail.width  | type: number | description:  Media item width. 
+                    - name: collection.media.items[].title  | type: string | description:  Media item title. 
+                    - ONE-OF: 
+                      - name: collection.media.items[].image  | type: MediaItemUrlAndSize | description:  Image data (URL, size). 
+                      - name: collection.media.items[].video  | type: MediaItemVideo | description:  Video data (URL, size). 
+                          - name: collection.media.items[].video.files  | type: Array<MediaItemUrlAndSize> | description:  Data (URL, size) about each resolution for which this video is available. 
+                          - name: collection.media.items[].video.stillFrameMediaId  | type: string | description:  GUID of an image taken from the video. Used primarily for Wix Search indexing. For example, `"nsplsh_306d666a123a4a74306459~mv2_d_4517_2992_s_4_2.jpg"`. 
+              - name: collection.media.mainMedia  | type: MediaItem | description:  Primary media (image, video etc) associated with this product. 
+          - name: collection.name  | type: string | description:  Collection name. 
+          - name: collection.numberOfProducts  | type: number | description:  Number of products in the collection. Read only. 
+          - name: collection.slug  | type: string | description:  Collection slug. 
+          - name: collection.visible  | type: boolean | description:  Collection visibility. Only impacts dynamic pages, no impact on static pages. Default: `true`. 
+
+```
+</type_definition>
+</stores_collections_updateCollection>

package/dist/docs-output/api-docs/stores-inventory-queryInventory-doc.txt

@@ -0,0 +1,98 @@
+<stores_inventory_queryInventory>
+<description>
+# Method name:
+
+stores.inventory.queryInventory(options: QueryInventoryOptions)
+
+# Method Link:
+
+https://dev.wix.com/docs/sdk/backend-modules/stores/inventory/query-inventory
+
+# Method Description:
+
+Returns a list of inventory items, given the provided paging, sorting and filtering.
+
+# Method Permissions:
+
+- WIX_STORES.READ_INVENTORY
+
+# Method Permissions Scopes IDs:
+
+undefined
+
+
+
+# Method Code Examples:
+
+## queryInventory
+
+```javascript
+import { inventory } from '@wix/stores';
+
+async function queryInventory(options) {
+ const response = await inventory.queryInventory(options);
+};
+```
+
+## queryInventory (with elevated permissions)
+
+```javascript
+import { inventory } from '@wix/stores';
+import { auth } from '@wix/essentials';
+
+async function myQueryInventoryMethod(options) {
+ const elevatedQueryInventory = auth.elevate(inventory.queryInventory);
+ const response = await elevatedQueryInventory(options);
+}
+```
+
+
+
+## default
+
+```javascript
+try {
+     const result = await inventory.queryInventory();
+     return result;
+   } catch (error) {
+     console.error(error);
+     throw error;
+  }
+```
+</description>
+<type_definition>
+```
+Method: stores.inventory.queryInventory(options)
+Description: Returns a list of inventory items, given the provided paging, sorting and filtering.
+Method parameters:
+  param name:  options | type: QueryInventoryOptions | description:  none 
+      - name: query  | type: Query | description:  Information about paging, filters, sorting. 
+          - name: filter  | type: string | description:  Filter string 
+          - name: paging  | type: Paging | description:  Paging options to limit and skip the number of items. 
+              - name: limit  | type: number | description:  Amount of items to load per page 
+              - name: offset  | type: number | description:  Number of items to skip in the display (relevant for all pages after the first) 
+          - name: sort  | type: string | description:  Sort string 
+Return type: PROMISE<QueryInventoryResponse>
+      - name: inventoryItems  | type: Array<InventoryItemV2> | description:  Inventory items. 
+            - name: inventoryItems[]._id  | type: string | description:  Inventory item GUID. 
+            - name: inventoryItems[].lastUpdated  | type: Date | description:  Last updated timestamp. 
+            - name: inventoryItems[].numericId  | type: string | description:  Inventory’s unique numeric GUID (assigned in ascending order). Primarily for sorting and filtering when crawling all inventories. 
+            - name: inventoryItems[].preorderInfo  | type: PreorderInfo | description:  Preorder information. 
+                - name: inventoryItems[].preorderInfo.enabled  | type: boolean | description:  Whether the item is available for preorder. 
+                - name: inventoryItems[].preorderInfo.limit  | type: number | description:  Number of products that can be preordered after stock reaches zero. 
+                - name: inventoryItems[].preorderInfo.message  | type: string | description:  A message the buyer will see when the item is out of stock and preorder is enabled. 
+            - name: inventoryItems[].productId  | type: string | description:  Product GUID. 
+            - name: inventoryItems[].trackQuantity  | type: boolean | description:  Whether quantity is being tracked. 
+            - name: inventoryItems[].variants  | type: Array<InventoryVariantV2> | description:  Variants associated with this inventory item. 
+                  - name: inventoryItems[].variants[].availableForPreorder  | type: boolean | description:  Whether the variant is available for preorder. When `true`, the variant is out of stock and preorder is enabled on inventory level. 
+                  - name: inventoryItems[].variants[].inStock  | type: boolean | description:  Whether the product is listed as in stock. 
+                  - name: inventoryItems[].variants[].quantity  | type: number | description:  Quantity currently left in inventory. 
+                  - name: inventoryItems[].variants[].variantId  | type: string | description:  Variant GUID. 
+      - name: metadata  | type: PagingMetadata | description:  Display metadata. 
+          - name: metadata.items  | type: number | description:  Amount of items to load per page 
+          - name: metadata.offset  | type: number | description:  Number of items to skip in the display (relevant for all pages after the first) 
+      - name: totalResults  | type: number | description:  Number of total results. 
+
+```
+</type_definition>
+</stores_inventory_queryInventory>