@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.
- package/build/cjs/index.d.ts +5 -5
- package/build/cjs/index.js +17 -17
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +362 -256
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +344 -238
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +5 -5
- package/build/es/index.mjs +17 -17
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +362 -256
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +344 -238
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +5 -5
- package/build/internal/cjs/index.typings.d.ts +407 -301
- package/build/internal/cjs/meta.d.ts +426 -320
- package/build/internal/es/index.d.mts +5 -5
- package/build/internal/es/index.typings.d.mts +407 -301
- package/build/internal/es/meta.d.mts +426 -320
- package/package.json +2 -2
|
@@ -266,6 +266,347 @@ interface ExternalReferenceInfo {
|
|
|
266
266
|
/** Whether the connection to the external system is currently active. */
|
|
267
267
|
connected?: boolean | null;
|
|
268
268
|
}
|
|
269
|
+
interface QueryMenuExportRowsRequest {
|
|
270
|
+
/**
|
|
271
|
+
* Filter: `{"menuId": "<GUID>"}` or `{"menuId": {"$eq": "<GUID>"}}`, required on the first page; a later page may omit
|
|
272
|
+
* it, and if it sends it, it must name the cursor's menu. Cursor paging only, at most 500 rows
|
|
273
|
+
* per page (default 100); a sort fails with `INVALID_MENU_EXPORT_QUERY`. This is the same wire format as the fed-infra
|
|
274
|
+
* export service's `ExportQueryV2`: filter 1, sort 2, cursor paging 6.
|
|
275
|
+
*/
|
|
276
|
+
query?: CursorQuery;
|
|
277
|
+
}
|
|
278
|
+
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
279
|
+
/** 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`. */
|
|
280
|
+
cursorPaging?: CursorPaging;
|
|
281
|
+
/**
|
|
282
|
+
* Filter object in the following format:
|
|
283
|
+
* `"filter" : {
|
|
284
|
+
* "fieldName1": "value1",
|
|
285
|
+
* "fieldName2":{"$operator":"value2"}
|
|
286
|
+
* }`
|
|
287
|
+
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
|
|
288
|
+
*/
|
|
289
|
+
filter?: Record<string, any> | null;
|
|
290
|
+
/**
|
|
291
|
+
* Sort object in the following format:
|
|
292
|
+
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
293
|
+
*/
|
|
294
|
+
sort?: Sorting[];
|
|
295
|
+
}
|
|
296
|
+
/** @oneof */
|
|
297
|
+
interface CursorQueryPagingMethodOneOf {
|
|
298
|
+
/** 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`. */
|
|
299
|
+
cursorPaging?: CursorPaging;
|
|
300
|
+
}
|
|
301
|
+
interface Sorting {
|
|
302
|
+
/**
|
|
303
|
+
* Name of the field to sort by.
|
|
304
|
+
* @maxLength 512
|
|
305
|
+
*/
|
|
306
|
+
fieldName?: string;
|
|
307
|
+
/** Sort order. */
|
|
308
|
+
order?: SortOrderWithLiterals;
|
|
309
|
+
/**
|
|
310
|
+
* Origin point for geo-distance sorting on a GEO field
|
|
311
|
+
* results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
|
|
312
|
+
*/
|
|
313
|
+
origin?: AddressLocation;
|
|
314
|
+
}
|
|
315
|
+
declare enum SortOrder {
|
|
316
|
+
ASC = "ASC",
|
|
317
|
+
DESC = "DESC"
|
|
318
|
+
}
|
|
319
|
+
/** @enumType */
|
|
320
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
321
|
+
interface AddressLocation {
|
|
322
|
+
/** Address latitude. */
|
|
323
|
+
latitude?: number | null;
|
|
324
|
+
/** Address longitude. */
|
|
325
|
+
longitude?: number | null;
|
|
326
|
+
}
|
|
327
|
+
interface CursorPaging {
|
|
328
|
+
/**
|
|
329
|
+
* Number of items to load.
|
|
330
|
+
* @max 500
|
|
331
|
+
*/
|
|
332
|
+
limit?: number | null;
|
|
333
|
+
/**
|
|
334
|
+
* Pointer to the next or previous page in the list of results.
|
|
335
|
+
*
|
|
336
|
+
* You can get the relevant cursor token
|
|
337
|
+
* from the `pagingMetadata` object in the previous call's response.
|
|
338
|
+
* Not relevant for the first request.
|
|
339
|
+
*/
|
|
340
|
+
cursor?: string | null;
|
|
341
|
+
}
|
|
342
|
+
interface QueryMenuExportRowsResponse {
|
|
343
|
+
/** The page's rows, in file order. */
|
|
344
|
+
menuExportRows?: MenuExportRow[];
|
|
345
|
+
/** Paging metadata: `cursors.next` is set while rows remain. */
|
|
346
|
+
pagingMetadata?: CursorPagingMetadata;
|
|
347
|
+
}
|
|
348
|
+
/**
|
|
349
|
+
* One CSV row. Every field is text exactly as written to the file (design-log/001 Q5); unused columns are empty.
|
|
350
|
+
* Free-text limits are the source field's product limit plus one, for the `'` the formula guard can add; `labels` allows
|
|
351
|
+
* 10 names of 50, each doubled at most by escaping, 9 separators and the guard. The other limits bound fixed values.
|
|
352
|
+
*/
|
|
353
|
+
interface MenuExportRow {
|
|
354
|
+
/**
|
|
355
|
+
* `section`, `item`, `variant`, `modifier_group` or `modifier`.
|
|
356
|
+
* @maxLength 20
|
|
357
|
+
*/
|
|
358
|
+
type?: string;
|
|
359
|
+
/**
|
|
360
|
+
* Name of the row's section.
|
|
361
|
+
* @maxLength 501
|
|
362
|
+
*/
|
|
363
|
+
sectionName?: string;
|
|
364
|
+
/**
|
|
365
|
+
* Section description, on section rows.
|
|
366
|
+
* @maxLength 1501
|
|
367
|
+
*/
|
|
368
|
+
sectionDescription?: string;
|
|
369
|
+
/**
|
|
370
|
+
* Item name, on item, variant, modifier group and modifier rows.
|
|
371
|
+
* @maxLength 201
|
|
372
|
+
*/
|
|
373
|
+
itemName?: string;
|
|
374
|
+
/**
|
|
375
|
+
* Item description, on item rows.
|
|
376
|
+
* @maxLength 1501
|
|
377
|
+
*/
|
|
378
|
+
itemDescription?: string;
|
|
379
|
+
/**
|
|
380
|
+
* 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
|
|
381
|
+
* item priced by variants, `0.00` for an item without a stored price. On variant and modifier rows: `0.00` without a
|
|
382
|
+
* price or charge. Empty on section and modifier group rows.
|
|
383
|
+
* @maxLength 50
|
|
384
|
+
*/
|
|
385
|
+
price?: string;
|
|
386
|
+
/**
|
|
387
|
+
* The site's payment currency on item, variant and modifier rows. The importer doesn't read it: an imported menu takes
|
|
388
|
+
* the target site's currency.
|
|
389
|
+
* @maxLength 10
|
|
390
|
+
*/
|
|
391
|
+
currency?: string;
|
|
392
|
+
/**
|
|
393
|
+
* The item's label names, `;`-separated, each exactly as the site names it, with `\` and `;` inside a name escaped
|
|
394
|
+
* as `\\` and `\;`.
|
|
395
|
+
* @maxLength 1010
|
|
396
|
+
*/
|
|
397
|
+
labels?: string;
|
|
398
|
+
/**
|
|
399
|
+
* Modifier group name, on modifier group and modifier rows.
|
|
400
|
+
* @maxLength 101
|
|
401
|
+
*/
|
|
402
|
+
modifierGroupName?: string;
|
|
403
|
+
/**
|
|
404
|
+
* `yes` or `no`, on modifier group rows.
|
|
405
|
+
* @maxLength 3
|
|
406
|
+
*/
|
|
407
|
+
modifierRequired?: string;
|
|
408
|
+
/**
|
|
409
|
+
* Minimum selections, on modifier group rows.
|
|
410
|
+
* @maxLength 20
|
|
411
|
+
*/
|
|
412
|
+
modifierMinSelections?: string;
|
|
413
|
+
/**
|
|
414
|
+
* Maximum selections (`0` is unlimited), on modifier group rows.
|
|
415
|
+
* @maxLength 20
|
|
416
|
+
*/
|
|
417
|
+
modifierMaxSelections?: string;
|
|
418
|
+
/**
|
|
419
|
+
* Modifier name, on modifier rows.
|
|
420
|
+
* @maxLength 201
|
|
421
|
+
*/
|
|
422
|
+
modifierName?: string;
|
|
423
|
+
/**
|
|
424
|
+
* `yes` or `no`, on modifier rows.
|
|
425
|
+
* @maxLength 3
|
|
426
|
+
*/
|
|
427
|
+
modifierPreSelected?: string;
|
|
428
|
+
/**
|
|
429
|
+
* Variant name, on variant rows.
|
|
430
|
+
* @maxLength 201
|
|
431
|
+
*/
|
|
432
|
+
variantName?: string;
|
|
433
|
+
/**
|
|
434
|
+
* `yes` or `no` on section and item rows.
|
|
435
|
+
* @maxLength 3
|
|
436
|
+
*/
|
|
437
|
+
visible?: string;
|
|
438
|
+
}
|
|
439
|
+
interface CursorPagingMetadata {
|
|
440
|
+
/** Number of items returned in the response. */
|
|
441
|
+
count?: number | null;
|
|
442
|
+
/** Offset that was requested. */
|
|
443
|
+
cursors?: Cursors;
|
|
444
|
+
/**
|
|
445
|
+
* Indicates if there are more results after the current page.
|
|
446
|
+
* If `true`, another page of results can be retrieved.
|
|
447
|
+
* If `false`, this is the last page.
|
|
448
|
+
*/
|
|
449
|
+
hasNext?: boolean | null;
|
|
450
|
+
}
|
|
451
|
+
interface Cursors {
|
|
452
|
+
/** Cursor pointing to next page in the list of results. */
|
|
453
|
+
next?: string | null;
|
|
454
|
+
/** Cursor pointing to previous page in the list of results. */
|
|
455
|
+
prev?: string | null;
|
|
456
|
+
}
|
|
457
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
458
|
+
createdEvent?: EntityCreatedEvent;
|
|
459
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
460
|
+
deletedEvent?: EntityDeletedEvent;
|
|
461
|
+
actionEvent?: ActionEvent;
|
|
462
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
463
|
+
_id?: string;
|
|
464
|
+
/**
|
|
465
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
466
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
467
|
+
*/
|
|
468
|
+
entityFqdn?: string;
|
|
469
|
+
/**
|
|
470
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
471
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
472
|
+
*/
|
|
473
|
+
slug?: string;
|
|
474
|
+
/** ID of the entity associated with the event. */
|
|
475
|
+
entityId?: string;
|
|
476
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
477
|
+
eventTime?: Date | null;
|
|
478
|
+
/**
|
|
479
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
480
|
+
* (for example, GDPR).
|
|
481
|
+
*/
|
|
482
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
483
|
+
/** If present, indicates the action that triggered the event. */
|
|
484
|
+
originatedFrom?: string | null;
|
|
485
|
+
/**
|
|
486
|
+
* 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.
|
|
487
|
+
* 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.
|
|
488
|
+
*/
|
|
489
|
+
entityEventSequence?: string | null;
|
|
490
|
+
}
|
|
491
|
+
/** @oneof */
|
|
492
|
+
interface DomainEventBodyOneOf {
|
|
493
|
+
createdEvent?: EntityCreatedEvent;
|
|
494
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
495
|
+
deletedEvent?: EntityDeletedEvent;
|
|
496
|
+
actionEvent?: ActionEvent;
|
|
497
|
+
}
|
|
498
|
+
interface EntityCreatedEvent {
|
|
499
|
+
entity?: string;
|
|
500
|
+
}
|
|
501
|
+
interface RestoreInfo {
|
|
502
|
+
deletedDate?: Date | null;
|
|
503
|
+
}
|
|
504
|
+
interface EntityUpdatedEvent {
|
|
505
|
+
/**
|
|
506
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
507
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
508
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
509
|
+
*/
|
|
510
|
+
currentEntity?: string;
|
|
511
|
+
}
|
|
512
|
+
interface EntityDeletedEvent {
|
|
513
|
+
/** Entity that was deleted. */
|
|
514
|
+
deletedEntity?: string | null;
|
|
515
|
+
}
|
|
516
|
+
interface ActionEvent {
|
|
517
|
+
body?: string;
|
|
518
|
+
}
|
|
519
|
+
interface MessageEnvelope {
|
|
520
|
+
/**
|
|
521
|
+
* App instance ID.
|
|
522
|
+
* @format GUID
|
|
523
|
+
*/
|
|
524
|
+
instanceId?: string | null;
|
|
525
|
+
/**
|
|
526
|
+
* Event type.
|
|
527
|
+
* @maxLength 150
|
|
528
|
+
*/
|
|
529
|
+
eventType?: string;
|
|
530
|
+
/** The identification type and identity data. */
|
|
531
|
+
identity?: IdentificationData;
|
|
532
|
+
/** Stringify payload. */
|
|
533
|
+
data?: string;
|
|
534
|
+
/** Details related to the account */
|
|
535
|
+
accountInfo?: AccountInfo;
|
|
536
|
+
}
|
|
537
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
538
|
+
/**
|
|
539
|
+
* ID of a site visitor that has not logged in to the site.
|
|
540
|
+
* @format GUID
|
|
541
|
+
*/
|
|
542
|
+
anonymousVisitorId?: string;
|
|
543
|
+
/**
|
|
544
|
+
* ID of a site visitor that has logged in to the site.
|
|
545
|
+
* @format GUID
|
|
546
|
+
*/
|
|
547
|
+
memberId?: string;
|
|
548
|
+
/**
|
|
549
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
550
|
+
* @format GUID
|
|
551
|
+
*/
|
|
552
|
+
wixUserId?: string;
|
|
553
|
+
/**
|
|
554
|
+
* ID of an app.
|
|
555
|
+
* @format GUID
|
|
556
|
+
*/
|
|
557
|
+
appId?: string;
|
|
558
|
+
/** @readonly */
|
|
559
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
560
|
+
}
|
|
561
|
+
/** @oneof */
|
|
562
|
+
interface IdentificationDataIdOneOf {
|
|
563
|
+
/**
|
|
564
|
+
* ID of a site visitor that has not logged in to the site.
|
|
565
|
+
* @format GUID
|
|
566
|
+
*/
|
|
567
|
+
anonymousVisitorId?: string;
|
|
568
|
+
/**
|
|
569
|
+
* ID of a site visitor that has logged in to the site.
|
|
570
|
+
* @format GUID
|
|
571
|
+
*/
|
|
572
|
+
memberId?: string;
|
|
573
|
+
/**
|
|
574
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
575
|
+
* @format GUID
|
|
576
|
+
*/
|
|
577
|
+
wixUserId?: string;
|
|
578
|
+
/**
|
|
579
|
+
* ID of an app.
|
|
580
|
+
* @format GUID
|
|
581
|
+
*/
|
|
582
|
+
appId?: string;
|
|
583
|
+
}
|
|
584
|
+
declare enum WebhookIdentityType {
|
|
585
|
+
UNKNOWN = "UNKNOWN",
|
|
586
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
587
|
+
MEMBER = "MEMBER",
|
|
588
|
+
WIX_USER = "WIX_USER",
|
|
589
|
+
APP = "APP"
|
|
590
|
+
}
|
|
591
|
+
/** @enumType */
|
|
592
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
593
|
+
interface AccountInfo {
|
|
594
|
+
/**
|
|
595
|
+
* ID of the Wix account associated with the event.
|
|
596
|
+
* @format GUID
|
|
597
|
+
*/
|
|
598
|
+
accountId?: string | null;
|
|
599
|
+
/**
|
|
600
|
+
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
601
|
+
* @format GUID
|
|
602
|
+
*/
|
|
603
|
+
parentAccountId?: string | null;
|
|
604
|
+
/**
|
|
605
|
+
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
606
|
+
* @format GUID
|
|
607
|
+
*/
|
|
608
|
+
siteId?: string | null;
|
|
609
|
+
}
|
|
269
610
|
interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
270
611
|
/**
|
|
271
612
|
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
@@ -501,26 +842,11 @@ interface ListMenusRequest {
|
|
|
501
842
|
* @format GUID
|
|
502
843
|
* @maxSize 500
|
|
503
844
|
*/
|
|
504
|
-
menuIds?: string[];
|
|
505
|
-
/** The metadata of the paginated results. */
|
|
506
|
-
paging?: CursorPaging;
|
|
507
|
-
/** Whether to return only menus that are visible to site visitors. */
|
|
508
|
-
onlyVisible?: boolean | null;
|
|
509
|
-
}
|
|
510
|
-
interface CursorPaging {
|
|
511
|
-
/**
|
|
512
|
-
* Number of items to load.
|
|
513
|
-
* @max 500
|
|
514
|
-
*/
|
|
515
|
-
limit?: number | null;
|
|
516
|
-
/**
|
|
517
|
-
* Pointer to the next or previous page in the list of results.
|
|
518
|
-
*
|
|
519
|
-
* You can get the relevant cursor token
|
|
520
|
-
* from the `pagingMetadata` object in the previous call's response.
|
|
521
|
-
* Not relevant for the first request.
|
|
522
|
-
*/
|
|
523
|
-
cursor?: string | null;
|
|
845
|
+
menuIds?: string[];
|
|
846
|
+
/** The metadata of the paginated results. */
|
|
847
|
+
paging?: CursorPaging;
|
|
848
|
+
/** Whether to return only menus that are visible to site visitors. */
|
|
849
|
+
onlyVisible?: boolean | null;
|
|
524
850
|
}
|
|
525
851
|
interface ListMenusResponse {
|
|
526
852
|
/** Retrieved menus. */
|
|
@@ -528,77 +854,10 @@ interface ListMenusResponse {
|
|
|
528
854
|
/** The metadata of the paginated results. */
|
|
529
855
|
pagingMetadata?: CursorPagingMetadata;
|
|
530
856
|
}
|
|
531
|
-
interface CursorPagingMetadata {
|
|
532
|
-
/** Number of items returned in the response. */
|
|
533
|
-
count?: number | null;
|
|
534
|
-
/** Offset that was requested. */
|
|
535
|
-
cursors?: Cursors;
|
|
536
|
-
/**
|
|
537
|
-
* Indicates if there are more results after the current page.
|
|
538
|
-
* If `true`, another page of results can be retrieved.
|
|
539
|
-
* If `false`, this is the last page.
|
|
540
|
-
*/
|
|
541
|
-
hasNext?: boolean | null;
|
|
542
|
-
}
|
|
543
|
-
interface Cursors {
|
|
544
|
-
/** Cursor pointing to next page in the list of results. */
|
|
545
|
-
next?: string | null;
|
|
546
|
-
/** Cursor pointing to previous page in the list of results. */
|
|
547
|
-
prev?: string | null;
|
|
548
|
-
}
|
|
549
857
|
interface QueryMenusRequest {
|
|
550
858
|
/** Query options. */
|
|
551
859
|
query?: CursorQuery;
|
|
552
860
|
}
|
|
553
|
-
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
554
|
-
/** 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`. */
|
|
555
|
-
cursorPaging?: CursorPaging;
|
|
556
|
-
/**
|
|
557
|
-
* Filter object in the following format:
|
|
558
|
-
* `"filter" : {
|
|
559
|
-
* "fieldName1": "value1",
|
|
560
|
-
* "fieldName2":{"$operator":"value2"}
|
|
561
|
-
* }`
|
|
562
|
-
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
|
|
563
|
-
*/
|
|
564
|
-
filter?: Record<string, any> | null;
|
|
565
|
-
/**
|
|
566
|
-
* Sort object in the following format:
|
|
567
|
-
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
568
|
-
*/
|
|
569
|
-
sort?: Sorting[];
|
|
570
|
-
}
|
|
571
|
-
/** @oneof */
|
|
572
|
-
interface CursorQueryPagingMethodOneOf {
|
|
573
|
-
/** 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`. */
|
|
574
|
-
cursorPaging?: CursorPaging;
|
|
575
|
-
}
|
|
576
|
-
interface Sorting {
|
|
577
|
-
/**
|
|
578
|
-
* Name of the field to sort by.
|
|
579
|
-
* @maxLength 512
|
|
580
|
-
*/
|
|
581
|
-
fieldName?: string;
|
|
582
|
-
/** Sort order. */
|
|
583
|
-
order?: SortOrderWithLiterals;
|
|
584
|
-
/**
|
|
585
|
-
* Origin point for geo-distance sorting on a GEO field
|
|
586
|
-
* results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
|
|
587
|
-
*/
|
|
588
|
-
origin?: AddressLocation;
|
|
589
|
-
}
|
|
590
|
-
declare enum SortOrder {
|
|
591
|
-
ASC = "ASC",
|
|
592
|
-
DESC = "DESC"
|
|
593
|
-
}
|
|
594
|
-
/** @enumType */
|
|
595
|
-
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
596
|
-
interface AddressLocation {
|
|
597
|
-
/** Address latitude. */
|
|
598
|
-
latitude?: number | null;
|
|
599
|
-
/** Address longitude. */
|
|
600
|
-
longitude?: number | null;
|
|
601
|
-
}
|
|
602
861
|
interface QueryMenusResponse {
|
|
603
862
|
/** Retrieved menus. */
|
|
604
863
|
menus?: Menu[];
|
|
@@ -696,68 +955,6 @@ interface CloneMenusRequest {
|
|
|
696
955
|
}
|
|
697
956
|
interface CloneMenusResponse {
|
|
698
957
|
}
|
|
699
|
-
interface DomainEvent extends DomainEventBodyOneOf {
|
|
700
|
-
createdEvent?: EntityCreatedEvent;
|
|
701
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
702
|
-
deletedEvent?: EntityDeletedEvent;
|
|
703
|
-
actionEvent?: ActionEvent;
|
|
704
|
-
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
705
|
-
_id?: string;
|
|
706
|
-
/**
|
|
707
|
-
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
708
|
-
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
709
|
-
*/
|
|
710
|
-
entityFqdn?: string;
|
|
711
|
-
/**
|
|
712
|
-
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
713
|
-
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
714
|
-
*/
|
|
715
|
-
slug?: string;
|
|
716
|
-
/** ID of the entity associated with the event. */
|
|
717
|
-
entityId?: string;
|
|
718
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
719
|
-
eventTime?: Date | null;
|
|
720
|
-
/**
|
|
721
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
722
|
-
* (for example, GDPR).
|
|
723
|
-
*/
|
|
724
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
725
|
-
/** If present, indicates the action that triggered the event. */
|
|
726
|
-
originatedFrom?: string | null;
|
|
727
|
-
/**
|
|
728
|
-
* 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.
|
|
729
|
-
* 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.
|
|
730
|
-
*/
|
|
731
|
-
entityEventSequence?: string | null;
|
|
732
|
-
}
|
|
733
|
-
/** @oneof */
|
|
734
|
-
interface DomainEventBodyOneOf {
|
|
735
|
-
createdEvent?: EntityCreatedEvent;
|
|
736
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
737
|
-
deletedEvent?: EntityDeletedEvent;
|
|
738
|
-
actionEvent?: ActionEvent;
|
|
739
|
-
}
|
|
740
|
-
interface EntityCreatedEvent {
|
|
741
|
-
entity?: string;
|
|
742
|
-
}
|
|
743
|
-
interface RestoreInfo {
|
|
744
|
-
deletedDate?: Date | null;
|
|
745
|
-
}
|
|
746
|
-
interface EntityUpdatedEvent {
|
|
747
|
-
/**
|
|
748
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
749
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
750
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
751
|
-
*/
|
|
752
|
-
currentEntity?: string;
|
|
753
|
-
}
|
|
754
|
-
interface EntityDeletedEvent {
|
|
755
|
-
/** Entity that was deleted. */
|
|
756
|
-
deletedEntity?: string | null;
|
|
757
|
-
}
|
|
758
|
-
interface ActionEvent {
|
|
759
|
-
body?: string;
|
|
760
|
-
}
|
|
761
958
|
interface Empty {
|
|
762
959
|
}
|
|
763
960
|
interface SyncContentToMultilingualRequest {
|
|
@@ -769,97 +966,6 @@ interface SyncContentToMultilingualRequest {
|
|
|
769
966
|
}
|
|
770
967
|
interface SyncContentToMultilingualResponse {
|
|
771
968
|
}
|
|
772
|
-
interface MessageEnvelope {
|
|
773
|
-
/**
|
|
774
|
-
* App instance ID.
|
|
775
|
-
* @format GUID
|
|
776
|
-
*/
|
|
777
|
-
instanceId?: string | null;
|
|
778
|
-
/**
|
|
779
|
-
* Event type.
|
|
780
|
-
* @maxLength 150
|
|
781
|
-
*/
|
|
782
|
-
eventType?: string;
|
|
783
|
-
/** The identification type and identity data. */
|
|
784
|
-
identity?: IdentificationData;
|
|
785
|
-
/** Stringify payload. */
|
|
786
|
-
data?: string;
|
|
787
|
-
/** Details related to the account */
|
|
788
|
-
accountInfo?: AccountInfo;
|
|
789
|
-
}
|
|
790
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
791
|
-
/**
|
|
792
|
-
* ID of a site visitor that has not logged in to the site.
|
|
793
|
-
* @format GUID
|
|
794
|
-
*/
|
|
795
|
-
anonymousVisitorId?: string;
|
|
796
|
-
/**
|
|
797
|
-
* ID of a site visitor that has logged in to the site.
|
|
798
|
-
* @format GUID
|
|
799
|
-
*/
|
|
800
|
-
memberId?: string;
|
|
801
|
-
/**
|
|
802
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
803
|
-
* @format GUID
|
|
804
|
-
*/
|
|
805
|
-
wixUserId?: string;
|
|
806
|
-
/**
|
|
807
|
-
* ID of an app.
|
|
808
|
-
* @format GUID
|
|
809
|
-
*/
|
|
810
|
-
appId?: string;
|
|
811
|
-
/** @readonly */
|
|
812
|
-
identityType?: WebhookIdentityTypeWithLiterals;
|
|
813
|
-
}
|
|
814
|
-
/** @oneof */
|
|
815
|
-
interface IdentificationDataIdOneOf {
|
|
816
|
-
/**
|
|
817
|
-
* ID of a site visitor that has not logged in to the site.
|
|
818
|
-
* @format GUID
|
|
819
|
-
*/
|
|
820
|
-
anonymousVisitorId?: string;
|
|
821
|
-
/**
|
|
822
|
-
* ID of a site visitor that has logged in to the site.
|
|
823
|
-
* @format GUID
|
|
824
|
-
*/
|
|
825
|
-
memberId?: string;
|
|
826
|
-
/**
|
|
827
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
828
|
-
* @format GUID
|
|
829
|
-
*/
|
|
830
|
-
wixUserId?: string;
|
|
831
|
-
/**
|
|
832
|
-
* ID of an app.
|
|
833
|
-
* @format GUID
|
|
834
|
-
*/
|
|
835
|
-
appId?: string;
|
|
836
|
-
}
|
|
837
|
-
declare enum WebhookIdentityType {
|
|
838
|
-
UNKNOWN = "UNKNOWN",
|
|
839
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
840
|
-
MEMBER = "MEMBER",
|
|
841
|
-
WIX_USER = "WIX_USER",
|
|
842
|
-
APP = "APP"
|
|
843
|
-
}
|
|
844
|
-
/** @enumType */
|
|
845
|
-
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
846
|
-
interface AccountInfo {
|
|
847
|
-
/**
|
|
848
|
-
* ID of the Wix account associated with the event.
|
|
849
|
-
* @format GUID
|
|
850
|
-
*/
|
|
851
|
-
accountId?: string | null;
|
|
852
|
-
/**
|
|
853
|
-
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
854
|
-
* @format GUID
|
|
855
|
-
*/
|
|
856
|
-
parentAccountId?: string | null;
|
|
857
|
-
/**
|
|
858
|
-
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
859
|
-
* @format GUID
|
|
860
|
-
*/
|
|
861
|
-
siteId?: string | null;
|
|
862
|
-
}
|
|
863
969
|
interface DuplicateMenuRequest {
|
|
864
970
|
/**
|
|
865
971
|
* Menu id to be duplicated.
|
|
@@ -969,6 +1075,21 @@ interface AccountInfoMetadata {
|
|
|
969
1075
|
/** ID of the parent Wix account. Only included when 'accountId' belongs to a child account. */
|
|
970
1076
|
parentAccountId?: string;
|
|
971
1077
|
}
|
|
1078
|
+
interface MenuUpdatedEnvelope {
|
|
1079
|
+
entity: Menu;
|
|
1080
|
+
metadata: EventMetadata;
|
|
1081
|
+
/** @hidden */
|
|
1082
|
+
modifiedFields: Record<string, any>;
|
|
1083
|
+
}
|
|
1084
|
+
/** @permissionScope Manage Restaurants - all permissions
|
|
1085
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1086
|
+
* @permissionId RESTAURANTS.MENU_READ
|
|
1087
|
+
* @webhook
|
|
1088
|
+
* @eventType wix.restaurants.menus.v1.menu_updated
|
|
1089
|
+
* @slug updated
|
|
1090
|
+
* @documentationMaturity preview
|
|
1091
|
+
*/
|
|
1092
|
+
declare function onMenuUpdated(handler: (event: MenuUpdatedEnvelope) => void | Promise<void>): void;
|
|
972
1093
|
interface MenuCreatedEnvelope {
|
|
973
1094
|
entity: Menu;
|
|
974
1095
|
metadata: EventMetadata;
|
|
@@ -998,21 +1119,6 @@ interface MenuDeletedEnvelope {
|
|
|
998
1119
|
* @documentationMaturity preview
|
|
999
1120
|
*/
|
|
1000
1121
|
declare function onMenuDeleted(handler: (event: MenuDeletedEnvelope) => void | Promise<void>): void;
|
|
1001
|
-
interface MenuUpdatedEnvelope {
|
|
1002
|
-
entity: Menu;
|
|
1003
|
-
metadata: EventMetadata;
|
|
1004
|
-
/** @hidden */
|
|
1005
|
-
modifiedFields: Record<string, any>;
|
|
1006
|
-
}
|
|
1007
|
-
/** @permissionScope Manage Restaurants - all permissions
|
|
1008
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1009
|
-
* @permissionId RESTAURANTS.MENU_READ
|
|
1010
|
-
* @webhook
|
|
1011
|
-
* @eventType wix.restaurants.menus.v1.menu_updated
|
|
1012
|
-
* @slug updated
|
|
1013
|
-
* @documentationMaturity preview
|
|
1014
|
-
*/
|
|
1015
|
-
declare function onMenuUpdated(handler: (event: MenuUpdatedEnvelope) => void | Promise<void>): void;
|
|
1016
1122
|
/**
|
|
1017
1123
|
* > **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).
|
|
1018
1124
|
*
|
|
@@ -1448,4 +1554,4 @@ interface QueryMenusSiteUrlOptions {
|
|
|
1448
1554
|
query?: CursorQuery;
|
|
1449
1555
|
}
|
|
1450
1556
|
|
|
1451
|
-
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 };
|
|
1557
|
+
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 MenuExportRow, type MenuQuery, type MenuQuerySpec, type MenuSiteUrl, type MenuUpdatedEnvelope, type MenusDataCloningCompleted, type MenusQueryBuilder, type MenusQueryResult, type MessageEnvelope, type Page, type Pages, type QueryMenuExportRowsRequest, type QueryMenuExportRowsResponse, 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 };
|