@wix/auto_sdk_restaurants_menus 1.0.97 → 1.0.98

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.
@@ -283,6 +283,405 @@ interface ExternalReferenceInfo {
283
283
  /** Whether the connection to the external system is currently active. */
284
284
  connected?: boolean | null;
285
285
  }
286
+ interface QueryMenuExportRowsRequest {
287
+ /**
288
+ * Filter: `{"menuId": "<GUID>"}` or `{"menuId": {"$eq": "<GUID>"}}`, required on the first page; a later page may omit
289
+ * it, and if it sends it, it must name the cursor's menu. Cursor paging only, at most 500 rows
290
+ * per page (default 100); a sort fails with `INVALID_MENU_EXPORT_QUERY`. This is the same wire format as the fed-infra
291
+ * export service's `ExportQueryV2`: filter 1, sort 2, cursor paging 6.
292
+ */
293
+ query?: CursorQuery;
294
+ }
295
+ interface CursorQuery extends CursorQueryPagingMethodOneOf {
296
+ /** 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`. */
297
+ cursorPaging?: CursorPaging;
298
+ /**
299
+ * Filter object in the following format:
300
+ * `"filter" : {
301
+ * "fieldName1": "value1",
302
+ * "fieldName2":{"$operator":"value2"}
303
+ * }`
304
+ * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
305
+ */
306
+ filter?: Record<string, any> | null;
307
+ /**
308
+ * Sort object in the following format:
309
+ * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
310
+ */
311
+ sort?: Sorting[];
312
+ }
313
+ /** @oneof */
314
+ interface CursorQueryPagingMethodOneOf {
315
+ /** 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`. */
316
+ cursorPaging?: CursorPaging;
317
+ }
318
+ interface Sorting {
319
+ /**
320
+ * Name of the field to sort by.
321
+ * @maxLength 512
322
+ */
323
+ fieldName?: string;
324
+ /** Sort order. */
325
+ order?: SortOrderWithLiterals;
326
+ /**
327
+ * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
328
+ * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
329
+ *
330
+ * If multiple filters are provided, they are combined with AND operator.
331
+ *
332
+ * Example:
333
+ * Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
334
+ * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
335
+ * { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
336
+ * @internal
337
+ * @maxSize 10
338
+ */
339
+ selectItemsBy?: Record<string, any>[] | null;
340
+ /**
341
+ * Origin point for geo-distance sorting on a GEO field
342
+ * results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
343
+ */
344
+ origin?: AddressLocation;
345
+ }
346
+ declare enum SortOrder {
347
+ ASC = "ASC",
348
+ DESC = "DESC"
349
+ }
350
+ /** @enumType */
351
+ type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
352
+ interface AddressLocation {
353
+ /** Address latitude. */
354
+ latitude?: number | null;
355
+ /** Address longitude. */
356
+ longitude?: number | null;
357
+ }
358
+ interface CursorPaging {
359
+ /**
360
+ * Number of items to load.
361
+ * @max 500
362
+ */
363
+ limit?: number | null;
364
+ /**
365
+ * Pointer to the next or previous page in the list of results.
366
+ *
367
+ * You can get the relevant cursor token
368
+ * from the `pagingMetadata` object in the previous call's response.
369
+ * Not relevant for the first request.
370
+ */
371
+ cursor?: string | null;
372
+ }
373
+ interface QueryMenuExportRowsResponse {
374
+ /** The page's rows, in file order. */
375
+ menuExportRows?: MenuExportRow[];
376
+ /** Paging metadata: `cursors.next` is set while rows remain. */
377
+ pagingMetadata?: CursorPagingMetadata;
378
+ }
379
+ /**
380
+ * One CSV row. Every field is text exactly as written to the file (design-log/001 Q5); unused columns are empty.
381
+ * Free-text limits are the source field's product limit plus one, for the `'` the formula guard can add; `labels` allows
382
+ * 10 names of 50, each doubled at most by escaping, 9 separators and the guard. The other limits bound fixed values.
383
+ */
384
+ interface MenuExportRow {
385
+ /**
386
+ * `section`, `item`, `variant`, `modifier_group` or `modifier`.
387
+ * @maxLength 20
388
+ */
389
+ type?: string;
390
+ /**
391
+ * Name of the row's section.
392
+ * @maxLength 501
393
+ */
394
+ sectionName?: string;
395
+ /**
396
+ * Section description, on section rows.
397
+ * @maxLength 1501
398
+ */
399
+ sectionDescription?: string;
400
+ /**
401
+ * Item name, on item, variant, modifier group and modifier rows.
402
+ * @maxLength 201
403
+ */
404
+ itemName?: string;
405
+ /**
406
+ * Item description, on item rows.
407
+ * @maxLength 1501
408
+ */
409
+ itemDescription?: string;
410
+ /**
411
+ * Price with 2 or 3 decimals, for example `8.50` (a legacy price stored with more decimals is written as stored). On item rows: `MARKET_PRICE` for a market-price item, empty for an
412
+ * item priced by variants, `0.00` for an item without a stored price. On variant and modifier rows: `0.00` without a
413
+ * price or charge. Empty on section and modifier group rows.
414
+ * @maxLength 50
415
+ */
416
+ price?: string;
417
+ /**
418
+ * The site's payment currency on item, variant and modifier rows. The importer doesn't read it: an imported menu takes
419
+ * the target site's currency.
420
+ * @maxLength 10
421
+ */
422
+ currency?: string;
423
+ /**
424
+ * The item's label names, `;`-separated, each exactly as the site names it, with `\` and `;` inside a name escaped
425
+ * as `\\` and `\;`.
426
+ * @maxLength 1010
427
+ */
428
+ labels?: string;
429
+ /**
430
+ * Modifier group name, on modifier group and modifier rows.
431
+ * @maxLength 101
432
+ */
433
+ modifierGroupName?: string;
434
+ /**
435
+ * `yes` or `no`, on modifier group rows.
436
+ * @maxLength 3
437
+ */
438
+ modifierRequired?: string;
439
+ /**
440
+ * Minimum selections, on modifier group rows.
441
+ * @maxLength 20
442
+ */
443
+ modifierMinSelections?: string;
444
+ /**
445
+ * Maximum selections (`0` is unlimited), on modifier group rows.
446
+ * @maxLength 20
447
+ */
448
+ modifierMaxSelections?: string;
449
+ /**
450
+ * Modifier name, on modifier rows.
451
+ * @maxLength 201
452
+ */
453
+ modifierName?: string;
454
+ /**
455
+ * `yes` or `no`, on modifier rows.
456
+ * @maxLength 3
457
+ */
458
+ modifierPreSelected?: string;
459
+ /**
460
+ * Variant name, on variant rows.
461
+ * @maxLength 201
462
+ */
463
+ variantName?: string;
464
+ /**
465
+ * `yes` or `no` on section and item rows.
466
+ * @maxLength 3
467
+ */
468
+ visible?: string;
469
+ }
470
+ interface CursorPagingMetadata {
471
+ /** Number of items returned in the response. */
472
+ count?: number | null;
473
+ /** Offset that was requested. */
474
+ cursors?: Cursors;
475
+ /**
476
+ * Indicates if there are more results after the current page.
477
+ * If `true`, another page of results can be retrieved.
478
+ * If `false`, this is the last page.
479
+ */
480
+ hasNext?: boolean | null;
481
+ }
482
+ interface Cursors {
483
+ /** Cursor pointing to next page in the list of results. */
484
+ next?: string | null;
485
+ /** Cursor pointing to previous page in the list of results. */
486
+ prev?: string | null;
487
+ }
488
+ interface DomainEvent extends DomainEventBodyOneOf {
489
+ createdEvent?: EntityCreatedEvent;
490
+ updatedEvent?: EntityUpdatedEvent;
491
+ deletedEvent?: EntityDeletedEvent;
492
+ actionEvent?: ActionEvent;
493
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
494
+ id?: string;
495
+ /**
496
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
497
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
498
+ */
499
+ entityFqdn?: string;
500
+ /**
501
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
502
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
503
+ */
504
+ slug?: string;
505
+ /** ID of the entity associated with the event. */
506
+ entityId?: string;
507
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
508
+ eventTime?: Date | null;
509
+ /**
510
+ * Whether the event was triggered as a result of a privacy regulation application
511
+ * (for example, GDPR).
512
+ */
513
+ triggeredByAnonymizeRequest?: boolean | null;
514
+ /** If present, indicates the action that triggered the event. */
515
+ originatedFrom?: string | null;
516
+ /**
517
+ * 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.
518
+ * 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.
519
+ */
520
+ entityEventSequence?: string | null;
521
+ }
522
+ /** @oneof */
523
+ interface DomainEventBodyOneOf {
524
+ createdEvent?: EntityCreatedEvent;
525
+ updatedEvent?: EntityUpdatedEvent;
526
+ deletedEvent?: EntityDeletedEvent;
527
+ actionEvent?: ActionEvent;
528
+ }
529
+ interface EntityCreatedEvent {
530
+ entityAsJson?: string;
531
+ /**
532
+ * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity
533
+ * @internal
534
+ */
535
+ triggeredByUndelete?: boolean | null;
536
+ /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
537
+ restoreInfo?: RestoreInfo;
538
+ /**
539
+ * Optional domain-specific metadata defined by the API owner, encoded as JSON.
540
+ * @internal
541
+ */
542
+ additionalMetadataAsJson?: string | null;
543
+ }
544
+ interface RestoreInfo {
545
+ deletedDate?: Date | null;
546
+ }
547
+ interface EntityUpdatedEvent {
548
+ /**
549
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
550
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
551
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
552
+ */
553
+ currentEntityAsJson?: string;
554
+ /**
555
+ * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard
556
+ * wont populate it / have any reference to it in the API.
557
+ * 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,
558
+ * the developer should send only the new (current) entity.
559
+ * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big
560
+ * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.
561
+ * @internal
562
+ * @deprecated
563
+ */
564
+ previousEntityAsJson?: string | null;
565
+ /**
566
+ * Map of fully qualified field paths to their previous values for fields that changed.
567
+ * 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)
568
+ * @internal
569
+ */
570
+ modifiedFields?: Record<string, any>;
571
+ /**
572
+ * Optional domain-specific metadata defined by the API owner, encoded as JSON.
573
+ * @internal
574
+ */
575
+ additionalMetadataAsJson?: string | null;
576
+ }
577
+ interface EntityDeletedEvent {
578
+ /**
579
+ * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled
580
+ * @internal
581
+ */
582
+ movedToTrash?: boolean | null;
583
+ /** Entity that was deleted. */
584
+ deletedEntityAsJson?: string | null;
585
+ /**
586
+ * Optional domain-specific metadata defined by the API owner, encoded as JSON.
587
+ * @internal
588
+ */
589
+ additionalMetadataAsJson?: string | null;
590
+ }
591
+ interface ActionEvent {
592
+ bodyAsJson?: string;
593
+ }
594
+ interface MessageEnvelope {
595
+ /**
596
+ * App instance ID.
597
+ * @format GUID
598
+ */
599
+ instanceId?: string | null;
600
+ /**
601
+ * Event type.
602
+ * @maxLength 150
603
+ */
604
+ eventType?: string;
605
+ /** The identification type and identity data. */
606
+ identity?: IdentificationData;
607
+ /** Stringify payload. */
608
+ data?: string;
609
+ /** Details related to the account */
610
+ accountInfo?: AccountInfo;
611
+ }
612
+ interface IdentificationData extends IdentificationDataIdOneOf {
613
+ /**
614
+ * ID of a site visitor that has not logged in to the site.
615
+ * @format GUID
616
+ */
617
+ anonymousVisitorId?: string;
618
+ /**
619
+ * ID of a site visitor that has logged in to the site.
620
+ * @format GUID
621
+ */
622
+ memberId?: string;
623
+ /**
624
+ * ID of a Wix user (site owner, contributor, etc.).
625
+ * @format GUID
626
+ */
627
+ wixUserId?: string;
628
+ /**
629
+ * ID of an app.
630
+ * @format GUID
631
+ */
632
+ appId?: string;
633
+ /** @readonly */
634
+ identityType?: WebhookIdentityTypeWithLiterals;
635
+ }
636
+ /** @oneof */
637
+ interface IdentificationDataIdOneOf {
638
+ /**
639
+ * ID of a site visitor that has not logged in to the site.
640
+ * @format GUID
641
+ */
642
+ anonymousVisitorId?: string;
643
+ /**
644
+ * ID of a site visitor that has logged in to the site.
645
+ * @format GUID
646
+ */
647
+ memberId?: string;
648
+ /**
649
+ * ID of a Wix user (site owner, contributor, etc.).
650
+ * @format GUID
651
+ */
652
+ wixUserId?: string;
653
+ /**
654
+ * ID of an app.
655
+ * @format GUID
656
+ */
657
+ appId?: string;
658
+ }
659
+ declare enum WebhookIdentityType {
660
+ UNKNOWN = "UNKNOWN",
661
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
662
+ MEMBER = "MEMBER",
663
+ WIX_USER = "WIX_USER",
664
+ APP = "APP"
665
+ }
666
+ /** @enumType */
667
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
668
+ interface AccountInfo {
669
+ /**
670
+ * ID of the Wix account associated with the event.
671
+ * @format GUID
672
+ */
673
+ accountId?: string | null;
674
+ /**
675
+ * ID of the parent Wix account. Only included when accountId belongs to a child account.
676
+ * @format GUID
677
+ */
678
+ parentAccountId?: string | null;
679
+ /**
680
+ * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
681
+ * @format GUID
682
+ */
683
+ siteId?: string | null;
684
+ }
286
685
  interface InvalidateCache extends InvalidateCacheGetByOneOf {
287
686
  /**
288
687
  * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
@@ -501,134 +900,38 @@ interface BulkActionMetadata {
501
900
  /** Number of failures without details because detailed failure threshold was exceeded. */
502
901
  undetailedFailures?: number;
503
902
  }
504
- interface GetMenuRequest {
505
- /**
506
- * Menu ID.
507
- * @format GUID
508
- */
509
- menuId: string;
510
- }
511
- interface GetMenuResponse {
512
- /** Menu. */
513
- menu?: Menu;
514
- }
515
- interface ListMenusRequest {
516
- /**
517
- * Menu IDs.
518
- * @format GUID
519
- * @maxSize 500
520
- */
521
- menuIds?: string[];
522
- /** The metadata of the paginated results. */
523
- paging?: CursorPaging;
524
- /** Whether to return only menus that are visible to site visitors. */
525
- onlyVisible?: boolean | null;
526
- }
527
- interface CursorPaging {
528
- /**
529
- * Number of items to load.
530
- * @max 500
531
- */
532
- limit?: number | null;
533
- /**
534
- * Pointer to the next or previous page in the list of results.
535
- *
536
- * You can get the relevant cursor token
537
- * from the `pagingMetadata` object in the previous call's response.
538
- * Not relevant for the first request.
539
- */
540
- cursor?: string | null;
541
- }
542
- interface ListMenusResponse {
543
- /** Retrieved menus. */
544
- menus?: Menu[];
545
- /** The metadata of the paginated results. */
546
- pagingMetadata?: CursorPagingMetadata;
547
- }
548
- interface CursorPagingMetadata {
549
- /** Number of items returned in the response. */
550
- count?: number | null;
551
- /** Offset that was requested. */
552
- cursors?: Cursors;
553
- /**
554
- * Indicates if there are more results after the current page.
555
- * If `true`, another page of results can be retrieved.
556
- * If `false`, this is the last page.
557
- */
558
- hasNext?: boolean | null;
559
- }
560
- interface Cursors {
561
- /** Cursor pointing to next page in the list of results. */
562
- next?: string | null;
563
- /** Cursor pointing to previous page in the list of results. */
564
- prev?: string | null;
565
- }
566
- interface QueryMenusRequest {
567
- /** Query options. */
568
- query?: CursorQuery;
569
- }
570
- interface CursorQuery extends CursorQueryPagingMethodOneOf {
571
- /** 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`. */
572
- cursorPaging?: CursorPaging;
573
- /**
574
- * Filter object in the following format:
575
- * `"filter" : {
576
- * "fieldName1": "value1",
577
- * "fieldName2":{"$operator":"value2"}
578
- * }`
579
- * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
580
- */
581
- filter?: Record<string, any> | null;
582
- /**
583
- * Sort object in the following format:
584
- * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
585
- */
586
- sort?: Sorting[];
587
- }
588
- /** @oneof */
589
- interface CursorQueryPagingMethodOneOf {
590
- /** 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`. */
591
- cursorPaging?: CursorPaging;
592
- }
593
- interface Sorting {
594
- /**
595
- * Name of the field to sort by.
596
- * @maxLength 512
597
- */
598
- fieldName?: string;
599
- /** Sort order. */
600
- order?: SortOrderWithLiterals;
903
+ interface GetMenuRequest {
601
904
  /**
602
- * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
603
- * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
604
- *
605
- * If multiple filters are provided, they are combined with AND operator.
606
- *
607
- * Example:
608
- * Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
609
- * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
610
- * { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
611
- * @internal
612
- * @maxSize 10
905
+ * Menu ID.
906
+ * @format GUID
613
907
  */
614
- selectItemsBy?: Record<string, any>[] | null;
908
+ menuId: string;
909
+ }
910
+ interface GetMenuResponse {
911
+ /** Menu. */
912
+ menu?: Menu;
913
+ }
914
+ interface ListMenusRequest {
615
915
  /**
616
- * Origin point for geo-distance sorting on a GEO field
617
- * results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
916
+ * Menu IDs.
917
+ * @format GUID
918
+ * @maxSize 500
618
919
  */
619
- origin?: AddressLocation;
920
+ menuIds?: string[];
921
+ /** The metadata of the paginated results. */
922
+ paging?: CursorPaging;
923
+ /** Whether to return only menus that are visible to site visitors. */
924
+ onlyVisible?: boolean | null;
620
925
  }
621
- declare enum SortOrder {
622
- ASC = "ASC",
623
- DESC = "DESC"
926
+ interface ListMenusResponse {
927
+ /** Retrieved menus. */
928
+ menus?: Menu[];
929
+ /** The metadata of the paginated results. */
930
+ pagingMetadata?: CursorPagingMetadata;
624
931
  }
625
- /** @enumType */
626
- type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
627
- interface AddressLocation {
628
- /** Address latitude. */
629
- latitude?: number | null;
630
- /** Address longitude. */
631
- longitude?: number | null;
932
+ interface QueryMenusRequest {
933
+ /** Query options. */
934
+ query?: CursorQuery;
632
935
  }
633
936
  interface QueryMenusResponse {
634
937
  /** Retrieved menus. */
@@ -732,112 +1035,6 @@ interface CloneMenusRequest {
732
1035
  }
733
1036
  interface CloneMenusResponse {
734
1037
  }
735
- interface DomainEvent extends DomainEventBodyOneOf {
736
- createdEvent?: EntityCreatedEvent;
737
- updatedEvent?: EntityUpdatedEvent;
738
- deletedEvent?: EntityDeletedEvent;
739
- actionEvent?: ActionEvent;
740
- /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
741
- id?: string;
742
- /**
743
- * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
744
- * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
745
- */
746
- entityFqdn?: string;
747
- /**
748
- * Event action name, placed at the top level to make it easier for users to dispatch messages.
749
- * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
750
- */
751
- slug?: string;
752
- /** ID of the entity associated with the event. */
753
- entityId?: string;
754
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
755
- eventTime?: Date | null;
756
- /**
757
- * Whether the event was triggered as a result of a privacy regulation application
758
- * (for example, GDPR).
759
- */
760
- triggeredByAnonymizeRequest?: boolean | null;
761
- /** If present, indicates the action that triggered the event. */
762
- originatedFrom?: string | null;
763
- /**
764
- * 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.
765
- * 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.
766
- */
767
- entityEventSequence?: string | null;
768
- }
769
- /** @oneof */
770
- interface DomainEventBodyOneOf {
771
- createdEvent?: EntityCreatedEvent;
772
- updatedEvent?: EntityUpdatedEvent;
773
- deletedEvent?: EntityDeletedEvent;
774
- actionEvent?: ActionEvent;
775
- }
776
- interface EntityCreatedEvent {
777
- entityAsJson?: string;
778
- /**
779
- * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity
780
- * @internal
781
- */
782
- triggeredByUndelete?: boolean | null;
783
- /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
784
- restoreInfo?: RestoreInfo;
785
- /**
786
- * Optional domain-specific metadata defined by the API owner, encoded as JSON.
787
- * @internal
788
- */
789
- additionalMetadataAsJson?: string | null;
790
- }
791
- interface RestoreInfo {
792
- deletedDate?: Date | null;
793
- }
794
- interface EntityUpdatedEvent {
795
- /**
796
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
797
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
798
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
799
- */
800
- currentEntityAsJson?: string;
801
- /**
802
- * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard
803
- * wont populate it / have any reference to it in the API.
804
- * 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,
805
- * the developer should send only the new (current) entity.
806
- * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big
807
- * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.
808
- * @internal
809
- * @deprecated
810
- */
811
- previousEntityAsJson?: string | null;
812
- /**
813
- * Map of fully qualified field paths to their previous values for fields that changed.
814
- * 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)
815
- * @internal
816
- */
817
- modifiedFields?: Record<string, any>;
818
- /**
819
- * Optional domain-specific metadata defined by the API owner, encoded as JSON.
820
- * @internal
821
- */
822
- additionalMetadataAsJson?: string | null;
823
- }
824
- interface EntityDeletedEvent {
825
- /**
826
- * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled
827
- * @internal
828
- */
829
- movedToTrash?: boolean | null;
830
- /** Entity that was deleted. */
831
- deletedEntityAsJson?: string | null;
832
- /**
833
- * Optional domain-specific metadata defined by the API owner, encoded as JSON.
834
- * @internal
835
- */
836
- additionalMetadataAsJson?: string | null;
837
- }
838
- interface ActionEvent {
839
- bodyAsJson?: string;
840
- }
841
1038
  interface Empty {
842
1039
  }
843
1040
  interface SyncContentToMultilingualRequest {
@@ -849,97 +1046,6 @@ interface SyncContentToMultilingualRequest {
849
1046
  }
850
1047
  interface SyncContentToMultilingualResponse {
851
1048
  }
852
- interface MessageEnvelope {
853
- /**
854
- * App instance ID.
855
- * @format GUID
856
- */
857
- instanceId?: string | null;
858
- /**
859
- * Event type.
860
- * @maxLength 150
861
- */
862
- eventType?: string;
863
- /** The identification type and identity data. */
864
- identity?: IdentificationData;
865
- /** Stringify payload. */
866
- data?: string;
867
- /** Details related to the account */
868
- accountInfo?: AccountInfo;
869
- }
870
- interface IdentificationData extends IdentificationDataIdOneOf {
871
- /**
872
- * ID of a site visitor that has not logged in to the site.
873
- * @format GUID
874
- */
875
- anonymousVisitorId?: string;
876
- /**
877
- * ID of a site visitor that has logged in to the site.
878
- * @format GUID
879
- */
880
- memberId?: string;
881
- /**
882
- * ID of a Wix user (site owner, contributor, etc.).
883
- * @format GUID
884
- */
885
- wixUserId?: string;
886
- /**
887
- * ID of an app.
888
- * @format GUID
889
- */
890
- appId?: string;
891
- /** @readonly */
892
- identityType?: WebhookIdentityTypeWithLiterals;
893
- }
894
- /** @oneof */
895
- interface IdentificationDataIdOneOf {
896
- /**
897
- * ID of a site visitor that has not logged in to the site.
898
- * @format GUID
899
- */
900
- anonymousVisitorId?: string;
901
- /**
902
- * ID of a site visitor that has logged in to the site.
903
- * @format GUID
904
- */
905
- memberId?: string;
906
- /**
907
- * ID of a Wix user (site owner, contributor, etc.).
908
- * @format GUID
909
- */
910
- wixUserId?: string;
911
- /**
912
- * ID of an app.
913
- * @format GUID
914
- */
915
- appId?: string;
916
- }
917
- declare enum WebhookIdentityType {
918
- UNKNOWN = "UNKNOWN",
919
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
920
- MEMBER = "MEMBER",
921
- WIX_USER = "WIX_USER",
922
- APP = "APP"
923
- }
924
- /** @enumType */
925
- type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
926
- interface AccountInfo {
927
- /**
928
- * ID of the Wix account associated with the event.
929
- * @format GUID
930
- */
931
- accountId?: string | null;
932
- /**
933
- * ID of the parent Wix account. Only included when accountId belongs to a child account.
934
- * @format GUID
935
- */
936
- parentAccountId?: string | null;
937
- /**
938
- * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
939
- * @format GUID
940
- */
941
- siteId?: string | null;
942
- }
943
1049
  interface DuplicateMenuRequest {
944
1050
  /**
945
1051
  * Menu id to be duplicated.
@@ -1030,4 +1136,4 @@ declare function getMenuSiteUrl(): __PublicMethodMetaInfo<'GET', {
1030
1136
  }, GetMenuSiteUrlRequest$1, GetMenuSiteUrlRequest, GetMenuSiteUrlResponse$1, GetMenuSiteUrlResponse>;
1031
1137
  declare function queryMenusSiteUrl(): __PublicMethodMetaInfo<'POST', {}, QueryMenusSiteUrlRequest$1, QueryMenusSiteUrlRequest, QueryMenusSiteUrlResponse$1, QueryMenusSiteUrlResponse>;
1032
1138
 
1033
- 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 };
1139
+ 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 MenuExportRow as MenuExportRowOriginal, 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 QueryMenuExportRowsRequest as QueryMenuExportRowsRequestOriginal, type QueryMenuExportRowsResponse as QueryMenuExportRowsResponseOriginal, 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 };