@wix/auto_sdk_restaurants_menus 1.0.86 → 1.0.87

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.
@@ -222,289 +222,206 @@ interface ExternalReferenceInfo {
222
222
  /** Whether the connection to the external system is currently active. */
223
223
  connected?: boolean | null;
224
224
  }
225
- interface InvalidateCache extends InvalidateCacheGetByOneOf {
225
+ interface DuplicateMenuRequest {
226
226
  /**
227
- * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
227
+ * Menu id to be duplicated.
228
228
  * @format GUID
229
229
  */
230
- metaSiteId?: string;
230
+ _id: string;
231
231
  /**
232
- * Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
232
+ * Business location ids to duplicate the menu to.
233
233
  * @format GUID
234
+ * @maxSize 100
234
235
  */
235
- siteId?: string;
236
- /** Invalidate by App */
237
- app?: App;
238
- /** Invalidate by page id */
239
- page?: Page;
240
- /** Invalidate by URI path */
241
- uri?: URI;
242
- /** Invalidate by file (for media files such as PDFs) */
243
- file?: File;
244
- /** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */
245
- customTag?: CustomTag;
246
- /** Invalidate by multiple page ids */
247
- pages?: Pages;
248
- /** Invalidate by multiple URI paths */
249
- uris?: URIs;
236
+ businessLocationIds?: string[] | null;
237
+ /** Indicates whether sub-entities (such as items) should be duplicated as well. */
238
+ duplicateSubEntities?: boolean | null;
250
239
  /**
251
- * tell us why you're invalidating the cache. You don't need to add your app name
252
- * @maxLength 256
240
+ * The new name of the duplicated menu.
241
+ * @maxLength 500
253
242
  */
254
- reason?: string | null;
255
- /** Is local DS */
256
- localDc?: boolean;
257
- hardPurge?: boolean;
243
+ menuName?: string | null;
244
+ }
245
+ interface DuplicateMenuResponse {
246
+ /** @format GUID */
247
+ menuIds?: string[];
248
+ }
249
+ interface DomainEvent extends DomainEventBodyOneOf {
250
+ createdEvent?: EntityCreatedEvent;
251
+ updatedEvent?: EntityUpdatedEvent;
252
+ deletedEvent?: EntityDeletedEvent;
253
+ actionEvent?: ActionEvent;
254
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
255
+ _id?: string;
258
256
  /**
259
- * Optional caller-provided ID for tracking this invalidation through the system.
260
- * When set, the corresponding CDN purge completion event will include this ID,
261
- * allowing you to confirm when the invalidation has fully propagated.
262
- * Example: generate a UUID, pass it here, and later match it in the CDN purge completion event.
263
- * @maxLength 256
257
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
258
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
264
259
  */
265
- correlationId?: string | null;
266
- }
267
- /** @oneof */
268
- interface InvalidateCacheGetByOneOf {
260
+ entityFqdn?: string;
269
261
  /**
270
- * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
271
- * @format GUID
262
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
263
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
272
264
  */
273
- metaSiteId?: string;
265
+ slug?: string;
266
+ /** ID of the entity associated with the event. */
267
+ entityId?: string;
268
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
269
+ eventTime?: Date | null;
274
270
  /**
275
- * Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
276
- * @format GUID
271
+ * Whether the event was triggered as a result of a privacy regulation application
272
+ * (for example, GDPR).
277
273
  */
278
- siteId?: string;
279
- /** Invalidate by App */
280
- app?: App;
281
- /** Invalidate by page id */
282
- page?: Page;
283
- /** Invalidate by URI path */
284
- uri?: URI;
285
- /** Invalidate by file (for media files such as PDFs) */
286
- file?: File;
287
- /** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */
288
- customTag?: CustomTag;
289
- /** Invalidate by multiple page ids */
290
- pages?: Pages;
291
- /** Invalidate by multiple URI paths */
292
- uris?: URIs;
274
+ triggeredByAnonymizeRequest?: boolean | null;
275
+ /** If present, indicates the action that triggered the event. */
276
+ originatedFrom?: string | null;
277
+ /**
278
+ * 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.
279
+ * 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.
280
+ */
281
+ entityEventSequence?: string | null;
293
282
  }
294
- interface App {
283
+ /** @oneof */
284
+ interface DomainEventBodyOneOf {
285
+ createdEvent?: EntityCreatedEvent;
286
+ updatedEvent?: EntityUpdatedEvent;
287
+ deletedEvent?: EntityDeletedEvent;
288
+ actionEvent?: ActionEvent;
289
+ }
290
+ interface EntityCreatedEvent {
291
+ entity?: string;
292
+ }
293
+ interface RestoreInfo {
294
+ deletedDate?: Date | null;
295
+ }
296
+ interface EntityUpdatedEvent {
295
297
  /**
296
- * The AppDefId
297
- * @minLength 1
298
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
299
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
300
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
298
301
  */
299
- appDefId?: string;
302
+ currentEntity?: string;
303
+ }
304
+ interface EntityDeletedEvent {
305
+ /** Entity that was deleted. */
306
+ deletedEntity?: string | null;
307
+ }
308
+ interface ActionEvent {
309
+ body?: string;
310
+ }
311
+ interface MessageEnvelope {
300
312
  /**
301
- * The instance Id
313
+ * App instance ID.
302
314
  * @format GUID
303
315
  */
304
- instanceId?: string;
316
+ instanceId?: string | null;
317
+ /**
318
+ * Event type.
319
+ * @maxLength 150
320
+ */
321
+ eventType?: string;
322
+ /** The identification type and identity data. */
323
+ identity?: IdentificationData;
324
+ /** Stringify payload. */
325
+ data?: string;
326
+ /** Details related to the account */
327
+ accountInfo?: AccountInfo;
305
328
  }
306
- interface Page {
329
+ interface IdentificationData extends IdentificationDataIdOneOf {
307
330
  /**
308
- * the msid the page is on
331
+ * ID of a site visitor that has not logged in to the site.
309
332
  * @format GUID
310
333
  */
311
- metaSiteId?: string;
334
+ anonymousVisitorId?: string;
312
335
  /**
313
- * Invalidate by Page ID
314
- * @minLength 1
336
+ * ID of a site visitor that has logged in to the site.
337
+ * @format GUID
315
338
  */
316
- pageId?: string;
317
- }
318
- interface URI {
339
+ memberId?: string;
319
340
  /**
320
- * the msid the URI is on
341
+ * ID of a Wix user (site owner, contributor, etc.).
321
342
  * @format GUID
322
343
  */
323
- metaSiteId?: string;
344
+ wixUserId?: string;
324
345
  /**
325
- * URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes
326
- * @minLength 1
346
+ * ID of an app.
347
+ * @format GUID
327
348
  */
328
- uriPath?: string;
349
+ appId?: string;
350
+ /** @readonly */
351
+ identityType?: WebhookIdentityTypeWithLiterals;
329
352
  }
330
- interface File {
353
+ /** @oneof */
354
+ interface IdentificationDataIdOneOf {
331
355
  /**
332
- * the msid the file is related to
356
+ * ID of a site visitor that has not logged in to the site.
333
357
  * @format GUID
334
358
  */
335
- metaSiteId?: string;
359
+ anonymousVisitorId?: string;
336
360
  /**
337
- * Invalidate by filename (for media files such as PDFs)
338
- * @minLength 1
339
- * @maxLength 256
361
+ * ID of a site visitor that has logged in to the site.
362
+ * @format GUID
340
363
  */
341
- fileName?: string;
342
- }
343
- interface CustomTag {
364
+ memberId?: string;
344
365
  /**
345
- * the msid the tag is related to
366
+ * ID of a Wix user (site owner, contributor, etc.).
346
367
  * @format GUID
347
368
  */
348
- metaSiteId?: string;
369
+ wixUserId?: string;
349
370
  /**
350
- * Tag to invalidate by
351
- * @minLength 1
352
- * @maxLength 256
371
+ * ID of an app.
372
+ * @format GUID
353
373
  */
354
- tag?: string;
374
+ appId?: string;
355
375
  }
356
- interface Pages {
376
+ declare enum WebhookIdentityType {
377
+ UNKNOWN = "UNKNOWN",
378
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
379
+ MEMBER = "MEMBER",
380
+ WIX_USER = "WIX_USER",
381
+ APP = "APP"
382
+ }
383
+ /** @enumType */
384
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
385
+ interface AccountInfo {
357
386
  /**
358
- * the msid the pages are on
387
+ * ID of the Wix account associated with the event.
359
388
  * @format GUID
360
389
  */
361
- metaSiteId?: string;
390
+ accountId?: string | null;
362
391
  /**
363
- * Invalidate by multiple Page IDs in a single message
364
- * @maxSize 100
365
- * @minLength 1
392
+ * ID of the parent Wix account. Only included when accountId belongs to a child account.
393
+ * @format GUID
366
394
  */
367
- pageIds?: string[];
368
- }
369
- interface URIs {
395
+ parentAccountId?: string | null;
370
396
  /**
371
- * the msid the URIs are on
397
+ * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
372
398
  * @format GUID
373
399
  */
374
- metaSiteId?: string;
400
+ siteId?: string | null;
401
+ }
402
+ interface GetMenuSiteUrlRequest {
375
403
  /**
376
- * URI paths to invalidate (e.g. page/my/path) - without leading/trailing slashes
377
- * @maxSize 100
378
- * @minLength 1
404
+ * Menu ID.
405
+ * @format GUID
406
+ * @readonly
379
407
  */
380
- uriPaths?: string[];
408
+ _id: string | null;
381
409
  }
382
- interface DeleteOrphanSections {
383
- /** Menu id */
384
- menuId?: string;
410
+ interface GetMenuSiteUrlResponse {
411
+ /** Retrieved menuInfo with path url. */
412
+ menuSiteUrl?: MenuSiteUrl;
385
413
  }
386
- interface MenusDataCloningCompleted {
414
+ interface MenuSiteUrl {
415
+ /**
416
+ * Path URL.
417
+ * @minLength 1
418
+ * @maxLength 1000
419
+ */
420
+ path?: string;
387
421
  }
388
- interface CreateMenuRequest {
389
- /** Menu details. */
390
- menu: Menu;
391
- }
392
- interface CreateMenuResponse {
393
- /** Menu. */
394
- menu?: Menu;
395
- }
396
- interface BulkCreateMenusRequest {
397
- /**
398
- * Menu details.
399
- * @maxSize 100
400
- */
401
- menus: Menu[];
402
- /** Whether to receive the created menus in the response. */
403
- returnEntity?: boolean;
404
- }
405
- interface BulkCreateMenusResponse {
406
- /** Information about the created menus. */
407
- results?: BulkCreateMenuResult[];
408
- /** Metadata for the API call. */
409
- bulkActionMetadata?: BulkActionMetadata;
410
- }
411
- interface BulkCreateMenuResult {
412
- /** Whether to receive the created menus in the response. */
413
- menuMetadata?: ItemMetadata;
414
- /** Created menu. */
415
- menu?: Menu;
416
- }
417
- interface ItemMetadata {
418
- /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
419
- _id?: string | null;
420
- /** Index of the item within the request array. Allows for correlation between request and response items. */
421
- originalIndex?: number;
422
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
423
- success?: boolean;
424
- /** Details about the error in case of failure. */
425
- error?: ApplicationError;
426
- }
427
- interface ApplicationError {
428
- /** Error code. */
429
- code?: string;
430
- /** Description of the error. */
431
- description?: string;
432
- /** Data related to the error. */
433
- data?: Record<string, any> | null;
434
- }
435
- interface BulkActionMetadata {
436
- /** Number of items that were successfully processed. */
437
- totalSuccesses?: number;
438
- /** Number of items that couldn't be processed. */
439
- totalFailures?: number;
440
- /** Number of failures without details because detailed failure threshold was exceeded. */
441
- undetailedFailures?: number;
442
- }
443
- interface GetMenuRequest {
444
- /**
445
- * Menu ID.
446
- * @format GUID
447
- */
448
- menuId: string;
449
- }
450
- interface GetMenuResponse {
451
- /** Menu. */
452
- menu?: Menu;
453
- }
454
- interface ListMenusRequest {
455
- /**
456
- * Menu IDs.
457
- * @format GUID
458
- * @maxSize 500
459
- */
460
- menuIds?: string[];
461
- /** The metadata of the paginated results. */
462
- paging?: CursorPaging;
463
- /** Whether to return only menus that are visible to site visitors. */
464
- onlyVisible?: boolean | null;
465
- }
466
- interface CursorPaging {
467
- /**
468
- * Number of items to load.
469
- * @max 500
470
- */
471
- limit?: number | null;
472
- /**
473
- * Pointer to the next or previous page in the list of results.
474
- *
475
- * You can get the relevant cursor token
476
- * from the `pagingMetadata` object in the previous call's response.
477
- * Not relevant for the first request.
478
- */
479
- cursor?: string | null;
480
- }
481
- interface ListMenusResponse {
482
- /** Retrieved menus. */
483
- menus?: Menu[];
484
- /** The metadata of the paginated results. */
485
- pagingMetadata?: CursorPagingMetadata;
486
- }
487
- interface CursorPagingMetadata {
488
- /** Number of items returned in the response. */
489
- count?: number | null;
490
- /** Offset that was requested. */
491
- cursors?: Cursors;
492
- /**
493
- * Indicates if there are more results after the current page.
494
- * If `true`, another page of results can be retrieved.
495
- * If `false`, this is the last page.
496
- */
497
- hasNext?: boolean | null;
498
- }
499
- interface Cursors {
500
- /** Cursor pointing to next page in the list of results. */
501
- next?: string | null;
502
- /** Cursor pointing to previous page in the list of results. */
503
- prev?: string | null;
504
- }
505
- interface QueryMenusRequest {
506
- /** Query options. */
507
- query?: CursorQuery;
422
+ interface QueryMenusSiteUrlRequest {
423
+ /** Query options */
424
+ query?: CursorQuery;
508
425
  }
509
426
  interface CursorQuery extends CursorQueryPagingMethodOneOf {
510
427
  /** 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`. */
@@ -569,348 +486,431 @@ interface AddressLocation {
569
486
  /** Address longitude. */
570
487
  longitude?: number | null;
571
488
  }
572
- interface QueryMenusResponse {
573
- /** Retrieved menus. */
574
- menus?: Menu[];
575
- /** The metadata of the paginated results. */
576
- pagingMetadata?: CursorPagingMetadata;
577
- }
578
- interface UpdateMenuRequest {
579
- /** Menu to update. */
580
- menu: Menu;
489
+ interface CursorPaging {
581
490
  /**
582
- * Explicit list of fields to update.
583
- * @internal
491
+ * Number of items to load.
492
+ * @max 500
584
493
  */
585
- mask?: string[];
586
- }
587
- interface UpdateMenuResponse {
588
- /** Updated menu. */
589
- menu?: Menu;
590
- }
591
- interface BulkUpdateMenuRequest {
494
+ limit?: number | null;
592
495
  /**
593
- * Menus to update.
594
- * @minSize 1
595
- * @maxSize 100
496
+ * Pointer to the next or previous page in the list of results.
497
+ *
498
+ * You can get the relevant cursor token
499
+ * from the `pagingMetadata` object in the previous call's response.
500
+ * Not relevant for the first request.
596
501
  */
597
- menus: MaskedMenu[];
598
- /** Whether to receive the entity in the response. */
599
- returnEntity?: boolean;
502
+ cursor?: string | null;
600
503
  }
601
- interface MaskedMenu {
602
- /** Menu to updated. */
603
- menu?: Menu;
604
- /** Explicit list of fields to update. */
605
- mask?: string[];
504
+ interface QueryMenusSiteUrlResponse {
505
+ /** Retrieved menuInfos with path urls. */
506
+ menuSiteUrls?: MenuSiteUrl[];
507
+ /** The metadata of the paginated results. */
508
+ pagingMetadata?: CursorPagingMetadata;
606
509
  }
607
- interface BulkUpdateMenuResponse {
510
+ interface CursorPagingMetadata {
511
+ /** Number of items returned in the response. */
512
+ count?: number | null;
513
+ /** Offset that was requested. */
514
+ cursors?: Cursors;
608
515
  /**
609
- * Results of bulk menu update.
610
- * @minSize 1
611
- * @maxSize 100
516
+ * Indicates if there are more results after the current page.
517
+ * If `true`, another page of results can be retrieved.
518
+ * If `false`, this is the last page.
612
519
  */
613
- results?: BulkMenuResult[];
614
- /** Metadata for the API call. */
615
- bulkActionMetadata?: BulkActionMetadata;
616
- }
617
- interface BulkMenuResult {
618
- /** Metadata for menu update. */
619
- menuMetadata?: ItemMetadata;
620
- /** Updated menu. Only returned if `returnEntity` is set to `true`. */
621
- menu?: Menu;
622
- }
623
- interface UpdateExtendedFieldsRequest {
624
- /** ID of the entity to update. */
625
- _id: string;
626
- /** Identifier for the app whose extended fields are being updated. */
627
- namespace: string;
628
- /** 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. */
629
- namespaceData: Record<string, any> | null;
520
+ hasNext?: boolean | null;
630
521
  }
631
- interface UpdateExtendedFieldsResponse {
632
- /** Namespace of the app. */
633
- namespace?: string;
634
- /** Updated extended fields data. */
635
- namespaceData?: Record<string, any> | null;
522
+ interface Cursors {
523
+ /** Cursor pointing to next page in the list of results. */
524
+ next?: string | null;
525
+ /** Cursor pointing to previous page in the list of results. */
526
+ prev?: string | null;
636
527
  }
637
- interface DeleteMenuRequest {
528
+ interface InvalidateCache extends InvalidateCacheGetByOneOf {
638
529
  /**
639
- * Menu ID.
530
+ * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
640
531
  * @format GUID
641
532
  */
642
- menuId: string;
643
- }
644
- interface DeleteMenuResponse {
645
- }
646
- interface RestoreMenusFromTrashRequest {
533
+ metaSiteId?: string;
647
534
  /**
648
- * Menu IDs to restore from the trash bin.
535
+ * Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
649
536
  * @format GUID
650
- * @minSize 1
651
- * @maxSize 100
652
537
  */
653
- menuIds?: string[];
654
- }
655
- interface RestoreMenusFromTrashResponse {
538
+ siteId?: string;
539
+ /** Invalidate by App */
540
+ app?: App;
541
+ /** Invalidate by page id */
542
+ page?: Page;
543
+ /** Invalidate by URI path */
544
+ uri?: URI;
545
+ /** Invalidate by file (for media files such as PDFs) */
546
+ file?: File;
547
+ /** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */
548
+ customTag?: CustomTag;
549
+ /** Invalidate by multiple page ids */
550
+ pages?: Pages;
551
+ /** Invalidate by multiple URI paths */
552
+ uris?: URIs;
656
553
  /**
657
- * Menu IDs that were successfully restored.
658
- * @format GUID
659
- * @maxSize 100
554
+ * tell us why you're invalidating the cache. You don't need to add your app name
555
+ * @maxLength 256
660
556
  */
661
- restoredMenuIds?: string[];
557
+ reason?: string | null;
558
+ /** Is local DS */
559
+ localDc?: boolean;
560
+ hardPurge?: boolean;
662
561
  /**
663
- * Menu IDs that failed to restore.
664
- * @format GUID
665
- * @maxSize 100
562
+ * Optional caller-provided ID for tracking this invalidation through the system.
563
+ * When set, the corresponding CDN purge completion event will include this ID,
564
+ * allowing you to confirm when the invalidation has fully propagated.
565
+ * Example: generate a UUID, pass it here, and later match it in the CDN purge completion event.
566
+ * @maxLength 256
666
567
  */
667
- failedMenuIds?: string[];
568
+ correlationId?: string | null;
668
569
  }
669
- interface RunMenusMultiLocationMigrationRequest {
570
+ /** @oneof */
571
+ interface InvalidateCacheGetByOneOf {
670
572
  /**
671
- * business location id
573
+ * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
672
574
  * @format GUID
673
575
  */
674
- businessLocationId?: string;
675
- }
676
- interface RunMenusMultiLocationMigrationResponse {
677
- /** Whether menus multi-location migration finished successfully */
678
- success?: boolean;
679
- }
680
- interface UpdateBusinessLocationIdRequest {
681
- /** @format GUID */
682
- menuId?: string;
683
- /** @format GUID */
684
- businessLocationId?: string | null;
685
- }
686
- interface UpdateBusinessLocationIdResponse {
687
- }
688
- interface CloneMenusRequest {
576
+ metaSiteId?: string;
689
577
  /**
690
- * The MetaSiteId to clone from.
578
+ * Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
691
579
  * @format GUID
692
580
  */
693
- metaSiteId?: string;
694
- }
695
- interface CloneMenusResponse {
581
+ siteId?: string;
582
+ /** Invalidate by App */
583
+ app?: App;
584
+ /** Invalidate by page id */
585
+ page?: Page;
586
+ /** Invalidate by URI path */
587
+ uri?: URI;
588
+ /** Invalidate by file (for media files such as PDFs) */
589
+ file?: File;
590
+ /** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */
591
+ customTag?: CustomTag;
592
+ /** Invalidate by multiple page ids */
593
+ pages?: Pages;
594
+ /** Invalidate by multiple URI paths */
595
+ uris?: URIs;
696
596
  }
697
- interface DomainEvent extends DomainEventBodyOneOf {
698
- createdEvent?: EntityCreatedEvent;
699
- updatedEvent?: EntityUpdatedEvent;
700
- deletedEvent?: EntityDeletedEvent;
701
- actionEvent?: ActionEvent;
702
- /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
703
- _id?: string;
597
+ interface App {
704
598
  /**
705
- * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
706
- * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
599
+ * The AppDefId
600
+ * @minLength 1
707
601
  */
708
- entityFqdn?: string;
602
+ appDefId?: string;
709
603
  /**
710
- * Event action name, placed at the top level to make it easier for users to dispatch messages.
711
- * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
604
+ * The instance Id
605
+ * @format GUID
712
606
  */
713
- slug?: string;
714
- /** ID of the entity associated with the event. */
715
- entityId?: string;
716
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
717
- eventTime?: Date | null;
607
+ instanceId?: string;
608
+ }
609
+ interface Page {
718
610
  /**
719
- * Whether the event was triggered as a result of a privacy regulation application
720
- * (for example, GDPR).
611
+ * the msid the page is on
612
+ * @format GUID
721
613
  */
722
- triggeredByAnonymizeRequest?: boolean | null;
723
- /** If present, indicates the action that triggered the event. */
724
- originatedFrom?: string | null;
614
+ metaSiteId?: string;
725
615
  /**
726
- * 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.
727
- * 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.
616
+ * Invalidate by Page ID
617
+ * @minLength 1
728
618
  */
729
- entityEventSequence?: string | null;
730
- }
731
- /** @oneof */
732
- interface DomainEventBodyOneOf {
733
- createdEvent?: EntityCreatedEvent;
734
- updatedEvent?: EntityUpdatedEvent;
735
- deletedEvent?: EntityDeletedEvent;
736
- actionEvent?: ActionEvent;
737
- }
738
- interface EntityCreatedEvent {
739
- entity?: string;
740
- }
741
- interface RestoreInfo {
742
- deletedDate?: Date | null;
619
+ pageId?: string;
743
620
  }
744
- interface EntityUpdatedEvent {
621
+ interface URI {
745
622
  /**
746
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
747
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
748
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
623
+ * the msid the URI is on
624
+ * @format GUID
749
625
  */
750
- currentEntity?: string;
751
- }
752
- interface EntityDeletedEvent {
753
- /** Entity that was deleted. */
754
- deletedEntity?: string | null;
755
- }
756
- interface ActionEvent {
757
- body?: string;
758
- }
759
- interface Empty {
626
+ metaSiteId?: string;
627
+ /**
628
+ * URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes
629
+ * @minLength 1
630
+ */
631
+ uriPath?: string;
760
632
  }
761
- interface SyncContentToMultilingualRequest {
633
+ interface File {
762
634
  /**
763
- * MetaSite ID
635
+ * the msid the file is related to
764
636
  * @format GUID
765
637
  */
766
638
  metaSiteId?: string;
639
+ /**
640
+ * Invalidate by filename (for media files such as PDFs)
641
+ * @minLength 1
642
+ * @maxLength 256
643
+ */
644
+ fileName?: string;
767
645
  }
768
- interface SyncContentToMultilingualResponse {
769
- }
770
- interface MessageEnvelope {
646
+ interface CustomTag {
771
647
  /**
772
- * App instance ID.
648
+ * the msid the tag is related to
773
649
  * @format GUID
774
650
  */
775
- instanceId?: string | null;
651
+ metaSiteId?: string;
776
652
  /**
777
- * Event type.
778
- * @maxLength 150
653
+ * Tag to invalidate by
654
+ * @minLength 1
655
+ * @maxLength 256
779
656
  */
780
- eventType?: string;
781
- /** The identification type and identity data. */
782
- identity?: IdentificationData;
783
- /** Stringify payload. */
784
- data?: string;
785
- /** Details related to the account */
786
- accountInfo?: AccountInfo;
657
+ tag?: string;
787
658
  }
788
- interface IdentificationData extends IdentificationDataIdOneOf {
659
+ interface Pages {
789
660
  /**
790
- * ID of a site visitor that has not logged in to the site.
661
+ * the msid the pages are on
791
662
  * @format GUID
792
663
  */
793
- anonymousVisitorId?: string;
664
+ metaSiteId?: string;
794
665
  /**
795
- * ID of a site visitor that has logged in to the site.
796
- * @format GUID
666
+ * Invalidate by multiple Page IDs in a single message
667
+ * @maxSize 100
668
+ * @minLength 1
797
669
  */
798
- memberId?: string;
670
+ pageIds?: string[];
671
+ }
672
+ interface URIs {
799
673
  /**
800
- * ID of a Wix user (site owner, contributor, etc.).
674
+ * the msid the URIs are on
801
675
  * @format GUID
802
676
  */
803
- wixUserId?: string;
677
+ metaSiteId?: string;
804
678
  /**
805
- * ID of an app.
806
- * @format GUID
679
+ * URI paths to invalidate (e.g. page/my/path) - without leading/trailing slashes
680
+ * @maxSize 100
681
+ * @minLength 1
807
682
  */
808
- appId?: string;
809
- /** @readonly */
810
- identityType?: WebhookIdentityTypeWithLiterals;
683
+ uriPaths?: string[];
811
684
  }
812
- /** @oneof */
813
- interface IdentificationDataIdOneOf {
685
+ interface DeleteOrphanSections {
686
+ /** Menu id */
687
+ menuId?: string;
688
+ }
689
+ interface MenusDataCloningCompleted {
690
+ }
691
+ interface CreateMenuRequest {
692
+ /** Menu details. */
693
+ menu: Menu;
694
+ }
695
+ interface CreateMenuResponse {
696
+ /** Menu. */
697
+ menu?: Menu;
698
+ }
699
+ interface BulkCreateMenusRequest {
814
700
  /**
815
- * ID of a site visitor that has not logged in to the site.
816
- * @format GUID
701
+ * Menu details.
702
+ * @maxSize 100
817
703
  */
818
- anonymousVisitorId?: string;
704
+ menus: Menu[];
705
+ /** Whether to receive the created menus in the response. */
706
+ returnEntity?: boolean;
707
+ }
708
+ interface BulkCreateMenusResponse {
709
+ /** Information about the created menus. */
710
+ results?: BulkCreateMenuResult[];
711
+ /** Metadata for the API call. */
712
+ bulkActionMetadata?: BulkActionMetadata;
713
+ }
714
+ interface BulkCreateMenuResult {
715
+ /** Whether to receive the created menus in the response. */
716
+ menuMetadata?: ItemMetadata;
717
+ /** Created menu. */
718
+ menu?: Menu;
719
+ }
720
+ interface ItemMetadata {
721
+ /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
722
+ _id?: string | null;
723
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
724
+ originalIndex?: number;
725
+ /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
726
+ success?: boolean;
727
+ /** Details about the error in case of failure. */
728
+ error?: ApplicationError;
729
+ }
730
+ interface ApplicationError {
731
+ /** Error code. */
732
+ code?: string;
733
+ /** Description of the error. */
734
+ description?: string;
735
+ /** Data related to the error. */
736
+ data?: Record<string, any> | null;
737
+ }
738
+ interface BulkActionMetadata {
739
+ /** Number of items that were successfully processed. */
740
+ totalSuccesses?: number;
741
+ /** Number of items that couldn't be processed. */
742
+ totalFailures?: number;
743
+ /** Number of failures without details because detailed failure threshold was exceeded. */
744
+ undetailedFailures?: number;
745
+ }
746
+ interface GetMenuRequest {
819
747
  /**
820
- * ID of a site visitor that has logged in to the site.
748
+ * Menu ID.
821
749
  * @format GUID
822
750
  */
823
- memberId?: string;
751
+ menuId: string;
752
+ }
753
+ interface GetMenuResponse {
754
+ /** Menu. */
755
+ menu?: Menu;
756
+ }
757
+ interface ListMenusRequest {
824
758
  /**
825
- * ID of a Wix user (site owner, contributor, etc.).
759
+ * Menu IDs.
826
760
  * @format GUID
761
+ * @maxSize 500
827
762
  */
828
- wixUserId?: string;
763
+ menuIds?: string[];
764
+ /** The metadata of the paginated results. */
765
+ paging?: CursorPaging;
766
+ /** Whether to return only menus that are visible to site visitors. */
767
+ onlyVisible?: boolean | null;
768
+ }
769
+ interface ListMenusResponse {
770
+ /** Retrieved menus. */
771
+ menus?: Menu[];
772
+ /** The metadata of the paginated results. */
773
+ pagingMetadata?: CursorPagingMetadata;
774
+ }
775
+ interface QueryMenusRequest {
776
+ /** Query options. */
777
+ query?: CursorQuery;
778
+ }
779
+ interface QueryMenusResponse {
780
+ /** Retrieved menus. */
781
+ menus?: Menu[];
782
+ /** The metadata of the paginated results. */
783
+ pagingMetadata?: CursorPagingMetadata;
784
+ }
785
+ interface UpdateMenuRequest {
786
+ /** Menu to update. */
787
+ menu: Menu;
788
+ /**
789
+ * Explicit list of fields to update.
790
+ * @internal
791
+ */
792
+ mask?: string[];
793
+ }
794
+ interface UpdateMenuResponse {
795
+ /** Updated menu. */
796
+ menu?: Menu;
797
+ }
798
+ interface BulkUpdateMenuRequest {
829
799
  /**
830
- * ID of an app.
831
- * @format GUID
800
+ * Menus to update.
801
+ * @minSize 1
802
+ * @maxSize 100
832
803
  */
833
- appId?: string;
804
+ menus: MaskedMenu[];
805
+ /** Whether to receive the entity in the response. */
806
+ returnEntity?: boolean;
834
807
  }
835
- declare enum WebhookIdentityType {
836
- UNKNOWN = "UNKNOWN",
837
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
838
- MEMBER = "MEMBER",
839
- WIX_USER = "WIX_USER",
840
- APP = "APP"
808
+ interface MaskedMenu {
809
+ /** Menu to updated. */
810
+ menu?: Menu;
811
+ /** Explicit list of fields to update. */
812
+ mask?: string[];
841
813
  }
842
- /** @enumType */
843
- type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
844
- interface AccountInfo {
814
+ interface BulkUpdateMenuResponse {
845
815
  /**
846
- * ID of the Wix account associated with the event.
847
- * @format GUID
816
+ * Results of bulk menu update.
817
+ * @minSize 1
818
+ * @maxSize 100
848
819
  */
849
- accountId?: string | null;
820
+ results?: BulkMenuResult[];
821
+ /** Metadata for the API call. */
822
+ bulkActionMetadata?: BulkActionMetadata;
823
+ }
824
+ interface BulkMenuResult {
825
+ /** Metadata for menu update. */
826
+ menuMetadata?: ItemMetadata;
827
+ /** Updated menu. Only returned if `returnEntity` is set to `true`. */
828
+ menu?: Menu;
829
+ }
830
+ interface UpdateExtendedFieldsRequest {
831
+ /** ID of the entity to update. */
832
+ _id: string;
833
+ /** Identifier for the app whose extended fields are being updated. */
834
+ namespace: string;
835
+ /** 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. */
836
+ namespaceData: Record<string, any> | null;
837
+ }
838
+ interface UpdateExtendedFieldsResponse {
839
+ /** Namespace of the app. */
840
+ namespace?: string;
841
+ /** Updated extended fields data. */
842
+ namespaceData?: Record<string, any> | null;
843
+ }
844
+ interface DeleteMenuRequest {
850
845
  /**
851
- * ID of the parent Wix account. Only included when accountId belongs to a child account.
846
+ * Menu ID.
852
847
  * @format GUID
853
848
  */
854
- parentAccountId?: string | null;
849
+ menuId: string;
850
+ }
851
+ interface DeleteMenuResponse {
852
+ }
853
+ interface RestoreMenusFromTrashRequest {
855
854
  /**
856
- * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
855
+ * Menu IDs to restore from the trash bin.
857
856
  * @format GUID
857
+ * @minSize 1
858
+ * @maxSize 100
858
859
  */
859
- siteId?: string | null;
860
+ menuIds?: string[];
860
861
  }
861
- interface DuplicateMenuRequest {
862
+ interface RestoreMenusFromTrashResponse {
862
863
  /**
863
- * Menu id to be duplicated.
864
+ * Menu IDs that were successfully restored.
864
865
  * @format GUID
866
+ * @maxSize 100
865
867
  */
866
- _id: string;
868
+ restoredMenuIds?: string[];
867
869
  /**
868
- * Business location ids to duplicate the menu to.
870
+ * Menu IDs that failed to restore.
869
871
  * @format GUID
870
872
  * @maxSize 100
871
873
  */
872
- businessLocationIds?: string[] | null;
873
- /** Indicates whether sub-entities (such as items) should be duplicated as well. */
874
- duplicateSubEntities?: boolean | null;
874
+ failedMenuIds?: string[];
875
+ }
876
+ interface RunMenusMultiLocationMigrationRequest {
875
877
  /**
876
- * The new name of the duplicated menu.
877
- * @maxLength 500
878
+ * business location id
879
+ * @format GUID
878
880
  */
879
- menuName?: string | null;
881
+ businessLocationId?: string;
880
882
  }
881
- interface DuplicateMenuResponse {
883
+ interface RunMenusMultiLocationMigrationResponse {
884
+ /** Whether menus multi-location migration finished successfully */
885
+ success?: boolean;
886
+ }
887
+ interface UpdateBusinessLocationIdRequest {
882
888
  /** @format GUID */
883
- menuIds?: string[];
889
+ menuId?: string;
890
+ /** @format GUID */
891
+ businessLocationId?: string | null;
884
892
  }
885
- interface GetMenuSiteUrlRequest {
893
+ interface UpdateBusinessLocationIdResponse {
894
+ }
895
+ interface CloneMenusRequest {
886
896
  /**
887
- * Menu ID.
897
+ * The MetaSiteId to clone from.
888
898
  * @format GUID
889
- * @readonly
890
899
  */
891
- _id: string | null;
900
+ metaSiteId?: string;
892
901
  }
893
- interface GetMenuSiteUrlResponse {
894
- /** Retrieved menuInfo with path url. */
895
- menuSiteUrl?: MenuSiteUrl;
902
+ interface CloneMenusResponse {
896
903
  }
897
- interface MenuSiteUrl {
904
+ interface Empty {
905
+ }
906
+ interface SyncContentToMultilingualRequest {
898
907
  /**
899
- * Path URL.
900
- * @minLength 1
901
- * @maxLength 1000
908
+ * MetaSite ID
909
+ * @format GUID
902
910
  */
903
- path?: string;
904
- }
905
- interface QueryMenusSiteUrlRequest {
906
- /** Query options */
907
- query?: CursorQuery;
911
+ metaSiteId?: string;
908
912
  }
909
- interface QueryMenusSiteUrlResponse {
910
- /** Retrieved menuInfos with path urls. */
911
- menuSiteUrls?: MenuSiteUrl[];
912
- /** The metadata of the paginated results. */
913
- pagingMetadata?: CursorPagingMetadata;
913
+ interface SyncContentToMultilingualResponse {
914
914
  }
915
915
  interface BaseEventMetadata {
916
916
  /**
@@ -967,6 +967,21 @@ interface AccountInfoMetadata {
967
967
  /** ID of the parent Wix account. Only included when 'accountId' belongs to a child account. */
968
968
  parentAccountId?: string;
969
969
  }
970
+ interface MenuUpdatedEnvelope {
971
+ entity: Menu;
972
+ metadata: EventMetadata;
973
+ /** @hidden */
974
+ modifiedFields: Record<string, any>;
975
+ }
976
+ /** @permissionScope Manage Restaurants - all permissions
977
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
978
+ * @permissionId RESTAURANTS.MENU_READ
979
+ * @webhook
980
+ * @eventType wix.restaurants.menus.v1.menu_updated
981
+ * @slug updated
982
+ * @documentationMaturity preview
983
+ */
984
+ declare function onMenuUpdated(handler: (event: MenuUpdatedEnvelope) => void | Promise<void>): void;
970
985
  interface MenuCreatedEnvelope {
971
986
  entity: Menu;
972
987
  metadata: EventMetadata;
@@ -996,21 +1011,54 @@ interface MenuDeletedEnvelope {
996
1011
  * @documentationMaturity preview
997
1012
  */
998
1013
  declare function onMenuDeleted(handler: (event: MenuDeletedEnvelope) => void | Promise<void>): void;
999
- interface MenuUpdatedEnvelope {
1000
- entity: Menu;
1001
- metadata: EventMetadata;
1002
- /** @hidden */
1003
- modifiedFields: Record<string, any>;
1014
+ /** @param _id - Menu id to be duplicated.
1015
+ * @public
1016
+ * @documentationMaturity preview
1017
+ * @requiredField _id
1018
+ * @permissionId RESTAURANTS.MENU_CREATE
1019
+ * @applicableIdentity APP
1020
+ * @fqn com.wixpress.restaurants.menus_menu.v1.restaurants_duplicate_menu.RestaurantsDuplicateMenu.DuplicateMenu
1021
+ */
1022
+ declare function duplicateMenu(_id: string, options?: DuplicateMenuOptions): Promise<NonNullablePaths<DuplicateMenuResponse, `menuIds`, 0>>;
1023
+ interface DuplicateMenuOptions {
1024
+ /**
1025
+ * Business location ids to duplicate the menu to.
1026
+ * @format GUID
1027
+ * @maxSize 100
1028
+ */
1029
+ businessLocationIds?: string[] | null;
1030
+ /** Indicates whether sub-entities (such as items) should be duplicated as well. */
1031
+ duplicateSubEntities?: boolean | null;
1032
+ /**
1033
+ * The new name of the duplicated menu.
1034
+ * @maxLength 500
1035
+ */
1036
+ menuName?: string | null;
1004
1037
  }
1005
- /** @permissionScope Manage Restaurants - all permissions
1006
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1038
+ /**
1039
+ * Get menu details and path URL by menu ID.
1040
+ * @param _id - Menu ID.
1041
+ * @public
1042
+ * @documentationMaturity preview
1043
+ * @requiredField _id
1007
1044
  * @permissionId RESTAURANTS.MENU_READ
1008
- * @webhook
1009
- * @eventType wix.restaurants.menus.v1.menu_updated
1010
- * @slug updated
1045
+ * @applicableIdentity APP
1046
+ * @fqn com.wixpress.restaurants.menus_menu.v1.restaurants_menus_site_url.RestaurantsMenusSiteUrl.GetMenuSiteUrl
1047
+ */
1048
+ declare function getMenuSiteUrl(_id: string): Promise<NonNullablePaths<GetMenuSiteUrlResponse, `menuSiteUrl.path`, 1>>;
1049
+ /**
1050
+ * Query menu details and path URL
1051
+ * @public
1011
1052
  * @documentationMaturity preview
1053
+ * @permissionId RESTAURANTS.MENU_READ
1054
+ * @applicableIdentity APP
1055
+ * @fqn com.wixpress.restaurants.menus_menu.v1.restaurants_menus_site_url.RestaurantsMenusSiteUrl.QueryMenusSiteUrl
1012
1056
  */
1013
- declare function onMenuUpdated(handler: (event: MenuUpdatedEnvelope) => void | Promise<void>): void;
1057
+ declare function queryMenusSiteUrl(options?: QueryMenusSiteUrlOptions): Promise<NonNullablePaths<QueryMenusSiteUrlResponse, `menuSiteUrls` | `menuSiteUrls.${number}.path`, 2>>;
1058
+ interface QueryMenusSiteUrlOptions {
1059
+ /** Query options */
1060
+ query?: CursorQuery;
1061
+ }
1014
1062
  /**
1015
1063
  * > **Note:** The Menus API only works with the Wix Restaurants Menus app. Make sure you have installed this app from the [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).
1016
1064
  *
@@ -1428,53 +1476,5 @@ interface UpdateExtendedFieldsOptions {
1428
1476
  * @fqn com.wixpress.restaurants.menus_menu.v1.RestaurantsMenusMenu.DeleteMenu
1429
1477
  */
1430
1478
  declare function deleteMenu(menuId: string): Promise<void>;
1431
- /** @param _id - Menu id to be duplicated.
1432
- * @public
1433
- * @documentationMaturity preview
1434
- * @requiredField _id
1435
- * @permissionId RESTAURANTS.MENU_CREATE
1436
- * @applicableIdentity APP
1437
- * @fqn com.wixpress.restaurants.menus_menu.v1.restaurants_duplicate_menu.RestaurantsDuplicateMenu.DuplicateMenu
1438
- */
1439
- declare function duplicateMenu(_id: string, options?: DuplicateMenuOptions): Promise<NonNullablePaths<DuplicateMenuResponse, `menuIds`, 0>>;
1440
- interface DuplicateMenuOptions {
1441
- /**
1442
- * Business location ids to duplicate the menu to.
1443
- * @format GUID
1444
- * @maxSize 100
1445
- */
1446
- businessLocationIds?: string[] | null;
1447
- /** Indicates whether sub-entities (such as items) should be duplicated as well. */
1448
- duplicateSubEntities?: boolean | null;
1449
- /**
1450
- * The new name of the duplicated menu.
1451
- * @maxLength 500
1452
- */
1453
- menuName?: string | null;
1454
- }
1455
- /**
1456
- * Get menu details and path URL by menu ID.
1457
- * @param _id - Menu ID.
1458
- * @public
1459
- * @documentationMaturity preview
1460
- * @requiredField _id
1461
- * @permissionId RESTAURANTS.MENU_READ
1462
- * @applicableIdentity APP
1463
- * @fqn com.wixpress.restaurants.menus_menu.v1.restaurants_menus_site_url.RestaurantsMenusSiteUrl.GetMenuSiteUrl
1464
- */
1465
- declare function getMenuSiteUrl(_id: string): Promise<NonNullablePaths<GetMenuSiteUrlResponse, `menuSiteUrl.path`, 1>>;
1466
- /**
1467
- * Query menu details and path URL
1468
- * @public
1469
- * @documentationMaturity preview
1470
- * @permissionId RESTAURANTS.MENU_READ
1471
- * @applicableIdentity APP
1472
- * @fqn com.wixpress.restaurants.menus_menu.v1.restaurants_menus_site_url.RestaurantsMenusSiteUrl.QueryMenusSiteUrl
1473
- */
1474
- declare function queryMenusSiteUrl(options?: QueryMenusSiteUrlOptions): Promise<NonNullablePaths<QueryMenusSiteUrlResponse, `menuSiteUrls` | `menuSiteUrls.${number}.path`, 2>>;
1475
- interface QueryMenusSiteUrlOptions {
1476
- /** Query options */
1477
- query?: CursorQuery;
1478
- }
1479
1479
 
1480
1480
  export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, type AddressLocation, type App, type ApplicationError, type BaseEventMetadata, type BulkActionMetadata, type BulkCreateMenuResult, type BulkCreateMenusOptions, type BulkCreateMenusRequest, type BulkCreateMenusResponse, type BulkMenuResult, type BulkUpdateMenuOptions, type BulkUpdateMenuRequest, type BulkUpdateMenuResponse, type BusinessLocationDetails, type CloneMenusRequest, type CloneMenusResponse, type CommonQueryWithEntityContext, type CreateMenuRequest, type CreateMenuResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type CustomTag, type DeleteMenuRequest, type DeleteMenuResponse, type DeleteOrphanSections, type DomainEvent, type DomainEventBodyOneOf, type DuplicateMenuOptions, type DuplicateMenuRequest, type DuplicateMenuResponse, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExtendedFields, type ExternalReferenceInfo, type File, type GetMenuRequest, type GetMenuResponse, type GetMenuSiteUrlRequest, type GetMenuSiteUrlResponse, type IdentificationData, type IdentificationDataIdOneOf, type InvalidateCache, type InvalidateCacheGetByOneOf, type ItemMetadata, type Keyword, type ListMenusOptions, type ListMenusRequest, type ListMenusResponse, type MaskedMenu, type Menu, type MenuCreatedEnvelope, type MenuDeletedEnvelope, type MenuQuery, type MenuQuerySpec, type MenuSiteUrl, type MenuUpdatedEnvelope, type MenusDataCloningCompleted, type MenusQueryBuilder, type MenusQueryResult, type MessageEnvelope, type Page, type Pages, type QueryMenusRequest, type QueryMenusResponse, type QueryMenusSiteUrlOptions, type QueryMenusSiteUrlRequest, type QueryMenusSiteUrlResponse, type RestoreInfo, type RestoreMenusFromTrashRequest, type RestoreMenusFromTrashResponse, type RunMenusMultiLocationMigrationRequest, type RunMenusMultiLocationMigrationResponse, type SeoSchema, type Settings, SortOrder, type SortOrderWithLiterals, type Sorting, type SyncContentToMultilingualRequest, type SyncContentToMultilingualResponse, type Tag, type URI, type URIs, type UpdateBusinessLocationIdRequest, type UpdateBusinessLocationIdResponse, type UpdateExtendedFieldsOptions, type UpdateExtendedFieldsRequest, type UpdateExtendedFieldsResponse, type UpdateMenu, type UpdateMenuRequest, type UpdateMenuResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, bulkCreateMenus, bulkUpdateMenu, createMenu, deleteMenu, duplicateMenu, getMenu, getMenuSiteUrl, listMenus, onMenuCreated, onMenuDeleted, onMenuUpdated, queryMenus, queryMenusSiteUrl, typedQueryMenus, updateExtendedFields, updateMenu, utils };