@wix/restaurants_menus - npm Package Compare versions

Comparing version 1.0.17 to 1.0.18

build/cjs/src/restaurants-menus-v1-menu-menus.http.d.ts

@@ -29,7 +29,16 @@ import { RequestOptionsFactory } from '@wix/sdk-types';
 /**
- * > **Note:** The Menu API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).
+ * Creates a query to retrieve a list of menus.
  *
- * Retrieves a list of menus given the provided paging, filtering, and sorting. Up to 500 menus can be returned per request.
+ * The `queryMenus()` function builds a query to retrieve a list of menus and returns a `MenusQueryBuilder` object.
  *
- * For a detailed list of supported operations, see the [Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-solutions/restaurants/menus/menu/supported-filters-and-sorting) article. To learn how to query menus, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language).
+ * The returned object contains the query definition, which is used to run the query using the [`find()`](/menus/menus-query-builder/find) function.
+ *
+ * You can refine the query by chaining `MenusQueryBuilder` functions onto the query. `MenusQueryBuilder` functions enable you to filter, sort, and control the results that `queryMenus()` returns.
+ *
+ * `queryMenus()` runs with the following `MenusQueryBuilder` defaults, which you can override:
+ *
+ * * [`limit(100)`](/menus/menus-query-builder/limit)
+ * * [`ascending('entityId')`](/menus/menus-query-builder/ascending)
+ *
+ * The following `MenusQueryBuilder` functions are supported for `queryMenus()`. For a full description of the menu object, see the object returned for the [`items`](/menus/menus-query-result/items) property in `MenusQueryResult`.
  */
@@ -36,0 +45,0 @@ export declare function queryMenus(payload: object): RequestOptionsFactory<any>;

build/cjs/src/restaurants-menus-v1-menu-menus.http.js

@@ -212,7 +212,16 @@ "use strict";
 /**
- * > **Note:** The Menu API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).
+ * Creates a query to retrieve a list of menus.
  *
- * Retrieves a list of menus given the provided paging, filtering, and sorting. Up to 500 menus can be returned per request.
+ * The `queryMenus()` function builds a query to retrieve a list of menus and returns a `MenusQueryBuilder` object.
  *
- * For a detailed list of supported operations, see the [Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-solutions/restaurants/menus/menu/supported-filters-and-sorting) article. To learn how to query menus, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language).
+ * The returned object contains the query definition, which is used to run the query using the [`find()`](/menus/menus-query-builder/find) function.
+ *
+ * You can refine the query by chaining `MenusQueryBuilder` functions onto the query. `MenusQueryBuilder` functions enable you to filter, sort, and control the results that `queryMenus()` returns.
+ *
+ * `queryMenus()` runs with the following `MenusQueryBuilder` defaults, which you can override:
+ *
+ * * [`limit(100)`](/menus/menus-query-builder/limit)
+ * * [`ascending('entityId')`](/menus/menus-query-builder/ascending)
+ *
+ * The following `MenusQueryBuilder` functions are supported for `queryMenus()`. For a full description of the menu object, see the object returned for the [`items`](/menus/menus-query-result/items) property in `MenusQueryResult`.
  */
@@ -219,0 +228,0 @@ function queryMenus(payload) {

build/cjs/src/restaurants-menus-v1-menu-menus.universal.d.ts

@@ -563,2 +563,4 @@ export interface Menu {
  * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @webhook
@@ -579,2 +581,4 @@ * @eventType wix.restaurants.menus.v1.menu_created
  * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @webhook
@@ -594,2 +598,4 @@ * @eventType wix.restaurants.menus.v1.menu_updated
  * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @webhook
@@ -614,2 +620,4 @@ * @eventType wix.restaurants.menus.v1.menu_deleted
  * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @applicableIdentity APP
@@ -631,2 +639,4 @@ * @returns Menu.
  * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @applicableIdentity APP
@@ -651,2 +661,4 @@ */
  * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @applicableIdentity APP
@@ -668,2 +680,4 @@ * @applicableIdentity MEMBER
  * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @applicableIdentity APP
@@ -681,7 +695,16 @@ * @applicableIdentity MEMBER
 /**
- * > **Note:** The Menu API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).
+ * Creates a query to retrieve a list of menus.
  *
- * Retrieves a list of menus given the provided paging, filtering, and sorting. Up to 500 menus can be returned per request.
+ * The `queryMenus()` function builds a query to retrieve a list of menus and returns a `MenusQueryBuilder` object.
  *
- * For a detailed list of supported operations, see the [Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-solutions/restaurants/menus/menu/supported-filters-and-sorting) article. To learn how to query menus, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language).
+ * The returned object contains the query definition, which is used to run the query using the [`find()`](/menus/menus-query-builder/find) function.
+ *
+ * You can refine the query by chaining `MenusQueryBuilder` functions onto the query. `MenusQueryBuilder` functions enable you to filter, sort, and control the results that `queryMenus()` returns.
+ *
+ * `queryMenus()` runs with the following `MenusQueryBuilder` defaults, which you can override:
+ *
+ * * [`limit(100)`](/menus/menus-query-builder/limit)
+ * * [`ascending('entityId')`](/menus/menus-query-builder/ascending)
+ *
+ * The following `MenusQueryBuilder` functions are supported for `queryMenus()`. For a full description of the menu object, see the object returned for the [`items`](/menus/menus-query-result/items) property in `MenusQueryResult`.
  * @public
@@ -693,2 +716,4 @@ * @documentationMaturity preview
  * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @applicableIdentity APP
@@ -779,2 +804,4 @@ * @applicableIdentity MEMBER
  * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @applicableIdentity APP
@@ -834,2 +861,4 @@ * @returns Updated menu.
  * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @applicableIdentity APP
@@ -874,2 +903,4 @@ */
  * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @applicableIdentity APP
@@ -876,0 +907,0 @@ */

build/cjs/src/restaurants-menus-v1-menu-menus.universal.js

@@ -58,2 +58,4 @@ "use strict";
  * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @applicableIdentity APP
@@ -96,2 +98,4 @@ * @returns Menu.
  * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @applicableIdentity APP
@@ -139,2 +143,4 @@ */
  * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @applicableIdentity APP
@@ -177,2 +183,4 @@ * @applicableIdentity MEMBER
  * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @applicableIdentity APP
@@ -211,7 +219,16 @@ * @applicableIdentity MEMBER
 /**
- * > **Note:** The Menu API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).
+ * Creates a query to retrieve a list of menus.
  *
- * Retrieves a list of menus given the provided paging, filtering, and sorting. Up to 500 menus can be returned per request.
+ * The `queryMenus()` function builds a query to retrieve a list of menus and returns a `MenusQueryBuilder` object.
  *
- * For a detailed list of supported operations, see the [Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-solutions/restaurants/menus/menu/supported-filters-and-sorting) article. To learn how to query menus, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language).
+ * The returned object contains the query definition, which is used to run the query using the [`find()`](/menus/menus-query-builder/find) function.
+ *
+ * You can refine the query by chaining `MenusQueryBuilder` functions onto the query. `MenusQueryBuilder` functions enable you to filter, sort, and control the results that `queryMenus()` returns.
+ *
+ * `queryMenus()` runs with the following `MenusQueryBuilder` defaults, which you can override:
+ *
+ * * [`limit(100)`](/menus/menus-query-builder/limit)
+ * * [`ascending('entityId')`](/menus/menus-query-builder/ascending)
+ *
+ * The following `MenusQueryBuilder` functions are supported for `queryMenus()`. For a full description of the menu object, see the object returned for the [`items`](/menus/menus-query-result/items) property in `MenusQueryResult`.
  * @public
@@ -223,2 +240,4 @@ * @documentationMaturity preview
  * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @applicableIdentity APP
@@ -290,2 +309,4 @@ * @applicableIdentity MEMBER
  * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @applicableIdentity APP
@@ -334,2 +355,4 @@ * @returns Updated menu.
  * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @applicableIdentity APP
@@ -422,2 +445,4 @@ */
  * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @applicableIdentity APP
@@ -424,0 +449,0 @@ */

build/es/src/restaurants-menus-v1-menu-menus.http.d.ts

@@ -29,7 +29,16 @@ import { RequestOptionsFactory } from '@wix/sdk-types';
 /**
- * > **Note:** The Menu API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).
+ * Creates a query to retrieve a list of menus.
  *
- * Retrieves a list of menus given the provided paging, filtering, and sorting. Up to 500 menus can be returned per request.
+ * The `queryMenus()` function builds a query to retrieve a list of menus and returns a `MenusQueryBuilder` object.
  *
- * For a detailed list of supported operations, see the [Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-solutions/restaurants/menus/menu/supported-filters-and-sorting) article. To learn how to query menus, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language).
+ * The returned object contains the query definition, which is used to run the query using the [`find()`](/menus/menus-query-builder/find) function.
+ *
+ * You can refine the query by chaining `MenusQueryBuilder` functions onto the query. `MenusQueryBuilder` functions enable you to filter, sort, and control the results that `queryMenus()` returns.
+ *
+ * `queryMenus()` runs with the following `MenusQueryBuilder` defaults, which you can override:
+ *
+ * * [`limit(100)`](/menus/menus-query-builder/limit)
+ * * [`ascending('entityId')`](/menus/menus-query-builder/ascending)
+ *
+ * The following `MenusQueryBuilder` functions are supported for `queryMenus()`. For a full description of the menu object, see the object returned for the [`items`](/menus/menus-query-result/items) property in `MenusQueryResult`.
  */
@@ -36,0 +45,0 @@ export declare function queryMenus(payload: object): RequestOptionsFactory<any>;

build/es/src/restaurants-menus-v1-menu-menus.http.js

@@ -205,7 +205,16 @@ import { toURLSearchParams } from '@wix/metro-runtime';
 /**
- * > **Note:** The Menu API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).
+ * Creates a query to retrieve a list of menus.
  *
- * Retrieves a list of menus given the provided paging, filtering, and sorting. Up to 500 menus can be returned per request.
+ * The `queryMenus()` function builds a query to retrieve a list of menus and returns a `MenusQueryBuilder` object.
  *
- * For a detailed list of supported operations, see the [Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-solutions/restaurants/menus/menu/supported-filters-and-sorting) article. To learn how to query menus, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language).
+ * The returned object contains the query definition, which is used to run the query using the [`find()`](/menus/menus-query-builder/find) function.
+ *
+ * You can refine the query by chaining `MenusQueryBuilder` functions onto the query. `MenusQueryBuilder` functions enable you to filter, sort, and control the results that `queryMenus()` returns.
+ *
+ * `queryMenus()` runs with the following `MenusQueryBuilder` defaults, which you can override:
+ *
+ * * [`limit(100)`](/menus/menus-query-builder/limit)
+ * * [`ascending('entityId')`](/menus/menus-query-builder/ascending)
+ *
+ * The following `MenusQueryBuilder` functions are supported for `queryMenus()`. For a full description of the menu object, see the object returned for the [`items`](/menus/menus-query-result/items) property in `MenusQueryResult`.
  */
@@ -212,0 +221,0 @@ export function queryMenus(payload) {

build/es/src/restaurants-menus-v1-menu-menus.universal.d.ts

@@ -563,2 +563,4 @@ export interface Menu {
  * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @webhook
@@ -579,2 +581,4 @@ * @eventType wix.restaurants.menus.v1.menu_created
  * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @webhook
@@ -594,2 +598,4 @@ * @eventType wix.restaurants.menus.v1.menu_updated
  * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @webhook
@@ -614,2 +620,4 @@ * @eventType wix.restaurants.menus.v1.menu_deleted
  * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @applicableIdentity APP
@@ -631,2 +639,4 @@ * @returns Menu.
  * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @applicableIdentity APP
@@ -651,2 +661,4 @@ */
  * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @applicableIdentity APP
@@ -668,2 +680,4 @@ * @applicableIdentity MEMBER
  * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @applicableIdentity APP
@@ -681,7 +695,16 @@ * @applicableIdentity MEMBER
 /**
- * > **Note:** The Menu API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).
+ * Creates a query to retrieve a list of menus.
  *
- * Retrieves a list of menus given the provided paging, filtering, and sorting. Up to 500 menus can be returned per request.
+ * The `queryMenus()` function builds a query to retrieve a list of menus and returns a `MenusQueryBuilder` object.
  *
- * For a detailed list of supported operations, see the [Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-solutions/restaurants/menus/menu/supported-filters-and-sorting) article. To learn how to query menus, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language).
+ * The returned object contains the query definition, which is used to run the query using the [`find()`](/menus/menus-query-builder/find) function.
+ *
+ * You can refine the query by chaining `MenusQueryBuilder` functions onto the query. `MenusQueryBuilder` functions enable you to filter, sort, and control the results that `queryMenus()` returns.
+ *
+ * `queryMenus()` runs with the following `MenusQueryBuilder` defaults, which you can override:
+ *
+ * * [`limit(100)`](/menus/menus-query-builder/limit)
+ * * [`ascending('entityId')`](/menus/menus-query-builder/ascending)
+ *
+ * The following `MenusQueryBuilder` functions are supported for `queryMenus()`. For a full description of the menu object, see the object returned for the [`items`](/menus/menus-query-result/items) property in `MenusQueryResult`.
  * @public
@@ -693,2 +716,4 @@ * @documentationMaturity preview
  * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @applicableIdentity APP
@@ -779,2 +804,4 @@ * @applicableIdentity MEMBER
  * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @applicableIdentity APP
@@ -834,2 +861,4 @@ * @returns Updated menu.
  * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @applicableIdentity APP
@@ -874,2 +903,4 @@ */
  * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @applicableIdentity APP
@@ -876,0 +907,0 @@ */

build/es/src/restaurants-menus-v1-menu-menus.universal.js

@@ -32,2 +32,4 @@ import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';
  * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @applicableIdentity APP
@@ -69,2 +71,4 @@ * @returns Menu.
  * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @applicableIdentity APP
@@ -111,2 +115,4 @@ */
  * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @applicableIdentity APP
@@ -148,2 +154,4 @@ * @applicableIdentity MEMBER
  * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @applicableIdentity APP
@@ -181,7 +189,16 @@ * @applicableIdentity MEMBER
 /**
- * > **Note:** The Menu API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).
+ * Creates a query to retrieve a list of menus.
  *
- * Retrieves a list of menus given the provided paging, filtering, and sorting. Up to 500 menus can be returned per request.
+ * The `queryMenus()` function builds a query to retrieve a list of menus and returns a `MenusQueryBuilder` object.
  *
- * For a detailed list of supported operations, see the [Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-solutions/restaurants/menus/menu/supported-filters-and-sorting) article. To learn how to query menus, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language).
+ * The returned object contains the query definition, which is used to run the query using the [`find()`](/menus/menus-query-builder/find) function.
+ *
+ * You can refine the query by chaining `MenusQueryBuilder` functions onto the query. `MenusQueryBuilder` functions enable you to filter, sort, and control the results that `queryMenus()` returns.
+ *
+ * `queryMenus()` runs with the following `MenusQueryBuilder` defaults, which you can override:
+ *
+ * * [`limit(100)`](/menus/menus-query-builder/limit)
+ * * [`ascending('entityId')`](/menus/menus-query-builder/ascending)
+ *
+ * The following `MenusQueryBuilder` functions are supported for `queryMenus()`. For a full description of the menu object, see the object returned for the [`items`](/menus/menus-query-result/items) property in `MenusQueryResult`.
  * @public
@@ -193,2 +210,4 @@ * @documentationMaturity preview
  * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @applicableIdentity APP
@@ -259,2 +278,4 @@ * @applicableIdentity MEMBER
  * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @applicableIdentity APP
@@ -302,2 +323,4 @@ * @returns Updated menu.
  * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @applicableIdentity APP
@@ -388,2 +411,4 @@ */
  * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @applicableIdentity APP
@@ -390,0 +415,0 @@ */

package.json

 {
   "name": "@wix/restaurants_menus",
-  "version": "1.0.17",
+  "version": "1.0.18",
   "publishConfig": {
@@ -48,3 +48,3 @@ "registry": "https://registry.npmjs.org/",
   },
-  "falconPackageHash": "bdad370f89eab6123e354afc1efbb3ce3a34edede5f5ce898ebc6855"
+  "falconPackageHash": "79fc1a1989f76abafcc240d1755a229c15417ff94ecad80766f4c5de"
 }

type-bundles/index.typings.bundle.d.ts

@@ -563,2 +563,4 @@ interface Menu {
  * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @webhook
@@ -579,2 +581,4 @@ * @eventType wix.restaurants.menus.v1.menu_created
  * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @webhook
@@ -594,2 +598,4 @@ * @eventType wix.restaurants.menus.v1.menu_updated
  * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @webhook
@@ -614,2 +620,4 @@ * @eventType wix.restaurants.menus.v1.menu_deleted
  * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @applicableIdentity APP
@@ -631,2 +639,4 @@ * @returns Menu.
  * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @applicableIdentity APP
@@ -651,2 +661,4 @@ */
  * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @applicableIdentity APP
@@ -668,2 +680,4 @@ * @applicableIdentity MEMBER
  * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @applicableIdentity APP
@@ -681,7 +695,16 @@ * @applicableIdentity MEMBER
 /**
- * > **Note:** The Menu API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).
+ * Creates a query to retrieve a list of menus.
  *
- * Retrieves a list of menus given the provided paging, filtering, and sorting. Up to 500 menus can be returned per request.
+ * The `queryMenus()` function builds a query to retrieve a list of menus and returns a `MenusQueryBuilder` object.
  *
- * For a detailed list of supported operations, see the [Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-solutions/restaurants/menus/menu/supported-filters-and-sorting) article. To learn how to query menus, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language).
+ * The returned object contains the query definition, which is used to run the query using the [`find()`](/menus/menus-query-builder/find) function.
+ *
+ * You can refine the query by chaining `MenusQueryBuilder` functions onto the query. `MenusQueryBuilder` functions enable you to filter, sort, and control the results that `queryMenus()` returns.
+ *
+ * `queryMenus()` runs with the following `MenusQueryBuilder` defaults, which you can override:
+ *
+ * * [`limit(100)`](/menus/menus-query-builder/limit)
+ * * [`ascending('entityId')`](/menus/menus-query-builder/ascending)
+ *
+ * The following `MenusQueryBuilder` functions are supported for `queryMenus()`. For a full description of the menu object, see the object returned for the [`items`](/menus/menus-query-result/items) property in `MenusQueryResult`.
  * @public
@@ -693,2 +716,4 @@ * @documentationMaturity preview
  * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @applicableIdentity APP
@@ -779,2 +804,4 @@ * @applicableIdentity MEMBER
  * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @applicableIdentity APP
@@ -834,2 +861,4 @@ * @returns Updated menu.
  * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @applicableIdentity APP
@@ -874,2 +903,4 @@ */
  * @permissionScopeId SCOPE.RESTAURANTS.MODIFY_MENUS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @applicableIdentity APP
@@ -876,0 +907,0 @@ */

No alert changes

Improved metrics

Total package byte prevSize

404042

increased by2.09%

Lines of code

8594

increased by2.02%

No dependency changes