@wix/auto_sdk_restaurants_menus 1.0.38 → 1.0.40

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.
@@ -128,6 +128,163 @@ interface Settings {
128
128
  */
129
129
  keywords?: Keyword[];
130
130
  }
131
+ interface BusinessLocationDetails {
132
+ /**
133
+ * Location name.
134
+ * @maxLength 150
135
+ * @readonly
136
+ */
137
+ name?: string | null;
138
+ /**
139
+ * Whether the location is archived.
140
+ *
141
+ * Archived locations are hidden and ignored on restaurants site pages, and marked as archived in the dashboard.
142
+ * @readonly
143
+ */
144
+ archived?: boolean | null;
145
+ /**
146
+ * Whether this location is the default location for the business.
147
+ * @readonly
148
+ */
149
+ default?: boolean | null;
150
+ }
151
+ interface ExternalReferenceInfo {
152
+ /**
153
+ * ID of the external integrator app\system associated with this object.
154
+ * @format GUID
155
+ */
156
+ externalAppId?: string | null;
157
+ /**
158
+ * Reference to an external resource ID. Used to link this object to a specific entity in an external system.
159
+ * @maxLength 100
160
+ */
161
+ externalEntityId?: string | null;
162
+ /** Last time this menu was synced with the external app. */
163
+ lastSyncDate?: Date | null;
164
+ /** Whether the connection to the external system is currently active. */
165
+ connected?: boolean | null;
166
+ }
167
+ interface InvalidateCache extends InvalidateCacheGetByOneOf {
168
+ /**
169
+ * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
170
+ * @format GUID
171
+ */
172
+ metaSiteId?: string;
173
+ /**
174
+ * Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
175
+ * @format GUID
176
+ */
177
+ siteId?: string;
178
+ /** Invalidate by App */
179
+ app?: App;
180
+ /** Invalidate by page id */
181
+ page?: Page;
182
+ /** Invalidate by URI path */
183
+ uri?: URI;
184
+ /** Invalidate by file (for media files such as PDFs) */
185
+ file?: File;
186
+ /** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */
187
+ customTag?: CustomTag;
188
+ /**
189
+ * tell us why you're invalidating the cache. You don't need to add your app name
190
+ * @maxLength 256
191
+ */
192
+ reason?: string | null;
193
+ /** Is local DS */
194
+ localDc?: boolean;
195
+ hardPurge?: boolean;
196
+ }
197
+ /** @oneof */
198
+ interface InvalidateCacheGetByOneOf {
199
+ /**
200
+ * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
201
+ * @format GUID
202
+ */
203
+ metaSiteId?: string;
204
+ /**
205
+ * Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
206
+ * @format GUID
207
+ */
208
+ siteId?: string;
209
+ /** Invalidate by App */
210
+ app?: App;
211
+ /** Invalidate by page id */
212
+ page?: Page;
213
+ /** Invalidate by URI path */
214
+ uri?: URI;
215
+ /** Invalidate by file (for media files such as PDFs) */
216
+ file?: File;
217
+ /** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */
218
+ customTag?: CustomTag;
219
+ }
220
+ interface App {
221
+ /**
222
+ * The AppDefId
223
+ * @minLength 1
224
+ */
225
+ appDefId?: string;
226
+ /**
227
+ * The instance Id
228
+ * @format GUID
229
+ */
230
+ instanceId?: string;
231
+ }
232
+ interface Page {
233
+ /**
234
+ * the msid the page is on
235
+ * @format GUID
236
+ */
237
+ metaSiteId?: string;
238
+ /**
239
+ * Invalidate by Page ID
240
+ * @minLength 1
241
+ */
242
+ pageId?: string;
243
+ }
244
+ interface URI {
245
+ /**
246
+ * the msid the URI is on
247
+ * @format GUID
248
+ */
249
+ metaSiteId?: string;
250
+ /**
251
+ * URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes
252
+ * @minLength 1
253
+ */
254
+ uriPath?: string;
255
+ }
256
+ interface File {
257
+ /**
258
+ * the msid the file is related to
259
+ * @format GUID
260
+ */
261
+ metaSiteId?: string;
262
+ /**
263
+ * Invalidate by filename (for media files such as PDFs)
264
+ * @minLength 1
265
+ * @maxLength 256
266
+ */
267
+ fileName?: string;
268
+ }
269
+ interface CustomTag {
270
+ /**
271
+ * the msid the tag is related to
272
+ * @format GUID
273
+ */
274
+ metaSiteId?: string;
275
+ /**
276
+ * Tag to invalidate by
277
+ * @minLength 1
278
+ * @maxLength 256
279
+ */
280
+ tag?: string;
281
+ }
282
+ interface DeleteOrphanSections {
283
+ /** Menu id */
284
+ menuId?: string;
285
+ }
286
+ interface MenusDataCloningCompleted {
287
+ }
131
288
  interface CreateMenuRequest {
132
289
  /** Menu details. */
133
290
  menu: Menu;
@@ -356,6 +513,181 @@ interface DeleteMenuRequest {
356
513
  }
357
514
  interface DeleteMenuResponse {
358
515
  }
516
+ interface RunMenusMultiLocationMigrationRequest {
517
+ /**
518
+ * business location id
519
+ * @format GUID
520
+ */
521
+ businessLocationId?: string;
522
+ }
523
+ interface RunMenusMultiLocationMigrationResponse {
524
+ /** Whether menus multi-location migration finished successfully */
525
+ success?: boolean;
526
+ }
527
+ interface UpdateBusinessLocationIdRequest {
528
+ /** @format GUID */
529
+ menuId?: string;
530
+ /** @format GUID */
531
+ businessLocationId?: string;
532
+ }
533
+ interface UpdateBusinessLocationIdResponse {
534
+ }
535
+ interface CloneMenusRequest {
536
+ /**
537
+ * The MetaSiteId to clone from.
538
+ * @format GUID
539
+ */
540
+ metaSiteId?: string;
541
+ }
542
+ interface CloneMenusResponse {
543
+ }
544
+ interface DomainEvent extends DomainEventBodyOneOf {
545
+ createdEvent?: EntityCreatedEvent;
546
+ updatedEvent?: EntityUpdatedEvent;
547
+ deletedEvent?: EntityDeletedEvent;
548
+ actionEvent?: ActionEvent;
549
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
550
+ id?: string;
551
+ /**
552
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
553
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
554
+ */
555
+ entityFqdn?: string;
556
+ /**
557
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
558
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
559
+ */
560
+ slug?: string;
561
+ /** ID of the entity associated with the event. */
562
+ entityId?: string;
563
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
564
+ eventTime?: Date | null;
565
+ /**
566
+ * Whether the event was triggered as a result of a privacy regulation application
567
+ * (for example, GDPR).
568
+ */
569
+ triggeredByAnonymizeRequest?: boolean | null;
570
+ /** If present, indicates the action that triggered the event. */
571
+ originatedFrom?: string | null;
572
+ /**
573
+ * 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.
574
+ * 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.
575
+ */
576
+ entityEventSequence?: string | null;
577
+ }
578
+ /** @oneof */
579
+ interface DomainEventBodyOneOf {
580
+ createdEvent?: EntityCreatedEvent;
581
+ updatedEvent?: EntityUpdatedEvent;
582
+ deletedEvent?: EntityDeletedEvent;
583
+ actionEvent?: ActionEvent;
584
+ }
585
+ interface EntityCreatedEvent {
586
+ entityAsJson?: string;
587
+ /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
588
+ restoreInfo?: RestoreInfo;
589
+ }
590
+ interface RestoreInfo {
591
+ deletedDate?: Date | null;
592
+ }
593
+ interface EntityUpdatedEvent {
594
+ /**
595
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
596
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
597
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
598
+ */
599
+ currentEntityAsJson?: string;
600
+ }
601
+ interface EntityDeletedEvent {
602
+ /** Entity that was deleted. */
603
+ deletedEntityAsJson?: string | null;
604
+ }
605
+ interface ActionEvent {
606
+ bodyAsJson?: string;
607
+ }
608
+ interface Empty {
609
+ }
610
+ interface SyncContentToMultilingualRequest {
611
+ /**
612
+ * MetaSite ID
613
+ * @format GUID
614
+ */
615
+ metaSiteId?: string;
616
+ }
617
+ interface SyncContentToMultilingualResponse {
618
+ }
619
+ interface MessageEnvelope {
620
+ /**
621
+ * App instance ID.
622
+ * @format GUID
623
+ */
624
+ instanceId?: string | null;
625
+ /**
626
+ * Event type.
627
+ * @maxLength 150
628
+ */
629
+ eventType?: string;
630
+ /** The identification type and identity data. */
631
+ identity?: IdentificationData;
632
+ /** Stringify payload. */
633
+ data?: string;
634
+ }
635
+ interface IdentificationData extends IdentificationDataIdOneOf {
636
+ /**
637
+ * ID of a site visitor that has not logged in to the site.
638
+ * @format GUID
639
+ */
640
+ anonymousVisitorId?: string;
641
+ /**
642
+ * ID of a site visitor that has logged in to the site.
643
+ * @format GUID
644
+ */
645
+ memberId?: string;
646
+ /**
647
+ * ID of a Wix user (site owner, contributor, etc.).
648
+ * @format GUID
649
+ */
650
+ wixUserId?: string;
651
+ /**
652
+ * ID of an app.
653
+ * @format GUID
654
+ */
655
+ appId?: string;
656
+ /** @readonly */
657
+ identityType?: WebhookIdentityTypeWithLiterals;
658
+ }
659
+ /** @oneof */
660
+ interface IdentificationDataIdOneOf {
661
+ /**
662
+ * ID of a site visitor that has not logged in to the site.
663
+ * @format GUID
664
+ */
665
+ anonymousVisitorId?: string;
666
+ /**
667
+ * ID of a site visitor that has logged in to the site.
668
+ * @format GUID
669
+ */
670
+ memberId?: string;
671
+ /**
672
+ * ID of a Wix user (site owner, contributor, etc.).
673
+ * @format GUID
674
+ */
675
+ wixUserId?: string;
676
+ /**
677
+ * ID of an app.
678
+ * @format GUID
679
+ */
680
+ appId?: string;
681
+ }
682
+ declare enum WebhookIdentityType {
683
+ UNKNOWN = "UNKNOWN",
684
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
685
+ MEMBER = "MEMBER",
686
+ WIX_USER = "WIX_USER",
687
+ APP = "APP"
688
+ }
689
+ /** @enumType */
690
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
359
691
  interface GetMenuSiteUrlRequest {
360
692
  /**
361
693
  * Menu ID.
@@ -446,4 +778,4 @@ declare function duplicateMenu(): __PublicMethodMetaInfo<'POST', {
446
778
  id: string;
447
779
  }, DuplicateMenuRequest$1, DuplicateMenuRequest, DuplicateMenuResponse$1, DuplicateMenuResponse>;
448
780
 
449
- export { type __PublicMethodMetaInfo, bulkCreateMenus, bulkUpdateMenu, createMenu, deleteMenu, duplicateMenu, getMenu, getMenuSiteUrl, listMenus, queryMenus, queryMenusSiteUrl, updateExtendedFields, updateMenu };
781
+ export { type ActionEvent as ActionEventOriginal, 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 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 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 };
package/build/cjs/meta.js CHANGED
@@ -20,6 +20,8 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
20
20
  // meta.ts
21
21
  var meta_exports = {};
22
22
  __export(meta_exports, {
23
+ SortOrderOriginal: () => SortOrder,
24
+ WebhookIdentityTypeOriginal: () => WebhookIdentityType,
23
25
  bulkCreateMenus: () => bulkCreateMenus2,
24
26
  bulkUpdateMenu: () => bulkUpdateMenu2,
25
27
  createMenu: () => createMenu2,
@@ -693,6 +695,21 @@ function duplicateMenu(payload) {
693
695
  return __duplicateMenu;
694
696
  }
695
697
 
698
+ // src/restaurants-menus-v1-menu-menus.types.ts
699
+ var SortOrder = /* @__PURE__ */ ((SortOrder2) => {
700
+ SortOrder2["ASC"] = "ASC";
701
+ SortOrder2["DESC"] = "DESC";
702
+ return SortOrder2;
703
+ })(SortOrder || {});
704
+ var WebhookIdentityType = /* @__PURE__ */ ((WebhookIdentityType2) => {
705
+ WebhookIdentityType2["UNKNOWN"] = "UNKNOWN";
706
+ WebhookIdentityType2["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
707
+ WebhookIdentityType2["MEMBER"] = "MEMBER";
708
+ WebhookIdentityType2["WIX_USER"] = "WIX_USER";
709
+ WebhookIdentityType2["APP"] = "APP";
710
+ return WebhookIdentityType2;
711
+ })(WebhookIdentityType || {});
712
+
696
713
  // src/restaurants-menus-v1-menu-menus.meta.ts
697
714
  function createMenu2() {
698
715
  const payload = {};
@@ -912,6 +929,8 @@ function duplicateMenu2() {
912
929
  }
913
930
  // Annotate the CommonJS export names for ESM import in node:
914
931
  0 && (module.exports = {
932
+ SortOrderOriginal,
933
+ WebhookIdentityTypeOriginal,
915
934
  bulkCreateMenus,
916
935
  bulkUpdateMenu,
917
936
  createMenu,