@wix/auto_sdk_restaurants_menus 1.0.96 → 1.0.97
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 +27 -27
- package/build/cjs/index.js +215 -215
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +520 -520
- package/build/cjs/index.typings.js +173 -173
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +315 -315
- package/build/cjs/meta.js +146 -146
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +27 -27
- package/build/es/index.mjs +215 -215
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +520 -520
- package/build/es/index.typings.mjs +173 -173
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +315 -315
- package/build/es/meta.mjs +146 -146
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +27 -27
- package/build/internal/cjs/index.typings.d.ts +544 -544
- package/build/internal/cjs/meta.d.ts +483 -483
- package/build/internal/es/index.d.mts +27 -27
- package/build/internal/es/index.typings.d.mts +544 -544
- package/build/internal/es/meta.d.mts +483 -483
- package/package.json +3 -3
|
@@ -283,469 +283,166 @@ interface ExternalReferenceInfo {
|
|
|
283
283
|
/** Whether the connection to the external system is currently active. */
|
|
284
284
|
connected?: boolean | null;
|
|
285
285
|
}
|
|
286
|
-
interface
|
|
286
|
+
interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
287
287
|
/**
|
|
288
|
-
*
|
|
288
|
+
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
289
289
|
* @format GUID
|
|
290
290
|
*/
|
|
291
|
-
|
|
291
|
+
metaSiteId?: string;
|
|
292
292
|
/**
|
|
293
|
-
*
|
|
293
|
+
* Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
|
|
294
294
|
* @format GUID
|
|
295
|
-
* @maxSize 100
|
|
296
|
-
*/
|
|
297
|
-
businessLocationIds?: string[] | null;
|
|
298
|
-
/** Indicates whether sub-entities (such as items) should be duplicated as well. */
|
|
299
|
-
duplicateSubEntities?: boolean | null;
|
|
300
|
-
/**
|
|
301
|
-
* The new name of the duplicated menu.
|
|
302
|
-
* @maxLength 500
|
|
303
|
-
*/
|
|
304
|
-
menuName?: string | null;
|
|
305
|
-
}
|
|
306
|
-
interface DuplicateMenuResponse {
|
|
307
|
-
/** @format GUID */
|
|
308
|
-
menuIds?: string[];
|
|
309
|
-
}
|
|
310
|
-
interface DomainEvent extends DomainEventBodyOneOf {
|
|
311
|
-
createdEvent?: EntityCreatedEvent;
|
|
312
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
313
|
-
deletedEvent?: EntityDeletedEvent;
|
|
314
|
-
actionEvent?: ActionEvent;
|
|
315
|
-
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
316
|
-
_id?: string;
|
|
317
|
-
/**
|
|
318
|
-
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
319
|
-
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
320
|
-
*/
|
|
321
|
-
entityFqdn?: string;
|
|
322
|
-
/**
|
|
323
|
-
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
324
|
-
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
325
295
|
*/
|
|
326
|
-
|
|
327
|
-
/**
|
|
328
|
-
|
|
329
|
-
/**
|
|
330
|
-
|
|
296
|
+
siteId?: string;
|
|
297
|
+
/** Invalidate by App */
|
|
298
|
+
app?: App;
|
|
299
|
+
/** Invalidate by page id */
|
|
300
|
+
page?: Page;
|
|
301
|
+
/** Invalidate by URI path */
|
|
302
|
+
uri?: URI;
|
|
303
|
+
/** Invalidate by file (for media files such as PDFs) */
|
|
304
|
+
file?: File;
|
|
305
|
+
/** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */
|
|
306
|
+
customTag?: CustomTag;
|
|
307
|
+
/** Invalidate by multiple page ids */
|
|
308
|
+
pages?: Pages;
|
|
309
|
+
/** Invalidate by multiple URI paths */
|
|
310
|
+
uris?: URIs;
|
|
331
311
|
/**
|
|
332
|
-
*
|
|
333
|
-
*
|
|
312
|
+
* tell us why you're invalidating the cache. You don't need to add your app name
|
|
313
|
+
* @maxLength 256
|
|
334
314
|
*/
|
|
335
|
-
|
|
336
|
-
/**
|
|
337
|
-
|
|
315
|
+
reason?: string | null;
|
|
316
|
+
/** Is local DS */
|
|
317
|
+
localDc?: boolean;
|
|
318
|
+
hardPurge?: boolean;
|
|
338
319
|
/**
|
|
339
|
-
*
|
|
340
|
-
*
|
|
320
|
+
* Optional caller-provided ID for tracking this invalidation through the system.
|
|
321
|
+
* When set, the corresponding CDN purge completion event will include this ID,
|
|
322
|
+
* allowing you to confirm when the invalidation has fully propagated.
|
|
323
|
+
* Example: generate a UUID, pass it here, and later match it in the CDN purge completion event.
|
|
324
|
+
* @maxLength 256
|
|
341
325
|
*/
|
|
342
|
-
|
|
326
|
+
correlationId?: string | null;
|
|
343
327
|
}
|
|
344
328
|
/** @oneof */
|
|
345
|
-
interface
|
|
346
|
-
createdEvent?: EntityCreatedEvent;
|
|
347
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
348
|
-
deletedEvent?: EntityDeletedEvent;
|
|
349
|
-
actionEvent?: ActionEvent;
|
|
350
|
-
}
|
|
351
|
-
interface EntityCreatedEvent {
|
|
352
|
-
entity?: string;
|
|
353
|
-
}
|
|
354
|
-
interface RestoreInfo {
|
|
355
|
-
deletedDate?: Date | null;
|
|
356
|
-
}
|
|
357
|
-
interface EntityUpdatedEvent {
|
|
358
|
-
/**
|
|
359
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
360
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
361
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
362
|
-
*/
|
|
363
|
-
currentEntity?: string;
|
|
364
|
-
}
|
|
365
|
-
interface EntityDeletedEvent {
|
|
366
|
-
/** Entity that was deleted. */
|
|
367
|
-
deletedEntity?: string | null;
|
|
368
|
-
}
|
|
369
|
-
interface ActionEvent {
|
|
370
|
-
body?: string;
|
|
371
|
-
}
|
|
372
|
-
interface MessageEnvelope {
|
|
329
|
+
interface InvalidateCacheGetByOneOf {
|
|
373
330
|
/**
|
|
374
|
-
*
|
|
331
|
+
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
375
332
|
* @format GUID
|
|
376
333
|
*/
|
|
377
|
-
|
|
334
|
+
metaSiteId?: string;
|
|
378
335
|
/**
|
|
379
|
-
*
|
|
380
|
-
* @
|
|
336
|
+
* Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
|
|
337
|
+
* @format GUID
|
|
381
338
|
*/
|
|
382
|
-
|
|
383
|
-
/**
|
|
384
|
-
|
|
385
|
-
/**
|
|
386
|
-
|
|
387
|
-
/**
|
|
388
|
-
|
|
339
|
+
siteId?: string;
|
|
340
|
+
/** Invalidate by App */
|
|
341
|
+
app?: App;
|
|
342
|
+
/** Invalidate by page id */
|
|
343
|
+
page?: Page;
|
|
344
|
+
/** Invalidate by URI path */
|
|
345
|
+
uri?: URI;
|
|
346
|
+
/** Invalidate by file (for media files such as PDFs) */
|
|
347
|
+
file?: File;
|
|
348
|
+
/** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */
|
|
349
|
+
customTag?: CustomTag;
|
|
350
|
+
/** Invalidate by multiple page ids */
|
|
351
|
+
pages?: Pages;
|
|
352
|
+
/** Invalidate by multiple URI paths */
|
|
353
|
+
uris?: URIs;
|
|
389
354
|
}
|
|
390
|
-
interface
|
|
355
|
+
interface App {
|
|
391
356
|
/**
|
|
392
|
-
*
|
|
393
|
-
* @
|
|
357
|
+
* The AppDefId
|
|
358
|
+
* @minLength 1
|
|
394
359
|
*/
|
|
395
|
-
|
|
360
|
+
appDefId?: string;
|
|
396
361
|
/**
|
|
397
|
-
*
|
|
362
|
+
* The instance Id
|
|
398
363
|
* @format GUID
|
|
399
364
|
*/
|
|
400
|
-
|
|
365
|
+
instanceId?: string;
|
|
366
|
+
}
|
|
367
|
+
interface Page {
|
|
401
368
|
/**
|
|
402
|
-
*
|
|
369
|
+
* the msid the page is on
|
|
403
370
|
* @format GUID
|
|
404
371
|
*/
|
|
405
|
-
|
|
372
|
+
metaSiteId?: string;
|
|
406
373
|
/**
|
|
407
|
-
*
|
|
408
|
-
* @
|
|
374
|
+
* Invalidate by Page ID
|
|
375
|
+
* @minLength 1
|
|
409
376
|
*/
|
|
410
|
-
|
|
411
|
-
/** @readonly */
|
|
412
|
-
identityType?: WebhookIdentityTypeWithLiterals;
|
|
377
|
+
pageId?: string;
|
|
413
378
|
}
|
|
414
|
-
|
|
415
|
-
interface IdentificationDataIdOneOf {
|
|
379
|
+
interface URI {
|
|
416
380
|
/**
|
|
417
|
-
*
|
|
381
|
+
* the msid the URI is on
|
|
418
382
|
* @format GUID
|
|
419
383
|
*/
|
|
420
|
-
|
|
384
|
+
metaSiteId?: string;
|
|
421
385
|
/**
|
|
422
|
-
*
|
|
423
|
-
* @
|
|
386
|
+
* URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes
|
|
387
|
+
* @minLength 1
|
|
424
388
|
*/
|
|
425
|
-
|
|
389
|
+
uriPath?: string;
|
|
390
|
+
}
|
|
391
|
+
interface File {
|
|
426
392
|
/**
|
|
427
|
-
*
|
|
393
|
+
* the msid the file is related to
|
|
428
394
|
* @format GUID
|
|
429
395
|
*/
|
|
430
|
-
|
|
396
|
+
metaSiteId?: string;
|
|
431
397
|
/**
|
|
432
|
-
*
|
|
433
|
-
* @
|
|
398
|
+
* Invalidate by filename (for media files such as PDFs)
|
|
399
|
+
* @minLength 1
|
|
400
|
+
* @maxLength 256
|
|
434
401
|
*/
|
|
435
|
-
|
|
436
|
-
}
|
|
437
|
-
declare enum WebhookIdentityType {
|
|
438
|
-
UNKNOWN = "UNKNOWN",
|
|
439
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
440
|
-
MEMBER = "MEMBER",
|
|
441
|
-
WIX_USER = "WIX_USER",
|
|
442
|
-
APP = "APP"
|
|
402
|
+
fileName?: string;
|
|
443
403
|
}
|
|
444
|
-
|
|
445
|
-
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
446
|
-
interface AccountInfo {
|
|
404
|
+
interface CustomTag {
|
|
447
405
|
/**
|
|
448
|
-
*
|
|
406
|
+
* the msid the tag is related to
|
|
449
407
|
* @format GUID
|
|
450
408
|
*/
|
|
451
|
-
|
|
409
|
+
metaSiteId?: string;
|
|
452
410
|
/**
|
|
453
|
-
*
|
|
454
|
-
* @
|
|
411
|
+
* Tag to invalidate by
|
|
412
|
+
* @minLength 1
|
|
413
|
+
* @maxLength 256
|
|
455
414
|
*/
|
|
456
|
-
|
|
415
|
+
tag?: string;
|
|
416
|
+
}
|
|
417
|
+
interface Pages {
|
|
457
418
|
/**
|
|
458
|
-
*
|
|
419
|
+
* the msid the pages are on
|
|
459
420
|
* @format GUID
|
|
460
421
|
*/
|
|
461
|
-
|
|
422
|
+
metaSiteId?: string;
|
|
423
|
+
/**
|
|
424
|
+
* Invalidate by multiple Page IDs in a single message
|
|
425
|
+
* @maxSize 100
|
|
426
|
+
* @minLength 1
|
|
427
|
+
*/
|
|
428
|
+
pageIds?: string[];
|
|
462
429
|
}
|
|
463
|
-
interface
|
|
430
|
+
interface URIs {
|
|
464
431
|
/**
|
|
465
|
-
*
|
|
432
|
+
* the msid the URIs are on
|
|
466
433
|
* @format GUID
|
|
467
|
-
* @readonly
|
|
468
434
|
*/
|
|
469
|
-
|
|
470
|
-
}
|
|
471
|
-
interface GetMenuSiteUrlResponse {
|
|
472
|
-
/** Retrieved menuInfo with path url. */
|
|
473
|
-
menuSiteUrl?: MenuSiteUrl;
|
|
474
|
-
}
|
|
475
|
-
interface MenuSiteUrl {
|
|
435
|
+
metaSiteId?: string;
|
|
476
436
|
/**
|
|
477
|
-
*
|
|
437
|
+
* URI paths to invalidate (e.g. page/my/path) - without leading/trailing slashes
|
|
438
|
+
* @maxSize 100
|
|
478
439
|
* @minLength 1
|
|
479
|
-
* @maxLength 1000
|
|
480
440
|
*/
|
|
481
|
-
|
|
441
|
+
uriPaths?: string[];
|
|
482
442
|
}
|
|
483
|
-
interface
|
|
484
|
-
/**
|
|
485
|
-
|
|
486
|
-
}
|
|
487
|
-
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
488
|
-
/** 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`. */
|
|
489
|
-
cursorPaging?: CursorPaging;
|
|
490
|
-
/**
|
|
491
|
-
* Filter object in the following format:
|
|
492
|
-
* `"filter" : {
|
|
493
|
-
* "fieldName1": "value1",
|
|
494
|
-
* "fieldName2":{"$operator":"value2"}
|
|
495
|
-
* }`
|
|
496
|
-
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
|
|
497
|
-
*/
|
|
498
|
-
filter?: Record<string, any> | null;
|
|
499
|
-
/**
|
|
500
|
-
* Sort object in the following format:
|
|
501
|
-
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
502
|
-
*/
|
|
503
|
-
sort?: Sorting[];
|
|
504
|
-
}
|
|
505
|
-
/** @oneof */
|
|
506
|
-
interface CursorQueryPagingMethodOneOf {
|
|
507
|
-
/** 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`. */
|
|
508
|
-
cursorPaging?: CursorPaging;
|
|
509
|
-
}
|
|
510
|
-
interface Sorting {
|
|
511
|
-
/**
|
|
512
|
-
* Name of the field to sort by.
|
|
513
|
-
* @maxLength 512
|
|
514
|
-
*/
|
|
515
|
-
fieldName?: string;
|
|
516
|
-
/** Sort order. */
|
|
517
|
-
order?: SortOrderWithLiterals;
|
|
518
|
-
/**
|
|
519
|
-
* When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
|
|
520
|
-
* a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
|
|
521
|
-
*
|
|
522
|
-
* If multiple filters are provided, they are combined with AND operator.
|
|
523
|
-
*
|
|
524
|
-
* Example:
|
|
525
|
-
* Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
|
|
526
|
-
* and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
|
|
527
|
-
* { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
|
|
528
|
-
* @internal
|
|
529
|
-
* @maxSize 10
|
|
530
|
-
*/
|
|
531
|
-
selectItemsBy?: Record<string, any>[] | null;
|
|
532
|
-
/**
|
|
533
|
-
* Origin point for geo-distance sorting on a GEO field
|
|
534
|
-
* results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
|
|
535
|
-
*/
|
|
536
|
-
origin?: AddressLocation;
|
|
537
|
-
}
|
|
538
|
-
declare enum SortOrder {
|
|
539
|
-
ASC = "ASC",
|
|
540
|
-
DESC = "DESC"
|
|
541
|
-
}
|
|
542
|
-
/** @enumType */
|
|
543
|
-
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
544
|
-
interface AddressLocation {
|
|
545
|
-
/** Address latitude. */
|
|
546
|
-
latitude?: number | null;
|
|
547
|
-
/** Address longitude. */
|
|
548
|
-
longitude?: number | null;
|
|
549
|
-
}
|
|
550
|
-
interface CursorPaging {
|
|
551
|
-
/**
|
|
552
|
-
* Number of items to load.
|
|
553
|
-
* @max 500
|
|
554
|
-
*/
|
|
555
|
-
limit?: number | null;
|
|
556
|
-
/**
|
|
557
|
-
* Pointer to the next or previous page in the list of results.
|
|
558
|
-
*
|
|
559
|
-
* You can get the relevant cursor token
|
|
560
|
-
* from the `pagingMetadata` object in the previous call's response.
|
|
561
|
-
* Not relevant for the first request.
|
|
562
|
-
*/
|
|
563
|
-
cursor?: string | null;
|
|
564
|
-
}
|
|
565
|
-
interface QueryMenusSiteUrlResponse {
|
|
566
|
-
/** Retrieved menuInfos with path urls. */
|
|
567
|
-
menuSiteUrls?: MenuSiteUrl[];
|
|
568
|
-
/** The metadata of the paginated results. */
|
|
569
|
-
pagingMetadata?: CursorPagingMetadata;
|
|
570
|
-
}
|
|
571
|
-
interface CursorPagingMetadata {
|
|
572
|
-
/** Number of items returned in the response. */
|
|
573
|
-
count?: number | null;
|
|
574
|
-
/** Offset that was requested. */
|
|
575
|
-
cursors?: Cursors;
|
|
576
|
-
/**
|
|
577
|
-
* Indicates if there are more results after the current page.
|
|
578
|
-
* If `true`, another page of results can be retrieved.
|
|
579
|
-
* If `false`, this is the last page.
|
|
580
|
-
*/
|
|
581
|
-
hasNext?: boolean | null;
|
|
582
|
-
}
|
|
583
|
-
interface Cursors {
|
|
584
|
-
/** Cursor pointing to next page in the list of results. */
|
|
585
|
-
next?: string | null;
|
|
586
|
-
/** Cursor pointing to previous page in the list of results. */
|
|
587
|
-
prev?: string | null;
|
|
588
|
-
}
|
|
589
|
-
interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
590
|
-
/**
|
|
591
|
-
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
592
|
-
* @format GUID
|
|
593
|
-
*/
|
|
594
|
-
metaSiteId?: string;
|
|
595
|
-
/**
|
|
596
|
-
* Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
|
|
597
|
-
* @format GUID
|
|
598
|
-
*/
|
|
599
|
-
siteId?: string;
|
|
600
|
-
/** Invalidate by App */
|
|
601
|
-
app?: App;
|
|
602
|
-
/** Invalidate by page id */
|
|
603
|
-
page?: Page;
|
|
604
|
-
/** Invalidate by URI path */
|
|
605
|
-
uri?: URI;
|
|
606
|
-
/** Invalidate by file (for media files such as PDFs) */
|
|
607
|
-
file?: File;
|
|
608
|
-
/** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */
|
|
609
|
-
customTag?: CustomTag;
|
|
610
|
-
/** Invalidate by multiple page ids */
|
|
611
|
-
pages?: Pages;
|
|
612
|
-
/** Invalidate by multiple URI paths */
|
|
613
|
-
uris?: URIs;
|
|
614
|
-
/**
|
|
615
|
-
* tell us why you're invalidating the cache. You don't need to add your app name
|
|
616
|
-
* @maxLength 256
|
|
617
|
-
*/
|
|
618
|
-
reason?: string | null;
|
|
619
|
-
/** Is local DS */
|
|
620
|
-
localDc?: boolean;
|
|
621
|
-
hardPurge?: boolean;
|
|
622
|
-
/**
|
|
623
|
-
* Optional caller-provided ID for tracking this invalidation through the system.
|
|
624
|
-
* When set, the corresponding CDN purge completion event will include this ID,
|
|
625
|
-
* allowing you to confirm when the invalidation has fully propagated.
|
|
626
|
-
* Example: generate a UUID, pass it here, and later match it in the CDN purge completion event.
|
|
627
|
-
* @maxLength 256
|
|
628
|
-
*/
|
|
629
|
-
correlationId?: string | null;
|
|
630
|
-
}
|
|
631
|
-
/** @oneof */
|
|
632
|
-
interface InvalidateCacheGetByOneOf {
|
|
633
|
-
/**
|
|
634
|
-
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
635
|
-
* @format GUID
|
|
636
|
-
*/
|
|
637
|
-
metaSiteId?: string;
|
|
638
|
-
/**
|
|
639
|
-
* Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
|
|
640
|
-
* @format GUID
|
|
641
|
-
*/
|
|
642
|
-
siteId?: string;
|
|
643
|
-
/** Invalidate by App */
|
|
644
|
-
app?: App;
|
|
645
|
-
/** Invalidate by page id */
|
|
646
|
-
page?: Page;
|
|
647
|
-
/** Invalidate by URI path */
|
|
648
|
-
uri?: URI;
|
|
649
|
-
/** Invalidate by file (for media files such as PDFs) */
|
|
650
|
-
file?: File;
|
|
651
|
-
/** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */
|
|
652
|
-
customTag?: CustomTag;
|
|
653
|
-
/** Invalidate by multiple page ids */
|
|
654
|
-
pages?: Pages;
|
|
655
|
-
/** Invalidate by multiple URI paths */
|
|
656
|
-
uris?: URIs;
|
|
657
|
-
}
|
|
658
|
-
interface App {
|
|
659
|
-
/**
|
|
660
|
-
* The AppDefId
|
|
661
|
-
* @minLength 1
|
|
662
|
-
*/
|
|
663
|
-
appDefId?: string;
|
|
664
|
-
/**
|
|
665
|
-
* The instance Id
|
|
666
|
-
* @format GUID
|
|
667
|
-
*/
|
|
668
|
-
instanceId?: string;
|
|
669
|
-
}
|
|
670
|
-
interface Page {
|
|
671
|
-
/**
|
|
672
|
-
* the msid the page is on
|
|
673
|
-
* @format GUID
|
|
674
|
-
*/
|
|
675
|
-
metaSiteId?: string;
|
|
676
|
-
/**
|
|
677
|
-
* Invalidate by Page ID
|
|
678
|
-
* @minLength 1
|
|
679
|
-
*/
|
|
680
|
-
pageId?: string;
|
|
681
|
-
}
|
|
682
|
-
interface URI {
|
|
683
|
-
/**
|
|
684
|
-
* the msid the URI is on
|
|
685
|
-
* @format GUID
|
|
686
|
-
*/
|
|
687
|
-
metaSiteId?: string;
|
|
688
|
-
/**
|
|
689
|
-
* URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes
|
|
690
|
-
* @minLength 1
|
|
691
|
-
*/
|
|
692
|
-
uriPath?: string;
|
|
693
|
-
}
|
|
694
|
-
interface File {
|
|
695
|
-
/**
|
|
696
|
-
* the msid the file is related to
|
|
697
|
-
* @format GUID
|
|
698
|
-
*/
|
|
699
|
-
metaSiteId?: string;
|
|
700
|
-
/**
|
|
701
|
-
* Invalidate by filename (for media files such as PDFs)
|
|
702
|
-
* @minLength 1
|
|
703
|
-
* @maxLength 256
|
|
704
|
-
*/
|
|
705
|
-
fileName?: string;
|
|
706
|
-
}
|
|
707
|
-
interface CustomTag {
|
|
708
|
-
/**
|
|
709
|
-
* the msid the tag is related to
|
|
710
|
-
* @format GUID
|
|
711
|
-
*/
|
|
712
|
-
metaSiteId?: string;
|
|
713
|
-
/**
|
|
714
|
-
* Tag to invalidate by
|
|
715
|
-
* @minLength 1
|
|
716
|
-
* @maxLength 256
|
|
717
|
-
*/
|
|
718
|
-
tag?: string;
|
|
719
|
-
}
|
|
720
|
-
interface Pages {
|
|
721
|
-
/**
|
|
722
|
-
* the msid the pages are on
|
|
723
|
-
* @format GUID
|
|
724
|
-
*/
|
|
725
|
-
metaSiteId?: string;
|
|
726
|
-
/**
|
|
727
|
-
* Invalidate by multiple Page IDs in a single message
|
|
728
|
-
* @maxSize 100
|
|
729
|
-
* @minLength 1
|
|
730
|
-
*/
|
|
731
|
-
pageIds?: string[];
|
|
732
|
-
}
|
|
733
|
-
interface URIs {
|
|
734
|
-
/**
|
|
735
|
-
* the msid the URIs are on
|
|
736
|
-
* @format GUID
|
|
737
|
-
*/
|
|
738
|
-
metaSiteId?: string;
|
|
739
|
-
/**
|
|
740
|
-
* URI paths to invalidate (e.g. page/my/path) - without leading/trailing slashes
|
|
741
|
-
* @maxSize 100
|
|
742
|
-
* @minLength 1
|
|
743
|
-
*/
|
|
744
|
-
uriPaths?: string[];
|
|
745
|
-
}
|
|
746
|
-
interface DeleteOrphanSections {
|
|
747
|
-
/** Menu id */
|
|
748
|
-
menuId?: string;
|
|
443
|
+
interface DeleteOrphanSections {
|
|
444
|
+
/** Menu id */
|
|
445
|
+
menuId?: string;
|
|
749
446
|
}
|
|
750
447
|
interface MenusDataCloningCompleted {
|
|
751
448
|
}
|
|
@@ -827,16 +524,112 @@ interface ListMenusRequest {
|
|
|
827
524
|
/** Whether to return only menus that are visible to site visitors. */
|
|
828
525
|
onlyVisible?: boolean | null;
|
|
829
526
|
}
|
|
830
|
-
interface
|
|
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 {
|
|
831
543
|
/** Retrieved menus. */
|
|
832
544
|
menus?: Menu[];
|
|
833
545
|
/** The metadata of the paginated results. */
|
|
834
546
|
pagingMetadata?: CursorPagingMetadata;
|
|
835
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
|
+
}
|
|
836
566
|
interface QueryMenusRequest {
|
|
837
567
|
/** Query options. */
|
|
838
568
|
query?: CursorQuery;
|
|
839
569
|
}
|
|
570
|
+
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
571
|
+
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
572
|
+
cursorPaging?: CursorPaging;
|
|
573
|
+
/**
|
|
574
|
+
* Filter object in the following format:
|
|
575
|
+
* `"filter" : {
|
|
576
|
+
* "fieldName1": "value1",
|
|
577
|
+
* "fieldName2":{"$operator":"value2"}
|
|
578
|
+
* }`
|
|
579
|
+
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
|
|
580
|
+
*/
|
|
581
|
+
filter?: Record<string, any> | null;
|
|
582
|
+
/**
|
|
583
|
+
* Sort object in the following format:
|
|
584
|
+
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
585
|
+
*/
|
|
586
|
+
sort?: Sorting[];
|
|
587
|
+
}
|
|
588
|
+
/** @oneof */
|
|
589
|
+
interface CursorQueryPagingMethodOneOf {
|
|
590
|
+
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
591
|
+
cursorPaging?: CursorPaging;
|
|
592
|
+
}
|
|
593
|
+
interface Sorting {
|
|
594
|
+
/**
|
|
595
|
+
* Name of the field to sort by.
|
|
596
|
+
* @maxLength 512
|
|
597
|
+
*/
|
|
598
|
+
fieldName?: string;
|
|
599
|
+
/** Sort order. */
|
|
600
|
+
order?: SortOrderWithLiterals;
|
|
601
|
+
/**
|
|
602
|
+
* When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
|
|
603
|
+
* a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
|
|
604
|
+
*
|
|
605
|
+
* If multiple filters are provided, they are combined with AND operator.
|
|
606
|
+
*
|
|
607
|
+
* Example:
|
|
608
|
+
* Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
|
|
609
|
+
* and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
|
|
610
|
+
* { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
|
|
611
|
+
* @internal
|
|
612
|
+
* @maxSize 10
|
|
613
|
+
*/
|
|
614
|
+
selectItemsBy?: Record<string, any>[] | null;
|
|
615
|
+
/**
|
|
616
|
+
* Origin point for geo-distance sorting on a GEO field
|
|
617
|
+
* results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
|
|
618
|
+
*/
|
|
619
|
+
origin?: AddressLocation;
|
|
620
|
+
}
|
|
621
|
+
declare enum SortOrder {
|
|
622
|
+
ASC = "ASC",
|
|
623
|
+
DESC = "DESC"
|
|
624
|
+
}
|
|
625
|
+
/** @enumType */
|
|
626
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
627
|
+
interface AddressLocation {
|
|
628
|
+
/** Address latitude. */
|
|
629
|
+
latitude?: number | null;
|
|
630
|
+
/** Address longitude. */
|
|
631
|
+
longitude?: number | null;
|
|
632
|
+
}
|
|
840
633
|
interface QueryMenusResponse {
|
|
841
634
|
/** Retrieved menus. */
|
|
842
635
|
menus?: Menu[];
|
|
@@ -847,108 +640,315 @@ interface UpdateMenuRequest {
|
|
|
847
640
|
/** Menu to update. */
|
|
848
641
|
menu: Menu;
|
|
849
642
|
/**
|
|
850
|
-
* Explicit list of fields to update.
|
|
851
|
-
* @internal
|
|
643
|
+
* Explicit list of fields to update.
|
|
644
|
+
* @internal
|
|
645
|
+
*/
|
|
646
|
+
mask?: string[];
|
|
647
|
+
}
|
|
648
|
+
interface UpdateMenuResponse {
|
|
649
|
+
/** Updated menu. */
|
|
650
|
+
menu?: Menu;
|
|
651
|
+
}
|
|
652
|
+
interface BulkUpdateMenuRequest {
|
|
653
|
+
/**
|
|
654
|
+
* Menus to update.
|
|
655
|
+
* @minSize 1
|
|
656
|
+
* @maxSize 100
|
|
657
|
+
*/
|
|
658
|
+
menus: MaskedMenu[];
|
|
659
|
+
/** Whether to receive the entity in the response. */
|
|
660
|
+
returnEntity?: boolean;
|
|
661
|
+
}
|
|
662
|
+
interface MaskedMenu {
|
|
663
|
+
/** Menu to updated. */
|
|
664
|
+
menu?: Menu;
|
|
665
|
+
/** Explicit list of fields to update. */
|
|
666
|
+
mask?: string[];
|
|
667
|
+
}
|
|
668
|
+
interface BulkUpdateMenuResponse {
|
|
669
|
+
/**
|
|
670
|
+
* Results of bulk menu update.
|
|
671
|
+
* @minSize 1
|
|
672
|
+
* @maxSize 100
|
|
673
|
+
*/
|
|
674
|
+
results?: BulkMenuResult[];
|
|
675
|
+
/** Metadata for the API call. */
|
|
676
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
677
|
+
}
|
|
678
|
+
interface BulkMenuResult {
|
|
679
|
+
/** Metadata for menu update. */
|
|
680
|
+
menuMetadata?: ItemMetadata;
|
|
681
|
+
/** Updated menu. Only returned if `returnEntity` is set to `true`. */
|
|
682
|
+
menu?: Menu;
|
|
683
|
+
}
|
|
684
|
+
interface UpdateExtendedFieldsRequest {
|
|
685
|
+
/** ID of the entity to update. */
|
|
686
|
+
_id: string;
|
|
687
|
+
/** Identifier for the app whose extended fields are being updated. */
|
|
688
|
+
namespace: string;
|
|
689
|
+
/** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
|
|
690
|
+
namespaceData: Record<string, any> | null;
|
|
691
|
+
}
|
|
692
|
+
interface UpdateExtendedFieldsResponse {
|
|
693
|
+
/** Namespace of the app. */
|
|
694
|
+
namespace?: string;
|
|
695
|
+
/** Updated extended fields data. */
|
|
696
|
+
namespaceData?: Record<string, any> | null;
|
|
697
|
+
}
|
|
698
|
+
interface DeleteMenuRequest {
|
|
699
|
+
/**
|
|
700
|
+
* Menu ID.
|
|
701
|
+
* @format GUID
|
|
702
|
+
*/
|
|
703
|
+
menuId: string;
|
|
704
|
+
}
|
|
705
|
+
interface DeleteMenuResponse {
|
|
706
|
+
}
|
|
707
|
+
interface RunMenusMultiLocationMigrationRequest {
|
|
708
|
+
/**
|
|
709
|
+
* business location id
|
|
710
|
+
* @format GUID
|
|
711
|
+
*/
|
|
712
|
+
businessLocationId?: string;
|
|
713
|
+
}
|
|
714
|
+
interface RunMenusMultiLocationMigrationResponse {
|
|
715
|
+
/** Whether menus multi-location migration finished successfully */
|
|
716
|
+
success?: boolean;
|
|
717
|
+
}
|
|
718
|
+
interface UpdateBusinessLocationIdRequest {
|
|
719
|
+
/** @format GUID */
|
|
720
|
+
menuId?: string;
|
|
721
|
+
/** @format GUID */
|
|
722
|
+
businessLocationId?: string | null;
|
|
723
|
+
}
|
|
724
|
+
interface UpdateBusinessLocationIdResponse {
|
|
725
|
+
}
|
|
726
|
+
interface CloneMenusRequest {
|
|
727
|
+
/**
|
|
728
|
+
* The MetaSiteId to clone from.
|
|
729
|
+
* @format GUID
|
|
730
|
+
*/
|
|
731
|
+
metaSiteId?: string;
|
|
732
|
+
}
|
|
733
|
+
interface CloneMenusResponse {
|
|
734
|
+
}
|
|
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
|
+
interface Empty {
|
|
798
|
+
}
|
|
799
|
+
interface SyncContentToMultilingualRequest {
|
|
800
|
+
/**
|
|
801
|
+
* MetaSite ID
|
|
802
|
+
* @format GUID
|
|
803
|
+
*/
|
|
804
|
+
metaSiteId?: string;
|
|
805
|
+
}
|
|
806
|
+
interface SyncContentToMultilingualResponse {
|
|
807
|
+
}
|
|
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
|
|
852
870
|
*/
|
|
853
|
-
|
|
871
|
+
appId?: string;
|
|
854
872
|
}
|
|
855
|
-
|
|
856
|
-
|
|
857
|
-
|
|
873
|
+
declare enum WebhookIdentityType {
|
|
874
|
+
UNKNOWN = "UNKNOWN",
|
|
875
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
876
|
+
MEMBER = "MEMBER",
|
|
877
|
+
WIX_USER = "WIX_USER",
|
|
878
|
+
APP = "APP"
|
|
858
879
|
}
|
|
859
|
-
|
|
880
|
+
/** @enumType */
|
|
881
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
882
|
+
interface AccountInfo {
|
|
860
883
|
/**
|
|
861
|
-
*
|
|
862
|
-
* @
|
|
863
|
-
* @maxSize 100
|
|
884
|
+
* ID of the Wix account associated with the event.
|
|
885
|
+
* @format GUID
|
|
864
886
|
*/
|
|
865
|
-
|
|
866
|
-
/** Whether to receive the entity in the response. */
|
|
867
|
-
returnEntity?: boolean;
|
|
868
|
-
}
|
|
869
|
-
interface MaskedMenu {
|
|
870
|
-
/** Menu to updated. */
|
|
871
|
-
menu?: Menu;
|
|
872
|
-
/** Explicit list of fields to update. */
|
|
873
|
-
mask?: string[];
|
|
874
|
-
}
|
|
875
|
-
interface BulkUpdateMenuResponse {
|
|
887
|
+
accountId?: string | null;
|
|
876
888
|
/**
|
|
877
|
-
*
|
|
878
|
-
* @
|
|
879
|
-
* @maxSize 100
|
|
889
|
+
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
890
|
+
* @format GUID
|
|
880
891
|
*/
|
|
881
|
-
|
|
882
|
-
/** Metadata for the API call. */
|
|
883
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
884
|
-
}
|
|
885
|
-
interface BulkMenuResult {
|
|
886
|
-
/** Metadata for menu update. */
|
|
887
|
-
menuMetadata?: ItemMetadata;
|
|
888
|
-
/** Updated menu. Only returned if `returnEntity` is set to `true`. */
|
|
889
|
-
menu?: Menu;
|
|
890
|
-
}
|
|
891
|
-
interface UpdateExtendedFieldsRequest {
|
|
892
|
-
/** ID of the entity to update. */
|
|
893
|
-
_id: string;
|
|
894
|
-
/** Identifier for the app whose extended fields are being updated. */
|
|
895
|
-
namespace: string;
|
|
896
|
-
/** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
|
|
897
|
-
namespaceData: Record<string, any> | null;
|
|
898
|
-
}
|
|
899
|
-
interface UpdateExtendedFieldsResponse {
|
|
900
|
-
/** Namespace of the app. */
|
|
901
|
-
namespace?: string;
|
|
902
|
-
/** Updated extended fields data. */
|
|
903
|
-
namespaceData?: Record<string, any> | null;
|
|
904
|
-
}
|
|
905
|
-
interface DeleteMenuRequest {
|
|
892
|
+
parentAccountId?: string | null;
|
|
906
893
|
/**
|
|
907
|
-
*
|
|
894
|
+
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
908
895
|
* @format GUID
|
|
909
896
|
*/
|
|
910
|
-
|
|
911
|
-
}
|
|
912
|
-
interface DeleteMenuResponse {
|
|
897
|
+
siteId?: string | null;
|
|
913
898
|
}
|
|
914
|
-
interface
|
|
899
|
+
interface DuplicateMenuRequest {
|
|
915
900
|
/**
|
|
916
|
-
*
|
|
901
|
+
* Menu id to be duplicated.
|
|
917
902
|
* @format GUID
|
|
918
903
|
*/
|
|
919
|
-
|
|
920
|
-
|
|
921
|
-
|
|
922
|
-
|
|
923
|
-
|
|
904
|
+
_id: string;
|
|
905
|
+
/**
|
|
906
|
+
* Business location ids to duplicate the menu to.
|
|
907
|
+
* @format GUID
|
|
908
|
+
* @maxSize 100
|
|
909
|
+
*/
|
|
910
|
+
businessLocationIds?: string[] | null;
|
|
911
|
+
/** Indicates whether sub-entities (such as items) should be duplicated as well. */
|
|
912
|
+
duplicateSubEntities?: boolean | null;
|
|
913
|
+
/**
|
|
914
|
+
* The new name of the duplicated menu.
|
|
915
|
+
* @maxLength 500
|
|
916
|
+
*/
|
|
917
|
+
menuName?: string | null;
|
|
924
918
|
}
|
|
925
|
-
interface
|
|
926
|
-
/** @format GUID */
|
|
927
|
-
menuId?: string;
|
|
919
|
+
interface DuplicateMenuResponse {
|
|
928
920
|
/** @format GUID */
|
|
929
|
-
|
|
930
|
-
}
|
|
931
|
-
interface UpdateBusinessLocationIdResponse {
|
|
921
|
+
menuIds?: string[];
|
|
932
922
|
}
|
|
933
|
-
interface
|
|
923
|
+
interface GetMenuSiteUrlRequest {
|
|
934
924
|
/**
|
|
935
|
-
*
|
|
925
|
+
* Menu ID.
|
|
936
926
|
* @format GUID
|
|
927
|
+
* @readonly
|
|
937
928
|
*/
|
|
938
|
-
|
|
939
|
-
}
|
|
940
|
-
interface CloneMenusResponse {
|
|
929
|
+
_id: string | null;
|
|
941
930
|
}
|
|
942
|
-
interface
|
|
931
|
+
interface GetMenuSiteUrlResponse {
|
|
932
|
+
/** Retrieved menuInfo with path url. */
|
|
933
|
+
menuSiteUrl?: MenuSiteUrl;
|
|
943
934
|
}
|
|
944
|
-
interface
|
|
935
|
+
interface MenuSiteUrl {
|
|
945
936
|
/**
|
|
946
|
-
*
|
|
947
|
-
* @
|
|
937
|
+
* Path URL.
|
|
938
|
+
* @minLength 1
|
|
939
|
+
* @maxLength 1000
|
|
948
940
|
*/
|
|
949
|
-
|
|
941
|
+
path?: string;
|
|
950
942
|
}
|
|
951
|
-
interface
|
|
943
|
+
interface QueryMenusSiteUrlRequest {
|
|
944
|
+
/** Query options */
|
|
945
|
+
query?: CursorQuery;
|
|
946
|
+
}
|
|
947
|
+
interface QueryMenusSiteUrlResponse {
|
|
948
|
+
/** Retrieved menuInfos with path urls. */
|
|
949
|
+
menuSiteUrls?: MenuSiteUrl[];
|
|
950
|
+
/** The metadata of the paginated results. */
|
|
951
|
+
pagingMetadata?: CursorPagingMetadata;
|
|
952
952
|
}
|
|
953
953
|
interface BaseEventMetadata {
|
|
954
954
|
/**
|
|
@@ -1005,21 +1005,6 @@ interface AccountInfoMetadata {
|
|
|
1005
1005
|
/** ID of the parent Wix account. Only included when 'accountId' belongs to a child account. */
|
|
1006
1006
|
parentAccountId?: string;
|
|
1007
1007
|
}
|
|
1008
|
-
interface MenuUpdatedEnvelope {
|
|
1009
|
-
entity: Menu;
|
|
1010
|
-
metadata: EventMetadata;
|
|
1011
|
-
/** @hidden */
|
|
1012
|
-
modifiedFields: Record<string, any>;
|
|
1013
|
-
}
|
|
1014
|
-
/** @permissionScope Manage Restaurants - all permissions
|
|
1015
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1016
|
-
* @permissionId RESTAURANTS.MENU_READ
|
|
1017
|
-
* @webhook
|
|
1018
|
-
* @eventType wix.restaurants.menus.v1.menu_updated
|
|
1019
|
-
* @slug updated
|
|
1020
|
-
* @documentationMaturity preview
|
|
1021
|
-
*/
|
|
1022
|
-
declare function onMenuUpdated(handler: (event: MenuUpdatedEnvelope) => void | Promise<void>): void;
|
|
1023
1008
|
interface MenuCreatedEnvelope {
|
|
1024
1009
|
entity: Menu;
|
|
1025
1010
|
metadata: EventMetadata;
|
|
@@ -1049,54 +1034,21 @@ interface MenuDeletedEnvelope {
|
|
|
1049
1034
|
* @documentationMaturity preview
|
|
1050
1035
|
*/
|
|
1051
1036
|
declare function onMenuDeleted(handler: (event: MenuDeletedEnvelope) => void | Promise<void>): void;
|
|
1052
|
-
|
|
1053
|
-
|
|
1054
|
-
|
|
1055
|
-
|
|
1056
|
-
|
|
1057
|
-
* @applicableIdentity APP
|
|
1058
|
-
* @fqn com.wixpress.restaurants.menus_menu.v1.restaurants_duplicate_menu.RestaurantsDuplicateMenu.DuplicateMenu
|
|
1059
|
-
*/
|
|
1060
|
-
declare function duplicateMenu(_id: string, options?: DuplicateMenuOptions): Promise<NonNullablePaths<DuplicateMenuResponse, `menuIds`, 0>>;
|
|
1061
|
-
interface DuplicateMenuOptions {
|
|
1062
|
-
/**
|
|
1063
|
-
* Business location ids to duplicate the menu to.
|
|
1064
|
-
* @format GUID
|
|
1065
|
-
* @maxSize 100
|
|
1066
|
-
*/
|
|
1067
|
-
businessLocationIds?: string[] | null;
|
|
1068
|
-
/** Indicates whether sub-entities (such as items) should be duplicated as well. */
|
|
1069
|
-
duplicateSubEntities?: boolean | null;
|
|
1070
|
-
/**
|
|
1071
|
-
* The new name of the duplicated menu.
|
|
1072
|
-
* @maxLength 500
|
|
1073
|
-
*/
|
|
1074
|
-
menuName?: string | null;
|
|
1037
|
+
interface MenuUpdatedEnvelope {
|
|
1038
|
+
entity: Menu;
|
|
1039
|
+
metadata: EventMetadata;
|
|
1040
|
+
/** @hidden */
|
|
1041
|
+
modifiedFields: Record<string, any>;
|
|
1075
1042
|
}
|
|
1076
|
-
/**
|
|
1077
|
-
*
|
|
1078
|
-
* @param _id - Menu ID.
|
|
1079
|
-
* @public
|
|
1080
|
-
* @documentationMaturity preview
|
|
1081
|
-
* @requiredField _id
|
|
1043
|
+
/** @permissionScope Manage Restaurants - all permissions
|
|
1044
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1082
1045
|
* @permissionId RESTAURANTS.MENU_READ
|
|
1083
|
-
* @
|
|
1084
|
-
* @
|
|
1085
|
-
|
|
1086
|
-
declare function getMenuSiteUrl(_id: string): Promise<NonNullablePaths<GetMenuSiteUrlResponse, `menuSiteUrl.path`, 1>>;
|
|
1087
|
-
/**
|
|
1088
|
-
* Query menu details and path URL
|
|
1089
|
-
* @public
|
|
1046
|
+
* @webhook
|
|
1047
|
+
* @eventType wix.restaurants.menus.v1.menu_updated
|
|
1048
|
+
* @slug updated
|
|
1090
1049
|
* @documentationMaturity preview
|
|
1091
|
-
* @permissionId RESTAURANTS.MENU_READ
|
|
1092
|
-
* @applicableIdentity APP
|
|
1093
|
-
* @fqn com.wixpress.restaurants.menus_menu.v1.restaurants_menus_site_url.RestaurantsMenusSiteUrl.QueryMenusSiteUrl
|
|
1094
1050
|
*/
|
|
1095
|
-
declare function
|
|
1096
|
-
interface QueryMenusSiteUrlOptions {
|
|
1097
|
-
/** Query options */
|
|
1098
|
-
query?: CursorQuery;
|
|
1099
|
-
}
|
|
1051
|
+
declare function onMenuUpdated(handler: (event: MenuUpdatedEnvelope) => void | Promise<void>): void;
|
|
1100
1052
|
/**
|
|
1101
1053
|
* > **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).
|
|
1102
1054
|
*
|
|
@@ -1514,5 +1466,53 @@ interface UpdateExtendedFieldsOptions {
|
|
|
1514
1466
|
* @fqn com.wixpress.restaurants.menus_menu.v1.RestaurantsMenusMenu.DeleteMenu
|
|
1515
1467
|
*/
|
|
1516
1468
|
declare function deleteMenu(menuId: string): Promise<void>;
|
|
1469
|
+
/** @param _id - Menu id to be duplicated.
|
|
1470
|
+
* @public
|
|
1471
|
+
* @documentationMaturity preview
|
|
1472
|
+
* @requiredField _id
|
|
1473
|
+
* @permissionId RESTAURANTS.MENU_CREATE
|
|
1474
|
+
* @applicableIdentity APP
|
|
1475
|
+
* @fqn com.wixpress.restaurants.menus_menu.v1.restaurants_duplicate_menu.RestaurantsDuplicateMenu.DuplicateMenu
|
|
1476
|
+
*/
|
|
1477
|
+
declare function duplicateMenu(_id: string, options?: DuplicateMenuOptions): Promise<NonNullablePaths<DuplicateMenuResponse, `menuIds`, 0>>;
|
|
1478
|
+
interface DuplicateMenuOptions {
|
|
1479
|
+
/**
|
|
1480
|
+
* Business location ids to duplicate the menu to.
|
|
1481
|
+
* @format GUID
|
|
1482
|
+
* @maxSize 100
|
|
1483
|
+
*/
|
|
1484
|
+
businessLocationIds?: string[] | null;
|
|
1485
|
+
/** Indicates whether sub-entities (such as items) should be duplicated as well. */
|
|
1486
|
+
duplicateSubEntities?: boolean | null;
|
|
1487
|
+
/**
|
|
1488
|
+
* The new name of the duplicated menu.
|
|
1489
|
+
* @maxLength 500
|
|
1490
|
+
*/
|
|
1491
|
+
menuName?: string | null;
|
|
1492
|
+
}
|
|
1493
|
+
/**
|
|
1494
|
+
* Get menu details and path URL by menu ID.
|
|
1495
|
+
* @param _id - Menu ID.
|
|
1496
|
+
* @public
|
|
1497
|
+
* @documentationMaturity preview
|
|
1498
|
+
* @requiredField _id
|
|
1499
|
+
* @permissionId RESTAURANTS.MENU_READ
|
|
1500
|
+
* @applicableIdentity APP
|
|
1501
|
+
* @fqn com.wixpress.restaurants.menus_menu.v1.restaurants_menus_site_url.RestaurantsMenusSiteUrl.GetMenuSiteUrl
|
|
1502
|
+
*/
|
|
1503
|
+
declare function getMenuSiteUrl(_id: string): Promise<NonNullablePaths<GetMenuSiteUrlResponse, `menuSiteUrl.path`, 1>>;
|
|
1504
|
+
/**
|
|
1505
|
+
* Query menu details and path URL
|
|
1506
|
+
* @public
|
|
1507
|
+
* @documentationMaturity preview
|
|
1508
|
+
* @permissionId RESTAURANTS.MENU_READ
|
|
1509
|
+
* @applicableIdentity APP
|
|
1510
|
+
* @fqn com.wixpress.restaurants.menus_menu.v1.restaurants_menus_site_url.RestaurantsMenusSiteUrl.QueryMenusSiteUrl
|
|
1511
|
+
*/
|
|
1512
|
+
declare function queryMenusSiteUrl(options?: QueryMenusSiteUrlOptions): Promise<NonNullablePaths<QueryMenusSiteUrlResponse, `menuSiteUrls` | `menuSiteUrls.${number}.path`, 2>>;
|
|
1513
|
+
interface QueryMenusSiteUrlOptions {
|
|
1514
|
+
/** Query options */
|
|
1515
|
+
query?: CursorQuery;
|
|
1516
|
+
}
|
|
1517
1517
|
|
|
1518
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 };
|