npm - @wix/auto_sdk_restaurants_menus - Versions diffs - 1.0.0 - Mend

@wix/auto_sdk_restaurants_menus 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (111) hide show

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

@@ -0,0 +1,1043 @@
+export interface Menu {
+    /**
+     * Menu ID.
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Revision number, which increments by 1 each time the menu is updated. To prevent conflicting changes, the current revision must be passed when updating the menu. Ignored when creating a menu.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the menu was created.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date and time the menu was updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /** Menu name. */
+    name?: string;
+    /** Menu description. */
+    description?: string | null;
+    /** Whether the menu visible to site visitors. */
+    visible?: boolean | null;
+    /** Menu section IDs. */
+    sectionIds?: string[];
+    /** Extended fields. */
+    extendedFields?: ExtendedFields;
+    /** Part of the site URL, that redirects to the menu. For example, in the URL `www.mywebsite.com/our-menus/dinner-menu`, `dinner-menu` is the field value. */
+    urlQueryParam?: string | null;
+    /** Custom SEO data for the menu. */
+    seoData?: SeoSchema;
+}
+export interface ExtendedFields {
+    /**
+     * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
+     * The value of each key is structured according to the schema defined when the extended fields were configured.
+     *
+     * You can only access fields for which you have the appropriate permissions.
+     *
+     * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
+     */
+    namespaces?: Record<string, Record<string, any>>;
+}
+/**
+ * The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.
+ * The search engines use this information for ranking purposes, or to display snippets in the search results.
+ * This data will override other sources of tags (for example patterns) and will be included in the <head> section of the HTML document, while not being displayed on the page itself.
+ */
+export interface SeoSchema {
+    /** SEO tag information. */
+    tags?: Tag[];
+    /** SEO general settings. */
+    settings?: Settings;
+}
+export interface Keyword {
+    /** Keyword value. */
+    term?: string;
+    /** Whether the keyword is the main focus keyword. */
+    isMain?: boolean;
+    /** The source that added the keyword terms to the SEO settings. */
+    origin?: string | null;
+}
+export interface Tag {
+    /**
+     * SEO tag type.
+     *
+     *
+     * Supported values: `title`, `meta`, `script`, `link`.
+     */
+    type?: string;
+    /**
+     * A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.
+     * For example: `{"name": "description", "content": "the description itself"}`.
+     */
+    props?: Record<string, any> | null;
+    /** SEO tag meta data. For example, `{"height": 300, "width": 240}`. */
+    meta?: Record<string, any> | null;
+    /** SEO tag inner content. For example, `<title> inner content </title>`. */
+    children?: string;
+    /** Whether the tag is a custom tag. */
+    custom?: boolean;
+    /** Whether the tag is disabled. */
+    disabled?: boolean;
+}
+export interface Settings {
+    /**
+     * Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.
+     *
+     *
+     * Default: `false` (Auto Redirect is enabled.)
+     */
+    preventAutoRedirect?: boolean;
+    /** User-selected keyword terms for a specific page. */
+    keywords?: Keyword[];
+}
+export interface BusinessLocationDetails {
+}
+export interface GetMenuSiteUrlRequest {
+    /**
+     * Menu ID.
+     * @readonly
+     */
+    _id: string | null;
+}
+export interface GetMenuSiteUrlResponse {
+    /** Retrieved menuInfo with path url. */
+    menuSiteUrl?: MenuSiteUrl;
+}
+export interface MenuSiteUrl {
+    /** Path URL. */
+    path?: string;
+}
+export interface QueryMenusSiteUrlRequest {
+    /** Query options */
+    query?: CursorQuery;
+}
+export interface CursorQuery extends CursorQueryPagingMethodOneOf {
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+    /**
+     * Filter object in the following format:
+     * `"filter" : {
+     * "fieldName1": "value1",
+     * "fieldName2":{"$operator":"value2"}
+     * }`
+     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object in the following format:
+     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     */
+    sort?: Sorting[];
+}
+/** @oneof */
+export interface CursorQueryPagingMethodOneOf {
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+}
+export interface Sorting {
+    /** Name of the field to sort by. */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrder;
+}
+export declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+export interface CursorPaging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * You can get the relevant cursor token
+     * from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     */
+    cursor?: string | null;
+}
+export interface QueryMenusSiteUrlResponse {
+    /** Retrieved menuInfos with path urls. */
+    menuSiteUrls?: MenuSiteUrl[];
+    /** The metadata of the paginated results. */
+    pagingMetadata?: CursorPagingMetadata;
+}
+export interface CursorPagingMetadata {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    cursors?: Cursors;
+    /**
+     * Indicates if there are more results after the current page.
+     * If `true`, another page of results can be retrieved.
+     * If `false`, this is the last page.
+     */
+    hasNext?: boolean | null;
+}
+export interface Cursors {
+    /** Cursor pointing to next page in the list of results. */
+    next?: string | null;
+    /** Cursor pointing to previous page in the list of results. */
+    prev?: string | null;
+}
+export interface Location {
+}
+export interface InvalidateCache extends InvalidateCacheGetByOneOf {
+    /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
+    metaSiteId?: string;
+    /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
+    siteId?: string;
+    /** Invalidate by App */
+    app?: App;
+    /** Invalidate by page id */
+    page?: Page;
+    /** Invalidate by URI path */
+    uri?: URI;
+    /** Invalidate by file (for media files such as PDFs) */
+    file?: File;
+    /** tell us why you're invalidating the cache. You don't need to add your app name */
+    reason?: string | null;
+    /** Is local DS */
+    localDc?: boolean;
+    hardPurge?: boolean;
+}
+/** @oneof */
+export interface InvalidateCacheGetByOneOf {
+    /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
+    metaSiteId?: string;
+    /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
+    siteId?: string;
+    /** Invalidate by App */
+    app?: App;
+    /** Invalidate by page id */
+    page?: Page;
+    /** Invalidate by URI path */
+    uri?: URI;
+    /** Invalidate by file (for media files such as PDFs) */
+    file?: File;
+}
+export interface App {
+    /** The AppDefId */
+    appDefId?: string;
+    /** The instance Id */
+    instanceId?: string;
+}
+export interface Page {
+    /** the msid the page is on */
+    metaSiteId?: string;
+    /** Invalidate by Page ID */
+    pageId?: string;
+}
+export interface URI {
+    /** the msid the URI is on */
+    metaSiteId?: string;
+    /** URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes */
+    uriPath?: string;
+}
+export interface File {
+    /** the msid the file is related to */
+    metaSiteId?: string;
+    /** Invalidate by filename (for media files such as PDFs) */
+    fileName?: string;
+}
+export interface DeleteOrphanSections {
+    /** Menu id */
+    menuId?: string;
+}
+export interface MenusDataCloningCompleted {
+}
+export interface CreateMenuRequest {
+    /** Menu details. */
+    menu: Menu;
+}
+export interface CreateMenuResponse {
+    /** Menu. */
+    menu?: Menu;
+}
+export interface BulkCreateMenusRequest {
+    /** Menu details. */
+    menus: Menu[];
+    /** Whether to receive the created menus in the response. */
+    returnEntity?: boolean;
+}
+export interface BulkCreateMenusResponse {
+    /** Information about the created menus. */
+    results?: BulkCreateMenuResult[];
+    /** Metadata for the API call. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface BulkCreateMenuResult {
+    /** Whether to receive the created menus in the response. */
+    menuMetadata?: ItemMetadata;
+    /** Created menu. */
+    menu?: Menu;
+}
+export interface ItemMetadata {
+    /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
+    _id?: string | null;
+    /** Index of the item within the request array. Allows for correlation between request and response items. */
+    originalIndex?: number;
+    /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
+    success?: boolean;
+    /** Details about the error in case of failure. */
+    error?: ApplicationError;
+}
+export interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+export interface BulkActionMetadata {
+    /** Number of items that were successfully processed. */
+    totalSuccesses?: number;
+    /** Number of items that couldn't be processed. */
+    totalFailures?: number;
+    /** Number of failures without details because detailed failure threshold was exceeded. */
+    undetailedFailures?: number;
+}
+export interface GetMenuRequest {
+    /** Menu ID. */
+    menuId: string;
+}
+export interface GetMenuResponse {
+    /** Menu. */
+    menu?: Menu;
+}
+export interface ListMenusRequest {
+    /** Menu IDs. */
+    menuIds?: string[];
+    /** The metadata of the paginated results. */
+    paging?: CursorPaging;
+    /** Whether to return only menus that are visible to site visitors. */
+    onlyVisible?: boolean | null;
+}
+export interface ListMenusResponse {
+    /** Retrieved menus. */
+    menus?: Menu[];
+    /** The metadata of the paginated results. */
+    pagingMetadata?: CursorPagingMetadata;
+}
+export interface QueryMenusRequest {
+    /** Query options. */
+    query?: CursorQuery;
+}
+export interface QueryMenusResponse {
+    /** Retrieved menus. */
+    menus?: Menu[];
+    /** The metadata of the paginated results. */
+    pagingMetadata?: CursorPagingMetadata;
+}
+export interface UpdateMenuRequest {
+    /** Menu to update. */
+    menu: Menu;
+}
+export interface UpdateMenuResponse {
+    /** Updated menu. */
+    menu?: Menu;
+}
+export interface BulkUpdateMenuRequest {
+    /** Menus to update. */
+    menus: MaskedMenu[];
+    /** Whether to receive the entity in the response. */
+    returnEntity?: boolean;
+}
+export interface MaskedMenu {
+    /** Menu to updated. */
+    menu?: Menu;
+    /** Explicit list of fields to update. */
+    mask?: string[];
+}
+export interface BulkUpdateMenuResponse {
+    /** Results of bulk menu update. */
+    results?: BulkMenuResult[];
+    /** Metadata for the API call. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface BulkMenuResult {
+    /** Metadata for menu update. */
+    menuMetadata?: ItemMetadata;
+    /** Updated menu. Only returned if `returnEntity` is set to `true`. */
+    menu?: Menu;
+}
+export interface UpdateExtendedFieldsRequest {
+    /** ID of the entity to update. */
+    _id: string;
+    /** Identifier for the app whose extended fields are being updated. */
+    namespace: string;
+    /** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
+    namespaceData: Record<string, any> | null;
+}
+export interface UpdateExtendedFieldsResponse {
+    /** Namespace of the app. */
+    namespace?: string;
+    /** Updated extended fields data. */
+    namespaceData?: Record<string, any> | null;
+}
+export interface DeleteMenuRequest {
+    /** Menu ID. */
+    menuId: string;
+}
+export interface DeleteMenuResponse {
+}
+export interface CloneMenusRequest {
+    /** The MetaSiteId to clone from. */
+    metaSiteId?: string;
+}
+export interface CloneMenusResponse {
+}
+export interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    _id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * Example: created/updated/deleted/started/completed/email_opened
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+export interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+export interface EntityCreatedEvent {
+    entity?: string;
+}
+export interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+export interface EntityUpdatedEvent {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntity?: string;
+}
+export interface EntityDeletedEvent {
+    /** Entity that was deleted */
+    deletedEntity?: string | null;
+}
+export interface ActionEvent {
+    body?: string;
+}
+export interface Empty {
+}
+export interface MessageEnvelope {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+export interface IdentificationData extends IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityType;
+}
+/** @oneof */
+export interface IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+}
+export declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+interface MenuSiteUrlNonNullableFields {
+    path: string;
+}
+export interface GetMenuSiteUrlResponseNonNullableFields {
+    menuSiteUrl?: MenuSiteUrlNonNullableFields;
+}
+export interface QueryMenusSiteUrlResponseNonNullableFields {
+    menuSiteUrls: MenuSiteUrlNonNullableFields[];
+}
+interface TagNonNullableFields {
+    type: string;
+    children: string;
+    custom: boolean;
+    disabled: boolean;
+}
+interface KeywordNonNullableFields {
+    term: string;
+    isMain: boolean;
+}
+interface SettingsNonNullableFields {
+    preventAutoRedirect: boolean;
+    keywords: KeywordNonNullableFields[];
+}
+interface SeoSchemaNonNullableFields {
+    tags: TagNonNullableFields[];
+    settings?: SettingsNonNullableFields;
+}
+export interface MenuNonNullableFields {
+    name: string;
+    sectionIds: string[];
+    seoData?: SeoSchemaNonNullableFields;
+}
+export interface CreateMenuResponseNonNullableFields {
+    menu?: MenuNonNullableFields;
+}
+interface ApplicationErrorNonNullableFields {
+    code: string;
+    description: string;
+}
+interface ItemMetadataNonNullableFields {
+    originalIndex: number;
+    success: boolean;
+    error?: ApplicationErrorNonNullableFields;
+}
+interface BulkCreateMenuResultNonNullableFields {
+    menuMetadata?: ItemMetadataNonNullableFields;
+    menu?: MenuNonNullableFields;
+}
+interface BulkActionMetadataNonNullableFields {
+    totalSuccesses: number;
+    totalFailures: number;
+    undetailedFailures: number;
+}
+export interface BulkCreateMenusResponseNonNullableFields {
+    results: BulkCreateMenuResultNonNullableFields[];
+    bulkActionMetadata?: BulkActionMetadataNonNullableFields;
+}
+export interface GetMenuResponseNonNullableFields {
+    menu?: MenuNonNullableFields;
+}
+export interface ListMenusResponseNonNullableFields {
+    menus: MenuNonNullableFields[];
+}
+export interface QueryMenusResponseNonNullableFields {
+    menus: MenuNonNullableFields[];
+}
+export interface UpdateMenuResponseNonNullableFields {
+    menu?: MenuNonNullableFields;
+}
+interface BulkMenuResultNonNullableFields {
+    menuMetadata?: ItemMetadataNonNullableFields;
+    menu?: MenuNonNullableFields;
+}
+export interface BulkUpdateMenuResponseNonNullableFields {
+    results: BulkMenuResultNonNullableFields[];
+    bulkActionMetadata?: BulkActionMetadataNonNullableFields;
+}
+export interface UpdateExtendedFieldsResponseNonNullableFields {
+    namespace: string;
+}
+export interface BaseEventMetadata {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+}
+export interface EventMetadata extends BaseEventMetadata {
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    _id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * Example: created/updated/deleted/started/completed/email_opened
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+export interface MenuCreatedEnvelope {
+    entity: Menu;
+    metadata: EventMetadata;
+}
+/** @permissionScope Manage Bookings Services and Settings
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
+ * @permissionScope Manage Portfolio
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @permissionId RESTAURANTS.MENU_READ
+ * @webhook
+ * @eventType wix.restaurants.menus.v1.menu_created
+ * @documentationMaturity preview
+ */
+export declare function onMenuCreated(handler: (event: MenuCreatedEnvelope) => void | Promise<void>): void;
+export interface MenuDeletedEnvelope {
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a menu is deleted.
+ * @permissionScope Manage Bookings Services and Settings
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
+ * @permissionScope Manage Portfolio
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @permissionId RESTAURANTS.MENU_READ
+ * @webhook
+ * @eventType wix.restaurants.menus.v1.menu_deleted
+ * @documentationMaturity preview
+ */
+export declare function onMenuDeleted(handler: (event: MenuDeletedEnvelope) => void | Promise<void>): void;
+export interface MenuUpdatedEnvelope {
+    entity: Menu;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a menu is updated.
+ * @permissionScope Manage Bookings Services and Settings
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
+ * @permissionScope Manage Portfolio
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @permissionId RESTAURANTS.MENU_READ
+ * @webhook
+ * @eventType wix.restaurants.menus.v1.menu_updated
+ * @documentationMaturity preview
+ */
+export declare function onMenuUpdated(handler: (event: MenuUpdatedEnvelope) => void | Promise<void>): void;
+/**
+ * Get menu details and path URL by menu ID.
+ * @param _id - Menu ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @permissionId RESTAURANTS.MENU_READ
+ * @permissionScope Manage Bookings Services and Settings
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
+ * @permissionScope Manage Portfolio
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn com.wixpress.restaurants.menus_menu.v1.restaurants_menus_site_url.RestaurantsMenusSiteUrl.GetMenuSiteUrl
+ */
+export declare function getMenuSiteUrl(_id: string | null): Promise<GetMenuSiteUrlResponse & GetMenuSiteUrlResponseNonNullableFields>;
+/**
+ * Query menu details and path URL
+ * @public
+ * @documentationMaturity preview
+ * @permissionId RESTAURANTS.MENU_READ
+ * @permissionScope Manage Bookings Services and Settings
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
+ * @permissionScope Manage Portfolio
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn com.wixpress.restaurants.menus_menu.v1.restaurants_menus_site_url.RestaurantsMenusSiteUrl.QueryMenusSiteUrl
+ */
+export declare function queryMenusSiteUrl(options?: QueryMenusSiteUrlOptions): Promise<QueryMenusSiteUrlResponse & QueryMenusSiteUrlResponseNonNullableFields>;
+export interface QueryMenusSiteUrlOptions {
+    /** Query options */
+    query?: CursorQuery;
+}
+/**
+ * > **Note:** The Menus API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).
+ *
+ * Creates a menu.
+ *
+ * To create multiple menus at once, use [Bulk Create Menus](https://dev.wix.com/docs/rest/business-solutions/restaurants/menus/menu/bulk-create-menus).
+ * @param menu - Menu details.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField menu
+ * @permissionId RESTAURANTS.MENU_CREATE
+ * @permissionScope Manage Bookings Services and Settings
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
+ * @permissionScope Manage Portfolio
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @applicableIdentity APP
+ * @returns Menu.
+ * @fqn com.wixpress.restaurants.menus_menu.v1.RestaurantsMenusMenu.CreateMenu
+ */
+export declare function createMenu(menu: Menu): Promise<Menu & MenuNonNullableFields>;
+/**
+ * > **Note:** The Menu API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).
+ *
+ * Creates multiple menus at once.
+ * @param menus - Menu details.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField menus
+ * @permissionId RESTAURANTS.MENU_CREATE
+ * @permissionScope Manage Bookings Services and Settings
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
+ * @permissionScope Manage Portfolio
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @applicableIdentity APP
+ * @fqn com.wixpress.restaurants.menus_menu.v1.RestaurantsMenusMenu.BulkCreateMenus
+ */
+export declare function bulkCreateMenus(menus: Menu[], options?: BulkCreateMenusOptions): Promise<BulkCreateMenusResponse & BulkCreateMenusResponseNonNullableFields>;
+export interface BulkCreateMenusOptions {
+    /** Whether to receive the created menus in the response. */
+    returnEntity?: boolean;
+}
+/**
+ * > **Note:** The Menu API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).
+ *
+ * Retrieves a menu by ID.
+ * @param menuId - Menu ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField menuId
+ * @permissionId RESTAURANTS.MENU_READ
+ * @permissionScope Manage Bookings Services and Settings
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
+ * @permissionScope Manage Portfolio
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @returns Menu.
+ * @fqn com.wixpress.restaurants.menus_menu.v1.RestaurantsMenusMenu.GetMenu
+ */
+export declare function getMenu(menuId: string): Promise<Menu & MenuNonNullableFields>;
+/**
+ * > **Note:** The Menu API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).
+ *
+ * Retrieves a list of up to 500 menus.
+ * @public
+ * @documentationMaturity preview
+ * @permissionId RESTAURANTS.MENU_READ
+ * @permissionScope Manage Bookings Services and Settings
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
+ * @permissionScope Manage Portfolio
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn com.wixpress.restaurants.menus_menu.v1.RestaurantsMenusMenu.ListMenus
+ */
+export declare function listMenus(options?: ListMenusOptions): Promise<ListMenusResponse & ListMenusResponseNonNullableFields>;
+export interface ListMenusOptions {
+    /** Menu IDs. */
+    menuIds?: string[];
+    /** The metadata of the paginated results. */
+    paging?: CursorPaging;
+    /** Whether to return only menus that are visible to site visitors. */
+    onlyVisible?: boolean | null;
+}
+/**
+ * Creates a query to retrieve a list of menus.
+ *
+ * The `queryMenus()` function builds a query to retrieve a list of menus and returns a `MenusQueryBuilder` object.
+ *
+ * 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
+ * @documentationMaturity preview
+ * @permissionScope Manage Bookings Services and Settings
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
+ * @permissionScope Manage Portfolio
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @permissionId RESTAURANTS.MENU_READ
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn com.wixpress.restaurants.menus_menu.v1.RestaurantsMenusMenu.QueryMenus
+ */
+export declare function queryMenus(): MenusQueryBuilder;
+interface QueryCursorResult {
+    cursors: Cursors;
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+export interface MenusQueryResult extends QueryCursorResult {
+    items: Menu[];
+    query: MenusQueryBuilder;
+    next: () => Promise<MenusQueryResult>;
+    prev: () => Promise<MenusQueryResult>;
+}
+export interface MenusQueryBuilder {
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    eq: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'visible' | 'urlQueryParam', value: any) => MenusQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ne: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'visible' | 'urlQueryParam', value: any) => MenusQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ge: (propertyName: '_createdDate' | '_updatedDate', value: any) => MenusQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    gt: (propertyName: '_createdDate' | '_updatedDate', value: any) => MenusQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    le: (propertyName: '_createdDate' | '_updatedDate', value: any) => MenusQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    lt: (propertyName: '_createdDate' | '_updatedDate', value: any) => MenusQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `string`.
+     * @param string - String to compare against. Case-insensitive.
+     * @documentationMaturity preview
+     */
+    startsWith: (propertyName: 'name' | 'description' | 'urlQueryParam', value: string) => MenusQueryBuilder;
+    /** @documentationMaturity preview */
+    in: (propertyName: '_id' | 'name' | 'description' | 'urlQueryParam', value: any) => MenusQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    ascending: (...propertyNames: Array<'_createdDate' | '_updatedDate'>) => MenusQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    descending: (...propertyNames: Array<'_createdDate' | '_updatedDate'>) => MenusQueryBuilder;
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
+     * @documentationMaturity preview
+     */
+    limit: (limit: number) => MenusQueryBuilder;
+    /** @param cursor - A pointer to specific record
+     * @documentationMaturity preview
+     */
+    skipTo: (cursor: string) => MenusQueryBuilder;
+    /** @documentationMaturity preview */
+    find: () => Promise<MenusQueryResult>;
+}
+/**
+ * > **Note:** The Menu API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).
+ *
+ * Updates a menu.
+ *
+ * To update multiple menus at once, use [Bulk Update Menu](https://dev.wix.com/docs/rest/business-solutions/restaurants/menus/menu/bulk-update-menu).
+ *
+ * Each time a menu is updated, its revision increments by 1. The existing revision must be included when updating a menu. This ensures you're working with the latest menu information, and it prevents unintended overwrites.
+ * @param _id - Menu ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @requiredField menu
+ * @requiredField menu.revision
+ * @permissionId RESTAURANTS.MENU_UPDATE
+ * @permissionScope Manage Bookings Services and Settings
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
+ * @permissionScope Manage Portfolio
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @applicableIdentity APP
+ * @returns Updated menu.
+ * @fqn com.wixpress.restaurants.menus_menu.v1.RestaurantsMenusMenu.UpdateMenu
+ */
+export declare function updateMenu(_id: string | null, menu: UpdateMenu): Promise<Menu & MenuNonNullableFields>;
+export interface UpdateMenu {
+    /**
+     * Menu ID.
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Revision number, which increments by 1 each time the menu is updated. To prevent conflicting changes, the current revision must be passed when updating the menu. Ignored when creating a menu.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the menu was created.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date and time the menu was updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /** Menu name. */
+    name?: string;
+    /** Menu description. */
+    description?: string | null;
+    /** Whether the menu visible to site visitors. */
+    visible?: boolean | null;
+    /** Menu section IDs. */
+    sectionIds?: string[];
+    /** Extended fields. */
+    extendedFields?: ExtendedFields;
+    /** Part of the site URL, that redirects to the menu. For example, in the URL `www.mywebsite.com/our-menus/dinner-menu`, `dinner-menu` is the field value. */
+    urlQueryParam?: string | null;
+    /** Custom SEO data for the menu. */
+    seoData?: SeoSchema;
+}
+/**
+ * > **Note:** The Menu API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).
+ *
+ * Updates multiple menus at once.
+ *
+ * Each time a menu is updated, its revision increments by 1. The existing revision must be included when updating the menu. This ensures you're working with the latest menu information, and it prevents unintended overwrites.
+ * @param menus - Menus to update.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField menus
+ * @requiredField menus.menu._id
+ * @requiredField menus.menu.revision
+ * @permissionId RESTAURANTS.MENU_UPDATE
+ * @permissionScope Manage Bookings Services and Settings
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
+ * @permissionScope Manage Portfolio
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @applicableIdentity APP
+ * @fqn com.wixpress.restaurants.menus_menu.v1.RestaurantsMenusMenu.BulkUpdateMenu
+ */
+export declare function bulkUpdateMenu(menus: MaskedMenu[], options?: BulkUpdateMenuOptions): Promise<BulkUpdateMenuResponse & BulkUpdateMenuResponseNonNullableFields>;
+export interface BulkUpdateMenuOptions {
+    /** Whether to receive the entity in the response. */
+    returnEntity?: boolean;
+}
+/**
+ * > **Note:** The Menu API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).
+ *
+ * Updates only the `extendedFields` field.
+ * @param _id - ID of the entity to update.
+ * @param namespace - Identifier for the app whose extended fields are being updated.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @requiredField namespace
+ * @requiredField options
+ * @requiredField options.namespaceData
+ * @fqn com.wixpress.restaurants.menus_menu.v1.RestaurantsMenusMenu.UpdateExtendedFields
+ */
+export declare function updateExtendedFields(_id: string, namespace: string, options: UpdateExtendedFieldsOptions): Promise<UpdateExtendedFieldsResponse & UpdateExtendedFieldsResponseNonNullableFields>;
+export interface UpdateExtendedFieldsOptions {
+    /** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
+    namespaceData: Record<string, any> | null;
+}
+/**
+ * > **Note:** The Menu API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).
+ *
+ * Deletes a menu.
+ * @param menuId - Menu ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField menuId
+ * @permissionId RESTAURANTS.MENU_DELETE
+ * @permissionScope Manage Bookings Services and Settings
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
+ * @permissionScope Manage Portfolio
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @applicableIdentity APP
+ * @fqn com.wixpress.restaurants.menus_menu.v1.RestaurantsMenusMenu.DeleteMenu
+ */
+export declare function deleteMenu(menuId: string): Promise<void>;
+export {};