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