@wix/auto_sdk_restaurants_menus 1.0.83 → 1.0.85
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +28 -28
- package/build/cjs/index.js +215 -215
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +531 -508
- package/build/cjs/index.typings.js +173 -173
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +333 -310
- package/build/cjs/meta.js +146 -146
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +28 -28
- package/build/es/index.mjs +215 -215
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +531 -508
- package/build/es/index.typings.mjs +173 -173
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +333 -310
- package/build/es/meta.mjs +146 -146
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +28 -28
- package/build/internal/cjs/index.typings.d.ts +535 -512
- package/build/internal/cjs/meta.d.ts +507 -484
- package/build/internal/es/index.d.mts +28 -28
- package/build/internal/es/index.typings.d.mts +535 -512
- package/build/internal/es/meta.d.mts +507 -484
- package/package.json +2 -2
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { DuplicateMenuRequest as DuplicateMenuRequest$1, DuplicateMenuResponse as DuplicateMenuResponse$1, GetMenuSiteUrlRequest as GetMenuSiteUrlRequest$1, GetMenuSiteUrlResponse as GetMenuSiteUrlResponse$1, QueryMenusSiteUrlRequest as QueryMenusSiteUrlRequest$1, QueryMenusSiteUrlResponse as QueryMenusSiteUrlResponse$1, 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 } from './index.typings.mjs';
|
|
2
2
|
import '@wix/sdk-types';
|
|
3
3
|
|
|
4
4
|
interface Menu {
|
|
@@ -222,288 +222,249 @@ 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 DuplicateMenuRequest {
|
|
226
226
|
/**
|
|
227
|
-
*
|
|
227
|
+
* Menu id to be duplicated.
|
|
228
228
|
* @format GUID
|
|
229
229
|
*/
|
|
230
|
-
|
|
230
|
+
id: string;
|
|
231
231
|
/**
|
|
232
|
-
*
|
|
232
|
+
* Business location ids to duplicate the menu to.
|
|
233
233
|
* @format GUID
|
|
234
|
+
* @maxSize 100
|
|
234
235
|
*/
|
|
235
|
-
|
|
236
|
-
/**
|
|
237
|
-
|
|
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;
|
|
236
|
+
businessLocationIds?: string[] | null;
|
|
237
|
+
/** Indicates whether sub-entities (such as items) should be duplicated as well. */
|
|
238
|
+
duplicateSubEntities?: boolean | null;
|
|
250
239
|
/**
|
|
251
|
-
*
|
|
252
|
-
* @maxLength
|
|
240
|
+
* The new name of the duplicated menu.
|
|
241
|
+
* @maxLength 500
|
|
253
242
|
*/
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
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;
|
|
258
256
|
/**
|
|
259
|
-
*
|
|
260
|
-
*
|
|
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
|
|
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`.
|
|
264
259
|
*/
|
|
265
|
-
|
|
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
|
+
*/
|
|
265
|
+
slug?: string;
|
|
266
|
+
/** ID of the entity associated with the event. */
|
|
267
|
+
entityId?: string;
|
|
268
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
269
|
+
eventTime?: Date | null;
|
|
270
|
+
/**
|
|
271
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
272
|
+
* (for example, GDPR).
|
|
273
|
+
*/
|
|
274
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
275
|
+
/** If present, indicates the action that triggered the event. */
|
|
276
|
+
originatedFrom?: string | null;
|
|
277
|
+
/**
|
|
278
|
+
* 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.
|
|
279
|
+
* 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.
|
|
280
|
+
*/
|
|
281
|
+
entityEventSequence?: string | null;
|
|
266
282
|
}
|
|
267
283
|
/** @oneof */
|
|
268
|
-
interface
|
|
284
|
+
interface DomainEventBodyOneOf {
|
|
285
|
+
createdEvent?: EntityCreatedEvent;
|
|
286
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
287
|
+
deletedEvent?: EntityDeletedEvent;
|
|
288
|
+
actionEvent?: ActionEvent;
|
|
289
|
+
}
|
|
290
|
+
interface EntityCreatedEvent {
|
|
291
|
+
entityAsJson?: string;
|
|
269
292
|
/**
|
|
270
|
-
*
|
|
271
|
-
* @
|
|
293
|
+
* Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity
|
|
294
|
+
* @internal
|
|
272
295
|
*/
|
|
273
|
-
|
|
296
|
+
triggeredByUndelete?: boolean | null;
|
|
297
|
+
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
298
|
+
restoreInfo?: RestoreInfo;
|
|
274
299
|
/**
|
|
275
|
-
*
|
|
276
|
-
* @
|
|
300
|
+
* Optional domain-specific metadata defined by the API owner, encoded as JSON.
|
|
301
|
+
* @internal
|
|
277
302
|
*/
|
|
278
|
-
|
|
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;
|
|
303
|
+
additionalMetadataAsJson?: string | null;
|
|
293
304
|
}
|
|
294
|
-
interface
|
|
305
|
+
interface RestoreInfo {
|
|
306
|
+
deletedDate?: Date | null;
|
|
307
|
+
}
|
|
308
|
+
interface EntityUpdatedEvent {
|
|
295
309
|
/**
|
|
296
|
-
*
|
|
297
|
-
*
|
|
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.
|
|
298
313
|
*/
|
|
299
|
-
|
|
314
|
+
currentEntityAsJson?: string;
|
|
300
315
|
/**
|
|
301
|
-
*
|
|
302
|
-
*
|
|
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
|
|
303
324
|
*/
|
|
304
|
-
|
|
325
|
+
previousEntityAsJson?: string | null;
|
|
326
|
+
/**
|
|
327
|
+
* Map of fully qualified field paths to their previous values for fields that changed.
|
|
328
|
+
* 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)
|
|
329
|
+
* @internal
|
|
330
|
+
*/
|
|
331
|
+
modifiedFields?: Record<string, any>;
|
|
332
|
+
/**
|
|
333
|
+
* Optional domain-specific metadata defined by the API owner, encoded as JSON.
|
|
334
|
+
* @internal
|
|
335
|
+
*/
|
|
336
|
+
additionalMetadataAsJson?: string | null;
|
|
305
337
|
}
|
|
306
|
-
interface
|
|
338
|
+
interface EntityDeletedEvent {
|
|
307
339
|
/**
|
|
308
|
-
*
|
|
309
|
-
* @
|
|
340
|
+
* Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled
|
|
341
|
+
* @internal
|
|
310
342
|
*/
|
|
311
|
-
|
|
343
|
+
movedToTrash?: boolean | null;
|
|
344
|
+
/** Entity that was deleted. */
|
|
345
|
+
deletedEntityAsJson?: string | null;
|
|
312
346
|
/**
|
|
313
|
-
*
|
|
314
|
-
* @
|
|
347
|
+
* Optional domain-specific metadata defined by the API owner, encoded as JSON.
|
|
348
|
+
* @internal
|
|
315
349
|
*/
|
|
316
|
-
|
|
350
|
+
additionalMetadataAsJson?: string | null;
|
|
317
351
|
}
|
|
318
|
-
interface
|
|
352
|
+
interface ActionEvent {
|
|
353
|
+
bodyAsJson?: string;
|
|
354
|
+
}
|
|
355
|
+
interface MessageEnvelope {
|
|
319
356
|
/**
|
|
320
|
-
*
|
|
357
|
+
* App instance ID.
|
|
321
358
|
* @format GUID
|
|
322
359
|
*/
|
|
323
|
-
|
|
360
|
+
instanceId?: string | null;
|
|
324
361
|
/**
|
|
325
|
-
*
|
|
326
|
-
* @
|
|
362
|
+
* Event type.
|
|
363
|
+
* @maxLength 150
|
|
327
364
|
*/
|
|
328
|
-
|
|
365
|
+
eventType?: string;
|
|
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;
|
|
329
372
|
}
|
|
330
|
-
interface
|
|
373
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
331
374
|
/**
|
|
332
|
-
*
|
|
375
|
+
* ID of a site visitor that has not logged in to the site.
|
|
333
376
|
* @format GUID
|
|
334
377
|
*/
|
|
335
|
-
|
|
378
|
+
anonymousVisitorId?: string;
|
|
336
379
|
/**
|
|
337
|
-
*
|
|
338
|
-
* @
|
|
339
|
-
* @maxLength 256
|
|
380
|
+
* ID of a site visitor that has logged in to the site.
|
|
381
|
+
* @format GUID
|
|
340
382
|
*/
|
|
341
|
-
|
|
342
|
-
}
|
|
343
|
-
interface CustomTag {
|
|
383
|
+
memberId?: string;
|
|
344
384
|
/**
|
|
345
|
-
*
|
|
385
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
346
386
|
* @format GUID
|
|
347
387
|
*/
|
|
348
|
-
|
|
388
|
+
wixUserId?: string;
|
|
349
389
|
/**
|
|
350
|
-
*
|
|
351
|
-
* @
|
|
352
|
-
* @maxLength 256
|
|
390
|
+
* ID of an app.
|
|
391
|
+
* @format GUID
|
|
353
392
|
*/
|
|
354
|
-
|
|
393
|
+
appId?: string;
|
|
394
|
+
/** @readonly */
|
|
395
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
355
396
|
}
|
|
356
|
-
|
|
397
|
+
/** @oneof */
|
|
398
|
+
interface IdentificationDataIdOneOf {
|
|
357
399
|
/**
|
|
358
|
-
*
|
|
400
|
+
* ID of a site visitor that has not logged in to the site.
|
|
359
401
|
* @format GUID
|
|
360
402
|
*/
|
|
361
|
-
|
|
403
|
+
anonymousVisitorId?: string;
|
|
362
404
|
/**
|
|
363
|
-
*
|
|
364
|
-
* @
|
|
365
|
-
* @minLength 1
|
|
405
|
+
* ID of a site visitor that has logged in to the site.
|
|
406
|
+
* @format GUID
|
|
366
407
|
*/
|
|
367
|
-
|
|
368
|
-
}
|
|
369
|
-
interface URIs {
|
|
408
|
+
memberId?: string;
|
|
370
409
|
/**
|
|
371
|
-
*
|
|
410
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
372
411
|
* @format GUID
|
|
373
412
|
*/
|
|
374
|
-
|
|
413
|
+
wixUserId?: string;
|
|
375
414
|
/**
|
|
376
|
-
*
|
|
377
|
-
* @
|
|
378
|
-
* @minLength 1
|
|
415
|
+
* ID of an app.
|
|
416
|
+
* @format GUID
|
|
379
417
|
*/
|
|
380
|
-
|
|
381
|
-
}
|
|
382
|
-
interface DeleteOrphanSections {
|
|
383
|
-
/** Menu id */
|
|
384
|
-
menuId?: string;
|
|
418
|
+
appId?: string;
|
|
385
419
|
}
|
|
386
|
-
|
|
420
|
+
declare enum WebhookIdentityType {
|
|
421
|
+
UNKNOWN = "UNKNOWN",
|
|
422
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
423
|
+
MEMBER = "MEMBER",
|
|
424
|
+
WIX_USER = "WIX_USER",
|
|
425
|
+
APP = "APP"
|
|
387
426
|
}
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
}
|
|
392
|
-
interface CreateMenuResponse {
|
|
393
|
-
/** Menu. */
|
|
394
|
-
menu?: Menu;
|
|
395
|
-
}
|
|
396
|
-
interface BulkCreateMenusRequest {
|
|
427
|
+
/** @enumType */
|
|
428
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
429
|
+
interface AccountInfo {
|
|
397
430
|
/**
|
|
398
|
-
*
|
|
399
|
-
* @
|
|
431
|
+
* ID of the Wix account associated with the event.
|
|
432
|
+
* @format GUID
|
|
400
433
|
*/
|
|
401
|
-
|
|
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 {
|
|
434
|
+
accountId?: string | null;
|
|
444
435
|
/**
|
|
445
|
-
*
|
|
436
|
+
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
446
437
|
* @format GUID
|
|
447
438
|
*/
|
|
448
|
-
|
|
449
|
-
}
|
|
450
|
-
interface GetMenuResponse {
|
|
451
|
-
/** Menu. */
|
|
452
|
-
menu?: Menu;
|
|
453
|
-
}
|
|
454
|
-
interface ListMenusRequest {
|
|
439
|
+
parentAccountId?: string | null;
|
|
455
440
|
/**
|
|
456
|
-
*
|
|
441
|
+
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
457
442
|
* @format GUID
|
|
458
|
-
* @maxSize 500
|
|
459
443
|
*/
|
|
460
|
-
|
|
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;
|
|
444
|
+
siteId?: string | null;
|
|
465
445
|
}
|
|
466
|
-
interface
|
|
467
|
-
/**
|
|
468
|
-
* Number of items to load.
|
|
469
|
-
* @max 500
|
|
470
|
-
*/
|
|
471
|
-
limit?: number | null;
|
|
446
|
+
interface GetMenuSiteUrlRequest {
|
|
472
447
|
/**
|
|
473
|
-
*
|
|
474
|
-
*
|
|
475
|
-
*
|
|
476
|
-
* from the `pagingMetadata` object in the previous call's response.
|
|
477
|
-
* Not relevant for the first request.
|
|
448
|
+
* Menu ID.
|
|
449
|
+
* @format GUID
|
|
450
|
+
* @readonly
|
|
478
451
|
*/
|
|
479
|
-
|
|
452
|
+
id: string | null;
|
|
480
453
|
}
|
|
481
|
-
interface
|
|
482
|
-
/** Retrieved
|
|
483
|
-
|
|
484
|
-
/** The metadata of the paginated results. */
|
|
485
|
-
pagingMetadata?: CursorPagingMetadata;
|
|
454
|
+
interface GetMenuSiteUrlResponse {
|
|
455
|
+
/** Retrieved menuInfo with path url. */
|
|
456
|
+
menuSiteUrl?: MenuSiteUrl;
|
|
486
457
|
}
|
|
487
|
-
interface
|
|
488
|
-
/** Number of items returned in the response. */
|
|
489
|
-
count?: number | null;
|
|
490
|
-
/** Offset that was requested. */
|
|
491
|
-
cursors?: Cursors;
|
|
458
|
+
interface MenuSiteUrl {
|
|
492
459
|
/**
|
|
493
|
-
*
|
|
494
|
-
*
|
|
495
|
-
*
|
|
460
|
+
* Path URL.
|
|
461
|
+
* @minLength 1
|
|
462
|
+
* @maxLength 1000
|
|
496
463
|
*/
|
|
497
|
-
|
|
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;
|
|
464
|
+
path?: string;
|
|
504
465
|
}
|
|
505
|
-
interface
|
|
506
|
-
/** Query options
|
|
466
|
+
interface QueryMenusSiteUrlRequest {
|
|
467
|
+
/** Query options */
|
|
507
468
|
query?: CursorQuery;
|
|
508
469
|
}
|
|
509
470
|
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
@@ -569,369 +530,431 @@ interface AddressLocation {
|
|
|
569
530
|
/** Address longitude. */
|
|
570
531
|
longitude?: number | null;
|
|
571
532
|
}
|
|
572
|
-
interface
|
|
573
|
-
/** Retrieved menus. */
|
|
574
|
-
menus?: Menu[];
|
|
575
|
-
/** The metadata of the paginated results. */
|
|
576
|
-
pagingMetadata?: CursorPagingMetadata;
|
|
577
|
-
}
|
|
578
|
-
interface UpdateMenuRequest {
|
|
579
|
-
/** Menu to update. */
|
|
580
|
-
menu: Menu;
|
|
533
|
+
interface CursorPaging {
|
|
581
534
|
/**
|
|
582
|
-
*
|
|
583
|
-
* @
|
|
535
|
+
* Number of items to load.
|
|
536
|
+
* @max 500
|
|
584
537
|
*/
|
|
585
|
-
|
|
586
|
-
}
|
|
587
|
-
interface UpdateMenuResponse {
|
|
588
|
-
/** Updated menu. */
|
|
589
|
-
menu?: Menu;
|
|
590
|
-
}
|
|
591
|
-
interface BulkUpdateMenuRequest {
|
|
538
|
+
limit?: number | null;
|
|
592
539
|
/**
|
|
593
|
-
*
|
|
594
|
-
*
|
|
595
|
-
*
|
|
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.
|
|
596
545
|
*/
|
|
597
|
-
|
|
598
|
-
/** Whether to receive the entity in the response. */
|
|
599
|
-
returnEntity?: boolean;
|
|
546
|
+
cursor?: string | null;
|
|
600
547
|
}
|
|
601
|
-
interface
|
|
602
|
-
/**
|
|
603
|
-
|
|
604
|
-
/**
|
|
605
|
-
|
|
548
|
+
interface QueryMenusSiteUrlResponse {
|
|
549
|
+
/** Retrieved menuInfos with path urls. */
|
|
550
|
+
menuSiteUrls?: MenuSiteUrl[];
|
|
551
|
+
/** The metadata of the paginated results. */
|
|
552
|
+
pagingMetadata?: CursorPagingMetadata;
|
|
606
553
|
}
|
|
607
|
-
interface
|
|
554
|
+
interface CursorPagingMetadata {
|
|
555
|
+
/** Number of items returned in the response. */
|
|
556
|
+
count?: number | null;
|
|
557
|
+
/** Offset that was requested. */
|
|
558
|
+
cursors?: Cursors;
|
|
608
559
|
/**
|
|
609
|
-
*
|
|
610
|
-
*
|
|
611
|
-
*
|
|
560
|
+
* Indicates if there are more results after the current page.
|
|
561
|
+
* If `true`, another page of results can be retrieved.
|
|
562
|
+
* If `false`, this is the last page.
|
|
612
563
|
*/
|
|
613
|
-
|
|
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;
|
|
564
|
+
hasNext?: boolean | null;
|
|
630
565
|
}
|
|
631
|
-
interface
|
|
632
|
-
/**
|
|
633
|
-
|
|
634
|
-
/**
|
|
635
|
-
|
|
566
|
+
interface Cursors {
|
|
567
|
+
/** Cursor pointing to next page in the list of results. */
|
|
568
|
+
next?: string | null;
|
|
569
|
+
/** Cursor pointing to previous page in the list of results. */
|
|
570
|
+
prev?: string | null;
|
|
636
571
|
}
|
|
637
|
-
interface
|
|
572
|
+
interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
638
573
|
/**
|
|
639
|
-
*
|
|
574
|
+
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
640
575
|
* @format GUID
|
|
641
576
|
*/
|
|
642
|
-
|
|
643
|
-
}
|
|
644
|
-
interface DeleteMenuResponse {
|
|
645
|
-
}
|
|
646
|
-
interface RunMenusMultiLocationMigrationRequest {
|
|
577
|
+
metaSiteId?: string;
|
|
647
578
|
/**
|
|
648
|
-
*
|
|
579
|
+
* Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
|
|
649
580
|
* @format GUID
|
|
650
581
|
*/
|
|
651
|
-
|
|
652
|
-
|
|
653
|
-
|
|
654
|
-
/**
|
|
655
|
-
|
|
656
|
-
|
|
657
|
-
|
|
658
|
-
/**
|
|
659
|
-
|
|
660
|
-
/**
|
|
661
|
-
|
|
662
|
-
|
|
663
|
-
|
|
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;
|
|
605
|
+
/**
|
|
606
|
+
* Optional caller-provided ID for tracking this invalidation through the system.
|
|
607
|
+
* When set, the corresponding CDN purge completion event will include this ID,
|
|
608
|
+
* allowing you to confirm when the invalidation has fully propagated.
|
|
609
|
+
* Example: generate a UUID, pass it here, and later match it in the CDN purge completion event.
|
|
610
|
+
* @maxLength 256
|
|
611
|
+
*/
|
|
612
|
+
correlationId?: string | null;
|
|
664
613
|
}
|
|
665
|
-
|
|
614
|
+
/** @oneof */
|
|
615
|
+
interface InvalidateCacheGetByOneOf {
|
|
666
616
|
/**
|
|
667
|
-
*
|
|
617
|
+
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
668
618
|
* @format GUID
|
|
669
619
|
*/
|
|
670
620
|
metaSiteId?: string;
|
|
621
|
+
/**
|
|
622
|
+
* Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
|
|
623
|
+
* @format GUID
|
|
624
|
+
*/
|
|
625
|
+
siteId?: string;
|
|
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;
|
|
671
640
|
}
|
|
672
|
-
interface
|
|
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;
|
|
641
|
+
interface App {
|
|
681
642
|
/**
|
|
682
|
-
*
|
|
683
|
-
*
|
|
643
|
+
* The AppDefId
|
|
644
|
+
* @minLength 1
|
|
684
645
|
*/
|
|
685
|
-
|
|
646
|
+
appDefId?: string;
|
|
686
647
|
/**
|
|
687
|
-
*
|
|
688
|
-
*
|
|
648
|
+
* The instance Id
|
|
649
|
+
* @format GUID
|
|
689
650
|
*/
|
|
690
|
-
|
|
691
|
-
|
|
692
|
-
|
|
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;
|
|
651
|
+
instanceId?: string;
|
|
652
|
+
}
|
|
653
|
+
interface Page {
|
|
695
654
|
/**
|
|
696
|
-
*
|
|
697
|
-
*
|
|
655
|
+
* the msid the page is on
|
|
656
|
+
* @format GUID
|
|
698
657
|
*/
|
|
699
|
-
|
|
700
|
-
/** If present, indicates the action that triggered the event. */
|
|
701
|
-
originatedFrom?: string | null;
|
|
658
|
+
metaSiteId?: string;
|
|
702
659
|
/**
|
|
703
|
-
*
|
|
704
|
-
*
|
|
660
|
+
* Invalidate by Page ID
|
|
661
|
+
* @minLength 1
|
|
705
662
|
*/
|
|
706
|
-
|
|
707
|
-
}
|
|
708
|
-
/** @oneof */
|
|
709
|
-
interface DomainEventBodyOneOf {
|
|
710
|
-
createdEvent?: EntityCreatedEvent;
|
|
711
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
712
|
-
deletedEvent?: EntityDeletedEvent;
|
|
713
|
-
actionEvent?: ActionEvent;
|
|
663
|
+
pageId?: string;
|
|
714
664
|
}
|
|
715
|
-
interface
|
|
716
|
-
entityAsJson?: string;
|
|
665
|
+
interface URI {
|
|
717
666
|
/**
|
|
718
|
-
*
|
|
719
|
-
* @
|
|
667
|
+
* the msid the URI is on
|
|
668
|
+
* @format GUID
|
|
720
669
|
*/
|
|
721
|
-
|
|
722
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
723
|
-
restoreInfo?: RestoreInfo;
|
|
670
|
+
metaSiteId?: string;
|
|
724
671
|
/**
|
|
725
|
-
*
|
|
726
|
-
* @
|
|
672
|
+
* URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes
|
|
673
|
+
* @minLength 1
|
|
727
674
|
*/
|
|
728
|
-
|
|
675
|
+
uriPath?: string;
|
|
729
676
|
}
|
|
730
|
-
interface
|
|
731
|
-
|
|
677
|
+
interface File {
|
|
678
|
+
/**
|
|
679
|
+
* the msid the file is related to
|
|
680
|
+
* @format GUID
|
|
681
|
+
*/
|
|
682
|
+
metaSiteId?: string;
|
|
683
|
+
/**
|
|
684
|
+
* Invalidate by filename (for media files such as PDFs)
|
|
685
|
+
* @minLength 1
|
|
686
|
+
* @maxLength 256
|
|
687
|
+
*/
|
|
688
|
+
fileName?: string;
|
|
732
689
|
}
|
|
733
|
-
interface
|
|
690
|
+
interface CustomTag {
|
|
734
691
|
/**
|
|
735
|
-
*
|
|
736
|
-
*
|
|
737
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
692
|
+
* the msid the tag is related to
|
|
693
|
+
* @format GUID
|
|
738
694
|
*/
|
|
739
|
-
|
|
695
|
+
metaSiteId?: string;
|
|
740
696
|
/**
|
|
741
|
-
*
|
|
742
|
-
*
|
|
743
|
-
*
|
|
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
|
|
697
|
+
* Tag to invalidate by
|
|
698
|
+
* @minLength 1
|
|
699
|
+
* @maxLength 256
|
|
749
700
|
*/
|
|
750
|
-
|
|
701
|
+
tag?: string;
|
|
702
|
+
}
|
|
703
|
+
interface Pages {
|
|
751
704
|
/**
|
|
752
|
-
*
|
|
753
|
-
*
|
|
754
|
-
* @internal
|
|
705
|
+
* the msid the pages are on
|
|
706
|
+
* @format GUID
|
|
755
707
|
*/
|
|
756
|
-
|
|
708
|
+
metaSiteId?: string;
|
|
757
709
|
/**
|
|
758
|
-
*
|
|
759
|
-
* @
|
|
710
|
+
* Invalidate by multiple Page IDs in a single message
|
|
711
|
+
* @maxSize 100
|
|
712
|
+
* @minLength 1
|
|
760
713
|
*/
|
|
761
|
-
|
|
714
|
+
pageIds?: string[];
|
|
762
715
|
}
|
|
763
|
-
interface
|
|
716
|
+
interface URIs {
|
|
764
717
|
/**
|
|
765
|
-
*
|
|
766
|
-
* @
|
|
718
|
+
* the msid the URIs are on
|
|
719
|
+
* @format GUID
|
|
767
720
|
*/
|
|
768
|
-
|
|
769
|
-
/** Entity that was deleted. */
|
|
770
|
-
deletedEntityAsJson?: string | null;
|
|
721
|
+
metaSiteId?: string;
|
|
771
722
|
/**
|
|
772
|
-
*
|
|
773
|
-
* @
|
|
723
|
+
* URI paths to invalidate (e.g. page/my/path) - without leading/trailing slashes
|
|
724
|
+
* @maxSize 100
|
|
725
|
+
* @minLength 1
|
|
774
726
|
*/
|
|
775
|
-
|
|
727
|
+
uriPaths?: string[];
|
|
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;
|
|
742
|
+
}
|
|
743
|
+
interface BulkCreateMenusRequest {
|
|
744
|
+
/**
|
|
745
|
+
* Menu details.
|
|
746
|
+
* @maxSize 100
|
|
747
|
+
*/
|
|
748
|
+
menus: Menu[];
|
|
749
|
+
/** Whether to receive the created menus in the response. */
|
|
750
|
+
returnEntity?: boolean;
|
|
751
|
+
}
|
|
752
|
+
interface BulkCreateMenusResponse {
|
|
753
|
+
/** Information about the created menus. */
|
|
754
|
+
results?: BulkCreateMenuResult[];
|
|
755
|
+
/** Metadata for the API call. */
|
|
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;
|
|
776
773
|
}
|
|
777
|
-
interface
|
|
778
|
-
|
|
774
|
+
interface ApplicationError {
|
|
775
|
+
/** Error code. */
|
|
776
|
+
code?: string;
|
|
777
|
+
/** Description of the error. */
|
|
778
|
+
description?: string;
|
|
779
|
+
/** Data related to the error. */
|
|
780
|
+
data?: Record<string, any> | null;
|
|
779
781
|
}
|
|
780
|
-
interface
|
|
782
|
+
interface BulkActionMetadata {
|
|
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;
|
|
781
789
|
}
|
|
782
|
-
interface
|
|
790
|
+
interface GetMenuRequest {
|
|
783
791
|
/**
|
|
784
|
-
*
|
|
792
|
+
* Menu ID.
|
|
785
793
|
* @format GUID
|
|
786
794
|
*/
|
|
787
|
-
|
|
795
|
+
menuId: string;
|
|
788
796
|
}
|
|
789
|
-
interface
|
|
797
|
+
interface GetMenuResponse {
|
|
798
|
+
/** Menu. */
|
|
799
|
+
menu?: Menu;
|
|
790
800
|
}
|
|
791
|
-
interface
|
|
801
|
+
interface ListMenusRequest {
|
|
792
802
|
/**
|
|
793
|
-
*
|
|
803
|
+
* Menu IDs.
|
|
794
804
|
* @format GUID
|
|
805
|
+
* @maxSize 500
|
|
795
806
|
*/
|
|
796
|
-
|
|
797
|
-
/**
|
|
798
|
-
|
|
799
|
-
|
|
800
|
-
|
|
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;
|
|
807
|
+
menuIds?: string[];
|
|
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;
|
|
808
812
|
}
|
|
809
|
-
interface
|
|
810
|
-
/**
|
|
811
|
-
|
|
812
|
-
|
|
813
|
-
|
|
814
|
-
anonymousVisitorId?: string;
|
|
815
|
-
/**
|
|
816
|
-
* ID of a site visitor that has logged in to the site.
|
|
817
|
-
* @format GUID
|
|
818
|
-
*/
|
|
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;
|
|
813
|
+
interface ListMenusResponse {
|
|
814
|
+
/** Retrieved menus. */
|
|
815
|
+
menus?: Menu[];
|
|
816
|
+
/** The metadata of the paginated results. */
|
|
817
|
+
pagingMetadata?: CursorPagingMetadata;
|
|
832
818
|
}
|
|
833
|
-
|
|
834
|
-
|
|
835
|
-
|
|
836
|
-
|
|
837
|
-
|
|
838
|
-
|
|
839
|
-
|
|
840
|
-
/**
|
|
841
|
-
|
|
842
|
-
|
|
843
|
-
|
|
844
|
-
|
|
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;
|
|
845
832
|
/**
|
|
846
|
-
*
|
|
847
|
-
* @
|
|
833
|
+
* Explicit list of fields to update.
|
|
834
|
+
* @internal
|
|
848
835
|
*/
|
|
849
|
-
|
|
836
|
+
mask?: string[];
|
|
837
|
+
}
|
|
838
|
+
interface UpdateMenuResponse {
|
|
839
|
+
/** Updated menu. */
|
|
840
|
+
menu?: Menu;
|
|
841
|
+
}
|
|
842
|
+
interface BulkUpdateMenuRequest {
|
|
850
843
|
/**
|
|
851
|
-
*
|
|
852
|
-
* @
|
|
844
|
+
* Menus to update.
|
|
845
|
+
* @minSize 1
|
|
846
|
+
* @maxSize 100
|
|
853
847
|
*/
|
|
854
|
-
|
|
848
|
+
menus: MaskedMenu[];
|
|
849
|
+
/** Whether to receive the entity in the response. */
|
|
850
|
+
returnEntity?: boolean;
|
|
855
851
|
}
|
|
856
|
-
|
|
857
|
-
|
|
858
|
-
|
|
859
|
-
|
|
860
|
-
|
|
861
|
-
APP = "APP"
|
|
852
|
+
interface MaskedMenu {
|
|
853
|
+
/** Menu to updated. */
|
|
854
|
+
menu?: Menu;
|
|
855
|
+
/** Explicit list of fields to update. */
|
|
856
|
+
mask?: string[];
|
|
862
857
|
}
|
|
863
|
-
|
|
864
|
-
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
865
|
-
interface AccountInfo {
|
|
858
|
+
interface BulkUpdateMenuResponse {
|
|
866
859
|
/**
|
|
867
|
-
*
|
|
868
|
-
* @
|
|
860
|
+
* Results of bulk menu update.
|
|
861
|
+
* @minSize 1
|
|
862
|
+
* @maxSize 100
|
|
869
863
|
*/
|
|
870
|
-
|
|
864
|
+
results?: BulkMenuResult[];
|
|
865
|
+
/** Metadata for the API call. */
|
|
866
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
867
|
+
}
|
|
868
|
+
interface BulkMenuResult {
|
|
869
|
+
/** Metadata for menu update. */
|
|
870
|
+
menuMetadata?: ItemMetadata;
|
|
871
|
+
/** Updated menu. Only returned if `returnEntity` is set to `true`. */
|
|
872
|
+
menu?: Menu;
|
|
873
|
+
}
|
|
874
|
+
interface UpdateExtendedFieldsRequest {
|
|
875
|
+
/** ID of the entity to update. */
|
|
876
|
+
id: string;
|
|
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;
|
|
887
|
+
}
|
|
888
|
+
interface DeleteMenuRequest {
|
|
871
889
|
/**
|
|
872
|
-
* ID
|
|
890
|
+
* Menu ID.
|
|
873
891
|
* @format GUID
|
|
874
892
|
*/
|
|
875
|
-
|
|
893
|
+
menuId: string;
|
|
894
|
+
}
|
|
895
|
+
interface DeleteMenuResponse {
|
|
896
|
+
}
|
|
897
|
+
interface RestoreMenusFromTrashRequest {
|
|
876
898
|
/**
|
|
877
|
-
*
|
|
899
|
+
* Menu IDs to restore from the trash bin.
|
|
878
900
|
* @format GUID
|
|
901
|
+
* @minSize 1
|
|
902
|
+
* @maxSize 100
|
|
879
903
|
*/
|
|
880
|
-
|
|
904
|
+
menuIds?: string[];
|
|
881
905
|
}
|
|
882
|
-
interface
|
|
906
|
+
interface RestoreMenusFromTrashResponse {
|
|
883
907
|
/**
|
|
884
|
-
* Menu
|
|
908
|
+
* Menu IDs that were successfully restored.
|
|
885
909
|
* @format GUID
|
|
910
|
+
* @maxSize 100
|
|
886
911
|
*/
|
|
887
|
-
|
|
912
|
+
restoredMenuIds?: string[];
|
|
888
913
|
/**
|
|
889
|
-
*
|
|
914
|
+
* Menu IDs that failed to restore.
|
|
890
915
|
* @format GUID
|
|
891
916
|
* @maxSize 100
|
|
892
917
|
*/
|
|
893
|
-
|
|
894
|
-
|
|
895
|
-
|
|
918
|
+
failedMenuIds?: string[];
|
|
919
|
+
}
|
|
920
|
+
interface RunMenusMultiLocationMigrationRequest {
|
|
896
921
|
/**
|
|
897
|
-
*
|
|
898
|
-
* @
|
|
922
|
+
* business location id
|
|
923
|
+
* @format GUID
|
|
899
924
|
*/
|
|
900
|
-
|
|
925
|
+
businessLocationId?: string;
|
|
901
926
|
}
|
|
902
|
-
interface
|
|
927
|
+
interface RunMenusMultiLocationMigrationResponse {
|
|
928
|
+
/** Whether menus multi-location migration finished successfully */
|
|
929
|
+
success?: boolean;
|
|
930
|
+
}
|
|
931
|
+
interface UpdateBusinessLocationIdRequest {
|
|
903
932
|
/** @format GUID */
|
|
904
|
-
|
|
933
|
+
menuId?: string;
|
|
934
|
+
/** @format GUID */
|
|
935
|
+
businessLocationId?: string | null;
|
|
905
936
|
}
|
|
906
|
-
interface
|
|
937
|
+
interface UpdateBusinessLocationIdResponse {
|
|
938
|
+
}
|
|
939
|
+
interface CloneMenusRequest {
|
|
907
940
|
/**
|
|
908
|
-
*
|
|
941
|
+
* The MetaSiteId to clone from.
|
|
909
942
|
* @format GUID
|
|
910
|
-
* @readonly
|
|
911
943
|
*/
|
|
912
|
-
|
|
944
|
+
metaSiteId?: string;
|
|
913
945
|
}
|
|
914
|
-
interface
|
|
915
|
-
/** Retrieved menuInfo with path url. */
|
|
916
|
-
menuSiteUrl?: MenuSiteUrl;
|
|
946
|
+
interface CloneMenusResponse {
|
|
917
947
|
}
|
|
918
|
-
interface
|
|
948
|
+
interface Empty {
|
|
949
|
+
}
|
|
950
|
+
interface SyncContentToMultilingualRequest {
|
|
919
951
|
/**
|
|
920
|
-
*
|
|
921
|
-
* @
|
|
922
|
-
* @maxLength 1000
|
|
952
|
+
* MetaSite ID
|
|
953
|
+
* @format GUID
|
|
923
954
|
*/
|
|
924
|
-
|
|
925
|
-
}
|
|
926
|
-
interface QueryMenusSiteUrlRequest {
|
|
927
|
-
/** Query options */
|
|
928
|
-
query?: CursorQuery;
|
|
955
|
+
metaSiteId?: string;
|
|
929
956
|
}
|
|
930
|
-
interface
|
|
931
|
-
/** Retrieved menuInfos with path urls. */
|
|
932
|
-
menuSiteUrls?: MenuSiteUrl[];
|
|
933
|
-
/** The metadata of the paginated results. */
|
|
934
|
-
pagingMetadata?: CursorPagingMetadata;
|
|
957
|
+
interface SyncContentToMultilingualResponse {
|
|
935
958
|
}
|
|
936
959
|
|
|
937
960
|
type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
@@ -944,6 +967,13 @@ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q
|
|
|
944
967
|
__responseType: Q;
|
|
945
968
|
__originalResponseType: R;
|
|
946
969
|
};
|
|
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>;
|
|
947
977
|
declare function createMenu(): __PublicMethodMetaInfo<'POST', {}, CreateMenuRequest$1, CreateMenuRequest, CreateMenuResponse$1, CreateMenuResponse>;
|
|
948
978
|
declare function bulkCreateMenus(): __PublicMethodMetaInfo<'POST', {}, BulkCreateMenusRequest$1, BulkCreateMenusRequest, BulkCreateMenusResponse$1, BulkCreateMenusResponse>;
|
|
949
979
|
declare function getMenu(): __PublicMethodMetaInfo<'GET', {
|
|
@@ -961,12 +991,5 @@ declare function updateExtendedFields(): __PublicMethodMetaInfo<'POST', {
|
|
|
961
991
|
declare function deleteMenu(): __PublicMethodMetaInfo<'DELETE', {
|
|
962
992
|
menuId: string;
|
|
963
993
|
}, 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>;
|
|
971
994
|
|
|
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 };
|
|
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 RestoreMenusFromTrashRequest as RestoreMenusFromTrashRequestOriginal, type RestoreMenusFromTrashResponse as RestoreMenusFromTrashResponseOriginal, 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 };
|