@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
|
@@ -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,320 +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
501
|
*/
|
|
615
|
-
|
|
616
|
-
}
|
|
617
|
-
interface RunMenusMultiLocationMigrationResponse {
|
|
618
|
-
/** Whether menus multi-location migration finished successfully */
|
|
619
|
-
success?: boolean;
|
|
620
|
-
}
|
|
621
|
-
interface UpdateBusinessLocationIdRequest {
|
|
622
|
-
/** @format GUID */
|
|
623
|
-
menuId?: string;
|
|
624
|
-
/** @format GUID */
|
|
625
|
-
businessLocationId?: string | null;
|
|
626
|
-
}
|
|
627
|
-
interface UpdateBusinessLocationIdResponse {
|
|
628
|
-
}
|
|
629
|
-
interface CloneMenusRequest {
|
|
502
|
+
metaSiteId?: string;
|
|
630
503
|
/**
|
|
631
|
-
*
|
|
504
|
+
* Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
|
|
632
505
|
* @format GUID
|
|
633
506
|
*/
|
|
634
|
-
|
|
635
|
-
|
|
636
|
-
|
|
637
|
-
|
|
638
|
-
|
|
639
|
-
|
|
640
|
-
|
|
641
|
-
|
|
642
|
-
|
|
643
|
-
/**
|
|
644
|
-
|
|
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;
|
|
645
522
|
/**
|
|
646
|
-
*
|
|
647
|
-
*
|
|
523
|
+
* tell us why you're invalidating the cache. You don't need to add your app name
|
|
524
|
+
* @maxLength 256
|
|
648
525
|
*/
|
|
649
|
-
|
|
526
|
+
reason?: string | null;
|
|
527
|
+
/** Is local DS */
|
|
528
|
+
localDc?: boolean;
|
|
529
|
+
hardPurge?: boolean;
|
|
650
530
|
/**
|
|
651
|
-
*
|
|
652
|
-
*
|
|
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
|
|
653
536
|
*/
|
|
654
|
-
|
|
655
|
-
|
|
656
|
-
|
|
657
|
-
|
|
658
|
-
eventTime?: Date | null;
|
|
537
|
+
correlationId?: string | null;
|
|
538
|
+
}
|
|
539
|
+
/** @oneof */
|
|
540
|
+
interface InvalidateCacheGetByOneOf {
|
|
659
541
|
/**
|
|
660
|
-
*
|
|
661
|
-
*
|
|
542
|
+
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
543
|
+
* @format GUID
|
|
662
544
|
*/
|
|
663
|
-
|
|
664
|
-
/** If present, indicates the action that triggered the event. */
|
|
665
|
-
originatedFrom?: string | null;
|
|
545
|
+
metaSiteId?: string;
|
|
666
546
|
/**
|
|
667
|
-
*
|
|
668
|
-
*
|
|
547
|
+
* Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
|
|
548
|
+
* @format GUID
|
|
669
549
|
*/
|
|
670
|
-
|
|
671
|
-
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
|
|
675
|
-
|
|
676
|
-
|
|
677
|
-
|
|
678
|
-
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
|
|
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;
|
|
684
565
|
}
|
|
685
|
-
interface
|
|
566
|
+
interface App {
|
|
686
567
|
/**
|
|
687
|
-
*
|
|
688
|
-
*
|
|
689
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
568
|
+
* The AppDefId
|
|
569
|
+
* @minLength 1
|
|
690
570
|
*/
|
|
691
|
-
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
|
|
695
|
-
|
|
696
|
-
|
|
697
|
-
interface ActionEvent {
|
|
698
|
-
body?: string;
|
|
699
|
-
}
|
|
700
|
-
interface Empty {
|
|
571
|
+
appDefId?: string;
|
|
572
|
+
/**
|
|
573
|
+
* The instance Id
|
|
574
|
+
* @format GUID
|
|
575
|
+
*/
|
|
576
|
+
instanceId?: string;
|
|
701
577
|
}
|
|
702
|
-
interface
|
|
578
|
+
interface Page {
|
|
703
579
|
/**
|
|
704
|
-
*
|
|
580
|
+
* the msid the page is on
|
|
705
581
|
* @format GUID
|
|
706
582
|
*/
|
|
707
583
|
metaSiteId?: string;
|
|
584
|
+
/**
|
|
585
|
+
* Invalidate by Page ID
|
|
586
|
+
* @minLength 1
|
|
587
|
+
*/
|
|
588
|
+
pageId?: string;
|
|
708
589
|
}
|
|
709
|
-
interface
|
|
710
|
-
}
|
|
711
|
-
interface MessageEnvelope {
|
|
590
|
+
interface URI {
|
|
712
591
|
/**
|
|
713
|
-
*
|
|
592
|
+
* the msid the URI is on
|
|
714
593
|
* @format GUID
|
|
715
594
|
*/
|
|
716
|
-
|
|
595
|
+
metaSiteId?: string;
|
|
717
596
|
/**
|
|
718
|
-
*
|
|
719
|
-
* @
|
|
597
|
+
* URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes
|
|
598
|
+
* @minLength 1
|
|
720
599
|
*/
|
|
721
|
-
|
|
722
|
-
/** The identification type and identity data. */
|
|
723
|
-
identity?: IdentificationData;
|
|
724
|
-
/** Stringify payload. */
|
|
725
|
-
data?: string;
|
|
726
|
-
/** Details related to the account */
|
|
727
|
-
accountInfo?: AccountInfo;
|
|
600
|
+
uriPath?: string;
|
|
728
601
|
}
|
|
729
|
-
interface
|
|
602
|
+
interface File {
|
|
730
603
|
/**
|
|
731
|
-
*
|
|
604
|
+
* the msid the file is related to
|
|
732
605
|
* @format GUID
|
|
733
606
|
*/
|
|
734
|
-
|
|
607
|
+
metaSiteId?: string;
|
|
735
608
|
/**
|
|
736
|
-
*
|
|
737
|
-
* @
|
|
609
|
+
* Invalidate by filename (for media files such as PDFs)
|
|
610
|
+
* @minLength 1
|
|
611
|
+
* @maxLength 256
|
|
738
612
|
*/
|
|
739
|
-
|
|
613
|
+
fileName?: string;
|
|
614
|
+
}
|
|
615
|
+
interface CustomTag {
|
|
740
616
|
/**
|
|
741
|
-
*
|
|
617
|
+
* the msid the tag is related to
|
|
742
618
|
* @format GUID
|
|
743
619
|
*/
|
|
744
|
-
|
|
620
|
+
metaSiteId?: string;
|
|
745
621
|
/**
|
|
746
|
-
*
|
|
622
|
+
* Tag to invalidate by
|
|
623
|
+
* @minLength 1
|
|
624
|
+
* @maxLength 256
|
|
625
|
+
*/
|
|
626
|
+
tag?: string;
|
|
627
|
+
}
|
|
628
|
+
interface Pages {
|
|
629
|
+
/**
|
|
630
|
+
* the msid the pages are on
|
|
747
631
|
* @format GUID
|
|
748
632
|
*/
|
|
749
|
-
|
|
750
|
-
/**
|
|
751
|
-
|
|
633
|
+
metaSiteId?: string;
|
|
634
|
+
/**
|
|
635
|
+
* Invalidate by multiple Page IDs in a single message
|
|
636
|
+
* @maxSize 100
|
|
637
|
+
* @minLength 1
|
|
638
|
+
*/
|
|
639
|
+
pageIds?: string[];
|
|
752
640
|
}
|
|
753
|
-
|
|
754
|
-
interface IdentificationDataIdOneOf {
|
|
641
|
+
interface URIs {
|
|
755
642
|
/**
|
|
756
|
-
*
|
|
643
|
+
* the msid the URIs are on
|
|
757
644
|
* @format GUID
|
|
758
645
|
*/
|
|
759
|
-
|
|
646
|
+
metaSiteId?: string;
|
|
760
647
|
/**
|
|
761
|
-
*
|
|
648
|
+
* URI paths to invalidate (e.g. page/my/path) - without leading/trailing slashes
|
|
649
|
+
* @maxSize 100
|
|
650
|
+
* @minLength 1
|
|
651
|
+
*/
|
|
652
|
+
uriPaths?: string[];
|
|
653
|
+
}
|
|
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 {
|
|
669
|
+
/**
|
|
670
|
+
* Menu details.
|
|
671
|
+
* @maxSize 100
|
|
672
|
+
*/
|
|
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 {
|
|
716
|
+
/**
|
|
717
|
+
* Menu ID.
|
|
762
718
|
* @format GUID
|
|
763
719
|
*/
|
|
764
|
-
|
|
720
|
+
menuId: string;
|
|
721
|
+
}
|
|
722
|
+
interface GetMenuResponse {
|
|
723
|
+
/** Menu. */
|
|
724
|
+
menu?: Menu;
|
|
725
|
+
}
|
|
726
|
+
interface ListMenusRequest {
|
|
765
727
|
/**
|
|
766
|
-
*
|
|
728
|
+
* Menu IDs.
|
|
767
729
|
* @format GUID
|
|
730
|
+
* @maxSize 500
|
|
768
731
|
*/
|
|
769
|
-
|
|
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 {
|
|
770
763
|
/**
|
|
771
|
-
*
|
|
772
|
-
* @
|
|
764
|
+
* Menus to update.
|
|
765
|
+
* @minSize 1
|
|
766
|
+
* @maxSize 100
|
|
773
767
|
*/
|
|
774
|
-
|
|
768
|
+
menus: MaskedMenu[];
|
|
769
|
+
/** Whether to receive the entity in the response. */
|
|
770
|
+
returnEntity?: boolean;
|
|
775
771
|
}
|
|
776
|
-
|
|
777
|
-
|
|
778
|
-
|
|
779
|
-
|
|
780
|
-
|
|
781
|
-
APP = "APP"
|
|
772
|
+
interface MaskedMenu {
|
|
773
|
+
/** Menu to updated. */
|
|
774
|
+
menu?: Menu;
|
|
775
|
+
/** Explicit list of fields to update. */
|
|
776
|
+
mask?: string[];
|
|
782
777
|
}
|
|
783
|
-
|
|
784
|
-
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
785
|
-
interface AccountInfo {
|
|
778
|
+
interface BulkUpdateMenuResponse {
|
|
786
779
|
/**
|
|
787
|
-
*
|
|
788
|
-
* @
|
|
780
|
+
* Results of bulk menu update.
|
|
781
|
+
* @minSize 1
|
|
782
|
+
* @maxSize 100
|
|
789
783
|
*/
|
|
790
|
-
|
|
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 {
|
|
791
809
|
/**
|
|
792
|
-
* ID
|
|
810
|
+
* Menu ID.
|
|
793
811
|
* @format GUID
|
|
794
812
|
*/
|
|
795
|
-
|
|
813
|
+
menuId: string;
|
|
814
|
+
}
|
|
815
|
+
interface DeleteMenuResponse {
|
|
816
|
+
}
|
|
817
|
+
interface RestoreMenusFromTrashRequest {
|
|
796
818
|
/**
|
|
797
|
-
*
|
|
819
|
+
* Menu IDs to restore from the trash bin.
|
|
798
820
|
* @format GUID
|
|
821
|
+
* @minSize 1
|
|
822
|
+
* @maxSize 100
|
|
799
823
|
*/
|
|
800
|
-
|
|
824
|
+
menuIds?: string[];
|
|
801
825
|
}
|
|
802
|
-
interface
|
|
826
|
+
interface RestoreMenusFromTrashResponse {
|
|
803
827
|
/**
|
|
804
|
-
* Menu
|
|
828
|
+
* Menu IDs that were successfully restored.
|
|
805
829
|
* @format GUID
|
|
830
|
+
* @maxSize 100
|
|
806
831
|
*/
|
|
807
|
-
|
|
832
|
+
restoredMenuIds?: string[];
|
|
808
833
|
/**
|
|
809
|
-
*
|
|
834
|
+
* Menu IDs that failed to restore.
|
|
810
835
|
* @format GUID
|
|
811
836
|
* @maxSize 100
|
|
812
837
|
*/
|
|
813
|
-
|
|
814
|
-
|
|
815
|
-
|
|
838
|
+
failedMenuIds?: string[];
|
|
839
|
+
}
|
|
840
|
+
interface RunMenusMultiLocationMigrationRequest {
|
|
816
841
|
/**
|
|
817
|
-
*
|
|
818
|
-
* @
|
|
842
|
+
* business location id
|
|
843
|
+
* @format GUID
|
|
819
844
|
*/
|
|
820
|
-
|
|
845
|
+
businessLocationId?: string;
|
|
821
846
|
}
|
|
822
|
-
interface
|
|
847
|
+
interface RunMenusMultiLocationMigrationResponse {
|
|
848
|
+
/** Whether menus multi-location migration finished successfully */
|
|
849
|
+
success?: boolean;
|
|
850
|
+
}
|
|
851
|
+
interface UpdateBusinessLocationIdRequest {
|
|
823
852
|
/** @format GUID */
|
|
824
|
-
|
|
853
|
+
menuId?: string;
|
|
854
|
+
/** @format GUID */
|
|
855
|
+
businessLocationId?: string | null;
|
|
825
856
|
}
|
|
826
|
-
interface
|
|
857
|
+
interface UpdateBusinessLocationIdResponse {
|
|
858
|
+
}
|
|
859
|
+
interface CloneMenusRequest {
|
|
827
860
|
/**
|
|
828
|
-
*
|
|
861
|
+
* The MetaSiteId to clone from.
|
|
829
862
|
* @format GUID
|
|
830
|
-
* @readonly
|
|
831
863
|
*/
|
|
832
|
-
|
|
864
|
+
metaSiteId?: string;
|
|
833
865
|
}
|
|
834
|
-
interface
|
|
835
|
-
/** Retrieved menuInfo with path url. */
|
|
836
|
-
menuSiteUrl?: MenuSiteUrl;
|
|
866
|
+
interface CloneMenusResponse {
|
|
837
867
|
}
|
|
838
|
-
interface
|
|
868
|
+
interface Empty {
|
|
869
|
+
}
|
|
870
|
+
interface SyncContentToMultilingualRequest {
|
|
839
871
|
/**
|
|
840
|
-
*
|
|
841
|
-
* @
|
|
842
|
-
* @maxLength 1000
|
|
872
|
+
* MetaSite ID
|
|
873
|
+
* @format GUID
|
|
843
874
|
*/
|
|
844
|
-
|
|
845
|
-
}
|
|
846
|
-
interface QueryMenusSiteUrlRequest {
|
|
847
|
-
/** Query options */
|
|
848
|
-
query?: CursorQuery;
|
|
875
|
+
metaSiteId?: string;
|
|
849
876
|
}
|
|
850
|
-
interface
|
|
851
|
-
/** Retrieved menuInfos with path urls. */
|
|
852
|
-
menuSiteUrls?: MenuSiteUrl[];
|
|
853
|
-
/** The metadata of the paginated results. */
|
|
854
|
-
pagingMetadata?: CursorPagingMetadata;
|
|
877
|
+
interface SyncContentToMultilingualResponse {
|
|
855
878
|
}
|
|
856
879
|
interface BaseEventMetadata {
|
|
857
880
|
/**
|
|
@@ -908,6 +931,21 @@ interface AccountInfoMetadata {
|
|
|
908
931
|
/** ID of the parent Wix account. Only included when 'accountId' belongs to a child account. */
|
|
909
932
|
parentAccountId?: string;
|
|
910
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;
|
|
911
949
|
interface MenuCreatedEnvelope {
|
|
912
950
|
entity: Menu;
|
|
913
951
|
metadata: EventMetadata;
|
|
@@ -937,21 +975,54 @@ interface MenuDeletedEnvelope {
|
|
|
937
975
|
* @documentationMaturity preview
|
|
938
976
|
*/
|
|
939
977
|
declare function onMenuDeleted(handler: (event: MenuDeletedEnvelope) => void | Promise<void>): void;
|
|
940
|
-
|
|
941
|
-
|
|
942
|
-
|
|
943
|
-
|
|
944
|
-
|
|
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;
|
|
945
1001
|
}
|
|
946
|
-
/**
|
|
947
|
-
*
|
|
1002
|
+
/**
|
|
1003
|
+
* Get menu details and path URL by menu ID.
|
|
1004
|
+
* @param _id - Menu ID.
|
|
1005
|
+
* @public
|
|
1006
|
+
* @documentationMaturity preview
|
|
1007
|
+
* @requiredField _id
|
|
948
1008
|
* @permissionId RESTAURANTS.MENU_READ
|
|
949
|
-
* @
|
|
950
|
-
* @
|
|
951
|
-
|
|
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
|
|
952
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
|
|
953
1020
|
*/
|
|
954
|
-
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
|
+
}
|
|
955
1026
|
/**
|
|
956
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).
|
|
957
1028
|
*
|
|
@@ -1338,53 +1409,5 @@ interface UpdateExtendedFieldsOptions {
|
|
|
1338
1409
|
* @fqn com.wixpress.restaurants.menus_menu.v1.RestaurantsMenusMenu.DeleteMenu
|
|
1339
1410
|
*/
|
|
1340
1411
|
declare function deleteMenu(menuId: string): Promise<void>;
|
|
1341
|
-
/** @param _id - Menu id to be duplicated.
|
|
1342
|
-
* @public
|
|
1343
|
-
* @documentationMaturity preview
|
|
1344
|
-
* @requiredField _id
|
|
1345
|
-
* @permissionId RESTAURANTS.MENU_CREATE
|
|
1346
|
-
* @applicableIdentity APP
|
|
1347
|
-
* @fqn com.wixpress.restaurants.menus_menu.v1.restaurants_duplicate_menu.RestaurantsDuplicateMenu.DuplicateMenu
|
|
1348
|
-
*/
|
|
1349
|
-
declare function duplicateMenu(_id: string, options?: DuplicateMenuOptions): Promise<NonNullablePaths<DuplicateMenuResponse, `menuIds`, 0>>;
|
|
1350
|
-
interface DuplicateMenuOptions {
|
|
1351
|
-
/**
|
|
1352
|
-
* Business location ids to duplicate the menu to.
|
|
1353
|
-
* @format GUID
|
|
1354
|
-
* @maxSize 100
|
|
1355
|
-
*/
|
|
1356
|
-
businessLocationIds?: string[] | null;
|
|
1357
|
-
/** Indicates whether sub-entities (such as items) should be duplicated as well. */
|
|
1358
|
-
duplicateSubEntities?: boolean | null;
|
|
1359
|
-
/**
|
|
1360
|
-
* The new name of the duplicated menu.
|
|
1361
|
-
* @maxLength 500
|
|
1362
|
-
*/
|
|
1363
|
-
menuName?: string | null;
|
|
1364
|
-
}
|
|
1365
|
-
/**
|
|
1366
|
-
* Get menu details and path URL by menu ID.
|
|
1367
|
-
* @param _id - Menu ID.
|
|
1368
|
-
* @public
|
|
1369
|
-
* @documentationMaturity preview
|
|
1370
|
-
* @requiredField _id
|
|
1371
|
-
* @permissionId RESTAURANTS.MENU_READ
|
|
1372
|
-
* @applicableIdentity APP
|
|
1373
|
-
* @fqn com.wixpress.restaurants.menus_menu.v1.restaurants_menus_site_url.RestaurantsMenusSiteUrl.GetMenuSiteUrl
|
|
1374
|
-
*/
|
|
1375
|
-
declare function getMenuSiteUrl(_id: string): Promise<NonNullablePaths<GetMenuSiteUrlResponse, `menuSiteUrl.path`, 1>>;
|
|
1376
|
-
/**
|
|
1377
|
-
* Query menu details and path URL
|
|
1378
|
-
* @public
|
|
1379
|
-
* @documentationMaturity preview
|
|
1380
|
-
* @permissionId RESTAURANTS.MENU_READ
|
|
1381
|
-
* @applicableIdentity APP
|
|
1382
|
-
* @fqn com.wixpress.restaurants.menus_menu.v1.restaurants_menus_site_url.RestaurantsMenusSiteUrl.QueryMenusSiteUrl
|
|
1383
|
-
*/
|
|
1384
|
-
declare function queryMenusSiteUrl(options?: QueryMenusSiteUrlOptions): Promise<NonNullablePaths<QueryMenusSiteUrlResponse, `menuSiteUrls` | `menuSiteUrls.${number}.path`, 2>>;
|
|
1385
|
-
interface QueryMenusSiteUrlOptions {
|
|
1386
|
-
/** Query options */
|
|
1387
|
-
query?: CursorQuery;
|
|
1388
|
-
}
|
|
1389
1412
|
|
|
1390
|
-
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 };
|
|
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 };
|