@wix/auto_sdk_restaurants_menus 1.0.90 → 1.0.91
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 +520 -520
- package/build/cjs/index.typings.js +173 -173
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +315 -315
- 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 +520 -520
- package/build/es/index.typings.mjs +173 -173
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +315 -315
- 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 +544 -544
- package/build/internal/cjs/meta.d.ts +483 -483
- package/build/internal/es/index.d.mts +27 -27
- package/build/internal/es/index.typings.d.mts +544 -544
- package/build/internal/es/meta.d.mts +483 -483
- package/package.json +2 -2
|
@@ -205,455 +205,166 @@ 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 InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
209
209
|
/**
|
|
210
|
-
*
|
|
210
|
+
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
211
211
|
* @format GUID
|
|
212
212
|
*/
|
|
213
|
-
|
|
213
|
+
metaSiteId?: string;
|
|
214
214
|
/**
|
|
215
|
-
*
|
|
215
|
+
* Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
|
|
216
216
|
* @format GUID
|
|
217
|
-
* @maxSize 100
|
|
218
|
-
*/
|
|
219
|
-
businessLocationIds?: string[] | null;
|
|
220
|
-
/** Indicates whether sub-entities (such as items) should be duplicated as well. */
|
|
221
|
-
duplicateSubEntities?: boolean | null;
|
|
222
|
-
/**
|
|
223
|
-
* The new name of the duplicated menu.
|
|
224
|
-
* @maxLength 500
|
|
225
|
-
*/
|
|
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;
|
|
239
|
-
/**
|
|
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`.
|
|
242
|
-
*/
|
|
243
|
-
entityFqdn?: string;
|
|
244
|
-
/**
|
|
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`.
|
|
247
217
|
*/
|
|
248
|
-
|
|
249
|
-
/**
|
|
250
|
-
|
|
251
|
-
/**
|
|
252
|
-
|
|
218
|
+
siteId?: string;
|
|
219
|
+
/** Invalidate by App */
|
|
220
|
+
app?: App;
|
|
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;
|
|
253
233
|
/**
|
|
254
|
-
*
|
|
255
|
-
*
|
|
234
|
+
* tell us why you're invalidating the cache. You don't need to add your app name
|
|
235
|
+
* @maxLength 256
|
|
256
236
|
*/
|
|
257
|
-
|
|
258
|
-
/**
|
|
259
|
-
|
|
237
|
+
reason?: string | null;
|
|
238
|
+
/** Is local DS */
|
|
239
|
+
localDc?: boolean;
|
|
240
|
+
hardPurge?: boolean;
|
|
260
241
|
/**
|
|
261
|
-
*
|
|
262
|
-
*
|
|
242
|
+
* Optional caller-provided ID for tracking this invalidation through the system.
|
|
243
|
+
* When set, the corresponding CDN purge completion event will include this ID,
|
|
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
|
|
263
247
|
*/
|
|
264
|
-
|
|
248
|
+
correlationId?: string | null;
|
|
265
249
|
}
|
|
266
250
|
/** @oneof */
|
|
267
|
-
interface
|
|
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 {
|
|
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.
|
|
284
|
-
*/
|
|
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 {
|
|
251
|
+
interface InvalidateCacheGetByOneOf {
|
|
295
252
|
/**
|
|
296
|
-
*
|
|
253
|
+
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
297
254
|
* @format GUID
|
|
298
255
|
*/
|
|
299
|
-
|
|
256
|
+
metaSiteId?: string;
|
|
300
257
|
/**
|
|
301
|
-
*
|
|
302
|
-
* @
|
|
258
|
+
* Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
|
|
259
|
+
* @format GUID
|
|
303
260
|
*/
|
|
304
|
-
|
|
305
|
-
/**
|
|
306
|
-
|
|
307
|
-
/**
|
|
308
|
-
|
|
309
|
-
/**
|
|
310
|
-
|
|
261
|
+
siteId?: string;
|
|
262
|
+
/** Invalidate by App */
|
|
263
|
+
app?: App;
|
|
264
|
+
/** Invalidate by page id */
|
|
265
|
+
page?: Page;
|
|
266
|
+
/** Invalidate by URI path */
|
|
267
|
+
uri?: URI;
|
|
268
|
+
/** Invalidate by file (for media files such as PDFs) */
|
|
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;
|
|
311
276
|
}
|
|
312
|
-
interface
|
|
277
|
+
interface App {
|
|
313
278
|
/**
|
|
314
|
-
*
|
|
315
|
-
* @
|
|
279
|
+
* The AppDefId
|
|
280
|
+
* @minLength 1
|
|
316
281
|
*/
|
|
317
|
-
|
|
282
|
+
appDefId?: string;
|
|
318
283
|
/**
|
|
319
|
-
*
|
|
284
|
+
* The instance Id
|
|
320
285
|
* @format GUID
|
|
321
286
|
*/
|
|
322
|
-
|
|
287
|
+
instanceId?: string;
|
|
288
|
+
}
|
|
289
|
+
interface Page {
|
|
323
290
|
/**
|
|
324
|
-
*
|
|
291
|
+
* the msid the page is on
|
|
325
292
|
* @format GUID
|
|
326
293
|
*/
|
|
327
|
-
|
|
294
|
+
metaSiteId?: string;
|
|
328
295
|
/**
|
|
329
|
-
*
|
|
330
|
-
* @
|
|
296
|
+
* Invalidate by Page ID
|
|
297
|
+
* @minLength 1
|
|
331
298
|
*/
|
|
332
|
-
|
|
333
|
-
/** @readonly */
|
|
334
|
-
identityType?: WebhookIdentityTypeWithLiterals;
|
|
299
|
+
pageId?: string;
|
|
335
300
|
}
|
|
336
|
-
|
|
337
|
-
interface IdentificationDataIdOneOf {
|
|
301
|
+
interface URI {
|
|
338
302
|
/**
|
|
339
|
-
*
|
|
303
|
+
* the msid the URI is on
|
|
340
304
|
* @format GUID
|
|
341
305
|
*/
|
|
342
|
-
|
|
306
|
+
metaSiteId?: string;
|
|
343
307
|
/**
|
|
344
|
-
*
|
|
345
|
-
* @
|
|
308
|
+
* URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes
|
|
309
|
+
* @minLength 1
|
|
346
310
|
*/
|
|
347
|
-
|
|
311
|
+
uriPath?: string;
|
|
312
|
+
}
|
|
313
|
+
interface File {
|
|
348
314
|
/**
|
|
349
|
-
*
|
|
315
|
+
* the msid the file is related to
|
|
350
316
|
* @format GUID
|
|
351
317
|
*/
|
|
352
|
-
|
|
318
|
+
metaSiteId?: string;
|
|
353
319
|
/**
|
|
354
|
-
*
|
|
355
|
-
* @
|
|
320
|
+
* Invalidate by filename (for media files such as PDFs)
|
|
321
|
+
* @minLength 1
|
|
322
|
+
* @maxLength 256
|
|
356
323
|
*/
|
|
357
|
-
|
|
358
|
-
}
|
|
359
|
-
declare enum WebhookIdentityType {
|
|
360
|
-
UNKNOWN = "UNKNOWN",
|
|
361
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
362
|
-
MEMBER = "MEMBER",
|
|
363
|
-
WIX_USER = "WIX_USER",
|
|
364
|
-
APP = "APP"
|
|
324
|
+
fileName?: string;
|
|
365
325
|
}
|
|
366
|
-
|
|
367
|
-
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
368
|
-
interface AccountInfo {
|
|
326
|
+
interface CustomTag {
|
|
369
327
|
/**
|
|
370
|
-
*
|
|
328
|
+
* the msid the tag is related to
|
|
371
329
|
* @format GUID
|
|
372
330
|
*/
|
|
373
|
-
|
|
331
|
+
metaSiteId?: string;
|
|
374
332
|
/**
|
|
375
|
-
*
|
|
376
|
-
* @
|
|
333
|
+
* Tag to invalidate by
|
|
334
|
+
* @minLength 1
|
|
335
|
+
* @maxLength 256
|
|
377
336
|
*/
|
|
378
|
-
|
|
337
|
+
tag?: string;
|
|
338
|
+
}
|
|
339
|
+
interface Pages {
|
|
379
340
|
/**
|
|
380
|
-
*
|
|
341
|
+
* the msid the pages are on
|
|
381
342
|
* @format GUID
|
|
382
343
|
*/
|
|
383
|
-
|
|
344
|
+
metaSiteId?: string;
|
|
345
|
+
/**
|
|
346
|
+
* Invalidate by multiple Page IDs in a single message
|
|
347
|
+
* @maxSize 100
|
|
348
|
+
* @minLength 1
|
|
349
|
+
*/
|
|
350
|
+
pageIds?: string[];
|
|
384
351
|
}
|
|
385
|
-
interface
|
|
352
|
+
interface URIs {
|
|
386
353
|
/**
|
|
387
|
-
*
|
|
354
|
+
* the msid the URIs are on
|
|
388
355
|
* @format GUID
|
|
389
|
-
* @readonly
|
|
390
356
|
*/
|
|
391
|
-
|
|
392
|
-
}
|
|
393
|
-
interface GetMenuSiteUrlResponse {
|
|
394
|
-
/** Retrieved menuInfo with path url. */
|
|
395
|
-
menuSiteUrl?: MenuSiteUrl;
|
|
396
|
-
}
|
|
397
|
-
interface MenuSiteUrl {
|
|
357
|
+
metaSiteId?: string;
|
|
398
358
|
/**
|
|
399
|
-
*
|
|
359
|
+
* URI paths to invalidate (e.g. page/my/path) - without leading/trailing slashes
|
|
360
|
+
* @maxSize 100
|
|
400
361
|
* @minLength 1
|
|
401
|
-
* @maxLength 1000
|
|
402
362
|
*/
|
|
403
|
-
|
|
363
|
+
uriPaths?: string[];
|
|
404
364
|
}
|
|
405
|
-
interface
|
|
406
|
-
/**
|
|
407
|
-
|
|
408
|
-
}
|
|
409
|
-
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
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`. */
|
|
411
|
-
cursorPaging?: CursorPaging;
|
|
412
|
-
/**
|
|
413
|
-
* Filter object in the following format:
|
|
414
|
-
* `"filter" : {
|
|
415
|
-
* "fieldName1": "value1",
|
|
416
|
-
* "fieldName2":{"$operator":"value2"}
|
|
417
|
-
* }`
|
|
418
|
-
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
|
|
419
|
-
*/
|
|
420
|
-
filter?: Record<string, any> | null;
|
|
421
|
-
/**
|
|
422
|
-
* Sort object in the following format:
|
|
423
|
-
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
424
|
-
*/
|
|
425
|
-
sort?: Sorting[];
|
|
426
|
-
}
|
|
427
|
-
/** @oneof */
|
|
428
|
-
interface CursorQueryPagingMethodOneOf {
|
|
429
|
-
/** 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`. */
|
|
430
|
-
cursorPaging?: CursorPaging;
|
|
431
|
-
}
|
|
432
|
-
interface Sorting {
|
|
433
|
-
/**
|
|
434
|
-
* Name of the field to sort by.
|
|
435
|
-
* @maxLength 512
|
|
436
|
-
*/
|
|
437
|
-
fieldName?: string;
|
|
438
|
-
/** Sort order. */
|
|
439
|
-
order?: SortOrderWithLiterals;
|
|
440
|
-
/**
|
|
441
|
-
* Origin point for geo-distance sorting on a GEO field
|
|
442
|
-
* results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
|
|
443
|
-
*/
|
|
444
|
-
origin?: AddressLocation;
|
|
445
|
-
}
|
|
446
|
-
declare enum SortOrder {
|
|
447
|
-
ASC = "ASC",
|
|
448
|
-
DESC = "DESC"
|
|
449
|
-
}
|
|
450
|
-
/** @enumType */
|
|
451
|
-
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
452
|
-
interface AddressLocation {
|
|
453
|
-
/** Address latitude. */
|
|
454
|
-
latitude?: number | null;
|
|
455
|
-
/** Address longitude. */
|
|
456
|
-
longitude?: number | null;
|
|
457
|
-
}
|
|
458
|
-
interface CursorPaging {
|
|
459
|
-
/**
|
|
460
|
-
* Number of items to load.
|
|
461
|
-
* @max 500
|
|
462
|
-
*/
|
|
463
|
-
limit?: number | null;
|
|
464
|
-
/**
|
|
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.
|
|
470
|
-
*/
|
|
471
|
-
cursor?: string | null;
|
|
472
|
-
}
|
|
473
|
-
interface QueryMenusSiteUrlResponse {
|
|
474
|
-
/** Retrieved menuInfos with path urls. */
|
|
475
|
-
menuSiteUrls?: MenuSiteUrl[];
|
|
476
|
-
/** The metadata of the paginated results. */
|
|
477
|
-
pagingMetadata?: CursorPagingMetadata;
|
|
478
|
-
}
|
|
479
|
-
interface CursorPagingMetadata {
|
|
480
|
-
/** Number of items returned in the response. */
|
|
481
|
-
count?: number | null;
|
|
482
|
-
/** Offset that was requested. */
|
|
483
|
-
cursors?: Cursors;
|
|
484
|
-
/**
|
|
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.
|
|
488
|
-
*/
|
|
489
|
-
hasNext?: boolean | null;
|
|
490
|
-
}
|
|
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;
|
|
496
|
-
}
|
|
497
|
-
interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
498
|
-
/**
|
|
499
|
-
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
500
|
-
* @format GUID
|
|
501
|
-
*/
|
|
502
|
-
metaSiteId?: string;
|
|
503
|
-
/**
|
|
504
|
-
* Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
|
|
505
|
-
* @format GUID
|
|
506
|
-
*/
|
|
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;
|
|
522
|
-
/**
|
|
523
|
-
* tell us why you're invalidating the cache. You don't need to add your app name
|
|
524
|
-
* @maxLength 256
|
|
525
|
-
*/
|
|
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;
|
|
538
|
-
}
|
|
539
|
-
/** @oneof */
|
|
540
|
-
interface InvalidateCacheGetByOneOf {
|
|
541
|
-
/**
|
|
542
|
-
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
543
|
-
* @format GUID
|
|
544
|
-
*/
|
|
545
|
-
metaSiteId?: string;
|
|
546
|
-
/**
|
|
547
|
-
* Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
|
|
548
|
-
* @format GUID
|
|
549
|
-
*/
|
|
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;
|
|
565
|
-
}
|
|
566
|
-
interface App {
|
|
567
|
-
/**
|
|
568
|
-
* The AppDefId
|
|
569
|
-
* @minLength 1
|
|
570
|
-
*/
|
|
571
|
-
appDefId?: string;
|
|
572
|
-
/**
|
|
573
|
-
* The instance Id
|
|
574
|
-
* @format GUID
|
|
575
|
-
*/
|
|
576
|
-
instanceId?: string;
|
|
577
|
-
}
|
|
578
|
-
interface Page {
|
|
579
|
-
/**
|
|
580
|
-
* the msid the page is on
|
|
581
|
-
* @format GUID
|
|
582
|
-
*/
|
|
583
|
-
metaSiteId?: string;
|
|
584
|
-
/**
|
|
585
|
-
* Invalidate by Page ID
|
|
586
|
-
* @minLength 1
|
|
587
|
-
*/
|
|
588
|
-
pageId?: string;
|
|
589
|
-
}
|
|
590
|
-
interface URI {
|
|
591
|
-
/**
|
|
592
|
-
* the msid the URI is on
|
|
593
|
-
* @format GUID
|
|
594
|
-
*/
|
|
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;
|
|
601
|
-
}
|
|
602
|
-
interface File {
|
|
603
|
-
/**
|
|
604
|
-
* the msid the file is related to
|
|
605
|
-
* @format GUID
|
|
606
|
-
*/
|
|
607
|
-
metaSiteId?: string;
|
|
608
|
-
/**
|
|
609
|
-
* Invalidate by filename (for media files such as PDFs)
|
|
610
|
-
* @minLength 1
|
|
611
|
-
* @maxLength 256
|
|
612
|
-
*/
|
|
613
|
-
fileName?: string;
|
|
614
|
-
}
|
|
615
|
-
interface CustomTag {
|
|
616
|
-
/**
|
|
617
|
-
* the msid the tag is related to
|
|
618
|
-
* @format GUID
|
|
619
|
-
*/
|
|
620
|
-
metaSiteId?: string;
|
|
621
|
-
/**
|
|
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
|
|
631
|
-
* @format GUID
|
|
632
|
-
*/
|
|
633
|
-
metaSiteId?: string;
|
|
634
|
-
/**
|
|
635
|
-
* Invalidate by multiple Page IDs in a single message
|
|
636
|
-
* @maxSize 100
|
|
637
|
-
* @minLength 1
|
|
638
|
-
*/
|
|
639
|
-
pageIds?: string[];
|
|
640
|
-
}
|
|
641
|
-
interface URIs {
|
|
642
|
-
/**
|
|
643
|
-
* the msid the URIs are on
|
|
644
|
-
* @format GUID
|
|
645
|
-
*/
|
|
646
|
-
metaSiteId?: string;
|
|
647
|
-
/**
|
|
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;
|
|
365
|
+
interface DeleteOrphanSections {
|
|
366
|
+
/** Menu id */
|
|
367
|
+
menuId?: string;
|
|
657
368
|
}
|
|
658
369
|
interface MenusDataCloningCompleted {
|
|
659
370
|
}
|
|
@@ -735,16 +446,98 @@ interface ListMenusRequest {
|
|
|
735
446
|
/** Whether to return only menus that are visible to site visitors. */
|
|
736
447
|
onlyVisible?: boolean | null;
|
|
737
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
|
+
}
|
|
738
464
|
interface ListMenusResponse {
|
|
739
465
|
/** Retrieved menus. */
|
|
740
466
|
menus?: Menu[];
|
|
741
467
|
/** The metadata of the paginated results. */
|
|
742
468
|
pagingMetadata?: CursorPagingMetadata;
|
|
743
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
|
+
}
|
|
744
488
|
interface QueryMenusRequest {
|
|
745
489
|
/** Query options. */
|
|
746
490
|
query?: CursorQuery;
|
|
747
491
|
}
|
|
492
|
+
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
493
|
+
/** 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`. */
|
|
494
|
+
cursorPaging?: CursorPaging;
|
|
495
|
+
/**
|
|
496
|
+
* Filter object in the following format:
|
|
497
|
+
* `"filter" : {
|
|
498
|
+
* "fieldName1": "value1",
|
|
499
|
+
* "fieldName2":{"$operator":"value2"}
|
|
500
|
+
* }`
|
|
501
|
+
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
|
|
502
|
+
*/
|
|
503
|
+
filter?: Record<string, any> | null;
|
|
504
|
+
/**
|
|
505
|
+
* Sort object in the following format:
|
|
506
|
+
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
507
|
+
*/
|
|
508
|
+
sort?: Sorting[];
|
|
509
|
+
}
|
|
510
|
+
/** @oneof */
|
|
511
|
+
interface CursorQueryPagingMethodOneOf {
|
|
512
|
+
/** 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`. */
|
|
513
|
+
cursorPaging?: CursorPaging;
|
|
514
|
+
}
|
|
515
|
+
interface Sorting {
|
|
516
|
+
/**
|
|
517
|
+
* Name of the field to sort by.
|
|
518
|
+
* @maxLength 512
|
|
519
|
+
*/
|
|
520
|
+
fieldName?: string;
|
|
521
|
+
/** Sort order. */
|
|
522
|
+
order?: SortOrderWithLiterals;
|
|
523
|
+
/**
|
|
524
|
+
* Origin point for geo-distance sorting on a GEO field
|
|
525
|
+
* results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
|
|
526
|
+
*/
|
|
527
|
+
origin?: AddressLocation;
|
|
528
|
+
}
|
|
529
|
+
declare enum SortOrder {
|
|
530
|
+
ASC = "ASC",
|
|
531
|
+
DESC = "DESC"
|
|
532
|
+
}
|
|
533
|
+
/** @enumType */
|
|
534
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
535
|
+
interface AddressLocation {
|
|
536
|
+
/** Address latitude. */
|
|
537
|
+
latitude?: number | null;
|
|
538
|
+
/** Address longitude. */
|
|
539
|
+
longitude?: number | null;
|
|
540
|
+
}
|
|
748
541
|
interface QueryMenusResponse {
|
|
749
542
|
/** Retrieved menus. */
|
|
750
543
|
menus?: Menu[];
|
|
@@ -761,97 +554,304 @@ interface UpdateMenuResponse {
|
|
|
761
554
|
}
|
|
762
555
|
interface BulkUpdateMenuRequest {
|
|
763
556
|
/**
|
|
764
|
-
* Menus to update.
|
|
765
|
-
* @minSize 1
|
|
766
|
-
* @maxSize 100
|
|
557
|
+
* Menus to update.
|
|
558
|
+
* @minSize 1
|
|
559
|
+
* @maxSize 100
|
|
560
|
+
*/
|
|
561
|
+
menus: MaskedMenu[];
|
|
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 {
|
|
572
|
+
/**
|
|
573
|
+
* Results of bulk menu update.
|
|
574
|
+
* @minSize 1
|
|
575
|
+
* @maxSize 100
|
|
576
|
+
*/
|
|
577
|
+
results?: BulkMenuResult[];
|
|
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;
|
|
594
|
+
}
|
|
595
|
+
interface UpdateExtendedFieldsResponse {
|
|
596
|
+
/** Namespace of the app. */
|
|
597
|
+
namespace?: string;
|
|
598
|
+
/** Updated extended fields data. */
|
|
599
|
+
namespaceData?: Record<string, any> | null;
|
|
600
|
+
}
|
|
601
|
+
interface DeleteMenuRequest {
|
|
602
|
+
/**
|
|
603
|
+
* Menu ID.
|
|
604
|
+
* @format GUID
|
|
605
|
+
*/
|
|
606
|
+
menuId: string;
|
|
607
|
+
}
|
|
608
|
+
interface DeleteMenuResponse {
|
|
609
|
+
}
|
|
610
|
+
interface RunMenusMultiLocationMigrationRequest {
|
|
611
|
+
/**
|
|
612
|
+
* business location id
|
|
613
|
+
* @format GUID
|
|
614
|
+
*/
|
|
615
|
+
businessLocationId?: string;
|
|
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 {
|
|
630
|
+
/**
|
|
631
|
+
* The MetaSiteId to clone from.
|
|
632
|
+
* @format GUID
|
|
633
|
+
*/
|
|
634
|
+
metaSiteId?: string;
|
|
635
|
+
}
|
|
636
|
+
interface CloneMenusResponse {
|
|
637
|
+
}
|
|
638
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
639
|
+
createdEvent?: EntityCreatedEvent;
|
|
640
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
641
|
+
deletedEvent?: EntityDeletedEvent;
|
|
642
|
+
actionEvent?: ActionEvent;
|
|
643
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
644
|
+
_id?: string;
|
|
645
|
+
/**
|
|
646
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
647
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
648
|
+
*/
|
|
649
|
+
entityFqdn?: string;
|
|
650
|
+
/**
|
|
651
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
652
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
653
|
+
*/
|
|
654
|
+
slug?: string;
|
|
655
|
+
/** ID of the entity associated with the event. */
|
|
656
|
+
entityId?: string;
|
|
657
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
658
|
+
eventTime?: Date | null;
|
|
659
|
+
/**
|
|
660
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
661
|
+
* (for example, GDPR).
|
|
662
|
+
*/
|
|
663
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
664
|
+
/** If present, indicates the action that triggered the event. */
|
|
665
|
+
originatedFrom?: string | null;
|
|
666
|
+
/**
|
|
667
|
+
* 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.
|
|
668
|
+
* 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.
|
|
669
|
+
*/
|
|
670
|
+
entityEventSequence?: string | null;
|
|
671
|
+
}
|
|
672
|
+
/** @oneof */
|
|
673
|
+
interface DomainEventBodyOneOf {
|
|
674
|
+
createdEvent?: EntityCreatedEvent;
|
|
675
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
676
|
+
deletedEvent?: EntityDeletedEvent;
|
|
677
|
+
actionEvent?: ActionEvent;
|
|
678
|
+
}
|
|
679
|
+
interface EntityCreatedEvent {
|
|
680
|
+
entity?: string;
|
|
681
|
+
}
|
|
682
|
+
interface RestoreInfo {
|
|
683
|
+
deletedDate?: Date | null;
|
|
684
|
+
}
|
|
685
|
+
interface EntityUpdatedEvent {
|
|
686
|
+
/**
|
|
687
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
688
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
689
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
690
|
+
*/
|
|
691
|
+
currentEntity?: string;
|
|
692
|
+
}
|
|
693
|
+
interface EntityDeletedEvent {
|
|
694
|
+
/** Entity that was deleted. */
|
|
695
|
+
deletedEntity?: string | null;
|
|
696
|
+
}
|
|
697
|
+
interface ActionEvent {
|
|
698
|
+
body?: string;
|
|
699
|
+
}
|
|
700
|
+
interface Empty {
|
|
701
|
+
}
|
|
702
|
+
interface SyncContentToMultilingualRequest {
|
|
703
|
+
/**
|
|
704
|
+
* MetaSite ID
|
|
705
|
+
* @format GUID
|
|
706
|
+
*/
|
|
707
|
+
metaSiteId?: string;
|
|
708
|
+
}
|
|
709
|
+
interface SyncContentToMultilingualResponse {
|
|
710
|
+
}
|
|
711
|
+
interface MessageEnvelope {
|
|
712
|
+
/**
|
|
713
|
+
* App instance ID.
|
|
714
|
+
* @format GUID
|
|
715
|
+
*/
|
|
716
|
+
instanceId?: string | null;
|
|
717
|
+
/**
|
|
718
|
+
* Event type.
|
|
719
|
+
* @maxLength 150
|
|
720
|
+
*/
|
|
721
|
+
eventType?: string;
|
|
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;
|
|
728
|
+
}
|
|
729
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
730
|
+
/**
|
|
731
|
+
* ID of a site visitor that has not logged in to the site.
|
|
732
|
+
* @format GUID
|
|
733
|
+
*/
|
|
734
|
+
anonymousVisitorId?: string;
|
|
735
|
+
/**
|
|
736
|
+
* ID of a site visitor that has logged in to the site.
|
|
737
|
+
* @format GUID
|
|
738
|
+
*/
|
|
739
|
+
memberId?: string;
|
|
740
|
+
/**
|
|
741
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
742
|
+
* @format GUID
|
|
743
|
+
*/
|
|
744
|
+
wixUserId?: string;
|
|
745
|
+
/**
|
|
746
|
+
* ID of an app.
|
|
747
|
+
* @format GUID
|
|
748
|
+
*/
|
|
749
|
+
appId?: string;
|
|
750
|
+
/** @readonly */
|
|
751
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
752
|
+
}
|
|
753
|
+
/** @oneof */
|
|
754
|
+
interface IdentificationDataIdOneOf {
|
|
755
|
+
/**
|
|
756
|
+
* ID of a site visitor that has not logged in to the site.
|
|
757
|
+
* @format GUID
|
|
758
|
+
*/
|
|
759
|
+
anonymousVisitorId?: string;
|
|
760
|
+
/**
|
|
761
|
+
* ID of a site visitor that has logged in to the site.
|
|
762
|
+
* @format GUID
|
|
763
|
+
*/
|
|
764
|
+
memberId?: string;
|
|
765
|
+
/**
|
|
766
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
767
|
+
* @format GUID
|
|
767
768
|
*/
|
|
768
|
-
|
|
769
|
-
/** Whether to receive the entity in the response. */
|
|
770
|
-
returnEntity?: boolean;
|
|
771
|
-
}
|
|
772
|
-
interface MaskedMenu {
|
|
773
|
-
/** Menu to updated. */
|
|
774
|
-
menu?: Menu;
|
|
775
|
-
/** Explicit list of fields to update. */
|
|
776
|
-
mask?: string[];
|
|
777
|
-
}
|
|
778
|
-
interface BulkUpdateMenuResponse {
|
|
769
|
+
wixUserId?: string;
|
|
779
770
|
/**
|
|
780
|
-
*
|
|
781
|
-
* @
|
|
782
|
-
* @maxSize 100
|
|
771
|
+
* ID of an app.
|
|
772
|
+
* @format GUID
|
|
783
773
|
*/
|
|
784
|
-
|
|
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;
|
|
774
|
+
appId?: string;
|
|
801
775
|
}
|
|
802
|
-
|
|
803
|
-
|
|
804
|
-
|
|
805
|
-
|
|
806
|
-
|
|
776
|
+
declare enum WebhookIdentityType {
|
|
777
|
+
UNKNOWN = "UNKNOWN",
|
|
778
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
779
|
+
MEMBER = "MEMBER",
|
|
780
|
+
WIX_USER = "WIX_USER",
|
|
781
|
+
APP = "APP"
|
|
807
782
|
}
|
|
808
|
-
|
|
783
|
+
/** @enumType */
|
|
784
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
785
|
+
interface AccountInfo {
|
|
809
786
|
/**
|
|
810
|
-
*
|
|
787
|
+
* ID of the Wix account associated with the event.
|
|
811
788
|
* @format GUID
|
|
812
789
|
*/
|
|
813
|
-
|
|
814
|
-
}
|
|
815
|
-
interface DeleteMenuResponse {
|
|
816
|
-
}
|
|
817
|
-
interface RunMenusMultiLocationMigrationRequest {
|
|
790
|
+
accountId?: string | null;
|
|
818
791
|
/**
|
|
819
|
-
*
|
|
792
|
+
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
820
793
|
* @format GUID
|
|
821
794
|
*/
|
|
822
|
-
|
|
795
|
+
parentAccountId?: string | null;
|
|
796
|
+
/**
|
|
797
|
+
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
798
|
+
* @format GUID
|
|
799
|
+
*/
|
|
800
|
+
siteId?: string | null;
|
|
823
801
|
}
|
|
824
|
-
interface
|
|
825
|
-
/**
|
|
826
|
-
|
|
802
|
+
interface DuplicateMenuRequest {
|
|
803
|
+
/**
|
|
804
|
+
* Menu id to be duplicated.
|
|
805
|
+
* @format GUID
|
|
806
|
+
*/
|
|
807
|
+
_id: string;
|
|
808
|
+
/**
|
|
809
|
+
* Business location ids to duplicate the menu to.
|
|
810
|
+
* @format GUID
|
|
811
|
+
* @maxSize 100
|
|
812
|
+
*/
|
|
813
|
+
businessLocationIds?: string[] | null;
|
|
814
|
+
/** Indicates whether sub-entities (such as items) should be duplicated as well. */
|
|
815
|
+
duplicateSubEntities?: boolean | null;
|
|
816
|
+
/**
|
|
817
|
+
* The new name of the duplicated menu.
|
|
818
|
+
* @maxLength 500
|
|
819
|
+
*/
|
|
820
|
+
menuName?: string | null;
|
|
827
821
|
}
|
|
828
|
-
interface
|
|
829
|
-
/** @format GUID */
|
|
830
|
-
menuId?: string;
|
|
822
|
+
interface DuplicateMenuResponse {
|
|
831
823
|
/** @format GUID */
|
|
832
|
-
|
|
833
|
-
}
|
|
834
|
-
interface UpdateBusinessLocationIdResponse {
|
|
824
|
+
menuIds?: string[];
|
|
835
825
|
}
|
|
836
|
-
interface
|
|
826
|
+
interface GetMenuSiteUrlRequest {
|
|
837
827
|
/**
|
|
838
|
-
*
|
|
828
|
+
* Menu ID.
|
|
839
829
|
* @format GUID
|
|
830
|
+
* @readonly
|
|
840
831
|
*/
|
|
841
|
-
|
|
842
|
-
}
|
|
843
|
-
interface CloneMenusResponse {
|
|
832
|
+
_id: string | null;
|
|
844
833
|
}
|
|
845
|
-
interface
|
|
834
|
+
interface GetMenuSiteUrlResponse {
|
|
835
|
+
/** Retrieved menuInfo with path url. */
|
|
836
|
+
menuSiteUrl?: MenuSiteUrl;
|
|
846
837
|
}
|
|
847
|
-
interface
|
|
838
|
+
interface MenuSiteUrl {
|
|
848
839
|
/**
|
|
849
|
-
*
|
|
850
|
-
* @
|
|
840
|
+
* Path URL.
|
|
841
|
+
* @minLength 1
|
|
842
|
+
* @maxLength 1000
|
|
851
843
|
*/
|
|
852
|
-
|
|
844
|
+
path?: string;
|
|
853
845
|
}
|
|
854
|
-
interface
|
|
846
|
+
interface QueryMenusSiteUrlRequest {
|
|
847
|
+
/** Query options */
|
|
848
|
+
query?: CursorQuery;
|
|
849
|
+
}
|
|
850
|
+
interface QueryMenusSiteUrlResponse {
|
|
851
|
+
/** Retrieved menuInfos with path urls. */
|
|
852
|
+
menuSiteUrls?: MenuSiteUrl[];
|
|
853
|
+
/** The metadata of the paginated results. */
|
|
854
|
+
pagingMetadata?: CursorPagingMetadata;
|
|
855
855
|
}
|
|
856
856
|
interface BaseEventMetadata {
|
|
857
857
|
/**
|
|
@@ -908,21 +908,6 @@ interface AccountInfoMetadata {
|
|
|
908
908
|
/** ID of the parent Wix account. Only included when 'accountId' belongs to a child account. */
|
|
909
909
|
parentAccountId?: string;
|
|
910
910
|
}
|
|
911
|
-
interface MenuUpdatedEnvelope {
|
|
912
|
-
entity: Menu;
|
|
913
|
-
metadata: EventMetadata;
|
|
914
|
-
/** @hidden */
|
|
915
|
-
modifiedFields: Record<string, any>;
|
|
916
|
-
}
|
|
917
|
-
/** @permissionScope Manage Restaurants - all permissions
|
|
918
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
919
|
-
* @permissionId RESTAURANTS.MENU_READ
|
|
920
|
-
* @webhook
|
|
921
|
-
* @eventType wix.restaurants.menus.v1.menu_updated
|
|
922
|
-
* @slug updated
|
|
923
|
-
* @documentationMaturity preview
|
|
924
|
-
*/
|
|
925
|
-
declare function onMenuUpdated(handler: (event: MenuUpdatedEnvelope) => void | Promise<void>): void;
|
|
926
911
|
interface MenuCreatedEnvelope {
|
|
927
912
|
entity: Menu;
|
|
928
913
|
metadata: EventMetadata;
|
|
@@ -952,54 +937,21 @@ interface MenuDeletedEnvelope {
|
|
|
952
937
|
* @documentationMaturity preview
|
|
953
938
|
*/
|
|
954
939
|
declare function onMenuDeleted(handler: (event: MenuDeletedEnvelope) => void | Promise<void>): void;
|
|
955
|
-
|
|
956
|
-
|
|
957
|
-
|
|
958
|
-
|
|
959
|
-
|
|
960
|
-
* @applicableIdentity APP
|
|
961
|
-
* @fqn com.wixpress.restaurants.menus_menu.v1.restaurants_duplicate_menu.RestaurantsDuplicateMenu.DuplicateMenu
|
|
962
|
-
*/
|
|
963
|
-
declare function duplicateMenu(_id: string, options?: DuplicateMenuOptions): Promise<NonNullablePaths<DuplicateMenuResponse, `menuIds`, 0>>;
|
|
964
|
-
interface DuplicateMenuOptions {
|
|
965
|
-
/**
|
|
966
|
-
* Business location ids to duplicate the menu to.
|
|
967
|
-
* @format GUID
|
|
968
|
-
* @maxSize 100
|
|
969
|
-
*/
|
|
970
|
-
businessLocationIds?: string[] | null;
|
|
971
|
-
/** Indicates whether sub-entities (such as items) should be duplicated as well. */
|
|
972
|
-
duplicateSubEntities?: boolean | null;
|
|
973
|
-
/**
|
|
974
|
-
* The new name of the duplicated menu.
|
|
975
|
-
* @maxLength 500
|
|
976
|
-
*/
|
|
977
|
-
menuName?: string | null;
|
|
940
|
+
interface MenuUpdatedEnvelope {
|
|
941
|
+
entity: Menu;
|
|
942
|
+
metadata: EventMetadata;
|
|
943
|
+
/** @hidden */
|
|
944
|
+
modifiedFields: Record<string, any>;
|
|
978
945
|
}
|
|
979
|
-
/**
|
|
980
|
-
*
|
|
981
|
-
* @param _id - Menu ID.
|
|
982
|
-
* @public
|
|
983
|
-
* @documentationMaturity preview
|
|
984
|
-
* @requiredField _id
|
|
946
|
+
/** @permissionScope Manage Restaurants - all permissions
|
|
947
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
985
948
|
* @permissionId RESTAURANTS.MENU_READ
|
|
986
|
-
* @
|
|
987
|
-
* @
|
|
988
|
-
|
|
989
|
-
declare function getMenuSiteUrl(_id: string): Promise<NonNullablePaths<GetMenuSiteUrlResponse, `menuSiteUrl.path`, 1>>;
|
|
990
|
-
/**
|
|
991
|
-
* Query menu details and path URL
|
|
992
|
-
* @public
|
|
949
|
+
* @webhook
|
|
950
|
+
* @eventType wix.restaurants.menus.v1.menu_updated
|
|
951
|
+
* @slug updated
|
|
993
952
|
* @documentationMaturity preview
|
|
994
|
-
* @permissionId RESTAURANTS.MENU_READ
|
|
995
|
-
* @applicableIdentity APP
|
|
996
|
-
* @fqn com.wixpress.restaurants.menus_menu.v1.restaurants_menus_site_url.RestaurantsMenusSiteUrl.QueryMenusSiteUrl
|
|
997
953
|
*/
|
|
998
|
-
declare function
|
|
999
|
-
interface QueryMenusSiteUrlOptions {
|
|
1000
|
-
/** Query options */
|
|
1001
|
-
query?: CursorQuery;
|
|
1002
|
-
}
|
|
954
|
+
declare function onMenuUpdated(handler: (event: MenuUpdatedEnvelope) => void | Promise<void>): void;
|
|
1003
955
|
/**
|
|
1004
956
|
* > **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).
|
|
1005
957
|
*
|
|
@@ -1386,5 +1338,53 @@ interface UpdateExtendedFieldsOptions {
|
|
|
1386
1338
|
* @fqn com.wixpress.restaurants.menus_menu.v1.RestaurantsMenusMenu.DeleteMenu
|
|
1387
1339
|
*/
|
|
1388
1340
|
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
1389
|
|
|
1390
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 };
|