@wix/auto_sdk_restaurants_menus 1.0.94 → 1.0.95

package/build/internal/cjs/meta.d.ts

@@ -1,4 +1,4 @@
-import { DuplicateMenuRequest as DuplicateMenuRequest$1, DuplicateMenuResponse as DuplicateMenuResponse$1, GetMenuSiteUrlRequest as GetMenuSiteUrlRequest$1, GetMenuSiteUrlResponse as GetMenuSiteUrlResponse$1, QueryMenusSiteUrlRequest as QueryMenusSiteUrlRequest$1, QueryMenusSiteUrlResponse as QueryMenusSiteUrlResponse$1, CreateMenuRequest as CreateMenuRequest$1, CreateMenuResponse as CreateMenuResponse$1, BulkCreateMenusRequest as BulkCreateMenusRequest$1, BulkCreateMenusResponse as BulkCreateMenusResponse$1, GetMenuRequest as GetMenuRequest$1, GetMenuResponse as GetMenuResponse$1, ListMenusRequest as ListMenusRequest$1, ListMenusResponse as ListMenusResponse$1, QueryMenusRequest as QueryMenusRequest$1, QueryMenusResponse as QueryMenusResponse$1, UpdateMenuRequest as UpdateMenuRequest$1, UpdateMenuResponse as UpdateMenuResponse$1, BulkUpdateMenuRequest as BulkUpdateMenuRequest$1, BulkUpdateMenuResponse as BulkUpdateMenuResponse$1, UpdateExtendedFieldsRequest as UpdateExtendedFieldsRequest$1, UpdateExtendedFieldsResponse as UpdateExtendedFieldsResponse$1, DeleteMenuRequest as DeleteMenuRequest$1, DeleteMenuResponse as DeleteMenuResponse$1 } from './index.typings.js';
+import { CreateMenuRequest as CreateMenuRequest$1, CreateMenuResponse as CreateMenuResponse$1, BulkCreateMenusRequest as BulkCreateMenusRequest$1, BulkCreateMenusResponse as BulkCreateMenusResponse$1, GetMenuRequest as GetMenuRequest$1, GetMenuResponse as GetMenuResponse$1, ListMenusRequest as ListMenusRequest$1, ListMenusResponse as ListMenusResponse$1, QueryMenusRequest as QueryMenusRequest$1, QueryMenusResponse as QueryMenusResponse$1, UpdateMenuRequest as UpdateMenuRequest$1, UpdateMenuResponse as UpdateMenuResponse$1, BulkUpdateMenuRequest as BulkUpdateMenuRequest$1, BulkUpdateMenuResponse as BulkUpdateMenuResponse$1, UpdateExtendedFieldsRequest as UpdateExtendedFieldsRequest$1, UpdateExtendedFieldsResponse as UpdateExtendedFieldsResponse$1, DeleteMenuRequest as DeleteMenuRequest$1, DeleteMenuResponse as DeleteMenuResponse$1, DuplicateMenuRequest as DuplicateMenuRequest$1, DuplicateMenuResponse as DuplicateMenuResponse$1, GetMenuSiteUrlRequest as GetMenuSiteUrlRequest$1, GetMenuSiteUrlResponse as GetMenuSiteUrlResponse$1, QueryMenusSiteUrlRequest as QueryMenusSiteUrlRequest$1, QueryMenusSiteUrlResponse as QueryMenusSiteUrlResponse$1 } from './index.typings.js';
 import '@wix/sdk-types';
 
 interface Menu {
@@ -283,249 +283,288 @@ interface ExternalReferenceInfo {
     /** Whether the connection to the external system is currently active. */
     connected?: boolean | null;
 }
-interface DuplicateMenuRequest {
+interface InvalidateCache extends InvalidateCacheGetByOneOf {
     /**
-     * Menu id to be duplicated.
+     * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
      * @format GUID
      */
-    id: string;
+    metaSiteId?: string;
     /**
-     * Business location ids to duplicate the menu to.
+     * Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
      * @format GUID
-     * @maxSize 100
      */
-    businessLocationIds?: string[] | null;
-    /** Indicates whether sub-entities (such as items) should be duplicated as well. */
-    duplicateSubEntities?: boolean | null;
-    /**
-     * The new name of the duplicated menu.
-     * @maxLength 500
-     */
-    menuName?: string | null;
-}
-interface DuplicateMenuResponse {
-    /** @format GUID */
-    menuIds?: string[];
-}
-interface DomainEvent extends DomainEventBodyOneOf {
-    createdEvent?: EntityCreatedEvent;
-    updatedEvent?: EntityUpdatedEvent;
-    deletedEvent?: EntityDeletedEvent;
-    actionEvent?: ActionEvent;
-    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
-    id?: string;
-    /**
-     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
-     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
-     */
-    entityFqdn?: string;
-    /**
-     * Event action name, placed at the top level to make it easier for users to dispatch messages.
-     * For 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;
+    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;
+    /** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */
+    customTag?: CustomTag;
+    /** Invalidate by multiple page ids */
+    pages?: Pages;
+    /** Invalidate by multiple URI paths */
+    uris?: URIs;
     /**
-     * Whether the event was triggered as a result of a privacy regulation application
-     * (for example, GDPR).
+     * tell us why you're invalidating the cache. You don't need to add your app name
+     * @maxLength 256
      */
-    triggeredByAnonymizeRequest?: boolean | null;
-    /** If present, indicates the action that triggered the event. */
-    originatedFrom?: string | null;
+    reason?: string | null;
+    /** Is local DS */
+    localDc?: boolean;
+    hardPurge?: boolean;
     /**
-     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at `16:00` and then again at `16:01`, the second update will always have a higher sequence number.
-     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
+     * Optional caller-provided ID for tracking this invalidation through the system.
+     * When set, the corresponding CDN purge completion event will include this ID,
+     * allowing you to confirm when the invalidation has fully propagated.
+     * Example: generate a UUID, pass it here, and later match it in the CDN purge completion event.
+     * @maxLength 256
      */
-    entityEventSequence?: string | null;
+    correlationId?: string | null;
 }
 /** @oneof */
-interface DomainEventBodyOneOf {
-    createdEvent?: EntityCreatedEvent;
-    updatedEvent?: EntityUpdatedEvent;
-    deletedEvent?: EntityDeletedEvent;
-    actionEvent?: ActionEvent;
-}
-interface EntityCreatedEvent {
-    entityAsJson?: string;
+interface InvalidateCacheGetByOneOf {
     /**
-     * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity
-     * @internal
+     * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
+     * @format GUID
      */
-    triggeredByUndelete?: boolean | null;
-    /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
-    restoreInfo?: RestoreInfo;
+    metaSiteId?: string;
     /**
-     * Optional domain-specific metadata defined by the API owner, encoded as JSON.
-     * @internal
+     * Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
+     * @format GUID
      */
-    additionalMetadataAsJson?: string | null;
-}
-interface RestoreInfo {
-    deletedDate?: Date | null;
+    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;
+    /** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */
+    customTag?: CustomTag;
+    /** Invalidate by multiple page ids */
+    pages?: Pages;
+    /** Invalidate by multiple URI paths */
+    uris?: URIs;
 }
-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.
-     */
-    currentEntityAsJson?: string;
-    /**
-     * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard
-     * wont populate it / have any reference to it in the API.
-     * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,
-     * the developer should send only the new (current) entity.
-     * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big
-     * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.
-     * @internal
-     * @deprecated
-     */
-    previousEntityAsJson?: string | null;
+interface App {
     /**
-     * Map of fully qualified field paths to their previous values for fields that changed.
-     * For more details please see [AIP](https://dev.wix.com/docs/rnd-general/articles/p13n-guidelines-aips/guidance-aips/design-patterns/7016-events#modified-fields-format)
-     * @internal
+     * The AppDefId
+     * @minLength 1
      */
-    modifiedFields?: Record<string, any>;
+    appDefId?: string;
     /**
-     * Optional domain-specific metadata defined by the API owner, encoded as JSON.
-     * @internal
+     * The instance Id
+     * @format GUID
      */
-    additionalMetadataAsJson?: string | null;
+    instanceId?: string;
 }
-interface EntityDeletedEvent {
+interface Page {
     /**
-     * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled
-     * @internal
+     * the msid the page is on
+     * @format GUID
      */
-    movedToTrash?: boolean | null;
-    /** Entity that was deleted. */
-    deletedEntityAsJson?: string | null;
+    metaSiteId?: string;
     /**
-     * Optional domain-specific metadata defined by the API owner, encoded as JSON.
-     * @internal
+     * Invalidate by Page ID
+     * @minLength 1
      */
-    additionalMetadataAsJson?: string | null;
-}
-interface ActionEvent {
-    bodyAsJson?: string;
+    pageId?: string;
 }
-interface MessageEnvelope {
+interface URI {
     /**
-     * App instance ID.
+     * the msid the URI is on
      * @format GUID
      */
-    instanceId?: string | null;
+    metaSiteId?: string;
     /**
-     * Event type.
-     * @maxLength 150
+     * URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes
+     * @minLength 1
      */
-    eventType?: string;
-    /** The identification type and identity data. */
-    identity?: IdentificationData;
-    /** Stringify payload. */
-    data?: string;
-    /** Details related to the account */
-    accountInfo?: AccountInfo;
+    uriPath?: string;
 }
-interface IdentificationData extends IdentificationDataIdOneOf {
+interface File {
     /**
-     * ID of a site visitor that has not logged in to the site.
+     * the msid the file is related to
      * @format GUID
      */
-    anonymousVisitorId?: string;
+    metaSiteId?: string;
     /**
-     * ID of a site visitor that has logged in to the site.
-     * @format GUID
+     * Invalidate by filename (for media files such as PDFs)
+     * @minLength 1
+     * @maxLength 256
      */
-    memberId?: string;
+    fileName?: string;
+}
+interface CustomTag {
     /**
-     * ID of a Wix user (site owner, contributor, etc.).
+     * the msid the tag is related to
      * @format GUID
      */
-    wixUserId?: string;
+    metaSiteId?: string;
     /**
-     * ID of an app.
-     * @format GUID
+     * Tag to invalidate by
+     * @minLength 1
+     * @maxLength 256
      */
-    appId?: string;
-    /** @readonly */
-    identityType?: WebhookIdentityTypeWithLiterals;
+    tag?: string;
 }
-/** @oneof */
-interface IdentificationDataIdOneOf {
+interface Pages {
     /**
-     * ID of a site visitor that has not logged in to the site.
+     * the msid the pages are on
      * @format GUID
      */
-    anonymousVisitorId?: string;
+    metaSiteId?: string;
     /**
-     * ID of a site visitor that has logged in to the site.
-     * @format GUID
+     * Invalidate by multiple Page IDs in a single message
+     * @maxSize 100
+     * @minLength 1
      */
-    memberId?: string;
+    pageIds?: string[];
+}
+interface URIs {
     /**
-     * ID of a Wix user (site owner, contributor, etc.).
+     * the msid the URIs are on
      * @format GUID
      */
-    wixUserId?: string;
+    metaSiteId?: string;
     /**
-     * ID of an app.
-     * @format GUID
+     * URI paths to invalidate (e.g. page/my/path) - without leading/trailing slashes
+     * @maxSize 100
+     * @minLength 1
      */
-    appId?: string;
+    uriPaths?: string[];
 }
-declare enum WebhookIdentityType {
-    UNKNOWN = "UNKNOWN",
-    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
-    MEMBER = "MEMBER",
-    WIX_USER = "WIX_USER",
-    APP = "APP"
+interface DeleteOrphanSections {
+    /** Menu id */
+    menuId?: string;
 }
-/** @enumType */
-type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
-interface AccountInfo {
+interface MenusDataCloningCompleted {
+}
+interface CreateMenuRequest {
+    /** Menu details. */
+    menu: Menu;
+}
+interface CreateMenuResponse {
+    /** Menu. */
+    menu?: Menu;
+}
+interface BulkCreateMenusRequest {
     /**
-     * ID of the Wix account associated with the event.
-     * @format GUID
+     * Menu details.
+     * @maxSize 100
      */
-    accountId?: string | null;
+    menus: Menu[];
+    /** Whether to receive the created menus in the response. */
+    returnEntity?: boolean;
+}
+interface BulkCreateMenusResponse {
+    /** Information about the created menus. */
+    results?: BulkCreateMenuResult[];
+    /** Metadata for the API call. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface BulkCreateMenuResult {
+    /** Whether to receive the created menus in the response. */
+    menuMetadata?: ItemMetadata;
+    /** Created menu. */
+    menu?: Menu;
+}
+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;
+}
+interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+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;
+}
+interface GetMenuRequest {
     /**
-     * ID of the parent Wix account. Only included when accountId belongs to a child account.
+     * Menu ID.
      * @format GUID
      */
-    parentAccountId?: string | null;
+    menuId: string;
+}
+interface GetMenuResponse {
+    /** Menu. */
+    menu?: Menu;
+}
+interface ListMenusRequest {
     /**
-     * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
+     * Menu IDs.
      * @format GUID
+     * @maxSize 500
      */
-    siteId?: string | null;
+    menuIds?: string[];
+    /** The metadata of the paginated results. */
+    paging?: CursorPaging;
+    /** Whether to return only menus that are visible to site visitors. */
+    onlyVisible?: boolean | null;
 }
-interface GetMenuSiteUrlRequest {
+interface CursorPaging {
     /**
-     * Menu ID.
-     * @format GUID
-     * @readonly
+     * Number of items to load.
+     * @max 500
      */
-    id: string | null;
+    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;
 }
-interface GetMenuSiteUrlResponse {
-    /** Retrieved menuInfo with path url. */
-    menuSiteUrl?: MenuSiteUrl;
+interface ListMenusResponse {
+    /** Retrieved menus. */
+    menus?: Menu[];
+    /** The metadata of the paginated results. */
+    pagingMetadata?: CursorPagingMetadata;
 }
-interface MenuSiteUrl {
+interface CursorPagingMetadata {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    cursors?: Cursors;
     /**
-     * Path URL.
-     * @minLength 1
-     * @maxLength 1000
+     * 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.
      */
-    path?: string;
+    hasNext?: boolean | null;
 }
-interface QueryMenusSiteUrlRequest {
-    /** Query options */
+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;
+}
+interface QueryMenusRequest {
+    /** Query options. */
     query?: CursorQuery;
 }
 interface CursorQuery extends CursorQueryPagingMethodOneOf {
@@ -591,408 +630,369 @@ interface AddressLocation {
     /** Address longitude. */
     longitude?: number | null;
 }
-interface CursorPaging {
+interface QueryMenusResponse {
+    /** Retrieved menus. */
+    menus?: Menu[];
+    /** The metadata of the paginated results. */
+    pagingMetadata?: CursorPagingMetadata;
+}
+interface UpdateMenuRequest {
+    /** Menu to update. */
+    menu: Menu;
     /**
-     * Number of items to load.
-     * @max 500
+     * Explicit list of fields to update.
+     * @internal
      */
-    limit?: number | null;
+    mask?: string[];
+}
+interface UpdateMenuResponse {
+    /** Updated menu. */
+    menu?: Menu;
+}
+interface BulkUpdateMenuRequest {
     /**
-     * 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.
+     * Menus to update.
+     * @minSize 1
+     * @maxSize 100
+     */
+    menus: MaskedMenu[];
+    /** Whether to receive the entity in the response. */
+    returnEntity?: boolean;
+}
+interface MaskedMenu {
+    /** Menu to updated. */
+    menu?: Menu;
+    /** Explicit list of fields to update. */
+    mask?: string[];
+}
+interface BulkUpdateMenuResponse {
+    /**
+     * Results of bulk menu update.
+     * @minSize 1
+     * @maxSize 100
+     */
+    results?: BulkMenuResult[];
+    /** Metadata for the API call. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface BulkMenuResult {
+    /** Metadata for menu update. */
+    menuMetadata?: ItemMetadata;
+    /** Updated menu. Only returned if `returnEntity` is set to `true`. */
+    menu?: Menu;
+}
+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;
+}
+interface UpdateExtendedFieldsResponse {
+    /** Namespace of the app. */
+    namespace?: string;
+    /** Updated extended fields data. */
+    namespaceData?: Record<string, any> | null;
+}
+interface DeleteMenuRequest {
+    /**
+     * Menu ID.
+     * @format GUID
      */
-    cursor?: string | null;
+    menuId: string;
 }
-interface QueryMenusSiteUrlResponse {
-    /** Retrieved menuInfos with path urls. */
-    menuSiteUrls?: MenuSiteUrl[];
-    /** The metadata of the paginated results. */
-    pagingMetadata?: CursorPagingMetadata;
+interface DeleteMenuResponse {
 }
-interface CursorPagingMetadata {
-    /** Number of items returned in the response. */
-    count?: number | null;
-    /** Offset that was requested. */
-    cursors?: Cursors;
+interface RunMenusMultiLocationMigrationRequest {
     /**
-     * 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.
+     * business location id
+     * @format GUID
      */
-    hasNext?: boolean | null;
+    businessLocationId?: string;
 }
-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;
+interface RunMenusMultiLocationMigrationResponse {
+    /** Whether menus multi-location migration finished successfully */
+    success?: boolean;
 }
-interface InvalidateCache extends InvalidateCacheGetByOneOf {
+interface UpdateBusinessLocationIdRequest {
+    /** @format GUID */
+    menuId?: string;
+    /** @format GUID */
+    businessLocationId?: string | null;
+}
+interface UpdateBusinessLocationIdResponse {
+}
+interface CloneMenusRequest {
     /**
-     * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
+     * The MetaSiteId to clone from.
      * @format GUID
      */
     metaSiteId?: string;
+}
+interface CloneMenusResponse {
+}
+interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    id?: string;
     /**
-     * Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
-     * @format GUID
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
      */
-    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;
-    /** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */
-    customTag?: CustomTag;
-    /** Invalidate by multiple page ids */
-    pages?: Pages;
-    /** Invalidate by multiple URI paths */
-    uris?: URIs;
+    entityFqdn?: string;
     /**
-     * tell us why you're invalidating the cache. You don't need to add your app name
-     * @maxLength 256
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
      */
-    reason?: string | null;
-    /** Is local DS */
-    localDc?: boolean;
-    hardPurge?: boolean;
+    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;
     /**
-     * Optional caller-provided ID for tracking this invalidation through the system.
-     * When set, the corresponding CDN purge completion event will include this ID,
-     * allowing you to confirm when the invalidation has fully propagated.
-     * Example: generate a UUID, pass it here, and later match it in the CDN purge completion event.
-     * @maxLength 256
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
      */
-    correlationId?: string | null;
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at `16:00` and then again at `16:01`, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
+     */
+    entityEventSequence?: string | null;
 }
 /** @oneof */
-interface InvalidateCacheGetByOneOf {
+interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+interface EntityCreatedEvent {
+    entityAsJson?: string;
     /**
-     * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
-     * @format GUID
+     * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity
+     * @internal
      */
-    metaSiteId?: string;
+    triggeredByUndelete?: boolean | null;
+    /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
+    restoreInfo?: RestoreInfo;
     /**
-     * Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
-     * @format GUID
+     * Optional domain-specific metadata defined by the API owner, encoded as JSON.
+     * @internal
      */
-    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;
-    /** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */
-    customTag?: CustomTag;
-    /** Invalidate by multiple page ids */
-    pages?: Pages;
-    /** Invalidate by multiple URI paths */
-    uris?: URIs;
+    additionalMetadataAsJson?: string | null;
 }
-interface App {
+interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+interface EntityUpdatedEvent {
     /**
-     * The AppDefId
-     * @minLength 1
+     * 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.
      */
-    appDefId?: string;
+    currentEntityAsJson?: string;
     /**
-     * The instance Id
-     * @format GUID
+     * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard
+     * wont populate it / have any reference to it in the API.
+     * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,
+     * the developer should send only the new (current) entity.
+     * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big
+     * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.
+     * @internal
+     * @deprecated
      */
-    instanceId?: string;
-}
-interface Page {
+    previousEntityAsJson?: string | null;
     /**
-     * the msid the page is on
-     * @format GUID
+     * Map of fully qualified field paths to their previous values for fields that changed.
+     * For more details please see [AIP](https://dev.wix.com/docs/rnd-general/articles/p13n-guidelines-aips/guidance-aips/design-patterns/7016-events#modified-fields-format)
+     * @internal
      */
-    metaSiteId?: string;
+    modifiedFields?: Record<string, any>;
     /**
-     * Invalidate by Page ID
-     * @minLength 1
+     * Optional domain-specific metadata defined by the API owner, encoded as JSON.
+     * @internal
      */
-    pageId?: string;
+    additionalMetadataAsJson?: string | null;
 }
-interface URI {
+interface EntityDeletedEvent {
     /**
-     * the msid the URI is on
-     * @format GUID
+     * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled
+     * @internal
      */
-    metaSiteId?: string;
+    movedToTrash?: boolean | null;
+    /** Entity that was deleted. */
+    deletedEntityAsJson?: string | null;
     /**
-     * URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes
-     * @minLength 1
+     * Optional domain-specific metadata defined by the API owner, encoded as JSON.
+     * @internal
      */
-    uriPath?: string;
+    additionalMetadataAsJson?: string | null;
 }
-interface File {
+interface ActionEvent {
+    bodyAsJson?: string;
+}
+interface Empty {
+}
+interface SyncContentToMultilingualRequest {
     /**
-     * the msid the file is related to
+     * MetaSite ID
      * @format GUID
      */
     metaSiteId?: string;
+}
+interface SyncContentToMultilingualResponse {
+}
+interface MessageEnvelope {
     /**
-     * Invalidate by filename (for media files such as PDFs)
-     * @minLength 1
-     * @maxLength 256
+     * App instance ID.
+     * @format GUID
      */
-    fileName?: string;
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+    /** Details related to the account */
+    accountInfo?: AccountInfo;
 }
-interface CustomTag {
+interface IdentificationData extends IdentificationDataIdOneOf {
     /**
-     * the msid the tag is related to
+     * ID of a site visitor that has not logged in to the site.
      * @format GUID
      */
-    metaSiteId?: string;
+    anonymousVisitorId?: string;
     /**
-     * Tag to invalidate by
-     * @minLength 1
-     * @maxLength 256
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
      */
-    tag?: string;
-}
-interface Pages {
+    memberId?: string;
     /**
-     * the msid the pages are on
+     * ID of a Wix user (site owner, contributor, etc.).
      * @format GUID
      */
-    metaSiteId?: string;
+    wixUserId?: string;
     /**
-     * Invalidate by multiple Page IDs in a single message
-     * @maxSize 100
-     * @minLength 1
+     * ID of an app.
+     * @format GUID
      */
-    pageIds?: string[];
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityTypeWithLiterals;
 }
-interface URIs {
+/** @oneof */
+interface IdentificationDataIdOneOf {
     /**
-     * the msid the URIs are on
+     * ID of a site visitor that has not logged in to the site.
      * @format GUID
      */
-    metaSiteId?: string;
+    anonymousVisitorId?: string;
     /**
-     * URI paths to invalidate (e.g. page/my/path) - without leading/trailing slashes
-     * @maxSize 100
-     * @minLength 1
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
      */
-    uriPaths?: string[];
-}
-interface DeleteOrphanSections {
-    /** Menu id */
-    menuId?: string;
-}
-interface MenusDataCloningCompleted {
-}
-interface CreateMenuRequest {
-    /** Menu details. */
-    menu: Menu;
-}
-interface CreateMenuResponse {
-    /** Menu. */
-    menu?: Menu;
-}
-interface BulkCreateMenusRequest {
+    memberId?: string;
     /**
-     * Menu details.
-     * @maxSize 100
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
      */
-    menus: Menu[];
-    /** Whether to receive the created menus in the response. */
-    returnEntity?: boolean;
-}
-interface BulkCreateMenusResponse {
-    /** Information about the created menus. */
-    results?: BulkCreateMenuResult[];
-    /** Metadata for the API call. */
-    bulkActionMetadata?: BulkActionMetadata;
-}
-interface BulkCreateMenuResult {
-    /** Whether to receive the created menus in the response. */
-    menuMetadata?: ItemMetadata;
-    /** Created menu. */
-    menu?: Menu;
-}
-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;
-}
-interface ApplicationError {
-    /** Error code. */
-    code?: string;
-    /** Description of the error. */
-    description?: string;
-    /** Data related to the error. */
-    data?: Record<string, any> | null;
-}
-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;
-}
-interface GetMenuRequest {
+    wixUserId?: string;
     /**
-     * Menu ID.
+     * ID of an app.
      * @format GUID
      */
-    menuId: string;
+    appId?: string;
 }
-interface GetMenuResponse {
-    /** Menu. */
-    menu?: Menu;
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
 }
-interface ListMenusRequest {
+/** @enumType */
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+interface AccountInfo {
     /**
-     * Menu IDs.
+     * ID of the Wix account associated with the event.
      * @format GUID
-     * @maxSize 500
      */
-    menuIds?: string[];
-    /** The metadata of the paginated results. */
-    paging?: CursorPaging;
-    /** Whether to return only menus that are visible to site visitors. */
-    onlyVisible?: boolean | null;
-}
-interface ListMenusResponse {
-    /** Retrieved menus. */
-    menus?: Menu[];
-    /** The metadata of the paginated results. */
-    pagingMetadata?: CursorPagingMetadata;
-}
-interface QueryMenusRequest {
-    /** Query options. */
-    query?: CursorQuery;
-}
-interface QueryMenusResponse {
-    /** Retrieved menus. */
-    menus?: Menu[];
-    /** The metadata of the paginated results. */
-    pagingMetadata?: CursorPagingMetadata;
-}
-interface UpdateMenuRequest {
-    /** Menu to update. */
-    menu: Menu;
+    accountId?: string | null;
     /**
-     * Explicit list of fields to update.
-     * @internal
+     * ID of the parent Wix account. Only included when accountId belongs to a child account.
+     * @format GUID
      */
-    mask?: string[];
-}
-interface UpdateMenuResponse {
-    /** Updated menu. */
-    menu?: Menu;
-}
-interface BulkUpdateMenuRequest {
+    parentAccountId?: string | null;
     /**
-     * Menus to update.
-     * @minSize 1
-     * @maxSize 100
+     * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
+     * @format GUID
      */
-    menus: MaskedMenu[];
-    /** Whether to receive the entity in the response. */
-    returnEntity?: boolean;
-}
-interface MaskedMenu {
-    /** Menu to updated. */
-    menu?: Menu;
-    /** Explicit list of fields to update. */
-    mask?: string[];
+    siteId?: string | null;
 }
-interface BulkUpdateMenuResponse {
+interface DuplicateMenuRequest {
     /**
-     * Results of bulk menu update.
-     * @minSize 1
-     * @maxSize 100
+     * Menu id to be duplicated.
+     * @format GUID
      */
-    results?: BulkMenuResult[];
-    /** Metadata for the API call. */
-    bulkActionMetadata?: BulkActionMetadata;
-}
-interface BulkMenuResult {
-    /** Metadata for menu update. */
-    menuMetadata?: ItemMetadata;
-    /** Updated menu. Only returned if `returnEntity` is set to `true`. */
-    menu?: Menu;
-}
-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;
-}
-interface UpdateExtendedFieldsResponse {
-    /** Namespace of the app. */
-    namespace?: string;
-    /** Updated extended fields data. */
-    namespaceData?: Record<string, any> | null;
-}
-interface DeleteMenuRequest {
     /**
-     * Menu ID.
+     * Business location ids to duplicate the menu to.
      * @format GUID
+     * @maxSize 100
      */
-    menuId: string;
-}
-interface DeleteMenuResponse {
-}
-interface RunMenusMultiLocationMigrationRequest {
+    businessLocationIds?: string[] | null;
+    /** Indicates whether sub-entities (such as items) should be duplicated as well. */
+    duplicateSubEntities?: boolean | null;
     /**
-     * business location id
-     * @format GUID
+     * The new name of the duplicated menu.
+     * @maxLength 500
      */
-    businessLocationId?: string;
-}
-interface RunMenusMultiLocationMigrationResponse {
-    /** Whether menus multi-location migration finished successfully */
-    success?: boolean;
+    menuName?: string | null;
 }
-interface UpdateBusinessLocationIdRequest {
-    /** @format GUID */
-    menuId?: string;
+interface DuplicateMenuResponse {
     /** @format GUID */
-    businessLocationId?: string | null;
-}
-interface UpdateBusinessLocationIdResponse {
+    menuIds?: string[];
 }
-interface CloneMenusRequest {
+interface GetMenuSiteUrlRequest {
     /**
-     * The MetaSiteId to clone from.
+     * Menu ID.
      * @format GUID
+     * @readonly
      */
-    metaSiteId?: string;
-}
-interface CloneMenusResponse {
+    id: string | null;
 }
-interface Empty {
+interface GetMenuSiteUrlResponse {
+    /** Retrieved menuInfo with path url. */
+    menuSiteUrl?: MenuSiteUrl;
 }
-interface SyncContentToMultilingualRequest {
+interface MenuSiteUrl {
     /**
-     * MetaSite ID
-     * @format GUID
+     * Path URL.
+     * @minLength 1
+     * @maxLength 1000
      */
-    metaSiteId?: string;
+    path?: string;
 }
-interface SyncContentToMultilingualResponse {
+interface QueryMenusSiteUrlRequest {
+    /** Query options */
+    query?: CursorQuery;
+}
+interface QueryMenusSiteUrlResponse {
+    /** Retrieved menuInfos with path urls. */
+    menuSiteUrls?: MenuSiteUrl[];
+    /** The metadata of the paginated results. */
+    pagingMetadata?: CursorPagingMetadata;
 }
 
 type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
@@ -1005,13 +1005,6 @@ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q
     __responseType: Q;
     __originalResponseType: R;
 };
-declare function duplicateMenu(): __PublicMethodMetaInfo<'POST', {
-    id: string;
-}, DuplicateMenuRequest$1, DuplicateMenuRequest, DuplicateMenuResponse$1, DuplicateMenuResponse>;
-declare function getMenuSiteUrl(): __PublicMethodMetaInfo<'GET', {
-    id: string;
-}, GetMenuSiteUrlRequest$1, GetMenuSiteUrlRequest, GetMenuSiteUrlResponse$1, GetMenuSiteUrlResponse>;
-declare function queryMenusSiteUrl(): __PublicMethodMetaInfo<'POST', {}, QueryMenusSiteUrlRequest$1, QueryMenusSiteUrlRequest, QueryMenusSiteUrlResponse$1, QueryMenusSiteUrlResponse>;
 declare function createMenu(): __PublicMethodMetaInfo<'POST', {}, CreateMenuRequest$1, CreateMenuRequest, CreateMenuResponse$1, CreateMenuResponse>;
 declare function bulkCreateMenus(): __PublicMethodMetaInfo<'POST', {}, BulkCreateMenusRequest$1, BulkCreateMenusRequest, BulkCreateMenusResponse$1, BulkCreateMenusResponse>;
 declare function getMenu(): __PublicMethodMetaInfo<'GET', {
@@ -1029,5 +1022,12 @@ declare function updateExtendedFields(): __PublicMethodMetaInfo<'POST', {
 declare function deleteMenu(): __PublicMethodMetaInfo<'DELETE', {
     menuId: string;
 }, DeleteMenuRequest$1, DeleteMenuRequest, DeleteMenuResponse$1, DeleteMenuResponse>;
+declare function duplicateMenu(): __PublicMethodMetaInfo<'POST', {
+    id: string;
+}, DuplicateMenuRequest$1, DuplicateMenuRequest, DuplicateMenuResponse$1, DuplicateMenuResponse>;
+declare function getMenuSiteUrl(): __PublicMethodMetaInfo<'GET', {
+    id: string;
+}, GetMenuSiteUrlRequest$1, GetMenuSiteUrlRequest, GetMenuSiteUrlResponse$1, GetMenuSiteUrlResponse>;
+declare function queryMenusSiteUrl(): __PublicMethodMetaInfo<'POST', {}, QueryMenusSiteUrlRequest$1, QueryMenusSiteUrlRequest, QueryMenusSiteUrlResponse$1, QueryMenusSiteUrlResponse>;
 
 export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, type AddressLocation as AddressLocationOriginal, type App as AppOriginal, type ApplicationError as ApplicationErrorOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type BulkCreateMenuResult as BulkCreateMenuResultOriginal, type BulkCreateMenusRequest as BulkCreateMenusRequestOriginal, type BulkCreateMenusResponse as BulkCreateMenusResponseOriginal, type BulkMenuResult as BulkMenuResultOriginal, type BulkUpdateMenuRequest as BulkUpdateMenuRequestOriginal, type BulkUpdateMenuResponse as BulkUpdateMenuResponseOriginal, type BusinessLocationDetails as BusinessLocationDetailsOriginal, type CloneMenusRequest as CloneMenusRequestOriginal, type CloneMenusResponse as CloneMenusResponseOriginal, type CreateMenuRequest as CreateMenuRequestOriginal, type CreateMenuResponse as CreateMenuResponseOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorQuery as CursorQueryOriginal, type CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, type CustomTag as CustomTagOriginal, type DeleteMenuRequest as DeleteMenuRequestOriginal, type DeleteMenuResponse as DeleteMenuResponseOriginal, type DeleteOrphanSections as DeleteOrphanSectionsOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type DuplicateMenuRequest as DuplicateMenuRequestOriginal, type DuplicateMenuResponse as DuplicateMenuResponseOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type ExtendedFields as ExtendedFieldsOriginal, type ExternalReferenceInfo as ExternalReferenceInfoOriginal, type File as FileOriginal, type GetMenuRequest as GetMenuRequestOriginal, type GetMenuResponse as GetMenuResponseOriginal, type GetMenuSiteUrlRequest as GetMenuSiteUrlRequestOriginal, type GetMenuSiteUrlResponse as GetMenuSiteUrlResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type InvalidateCacheGetByOneOf as InvalidateCacheGetByOneOfOriginal, type InvalidateCache as InvalidateCacheOriginal, type ItemMetadata as ItemMetadataOriginal, type Keyword as KeywordOriginal, type ListMenusRequest as ListMenusRequestOriginal, type ListMenusResponse as ListMenusResponseOriginal, type MaskedMenu as MaskedMenuOriginal, type Menu as MenuOriginal, type MenuSiteUrl as MenuSiteUrlOriginal, type MenusDataCloningCompleted as MenusDataCloningCompletedOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type Page as PageOriginal, type Pages as PagesOriginal, type QueryMenusRequest as QueryMenusRequestOriginal, type QueryMenusResponse as QueryMenusResponseOriginal, type QueryMenusSiteUrlRequest as QueryMenusSiteUrlRequestOriginal, type QueryMenusSiteUrlResponse as QueryMenusSiteUrlResponseOriginal, type RestoreInfo as RestoreInfoOriginal, type RunMenusMultiLocationMigrationRequest as RunMenusMultiLocationMigrationRequestOriginal, type RunMenusMultiLocationMigrationResponse as RunMenusMultiLocationMigrationResponseOriginal, type SeoSchema as SeoSchemaOriginal, type Settings as SettingsOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, type SyncContentToMultilingualRequest as SyncContentToMultilingualRequestOriginal, type SyncContentToMultilingualResponse as SyncContentToMultilingualResponseOriginal, type Tag as TagOriginal, type URI as URIOriginal, type URIs as URIsOriginal, type UpdateBusinessLocationIdRequest as UpdateBusinessLocationIdRequestOriginal, type UpdateBusinessLocationIdResponse as UpdateBusinessLocationIdResponseOriginal, type UpdateExtendedFieldsRequest as UpdateExtendedFieldsRequestOriginal, type UpdateExtendedFieldsResponse as UpdateExtendedFieldsResponseOriginal, type UpdateMenuRequest as UpdateMenuRequestOriginal, type UpdateMenuResponse as UpdateMenuResponseOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, bulkCreateMenus, bulkUpdateMenu, createMenu, deleteMenu, duplicateMenu, getMenu, getMenuSiteUrl, listMenus, queryMenus, queryMenusSiteUrl, updateExtendedFields, updateMenu };