@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
|
@@ -266,289 +266,206 @@ interface ExternalReferenceInfo {
|
|
|
266
266
|
/** Whether the connection to the external system is currently active. */
|
|
267
267
|
connected?: boolean | null;
|
|
268
268
|
}
|
|
269
|
-
interface
|
|
269
|
+
interface DuplicateMenuRequest {
|
|
270
270
|
/**
|
|
271
|
-
*
|
|
271
|
+
* Menu id to be duplicated.
|
|
272
272
|
* @format GUID
|
|
273
273
|
*/
|
|
274
|
-
|
|
274
|
+
_id: string;
|
|
275
275
|
/**
|
|
276
|
-
*
|
|
276
|
+
* Business location ids to duplicate the menu to.
|
|
277
277
|
* @format GUID
|
|
278
|
+
* @maxSize 100
|
|
278
279
|
*/
|
|
279
|
-
|
|
280
|
-
/**
|
|
281
|
-
|
|
282
|
-
/** Invalidate by page id */
|
|
283
|
-
page?: Page;
|
|
284
|
-
/** Invalidate by URI path */
|
|
285
|
-
uri?: URI;
|
|
286
|
-
/** Invalidate by file (for media files such as PDFs) */
|
|
287
|
-
file?: File;
|
|
288
|
-
/** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */
|
|
289
|
-
customTag?: CustomTag;
|
|
290
|
-
/** Invalidate by multiple page ids */
|
|
291
|
-
pages?: Pages;
|
|
292
|
-
/** Invalidate by multiple URI paths */
|
|
293
|
-
uris?: URIs;
|
|
280
|
+
businessLocationIds?: string[] | null;
|
|
281
|
+
/** Indicates whether sub-entities (such as items) should be duplicated as well. */
|
|
282
|
+
duplicateSubEntities?: boolean | null;
|
|
294
283
|
/**
|
|
295
|
-
*
|
|
296
|
-
* @maxLength
|
|
284
|
+
* The new name of the duplicated menu.
|
|
285
|
+
* @maxLength 500
|
|
297
286
|
*/
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
287
|
+
menuName?: string | null;
|
|
288
|
+
}
|
|
289
|
+
interface DuplicateMenuResponse {
|
|
290
|
+
/** @format GUID */
|
|
291
|
+
menuIds?: string[];
|
|
292
|
+
}
|
|
293
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
294
|
+
createdEvent?: EntityCreatedEvent;
|
|
295
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
296
|
+
deletedEvent?: EntityDeletedEvent;
|
|
297
|
+
actionEvent?: ActionEvent;
|
|
298
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
299
|
+
_id?: string;
|
|
302
300
|
/**
|
|
303
|
-
*
|
|
304
|
-
*
|
|
305
|
-
* allowing you to confirm when the invalidation has fully propagated.
|
|
306
|
-
* Example: generate a UUID, pass it here, and later match it in the CDN purge completion event.
|
|
307
|
-
* @maxLength 256
|
|
301
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
302
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
308
303
|
*/
|
|
309
|
-
|
|
310
|
-
}
|
|
311
|
-
/** @oneof */
|
|
312
|
-
interface InvalidateCacheGetByOneOf {
|
|
304
|
+
entityFqdn?: string;
|
|
313
305
|
/**
|
|
314
|
-
*
|
|
315
|
-
*
|
|
306
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
307
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
316
308
|
*/
|
|
317
|
-
|
|
309
|
+
slug?: string;
|
|
310
|
+
/** ID of the entity associated with the event. */
|
|
311
|
+
entityId?: string;
|
|
312
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
313
|
+
eventTime?: Date | null;
|
|
318
314
|
/**
|
|
319
|
-
*
|
|
320
|
-
*
|
|
315
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
316
|
+
* (for example, GDPR).
|
|
321
317
|
*/
|
|
322
|
-
|
|
323
|
-
/**
|
|
324
|
-
|
|
325
|
-
/**
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
file?: File;
|
|
331
|
-
/** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */
|
|
332
|
-
customTag?: CustomTag;
|
|
333
|
-
/** Invalidate by multiple page ids */
|
|
334
|
-
pages?: Pages;
|
|
335
|
-
/** Invalidate by multiple URI paths */
|
|
336
|
-
uris?: URIs;
|
|
318
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
319
|
+
/** If present, indicates the action that triggered the event. */
|
|
320
|
+
originatedFrom?: string | null;
|
|
321
|
+
/**
|
|
322
|
+
* 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.
|
|
323
|
+
* 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.
|
|
324
|
+
*/
|
|
325
|
+
entityEventSequence?: string | null;
|
|
337
326
|
}
|
|
338
|
-
|
|
327
|
+
/** @oneof */
|
|
328
|
+
interface DomainEventBodyOneOf {
|
|
329
|
+
createdEvent?: EntityCreatedEvent;
|
|
330
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
331
|
+
deletedEvent?: EntityDeletedEvent;
|
|
332
|
+
actionEvent?: ActionEvent;
|
|
333
|
+
}
|
|
334
|
+
interface EntityCreatedEvent {
|
|
335
|
+
entity?: string;
|
|
336
|
+
}
|
|
337
|
+
interface RestoreInfo {
|
|
338
|
+
deletedDate?: Date | null;
|
|
339
|
+
}
|
|
340
|
+
interface EntityUpdatedEvent {
|
|
339
341
|
/**
|
|
340
|
-
*
|
|
341
|
-
*
|
|
342
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
343
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
344
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
342
345
|
*/
|
|
343
|
-
|
|
346
|
+
currentEntity?: string;
|
|
347
|
+
}
|
|
348
|
+
interface EntityDeletedEvent {
|
|
349
|
+
/** Entity that was deleted. */
|
|
350
|
+
deletedEntity?: string | null;
|
|
351
|
+
}
|
|
352
|
+
interface ActionEvent {
|
|
353
|
+
body?: string;
|
|
354
|
+
}
|
|
355
|
+
interface MessageEnvelope {
|
|
344
356
|
/**
|
|
345
|
-
*
|
|
357
|
+
* App instance ID.
|
|
346
358
|
* @format GUID
|
|
347
359
|
*/
|
|
348
|
-
instanceId?: string;
|
|
360
|
+
instanceId?: string | null;
|
|
361
|
+
/**
|
|
362
|
+
* Event type.
|
|
363
|
+
* @maxLength 150
|
|
364
|
+
*/
|
|
365
|
+
eventType?: string;
|
|
366
|
+
/** The identification type and identity data. */
|
|
367
|
+
identity?: IdentificationData;
|
|
368
|
+
/** Stringify payload. */
|
|
369
|
+
data?: string;
|
|
370
|
+
/** Details related to the account */
|
|
371
|
+
accountInfo?: AccountInfo;
|
|
349
372
|
}
|
|
350
|
-
interface
|
|
373
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
351
374
|
/**
|
|
352
|
-
*
|
|
375
|
+
* ID of a site visitor that has not logged in to the site.
|
|
353
376
|
* @format GUID
|
|
354
377
|
*/
|
|
355
|
-
|
|
378
|
+
anonymousVisitorId?: string;
|
|
356
379
|
/**
|
|
357
|
-
*
|
|
358
|
-
* @
|
|
380
|
+
* ID of a site visitor that has logged in to the site.
|
|
381
|
+
* @format GUID
|
|
359
382
|
*/
|
|
360
|
-
|
|
361
|
-
}
|
|
362
|
-
interface URI {
|
|
383
|
+
memberId?: string;
|
|
363
384
|
/**
|
|
364
|
-
*
|
|
385
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
365
386
|
* @format GUID
|
|
366
387
|
*/
|
|
367
|
-
|
|
388
|
+
wixUserId?: string;
|
|
368
389
|
/**
|
|
369
|
-
*
|
|
370
|
-
* @
|
|
390
|
+
* ID of an app.
|
|
391
|
+
* @format GUID
|
|
371
392
|
*/
|
|
372
|
-
|
|
393
|
+
appId?: string;
|
|
394
|
+
/** @readonly */
|
|
395
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
373
396
|
}
|
|
374
|
-
|
|
397
|
+
/** @oneof */
|
|
398
|
+
interface IdentificationDataIdOneOf {
|
|
375
399
|
/**
|
|
376
|
-
*
|
|
400
|
+
* ID of a site visitor that has not logged in to the site.
|
|
377
401
|
* @format GUID
|
|
378
402
|
*/
|
|
379
|
-
|
|
403
|
+
anonymousVisitorId?: string;
|
|
380
404
|
/**
|
|
381
|
-
*
|
|
382
|
-
* @
|
|
383
|
-
* @maxLength 256
|
|
405
|
+
* ID of a site visitor that has logged in to the site.
|
|
406
|
+
* @format GUID
|
|
384
407
|
*/
|
|
385
|
-
|
|
386
|
-
}
|
|
387
|
-
interface CustomTag {
|
|
408
|
+
memberId?: string;
|
|
388
409
|
/**
|
|
389
|
-
*
|
|
410
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
390
411
|
* @format GUID
|
|
391
412
|
*/
|
|
392
|
-
|
|
413
|
+
wixUserId?: string;
|
|
393
414
|
/**
|
|
394
|
-
*
|
|
395
|
-
* @
|
|
396
|
-
* @maxLength 256
|
|
415
|
+
* ID of an app.
|
|
416
|
+
* @format GUID
|
|
397
417
|
*/
|
|
398
|
-
|
|
418
|
+
appId?: string;
|
|
399
419
|
}
|
|
400
|
-
|
|
420
|
+
declare enum WebhookIdentityType {
|
|
421
|
+
UNKNOWN = "UNKNOWN",
|
|
422
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
423
|
+
MEMBER = "MEMBER",
|
|
424
|
+
WIX_USER = "WIX_USER",
|
|
425
|
+
APP = "APP"
|
|
426
|
+
}
|
|
427
|
+
/** @enumType */
|
|
428
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
429
|
+
interface AccountInfo {
|
|
401
430
|
/**
|
|
402
|
-
*
|
|
431
|
+
* ID of the Wix account associated with the event.
|
|
403
432
|
* @format GUID
|
|
404
433
|
*/
|
|
405
|
-
|
|
434
|
+
accountId?: string | null;
|
|
406
435
|
/**
|
|
407
|
-
*
|
|
408
|
-
* @
|
|
409
|
-
* @minLength 1
|
|
436
|
+
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
437
|
+
* @format GUID
|
|
410
438
|
*/
|
|
411
|
-
|
|
412
|
-
}
|
|
413
|
-
interface URIs {
|
|
439
|
+
parentAccountId?: string | null;
|
|
414
440
|
/**
|
|
415
|
-
* the
|
|
441
|
+
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
416
442
|
* @format GUID
|
|
417
443
|
*/
|
|
418
|
-
|
|
444
|
+
siteId?: string | null;
|
|
445
|
+
}
|
|
446
|
+
interface GetMenuSiteUrlRequest {
|
|
419
447
|
/**
|
|
420
|
-
*
|
|
421
|
-
* @
|
|
422
|
-
* @
|
|
448
|
+
* Menu ID.
|
|
449
|
+
* @format GUID
|
|
450
|
+
* @readonly
|
|
423
451
|
*/
|
|
424
|
-
|
|
452
|
+
_id: string | null;
|
|
425
453
|
}
|
|
426
|
-
interface
|
|
427
|
-
/**
|
|
428
|
-
|
|
454
|
+
interface GetMenuSiteUrlResponse {
|
|
455
|
+
/** Retrieved menuInfo with path url. */
|
|
456
|
+
menuSiteUrl?: MenuSiteUrl;
|
|
429
457
|
}
|
|
430
|
-
interface
|
|
458
|
+
interface MenuSiteUrl {
|
|
459
|
+
/**
|
|
460
|
+
* Path URL.
|
|
461
|
+
* @minLength 1
|
|
462
|
+
* @maxLength 1000
|
|
463
|
+
*/
|
|
464
|
+
path?: string;
|
|
431
465
|
}
|
|
432
|
-
interface
|
|
433
|
-
/**
|
|
434
|
-
|
|
435
|
-
}
|
|
436
|
-
interface CreateMenuResponse {
|
|
437
|
-
/** Menu. */
|
|
438
|
-
menu?: Menu;
|
|
439
|
-
}
|
|
440
|
-
interface BulkCreateMenusRequest {
|
|
441
|
-
/**
|
|
442
|
-
* Menu details.
|
|
443
|
-
* @maxSize 100
|
|
444
|
-
*/
|
|
445
|
-
menus: Menu[];
|
|
446
|
-
/** Whether to receive the created menus in the response. */
|
|
447
|
-
returnEntity?: boolean;
|
|
448
|
-
}
|
|
449
|
-
interface BulkCreateMenusResponse {
|
|
450
|
-
/** Information about the created menus. */
|
|
451
|
-
results?: BulkCreateMenuResult[];
|
|
452
|
-
/** Metadata for the API call. */
|
|
453
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
454
|
-
}
|
|
455
|
-
interface BulkCreateMenuResult {
|
|
456
|
-
/** Whether to receive the created menus in the response. */
|
|
457
|
-
menuMetadata?: ItemMetadata;
|
|
458
|
-
/** Created menu. */
|
|
459
|
-
menu?: Menu;
|
|
460
|
-
}
|
|
461
|
-
interface ItemMetadata {
|
|
462
|
-
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
463
|
-
_id?: string | null;
|
|
464
|
-
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
465
|
-
originalIndex?: number;
|
|
466
|
-
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
467
|
-
success?: boolean;
|
|
468
|
-
/** Details about the error in case of failure. */
|
|
469
|
-
error?: ApplicationError;
|
|
470
|
-
}
|
|
471
|
-
interface ApplicationError {
|
|
472
|
-
/** Error code. */
|
|
473
|
-
code?: string;
|
|
474
|
-
/** Description of the error. */
|
|
475
|
-
description?: string;
|
|
476
|
-
/** Data related to the error. */
|
|
477
|
-
data?: Record<string, any> | null;
|
|
478
|
-
}
|
|
479
|
-
interface BulkActionMetadata {
|
|
480
|
-
/** Number of items that were successfully processed. */
|
|
481
|
-
totalSuccesses?: number;
|
|
482
|
-
/** Number of items that couldn't be processed. */
|
|
483
|
-
totalFailures?: number;
|
|
484
|
-
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
485
|
-
undetailedFailures?: number;
|
|
486
|
-
}
|
|
487
|
-
interface GetMenuRequest {
|
|
488
|
-
/**
|
|
489
|
-
* Menu ID.
|
|
490
|
-
* @format GUID
|
|
491
|
-
*/
|
|
492
|
-
menuId: string;
|
|
493
|
-
}
|
|
494
|
-
interface GetMenuResponse {
|
|
495
|
-
/** Menu. */
|
|
496
|
-
menu?: Menu;
|
|
497
|
-
}
|
|
498
|
-
interface ListMenusRequest {
|
|
499
|
-
/**
|
|
500
|
-
* Menu IDs.
|
|
501
|
-
* @format GUID
|
|
502
|
-
* @maxSize 500
|
|
503
|
-
*/
|
|
504
|
-
menuIds?: string[];
|
|
505
|
-
/** The metadata of the paginated results. */
|
|
506
|
-
paging?: CursorPaging;
|
|
507
|
-
/** Whether to return only menus that are visible to site visitors. */
|
|
508
|
-
onlyVisible?: boolean | null;
|
|
509
|
-
}
|
|
510
|
-
interface CursorPaging {
|
|
511
|
-
/**
|
|
512
|
-
* Number of items to load.
|
|
513
|
-
* @max 500
|
|
514
|
-
*/
|
|
515
|
-
limit?: number | null;
|
|
516
|
-
/**
|
|
517
|
-
* Pointer to the next or previous page in the list of results.
|
|
518
|
-
*
|
|
519
|
-
* You can get the relevant cursor token
|
|
520
|
-
* from the `pagingMetadata` object in the previous call's response.
|
|
521
|
-
* Not relevant for the first request.
|
|
522
|
-
*/
|
|
523
|
-
cursor?: string | null;
|
|
524
|
-
}
|
|
525
|
-
interface ListMenusResponse {
|
|
526
|
-
/** Retrieved menus. */
|
|
527
|
-
menus?: Menu[];
|
|
528
|
-
/** The metadata of the paginated results. */
|
|
529
|
-
pagingMetadata?: CursorPagingMetadata;
|
|
530
|
-
}
|
|
531
|
-
interface CursorPagingMetadata {
|
|
532
|
-
/** Number of items returned in the response. */
|
|
533
|
-
count?: number | null;
|
|
534
|
-
/** Offset that was requested. */
|
|
535
|
-
cursors?: Cursors;
|
|
536
|
-
/**
|
|
537
|
-
* Indicates if there are more results after the current page.
|
|
538
|
-
* If `true`, another page of results can be retrieved.
|
|
539
|
-
* If `false`, this is the last page.
|
|
540
|
-
*/
|
|
541
|
-
hasNext?: boolean | null;
|
|
542
|
-
}
|
|
543
|
-
interface Cursors {
|
|
544
|
-
/** Cursor pointing to next page in the list of results. */
|
|
545
|
-
next?: string | null;
|
|
546
|
-
/** Cursor pointing to previous page in the list of results. */
|
|
547
|
-
prev?: string | null;
|
|
548
|
-
}
|
|
549
|
-
interface QueryMenusRequest {
|
|
550
|
-
/** Query options. */
|
|
551
|
-
query?: CursorQuery;
|
|
466
|
+
interface QueryMenusSiteUrlRequest {
|
|
467
|
+
/** Query options */
|
|
468
|
+
query?: CursorQuery;
|
|
552
469
|
}
|
|
553
470
|
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
554
471
|
/** 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`. */
|
|
@@ -599,320 +516,403 @@ interface AddressLocation {
|
|
|
599
516
|
/** Address longitude. */
|
|
600
517
|
longitude?: number | null;
|
|
601
518
|
}
|
|
602
|
-
interface
|
|
603
|
-
/** Retrieved menus. */
|
|
604
|
-
menus?: Menu[];
|
|
605
|
-
/** The metadata of the paginated results. */
|
|
606
|
-
pagingMetadata?: CursorPagingMetadata;
|
|
607
|
-
}
|
|
608
|
-
interface UpdateMenuRequest {
|
|
609
|
-
/** Menu to update. */
|
|
610
|
-
menu: Menu;
|
|
611
|
-
}
|
|
612
|
-
interface UpdateMenuResponse {
|
|
613
|
-
/** Updated menu. */
|
|
614
|
-
menu?: Menu;
|
|
615
|
-
}
|
|
616
|
-
interface BulkUpdateMenuRequest {
|
|
519
|
+
interface CursorPaging {
|
|
617
520
|
/**
|
|
618
|
-
*
|
|
619
|
-
* @
|
|
620
|
-
* @maxSize 100
|
|
521
|
+
* Number of items to load.
|
|
522
|
+
* @max 500
|
|
621
523
|
*/
|
|
622
|
-
|
|
623
|
-
/** Whether to receive the entity in the response. */
|
|
624
|
-
returnEntity?: boolean;
|
|
625
|
-
}
|
|
626
|
-
interface MaskedMenu {
|
|
627
|
-
/** Menu to updated. */
|
|
628
|
-
menu?: Menu;
|
|
629
|
-
/** Explicit list of fields to update. */
|
|
630
|
-
mask?: string[];
|
|
631
|
-
}
|
|
632
|
-
interface BulkUpdateMenuResponse {
|
|
524
|
+
limit?: number | null;
|
|
633
525
|
/**
|
|
634
|
-
*
|
|
635
|
-
*
|
|
636
|
-
*
|
|
526
|
+
* Pointer to the next or previous page in the list of results.
|
|
527
|
+
*
|
|
528
|
+
* You can get the relevant cursor token
|
|
529
|
+
* from the `pagingMetadata` object in the previous call's response.
|
|
530
|
+
* Not relevant for the first request.
|
|
637
531
|
*/
|
|
638
|
-
|
|
639
|
-
/** Metadata for the API call. */
|
|
640
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
641
|
-
}
|
|
642
|
-
interface BulkMenuResult {
|
|
643
|
-
/** Metadata for menu update. */
|
|
644
|
-
menuMetadata?: ItemMetadata;
|
|
645
|
-
/** Updated menu. Only returned if `returnEntity` is set to `true`. */
|
|
646
|
-
menu?: Menu;
|
|
647
|
-
}
|
|
648
|
-
interface UpdateExtendedFieldsRequest {
|
|
649
|
-
/** ID of the entity to update. */
|
|
650
|
-
_id: string;
|
|
651
|
-
/** Identifier for the app whose extended fields are being updated. */
|
|
652
|
-
namespace: string;
|
|
653
|
-
/** 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. */
|
|
654
|
-
namespaceData: Record<string, any> | null;
|
|
532
|
+
cursor?: string | null;
|
|
655
533
|
}
|
|
656
|
-
interface
|
|
657
|
-
/**
|
|
658
|
-
|
|
659
|
-
/**
|
|
660
|
-
|
|
534
|
+
interface QueryMenusSiteUrlResponse {
|
|
535
|
+
/** Retrieved menuInfos with path urls. */
|
|
536
|
+
menuSiteUrls?: MenuSiteUrl[];
|
|
537
|
+
/** The metadata of the paginated results. */
|
|
538
|
+
pagingMetadata?: CursorPagingMetadata;
|
|
661
539
|
}
|
|
662
|
-
interface
|
|
540
|
+
interface CursorPagingMetadata {
|
|
541
|
+
/** Number of items returned in the response. */
|
|
542
|
+
count?: number | null;
|
|
543
|
+
/** Offset that was requested. */
|
|
544
|
+
cursors?: Cursors;
|
|
663
545
|
/**
|
|
664
|
-
*
|
|
665
|
-
*
|
|
546
|
+
* Indicates if there are more results after the current page.
|
|
547
|
+
* If `true`, another page of results can be retrieved.
|
|
548
|
+
* If `false`, this is the last page.
|
|
666
549
|
*/
|
|
667
|
-
|
|
550
|
+
hasNext?: boolean | null;
|
|
668
551
|
}
|
|
669
|
-
interface
|
|
552
|
+
interface Cursors {
|
|
553
|
+
/** Cursor pointing to next page in the list of results. */
|
|
554
|
+
next?: string | null;
|
|
555
|
+
/** Cursor pointing to previous page in the list of results. */
|
|
556
|
+
prev?: string | null;
|
|
670
557
|
}
|
|
671
|
-
interface
|
|
558
|
+
interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
672
559
|
/**
|
|
673
|
-
*
|
|
560
|
+
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
674
561
|
* @format GUID
|
|
675
562
|
*/
|
|
676
|
-
|
|
677
|
-
}
|
|
678
|
-
interface RunMenusMultiLocationMigrationResponse {
|
|
679
|
-
/** Whether menus multi-location migration finished successfully */
|
|
680
|
-
success?: boolean;
|
|
681
|
-
}
|
|
682
|
-
interface UpdateBusinessLocationIdRequest {
|
|
683
|
-
/** @format GUID */
|
|
684
|
-
menuId?: string;
|
|
685
|
-
/** @format GUID */
|
|
686
|
-
businessLocationId?: string | null;
|
|
687
|
-
}
|
|
688
|
-
interface UpdateBusinessLocationIdResponse {
|
|
689
|
-
}
|
|
690
|
-
interface CloneMenusRequest {
|
|
563
|
+
metaSiteId?: string;
|
|
691
564
|
/**
|
|
692
|
-
*
|
|
565
|
+
* Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
|
|
693
566
|
* @format GUID
|
|
694
567
|
*/
|
|
695
|
-
|
|
696
|
-
|
|
697
|
-
|
|
698
|
-
|
|
699
|
-
|
|
700
|
-
|
|
701
|
-
|
|
702
|
-
|
|
703
|
-
|
|
704
|
-
/**
|
|
705
|
-
|
|
568
|
+
siteId?: string;
|
|
569
|
+
/** Invalidate by App */
|
|
570
|
+
app?: App;
|
|
571
|
+
/** Invalidate by page id */
|
|
572
|
+
page?: Page;
|
|
573
|
+
/** Invalidate by URI path */
|
|
574
|
+
uri?: URI;
|
|
575
|
+
/** Invalidate by file (for media files such as PDFs) */
|
|
576
|
+
file?: File;
|
|
577
|
+
/** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */
|
|
578
|
+
customTag?: CustomTag;
|
|
579
|
+
/** Invalidate by multiple page ids */
|
|
580
|
+
pages?: Pages;
|
|
581
|
+
/** Invalidate by multiple URI paths */
|
|
582
|
+
uris?: URIs;
|
|
706
583
|
/**
|
|
707
|
-
*
|
|
708
|
-
*
|
|
584
|
+
* tell us why you're invalidating the cache. You don't need to add your app name
|
|
585
|
+
* @maxLength 256
|
|
709
586
|
*/
|
|
710
|
-
|
|
587
|
+
reason?: string | null;
|
|
588
|
+
/** Is local DS */
|
|
589
|
+
localDc?: boolean;
|
|
590
|
+
hardPurge?: boolean;
|
|
711
591
|
/**
|
|
712
|
-
*
|
|
713
|
-
*
|
|
592
|
+
* Optional caller-provided ID for tracking this invalidation through the system.
|
|
593
|
+
* When set, the corresponding CDN purge completion event will include this ID,
|
|
594
|
+
* allowing you to confirm when the invalidation has fully propagated.
|
|
595
|
+
* Example: generate a UUID, pass it here, and later match it in the CDN purge completion event.
|
|
596
|
+
* @maxLength 256
|
|
714
597
|
*/
|
|
715
|
-
|
|
716
|
-
|
|
717
|
-
|
|
718
|
-
|
|
719
|
-
eventTime?: Date | null;
|
|
598
|
+
correlationId?: string | null;
|
|
599
|
+
}
|
|
600
|
+
/** @oneof */
|
|
601
|
+
interface InvalidateCacheGetByOneOf {
|
|
720
602
|
/**
|
|
721
|
-
*
|
|
722
|
-
*
|
|
603
|
+
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
604
|
+
* @format GUID
|
|
723
605
|
*/
|
|
724
|
-
|
|
725
|
-
/** If present, indicates the action that triggered the event. */
|
|
726
|
-
originatedFrom?: string | null;
|
|
606
|
+
metaSiteId?: string;
|
|
727
607
|
/**
|
|
728
|
-
*
|
|
729
|
-
*
|
|
608
|
+
* Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
|
|
609
|
+
* @format GUID
|
|
730
610
|
*/
|
|
731
|
-
|
|
732
|
-
|
|
733
|
-
|
|
734
|
-
|
|
735
|
-
|
|
736
|
-
|
|
737
|
-
|
|
738
|
-
|
|
739
|
-
|
|
740
|
-
|
|
741
|
-
|
|
742
|
-
|
|
743
|
-
|
|
744
|
-
|
|
611
|
+
siteId?: string;
|
|
612
|
+
/** Invalidate by App */
|
|
613
|
+
app?: App;
|
|
614
|
+
/** Invalidate by page id */
|
|
615
|
+
page?: Page;
|
|
616
|
+
/** Invalidate by URI path */
|
|
617
|
+
uri?: URI;
|
|
618
|
+
/** Invalidate by file (for media files such as PDFs) */
|
|
619
|
+
file?: File;
|
|
620
|
+
/** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */
|
|
621
|
+
customTag?: CustomTag;
|
|
622
|
+
/** Invalidate by multiple page ids */
|
|
623
|
+
pages?: Pages;
|
|
624
|
+
/** Invalidate by multiple URI paths */
|
|
625
|
+
uris?: URIs;
|
|
745
626
|
}
|
|
746
|
-
interface
|
|
627
|
+
interface App {
|
|
747
628
|
/**
|
|
748
|
-
*
|
|
749
|
-
*
|
|
750
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
629
|
+
* The AppDefId
|
|
630
|
+
* @minLength 1
|
|
751
631
|
*/
|
|
752
|
-
|
|
753
|
-
|
|
754
|
-
|
|
755
|
-
|
|
756
|
-
|
|
757
|
-
|
|
758
|
-
interface ActionEvent {
|
|
759
|
-
body?: string;
|
|
760
|
-
}
|
|
761
|
-
interface Empty {
|
|
632
|
+
appDefId?: string;
|
|
633
|
+
/**
|
|
634
|
+
* The instance Id
|
|
635
|
+
* @format GUID
|
|
636
|
+
*/
|
|
637
|
+
instanceId?: string;
|
|
762
638
|
}
|
|
763
|
-
interface
|
|
639
|
+
interface Page {
|
|
764
640
|
/**
|
|
765
|
-
*
|
|
641
|
+
* the msid the page is on
|
|
766
642
|
* @format GUID
|
|
767
643
|
*/
|
|
768
644
|
metaSiteId?: string;
|
|
645
|
+
/**
|
|
646
|
+
* Invalidate by Page ID
|
|
647
|
+
* @minLength 1
|
|
648
|
+
*/
|
|
649
|
+
pageId?: string;
|
|
769
650
|
}
|
|
770
|
-
interface
|
|
771
|
-
}
|
|
772
|
-
interface MessageEnvelope {
|
|
651
|
+
interface URI {
|
|
773
652
|
/**
|
|
774
|
-
*
|
|
653
|
+
* the msid the URI is on
|
|
775
654
|
* @format GUID
|
|
776
655
|
*/
|
|
777
|
-
|
|
656
|
+
metaSiteId?: string;
|
|
778
657
|
/**
|
|
779
|
-
*
|
|
780
|
-
* @
|
|
658
|
+
* URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes
|
|
659
|
+
* @minLength 1
|
|
781
660
|
*/
|
|
782
|
-
|
|
783
|
-
/** The identification type and identity data. */
|
|
784
|
-
identity?: IdentificationData;
|
|
785
|
-
/** Stringify payload. */
|
|
786
|
-
data?: string;
|
|
787
|
-
/** Details related to the account */
|
|
788
|
-
accountInfo?: AccountInfo;
|
|
661
|
+
uriPath?: string;
|
|
789
662
|
}
|
|
790
|
-
interface
|
|
663
|
+
interface File {
|
|
791
664
|
/**
|
|
792
|
-
*
|
|
665
|
+
* the msid the file is related to
|
|
793
666
|
* @format GUID
|
|
794
667
|
*/
|
|
795
|
-
|
|
668
|
+
metaSiteId?: string;
|
|
796
669
|
/**
|
|
797
|
-
*
|
|
798
|
-
* @
|
|
670
|
+
* Invalidate by filename (for media files such as PDFs)
|
|
671
|
+
* @minLength 1
|
|
672
|
+
* @maxLength 256
|
|
799
673
|
*/
|
|
800
|
-
|
|
674
|
+
fileName?: string;
|
|
675
|
+
}
|
|
676
|
+
interface CustomTag {
|
|
801
677
|
/**
|
|
802
|
-
*
|
|
678
|
+
* the msid the tag is related to
|
|
803
679
|
* @format GUID
|
|
804
680
|
*/
|
|
805
|
-
|
|
681
|
+
metaSiteId?: string;
|
|
806
682
|
/**
|
|
807
|
-
*
|
|
808
|
-
* @
|
|
683
|
+
* Tag to invalidate by
|
|
684
|
+
* @minLength 1
|
|
685
|
+
* @maxLength 256
|
|
809
686
|
*/
|
|
810
|
-
|
|
811
|
-
/** @readonly */
|
|
812
|
-
identityType?: WebhookIdentityTypeWithLiterals;
|
|
687
|
+
tag?: string;
|
|
813
688
|
}
|
|
814
|
-
|
|
815
|
-
interface IdentificationDataIdOneOf {
|
|
689
|
+
interface Pages {
|
|
816
690
|
/**
|
|
817
|
-
*
|
|
691
|
+
* the msid the pages are on
|
|
818
692
|
* @format GUID
|
|
819
693
|
*/
|
|
820
|
-
|
|
694
|
+
metaSiteId?: string;
|
|
821
695
|
/**
|
|
822
|
-
*
|
|
696
|
+
* Invalidate by multiple Page IDs in a single message
|
|
697
|
+
* @maxSize 100
|
|
698
|
+
* @minLength 1
|
|
699
|
+
*/
|
|
700
|
+
pageIds?: string[];
|
|
701
|
+
}
|
|
702
|
+
interface URIs {
|
|
703
|
+
/**
|
|
704
|
+
* the msid the URIs are on
|
|
823
705
|
* @format GUID
|
|
824
706
|
*/
|
|
825
|
-
|
|
707
|
+
metaSiteId?: string;
|
|
826
708
|
/**
|
|
827
|
-
*
|
|
709
|
+
* URI paths to invalidate (e.g. page/my/path) - without leading/trailing slashes
|
|
710
|
+
* @maxSize 100
|
|
711
|
+
* @minLength 1
|
|
712
|
+
*/
|
|
713
|
+
uriPaths?: string[];
|
|
714
|
+
}
|
|
715
|
+
interface DeleteOrphanSections {
|
|
716
|
+
/** Menu id */
|
|
717
|
+
menuId?: string;
|
|
718
|
+
}
|
|
719
|
+
interface MenusDataCloningCompleted {
|
|
720
|
+
}
|
|
721
|
+
interface CreateMenuRequest {
|
|
722
|
+
/** Menu details. */
|
|
723
|
+
menu: Menu;
|
|
724
|
+
}
|
|
725
|
+
interface CreateMenuResponse {
|
|
726
|
+
/** Menu. */
|
|
727
|
+
menu?: Menu;
|
|
728
|
+
}
|
|
729
|
+
interface BulkCreateMenusRequest {
|
|
730
|
+
/**
|
|
731
|
+
* Menu details.
|
|
732
|
+
* @maxSize 100
|
|
733
|
+
*/
|
|
734
|
+
menus: Menu[];
|
|
735
|
+
/** Whether to receive the created menus in the response. */
|
|
736
|
+
returnEntity?: boolean;
|
|
737
|
+
}
|
|
738
|
+
interface BulkCreateMenusResponse {
|
|
739
|
+
/** Information about the created menus. */
|
|
740
|
+
results?: BulkCreateMenuResult[];
|
|
741
|
+
/** Metadata for the API call. */
|
|
742
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
743
|
+
}
|
|
744
|
+
interface BulkCreateMenuResult {
|
|
745
|
+
/** Whether to receive the created menus in the response. */
|
|
746
|
+
menuMetadata?: ItemMetadata;
|
|
747
|
+
/** Created menu. */
|
|
748
|
+
menu?: Menu;
|
|
749
|
+
}
|
|
750
|
+
interface ItemMetadata {
|
|
751
|
+
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
752
|
+
_id?: string | null;
|
|
753
|
+
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
754
|
+
originalIndex?: number;
|
|
755
|
+
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
756
|
+
success?: boolean;
|
|
757
|
+
/** Details about the error in case of failure. */
|
|
758
|
+
error?: ApplicationError;
|
|
759
|
+
}
|
|
760
|
+
interface ApplicationError {
|
|
761
|
+
/** Error code. */
|
|
762
|
+
code?: string;
|
|
763
|
+
/** Description of the error. */
|
|
764
|
+
description?: string;
|
|
765
|
+
/** Data related to the error. */
|
|
766
|
+
data?: Record<string, any> | null;
|
|
767
|
+
}
|
|
768
|
+
interface BulkActionMetadata {
|
|
769
|
+
/** Number of items that were successfully processed. */
|
|
770
|
+
totalSuccesses?: number;
|
|
771
|
+
/** Number of items that couldn't be processed. */
|
|
772
|
+
totalFailures?: number;
|
|
773
|
+
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
774
|
+
undetailedFailures?: number;
|
|
775
|
+
}
|
|
776
|
+
interface GetMenuRequest {
|
|
777
|
+
/**
|
|
778
|
+
* Menu ID.
|
|
828
779
|
* @format GUID
|
|
829
780
|
*/
|
|
830
|
-
|
|
781
|
+
menuId: string;
|
|
782
|
+
}
|
|
783
|
+
interface GetMenuResponse {
|
|
784
|
+
/** Menu. */
|
|
785
|
+
menu?: Menu;
|
|
786
|
+
}
|
|
787
|
+
interface ListMenusRequest {
|
|
831
788
|
/**
|
|
832
|
-
*
|
|
789
|
+
* Menu IDs.
|
|
833
790
|
* @format GUID
|
|
791
|
+
* @maxSize 500
|
|
834
792
|
*/
|
|
835
|
-
|
|
793
|
+
menuIds?: string[];
|
|
794
|
+
/** The metadata of the paginated results. */
|
|
795
|
+
paging?: CursorPaging;
|
|
796
|
+
/** Whether to return only menus that are visible to site visitors. */
|
|
797
|
+
onlyVisible?: boolean | null;
|
|
798
|
+
}
|
|
799
|
+
interface ListMenusResponse {
|
|
800
|
+
/** Retrieved menus. */
|
|
801
|
+
menus?: Menu[];
|
|
802
|
+
/** The metadata of the paginated results. */
|
|
803
|
+
pagingMetadata?: CursorPagingMetadata;
|
|
804
|
+
}
|
|
805
|
+
interface QueryMenusRequest {
|
|
806
|
+
/** Query options. */
|
|
807
|
+
query?: CursorQuery;
|
|
808
|
+
}
|
|
809
|
+
interface QueryMenusResponse {
|
|
810
|
+
/** Retrieved menus. */
|
|
811
|
+
menus?: Menu[];
|
|
812
|
+
/** The metadata of the paginated results. */
|
|
813
|
+
pagingMetadata?: CursorPagingMetadata;
|
|
836
814
|
}
|
|
837
|
-
|
|
838
|
-
|
|
839
|
-
|
|
840
|
-
MEMBER = "MEMBER",
|
|
841
|
-
WIX_USER = "WIX_USER",
|
|
842
|
-
APP = "APP"
|
|
815
|
+
interface UpdateMenuRequest {
|
|
816
|
+
/** Menu to update. */
|
|
817
|
+
menu: Menu;
|
|
843
818
|
}
|
|
844
|
-
|
|
845
|
-
|
|
846
|
-
|
|
847
|
-
|
|
848
|
-
|
|
849
|
-
* @format GUID
|
|
850
|
-
*/
|
|
851
|
-
accountId?: string | null;
|
|
852
|
-
/**
|
|
853
|
-
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
854
|
-
* @format GUID
|
|
855
|
-
*/
|
|
856
|
-
parentAccountId?: string | null;
|
|
819
|
+
interface UpdateMenuResponse {
|
|
820
|
+
/** Updated menu. */
|
|
821
|
+
menu?: Menu;
|
|
822
|
+
}
|
|
823
|
+
interface BulkUpdateMenuRequest {
|
|
857
824
|
/**
|
|
858
|
-
*
|
|
859
|
-
* @
|
|
825
|
+
* Menus to update.
|
|
826
|
+
* @minSize 1
|
|
827
|
+
* @maxSize 100
|
|
860
828
|
*/
|
|
861
|
-
|
|
829
|
+
menus: MaskedMenu[];
|
|
830
|
+
/** Whether to receive the entity in the response. */
|
|
831
|
+
returnEntity?: boolean;
|
|
862
832
|
}
|
|
863
|
-
interface
|
|
833
|
+
interface MaskedMenu {
|
|
834
|
+
/** Menu to updated. */
|
|
835
|
+
menu?: Menu;
|
|
836
|
+
/** Explicit list of fields to update. */
|
|
837
|
+
mask?: string[];
|
|
838
|
+
}
|
|
839
|
+
interface BulkUpdateMenuResponse {
|
|
864
840
|
/**
|
|
865
|
-
*
|
|
866
|
-
* @
|
|
841
|
+
* Results of bulk menu update.
|
|
842
|
+
* @minSize 1
|
|
843
|
+
* @maxSize 100
|
|
867
844
|
*/
|
|
845
|
+
results?: BulkMenuResult[];
|
|
846
|
+
/** Metadata for the API call. */
|
|
847
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
848
|
+
}
|
|
849
|
+
interface BulkMenuResult {
|
|
850
|
+
/** Metadata for menu update. */
|
|
851
|
+
menuMetadata?: ItemMetadata;
|
|
852
|
+
/** Updated menu. Only returned if `returnEntity` is set to `true`. */
|
|
853
|
+
menu?: Menu;
|
|
854
|
+
}
|
|
855
|
+
interface UpdateExtendedFieldsRequest {
|
|
856
|
+
/** ID of the entity to update. */
|
|
868
857
|
_id: string;
|
|
858
|
+
/** Identifier for the app whose extended fields are being updated. */
|
|
859
|
+
namespace: string;
|
|
860
|
+
/** 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. */
|
|
861
|
+
namespaceData: Record<string, any> | null;
|
|
862
|
+
}
|
|
863
|
+
interface UpdateExtendedFieldsResponse {
|
|
864
|
+
/** Namespace of the app. */
|
|
865
|
+
namespace?: string;
|
|
866
|
+
/** Updated extended fields data. */
|
|
867
|
+
namespaceData?: Record<string, any> | null;
|
|
868
|
+
}
|
|
869
|
+
interface DeleteMenuRequest {
|
|
869
870
|
/**
|
|
870
|
-
*
|
|
871
|
+
* Menu ID.
|
|
871
872
|
* @format GUID
|
|
872
|
-
* @maxSize 100
|
|
873
873
|
*/
|
|
874
|
-
|
|
875
|
-
|
|
876
|
-
|
|
874
|
+
menuId: string;
|
|
875
|
+
}
|
|
876
|
+
interface DeleteMenuResponse {
|
|
877
|
+
}
|
|
878
|
+
interface RunMenusMultiLocationMigrationRequest {
|
|
877
879
|
/**
|
|
878
|
-
*
|
|
879
|
-
* @
|
|
880
|
+
* business location id
|
|
881
|
+
* @format GUID
|
|
880
882
|
*/
|
|
881
|
-
|
|
883
|
+
businessLocationId?: string;
|
|
882
884
|
}
|
|
883
|
-
interface
|
|
885
|
+
interface RunMenusMultiLocationMigrationResponse {
|
|
886
|
+
/** Whether menus multi-location migration finished successfully */
|
|
887
|
+
success?: boolean;
|
|
888
|
+
}
|
|
889
|
+
interface UpdateBusinessLocationIdRequest {
|
|
884
890
|
/** @format GUID */
|
|
885
|
-
|
|
891
|
+
menuId?: string;
|
|
892
|
+
/** @format GUID */
|
|
893
|
+
businessLocationId?: string | null;
|
|
886
894
|
}
|
|
887
|
-
interface
|
|
895
|
+
interface UpdateBusinessLocationIdResponse {
|
|
896
|
+
}
|
|
897
|
+
interface CloneMenusRequest {
|
|
888
898
|
/**
|
|
889
|
-
*
|
|
899
|
+
* The MetaSiteId to clone from.
|
|
890
900
|
* @format GUID
|
|
891
|
-
* @readonly
|
|
892
901
|
*/
|
|
893
|
-
|
|
902
|
+
metaSiteId?: string;
|
|
894
903
|
}
|
|
895
|
-
interface
|
|
896
|
-
/** Retrieved menuInfo with path url. */
|
|
897
|
-
menuSiteUrl?: MenuSiteUrl;
|
|
904
|
+
interface CloneMenusResponse {
|
|
898
905
|
}
|
|
899
|
-
interface
|
|
906
|
+
interface Empty {
|
|
907
|
+
}
|
|
908
|
+
interface SyncContentToMultilingualRequest {
|
|
900
909
|
/**
|
|
901
|
-
*
|
|
902
|
-
* @
|
|
903
|
-
* @maxLength 1000
|
|
910
|
+
* MetaSite ID
|
|
911
|
+
* @format GUID
|
|
904
912
|
*/
|
|
905
|
-
|
|
906
|
-
}
|
|
907
|
-
interface QueryMenusSiteUrlRequest {
|
|
908
|
-
/** Query options */
|
|
909
|
-
query?: CursorQuery;
|
|
913
|
+
metaSiteId?: string;
|
|
910
914
|
}
|
|
911
|
-
interface
|
|
912
|
-
/** Retrieved menuInfos with path urls. */
|
|
913
|
-
menuSiteUrls?: MenuSiteUrl[];
|
|
914
|
-
/** The metadata of the paginated results. */
|
|
915
|
-
pagingMetadata?: CursorPagingMetadata;
|
|
915
|
+
interface SyncContentToMultilingualResponse {
|
|
916
916
|
}
|
|
917
917
|
interface BaseEventMetadata {
|
|
918
918
|
/**
|
|
@@ -969,6 +969,21 @@ interface AccountInfoMetadata {
|
|
|
969
969
|
/** ID of the parent Wix account. Only included when 'accountId' belongs to a child account. */
|
|
970
970
|
parentAccountId?: string;
|
|
971
971
|
}
|
|
972
|
+
interface MenuUpdatedEnvelope {
|
|
973
|
+
entity: Menu;
|
|
974
|
+
metadata: EventMetadata;
|
|
975
|
+
/** @hidden */
|
|
976
|
+
modifiedFields: Record<string, any>;
|
|
977
|
+
}
|
|
978
|
+
/** @permissionScope Manage Restaurants - all permissions
|
|
979
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
980
|
+
* @permissionId RESTAURANTS.MENU_READ
|
|
981
|
+
* @webhook
|
|
982
|
+
* @eventType wix.restaurants.menus.v1.menu_updated
|
|
983
|
+
* @slug updated
|
|
984
|
+
* @documentationMaturity preview
|
|
985
|
+
*/
|
|
986
|
+
declare function onMenuUpdated(handler: (event: MenuUpdatedEnvelope) => void | Promise<void>): void;
|
|
972
987
|
interface MenuCreatedEnvelope {
|
|
973
988
|
entity: Menu;
|
|
974
989
|
metadata: EventMetadata;
|
|
@@ -998,21 +1013,54 @@ interface MenuDeletedEnvelope {
|
|
|
998
1013
|
* @documentationMaturity preview
|
|
999
1014
|
*/
|
|
1000
1015
|
declare function onMenuDeleted(handler: (event: MenuDeletedEnvelope) => void | Promise<void>): void;
|
|
1001
|
-
|
|
1002
|
-
|
|
1003
|
-
|
|
1004
|
-
|
|
1005
|
-
|
|
1016
|
+
/** @param _id - Menu id to be duplicated.
|
|
1017
|
+
* @public
|
|
1018
|
+
* @documentationMaturity preview
|
|
1019
|
+
* @requiredField _id
|
|
1020
|
+
* @permissionId RESTAURANTS.MENU_CREATE
|
|
1021
|
+
* @applicableIdentity APP
|
|
1022
|
+
* @fqn com.wixpress.restaurants.menus_menu.v1.restaurants_duplicate_menu.RestaurantsDuplicateMenu.DuplicateMenu
|
|
1023
|
+
*/
|
|
1024
|
+
declare function duplicateMenu(_id: string, options?: DuplicateMenuOptions): Promise<NonNullablePaths<DuplicateMenuResponse, `menuIds`, 0>>;
|
|
1025
|
+
interface DuplicateMenuOptions {
|
|
1026
|
+
/**
|
|
1027
|
+
* Business location ids to duplicate the menu to.
|
|
1028
|
+
* @format GUID
|
|
1029
|
+
* @maxSize 100
|
|
1030
|
+
*/
|
|
1031
|
+
businessLocationIds?: string[] | null;
|
|
1032
|
+
/** Indicates whether sub-entities (such as items) should be duplicated as well. */
|
|
1033
|
+
duplicateSubEntities?: boolean | null;
|
|
1034
|
+
/**
|
|
1035
|
+
* The new name of the duplicated menu.
|
|
1036
|
+
* @maxLength 500
|
|
1037
|
+
*/
|
|
1038
|
+
menuName?: string | null;
|
|
1006
1039
|
}
|
|
1007
|
-
/**
|
|
1008
|
-
*
|
|
1040
|
+
/**
|
|
1041
|
+
* Get menu details and path URL by menu ID.
|
|
1042
|
+
* @param _id - Menu ID.
|
|
1043
|
+
* @public
|
|
1044
|
+
* @documentationMaturity preview
|
|
1045
|
+
* @requiredField _id
|
|
1009
1046
|
* @permissionId RESTAURANTS.MENU_READ
|
|
1010
|
-
* @
|
|
1011
|
-
* @
|
|
1012
|
-
|
|
1047
|
+
* @applicableIdentity APP
|
|
1048
|
+
* @fqn com.wixpress.restaurants.menus_menu.v1.restaurants_menus_site_url.RestaurantsMenusSiteUrl.GetMenuSiteUrl
|
|
1049
|
+
*/
|
|
1050
|
+
declare function getMenuSiteUrl(_id: string): Promise<NonNullablePaths<GetMenuSiteUrlResponse, `menuSiteUrl.path`, 1>>;
|
|
1051
|
+
/**
|
|
1052
|
+
* Query menu details and path URL
|
|
1053
|
+
* @public
|
|
1013
1054
|
* @documentationMaturity preview
|
|
1055
|
+
* @permissionId RESTAURANTS.MENU_READ
|
|
1056
|
+
* @applicableIdentity APP
|
|
1057
|
+
* @fqn com.wixpress.restaurants.menus_menu.v1.restaurants_menus_site_url.RestaurantsMenusSiteUrl.QueryMenusSiteUrl
|
|
1014
1058
|
*/
|
|
1015
|
-
declare function
|
|
1059
|
+
declare function queryMenusSiteUrl(options?: QueryMenusSiteUrlOptions): Promise<NonNullablePaths<QueryMenusSiteUrlResponse, `menuSiteUrls` | `menuSiteUrls.${number}.path`, 2>>;
|
|
1060
|
+
interface QueryMenusSiteUrlOptions {
|
|
1061
|
+
/** Query options */
|
|
1062
|
+
query?: CursorQuery;
|
|
1063
|
+
}
|
|
1016
1064
|
/**
|
|
1017
1065
|
* > **Note:** The Menus API only works with the Wix Restaurants Menus app. Make sure you have installed this app from the [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).
|
|
1018
1066
|
*
|
|
@@ -1399,53 +1447,5 @@ interface UpdateExtendedFieldsOptions {
|
|
|
1399
1447
|
* @fqn com.wixpress.restaurants.menus_menu.v1.RestaurantsMenusMenu.DeleteMenu
|
|
1400
1448
|
*/
|
|
1401
1449
|
declare function deleteMenu(menuId: string): Promise<void>;
|
|
1402
|
-
/** @param _id - Menu id to be duplicated.
|
|
1403
|
-
* @public
|
|
1404
|
-
* @documentationMaturity preview
|
|
1405
|
-
* @requiredField _id
|
|
1406
|
-
* @permissionId RESTAURANTS.MENU_CREATE
|
|
1407
|
-
* @applicableIdentity APP
|
|
1408
|
-
* @fqn com.wixpress.restaurants.menus_menu.v1.restaurants_duplicate_menu.RestaurantsDuplicateMenu.DuplicateMenu
|
|
1409
|
-
*/
|
|
1410
|
-
declare function duplicateMenu(_id: string, options?: DuplicateMenuOptions): Promise<NonNullablePaths<DuplicateMenuResponse, `menuIds`, 0>>;
|
|
1411
|
-
interface DuplicateMenuOptions {
|
|
1412
|
-
/**
|
|
1413
|
-
* Business location ids to duplicate the menu to.
|
|
1414
|
-
* @format GUID
|
|
1415
|
-
* @maxSize 100
|
|
1416
|
-
*/
|
|
1417
|
-
businessLocationIds?: string[] | null;
|
|
1418
|
-
/** Indicates whether sub-entities (such as items) should be duplicated as well. */
|
|
1419
|
-
duplicateSubEntities?: boolean | null;
|
|
1420
|
-
/**
|
|
1421
|
-
* The new name of the duplicated menu.
|
|
1422
|
-
* @maxLength 500
|
|
1423
|
-
*/
|
|
1424
|
-
menuName?: string | null;
|
|
1425
|
-
}
|
|
1426
|
-
/**
|
|
1427
|
-
* Get menu details and path URL by menu ID.
|
|
1428
|
-
* @param _id - Menu ID.
|
|
1429
|
-
* @public
|
|
1430
|
-
* @documentationMaturity preview
|
|
1431
|
-
* @requiredField _id
|
|
1432
|
-
* @permissionId RESTAURANTS.MENU_READ
|
|
1433
|
-
* @applicableIdentity APP
|
|
1434
|
-
* @fqn com.wixpress.restaurants.menus_menu.v1.restaurants_menus_site_url.RestaurantsMenusSiteUrl.GetMenuSiteUrl
|
|
1435
|
-
*/
|
|
1436
|
-
declare function getMenuSiteUrl(_id: string): Promise<NonNullablePaths<GetMenuSiteUrlResponse, `menuSiteUrl.path`, 1>>;
|
|
1437
|
-
/**
|
|
1438
|
-
* Query menu details and path URL
|
|
1439
|
-
* @public
|
|
1440
|
-
* @documentationMaturity preview
|
|
1441
|
-
* @permissionId RESTAURANTS.MENU_READ
|
|
1442
|
-
* @applicableIdentity APP
|
|
1443
|
-
* @fqn com.wixpress.restaurants.menus_menu.v1.restaurants_menus_site_url.RestaurantsMenusSiteUrl.QueryMenusSiteUrl
|
|
1444
|
-
*/
|
|
1445
|
-
declare function queryMenusSiteUrl(options?: QueryMenusSiteUrlOptions): Promise<NonNullablePaths<QueryMenusSiteUrlResponse, `menuSiteUrls` | `menuSiteUrls.${number}.path`, 2>>;
|
|
1446
|
-
interface QueryMenusSiteUrlOptions {
|
|
1447
|
-
/** Query options */
|
|
1448
|
-
query?: CursorQuery;
|
|
1449
|
-
}
|
|
1450
1450
|
|
|
1451
1451
|
export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, type AddressLocation, type App, type ApplicationError, type BaseEventMetadata, type BulkActionMetadata, type BulkCreateMenuResult, type BulkCreateMenusOptions, type BulkCreateMenusRequest, type BulkCreateMenusResponse, type BulkMenuResult, type BulkUpdateMenuOptions, type BulkUpdateMenuRequest, type BulkUpdateMenuResponse, type BusinessLocationDetails, type CloneMenusRequest, type CloneMenusResponse, type CommonQueryWithEntityContext, type CreateMenuRequest, type CreateMenuResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type CustomTag, type DeleteMenuRequest, type DeleteMenuResponse, type DeleteOrphanSections, type DomainEvent, type DomainEventBodyOneOf, type DuplicateMenuOptions, type DuplicateMenuRequest, type DuplicateMenuResponse, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExtendedFields, type ExternalReferenceInfo, type File, type GetMenuRequest, type GetMenuResponse, type GetMenuSiteUrlRequest, type GetMenuSiteUrlResponse, type IdentificationData, type IdentificationDataIdOneOf, type InvalidateCache, type InvalidateCacheGetByOneOf, type ItemMetadata, type Keyword, type ListMenusOptions, type ListMenusRequest, type ListMenusResponse, type MaskedMenu, type Menu, type MenuCreatedEnvelope, type MenuDeletedEnvelope, type MenuQuery, type MenuQuerySpec, type MenuSiteUrl, type MenuUpdatedEnvelope, type MenusDataCloningCompleted, type MenusQueryBuilder, type MenusQueryResult, type MessageEnvelope, type Page, type Pages, type QueryMenusRequest, type QueryMenusResponse, type QueryMenusSiteUrlOptions, type QueryMenusSiteUrlRequest, type QueryMenusSiteUrlResponse, type RestoreInfo, type RunMenusMultiLocationMigrationRequest, type RunMenusMultiLocationMigrationResponse, type SeoSchema, type Settings, SortOrder, type SortOrderWithLiterals, type Sorting, type SyncContentToMultilingualRequest, type SyncContentToMultilingualResponse, type Tag, type URI, type URIs, type UpdateBusinessLocationIdRequest, type UpdateBusinessLocationIdResponse, type UpdateExtendedFieldsOptions, type UpdateExtendedFieldsRequest, type UpdateExtendedFieldsResponse, type UpdateMenu, type UpdateMenuRequest, type UpdateMenuResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, bulkCreateMenus, bulkUpdateMenu, createMenu, deleteMenu, duplicateMenu, getMenu, getMenuSiteUrl, listMenus, onMenuCreated, onMenuDeleted, onMenuUpdated, queryMenus, queryMenusSiteUrl, typedQueryMenus, updateExtendedFields, updateMenu, utils };
|