@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
|
@@ -283,6 +283,361 @@ 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
|
+
entity?: string;
|
|
531
|
+
}
|
|
532
|
+
interface RestoreInfo {
|
|
533
|
+
deletedDate?: Date | null;
|
|
534
|
+
}
|
|
535
|
+
interface EntityUpdatedEvent {
|
|
536
|
+
/**
|
|
537
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
538
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
539
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
540
|
+
*/
|
|
541
|
+
currentEntity?: string;
|
|
542
|
+
}
|
|
543
|
+
interface EntityDeletedEvent {
|
|
544
|
+
/** Entity that was deleted. */
|
|
545
|
+
deletedEntity?: string | null;
|
|
546
|
+
}
|
|
547
|
+
interface ActionEvent {
|
|
548
|
+
body?: string;
|
|
549
|
+
}
|
|
550
|
+
interface MessageEnvelope {
|
|
551
|
+
/**
|
|
552
|
+
* App instance ID.
|
|
553
|
+
* @format GUID
|
|
554
|
+
*/
|
|
555
|
+
instanceId?: string | null;
|
|
556
|
+
/**
|
|
557
|
+
* Event type.
|
|
558
|
+
* @maxLength 150
|
|
559
|
+
*/
|
|
560
|
+
eventType?: string;
|
|
561
|
+
/** The identification type and identity data. */
|
|
562
|
+
identity?: IdentificationData;
|
|
563
|
+
/** Stringify payload. */
|
|
564
|
+
data?: string;
|
|
565
|
+
/** Details related to the account */
|
|
566
|
+
accountInfo?: AccountInfo;
|
|
567
|
+
}
|
|
568
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
569
|
+
/**
|
|
570
|
+
* ID of a site visitor that has not logged in to the site.
|
|
571
|
+
* @format GUID
|
|
572
|
+
*/
|
|
573
|
+
anonymousVisitorId?: string;
|
|
574
|
+
/**
|
|
575
|
+
* ID of a site visitor that has logged in to the site.
|
|
576
|
+
* @format GUID
|
|
577
|
+
*/
|
|
578
|
+
memberId?: string;
|
|
579
|
+
/**
|
|
580
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
581
|
+
* @format GUID
|
|
582
|
+
*/
|
|
583
|
+
wixUserId?: string;
|
|
584
|
+
/**
|
|
585
|
+
* ID of an app.
|
|
586
|
+
* @format GUID
|
|
587
|
+
*/
|
|
588
|
+
appId?: string;
|
|
589
|
+
/** @readonly */
|
|
590
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
591
|
+
}
|
|
592
|
+
/** @oneof */
|
|
593
|
+
interface IdentificationDataIdOneOf {
|
|
594
|
+
/**
|
|
595
|
+
* ID of a site visitor that has not logged in to the site.
|
|
596
|
+
* @format GUID
|
|
597
|
+
*/
|
|
598
|
+
anonymousVisitorId?: string;
|
|
599
|
+
/**
|
|
600
|
+
* ID of a site visitor that has logged in to the site.
|
|
601
|
+
* @format GUID
|
|
602
|
+
*/
|
|
603
|
+
memberId?: string;
|
|
604
|
+
/**
|
|
605
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
606
|
+
* @format GUID
|
|
607
|
+
*/
|
|
608
|
+
wixUserId?: string;
|
|
609
|
+
/**
|
|
610
|
+
* ID of an app.
|
|
611
|
+
* @format GUID
|
|
612
|
+
*/
|
|
613
|
+
appId?: string;
|
|
614
|
+
}
|
|
615
|
+
declare enum WebhookIdentityType {
|
|
616
|
+
UNKNOWN = "UNKNOWN",
|
|
617
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
618
|
+
MEMBER = "MEMBER",
|
|
619
|
+
WIX_USER = "WIX_USER",
|
|
620
|
+
APP = "APP"
|
|
621
|
+
}
|
|
622
|
+
/** @enumType */
|
|
623
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
624
|
+
interface AccountInfo {
|
|
625
|
+
/**
|
|
626
|
+
* ID of the Wix account associated with the event.
|
|
627
|
+
* @format GUID
|
|
628
|
+
*/
|
|
629
|
+
accountId?: string | null;
|
|
630
|
+
/**
|
|
631
|
+
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
632
|
+
* @format GUID
|
|
633
|
+
*/
|
|
634
|
+
parentAccountId?: string | null;
|
|
635
|
+
/**
|
|
636
|
+
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
637
|
+
* @format GUID
|
|
638
|
+
*/
|
|
639
|
+
siteId?: string | null;
|
|
640
|
+
}
|
|
286
641
|
interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
287
642
|
/**
|
|
288
643
|
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
@@ -489,146 +844,50 @@ interface ApplicationError {
|
|
|
489
844
|
/** Error code. */
|
|
490
845
|
code?: string;
|
|
491
846
|
/** Description of the error. */
|
|
492
|
-
description?: string;
|
|
493
|
-
/** Data related to the error. */
|
|
494
|
-
data?: Record<string, any> | null;
|
|
495
|
-
}
|
|
496
|
-
interface BulkActionMetadata {
|
|
497
|
-
/** Number of items that were successfully processed. */
|
|
498
|
-
totalSuccesses?: number;
|
|
499
|
-
/** Number of items that couldn't be processed. */
|
|
500
|
-
totalFailures?: number;
|
|
501
|
-
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
502
|
-
undetailedFailures?: number;
|
|
503
|
-
}
|
|
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[];
|
|
847
|
+
description?: string;
|
|
848
|
+
/** Data related to the error. */
|
|
849
|
+
data?: Record<string, any> | null;
|
|
587
850
|
}
|
|
588
|
-
|
|
589
|
-
|
|
590
|
-
|
|
591
|
-
|
|
851
|
+
interface BulkActionMetadata {
|
|
852
|
+
/** Number of items that were successfully processed. */
|
|
853
|
+
totalSuccesses?: number;
|
|
854
|
+
/** Number of items that couldn't be processed. */
|
|
855
|
+
totalFailures?: number;
|
|
856
|
+
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
857
|
+
undetailedFailures?: number;
|
|
592
858
|
}
|
|
593
|
-
interface
|
|
594
|
-
/**
|
|
595
|
-
* Name of the field to sort by.
|
|
596
|
-
* @maxLength 512
|
|
597
|
-
*/
|
|
598
|
-
fieldName?: string;
|
|
599
|
-
/** Sort order. */
|
|
600
|
-
order?: SortOrderWithLiterals;
|
|
859
|
+
interface GetMenuRequest {
|
|
601
860
|
/**
|
|
602
|
-
*
|
|
603
|
-
*
|
|
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
|
|
861
|
+
* Menu ID.
|
|
862
|
+
* @format GUID
|
|
613
863
|
*/
|
|
614
|
-
|
|
864
|
+
menuId: string;
|
|
865
|
+
}
|
|
866
|
+
interface GetMenuResponse {
|
|
867
|
+
/** Menu. */
|
|
868
|
+
menu?: Menu;
|
|
869
|
+
}
|
|
870
|
+
interface ListMenusRequest {
|
|
615
871
|
/**
|
|
616
|
-
*
|
|
617
|
-
*
|
|
872
|
+
* Menu IDs.
|
|
873
|
+
* @format GUID
|
|
874
|
+
* @maxSize 500
|
|
618
875
|
*/
|
|
619
|
-
|
|
876
|
+
menuIds?: string[];
|
|
877
|
+
/** The metadata of the paginated results. */
|
|
878
|
+
paging?: CursorPaging;
|
|
879
|
+
/** Whether to return only menus that are visible to site visitors. */
|
|
880
|
+
onlyVisible?: boolean | null;
|
|
620
881
|
}
|
|
621
|
-
|
|
622
|
-
|
|
623
|
-
|
|
882
|
+
interface ListMenusResponse {
|
|
883
|
+
/** Retrieved menus. */
|
|
884
|
+
menus?: Menu[];
|
|
885
|
+
/** The metadata of the paginated results. */
|
|
886
|
+
pagingMetadata?: CursorPagingMetadata;
|
|
624
887
|
}
|
|
625
|
-
|
|
626
|
-
|
|
627
|
-
|
|
628
|
-
/** Address latitude. */
|
|
629
|
-
latitude?: number | null;
|
|
630
|
-
/** Address longitude. */
|
|
631
|
-
longitude?: number | null;
|
|
888
|
+
interface QueryMenusRequest {
|
|
889
|
+
/** Query options. */
|
|
890
|
+
query?: CursorQuery;
|
|
632
891
|
}
|
|
633
892
|
interface QueryMenusResponse {
|
|
634
893
|
/** Retrieved menus. */
|
|
@@ -732,68 +991,6 @@ interface CloneMenusRequest {
|
|
|
732
991
|
}
|
|
733
992
|
interface CloneMenusResponse {
|
|
734
993
|
}
|
|
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
|
-
entity?: string;
|
|
778
|
-
}
|
|
779
|
-
interface RestoreInfo {
|
|
780
|
-
deletedDate?: Date | null;
|
|
781
|
-
}
|
|
782
|
-
interface EntityUpdatedEvent {
|
|
783
|
-
/**
|
|
784
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
785
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
786
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
787
|
-
*/
|
|
788
|
-
currentEntity?: string;
|
|
789
|
-
}
|
|
790
|
-
interface EntityDeletedEvent {
|
|
791
|
-
/** Entity that was deleted. */
|
|
792
|
-
deletedEntity?: string | null;
|
|
793
|
-
}
|
|
794
|
-
interface ActionEvent {
|
|
795
|
-
body?: string;
|
|
796
|
-
}
|
|
797
994
|
interface Empty {
|
|
798
995
|
}
|
|
799
996
|
interface SyncContentToMultilingualRequest {
|
|
@@ -805,97 +1002,6 @@ interface SyncContentToMultilingualRequest {
|
|
|
805
1002
|
}
|
|
806
1003
|
interface SyncContentToMultilingualResponse {
|
|
807
1004
|
}
|
|
808
|
-
interface MessageEnvelope {
|
|
809
|
-
/**
|
|
810
|
-
* App instance ID.
|
|
811
|
-
* @format GUID
|
|
812
|
-
*/
|
|
813
|
-
instanceId?: string | null;
|
|
814
|
-
/**
|
|
815
|
-
* Event type.
|
|
816
|
-
* @maxLength 150
|
|
817
|
-
*/
|
|
818
|
-
eventType?: string;
|
|
819
|
-
/** The identification type and identity data. */
|
|
820
|
-
identity?: IdentificationData;
|
|
821
|
-
/** Stringify payload. */
|
|
822
|
-
data?: string;
|
|
823
|
-
/** Details related to the account */
|
|
824
|
-
accountInfo?: AccountInfo;
|
|
825
|
-
}
|
|
826
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
827
|
-
/**
|
|
828
|
-
* ID of a site visitor that has not logged in to the site.
|
|
829
|
-
* @format GUID
|
|
830
|
-
*/
|
|
831
|
-
anonymousVisitorId?: string;
|
|
832
|
-
/**
|
|
833
|
-
* ID of a site visitor that has logged in to the site.
|
|
834
|
-
* @format GUID
|
|
835
|
-
*/
|
|
836
|
-
memberId?: string;
|
|
837
|
-
/**
|
|
838
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
839
|
-
* @format GUID
|
|
840
|
-
*/
|
|
841
|
-
wixUserId?: string;
|
|
842
|
-
/**
|
|
843
|
-
* ID of an app.
|
|
844
|
-
* @format GUID
|
|
845
|
-
*/
|
|
846
|
-
appId?: string;
|
|
847
|
-
/** @readonly */
|
|
848
|
-
identityType?: WebhookIdentityTypeWithLiterals;
|
|
849
|
-
}
|
|
850
|
-
/** @oneof */
|
|
851
|
-
interface IdentificationDataIdOneOf {
|
|
852
|
-
/**
|
|
853
|
-
* ID of a site visitor that has not logged in to the site.
|
|
854
|
-
* @format GUID
|
|
855
|
-
*/
|
|
856
|
-
anonymousVisitorId?: string;
|
|
857
|
-
/**
|
|
858
|
-
* ID of a site visitor that has logged in to the site.
|
|
859
|
-
* @format GUID
|
|
860
|
-
*/
|
|
861
|
-
memberId?: string;
|
|
862
|
-
/**
|
|
863
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
864
|
-
* @format GUID
|
|
865
|
-
*/
|
|
866
|
-
wixUserId?: string;
|
|
867
|
-
/**
|
|
868
|
-
* ID of an app.
|
|
869
|
-
* @format GUID
|
|
870
|
-
*/
|
|
871
|
-
appId?: string;
|
|
872
|
-
}
|
|
873
|
-
declare enum WebhookIdentityType {
|
|
874
|
-
UNKNOWN = "UNKNOWN",
|
|
875
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
876
|
-
MEMBER = "MEMBER",
|
|
877
|
-
WIX_USER = "WIX_USER",
|
|
878
|
-
APP = "APP"
|
|
879
|
-
}
|
|
880
|
-
/** @enumType */
|
|
881
|
-
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
882
|
-
interface AccountInfo {
|
|
883
|
-
/**
|
|
884
|
-
* ID of the Wix account associated with the event.
|
|
885
|
-
* @format GUID
|
|
886
|
-
*/
|
|
887
|
-
accountId?: string | null;
|
|
888
|
-
/**
|
|
889
|
-
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
890
|
-
* @format GUID
|
|
891
|
-
*/
|
|
892
|
-
parentAccountId?: string | null;
|
|
893
|
-
/**
|
|
894
|
-
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
895
|
-
* @format GUID
|
|
896
|
-
*/
|
|
897
|
-
siteId?: string | null;
|
|
898
|
-
}
|
|
899
1005
|
interface DuplicateMenuRequest {
|
|
900
1006
|
/**
|
|
901
1007
|
* Menu id to be duplicated.
|
|
@@ -1005,6 +1111,21 @@ interface AccountInfoMetadata {
|
|
|
1005
1111
|
/** ID of the parent Wix account. Only included when 'accountId' belongs to a child account. */
|
|
1006
1112
|
parentAccountId?: string;
|
|
1007
1113
|
}
|
|
1114
|
+
interface MenuUpdatedEnvelope {
|
|
1115
|
+
entity: Menu;
|
|
1116
|
+
metadata: EventMetadata;
|
|
1117
|
+
/** @hidden */
|
|
1118
|
+
modifiedFields: Record<string, any>;
|
|
1119
|
+
}
|
|
1120
|
+
/** @permissionScope Manage Restaurants - all permissions
|
|
1121
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1122
|
+
* @permissionId RESTAURANTS.MENU_READ
|
|
1123
|
+
* @webhook
|
|
1124
|
+
* @eventType wix.restaurants.menus.v1.menu_updated
|
|
1125
|
+
* @slug updated
|
|
1126
|
+
* @documentationMaturity preview
|
|
1127
|
+
*/
|
|
1128
|
+
declare function onMenuUpdated(handler: (event: MenuUpdatedEnvelope) => void | Promise<void>): void;
|
|
1008
1129
|
interface MenuCreatedEnvelope {
|
|
1009
1130
|
entity: Menu;
|
|
1010
1131
|
metadata: EventMetadata;
|
|
@@ -1034,21 +1155,6 @@ interface MenuDeletedEnvelope {
|
|
|
1034
1155
|
* @documentationMaturity preview
|
|
1035
1156
|
*/
|
|
1036
1157
|
declare function onMenuDeleted(handler: (event: MenuDeletedEnvelope) => void | Promise<void>): void;
|
|
1037
|
-
interface MenuUpdatedEnvelope {
|
|
1038
|
-
entity: Menu;
|
|
1039
|
-
metadata: EventMetadata;
|
|
1040
|
-
/** @hidden */
|
|
1041
|
-
modifiedFields: Record<string, any>;
|
|
1042
|
-
}
|
|
1043
|
-
/** @permissionScope Manage Restaurants - all permissions
|
|
1044
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1045
|
-
* @permissionId RESTAURANTS.MENU_READ
|
|
1046
|
-
* @webhook
|
|
1047
|
-
* @eventType wix.restaurants.menus.v1.menu_updated
|
|
1048
|
-
* @slug updated
|
|
1049
|
-
* @documentationMaturity preview
|
|
1050
|
-
*/
|
|
1051
|
-
declare function onMenuUpdated(handler: (event: MenuUpdatedEnvelope) => void | Promise<void>): void;
|
|
1052
1158
|
/**
|
|
1053
1159
|
* > **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).
|
|
1054
1160
|
*
|
|
@@ -1515,4 +1621,4 @@ interface QueryMenusSiteUrlOptions {
|
|
|
1515
1621
|
query?: CursorQuery;
|
|
1516
1622
|
}
|
|
1517
1623
|
|
|
1518
|
-
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 };
|
|
1624
|
+
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 };
|