@wix/auto_sdk_restaurants_menus 1.0.90 → 1.0.91
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +27 -27
- package/build/cjs/index.js +215 -215
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +520 -520
- package/build/cjs/index.typings.js +173 -173
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +315 -315
- package/build/cjs/meta.js +146 -146
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +27 -27
- package/build/es/index.mjs +215 -215
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +520 -520
- package/build/es/index.typings.mjs +173 -173
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +315 -315
- package/build/es/meta.mjs +146 -146
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +27 -27
- package/build/internal/cjs/index.typings.d.ts +544 -544
- package/build/internal/cjs/meta.d.ts +483 -483
- package/build/internal/es/index.d.mts +27 -27
- package/build/internal/es/index.typings.d.mts +544 -544
- package/build/internal/es/meta.d.mts +483 -483
- package/package.json +2 -2
package/build/cjs/meta.d.ts
CHANGED
|
@@ -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 {
|
|
@@ -205,297 +205,6 @@ interface ExternalReferenceInfo {
|
|
|
205
205
|
/** Whether the connection to the external system is currently active. */
|
|
206
206
|
connected?: boolean | null;
|
|
207
207
|
}
|
|
208
|
-
interface DuplicateMenuRequest {
|
|
209
|
-
/**
|
|
210
|
-
* Menu id to be duplicated.
|
|
211
|
-
* @format GUID
|
|
212
|
-
*/
|
|
213
|
-
id: string;
|
|
214
|
-
/**
|
|
215
|
-
* Business location ids to duplicate the menu to.
|
|
216
|
-
* @format GUID
|
|
217
|
-
* @maxSize 100
|
|
218
|
-
*/
|
|
219
|
-
businessLocationIds?: string[] | null;
|
|
220
|
-
/** Indicates whether sub-entities (such as items) should be duplicated as well. */
|
|
221
|
-
duplicateSubEntities?: boolean | null;
|
|
222
|
-
/**
|
|
223
|
-
* The new name of the duplicated menu.
|
|
224
|
-
* @maxLength 500
|
|
225
|
-
*/
|
|
226
|
-
menuName?: string | null;
|
|
227
|
-
}
|
|
228
|
-
interface DuplicateMenuResponse {
|
|
229
|
-
/** @format GUID */
|
|
230
|
-
menuIds?: string[];
|
|
231
|
-
}
|
|
232
|
-
interface DomainEvent extends DomainEventBodyOneOf {
|
|
233
|
-
createdEvent?: EntityCreatedEvent;
|
|
234
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
235
|
-
deletedEvent?: EntityDeletedEvent;
|
|
236
|
-
actionEvent?: ActionEvent;
|
|
237
|
-
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
238
|
-
id?: string;
|
|
239
|
-
/**
|
|
240
|
-
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
241
|
-
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
242
|
-
*/
|
|
243
|
-
entityFqdn?: string;
|
|
244
|
-
/**
|
|
245
|
-
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
246
|
-
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
247
|
-
*/
|
|
248
|
-
slug?: string;
|
|
249
|
-
/** ID of the entity associated with the event. */
|
|
250
|
-
entityId?: string;
|
|
251
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
252
|
-
eventTime?: Date | null;
|
|
253
|
-
/**
|
|
254
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
255
|
-
* (for example, GDPR).
|
|
256
|
-
*/
|
|
257
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
258
|
-
/** If present, indicates the action that triggered the event. */
|
|
259
|
-
originatedFrom?: string | null;
|
|
260
|
-
/**
|
|
261
|
-
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at `16:00` and then again at `16:01`, the second update will always have a higher sequence number.
|
|
262
|
-
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
263
|
-
*/
|
|
264
|
-
entityEventSequence?: string | null;
|
|
265
|
-
}
|
|
266
|
-
/** @oneof */
|
|
267
|
-
interface DomainEventBodyOneOf {
|
|
268
|
-
createdEvent?: EntityCreatedEvent;
|
|
269
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
270
|
-
deletedEvent?: EntityDeletedEvent;
|
|
271
|
-
actionEvent?: ActionEvent;
|
|
272
|
-
}
|
|
273
|
-
interface EntityCreatedEvent {
|
|
274
|
-
entityAsJson?: string;
|
|
275
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
276
|
-
restoreInfo?: RestoreInfo;
|
|
277
|
-
}
|
|
278
|
-
interface RestoreInfo {
|
|
279
|
-
deletedDate?: Date | null;
|
|
280
|
-
}
|
|
281
|
-
interface EntityUpdatedEvent {
|
|
282
|
-
/**
|
|
283
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
284
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
285
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
286
|
-
*/
|
|
287
|
-
currentEntityAsJson?: string;
|
|
288
|
-
}
|
|
289
|
-
interface EntityDeletedEvent {
|
|
290
|
-
/** Entity that was deleted. */
|
|
291
|
-
deletedEntityAsJson?: string | null;
|
|
292
|
-
}
|
|
293
|
-
interface ActionEvent {
|
|
294
|
-
bodyAsJson?: string;
|
|
295
|
-
}
|
|
296
|
-
interface MessageEnvelope {
|
|
297
|
-
/**
|
|
298
|
-
* App instance ID.
|
|
299
|
-
* @format GUID
|
|
300
|
-
*/
|
|
301
|
-
instanceId?: string | null;
|
|
302
|
-
/**
|
|
303
|
-
* Event type.
|
|
304
|
-
* @maxLength 150
|
|
305
|
-
*/
|
|
306
|
-
eventType?: string;
|
|
307
|
-
/** The identification type and identity data. */
|
|
308
|
-
identity?: IdentificationData;
|
|
309
|
-
/** Stringify payload. */
|
|
310
|
-
data?: string;
|
|
311
|
-
/** Details related to the account */
|
|
312
|
-
accountInfo?: AccountInfo;
|
|
313
|
-
}
|
|
314
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
315
|
-
/**
|
|
316
|
-
* ID of a site visitor that has not logged in to the site.
|
|
317
|
-
* @format GUID
|
|
318
|
-
*/
|
|
319
|
-
anonymousVisitorId?: string;
|
|
320
|
-
/**
|
|
321
|
-
* ID of a site visitor that has logged in to the site.
|
|
322
|
-
* @format GUID
|
|
323
|
-
*/
|
|
324
|
-
memberId?: string;
|
|
325
|
-
/**
|
|
326
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
327
|
-
* @format GUID
|
|
328
|
-
*/
|
|
329
|
-
wixUserId?: string;
|
|
330
|
-
/**
|
|
331
|
-
* ID of an app.
|
|
332
|
-
* @format GUID
|
|
333
|
-
*/
|
|
334
|
-
appId?: string;
|
|
335
|
-
/** @readonly */
|
|
336
|
-
identityType?: WebhookIdentityTypeWithLiterals;
|
|
337
|
-
}
|
|
338
|
-
/** @oneof */
|
|
339
|
-
interface IdentificationDataIdOneOf {
|
|
340
|
-
/**
|
|
341
|
-
* ID of a site visitor that has not logged in to the site.
|
|
342
|
-
* @format GUID
|
|
343
|
-
*/
|
|
344
|
-
anonymousVisitorId?: string;
|
|
345
|
-
/**
|
|
346
|
-
* ID of a site visitor that has logged in to the site.
|
|
347
|
-
* @format GUID
|
|
348
|
-
*/
|
|
349
|
-
memberId?: string;
|
|
350
|
-
/**
|
|
351
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
352
|
-
* @format GUID
|
|
353
|
-
*/
|
|
354
|
-
wixUserId?: string;
|
|
355
|
-
/**
|
|
356
|
-
* ID of an app.
|
|
357
|
-
* @format GUID
|
|
358
|
-
*/
|
|
359
|
-
appId?: string;
|
|
360
|
-
}
|
|
361
|
-
declare enum WebhookIdentityType {
|
|
362
|
-
UNKNOWN = "UNKNOWN",
|
|
363
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
364
|
-
MEMBER = "MEMBER",
|
|
365
|
-
WIX_USER = "WIX_USER",
|
|
366
|
-
APP = "APP"
|
|
367
|
-
}
|
|
368
|
-
/** @enumType */
|
|
369
|
-
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
370
|
-
interface AccountInfo {
|
|
371
|
-
/**
|
|
372
|
-
* ID of the Wix account associated with the event.
|
|
373
|
-
* @format GUID
|
|
374
|
-
*/
|
|
375
|
-
accountId?: string | null;
|
|
376
|
-
/**
|
|
377
|
-
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
378
|
-
* @format GUID
|
|
379
|
-
*/
|
|
380
|
-
parentAccountId?: string | null;
|
|
381
|
-
/**
|
|
382
|
-
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
383
|
-
* @format GUID
|
|
384
|
-
*/
|
|
385
|
-
siteId?: string | null;
|
|
386
|
-
}
|
|
387
|
-
interface GetMenuSiteUrlRequest {
|
|
388
|
-
/**
|
|
389
|
-
* Menu ID.
|
|
390
|
-
* @format GUID
|
|
391
|
-
* @readonly
|
|
392
|
-
*/
|
|
393
|
-
id: string | null;
|
|
394
|
-
}
|
|
395
|
-
interface GetMenuSiteUrlResponse {
|
|
396
|
-
/** Retrieved menuInfo with path url. */
|
|
397
|
-
menuSiteUrl?: MenuSiteUrl;
|
|
398
|
-
}
|
|
399
|
-
interface MenuSiteUrl {
|
|
400
|
-
/**
|
|
401
|
-
* Path URL.
|
|
402
|
-
* @minLength 1
|
|
403
|
-
* @maxLength 1000
|
|
404
|
-
*/
|
|
405
|
-
path?: string;
|
|
406
|
-
}
|
|
407
|
-
interface QueryMenusSiteUrlRequest {
|
|
408
|
-
/** Query options */
|
|
409
|
-
query?: CursorQuery;
|
|
410
|
-
}
|
|
411
|
-
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
412
|
-
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
413
|
-
cursorPaging?: CursorPaging;
|
|
414
|
-
/**
|
|
415
|
-
* Filter object in the following format:
|
|
416
|
-
* `"filter" : {
|
|
417
|
-
* "fieldName1": "value1",
|
|
418
|
-
* "fieldName2":{"$operator":"value2"}
|
|
419
|
-
* }`
|
|
420
|
-
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
|
|
421
|
-
*/
|
|
422
|
-
filter?: Record<string, any> | null;
|
|
423
|
-
/**
|
|
424
|
-
* Sort object in the following format:
|
|
425
|
-
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
426
|
-
*/
|
|
427
|
-
sort?: Sorting[];
|
|
428
|
-
}
|
|
429
|
-
/** @oneof */
|
|
430
|
-
interface CursorQueryPagingMethodOneOf {
|
|
431
|
-
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
432
|
-
cursorPaging?: CursorPaging;
|
|
433
|
-
}
|
|
434
|
-
interface Sorting {
|
|
435
|
-
/**
|
|
436
|
-
* Name of the field to sort by.
|
|
437
|
-
* @maxLength 512
|
|
438
|
-
*/
|
|
439
|
-
fieldName?: string;
|
|
440
|
-
/** Sort order. */
|
|
441
|
-
order?: SortOrderWithLiterals;
|
|
442
|
-
/**
|
|
443
|
-
* Origin point for geo-distance sorting on a GEO field
|
|
444
|
-
* results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
|
|
445
|
-
*/
|
|
446
|
-
origin?: AddressLocation;
|
|
447
|
-
}
|
|
448
|
-
declare enum SortOrder {
|
|
449
|
-
ASC = "ASC",
|
|
450
|
-
DESC = "DESC"
|
|
451
|
-
}
|
|
452
|
-
/** @enumType */
|
|
453
|
-
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
454
|
-
interface AddressLocation {
|
|
455
|
-
/** Address latitude. */
|
|
456
|
-
latitude?: number | null;
|
|
457
|
-
/** Address longitude. */
|
|
458
|
-
longitude?: number | null;
|
|
459
|
-
}
|
|
460
|
-
interface CursorPaging {
|
|
461
|
-
/**
|
|
462
|
-
* Number of items to load.
|
|
463
|
-
* @max 500
|
|
464
|
-
*/
|
|
465
|
-
limit?: number | null;
|
|
466
|
-
/**
|
|
467
|
-
* Pointer to the next or previous page in the list of results.
|
|
468
|
-
*
|
|
469
|
-
* You can get the relevant cursor token
|
|
470
|
-
* from the `pagingMetadata` object in the previous call's response.
|
|
471
|
-
* Not relevant for the first request.
|
|
472
|
-
*/
|
|
473
|
-
cursor?: string | null;
|
|
474
|
-
}
|
|
475
|
-
interface QueryMenusSiteUrlResponse {
|
|
476
|
-
/** Retrieved menuInfos with path urls. */
|
|
477
|
-
menuSiteUrls?: MenuSiteUrl[];
|
|
478
|
-
/** The metadata of the paginated results. */
|
|
479
|
-
pagingMetadata?: CursorPagingMetadata;
|
|
480
|
-
}
|
|
481
|
-
interface CursorPagingMetadata {
|
|
482
|
-
/** Number of items returned in the response. */
|
|
483
|
-
count?: number | null;
|
|
484
|
-
/** Offset that was requested. */
|
|
485
|
-
cursors?: Cursors;
|
|
486
|
-
/**
|
|
487
|
-
* Indicates if there are more results after the current page.
|
|
488
|
-
* If `true`, another page of results can be retrieved.
|
|
489
|
-
* If `false`, this is the last page.
|
|
490
|
-
*/
|
|
491
|
-
hasNext?: boolean | null;
|
|
492
|
-
}
|
|
493
|
-
interface Cursors {
|
|
494
|
-
/** Cursor pointing to next page in the list of results. */
|
|
495
|
-
next?: string | null;
|
|
496
|
-
/** Cursor pointing to previous page in the list of results. */
|
|
497
|
-
prev?: string | null;
|
|
498
|
-
}
|
|
499
208
|
interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
500
209
|
/**
|
|
501
210
|
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
@@ -727,25 +436,107 @@ interface GetMenuResponse {
|
|
|
727
436
|
}
|
|
728
437
|
interface ListMenusRequest {
|
|
729
438
|
/**
|
|
730
|
-
* Menu IDs.
|
|
731
|
-
* @format GUID
|
|
732
|
-
* @maxSize 500
|
|
439
|
+
* Menu IDs.
|
|
440
|
+
* @format GUID
|
|
441
|
+
* @maxSize 500
|
|
442
|
+
*/
|
|
443
|
+
menuIds?: string[];
|
|
444
|
+
/** The metadata of the paginated results. */
|
|
445
|
+
paging?: CursorPaging;
|
|
446
|
+
/** Whether to return only menus that are visible to site visitors. */
|
|
447
|
+
onlyVisible?: boolean | null;
|
|
448
|
+
}
|
|
449
|
+
interface CursorPaging {
|
|
450
|
+
/**
|
|
451
|
+
* Number of items to load.
|
|
452
|
+
* @max 500
|
|
453
|
+
*/
|
|
454
|
+
limit?: number | null;
|
|
455
|
+
/**
|
|
456
|
+
* Pointer to the next or previous page in the list of results.
|
|
457
|
+
*
|
|
458
|
+
* You can get the relevant cursor token
|
|
459
|
+
* from the `pagingMetadata` object in the previous call's response.
|
|
460
|
+
* Not relevant for the first request.
|
|
461
|
+
*/
|
|
462
|
+
cursor?: string | null;
|
|
463
|
+
}
|
|
464
|
+
interface ListMenusResponse {
|
|
465
|
+
/** Retrieved menus. */
|
|
466
|
+
menus?: Menu[];
|
|
467
|
+
/** The metadata of the paginated results. */
|
|
468
|
+
pagingMetadata?: CursorPagingMetadata;
|
|
469
|
+
}
|
|
470
|
+
interface CursorPagingMetadata {
|
|
471
|
+
/** Number of items returned in the response. */
|
|
472
|
+
count?: number | null;
|
|
473
|
+
/** Offset that was requested. */
|
|
474
|
+
cursors?: Cursors;
|
|
475
|
+
/**
|
|
476
|
+
* Indicates if there are more results after the current page.
|
|
477
|
+
* If `true`, another page of results can be retrieved.
|
|
478
|
+
* If `false`, this is the last page.
|
|
479
|
+
*/
|
|
480
|
+
hasNext?: boolean | null;
|
|
481
|
+
}
|
|
482
|
+
interface Cursors {
|
|
483
|
+
/** Cursor pointing to next page in the list of results. */
|
|
484
|
+
next?: string | null;
|
|
485
|
+
/** Cursor pointing to previous page in the list of results. */
|
|
486
|
+
prev?: string | null;
|
|
487
|
+
}
|
|
488
|
+
interface QueryMenusRequest {
|
|
489
|
+
/** Query options. */
|
|
490
|
+
query?: CursorQuery;
|
|
491
|
+
}
|
|
492
|
+
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
493
|
+
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
494
|
+
cursorPaging?: CursorPaging;
|
|
495
|
+
/**
|
|
496
|
+
* Filter object in the following format:
|
|
497
|
+
* `"filter" : {
|
|
498
|
+
* "fieldName1": "value1",
|
|
499
|
+
* "fieldName2":{"$operator":"value2"}
|
|
500
|
+
* }`
|
|
501
|
+
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
|
|
502
|
+
*/
|
|
503
|
+
filter?: Record<string, any> | null;
|
|
504
|
+
/**
|
|
505
|
+
* Sort object in the following format:
|
|
506
|
+
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
507
|
+
*/
|
|
508
|
+
sort?: Sorting[];
|
|
509
|
+
}
|
|
510
|
+
/** @oneof */
|
|
511
|
+
interface CursorQueryPagingMethodOneOf {
|
|
512
|
+
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
513
|
+
cursorPaging?: CursorPaging;
|
|
514
|
+
}
|
|
515
|
+
interface Sorting {
|
|
516
|
+
/**
|
|
517
|
+
* Name of the field to sort by.
|
|
518
|
+
* @maxLength 512
|
|
519
|
+
*/
|
|
520
|
+
fieldName?: string;
|
|
521
|
+
/** Sort order. */
|
|
522
|
+
order?: SortOrderWithLiterals;
|
|
523
|
+
/**
|
|
524
|
+
* Origin point for geo-distance sorting on a GEO field
|
|
525
|
+
* results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
|
|
733
526
|
*/
|
|
734
|
-
|
|
735
|
-
/** The metadata of the paginated results. */
|
|
736
|
-
paging?: CursorPaging;
|
|
737
|
-
/** Whether to return only menus that are visible to site visitors. */
|
|
738
|
-
onlyVisible?: boolean | null;
|
|
527
|
+
origin?: AddressLocation;
|
|
739
528
|
}
|
|
740
|
-
|
|
741
|
-
|
|
742
|
-
|
|
743
|
-
/** The metadata of the paginated results. */
|
|
744
|
-
pagingMetadata?: CursorPagingMetadata;
|
|
529
|
+
declare enum SortOrder {
|
|
530
|
+
ASC = "ASC",
|
|
531
|
+
DESC = "DESC"
|
|
745
532
|
}
|
|
746
|
-
|
|
747
|
-
|
|
748
|
-
|
|
533
|
+
/** @enumType */
|
|
534
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
535
|
+
interface AddressLocation {
|
|
536
|
+
/** Address latitude. */
|
|
537
|
+
latitude?: number | null;
|
|
538
|
+
/** Address longitude. */
|
|
539
|
+
longitude?: number | null;
|
|
749
540
|
}
|
|
750
541
|
interface QueryMenusResponse {
|
|
751
542
|
/** Retrieved menus. */
|
|
@@ -844,6 +635,70 @@ interface CloneMenusRequest {
|
|
|
844
635
|
}
|
|
845
636
|
interface CloneMenusResponse {
|
|
846
637
|
}
|
|
638
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
639
|
+
createdEvent?: EntityCreatedEvent;
|
|
640
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
641
|
+
deletedEvent?: EntityDeletedEvent;
|
|
642
|
+
actionEvent?: ActionEvent;
|
|
643
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
644
|
+
id?: string;
|
|
645
|
+
/**
|
|
646
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
647
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
648
|
+
*/
|
|
649
|
+
entityFqdn?: string;
|
|
650
|
+
/**
|
|
651
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
652
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
653
|
+
*/
|
|
654
|
+
slug?: string;
|
|
655
|
+
/** ID of the entity associated with the event. */
|
|
656
|
+
entityId?: string;
|
|
657
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
658
|
+
eventTime?: Date | null;
|
|
659
|
+
/**
|
|
660
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
661
|
+
* (for example, GDPR).
|
|
662
|
+
*/
|
|
663
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
664
|
+
/** If present, indicates the action that triggered the event. */
|
|
665
|
+
originatedFrom?: string | null;
|
|
666
|
+
/**
|
|
667
|
+
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at `16:00` and then again at `16:01`, the second update will always have a higher sequence number.
|
|
668
|
+
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
669
|
+
*/
|
|
670
|
+
entityEventSequence?: string | null;
|
|
671
|
+
}
|
|
672
|
+
/** @oneof */
|
|
673
|
+
interface DomainEventBodyOneOf {
|
|
674
|
+
createdEvent?: EntityCreatedEvent;
|
|
675
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
676
|
+
deletedEvent?: EntityDeletedEvent;
|
|
677
|
+
actionEvent?: ActionEvent;
|
|
678
|
+
}
|
|
679
|
+
interface EntityCreatedEvent {
|
|
680
|
+
entityAsJson?: string;
|
|
681
|
+
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
682
|
+
restoreInfo?: RestoreInfo;
|
|
683
|
+
}
|
|
684
|
+
interface RestoreInfo {
|
|
685
|
+
deletedDate?: Date | null;
|
|
686
|
+
}
|
|
687
|
+
interface EntityUpdatedEvent {
|
|
688
|
+
/**
|
|
689
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
690
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
691
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
692
|
+
*/
|
|
693
|
+
currentEntityAsJson?: string;
|
|
694
|
+
}
|
|
695
|
+
interface EntityDeletedEvent {
|
|
696
|
+
/** Entity that was deleted. */
|
|
697
|
+
deletedEntityAsJson?: string | null;
|
|
698
|
+
}
|
|
699
|
+
interface ActionEvent {
|
|
700
|
+
bodyAsJson?: string;
|
|
701
|
+
}
|
|
847
702
|
interface Empty {
|
|
848
703
|
}
|
|
849
704
|
interface SyncContentToMultilingualRequest {
|
|
@@ -855,6 +710,151 @@ interface SyncContentToMultilingualRequest {
|
|
|
855
710
|
}
|
|
856
711
|
interface SyncContentToMultilingualResponse {
|
|
857
712
|
}
|
|
713
|
+
interface MessageEnvelope {
|
|
714
|
+
/**
|
|
715
|
+
* App instance ID.
|
|
716
|
+
* @format GUID
|
|
717
|
+
*/
|
|
718
|
+
instanceId?: string | null;
|
|
719
|
+
/**
|
|
720
|
+
* Event type.
|
|
721
|
+
* @maxLength 150
|
|
722
|
+
*/
|
|
723
|
+
eventType?: string;
|
|
724
|
+
/** The identification type and identity data. */
|
|
725
|
+
identity?: IdentificationData;
|
|
726
|
+
/** Stringify payload. */
|
|
727
|
+
data?: string;
|
|
728
|
+
/** Details related to the account */
|
|
729
|
+
accountInfo?: AccountInfo;
|
|
730
|
+
}
|
|
731
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
732
|
+
/**
|
|
733
|
+
* ID of a site visitor that has not logged in to the site.
|
|
734
|
+
* @format GUID
|
|
735
|
+
*/
|
|
736
|
+
anonymousVisitorId?: string;
|
|
737
|
+
/**
|
|
738
|
+
* ID of a site visitor that has logged in to the site.
|
|
739
|
+
* @format GUID
|
|
740
|
+
*/
|
|
741
|
+
memberId?: string;
|
|
742
|
+
/**
|
|
743
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
744
|
+
* @format GUID
|
|
745
|
+
*/
|
|
746
|
+
wixUserId?: string;
|
|
747
|
+
/**
|
|
748
|
+
* ID of an app.
|
|
749
|
+
* @format GUID
|
|
750
|
+
*/
|
|
751
|
+
appId?: string;
|
|
752
|
+
/** @readonly */
|
|
753
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
754
|
+
}
|
|
755
|
+
/** @oneof */
|
|
756
|
+
interface IdentificationDataIdOneOf {
|
|
757
|
+
/**
|
|
758
|
+
* ID of a site visitor that has not logged in to the site.
|
|
759
|
+
* @format GUID
|
|
760
|
+
*/
|
|
761
|
+
anonymousVisitorId?: string;
|
|
762
|
+
/**
|
|
763
|
+
* ID of a site visitor that has logged in to the site.
|
|
764
|
+
* @format GUID
|
|
765
|
+
*/
|
|
766
|
+
memberId?: string;
|
|
767
|
+
/**
|
|
768
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
769
|
+
* @format GUID
|
|
770
|
+
*/
|
|
771
|
+
wixUserId?: string;
|
|
772
|
+
/**
|
|
773
|
+
* ID of an app.
|
|
774
|
+
* @format GUID
|
|
775
|
+
*/
|
|
776
|
+
appId?: string;
|
|
777
|
+
}
|
|
778
|
+
declare enum WebhookIdentityType {
|
|
779
|
+
UNKNOWN = "UNKNOWN",
|
|
780
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
781
|
+
MEMBER = "MEMBER",
|
|
782
|
+
WIX_USER = "WIX_USER",
|
|
783
|
+
APP = "APP"
|
|
784
|
+
}
|
|
785
|
+
/** @enumType */
|
|
786
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
787
|
+
interface AccountInfo {
|
|
788
|
+
/**
|
|
789
|
+
* ID of the Wix account associated with the event.
|
|
790
|
+
* @format GUID
|
|
791
|
+
*/
|
|
792
|
+
accountId?: string | null;
|
|
793
|
+
/**
|
|
794
|
+
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
795
|
+
* @format GUID
|
|
796
|
+
*/
|
|
797
|
+
parentAccountId?: string | null;
|
|
798
|
+
/**
|
|
799
|
+
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
800
|
+
* @format GUID
|
|
801
|
+
*/
|
|
802
|
+
siteId?: string | null;
|
|
803
|
+
}
|
|
804
|
+
interface DuplicateMenuRequest {
|
|
805
|
+
/**
|
|
806
|
+
* Menu id to be duplicated.
|
|
807
|
+
* @format GUID
|
|
808
|
+
*/
|
|
809
|
+
id: string;
|
|
810
|
+
/**
|
|
811
|
+
* Business location ids to duplicate the menu to.
|
|
812
|
+
* @format GUID
|
|
813
|
+
* @maxSize 100
|
|
814
|
+
*/
|
|
815
|
+
businessLocationIds?: string[] | null;
|
|
816
|
+
/** Indicates whether sub-entities (such as items) should be duplicated as well. */
|
|
817
|
+
duplicateSubEntities?: boolean | null;
|
|
818
|
+
/**
|
|
819
|
+
* The new name of the duplicated menu.
|
|
820
|
+
* @maxLength 500
|
|
821
|
+
*/
|
|
822
|
+
menuName?: string | null;
|
|
823
|
+
}
|
|
824
|
+
interface DuplicateMenuResponse {
|
|
825
|
+
/** @format GUID */
|
|
826
|
+
menuIds?: string[];
|
|
827
|
+
}
|
|
828
|
+
interface GetMenuSiteUrlRequest {
|
|
829
|
+
/**
|
|
830
|
+
* Menu ID.
|
|
831
|
+
* @format GUID
|
|
832
|
+
* @readonly
|
|
833
|
+
*/
|
|
834
|
+
id: string | null;
|
|
835
|
+
}
|
|
836
|
+
interface GetMenuSiteUrlResponse {
|
|
837
|
+
/** Retrieved menuInfo with path url. */
|
|
838
|
+
menuSiteUrl?: MenuSiteUrl;
|
|
839
|
+
}
|
|
840
|
+
interface MenuSiteUrl {
|
|
841
|
+
/**
|
|
842
|
+
* Path URL.
|
|
843
|
+
* @minLength 1
|
|
844
|
+
* @maxLength 1000
|
|
845
|
+
*/
|
|
846
|
+
path?: string;
|
|
847
|
+
}
|
|
848
|
+
interface QueryMenusSiteUrlRequest {
|
|
849
|
+
/** Query options */
|
|
850
|
+
query?: CursorQuery;
|
|
851
|
+
}
|
|
852
|
+
interface QueryMenusSiteUrlResponse {
|
|
853
|
+
/** Retrieved menuInfos with path urls. */
|
|
854
|
+
menuSiteUrls?: MenuSiteUrl[];
|
|
855
|
+
/** The metadata of the paginated results. */
|
|
856
|
+
pagingMetadata?: CursorPagingMetadata;
|
|
857
|
+
}
|
|
858
858
|
|
|
859
859
|
type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
860
860
|
getUrl: (context: any) => string;
|
|
@@ -866,13 +866,6 @@ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q
|
|
|
866
866
|
__responseType: Q;
|
|
867
867
|
__originalResponseType: R;
|
|
868
868
|
};
|
|
869
|
-
declare function duplicateMenu(): __PublicMethodMetaInfo<'POST', {
|
|
870
|
-
id: string;
|
|
871
|
-
}, DuplicateMenuRequest$1, DuplicateMenuRequest, DuplicateMenuResponse$1, DuplicateMenuResponse>;
|
|
872
|
-
declare function getMenuSiteUrl(): __PublicMethodMetaInfo<'GET', {
|
|
873
|
-
id: string;
|
|
874
|
-
}, GetMenuSiteUrlRequest$1, GetMenuSiteUrlRequest, GetMenuSiteUrlResponse$1, GetMenuSiteUrlResponse>;
|
|
875
|
-
declare function queryMenusSiteUrl(): __PublicMethodMetaInfo<'POST', {}, QueryMenusSiteUrlRequest$1, QueryMenusSiteUrlRequest, QueryMenusSiteUrlResponse$1, QueryMenusSiteUrlResponse>;
|
|
876
869
|
declare function createMenu(): __PublicMethodMetaInfo<'POST', {}, CreateMenuRequest$1, CreateMenuRequest, CreateMenuResponse$1, CreateMenuResponse>;
|
|
877
870
|
declare function bulkCreateMenus(): __PublicMethodMetaInfo<'POST', {}, BulkCreateMenusRequest$1, BulkCreateMenusRequest, BulkCreateMenusResponse$1, BulkCreateMenusResponse>;
|
|
878
871
|
declare function getMenu(): __PublicMethodMetaInfo<'GET', {
|
|
@@ -890,5 +883,12 @@ declare function updateExtendedFields(): __PublicMethodMetaInfo<'POST', {
|
|
|
890
883
|
declare function deleteMenu(): __PublicMethodMetaInfo<'DELETE', {
|
|
891
884
|
menuId: string;
|
|
892
885
|
}, DeleteMenuRequest$1, DeleteMenuRequest, DeleteMenuResponse$1, DeleteMenuResponse>;
|
|
886
|
+
declare function duplicateMenu(): __PublicMethodMetaInfo<'POST', {
|
|
887
|
+
id: string;
|
|
888
|
+
}, DuplicateMenuRequest$1, DuplicateMenuRequest, DuplicateMenuResponse$1, DuplicateMenuResponse>;
|
|
889
|
+
declare function getMenuSiteUrl(): __PublicMethodMetaInfo<'GET', {
|
|
890
|
+
id: string;
|
|
891
|
+
}, GetMenuSiteUrlRequest$1, GetMenuSiteUrlRequest, GetMenuSiteUrlResponse$1, GetMenuSiteUrlResponse>;
|
|
892
|
+
declare function queryMenusSiteUrl(): __PublicMethodMetaInfo<'POST', {}, QueryMenusSiteUrlRequest$1, QueryMenusSiteUrlRequest, QueryMenusSiteUrlResponse$1, QueryMenusSiteUrlResponse>;
|
|
893
893
|
|
|
894
894
|
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 };
|