@wix/auto_sdk_restaurants_menus 1.0.76 → 1.0.77
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.
- package/build/cjs/index.d.ts +11 -11
- package/build/cjs/index.js +113 -90
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +233 -223
- package/build/cjs/index.typings.js +86 -63
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +195 -184
- package/build/cjs/meta.js +71 -48
- package/build/cjs/meta.js.map +1 -1
- package/build/cjs/schemas.d.ts +16 -12
- package/build/cjs/schemas.js +23 -17
- package/build/cjs/schemas.js.map +1 -1
- package/build/es/index.d.mts +11 -11
- package/build/es/index.mjs +113 -90
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +233 -223
- package/build/es/index.typings.mjs +86 -63
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +195 -184
- package/build/es/meta.mjs +71 -48
- package/build/es/meta.mjs.map +1 -1
- package/build/es/schemas.d.mts +16 -12
- package/build/es/schemas.mjs +23 -17
- package/build/es/schemas.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +11 -11
- package/build/internal/cjs/index.js +113 -90
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +233 -223
- package/build/internal/cjs/index.typings.js +86 -63
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +195 -184
- package/build/internal/cjs/meta.js +71 -48
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/cjs/schemas.d.ts +16 -12
- package/build/internal/cjs/schemas.js +23 -17
- package/build/internal/cjs/schemas.js.map +1 -1
- package/build/internal/es/index.d.mts +11 -11
- package/build/internal/es/index.mjs +113 -90
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +233 -223
- package/build/internal/es/index.typings.mjs +86 -63
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +195 -184
- package/build/internal/es/meta.mjs +71 -48
- package/build/internal/es/meta.mjs.map +1 -1
- package/build/internal/es/schemas.d.mts +16 -12
- package/build/internal/es/schemas.mjs +23 -17
- package/build/internal/es/schemas.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -164,183 +164,6 @@ interface ExternalReferenceInfo {
|
|
|
164
164
|
/** Whether the connection to the external system is currently active. */
|
|
165
165
|
connected?: boolean | null;
|
|
166
166
|
}
|
|
167
|
-
interface DuplicateMenuRequest {
|
|
168
|
-
/**
|
|
169
|
-
* Menu id to be duplicated.
|
|
170
|
-
* @format GUID
|
|
171
|
-
*/
|
|
172
|
-
_id: string;
|
|
173
|
-
/**
|
|
174
|
-
* Business location ids to duplicate the menu to.
|
|
175
|
-
* @format GUID
|
|
176
|
-
* @maxSize 100
|
|
177
|
-
*/
|
|
178
|
-
businessLocationIds?: string[] | null;
|
|
179
|
-
/** Indicates whether sub-entities (such as items) should be duplicated as well. */
|
|
180
|
-
duplicateSubEntities?: boolean | null;
|
|
181
|
-
/**
|
|
182
|
-
* The new name of the duplicated menu.
|
|
183
|
-
* @maxLength 500
|
|
184
|
-
*/
|
|
185
|
-
menuName?: string | null;
|
|
186
|
-
}
|
|
187
|
-
interface DuplicateMenuResponse {
|
|
188
|
-
/** @format GUID */
|
|
189
|
-
menuIds?: string[];
|
|
190
|
-
}
|
|
191
|
-
interface DomainEvent extends DomainEventBodyOneOf {
|
|
192
|
-
createdEvent?: EntityCreatedEvent;
|
|
193
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
194
|
-
deletedEvent?: EntityDeletedEvent;
|
|
195
|
-
actionEvent?: ActionEvent;
|
|
196
|
-
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
197
|
-
_id?: string;
|
|
198
|
-
/**
|
|
199
|
-
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
200
|
-
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
201
|
-
*/
|
|
202
|
-
entityFqdn?: string;
|
|
203
|
-
/**
|
|
204
|
-
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
205
|
-
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
206
|
-
*/
|
|
207
|
-
slug?: string;
|
|
208
|
-
/** ID of the entity associated with the event. */
|
|
209
|
-
entityId?: string;
|
|
210
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
211
|
-
eventTime?: Date | null;
|
|
212
|
-
/**
|
|
213
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
214
|
-
* (for example, GDPR).
|
|
215
|
-
*/
|
|
216
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
217
|
-
/** If present, indicates the action that triggered the event. */
|
|
218
|
-
originatedFrom?: string | null;
|
|
219
|
-
/**
|
|
220
|
-
* 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.
|
|
221
|
-
* 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.
|
|
222
|
-
*/
|
|
223
|
-
entityEventSequence?: string | null;
|
|
224
|
-
}
|
|
225
|
-
/** @oneof */
|
|
226
|
-
interface DomainEventBodyOneOf {
|
|
227
|
-
createdEvent?: EntityCreatedEvent;
|
|
228
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
229
|
-
deletedEvent?: EntityDeletedEvent;
|
|
230
|
-
actionEvent?: ActionEvent;
|
|
231
|
-
}
|
|
232
|
-
interface EntityCreatedEvent {
|
|
233
|
-
entity?: string;
|
|
234
|
-
}
|
|
235
|
-
interface RestoreInfo {
|
|
236
|
-
deletedDate?: Date | null;
|
|
237
|
-
}
|
|
238
|
-
interface EntityUpdatedEvent {
|
|
239
|
-
/**
|
|
240
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
241
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
242
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
243
|
-
*/
|
|
244
|
-
currentEntity?: string;
|
|
245
|
-
}
|
|
246
|
-
interface EntityDeletedEvent {
|
|
247
|
-
/** Entity that was deleted. */
|
|
248
|
-
deletedEntity?: string | null;
|
|
249
|
-
}
|
|
250
|
-
interface ActionEvent {
|
|
251
|
-
body?: string;
|
|
252
|
-
}
|
|
253
|
-
interface MessageEnvelope {
|
|
254
|
-
/**
|
|
255
|
-
* App instance ID.
|
|
256
|
-
* @format GUID
|
|
257
|
-
*/
|
|
258
|
-
instanceId?: string | null;
|
|
259
|
-
/**
|
|
260
|
-
* Event type.
|
|
261
|
-
* @maxLength 150
|
|
262
|
-
*/
|
|
263
|
-
eventType?: string;
|
|
264
|
-
/** The identification type and identity data. */
|
|
265
|
-
identity?: IdentificationData;
|
|
266
|
-
/** Stringify payload. */
|
|
267
|
-
data?: string;
|
|
268
|
-
/** Details related to the account */
|
|
269
|
-
accountInfo?: AccountInfo;
|
|
270
|
-
}
|
|
271
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
272
|
-
/**
|
|
273
|
-
* ID of a site visitor that has not logged in to the site.
|
|
274
|
-
* @format GUID
|
|
275
|
-
*/
|
|
276
|
-
anonymousVisitorId?: string;
|
|
277
|
-
/**
|
|
278
|
-
* ID of a site visitor that has logged in to the site.
|
|
279
|
-
* @format GUID
|
|
280
|
-
*/
|
|
281
|
-
memberId?: string;
|
|
282
|
-
/**
|
|
283
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
284
|
-
* @format GUID
|
|
285
|
-
*/
|
|
286
|
-
wixUserId?: string;
|
|
287
|
-
/**
|
|
288
|
-
* ID of an app.
|
|
289
|
-
* @format GUID
|
|
290
|
-
*/
|
|
291
|
-
appId?: string;
|
|
292
|
-
/** @readonly */
|
|
293
|
-
identityType?: WebhookIdentityTypeWithLiterals;
|
|
294
|
-
}
|
|
295
|
-
/** @oneof */
|
|
296
|
-
interface IdentificationDataIdOneOf {
|
|
297
|
-
/**
|
|
298
|
-
* ID of a site visitor that has not logged in to the site.
|
|
299
|
-
* @format GUID
|
|
300
|
-
*/
|
|
301
|
-
anonymousVisitorId?: string;
|
|
302
|
-
/**
|
|
303
|
-
* ID of a site visitor that has logged in to the site.
|
|
304
|
-
* @format GUID
|
|
305
|
-
*/
|
|
306
|
-
memberId?: string;
|
|
307
|
-
/**
|
|
308
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
309
|
-
* @format GUID
|
|
310
|
-
*/
|
|
311
|
-
wixUserId?: string;
|
|
312
|
-
/**
|
|
313
|
-
* ID of an app.
|
|
314
|
-
* @format GUID
|
|
315
|
-
*/
|
|
316
|
-
appId?: string;
|
|
317
|
-
}
|
|
318
|
-
declare enum WebhookIdentityType {
|
|
319
|
-
UNKNOWN = "UNKNOWN",
|
|
320
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
321
|
-
MEMBER = "MEMBER",
|
|
322
|
-
WIX_USER = "WIX_USER",
|
|
323
|
-
APP = "APP"
|
|
324
|
-
}
|
|
325
|
-
/** @enumType */
|
|
326
|
-
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
327
|
-
interface AccountInfo {
|
|
328
|
-
/**
|
|
329
|
-
* ID of the Wix account associated with the event.
|
|
330
|
-
* @format GUID
|
|
331
|
-
*/
|
|
332
|
-
accountId?: string | null;
|
|
333
|
-
/**
|
|
334
|
-
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
335
|
-
* @format GUID
|
|
336
|
-
*/
|
|
337
|
-
parentAccountId?: string | null;
|
|
338
|
-
/**
|
|
339
|
-
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
340
|
-
* @format GUID
|
|
341
|
-
*/
|
|
342
|
-
siteId?: string | null;
|
|
343
|
-
}
|
|
344
167
|
interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
345
168
|
/**
|
|
346
169
|
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
@@ -656,6 +479,11 @@ interface Sorting {
|
|
|
656
479
|
fieldName?: string;
|
|
657
480
|
/** Sort order. */
|
|
658
481
|
order?: SortOrderWithLiterals;
|
|
482
|
+
/**
|
|
483
|
+
* Origin point for geo-distance sorting on a GEO field
|
|
484
|
+
* results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
|
|
485
|
+
*/
|
|
486
|
+
origin?: AddressLocation;
|
|
659
487
|
}
|
|
660
488
|
declare enum SortOrder {
|
|
661
489
|
ASC = "ASC",
|
|
@@ -663,6 +491,12 @@ declare enum SortOrder {
|
|
|
663
491
|
}
|
|
664
492
|
/** @enumType */
|
|
665
493
|
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
494
|
+
interface AddressLocation {
|
|
495
|
+
/** Address latitude. */
|
|
496
|
+
latitude?: number | null;
|
|
497
|
+
/** Address longitude. */
|
|
498
|
+
longitude?: number | null;
|
|
499
|
+
}
|
|
666
500
|
interface QueryMenusResponse {
|
|
667
501
|
/** Retrieved menus. */
|
|
668
502
|
menus?: Menu[];
|
|
@@ -760,6 +594,68 @@ interface CloneMenusRequest {
|
|
|
760
594
|
}
|
|
761
595
|
interface CloneMenusResponse {
|
|
762
596
|
}
|
|
597
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
598
|
+
createdEvent?: EntityCreatedEvent;
|
|
599
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
600
|
+
deletedEvent?: EntityDeletedEvent;
|
|
601
|
+
actionEvent?: ActionEvent;
|
|
602
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
603
|
+
_id?: string;
|
|
604
|
+
/**
|
|
605
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
606
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
607
|
+
*/
|
|
608
|
+
entityFqdn?: string;
|
|
609
|
+
/**
|
|
610
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
611
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
612
|
+
*/
|
|
613
|
+
slug?: string;
|
|
614
|
+
/** ID of the entity associated with the event. */
|
|
615
|
+
entityId?: string;
|
|
616
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
617
|
+
eventTime?: Date | null;
|
|
618
|
+
/**
|
|
619
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
620
|
+
* (for example, GDPR).
|
|
621
|
+
*/
|
|
622
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
623
|
+
/** If present, indicates the action that triggered the event. */
|
|
624
|
+
originatedFrom?: string | null;
|
|
625
|
+
/**
|
|
626
|
+
* 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.
|
|
627
|
+
* 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.
|
|
628
|
+
*/
|
|
629
|
+
entityEventSequence?: string | null;
|
|
630
|
+
}
|
|
631
|
+
/** @oneof */
|
|
632
|
+
interface DomainEventBodyOneOf {
|
|
633
|
+
createdEvent?: EntityCreatedEvent;
|
|
634
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
635
|
+
deletedEvent?: EntityDeletedEvent;
|
|
636
|
+
actionEvent?: ActionEvent;
|
|
637
|
+
}
|
|
638
|
+
interface EntityCreatedEvent {
|
|
639
|
+
entity?: string;
|
|
640
|
+
}
|
|
641
|
+
interface RestoreInfo {
|
|
642
|
+
deletedDate?: Date | null;
|
|
643
|
+
}
|
|
644
|
+
interface EntityUpdatedEvent {
|
|
645
|
+
/**
|
|
646
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
647
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
648
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
649
|
+
*/
|
|
650
|
+
currentEntity?: string;
|
|
651
|
+
}
|
|
652
|
+
interface EntityDeletedEvent {
|
|
653
|
+
/** Entity that was deleted. */
|
|
654
|
+
deletedEntity?: string | null;
|
|
655
|
+
}
|
|
656
|
+
interface ActionEvent {
|
|
657
|
+
body?: string;
|
|
658
|
+
}
|
|
763
659
|
interface Empty {
|
|
764
660
|
}
|
|
765
661
|
interface SyncContentToMultilingualRequest {
|
|
@@ -771,6 +667,121 @@ interface SyncContentToMultilingualRequest {
|
|
|
771
667
|
}
|
|
772
668
|
interface SyncContentToMultilingualResponse {
|
|
773
669
|
}
|
|
670
|
+
interface MessageEnvelope {
|
|
671
|
+
/**
|
|
672
|
+
* App instance ID.
|
|
673
|
+
* @format GUID
|
|
674
|
+
*/
|
|
675
|
+
instanceId?: string | null;
|
|
676
|
+
/**
|
|
677
|
+
* Event type.
|
|
678
|
+
* @maxLength 150
|
|
679
|
+
*/
|
|
680
|
+
eventType?: string;
|
|
681
|
+
/** The identification type and identity data. */
|
|
682
|
+
identity?: IdentificationData;
|
|
683
|
+
/** Stringify payload. */
|
|
684
|
+
data?: string;
|
|
685
|
+
/** Details related to the account */
|
|
686
|
+
accountInfo?: AccountInfo;
|
|
687
|
+
}
|
|
688
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
689
|
+
/**
|
|
690
|
+
* ID of a site visitor that has not logged in to the site.
|
|
691
|
+
* @format GUID
|
|
692
|
+
*/
|
|
693
|
+
anonymousVisitorId?: string;
|
|
694
|
+
/**
|
|
695
|
+
* ID of a site visitor that has logged in to the site.
|
|
696
|
+
* @format GUID
|
|
697
|
+
*/
|
|
698
|
+
memberId?: string;
|
|
699
|
+
/**
|
|
700
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
701
|
+
* @format GUID
|
|
702
|
+
*/
|
|
703
|
+
wixUserId?: string;
|
|
704
|
+
/**
|
|
705
|
+
* ID of an app.
|
|
706
|
+
* @format GUID
|
|
707
|
+
*/
|
|
708
|
+
appId?: string;
|
|
709
|
+
/** @readonly */
|
|
710
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
711
|
+
}
|
|
712
|
+
/** @oneof */
|
|
713
|
+
interface IdentificationDataIdOneOf {
|
|
714
|
+
/**
|
|
715
|
+
* ID of a site visitor that has not logged in to the site.
|
|
716
|
+
* @format GUID
|
|
717
|
+
*/
|
|
718
|
+
anonymousVisitorId?: string;
|
|
719
|
+
/**
|
|
720
|
+
* ID of a site visitor that has logged in to the site.
|
|
721
|
+
* @format GUID
|
|
722
|
+
*/
|
|
723
|
+
memberId?: string;
|
|
724
|
+
/**
|
|
725
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
726
|
+
* @format GUID
|
|
727
|
+
*/
|
|
728
|
+
wixUserId?: string;
|
|
729
|
+
/**
|
|
730
|
+
* ID of an app.
|
|
731
|
+
* @format GUID
|
|
732
|
+
*/
|
|
733
|
+
appId?: string;
|
|
734
|
+
}
|
|
735
|
+
declare enum WebhookIdentityType {
|
|
736
|
+
UNKNOWN = "UNKNOWN",
|
|
737
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
738
|
+
MEMBER = "MEMBER",
|
|
739
|
+
WIX_USER = "WIX_USER",
|
|
740
|
+
APP = "APP"
|
|
741
|
+
}
|
|
742
|
+
/** @enumType */
|
|
743
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
744
|
+
interface AccountInfo {
|
|
745
|
+
/**
|
|
746
|
+
* ID of the Wix account associated with the event.
|
|
747
|
+
* @format GUID
|
|
748
|
+
*/
|
|
749
|
+
accountId?: string | null;
|
|
750
|
+
/**
|
|
751
|
+
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
752
|
+
* @format GUID
|
|
753
|
+
*/
|
|
754
|
+
parentAccountId?: string | null;
|
|
755
|
+
/**
|
|
756
|
+
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
757
|
+
* @format GUID
|
|
758
|
+
*/
|
|
759
|
+
siteId?: string | null;
|
|
760
|
+
}
|
|
761
|
+
interface DuplicateMenuRequest {
|
|
762
|
+
/**
|
|
763
|
+
* Menu id to be duplicated.
|
|
764
|
+
* @format GUID
|
|
765
|
+
*/
|
|
766
|
+
_id: string;
|
|
767
|
+
/**
|
|
768
|
+
* Business location ids to duplicate the menu to.
|
|
769
|
+
* @format GUID
|
|
770
|
+
* @maxSize 100
|
|
771
|
+
*/
|
|
772
|
+
businessLocationIds?: string[] | null;
|
|
773
|
+
/** Indicates whether sub-entities (such as items) should be duplicated as well. */
|
|
774
|
+
duplicateSubEntities?: boolean | null;
|
|
775
|
+
/**
|
|
776
|
+
* The new name of the duplicated menu.
|
|
777
|
+
* @maxLength 500
|
|
778
|
+
*/
|
|
779
|
+
menuName?: string | null;
|
|
780
|
+
}
|
|
781
|
+
interface DuplicateMenuResponse {
|
|
782
|
+
/** @format GUID */
|
|
783
|
+
menuIds?: string[];
|
|
784
|
+
}
|
|
774
785
|
interface GetMenuSiteUrlRequest {
|
|
775
786
|
/**
|
|
776
787
|
* Menu ID.
|
|
@@ -842,7 +853,7 @@ interface EventMetadata extends BaseEventMetadata {
|
|
|
842
853
|
/** If present, indicates the action that triggered the event. */
|
|
843
854
|
originatedFrom?: string | null;
|
|
844
855
|
/**
|
|
845
|
-
* 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
|
|
856
|
+
* 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.
|
|
846
857
|
* 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.
|
|
847
858
|
*/
|
|
848
859
|
entityEventSequence?: string | null;
|
|
@@ -856,30 +867,11 @@ interface AccountInfoMetadata {
|
|
|
856
867
|
/** ID of the parent Wix account. Only included when 'accountId' belongs to a child account. */
|
|
857
868
|
parentAccountId?: string;
|
|
858
869
|
}
|
|
859
|
-
interface MenuUpdatedEnvelope {
|
|
860
|
-
entity: Menu;
|
|
861
|
-
metadata: EventMetadata;
|
|
862
|
-
/** @hidden */
|
|
863
|
-
modifiedFields: Record<string, any>;
|
|
864
|
-
}
|
|
865
|
-
/** @permissionScope Wix Multilingual - Nile Wrapper Domain Events Read
|
|
866
|
-
* @permissionScopeId SCOPE.MULTILINGUAL.NILE_WRAPPER_DOMAIN_EVENTS_READ
|
|
867
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
868
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
869
|
-
* @permissionId RESTAURANTS.MENU_READ
|
|
870
|
-
* @webhook
|
|
871
|
-
* @eventType wix.restaurants.menus.v1.menu_updated
|
|
872
|
-
* @slug updated
|
|
873
|
-
* @documentationMaturity preview
|
|
874
|
-
*/
|
|
875
|
-
declare function onMenuUpdated(handler: (event: MenuUpdatedEnvelope) => void | Promise<void>): void;
|
|
876
870
|
interface MenuCreatedEnvelope {
|
|
877
871
|
entity: Menu;
|
|
878
872
|
metadata: EventMetadata;
|
|
879
873
|
}
|
|
880
|
-
/** @permissionScope
|
|
881
|
-
* @permissionScopeId SCOPE.MULTILINGUAL.NILE_WRAPPER_DOMAIN_EVENTS_READ
|
|
882
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
874
|
+
/** @permissionScope Manage Restaurants - all permissions
|
|
883
875
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
884
876
|
* @permissionId RESTAURANTS.MENU_READ
|
|
885
877
|
* @webhook
|
|
@@ -894,8 +886,6 @@ interface MenuDeletedEnvelope {
|
|
|
894
886
|
}
|
|
895
887
|
/**
|
|
896
888
|
* Triggered when a menu is deleted.
|
|
897
|
-
* @permissionScope Wix Multilingual - Nile Wrapper Domain Events Read
|
|
898
|
-
* @permissionScopeId SCOPE.MULTILINGUAL.NILE_WRAPPER_DOMAIN_EVENTS_READ
|
|
899
889
|
* @permissionScope Manage Restaurants - all permissions
|
|
900
890
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
901
891
|
* @permissionId RESTAURANTS.MENU_READ
|
|
@@ -906,30 +896,21 @@ interface MenuDeletedEnvelope {
|
|
|
906
896
|
* @documentationMaturity preview
|
|
907
897
|
*/
|
|
908
898
|
declare function onMenuDeleted(handler: (event: MenuDeletedEnvelope) => void | Promise<void>): void;
|
|
909
|
-
|
|
910
|
-
|
|
899
|
+
interface MenuUpdatedEnvelope {
|
|
900
|
+
entity: Menu;
|
|
901
|
+
metadata: EventMetadata;
|
|
902
|
+
/** @hidden */
|
|
903
|
+
modifiedFields: Record<string, any>;
|
|
904
|
+
}
|
|
905
|
+
/** @permissionScope Manage Restaurants - all permissions
|
|
906
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
907
|
+
* @permissionId RESTAURANTS.MENU_READ
|
|
908
|
+
* @webhook
|
|
909
|
+
* @eventType wix.restaurants.menus.v1.menu_updated
|
|
910
|
+
* @slug updated
|
|
911
911
|
* @documentationMaturity preview
|
|
912
|
-
* @requiredField _id
|
|
913
|
-
* @permissionId RESTAURANTS.MENU_CREATE
|
|
914
|
-
* @applicableIdentity APP
|
|
915
|
-
* @fqn com.wixpress.restaurants.menus_menu.v1.restaurants_duplicate_menu.RestaurantsDuplicateMenu.DuplicateMenu
|
|
916
912
|
*/
|
|
917
|
-
declare function
|
|
918
|
-
interface DuplicateMenuOptions {
|
|
919
|
-
/**
|
|
920
|
-
* Business location ids to duplicate the menu to.
|
|
921
|
-
* @format GUID
|
|
922
|
-
* @maxSize 100
|
|
923
|
-
*/
|
|
924
|
-
businessLocationIds?: string[] | null;
|
|
925
|
-
/** Indicates whether sub-entities (such as items) should be duplicated as well. */
|
|
926
|
-
duplicateSubEntities?: boolean | null;
|
|
927
|
-
/**
|
|
928
|
-
* The new name of the duplicated menu.
|
|
929
|
-
* @maxLength 500
|
|
930
|
-
*/
|
|
931
|
-
menuName?: string | null;
|
|
932
|
-
}
|
|
913
|
+
declare function onMenuUpdated(handler: (event: MenuUpdatedEnvelope) => void | Promise<void>): void;
|
|
933
914
|
/**
|
|
934
915
|
* > **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).
|
|
935
916
|
*
|
|
@@ -1175,6 +1156,11 @@ type MenuQuery = {
|
|
|
1175
1156
|
Sort order.
|
|
1176
1157
|
*/
|
|
1177
1158
|
order?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['order'];
|
|
1159
|
+
/**
|
|
1160
|
+
Origin point for geo-distance sorting on a GEO field
|
|
1161
|
+
results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
|
|
1162
|
+
*/
|
|
1163
|
+
origin?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['origin'];
|
|
1178
1164
|
}[];
|
|
1179
1165
|
};
|
|
1180
1166
|
declare const utils: {
|
|
@@ -1315,6 +1301,30 @@ interface UpdateExtendedFieldsOptions {
|
|
|
1315
1301
|
* @fqn com.wixpress.restaurants.menus_menu.v1.RestaurantsMenusMenu.DeleteMenu
|
|
1316
1302
|
*/
|
|
1317
1303
|
declare function deleteMenu(menuId: string): Promise<void>;
|
|
1304
|
+
/** @param _id - Menu id to be duplicated.
|
|
1305
|
+
* @public
|
|
1306
|
+
* @documentationMaturity preview
|
|
1307
|
+
* @requiredField _id
|
|
1308
|
+
* @permissionId RESTAURANTS.MENU_CREATE
|
|
1309
|
+
* @applicableIdentity APP
|
|
1310
|
+
* @fqn com.wixpress.restaurants.menus_menu.v1.restaurants_duplicate_menu.RestaurantsDuplicateMenu.DuplicateMenu
|
|
1311
|
+
*/
|
|
1312
|
+
declare function duplicateMenu(_id: string, options?: DuplicateMenuOptions): Promise<NonNullablePaths<DuplicateMenuResponse, `menuIds`, 2>>;
|
|
1313
|
+
interface DuplicateMenuOptions {
|
|
1314
|
+
/**
|
|
1315
|
+
* Business location ids to duplicate the menu to.
|
|
1316
|
+
* @format GUID
|
|
1317
|
+
* @maxSize 100
|
|
1318
|
+
*/
|
|
1319
|
+
businessLocationIds?: string[] | null;
|
|
1320
|
+
/** Indicates whether sub-entities (such as items) should be duplicated as well. */
|
|
1321
|
+
duplicateSubEntities?: boolean | null;
|
|
1322
|
+
/**
|
|
1323
|
+
* The new name of the duplicated menu.
|
|
1324
|
+
* @maxLength 500
|
|
1325
|
+
*/
|
|
1326
|
+
menuName?: string | null;
|
|
1327
|
+
}
|
|
1318
1328
|
/**
|
|
1319
1329
|
* Get menu details and path URL by menu ID.
|
|
1320
1330
|
* @param _id - Menu ID.
|
|
@@ -1340,4 +1350,4 @@ interface QueryMenusSiteUrlOptions {
|
|
|
1340
1350
|
query?: CursorQuery;
|
|
1341
1351
|
}
|
|
1342
1352
|
|
|
1343
|
-
export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, 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 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 };
|
|
1353
|
+
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 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 };
|