@wix/auto_sdk_restaurants_menus 1.0.95 → 1.0.96
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 +514 -514
- package/build/cjs/index.typings.js +173 -173
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +319 -319
- 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 +514 -514
- package/build/es/index.typings.mjs +173 -173
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +319 -319
- 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 +518 -518
- package/build/internal/cjs/meta.d.ts +484 -484
- package/build/internal/es/index.d.mts +27 -27
- package/build/internal/es/index.typings.d.mts +518 -518
- package/build/internal/es/meta.d.mts +484 -484
- package/package.json +2 -2
|
@@ -283,289 +283,206 @@ 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 DuplicateMenuRequest {
|
|
287
287
|
/**
|
|
288
|
-
*
|
|
288
|
+
* Menu id to be duplicated.
|
|
289
289
|
* @format GUID
|
|
290
290
|
*/
|
|
291
|
-
|
|
291
|
+
_id: string;
|
|
292
292
|
/**
|
|
293
|
-
*
|
|
293
|
+
* Business location ids to duplicate the menu to.
|
|
294
294
|
* @format GUID
|
|
295
|
+
* @maxSize 100
|
|
295
296
|
*/
|
|
296
|
-
|
|
297
|
-
/**
|
|
298
|
-
|
|
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;
|
|
297
|
+
businessLocationIds?: string[] | null;
|
|
298
|
+
/** Indicates whether sub-entities (such as items) should be duplicated as well. */
|
|
299
|
+
duplicateSubEntities?: boolean | null;
|
|
311
300
|
/**
|
|
312
|
-
*
|
|
313
|
-
* @maxLength
|
|
301
|
+
* The new name of the duplicated menu.
|
|
302
|
+
* @maxLength 500
|
|
314
303
|
*/
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
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;
|
|
319
317
|
/**
|
|
320
|
-
*
|
|
321
|
-
*
|
|
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
|
|
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`.
|
|
325
320
|
*/
|
|
326
|
-
|
|
327
|
-
}
|
|
328
|
-
/** @oneof */
|
|
329
|
-
interface InvalidateCacheGetByOneOf {
|
|
321
|
+
entityFqdn?: string;
|
|
330
322
|
/**
|
|
331
|
-
*
|
|
332
|
-
*
|
|
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`.
|
|
333
325
|
*/
|
|
334
|
-
|
|
326
|
+
slug?: string;
|
|
327
|
+
/** ID of the entity associated with the event. */
|
|
328
|
+
entityId?: string;
|
|
329
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
330
|
+
eventTime?: Date | null;
|
|
335
331
|
/**
|
|
336
|
-
*
|
|
337
|
-
*
|
|
332
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
333
|
+
* (for example, GDPR).
|
|
338
334
|
*/
|
|
339
|
-
|
|
340
|
-
/**
|
|
341
|
-
|
|
342
|
-
/**
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
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;
|
|
335
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
336
|
+
/** If present, indicates the action that triggered the event. */
|
|
337
|
+
originatedFrom?: string | null;
|
|
338
|
+
/**
|
|
339
|
+
* 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.
|
|
340
|
+
* 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.
|
|
341
|
+
*/
|
|
342
|
+
entityEventSequence?: string | null;
|
|
354
343
|
}
|
|
355
|
-
|
|
344
|
+
/** @oneof */
|
|
345
|
+
interface DomainEventBodyOneOf {
|
|
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 {
|
|
356
358
|
/**
|
|
357
|
-
*
|
|
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.
|
|
359
362
|
*/
|
|
360
|
-
|
|
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 {
|
|
361
373
|
/**
|
|
362
|
-
*
|
|
374
|
+
* App instance ID.
|
|
363
375
|
* @format GUID
|
|
364
376
|
*/
|
|
365
|
-
instanceId?: string;
|
|
377
|
+
instanceId?: string | null;
|
|
378
|
+
/**
|
|
379
|
+
* Event type.
|
|
380
|
+
* @maxLength 150
|
|
381
|
+
*/
|
|
382
|
+
eventType?: string;
|
|
383
|
+
/** The identification type and identity data. */
|
|
384
|
+
identity?: IdentificationData;
|
|
385
|
+
/** Stringify payload. */
|
|
386
|
+
data?: string;
|
|
387
|
+
/** Details related to the account */
|
|
388
|
+
accountInfo?: AccountInfo;
|
|
366
389
|
}
|
|
367
|
-
interface
|
|
390
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
368
391
|
/**
|
|
369
|
-
*
|
|
392
|
+
* ID of a site visitor that has not logged in to the site.
|
|
370
393
|
* @format GUID
|
|
371
394
|
*/
|
|
372
|
-
|
|
395
|
+
anonymousVisitorId?: string;
|
|
373
396
|
/**
|
|
374
|
-
*
|
|
375
|
-
* @
|
|
397
|
+
* ID of a site visitor that has logged in to the site.
|
|
398
|
+
* @format GUID
|
|
376
399
|
*/
|
|
377
|
-
|
|
378
|
-
}
|
|
379
|
-
interface URI {
|
|
400
|
+
memberId?: string;
|
|
380
401
|
/**
|
|
381
|
-
*
|
|
402
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
382
403
|
* @format GUID
|
|
383
404
|
*/
|
|
384
|
-
|
|
405
|
+
wixUserId?: string;
|
|
385
406
|
/**
|
|
386
|
-
*
|
|
387
|
-
* @
|
|
407
|
+
* ID of an app.
|
|
408
|
+
* @format GUID
|
|
388
409
|
*/
|
|
389
|
-
|
|
410
|
+
appId?: string;
|
|
411
|
+
/** @readonly */
|
|
412
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
390
413
|
}
|
|
391
|
-
|
|
414
|
+
/** @oneof */
|
|
415
|
+
interface IdentificationDataIdOneOf {
|
|
392
416
|
/**
|
|
393
|
-
*
|
|
417
|
+
* ID of a site visitor that has not logged in to the site.
|
|
394
418
|
* @format GUID
|
|
395
419
|
*/
|
|
396
|
-
|
|
420
|
+
anonymousVisitorId?: string;
|
|
397
421
|
/**
|
|
398
|
-
*
|
|
399
|
-
* @
|
|
400
|
-
* @maxLength 256
|
|
422
|
+
* ID of a site visitor that has logged in to the site.
|
|
423
|
+
* @format GUID
|
|
401
424
|
*/
|
|
402
|
-
|
|
403
|
-
}
|
|
404
|
-
interface CustomTag {
|
|
425
|
+
memberId?: string;
|
|
405
426
|
/**
|
|
406
|
-
*
|
|
427
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
407
428
|
* @format GUID
|
|
408
429
|
*/
|
|
409
|
-
|
|
430
|
+
wixUserId?: string;
|
|
410
431
|
/**
|
|
411
|
-
*
|
|
412
|
-
* @
|
|
413
|
-
* @maxLength 256
|
|
432
|
+
* ID of an app.
|
|
433
|
+
* @format GUID
|
|
414
434
|
*/
|
|
415
|
-
|
|
435
|
+
appId?: string;
|
|
416
436
|
}
|
|
417
|
-
|
|
437
|
+
declare enum WebhookIdentityType {
|
|
438
|
+
UNKNOWN = "UNKNOWN",
|
|
439
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
440
|
+
MEMBER = "MEMBER",
|
|
441
|
+
WIX_USER = "WIX_USER",
|
|
442
|
+
APP = "APP"
|
|
443
|
+
}
|
|
444
|
+
/** @enumType */
|
|
445
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
446
|
+
interface AccountInfo {
|
|
418
447
|
/**
|
|
419
|
-
*
|
|
448
|
+
* ID of the Wix account associated with the event.
|
|
420
449
|
* @format GUID
|
|
421
450
|
*/
|
|
422
|
-
|
|
451
|
+
accountId?: string | null;
|
|
423
452
|
/**
|
|
424
|
-
*
|
|
425
|
-
* @
|
|
426
|
-
* @minLength 1
|
|
453
|
+
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
454
|
+
* @format GUID
|
|
427
455
|
*/
|
|
428
|
-
|
|
429
|
-
}
|
|
430
|
-
interface URIs {
|
|
456
|
+
parentAccountId?: string | null;
|
|
431
457
|
/**
|
|
432
|
-
* the
|
|
458
|
+
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
433
459
|
* @format GUID
|
|
434
460
|
*/
|
|
435
|
-
|
|
461
|
+
siteId?: string | null;
|
|
462
|
+
}
|
|
463
|
+
interface GetMenuSiteUrlRequest {
|
|
436
464
|
/**
|
|
437
|
-
*
|
|
438
|
-
* @
|
|
439
|
-
* @
|
|
465
|
+
* Menu ID.
|
|
466
|
+
* @format GUID
|
|
467
|
+
* @readonly
|
|
440
468
|
*/
|
|
441
|
-
|
|
469
|
+
_id: string | null;
|
|
442
470
|
}
|
|
443
|
-
interface
|
|
444
|
-
/**
|
|
445
|
-
|
|
471
|
+
interface GetMenuSiteUrlResponse {
|
|
472
|
+
/** Retrieved menuInfo with path url. */
|
|
473
|
+
menuSiteUrl?: MenuSiteUrl;
|
|
446
474
|
}
|
|
447
|
-
interface
|
|
475
|
+
interface MenuSiteUrl {
|
|
476
|
+
/**
|
|
477
|
+
* Path URL.
|
|
478
|
+
* @minLength 1
|
|
479
|
+
* @maxLength 1000
|
|
480
|
+
*/
|
|
481
|
+
path?: string;
|
|
448
482
|
}
|
|
449
|
-
interface
|
|
450
|
-
/**
|
|
451
|
-
|
|
452
|
-
}
|
|
453
|
-
interface CreateMenuResponse {
|
|
454
|
-
/** Menu. */
|
|
455
|
-
menu?: Menu;
|
|
456
|
-
}
|
|
457
|
-
interface BulkCreateMenusRequest {
|
|
458
|
-
/**
|
|
459
|
-
* Menu details.
|
|
460
|
-
* @maxSize 100
|
|
461
|
-
*/
|
|
462
|
-
menus: Menu[];
|
|
463
|
-
/** Whether to receive the created menus in the response. */
|
|
464
|
-
returnEntity?: boolean;
|
|
465
|
-
}
|
|
466
|
-
interface BulkCreateMenusResponse {
|
|
467
|
-
/** Information about the created menus. */
|
|
468
|
-
results?: BulkCreateMenuResult[];
|
|
469
|
-
/** Metadata for the API call. */
|
|
470
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
471
|
-
}
|
|
472
|
-
interface BulkCreateMenuResult {
|
|
473
|
-
/** Whether to receive the created menus in the response. */
|
|
474
|
-
menuMetadata?: ItemMetadata;
|
|
475
|
-
/** Created menu. */
|
|
476
|
-
menu?: Menu;
|
|
477
|
-
}
|
|
478
|
-
interface ItemMetadata {
|
|
479
|
-
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
480
|
-
_id?: string | null;
|
|
481
|
-
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
482
|
-
originalIndex?: number;
|
|
483
|
-
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
484
|
-
success?: boolean;
|
|
485
|
-
/** Details about the error in case of failure. */
|
|
486
|
-
error?: ApplicationError;
|
|
487
|
-
}
|
|
488
|
-
interface ApplicationError {
|
|
489
|
-
/** Error code. */
|
|
490
|
-
code?: string;
|
|
491
|
-
/** 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;
|
|
483
|
+
interface QueryMenusSiteUrlRequest {
|
|
484
|
+
/** Query options */
|
|
485
|
+
query?: CursorQuery;
|
|
569
486
|
}
|
|
570
487
|
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
571
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`. */
|
|
@@ -630,325 +547,408 @@ interface AddressLocation {
|
|
|
630
547
|
/** Address longitude. */
|
|
631
548
|
longitude?: number | null;
|
|
632
549
|
}
|
|
633
|
-
interface
|
|
634
|
-
/** Retrieved menus. */
|
|
635
|
-
menus?: Menu[];
|
|
636
|
-
/** The metadata of the paginated results. */
|
|
637
|
-
pagingMetadata?: CursorPagingMetadata;
|
|
638
|
-
}
|
|
639
|
-
interface UpdateMenuRequest {
|
|
640
|
-
/** Menu to update. */
|
|
641
|
-
menu: Menu;
|
|
550
|
+
interface CursorPaging {
|
|
642
551
|
/**
|
|
643
|
-
*
|
|
644
|
-
* @
|
|
552
|
+
* Number of items to load.
|
|
553
|
+
* @max 500
|
|
645
554
|
*/
|
|
646
|
-
|
|
647
|
-
}
|
|
648
|
-
interface UpdateMenuResponse {
|
|
649
|
-
/** Updated menu. */
|
|
650
|
-
menu?: Menu;
|
|
651
|
-
}
|
|
652
|
-
interface BulkUpdateMenuRequest {
|
|
555
|
+
limit?: number | null;
|
|
653
556
|
/**
|
|
654
|
-
*
|
|
655
|
-
*
|
|
656
|
-
*
|
|
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.
|
|
657
562
|
*/
|
|
658
|
-
|
|
659
|
-
/** Whether to receive the entity in the response. */
|
|
660
|
-
returnEntity?: boolean;
|
|
563
|
+
cursor?: string | null;
|
|
661
564
|
}
|
|
662
|
-
interface
|
|
663
|
-
/**
|
|
664
|
-
|
|
665
|
-
/**
|
|
666
|
-
|
|
565
|
+
interface QueryMenusSiteUrlResponse {
|
|
566
|
+
/** Retrieved menuInfos with path urls. */
|
|
567
|
+
menuSiteUrls?: MenuSiteUrl[];
|
|
568
|
+
/** The metadata of the paginated results. */
|
|
569
|
+
pagingMetadata?: CursorPagingMetadata;
|
|
667
570
|
}
|
|
668
|
-
interface
|
|
571
|
+
interface CursorPagingMetadata {
|
|
572
|
+
/** Number of items returned in the response. */
|
|
573
|
+
count?: number | null;
|
|
574
|
+
/** Offset that was requested. */
|
|
575
|
+
cursors?: Cursors;
|
|
669
576
|
/**
|
|
670
|
-
*
|
|
671
|
-
*
|
|
672
|
-
*
|
|
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.
|
|
673
580
|
*/
|
|
674
|
-
|
|
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;
|
|
581
|
+
hasNext?: boolean | null;
|
|
691
582
|
}
|
|
692
|
-
interface
|
|
693
|
-
/**
|
|
694
|
-
|
|
695
|
-
/**
|
|
696
|
-
|
|
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;
|
|
697
588
|
}
|
|
698
|
-
interface
|
|
589
|
+
interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
699
590
|
/**
|
|
700
|
-
*
|
|
591
|
+
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
701
592
|
* @format GUID
|
|
702
593
|
*/
|
|
703
|
-
|
|
704
|
-
}
|
|
705
|
-
interface DeleteMenuResponse {
|
|
706
|
-
}
|
|
707
|
-
interface RunMenusMultiLocationMigrationRequest {
|
|
594
|
+
metaSiteId?: string;
|
|
708
595
|
/**
|
|
709
|
-
*
|
|
596
|
+
* Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
|
|
710
597
|
* @format GUID
|
|
711
598
|
*/
|
|
712
|
-
|
|
713
|
-
|
|
714
|
-
|
|
715
|
-
/**
|
|
716
|
-
|
|
717
|
-
|
|
718
|
-
|
|
719
|
-
/**
|
|
720
|
-
|
|
721
|
-
/**
|
|
722
|
-
|
|
723
|
-
|
|
724
|
-
|
|
725
|
-
|
|
726
|
-
|
|
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;
|
|
727
614
|
/**
|
|
728
|
-
*
|
|
729
|
-
* @
|
|
615
|
+
* tell us why you're invalidating the cache. You don't need to add your app name
|
|
616
|
+
* @maxLength 256
|
|
730
617
|
*/
|
|
731
|
-
|
|
732
|
-
|
|
733
|
-
|
|
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;
|
|
618
|
+
reason?: string | null;
|
|
619
|
+
/** Is local DS */
|
|
620
|
+
localDc?: boolean;
|
|
621
|
+
hardPurge?: boolean;
|
|
742
622
|
/**
|
|
743
|
-
*
|
|
744
|
-
*
|
|
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
|
|
745
628
|
*/
|
|
746
|
-
|
|
629
|
+
correlationId?: string | null;
|
|
630
|
+
}
|
|
631
|
+
/** @oneof */
|
|
632
|
+
interface InvalidateCacheGetByOneOf {
|
|
747
633
|
/**
|
|
748
|
-
*
|
|
749
|
-
*
|
|
634
|
+
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
635
|
+
* @format GUID
|
|
750
636
|
*/
|
|
751
|
-
|
|
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;
|
|
637
|
+
metaSiteId?: string;
|
|
756
638
|
/**
|
|
757
|
-
*
|
|
758
|
-
*
|
|
639
|
+
* Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
|
|
640
|
+
* @format GUID
|
|
759
641
|
*/
|
|
760
|
-
|
|
761
|
-
/**
|
|
762
|
-
|
|
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 {
|
|
763
659
|
/**
|
|
764
|
-
*
|
|
765
|
-
*
|
|
660
|
+
* The AppDefId
|
|
661
|
+
* @minLength 1
|
|
766
662
|
*/
|
|
767
|
-
|
|
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 {
|
|
663
|
+
appDefId?: string;
|
|
783
664
|
/**
|
|
784
|
-
*
|
|
785
|
-
*
|
|
786
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
665
|
+
* The instance Id
|
|
666
|
+
* @format GUID
|
|
787
667
|
*/
|
|
788
|
-
|
|
789
|
-
}
|
|
790
|
-
interface EntityDeletedEvent {
|
|
791
|
-
/** Entity that was deleted. */
|
|
792
|
-
deletedEntity?: string | null;
|
|
793
|
-
}
|
|
794
|
-
interface ActionEvent {
|
|
795
|
-
body?: string;
|
|
796
|
-
}
|
|
797
|
-
interface Empty {
|
|
668
|
+
instanceId?: string;
|
|
798
669
|
}
|
|
799
|
-
interface
|
|
670
|
+
interface Page {
|
|
800
671
|
/**
|
|
801
|
-
*
|
|
672
|
+
* the msid the page is on
|
|
802
673
|
* @format GUID
|
|
803
674
|
*/
|
|
804
675
|
metaSiteId?: string;
|
|
676
|
+
/**
|
|
677
|
+
* Invalidate by Page ID
|
|
678
|
+
* @minLength 1
|
|
679
|
+
*/
|
|
680
|
+
pageId?: string;
|
|
805
681
|
}
|
|
806
|
-
interface
|
|
807
|
-
}
|
|
808
|
-
interface MessageEnvelope {
|
|
682
|
+
interface URI {
|
|
809
683
|
/**
|
|
810
|
-
*
|
|
684
|
+
* the msid the URI is on
|
|
811
685
|
* @format GUID
|
|
812
686
|
*/
|
|
813
|
-
|
|
687
|
+
metaSiteId?: string;
|
|
814
688
|
/**
|
|
815
|
-
*
|
|
816
|
-
* @
|
|
689
|
+
* URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes
|
|
690
|
+
* @minLength 1
|
|
817
691
|
*/
|
|
818
|
-
|
|
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;
|
|
692
|
+
uriPath?: string;
|
|
825
693
|
}
|
|
826
|
-
interface
|
|
694
|
+
interface File {
|
|
827
695
|
/**
|
|
828
|
-
*
|
|
696
|
+
* the msid the file is related to
|
|
829
697
|
* @format GUID
|
|
830
698
|
*/
|
|
831
|
-
|
|
699
|
+
metaSiteId?: string;
|
|
832
700
|
/**
|
|
833
|
-
*
|
|
834
|
-
* @
|
|
701
|
+
* Invalidate by filename (for media files such as PDFs)
|
|
702
|
+
* @minLength 1
|
|
703
|
+
* @maxLength 256
|
|
835
704
|
*/
|
|
836
|
-
|
|
705
|
+
fileName?: string;
|
|
706
|
+
}
|
|
707
|
+
interface CustomTag {
|
|
837
708
|
/**
|
|
838
|
-
*
|
|
709
|
+
* the msid the tag is related to
|
|
839
710
|
* @format GUID
|
|
840
711
|
*/
|
|
841
|
-
|
|
712
|
+
metaSiteId?: string;
|
|
842
713
|
/**
|
|
843
|
-
*
|
|
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
|
|
844
723
|
* @format GUID
|
|
845
724
|
*/
|
|
846
|
-
|
|
847
|
-
/**
|
|
848
|
-
|
|
725
|
+
metaSiteId?: string;
|
|
726
|
+
/**
|
|
727
|
+
* Invalidate by multiple Page IDs in a single message
|
|
728
|
+
* @maxSize 100
|
|
729
|
+
* @minLength 1
|
|
730
|
+
*/
|
|
731
|
+
pageIds?: string[];
|
|
849
732
|
}
|
|
850
|
-
|
|
851
|
-
interface IdentificationDataIdOneOf {
|
|
733
|
+
interface URIs {
|
|
852
734
|
/**
|
|
853
|
-
*
|
|
735
|
+
* the msid the URIs are on
|
|
854
736
|
* @format GUID
|
|
855
737
|
*/
|
|
856
|
-
|
|
738
|
+
metaSiteId?: string;
|
|
857
739
|
/**
|
|
858
|
-
*
|
|
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;
|
|
749
|
+
}
|
|
750
|
+
interface MenusDataCloningCompleted {
|
|
751
|
+
}
|
|
752
|
+
interface CreateMenuRequest {
|
|
753
|
+
/** Menu details. */
|
|
754
|
+
menu: Menu;
|
|
755
|
+
}
|
|
756
|
+
interface CreateMenuResponse {
|
|
757
|
+
/** Menu. */
|
|
758
|
+
menu?: Menu;
|
|
759
|
+
}
|
|
760
|
+
interface BulkCreateMenusRequest {
|
|
761
|
+
/**
|
|
762
|
+
* Menu details.
|
|
763
|
+
* @maxSize 100
|
|
764
|
+
*/
|
|
765
|
+
menus: Menu[];
|
|
766
|
+
/** Whether to receive the created menus in the response. */
|
|
767
|
+
returnEntity?: boolean;
|
|
768
|
+
}
|
|
769
|
+
interface BulkCreateMenusResponse {
|
|
770
|
+
/** Information about the created menus. */
|
|
771
|
+
results?: BulkCreateMenuResult[];
|
|
772
|
+
/** Metadata for the API call. */
|
|
773
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
774
|
+
}
|
|
775
|
+
interface BulkCreateMenuResult {
|
|
776
|
+
/** Whether to receive the created menus in the response. */
|
|
777
|
+
menuMetadata?: ItemMetadata;
|
|
778
|
+
/** Created menu. */
|
|
779
|
+
menu?: Menu;
|
|
780
|
+
}
|
|
781
|
+
interface ItemMetadata {
|
|
782
|
+
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
783
|
+
_id?: string | null;
|
|
784
|
+
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
785
|
+
originalIndex?: number;
|
|
786
|
+
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
787
|
+
success?: boolean;
|
|
788
|
+
/** Details about the error in case of failure. */
|
|
789
|
+
error?: ApplicationError;
|
|
790
|
+
}
|
|
791
|
+
interface ApplicationError {
|
|
792
|
+
/** Error code. */
|
|
793
|
+
code?: string;
|
|
794
|
+
/** Description of the error. */
|
|
795
|
+
description?: string;
|
|
796
|
+
/** Data related to the error. */
|
|
797
|
+
data?: Record<string, any> | null;
|
|
798
|
+
}
|
|
799
|
+
interface BulkActionMetadata {
|
|
800
|
+
/** Number of items that were successfully processed. */
|
|
801
|
+
totalSuccesses?: number;
|
|
802
|
+
/** Number of items that couldn't be processed. */
|
|
803
|
+
totalFailures?: number;
|
|
804
|
+
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
805
|
+
undetailedFailures?: number;
|
|
806
|
+
}
|
|
807
|
+
interface GetMenuRequest {
|
|
808
|
+
/**
|
|
809
|
+
* Menu ID.
|
|
859
810
|
* @format GUID
|
|
860
811
|
*/
|
|
861
|
-
|
|
812
|
+
menuId: string;
|
|
813
|
+
}
|
|
814
|
+
interface GetMenuResponse {
|
|
815
|
+
/** Menu. */
|
|
816
|
+
menu?: Menu;
|
|
817
|
+
}
|
|
818
|
+
interface ListMenusRequest {
|
|
862
819
|
/**
|
|
863
|
-
*
|
|
820
|
+
* Menu IDs.
|
|
864
821
|
* @format GUID
|
|
822
|
+
* @maxSize 500
|
|
865
823
|
*/
|
|
866
|
-
|
|
824
|
+
menuIds?: string[];
|
|
825
|
+
/** The metadata of the paginated results. */
|
|
826
|
+
paging?: CursorPaging;
|
|
827
|
+
/** Whether to return only menus that are visible to site visitors. */
|
|
828
|
+
onlyVisible?: boolean | null;
|
|
829
|
+
}
|
|
830
|
+
interface ListMenusResponse {
|
|
831
|
+
/** Retrieved menus. */
|
|
832
|
+
menus?: Menu[];
|
|
833
|
+
/** The metadata of the paginated results. */
|
|
834
|
+
pagingMetadata?: CursorPagingMetadata;
|
|
835
|
+
}
|
|
836
|
+
interface QueryMenusRequest {
|
|
837
|
+
/** Query options. */
|
|
838
|
+
query?: CursorQuery;
|
|
839
|
+
}
|
|
840
|
+
interface QueryMenusResponse {
|
|
841
|
+
/** Retrieved menus. */
|
|
842
|
+
menus?: Menu[];
|
|
843
|
+
/** The metadata of the paginated results. */
|
|
844
|
+
pagingMetadata?: CursorPagingMetadata;
|
|
845
|
+
}
|
|
846
|
+
interface UpdateMenuRequest {
|
|
847
|
+
/** Menu to update. */
|
|
848
|
+
menu: Menu;
|
|
867
849
|
/**
|
|
868
|
-
*
|
|
869
|
-
* @
|
|
850
|
+
* Explicit list of fields to update.
|
|
851
|
+
* @internal
|
|
870
852
|
*/
|
|
871
|
-
|
|
853
|
+
mask?: string[];
|
|
872
854
|
}
|
|
873
|
-
|
|
874
|
-
|
|
875
|
-
|
|
876
|
-
MEMBER = "MEMBER",
|
|
877
|
-
WIX_USER = "WIX_USER",
|
|
878
|
-
APP = "APP"
|
|
855
|
+
interface UpdateMenuResponse {
|
|
856
|
+
/** Updated menu. */
|
|
857
|
+
menu?: Menu;
|
|
879
858
|
}
|
|
880
|
-
|
|
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;
|
|
859
|
+
interface BulkUpdateMenuRequest {
|
|
893
860
|
/**
|
|
894
|
-
*
|
|
895
|
-
* @
|
|
861
|
+
* Menus to update.
|
|
862
|
+
* @minSize 1
|
|
863
|
+
* @maxSize 100
|
|
896
864
|
*/
|
|
897
|
-
|
|
865
|
+
menus: MaskedMenu[];
|
|
866
|
+
/** Whether to receive the entity in the response. */
|
|
867
|
+
returnEntity?: boolean;
|
|
898
868
|
}
|
|
899
|
-
interface
|
|
869
|
+
interface MaskedMenu {
|
|
870
|
+
/** Menu to updated. */
|
|
871
|
+
menu?: Menu;
|
|
872
|
+
/** Explicit list of fields to update. */
|
|
873
|
+
mask?: string[];
|
|
874
|
+
}
|
|
875
|
+
interface BulkUpdateMenuResponse {
|
|
900
876
|
/**
|
|
901
|
-
*
|
|
902
|
-
* @
|
|
877
|
+
* Results of bulk menu update.
|
|
878
|
+
* @minSize 1
|
|
879
|
+
* @maxSize 100
|
|
903
880
|
*/
|
|
881
|
+
results?: BulkMenuResult[];
|
|
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. */
|
|
904
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 {
|
|
905
906
|
/**
|
|
906
|
-
*
|
|
907
|
+
* Menu ID.
|
|
907
908
|
* @format GUID
|
|
908
|
-
* @maxSize 100
|
|
909
909
|
*/
|
|
910
|
-
|
|
911
|
-
|
|
912
|
-
|
|
910
|
+
menuId: string;
|
|
911
|
+
}
|
|
912
|
+
interface DeleteMenuResponse {
|
|
913
|
+
}
|
|
914
|
+
interface RunMenusMultiLocationMigrationRequest {
|
|
913
915
|
/**
|
|
914
|
-
*
|
|
915
|
-
* @
|
|
916
|
+
* business location id
|
|
917
|
+
* @format GUID
|
|
916
918
|
*/
|
|
917
|
-
|
|
919
|
+
businessLocationId?: string;
|
|
918
920
|
}
|
|
919
|
-
interface
|
|
921
|
+
interface RunMenusMultiLocationMigrationResponse {
|
|
922
|
+
/** Whether menus multi-location migration finished successfully */
|
|
923
|
+
success?: boolean;
|
|
924
|
+
}
|
|
925
|
+
interface UpdateBusinessLocationIdRequest {
|
|
920
926
|
/** @format GUID */
|
|
921
|
-
|
|
927
|
+
menuId?: string;
|
|
928
|
+
/** @format GUID */
|
|
929
|
+
businessLocationId?: string | null;
|
|
922
930
|
}
|
|
923
|
-
interface
|
|
931
|
+
interface UpdateBusinessLocationIdResponse {
|
|
932
|
+
}
|
|
933
|
+
interface CloneMenusRequest {
|
|
924
934
|
/**
|
|
925
|
-
*
|
|
935
|
+
* The MetaSiteId to clone from.
|
|
926
936
|
* @format GUID
|
|
927
|
-
* @readonly
|
|
928
937
|
*/
|
|
929
|
-
|
|
938
|
+
metaSiteId?: string;
|
|
930
939
|
}
|
|
931
|
-
interface
|
|
932
|
-
/** Retrieved menuInfo with path url. */
|
|
933
|
-
menuSiteUrl?: MenuSiteUrl;
|
|
940
|
+
interface CloneMenusResponse {
|
|
934
941
|
}
|
|
935
|
-
interface
|
|
942
|
+
interface Empty {
|
|
943
|
+
}
|
|
944
|
+
interface SyncContentToMultilingualRequest {
|
|
936
945
|
/**
|
|
937
|
-
*
|
|
938
|
-
* @
|
|
939
|
-
* @maxLength 1000
|
|
946
|
+
* MetaSite ID
|
|
947
|
+
* @format GUID
|
|
940
948
|
*/
|
|
941
|
-
|
|
942
|
-
}
|
|
943
|
-
interface QueryMenusSiteUrlRequest {
|
|
944
|
-
/** Query options */
|
|
945
|
-
query?: CursorQuery;
|
|
949
|
+
metaSiteId?: string;
|
|
946
950
|
}
|
|
947
|
-
interface
|
|
948
|
-
/** Retrieved menuInfos with path urls. */
|
|
949
|
-
menuSiteUrls?: MenuSiteUrl[];
|
|
950
|
-
/** The metadata of the paginated results. */
|
|
951
|
-
pagingMetadata?: CursorPagingMetadata;
|
|
951
|
+
interface SyncContentToMultilingualResponse {
|
|
952
952
|
}
|
|
953
953
|
interface BaseEventMetadata {
|
|
954
954
|
/**
|
|
@@ -1005,6 +1005,21 @@ 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;
|
|
1008
1023
|
interface MenuCreatedEnvelope {
|
|
1009
1024
|
entity: Menu;
|
|
1010
1025
|
metadata: EventMetadata;
|
|
@@ -1034,21 +1049,54 @@ interface MenuDeletedEnvelope {
|
|
|
1034
1049
|
* @documentationMaturity preview
|
|
1035
1050
|
*/
|
|
1036
1051
|
declare function onMenuDeleted(handler: (event: MenuDeletedEnvelope) => void | Promise<void>): void;
|
|
1037
|
-
|
|
1038
|
-
|
|
1039
|
-
|
|
1040
|
-
|
|
1041
|
-
|
|
1052
|
+
/** @param _id - Menu id to be duplicated.
|
|
1053
|
+
* @public
|
|
1054
|
+
* @documentationMaturity preview
|
|
1055
|
+
* @requiredField _id
|
|
1056
|
+
* @permissionId RESTAURANTS.MENU_CREATE
|
|
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;
|
|
1042
1075
|
}
|
|
1043
|
-
/**
|
|
1044
|
-
*
|
|
1076
|
+
/**
|
|
1077
|
+
* Get menu details and path URL by menu ID.
|
|
1078
|
+
* @param _id - Menu ID.
|
|
1079
|
+
* @public
|
|
1080
|
+
* @documentationMaturity preview
|
|
1081
|
+
* @requiredField _id
|
|
1045
1082
|
* @permissionId RESTAURANTS.MENU_READ
|
|
1046
|
-
* @
|
|
1047
|
-
* @
|
|
1048
|
-
|
|
1083
|
+
* @applicableIdentity APP
|
|
1084
|
+
* @fqn com.wixpress.restaurants.menus_menu.v1.restaurants_menus_site_url.RestaurantsMenusSiteUrl.GetMenuSiteUrl
|
|
1085
|
+
*/
|
|
1086
|
+
declare function getMenuSiteUrl(_id: string): Promise<NonNullablePaths<GetMenuSiteUrlResponse, `menuSiteUrl.path`, 1>>;
|
|
1087
|
+
/**
|
|
1088
|
+
* Query menu details and path URL
|
|
1089
|
+
* @public
|
|
1049
1090
|
* @documentationMaturity preview
|
|
1091
|
+
* @permissionId RESTAURANTS.MENU_READ
|
|
1092
|
+
* @applicableIdentity APP
|
|
1093
|
+
* @fqn com.wixpress.restaurants.menus_menu.v1.restaurants_menus_site_url.RestaurantsMenusSiteUrl.QueryMenusSiteUrl
|
|
1050
1094
|
*/
|
|
1051
|
-
declare function
|
|
1095
|
+
declare function queryMenusSiteUrl(options?: QueryMenusSiteUrlOptions): Promise<NonNullablePaths<QueryMenusSiteUrlResponse, `menuSiteUrls` | `menuSiteUrls.${number}.path`, 2>>;
|
|
1096
|
+
interface QueryMenusSiteUrlOptions {
|
|
1097
|
+
/** Query options */
|
|
1098
|
+
query?: CursorQuery;
|
|
1099
|
+
}
|
|
1052
1100
|
/**
|
|
1053
1101
|
* > **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
1102
|
*
|
|
@@ -1466,53 +1514,5 @@ interface UpdateExtendedFieldsOptions {
|
|
|
1466
1514
|
* @fqn com.wixpress.restaurants.menus_menu.v1.RestaurantsMenusMenu.DeleteMenu
|
|
1467
1515
|
*/
|
|
1468
1516
|
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 };
|