@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
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { CreateMenuRequest as CreateMenuRequest$1, CreateMenuResponse as CreateMenuResponse$1, BulkCreateMenusRequest as BulkCreateMenusRequest$1, BulkCreateMenusResponse as BulkCreateMenusResponse$1, GetMenuRequest as GetMenuRequest$1, GetMenuResponse as GetMenuResponse$1, ListMenusRequest as ListMenusRequest$1, ListMenusResponse as ListMenusResponse$1, QueryMenusRequest as QueryMenusRequest$1, QueryMenusResponse as QueryMenusResponse$1, UpdateMenuRequest as UpdateMenuRequest$1, UpdateMenuResponse as UpdateMenuResponse$1, BulkUpdateMenuRequest as BulkUpdateMenuRequest$1, BulkUpdateMenuResponse as BulkUpdateMenuResponse$1, UpdateExtendedFieldsRequest as UpdateExtendedFieldsRequest$1, UpdateExtendedFieldsResponse as UpdateExtendedFieldsResponse$1, DeleteMenuRequest as DeleteMenuRequest$1, DeleteMenuResponse as DeleteMenuResponse$1, DuplicateMenuRequest as DuplicateMenuRequest$1, DuplicateMenuResponse as DuplicateMenuResponse$1, GetMenuSiteUrlRequest as GetMenuSiteUrlRequest$1, GetMenuSiteUrlResponse as GetMenuSiteUrlResponse$1, QueryMenusSiteUrlRequest as QueryMenusSiteUrlRequest$1, QueryMenusSiteUrlResponse as QueryMenusSiteUrlResponse$1 } from './index.typings.js';
|
|
2
2
|
import '@wix/sdk-types';
|
|
3
3
|
|
|
4
4
|
interface Menu {
|
|
@@ -222,249 +222,288 @@ 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
|
-
entityAsJson?: string;
|
|
268
|
+
interface InvalidateCacheGetByOneOf {
|
|
292
269
|
/**
|
|
293
|
-
*
|
|
294
|
-
* @
|
|
270
|
+
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
271
|
+
* @format GUID
|
|
295
272
|
*/
|
|
296
|
-
|
|
297
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
298
|
-
restoreInfo?: RestoreInfo;
|
|
273
|
+
metaSiteId?: string;
|
|
299
274
|
/**
|
|
300
|
-
*
|
|
301
|
-
* @
|
|
275
|
+
* Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
|
|
276
|
+
* @format GUID
|
|
302
277
|
*/
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
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;
|
|
307
293
|
}
|
|
308
|
-
interface
|
|
309
|
-
/**
|
|
310
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
311
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
312
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
313
|
-
*/
|
|
314
|
-
currentEntityAsJson?: string;
|
|
315
|
-
/**
|
|
316
|
-
* This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard
|
|
317
|
-
* wont populate it / have any reference to it in the API.
|
|
318
|
-
* The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,
|
|
319
|
-
* the developer should send only the new (current) entity.
|
|
320
|
-
* An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big
|
|
321
|
-
* Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.
|
|
322
|
-
* @internal
|
|
323
|
-
* @deprecated
|
|
324
|
-
*/
|
|
325
|
-
previousEntityAsJson?: string | null;
|
|
294
|
+
interface App {
|
|
326
295
|
/**
|
|
327
|
-
*
|
|
328
|
-
*
|
|
329
|
-
* @internal
|
|
296
|
+
* The AppDefId
|
|
297
|
+
* @minLength 1
|
|
330
298
|
*/
|
|
331
|
-
|
|
299
|
+
appDefId?: string;
|
|
332
300
|
/**
|
|
333
|
-
*
|
|
334
|
-
* @
|
|
301
|
+
* The instance Id
|
|
302
|
+
* @format GUID
|
|
335
303
|
*/
|
|
336
|
-
|
|
304
|
+
instanceId?: string;
|
|
337
305
|
}
|
|
338
|
-
interface
|
|
306
|
+
interface Page {
|
|
339
307
|
/**
|
|
340
|
-
*
|
|
341
|
-
* @
|
|
308
|
+
* the msid the page is on
|
|
309
|
+
* @format GUID
|
|
342
310
|
*/
|
|
343
|
-
|
|
344
|
-
/** Entity that was deleted. */
|
|
345
|
-
deletedEntityAsJson?: string | null;
|
|
311
|
+
metaSiteId?: string;
|
|
346
312
|
/**
|
|
347
|
-
*
|
|
348
|
-
* @
|
|
313
|
+
* Invalidate by Page ID
|
|
314
|
+
* @minLength 1
|
|
349
315
|
*/
|
|
350
|
-
|
|
351
|
-
}
|
|
352
|
-
interface ActionEvent {
|
|
353
|
-
bodyAsJson?: string;
|
|
316
|
+
pageId?: string;
|
|
354
317
|
}
|
|
355
|
-
interface
|
|
318
|
+
interface URI {
|
|
356
319
|
/**
|
|
357
|
-
*
|
|
320
|
+
* the msid the URI is on
|
|
358
321
|
* @format GUID
|
|
359
322
|
*/
|
|
360
|
-
|
|
323
|
+
metaSiteId?: string;
|
|
361
324
|
/**
|
|
362
|
-
*
|
|
363
|
-
* @
|
|
325
|
+
* URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes
|
|
326
|
+
* @minLength 1
|
|
364
327
|
*/
|
|
365
|
-
|
|
366
|
-
/** The identification type and identity data. */
|
|
367
|
-
identity?: IdentificationData;
|
|
368
|
-
/** Stringify payload. */
|
|
369
|
-
data?: string;
|
|
370
|
-
/** Details related to the account */
|
|
371
|
-
accountInfo?: AccountInfo;
|
|
328
|
+
uriPath?: string;
|
|
372
329
|
}
|
|
373
|
-
interface
|
|
330
|
+
interface File {
|
|
374
331
|
/**
|
|
375
|
-
*
|
|
332
|
+
* the msid the file is related to
|
|
376
333
|
* @format GUID
|
|
377
334
|
*/
|
|
378
|
-
|
|
335
|
+
metaSiteId?: string;
|
|
379
336
|
/**
|
|
380
|
-
*
|
|
381
|
-
* @
|
|
337
|
+
* Invalidate by filename (for media files such as PDFs)
|
|
338
|
+
* @minLength 1
|
|
339
|
+
* @maxLength 256
|
|
382
340
|
*/
|
|
383
|
-
|
|
341
|
+
fileName?: string;
|
|
342
|
+
}
|
|
343
|
+
interface CustomTag {
|
|
384
344
|
/**
|
|
385
|
-
*
|
|
345
|
+
* the msid the tag is related to
|
|
386
346
|
* @format GUID
|
|
387
347
|
*/
|
|
388
|
-
|
|
348
|
+
metaSiteId?: string;
|
|
389
349
|
/**
|
|
390
|
-
*
|
|
391
|
-
* @
|
|
350
|
+
* Tag to invalidate by
|
|
351
|
+
* @minLength 1
|
|
352
|
+
* @maxLength 256
|
|
392
353
|
*/
|
|
393
|
-
|
|
394
|
-
/** @readonly */
|
|
395
|
-
identityType?: WebhookIdentityTypeWithLiterals;
|
|
354
|
+
tag?: string;
|
|
396
355
|
}
|
|
397
|
-
|
|
398
|
-
interface IdentificationDataIdOneOf {
|
|
356
|
+
interface Pages {
|
|
399
357
|
/**
|
|
400
|
-
*
|
|
358
|
+
* the msid the pages are on
|
|
401
359
|
* @format GUID
|
|
402
360
|
*/
|
|
403
|
-
|
|
361
|
+
metaSiteId?: string;
|
|
404
362
|
/**
|
|
405
|
-
*
|
|
406
|
-
* @
|
|
363
|
+
* Invalidate by multiple Page IDs in a single message
|
|
364
|
+
* @maxSize 100
|
|
365
|
+
* @minLength 1
|
|
407
366
|
*/
|
|
408
|
-
|
|
367
|
+
pageIds?: string[];
|
|
368
|
+
}
|
|
369
|
+
interface URIs {
|
|
409
370
|
/**
|
|
410
|
-
*
|
|
371
|
+
* the msid the URIs are on
|
|
411
372
|
* @format GUID
|
|
412
373
|
*/
|
|
413
|
-
|
|
374
|
+
metaSiteId?: string;
|
|
414
375
|
/**
|
|
415
|
-
*
|
|
416
|
-
* @
|
|
376
|
+
* URI paths to invalidate (e.g. page/my/path) - without leading/trailing slashes
|
|
377
|
+
* @maxSize 100
|
|
378
|
+
* @minLength 1
|
|
417
379
|
*/
|
|
418
|
-
|
|
380
|
+
uriPaths?: string[];
|
|
419
381
|
}
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
MEMBER = "MEMBER",
|
|
424
|
-
WIX_USER = "WIX_USER",
|
|
425
|
-
APP = "APP"
|
|
382
|
+
interface DeleteOrphanSections {
|
|
383
|
+
/** Menu id */
|
|
384
|
+
menuId?: string;
|
|
426
385
|
}
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
interface
|
|
430
|
-
/**
|
|
431
|
-
|
|
432
|
-
|
|
386
|
+
interface MenusDataCloningCompleted {
|
|
387
|
+
}
|
|
388
|
+
interface CreateMenuRequest {
|
|
389
|
+
/** Menu details. */
|
|
390
|
+
menu: Menu;
|
|
391
|
+
}
|
|
392
|
+
interface CreateMenuResponse {
|
|
393
|
+
/** Menu. */
|
|
394
|
+
menu?: Menu;
|
|
395
|
+
}
|
|
396
|
+
interface BulkCreateMenusRequest {
|
|
397
|
+
/**
|
|
398
|
+
* Menu details.
|
|
399
|
+
* @maxSize 100
|
|
433
400
|
*/
|
|
434
|
-
|
|
401
|
+
menus: Menu[];
|
|
402
|
+
/** Whether to receive the created menus in the response. */
|
|
403
|
+
returnEntity?: boolean;
|
|
404
|
+
}
|
|
405
|
+
interface BulkCreateMenusResponse {
|
|
406
|
+
/** Information about the created menus. */
|
|
407
|
+
results?: BulkCreateMenuResult[];
|
|
408
|
+
/** Metadata for the API call. */
|
|
409
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
410
|
+
}
|
|
411
|
+
interface BulkCreateMenuResult {
|
|
412
|
+
/** Whether to receive the created menus in the response. */
|
|
413
|
+
menuMetadata?: ItemMetadata;
|
|
414
|
+
/** Created menu. */
|
|
415
|
+
menu?: Menu;
|
|
416
|
+
}
|
|
417
|
+
interface ItemMetadata {
|
|
418
|
+
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
419
|
+
id?: string | null;
|
|
420
|
+
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
421
|
+
originalIndex?: number;
|
|
422
|
+
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
423
|
+
success?: boolean;
|
|
424
|
+
/** Details about the error in case of failure. */
|
|
425
|
+
error?: ApplicationError;
|
|
426
|
+
}
|
|
427
|
+
interface ApplicationError {
|
|
428
|
+
/** Error code. */
|
|
429
|
+
code?: string;
|
|
430
|
+
/** Description of the error. */
|
|
431
|
+
description?: string;
|
|
432
|
+
/** Data related to the error. */
|
|
433
|
+
data?: Record<string, any> | null;
|
|
434
|
+
}
|
|
435
|
+
interface BulkActionMetadata {
|
|
436
|
+
/** Number of items that were successfully processed. */
|
|
437
|
+
totalSuccesses?: number;
|
|
438
|
+
/** Number of items that couldn't be processed. */
|
|
439
|
+
totalFailures?: number;
|
|
440
|
+
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
441
|
+
undetailedFailures?: number;
|
|
442
|
+
}
|
|
443
|
+
interface GetMenuRequest {
|
|
435
444
|
/**
|
|
436
|
-
* ID
|
|
445
|
+
* Menu ID.
|
|
437
446
|
* @format GUID
|
|
438
447
|
*/
|
|
439
|
-
|
|
448
|
+
menuId: string;
|
|
449
|
+
}
|
|
450
|
+
interface GetMenuResponse {
|
|
451
|
+
/** Menu. */
|
|
452
|
+
menu?: Menu;
|
|
453
|
+
}
|
|
454
|
+
interface ListMenusRequest {
|
|
440
455
|
/**
|
|
441
|
-
*
|
|
456
|
+
* Menu IDs.
|
|
442
457
|
* @format GUID
|
|
458
|
+
* @maxSize 500
|
|
443
459
|
*/
|
|
444
|
-
|
|
460
|
+
menuIds?: string[];
|
|
461
|
+
/** The metadata of the paginated results. */
|
|
462
|
+
paging?: CursorPaging;
|
|
463
|
+
/** Whether to return only menus that are visible to site visitors. */
|
|
464
|
+
onlyVisible?: boolean | null;
|
|
445
465
|
}
|
|
446
|
-
interface
|
|
466
|
+
interface CursorPaging {
|
|
447
467
|
/**
|
|
448
|
-
*
|
|
449
|
-
* @
|
|
450
|
-
* @readonly
|
|
468
|
+
* Number of items to load.
|
|
469
|
+
* @max 500
|
|
451
470
|
*/
|
|
452
|
-
|
|
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;
|
|
453
480
|
}
|
|
454
|
-
interface
|
|
455
|
-
/** Retrieved
|
|
456
|
-
|
|
481
|
+
interface ListMenusResponse {
|
|
482
|
+
/** Retrieved menus. */
|
|
483
|
+
menus?: Menu[];
|
|
484
|
+
/** The metadata of the paginated results. */
|
|
485
|
+
pagingMetadata?: CursorPagingMetadata;
|
|
457
486
|
}
|
|
458
|
-
interface
|
|
487
|
+
interface CursorPagingMetadata {
|
|
488
|
+
/** Number of items returned in the response. */
|
|
489
|
+
count?: number | null;
|
|
490
|
+
/** Offset that was requested. */
|
|
491
|
+
cursors?: Cursors;
|
|
459
492
|
/**
|
|
460
|
-
*
|
|
461
|
-
*
|
|
462
|
-
*
|
|
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.
|
|
463
496
|
*/
|
|
464
|
-
|
|
497
|
+
hasNext?: boolean | null;
|
|
465
498
|
}
|
|
466
|
-
interface
|
|
467
|
-
/**
|
|
499
|
+
interface Cursors {
|
|
500
|
+
/** Cursor pointing to next page in the list of results. */
|
|
501
|
+
next?: string | null;
|
|
502
|
+
/** Cursor pointing to previous page in the list of results. */
|
|
503
|
+
prev?: string | null;
|
|
504
|
+
}
|
|
505
|
+
interface QueryMenusRequest {
|
|
506
|
+
/** Query options. */
|
|
468
507
|
query?: CursorQuery;
|
|
469
508
|
}
|
|
470
509
|
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
@@ -530,431 +569,369 @@ interface AddressLocation {
|
|
|
530
569
|
/** Address longitude. */
|
|
531
570
|
longitude?: number | null;
|
|
532
571
|
}
|
|
533
|
-
interface
|
|
534
|
-
/**
|
|
535
|
-
|
|
536
|
-
* @max 500
|
|
537
|
-
*/
|
|
538
|
-
limit?: number | null;
|
|
539
|
-
/**
|
|
540
|
-
* Pointer to the next or previous page in the list of results.
|
|
541
|
-
*
|
|
542
|
-
* You can get the relevant cursor token
|
|
543
|
-
* from the `pagingMetadata` object in the previous call's response.
|
|
544
|
-
* Not relevant for the first request.
|
|
545
|
-
*/
|
|
546
|
-
cursor?: string | null;
|
|
547
|
-
}
|
|
548
|
-
interface QueryMenusSiteUrlResponse {
|
|
549
|
-
/** Retrieved menuInfos with path urls. */
|
|
550
|
-
menuSiteUrls?: MenuSiteUrl[];
|
|
572
|
+
interface QueryMenusResponse {
|
|
573
|
+
/** Retrieved menus. */
|
|
574
|
+
menus?: Menu[];
|
|
551
575
|
/** The metadata of the paginated results. */
|
|
552
576
|
pagingMetadata?: CursorPagingMetadata;
|
|
553
577
|
}
|
|
554
|
-
interface
|
|
555
|
-
/**
|
|
556
|
-
|
|
557
|
-
/** Offset that was requested. */
|
|
558
|
-
cursors?: Cursors;
|
|
578
|
+
interface UpdateMenuRequest {
|
|
579
|
+
/** Menu to update. */
|
|
580
|
+
menu: Menu;
|
|
559
581
|
/**
|
|
560
|
-
*
|
|
561
|
-
*
|
|
562
|
-
* If `false`, this is the last page.
|
|
582
|
+
* Explicit list of fields to update.
|
|
583
|
+
* @internal
|
|
563
584
|
*/
|
|
564
|
-
|
|
585
|
+
mask?: string[];
|
|
565
586
|
}
|
|
566
|
-
interface
|
|
567
|
-
/**
|
|
568
|
-
|
|
569
|
-
/** Cursor pointing to previous page in the list of results. */
|
|
570
|
-
prev?: string | null;
|
|
587
|
+
interface UpdateMenuResponse {
|
|
588
|
+
/** Updated menu. */
|
|
589
|
+
menu?: Menu;
|
|
571
590
|
}
|
|
572
|
-
interface
|
|
573
|
-
/**
|
|
574
|
-
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
575
|
-
* @format GUID
|
|
576
|
-
*/
|
|
577
|
-
metaSiteId?: string;
|
|
578
|
-
/**
|
|
579
|
-
* Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
|
|
580
|
-
* @format GUID
|
|
581
|
-
*/
|
|
582
|
-
siteId?: string;
|
|
583
|
-
/** Invalidate by App */
|
|
584
|
-
app?: App;
|
|
585
|
-
/** Invalidate by page id */
|
|
586
|
-
page?: Page;
|
|
587
|
-
/** Invalidate by URI path */
|
|
588
|
-
uri?: URI;
|
|
589
|
-
/** Invalidate by file (for media files such as PDFs) */
|
|
590
|
-
file?: File;
|
|
591
|
-
/** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */
|
|
592
|
-
customTag?: CustomTag;
|
|
593
|
-
/** Invalidate by multiple page ids */
|
|
594
|
-
pages?: Pages;
|
|
595
|
-
/** Invalidate by multiple URI paths */
|
|
596
|
-
uris?: URIs;
|
|
597
|
-
/**
|
|
598
|
-
* tell us why you're invalidating the cache. You don't need to add your app name
|
|
599
|
-
* @maxLength 256
|
|
600
|
-
*/
|
|
601
|
-
reason?: string | null;
|
|
602
|
-
/** Is local DS */
|
|
603
|
-
localDc?: boolean;
|
|
604
|
-
hardPurge?: boolean;
|
|
591
|
+
interface BulkUpdateMenuRequest {
|
|
605
592
|
/**
|
|
606
|
-
*
|
|
607
|
-
*
|
|
608
|
-
*
|
|
609
|
-
* Example: generate a UUID, pass it here, and later match it in the CDN purge completion event.
|
|
610
|
-
* @maxLength 256
|
|
593
|
+
* Menus to update.
|
|
594
|
+
* @minSize 1
|
|
595
|
+
* @maxSize 100
|
|
611
596
|
*/
|
|
612
|
-
|
|
597
|
+
menus: MaskedMenu[];
|
|
598
|
+
/** Whether to receive the entity in the response. */
|
|
599
|
+
returnEntity?: boolean;
|
|
613
600
|
}
|
|
614
|
-
|
|
615
|
-
|
|
601
|
+
interface MaskedMenu {
|
|
602
|
+
/** Menu to updated. */
|
|
603
|
+
menu?: Menu;
|
|
604
|
+
/** Explicit list of fields to update. */
|
|
605
|
+
mask?: string[];
|
|
606
|
+
}
|
|
607
|
+
interface BulkUpdateMenuResponse {
|
|
616
608
|
/**
|
|
617
|
-
*
|
|
618
|
-
* @
|
|
609
|
+
* Results of bulk menu update.
|
|
610
|
+
* @minSize 1
|
|
611
|
+
* @maxSize 100
|
|
619
612
|
*/
|
|
620
|
-
|
|
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 {
|
|
621
638
|
/**
|
|
622
|
-
*
|
|
639
|
+
* Menu ID.
|
|
623
640
|
* @format GUID
|
|
624
641
|
*/
|
|
625
|
-
|
|
626
|
-
/** Invalidate by App */
|
|
627
|
-
app?: App;
|
|
628
|
-
/** Invalidate by page id */
|
|
629
|
-
page?: Page;
|
|
630
|
-
/** Invalidate by URI path */
|
|
631
|
-
uri?: URI;
|
|
632
|
-
/** Invalidate by file (for media files such as PDFs) */
|
|
633
|
-
file?: File;
|
|
634
|
-
/** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */
|
|
635
|
-
customTag?: CustomTag;
|
|
636
|
-
/** Invalidate by multiple page ids */
|
|
637
|
-
pages?: Pages;
|
|
638
|
-
/** Invalidate by multiple URI paths */
|
|
639
|
-
uris?: URIs;
|
|
642
|
+
menuId: string;
|
|
640
643
|
}
|
|
641
|
-
interface
|
|
642
|
-
|
|
643
|
-
|
|
644
|
-
* @minLength 1
|
|
645
|
-
*/
|
|
646
|
-
appDefId?: string;
|
|
644
|
+
interface DeleteMenuResponse {
|
|
645
|
+
}
|
|
646
|
+
interface RunMenusMultiLocationMigrationRequest {
|
|
647
647
|
/**
|
|
648
|
-
*
|
|
648
|
+
* business location id
|
|
649
649
|
* @format GUID
|
|
650
650
|
*/
|
|
651
|
-
|
|
651
|
+
businessLocationId?: string;
|
|
652
652
|
}
|
|
653
|
-
interface
|
|
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 {
|
|
654
666
|
/**
|
|
655
|
-
*
|
|
667
|
+
* The MetaSiteId to clone from.
|
|
656
668
|
* @format GUID
|
|
657
669
|
*/
|
|
658
670
|
metaSiteId?: string;
|
|
659
|
-
/**
|
|
660
|
-
* Invalidate by Page ID
|
|
661
|
-
* @minLength 1
|
|
662
|
-
*/
|
|
663
|
-
pageId?: string;
|
|
664
671
|
}
|
|
665
|
-
interface
|
|
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;
|
|
666
681
|
/**
|
|
667
|
-
*
|
|
668
|
-
*
|
|
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`.
|
|
669
684
|
*/
|
|
670
|
-
|
|
685
|
+
entityFqdn?: string;
|
|
671
686
|
/**
|
|
672
|
-
*
|
|
673
|
-
*
|
|
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`.
|
|
674
689
|
*/
|
|
675
|
-
|
|
676
|
-
|
|
677
|
-
|
|
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;
|
|
678
695
|
/**
|
|
679
|
-
* the
|
|
680
|
-
*
|
|
696
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
697
|
+
* (for example, GDPR).
|
|
681
698
|
*/
|
|
682
|
-
|
|
699
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
700
|
+
/** If present, indicates the action that triggered the event. */
|
|
701
|
+
originatedFrom?: string | null;
|
|
683
702
|
/**
|
|
684
|
-
*
|
|
685
|
-
*
|
|
686
|
-
* @maxLength 256
|
|
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.
|
|
687
705
|
*/
|
|
688
|
-
|
|
706
|
+
entityEventSequence?: string | null;
|
|
689
707
|
}
|
|
690
|
-
|
|
708
|
+
/** @oneof */
|
|
709
|
+
interface DomainEventBodyOneOf {
|
|
710
|
+
createdEvent?: EntityCreatedEvent;
|
|
711
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
712
|
+
deletedEvent?: EntityDeletedEvent;
|
|
713
|
+
actionEvent?: ActionEvent;
|
|
714
|
+
}
|
|
715
|
+
interface EntityCreatedEvent {
|
|
716
|
+
entityAsJson?: string;
|
|
691
717
|
/**
|
|
692
|
-
* the
|
|
693
|
-
* @
|
|
718
|
+
* Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity
|
|
719
|
+
* @internal
|
|
694
720
|
*/
|
|
695
|
-
|
|
721
|
+
triggeredByUndelete?: boolean | null;
|
|
722
|
+
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
723
|
+
restoreInfo?: RestoreInfo;
|
|
696
724
|
/**
|
|
697
|
-
*
|
|
698
|
-
* @
|
|
699
|
-
* @maxLength 256
|
|
725
|
+
* Optional domain-specific metadata defined by the API owner, encoded as JSON.
|
|
726
|
+
* @internal
|
|
700
727
|
*/
|
|
701
|
-
|
|
728
|
+
additionalMetadataAsJson?: string | null;
|
|
702
729
|
}
|
|
703
|
-
interface
|
|
730
|
+
interface RestoreInfo {
|
|
731
|
+
deletedDate?: Date | null;
|
|
732
|
+
}
|
|
733
|
+
interface EntityUpdatedEvent {
|
|
704
734
|
/**
|
|
705
|
-
* the
|
|
706
|
-
*
|
|
735
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
736
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
737
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
707
738
|
*/
|
|
708
|
-
|
|
739
|
+
currentEntityAsJson?: string;
|
|
709
740
|
/**
|
|
710
|
-
*
|
|
711
|
-
*
|
|
712
|
-
*
|
|
741
|
+
* This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard
|
|
742
|
+
* wont populate it / have any reference to it in the API.
|
|
743
|
+
* The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,
|
|
744
|
+
* the developer should send only the new (current) entity.
|
|
745
|
+
* An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big
|
|
746
|
+
* Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.
|
|
747
|
+
* @internal
|
|
748
|
+
* @deprecated
|
|
713
749
|
*/
|
|
714
|
-
|
|
715
|
-
}
|
|
716
|
-
interface URIs {
|
|
750
|
+
previousEntityAsJson?: string | null;
|
|
717
751
|
/**
|
|
718
|
-
*
|
|
719
|
-
*
|
|
752
|
+
* Map of fully qualified field paths to their previous values for fields that changed.
|
|
753
|
+
* For more details please see [AIP](https://dev.wix.com/docs/rnd-general/articles/p13n-guidelines-aips/guidance-aips/design-patterns/7016-events#modified-fields-format)
|
|
754
|
+
* @internal
|
|
720
755
|
*/
|
|
721
|
-
|
|
756
|
+
modifiedFields?: Record<string, any>;
|
|
722
757
|
/**
|
|
723
|
-
*
|
|
724
|
-
* @
|
|
725
|
-
* @minLength 1
|
|
758
|
+
* Optional domain-specific metadata defined by the API owner, encoded as JSON.
|
|
759
|
+
* @internal
|
|
726
760
|
*/
|
|
727
|
-
|
|
728
|
-
}
|
|
729
|
-
interface DeleteOrphanSections {
|
|
730
|
-
/** Menu id */
|
|
731
|
-
menuId?: string;
|
|
732
|
-
}
|
|
733
|
-
interface MenusDataCloningCompleted {
|
|
734
|
-
}
|
|
735
|
-
interface CreateMenuRequest {
|
|
736
|
-
/** Menu details. */
|
|
737
|
-
menu: Menu;
|
|
738
|
-
}
|
|
739
|
-
interface CreateMenuResponse {
|
|
740
|
-
/** Menu. */
|
|
741
|
-
menu?: Menu;
|
|
761
|
+
additionalMetadataAsJson?: string | null;
|
|
742
762
|
}
|
|
743
|
-
interface
|
|
763
|
+
interface EntityDeletedEvent {
|
|
744
764
|
/**
|
|
745
|
-
*
|
|
746
|
-
* @
|
|
765
|
+
* Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled
|
|
766
|
+
* @internal
|
|
747
767
|
*/
|
|
748
|
-
|
|
749
|
-
/**
|
|
750
|
-
|
|
751
|
-
|
|
752
|
-
|
|
753
|
-
|
|
754
|
-
|
|
755
|
-
|
|
756
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
757
|
-
}
|
|
758
|
-
interface BulkCreateMenuResult {
|
|
759
|
-
/** Whether to receive the created menus in the response. */
|
|
760
|
-
menuMetadata?: ItemMetadata;
|
|
761
|
-
/** Created menu. */
|
|
762
|
-
menu?: Menu;
|
|
763
|
-
}
|
|
764
|
-
interface ItemMetadata {
|
|
765
|
-
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
766
|
-
id?: string | null;
|
|
767
|
-
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
768
|
-
originalIndex?: number;
|
|
769
|
-
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
770
|
-
success?: boolean;
|
|
771
|
-
/** Details about the error in case of failure. */
|
|
772
|
-
error?: ApplicationError;
|
|
768
|
+
movedToTrash?: boolean | null;
|
|
769
|
+
/** Entity that was deleted. */
|
|
770
|
+
deletedEntityAsJson?: string | null;
|
|
771
|
+
/**
|
|
772
|
+
* Optional domain-specific metadata defined by the API owner, encoded as JSON.
|
|
773
|
+
* @internal
|
|
774
|
+
*/
|
|
775
|
+
additionalMetadataAsJson?: string | null;
|
|
773
776
|
}
|
|
774
|
-
interface
|
|
775
|
-
|
|
776
|
-
code?: string;
|
|
777
|
-
/** Description of the error. */
|
|
778
|
-
description?: string;
|
|
779
|
-
/** Data related to the error. */
|
|
780
|
-
data?: Record<string, any> | null;
|
|
777
|
+
interface ActionEvent {
|
|
778
|
+
bodyAsJson?: string;
|
|
781
779
|
}
|
|
782
|
-
interface
|
|
783
|
-
/** Number of items that were successfully processed. */
|
|
784
|
-
totalSuccesses?: number;
|
|
785
|
-
/** Number of items that couldn't be processed. */
|
|
786
|
-
totalFailures?: number;
|
|
787
|
-
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
788
|
-
undetailedFailures?: number;
|
|
780
|
+
interface Empty {
|
|
789
781
|
}
|
|
790
|
-
interface
|
|
782
|
+
interface SyncContentToMultilingualRequest {
|
|
791
783
|
/**
|
|
792
|
-
*
|
|
784
|
+
* MetaSite ID
|
|
793
785
|
* @format GUID
|
|
794
786
|
*/
|
|
795
|
-
|
|
787
|
+
metaSiteId?: string;
|
|
796
788
|
}
|
|
797
|
-
interface
|
|
798
|
-
/** Menu. */
|
|
799
|
-
menu?: Menu;
|
|
789
|
+
interface SyncContentToMultilingualResponse {
|
|
800
790
|
}
|
|
801
|
-
interface
|
|
791
|
+
interface MessageEnvelope {
|
|
802
792
|
/**
|
|
803
|
-
*
|
|
793
|
+
* App instance ID.
|
|
804
794
|
* @format GUID
|
|
805
|
-
* @maxSize 500
|
|
806
795
|
*/
|
|
807
|
-
|
|
808
|
-
/** The metadata of the paginated results. */
|
|
809
|
-
paging?: CursorPaging;
|
|
810
|
-
/** Whether to return only menus that are visible to site visitors. */
|
|
811
|
-
onlyVisible?: boolean | null;
|
|
812
|
-
}
|
|
813
|
-
interface ListMenusResponse {
|
|
814
|
-
/** Retrieved menus. */
|
|
815
|
-
menus?: Menu[];
|
|
816
|
-
/** The metadata of the paginated results. */
|
|
817
|
-
pagingMetadata?: CursorPagingMetadata;
|
|
818
|
-
}
|
|
819
|
-
interface QueryMenusRequest {
|
|
820
|
-
/** Query options. */
|
|
821
|
-
query?: CursorQuery;
|
|
822
|
-
}
|
|
823
|
-
interface QueryMenusResponse {
|
|
824
|
-
/** Retrieved menus. */
|
|
825
|
-
menus?: Menu[];
|
|
826
|
-
/** The metadata of the paginated results. */
|
|
827
|
-
pagingMetadata?: CursorPagingMetadata;
|
|
828
|
-
}
|
|
829
|
-
interface UpdateMenuRequest {
|
|
830
|
-
/** Menu to update. */
|
|
831
|
-
menu: Menu;
|
|
796
|
+
instanceId?: string | null;
|
|
832
797
|
/**
|
|
833
|
-
*
|
|
834
|
-
* @
|
|
798
|
+
* Event type.
|
|
799
|
+
* @maxLength 150
|
|
835
800
|
*/
|
|
836
|
-
|
|
837
|
-
|
|
838
|
-
|
|
839
|
-
/**
|
|
840
|
-
|
|
801
|
+
eventType?: string;
|
|
802
|
+
/** The identification type and identity data. */
|
|
803
|
+
identity?: IdentificationData;
|
|
804
|
+
/** Stringify payload. */
|
|
805
|
+
data?: string;
|
|
806
|
+
/** Details related to the account */
|
|
807
|
+
accountInfo?: AccountInfo;
|
|
841
808
|
}
|
|
842
|
-
interface
|
|
809
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
843
810
|
/**
|
|
844
|
-
*
|
|
845
|
-
* @
|
|
846
|
-
* @maxSize 100
|
|
811
|
+
* ID of a site visitor that has not logged in to the site.
|
|
812
|
+
* @format GUID
|
|
847
813
|
*/
|
|
848
|
-
|
|
849
|
-
/** Whether to receive the entity in the response. */
|
|
850
|
-
returnEntity?: boolean;
|
|
851
|
-
}
|
|
852
|
-
interface MaskedMenu {
|
|
853
|
-
/** Menu to updated. */
|
|
854
|
-
menu?: Menu;
|
|
855
|
-
/** Explicit list of fields to update. */
|
|
856
|
-
mask?: string[];
|
|
857
|
-
}
|
|
858
|
-
interface BulkUpdateMenuResponse {
|
|
814
|
+
anonymousVisitorId?: string;
|
|
859
815
|
/**
|
|
860
|
-
*
|
|
861
|
-
* @
|
|
862
|
-
* @maxSize 100
|
|
816
|
+
* ID of a site visitor that has logged in to the site.
|
|
817
|
+
* @format GUID
|
|
863
818
|
*/
|
|
864
|
-
|
|
865
|
-
/**
|
|
866
|
-
|
|
867
|
-
|
|
868
|
-
|
|
869
|
-
|
|
870
|
-
|
|
871
|
-
|
|
872
|
-
|
|
873
|
-
|
|
874
|
-
|
|
875
|
-
/**
|
|
876
|
-
|
|
877
|
-
/** Identifier for the app whose extended fields are being updated. */
|
|
878
|
-
namespace: string;
|
|
879
|
-
/** 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. */
|
|
880
|
-
namespaceData: Record<string, any> | null;
|
|
881
|
-
}
|
|
882
|
-
interface UpdateExtendedFieldsResponse {
|
|
883
|
-
/** Namespace of the app. */
|
|
884
|
-
namespace?: string;
|
|
885
|
-
/** Updated extended fields data. */
|
|
886
|
-
namespaceData?: Record<string, any> | null;
|
|
819
|
+
memberId?: string;
|
|
820
|
+
/**
|
|
821
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
822
|
+
* @format GUID
|
|
823
|
+
*/
|
|
824
|
+
wixUserId?: string;
|
|
825
|
+
/**
|
|
826
|
+
* ID of an app.
|
|
827
|
+
* @format GUID
|
|
828
|
+
*/
|
|
829
|
+
appId?: string;
|
|
830
|
+
/** @readonly */
|
|
831
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
887
832
|
}
|
|
888
|
-
|
|
833
|
+
/** @oneof */
|
|
834
|
+
interface IdentificationDataIdOneOf {
|
|
889
835
|
/**
|
|
890
|
-
*
|
|
836
|
+
* ID of a site visitor that has not logged in to the site.
|
|
891
837
|
* @format GUID
|
|
892
838
|
*/
|
|
893
|
-
|
|
839
|
+
anonymousVisitorId?: string;
|
|
840
|
+
/**
|
|
841
|
+
* ID of a site visitor that has logged in to the site.
|
|
842
|
+
* @format GUID
|
|
843
|
+
*/
|
|
844
|
+
memberId?: string;
|
|
845
|
+
/**
|
|
846
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
847
|
+
* @format GUID
|
|
848
|
+
*/
|
|
849
|
+
wixUserId?: string;
|
|
850
|
+
/**
|
|
851
|
+
* ID of an app.
|
|
852
|
+
* @format GUID
|
|
853
|
+
*/
|
|
854
|
+
appId?: string;
|
|
894
855
|
}
|
|
895
|
-
|
|
856
|
+
declare enum WebhookIdentityType {
|
|
857
|
+
UNKNOWN = "UNKNOWN",
|
|
858
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
859
|
+
MEMBER = "MEMBER",
|
|
860
|
+
WIX_USER = "WIX_USER",
|
|
861
|
+
APP = "APP"
|
|
896
862
|
}
|
|
897
|
-
|
|
863
|
+
/** @enumType */
|
|
864
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
865
|
+
interface AccountInfo {
|
|
898
866
|
/**
|
|
899
|
-
*
|
|
867
|
+
* ID of the Wix account associated with the event.
|
|
900
868
|
* @format GUID
|
|
901
|
-
* @minSize 1
|
|
902
|
-
* @maxSize 100
|
|
903
869
|
*/
|
|
904
|
-
|
|
905
|
-
}
|
|
906
|
-
interface RestoreMenusFromTrashResponse {
|
|
870
|
+
accountId?: string | null;
|
|
907
871
|
/**
|
|
908
|
-
*
|
|
872
|
+
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
909
873
|
* @format GUID
|
|
910
|
-
* @maxSize 100
|
|
911
874
|
*/
|
|
912
|
-
|
|
875
|
+
parentAccountId?: string | null;
|
|
913
876
|
/**
|
|
914
|
-
*
|
|
877
|
+
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
915
878
|
* @format GUID
|
|
916
|
-
* @maxSize 100
|
|
917
879
|
*/
|
|
918
|
-
|
|
880
|
+
siteId?: string | null;
|
|
919
881
|
}
|
|
920
|
-
interface
|
|
882
|
+
interface DuplicateMenuRequest {
|
|
921
883
|
/**
|
|
922
|
-
*
|
|
884
|
+
* Menu id to be duplicated.
|
|
923
885
|
* @format GUID
|
|
924
886
|
*/
|
|
925
|
-
|
|
926
|
-
|
|
927
|
-
|
|
928
|
-
|
|
929
|
-
|
|
887
|
+
id: string;
|
|
888
|
+
/**
|
|
889
|
+
* Business location ids to duplicate the menu to.
|
|
890
|
+
* @format GUID
|
|
891
|
+
* @maxSize 100
|
|
892
|
+
*/
|
|
893
|
+
businessLocationIds?: string[] | null;
|
|
894
|
+
/** Indicates whether sub-entities (such as items) should be duplicated as well. */
|
|
895
|
+
duplicateSubEntities?: boolean | null;
|
|
896
|
+
/**
|
|
897
|
+
* The new name of the duplicated menu.
|
|
898
|
+
* @maxLength 500
|
|
899
|
+
*/
|
|
900
|
+
menuName?: string | null;
|
|
930
901
|
}
|
|
931
|
-
interface
|
|
932
|
-
/** @format GUID */
|
|
933
|
-
menuId?: string;
|
|
902
|
+
interface DuplicateMenuResponse {
|
|
934
903
|
/** @format GUID */
|
|
935
|
-
|
|
936
|
-
}
|
|
937
|
-
interface UpdateBusinessLocationIdResponse {
|
|
904
|
+
menuIds?: string[];
|
|
938
905
|
}
|
|
939
|
-
interface
|
|
906
|
+
interface GetMenuSiteUrlRequest {
|
|
940
907
|
/**
|
|
941
|
-
*
|
|
908
|
+
* Menu ID.
|
|
942
909
|
* @format GUID
|
|
910
|
+
* @readonly
|
|
943
911
|
*/
|
|
944
|
-
|
|
945
|
-
}
|
|
946
|
-
interface CloneMenusResponse {
|
|
912
|
+
id: string | null;
|
|
947
913
|
}
|
|
948
|
-
interface
|
|
914
|
+
interface GetMenuSiteUrlResponse {
|
|
915
|
+
/** Retrieved menuInfo with path url. */
|
|
916
|
+
menuSiteUrl?: MenuSiteUrl;
|
|
949
917
|
}
|
|
950
|
-
interface
|
|
918
|
+
interface MenuSiteUrl {
|
|
951
919
|
/**
|
|
952
|
-
*
|
|
953
|
-
* @
|
|
920
|
+
* Path URL.
|
|
921
|
+
* @minLength 1
|
|
922
|
+
* @maxLength 1000
|
|
954
923
|
*/
|
|
955
|
-
|
|
924
|
+
path?: string;
|
|
956
925
|
}
|
|
957
|
-
interface
|
|
926
|
+
interface QueryMenusSiteUrlRequest {
|
|
927
|
+
/** Query options */
|
|
928
|
+
query?: CursorQuery;
|
|
929
|
+
}
|
|
930
|
+
interface QueryMenusSiteUrlResponse {
|
|
931
|
+
/** Retrieved menuInfos with path urls. */
|
|
932
|
+
menuSiteUrls?: MenuSiteUrl[];
|
|
933
|
+
/** The metadata of the paginated results. */
|
|
934
|
+
pagingMetadata?: CursorPagingMetadata;
|
|
958
935
|
}
|
|
959
936
|
|
|
960
937
|
type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
@@ -967,13 +944,6 @@ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q
|
|
|
967
944
|
__responseType: Q;
|
|
968
945
|
__originalResponseType: R;
|
|
969
946
|
};
|
|
970
|
-
declare function duplicateMenu(): __PublicMethodMetaInfo<'POST', {
|
|
971
|
-
id: string;
|
|
972
|
-
}, DuplicateMenuRequest$1, DuplicateMenuRequest, DuplicateMenuResponse$1, DuplicateMenuResponse>;
|
|
973
|
-
declare function getMenuSiteUrl(): __PublicMethodMetaInfo<'GET', {
|
|
974
|
-
id: string;
|
|
975
|
-
}, GetMenuSiteUrlRequest$1, GetMenuSiteUrlRequest, GetMenuSiteUrlResponse$1, GetMenuSiteUrlResponse>;
|
|
976
|
-
declare function queryMenusSiteUrl(): __PublicMethodMetaInfo<'POST', {}, QueryMenusSiteUrlRequest$1, QueryMenusSiteUrlRequest, QueryMenusSiteUrlResponse$1, QueryMenusSiteUrlResponse>;
|
|
977
947
|
declare function createMenu(): __PublicMethodMetaInfo<'POST', {}, CreateMenuRequest$1, CreateMenuRequest, CreateMenuResponse$1, CreateMenuResponse>;
|
|
978
948
|
declare function bulkCreateMenus(): __PublicMethodMetaInfo<'POST', {}, BulkCreateMenusRequest$1, BulkCreateMenusRequest, BulkCreateMenusResponse$1, BulkCreateMenusResponse>;
|
|
979
949
|
declare function getMenu(): __PublicMethodMetaInfo<'GET', {
|
|
@@ -991,5 +961,12 @@ declare function updateExtendedFields(): __PublicMethodMetaInfo<'POST', {
|
|
|
991
961
|
declare function deleteMenu(): __PublicMethodMetaInfo<'DELETE', {
|
|
992
962
|
menuId: string;
|
|
993
963
|
}, DeleteMenuRequest$1, DeleteMenuRequest, DeleteMenuResponse$1, DeleteMenuResponse>;
|
|
964
|
+
declare function duplicateMenu(): __PublicMethodMetaInfo<'POST', {
|
|
965
|
+
id: string;
|
|
966
|
+
}, DuplicateMenuRequest$1, DuplicateMenuRequest, DuplicateMenuResponse$1, DuplicateMenuResponse>;
|
|
967
|
+
declare function getMenuSiteUrl(): __PublicMethodMetaInfo<'GET', {
|
|
968
|
+
id: string;
|
|
969
|
+
}, GetMenuSiteUrlRequest$1, GetMenuSiteUrlRequest, GetMenuSiteUrlResponse$1, GetMenuSiteUrlResponse>;
|
|
970
|
+
declare function queryMenusSiteUrl(): __PublicMethodMetaInfo<'POST', {}, QueryMenusSiteUrlRequest$1, QueryMenusSiteUrlRequest, QueryMenusSiteUrlResponse$1, QueryMenusSiteUrlResponse>;
|
|
994
971
|
|
|
995
|
-
export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, type AddressLocation as AddressLocationOriginal, type App as AppOriginal, type ApplicationError as ApplicationErrorOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type BulkCreateMenuResult as BulkCreateMenuResultOriginal, type BulkCreateMenusRequest as BulkCreateMenusRequestOriginal, type BulkCreateMenusResponse as BulkCreateMenusResponseOriginal, type BulkMenuResult as BulkMenuResultOriginal, type BulkUpdateMenuRequest as BulkUpdateMenuRequestOriginal, type BulkUpdateMenuResponse as BulkUpdateMenuResponseOriginal, type BusinessLocationDetails as BusinessLocationDetailsOriginal, type CloneMenusRequest as CloneMenusRequestOriginal, type CloneMenusResponse as CloneMenusResponseOriginal, type CreateMenuRequest as CreateMenuRequestOriginal, type CreateMenuResponse as CreateMenuResponseOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorQuery as CursorQueryOriginal, type CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, type CustomTag as CustomTagOriginal, type DeleteMenuRequest as DeleteMenuRequestOriginal, type DeleteMenuResponse as DeleteMenuResponseOriginal, type DeleteOrphanSections as DeleteOrphanSectionsOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type DuplicateMenuRequest as DuplicateMenuRequestOriginal, type DuplicateMenuResponse as DuplicateMenuResponseOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type ExtendedFields as ExtendedFieldsOriginal, type ExternalReferenceInfo as ExternalReferenceInfoOriginal, type File as FileOriginal, type GetMenuRequest as GetMenuRequestOriginal, type GetMenuResponse as GetMenuResponseOriginal, type GetMenuSiteUrlRequest as GetMenuSiteUrlRequestOriginal, type GetMenuSiteUrlResponse as GetMenuSiteUrlResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type InvalidateCacheGetByOneOf as InvalidateCacheGetByOneOfOriginal, type InvalidateCache as InvalidateCacheOriginal, type ItemMetadata as ItemMetadataOriginal, type Keyword as KeywordOriginal, type ListMenusRequest as ListMenusRequestOriginal, type ListMenusResponse as ListMenusResponseOriginal, type MaskedMenu as MaskedMenuOriginal, type Menu as MenuOriginal, type MenuSiteUrl as MenuSiteUrlOriginal, type MenusDataCloningCompleted as MenusDataCloningCompletedOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type Page as PageOriginal, type Pages as PagesOriginal, type QueryMenusRequest as QueryMenusRequestOriginal, type QueryMenusResponse as QueryMenusResponseOriginal, type QueryMenusSiteUrlRequest as QueryMenusSiteUrlRequestOriginal, type QueryMenusSiteUrlResponse as QueryMenusSiteUrlResponseOriginal, type RestoreInfo as RestoreInfoOriginal, type
|
|
972
|
+
export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, type AddressLocation as AddressLocationOriginal, type App as AppOriginal, type ApplicationError as ApplicationErrorOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type BulkCreateMenuResult as BulkCreateMenuResultOriginal, type BulkCreateMenusRequest as BulkCreateMenusRequestOriginal, type BulkCreateMenusResponse as BulkCreateMenusResponseOriginal, type BulkMenuResult as BulkMenuResultOriginal, type BulkUpdateMenuRequest as BulkUpdateMenuRequestOriginal, type BulkUpdateMenuResponse as BulkUpdateMenuResponseOriginal, type BusinessLocationDetails as BusinessLocationDetailsOriginal, type CloneMenusRequest as CloneMenusRequestOriginal, type CloneMenusResponse as CloneMenusResponseOriginal, type CreateMenuRequest as CreateMenuRequestOriginal, type CreateMenuResponse as CreateMenuResponseOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorQuery as CursorQueryOriginal, type CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, type CustomTag as CustomTagOriginal, type DeleteMenuRequest as DeleteMenuRequestOriginal, type DeleteMenuResponse as DeleteMenuResponseOriginal, type DeleteOrphanSections as DeleteOrphanSectionsOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type DuplicateMenuRequest as DuplicateMenuRequestOriginal, type DuplicateMenuResponse as DuplicateMenuResponseOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type ExtendedFields as ExtendedFieldsOriginal, type ExternalReferenceInfo as ExternalReferenceInfoOriginal, type File as FileOriginal, type GetMenuRequest as GetMenuRequestOriginal, type GetMenuResponse as GetMenuResponseOriginal, type GetMenuSiteUrlRequest as GetMenuSiteUrlRequestOriginal, type GetMenuSiteUrlResponse as GetMenuSiteUrlResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type InvalidateCacheGetByOneOf as InvalidateCacheGetByOneOfOriginal, type InvalidateCache as InvalidateCacheOriginal, type ItemMetadata as ItemMetadataOriginal, type Keyword as KeywordOriginal, type ListMenusRequest as ListMenusRequestOriginal, type ListMenusResponse as ListMenusResponseOriginal, type MaskedMenu as MaskedMenuOriginal, type Menu as MenuOriginal, type MenuSiteUrl as MenuSiteUrlOriginal, type MenusDataCloningCompleted as MenusDataCloningCompletedOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type Page as PageOriginal, type Pages as PagesOriginal, type QueryMenusRequest as QueryMenusRequestOriginal, type QueryMenusResponse as QueryMenusResponseOriginal, type QueryMenusSiteUrlRequest as QueryMenusSiteUrlRequestOriginal, type QueryMenusSiteUrlResponse as QueryMenusSiteUrlResponseOriginal, type RestoreInfo as RestoreInfoOriginal, type RunMenusMultiLocationMigrationRequest as RunMenusMultiLocationMigrationRequestOriginal, type RunMenusMultiLocationMigrationResponse as RunMenusMultiLocationMigrationResponseOriginal, type SeoSchema as SeoSchemaOriginal, type Settings as SettingsOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, type SyncContentToMultilingualRequest as SyncContentToMultilingualRequestOriginal, type SyncContentToMultilingualResponse as SyncContentToMultilingualResponseOriginal, type Tag as TagOriginal, type URI as URIOriginal, type URIs as URIsOriginal, type UpdateBusinessLocationIdRequest as UpdateBusinessLocationIdRequestOriginal, type UpdateBusinessLocationIdResponse as UpdateBusinessLocationIdResponseOriginal, type UpdateExtendedFieldsRequest as UpdateExtendedFieldsRequestOriginal, type UpdateExtendedFieldsResponse as UpdateExtendedFieldsResponseOriginal, type UpdateMenuRequest as UpdateMenuRequestOriginal, type UpdateMenuResponse as UpdateMenuResponseOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, bulkCreateMenus, bulkUpdateMenu, createMenu, deleteMenu, duplicateMenu, getMenu, getMenuSiteUrl, listMenus, queryMenus, queryMenusSiteUrl, updateExtendedFields, updateMenu };
|