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