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