@wix/auto_sdk_restaurants_menus 1.0.97 → 1.0.98
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 +5 -5
- package/build/cjs/index.js +17 -17
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +362 -256
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +344 -238
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +5 -5
- package/build/es/index.mjs +17 -17
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +362 -256
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +344 -238
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +5 -5
- package/build/internal/cjs/index.typings.d.ts +407 -301
- package/build/internal/cjs/meta.d.ts +426 -320
- package/build/internal/es/index.d.mts +5 -5
- package/build/internal/es/index.typings.d.mts +407 -301
- package/build/internal/es/meta.d.mts +426 -320
- package/package.json +2 -2
package/build/cjs/meta.d.ts
CHANGED
|
@@ -266,6 +266,349 @@ interface ExternalReferenceInfo {
|
|
|
266
266
|
/** Whether the connection to the external system is currently active. */
|
|
267
267
|
connected?: boolean | null;
|
|
268
268
|
}
|
|
269
|
+
interface QueryMenuExportRowsRequest {
|
|
270
|
+
/**
|
|
271
|
+
* Filter: `{"menuId": "<GUID>"}` or `{"menuId": {"$eq": "<GUID>"}}`, required on the first page; a later page may omit
|
|
272
|
+
* it, and if it sends it, it must name the cursor's menu. Cursor paging only, at most 500 rows
|
|
273
|
+
* per page (default 100); a sort fails with `INVALID_MENU_EXPORT_QUERY`. This is the same wire format as the fed-infra
|
|
274
|
+
* export service's `ExportQueryV2`: filter 1, sort 2, cursor paging 6.
|
|
275
|
+
*/
|
|
276
|
+
query?: CursorQuery;
|
|
277
|
+
}
|
|
278
|
+
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
279
|
+
/** 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`. */
|
|
280
|
+
cursorPaging?: CursorPaging;
|
|
281
|
+
/**
|
|
282
|
+
* Filter object in the following format:
|
|
283
|
+
* `"filter" : {
|
|
284
|
+
* "fieldName1": "value1",
|
|
285
|
+
* "fieldName2":{"$operator":"value2"}
|
|
286
|
+
* }`
|
|
287
|
+
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
|
|
288
|
+
*/
|
|
289
|
+
filter?: Record<string, any> | null;
|
|
290
|
+
/**
|
|
291
|
+
* Sort object in the following format:
|
|
292
|
+
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
293
|
+
*/
|
|
294
|
+
sort?: Sorting[];
|
|
295
|
+
}
|
|
296
|
+
/** @oneof */
|
|
297
|
+
interface CursorQueryPagingMethodOneOf {
|
|
298
|
+
/** 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`. */
|
|
299
|
+
cursorPaging?: CursorPaging;
|
|
300
|
+
}
|
|
301
|
+
interface Sorting {
|
|
302
|
+
/**
|
|
303
|
+
* Name of the field to sort by.
|
|
304
|
+
* @maxLength 512
|
|
305
|
+
*/
|
|
306
|
+
fieldName?: string;
|
|
307
|
+
/** Sort order. */
|
|
308
|
+
order?: SortOrderWithLiterals;
|
|
309
|
+
/**
|
|
310
|
+
* Origin point for geo-distance sorting on a GEO field
|
|
311
|
+
* results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
|
|
312
|
+
*/
|
|
313
|
+
origin?: AddressLocation;
|
|
314
|
+
}
|
|
315
|
+
declare enum SortOrder {
|
|
316
|
+
ASC = "ASC",
|
|
317
|
+
DESC = "DESC"
|
|
318
|
+
}
|
|
319
|
+
/** @enumType */
|
|
320
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
321
|
+
interface AddressLocation {
|
|
322
|
+
/** Address latitude. */
|
|
323
|
+
latitude?: number | null;
|
|
324
|
+
/** Address longitude. */
|
|
325
|
+
longitude?: number | null;
|
|
326
|
+
}
|
|
327
|
+
interface CursorPaging {
|
|
328
|
+
/**
|
|
329
|
+
* Number of items to load.
|
|
330
|
+
* @max 500
|
|
331
|
+
*/
|
|
332
|
+
limit?: number | null;
|
|
333
|
+
/**
|
|
334
|
+
* Pointer to the next or previous page in the list of results.
|
|
335
|
+
*
|
|
336
|
+
* You can get the relevant cursor token
|
|
337
|
+
* from the `pagingMetadata` object in the previous call's response.
|
|
338
|
+
* Not relevant for the first request.
|
|
339
|
+
*/
|
|
340
|
+
cursor?: string | null;
|
|
341
|
+
}
|
|
342
|
+
interface QueryMenuExportRowsResponse {
|
|
343
|
+
/** The page's rows, in file order. */
|
|
344
|
+
menuExportRows?: MenuExportRow[];
|
|
345
|
+
/** Paging metadata: `cursors.next` is set while rows remain. */
|
|
346
|
+
pagingMetadata?: CursorPagingMetadata;
|
|
347
|
+
}
|
|
348
|
+
/**
|
|
349
|
+
* One CSV row. Every field is text exactly as written to the file (design-log/001 Q5); unused columns are empty.
|
|
350
|
+
* Free-text limits are the source field's product limit plus one, for the `'` the formula guard can add; `labels` allows
|
|
351
|
+
* 10 names of 50, each doubled at most by escaping, 9 separators and the guard. The other limits bound fixed values.
|
|
352
|
+
*/
|
|
353
|
+
interface MenuExportRow {
|
|
354
|
+
/**
|
|
355
|
+
* `section`, `item`, `variant`, `modifier_group` or `modifier`.
|
|
356
|
+
* @maxLength 20
|
|
357
|
+
*/
|
|
358
|
+
type?: string;
|
|
359
|
+
/**
|
|
360
|
+
* Name of the row's section.
|
|
361
|
+
* @maxLength 501
|
|
362
|
+
*/
|
|
363
|
+
sectionName?: string;
|
|
364
|
+
/**
|
|
365
|
+
* Section description, on section rows.
|
|
366
|
+
* @maxLength 1501
|
|
367
|
+
*/
|
|
368
|
+
sectionDescription?: string;
|
|
369
|
+
/**
|
|
370
|
+
* Item name, on item, variant, modifier group and modifier rows.
|
|
371
|
+
* @maxLength 201
|
|
372
|
+
*/
|
|
373
|
+
itemName?: string;
|
|
374
|
+
/**
|
|
375
|
+
* Item description, on item rows.
|
|
376
|
+
* @maxLength 1501
|
|
377
|
+
*/
|
|
378
|
+
itemDescription?: string;
|
|
379
|
+
/**
|
|
380
|
+
* Price with 2 or 3 decimals, for example `8.50` (a legacy price stored with more decimals is written as stored). On item rows: `MARKET_PRICE` for a market-price item, empty for an
|
|
381
|
+
* item priced by variants, `0.00` for an item without a stored price. On variant and modifier rows: `0.00` without a
|
|
382
|
+
* price or charge. Empty on section and modifier group rows.
|
|
383
|
+
* @maxLength 50
|
|
384
|
+
*/
|
|
385
|
+
price?: string;
|
|
386
|
+
/**
|
|
387
|
+
* The site's payment currency on item, variant and modifier rows. The importer doesn't read it: an imported menu takes
|
|
388
|
+
* the target site's currency.
|
|
389
|
+
* @maxLength 10
|
|
390
|
+
*/
|
|
391
|
+
currency?: string;
|
|
392
|
+
/**
|
|
393
|
+
* The item's label names, `;`-separated, each exactly as the site names it, with `\` and `;` inside a name escaped
|
|
394
|
+
* as `\\` and `\;`.
|
|
395
|
+
* @maxLength 1010
|
|
396
|
+
*/
|
|
397
|
+
labels?: string;
|
|
398
|
+
/**
|
|
399
|
+
* Modifier group name, on modifier group and modifier rows.
|
|
400
|
+
* @maxLength 101
|
|
401
|
+
*/
|
|
402
|
+
modifierGroupName?: string;
|
|
403
|
+
/**
|
|
404
|
+
* `yes` or `no`, on modifier group rows.
|
|
405
|
+
* @maxLength 3
|
|
406
|
+
*/
|
|
407
|
+
modifierRequired?: string;
|
|
408
|
+
/**
|
|
409
|
+
* Minimum selections, on modifier group rows.
|
|
410
|
+
* @maxLength 20
|
|
411
|
+
*/
|
|
412
|
+
modifierMinSelections?: string;
|
|
413
|
+
/**
|
|
414
|
+
* Maximum selections (`0` is unlimited), on modifier group rows.
|
|
415
|
+
* @maxLength 20
|
|
416
|
+
*/
|
|
417
|
+
modifierMaxSelections?: string;
|
|
418
|
+
/**
|
|
419
|
+
* Modifier name, on modifier rows.
|
|
420
|
+
* @maxLength 201
|
|
421
|
+
*/
|
|
422
|
+
modifierName?: string;
|
|
423
|
+
/**
|
|
424
|
+
* `yes` or `no`, on modifier rows.
|
|
425
|
+
* @maxLength 3
|
|
426
|
+
*/
|
|
427
|
+
modifierPreSelected?: string;
|
|
428
|
+
/**
|
|
429
|
+
* Variant name, on variant rows.
|
|
430
|
+
* @maxLength 201
|
|
431
|
+
*/
|
|
432
|
+
variantName?: string;
|
|
433
|
+
/**
|
|
434
|
+
* `yes` or `no` on section and item rows.
|
|
435
|
+
* @maxLength 3
|
|
436
|
+
*/
|
|
437
|
+
visible?: string;
|
|
438
|
+
}
|
|
439
|
+
interface CursorPagingMetadata {
|
|
440
|
+
/** Number of items returned in the response. */
|
|
441
|
+
count?: number | null;
|
|
442
|
+
/** Offset that was requested. */
|
|
443
|
+
cursors?: Cursors;
|
|
444
|
+
/**
|
|
445
|
+
* Indicates if there are more results after the current page.
|
|
446
|
+
* If `true`, another page of results can be retrieved.
|
|
447
|
+
* If `false`, this is the last page.
|
|
448
|
+
*/
|
|
449
|
+
hasNext?: boolean | null;
|
|
450
|
+
}
|
|
451
|
+
interface Cursors {
|
|
452
|
+
/** Cursor pointing to next page in the list of results. */
|
|
453
|
+
next?: string | null;
|
|
454
|
+
/** Cursor pointing to previous page in the list of results. */
|
|
455
|
+
prev?: string | null;
|
|
456
|
+
}
|
|
457
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
458
|
+
createdEvent?: EntityCreatedEvent;
|
|
459
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
460
|
+
deletedEvent?: EntityDeletedEvent;
|
|
461
|
+
actionEvent?: ActionEvent;
|
|
462
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
463
|
+
id?: string;
|
|
464
|
+
/**
|
|
465
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
466
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
467
|
+
*/
|
|
468
|
+
entityFqdn?: string;
|
|
469
|
+
/**
|
|
470
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
471
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
472
|
+
*/
|
|
473
|
+
slug?: string;
|
|
474
|
+
/** ID of the entity associated with the event. */
|
|
475
|
+
entityId?: string;
|
|
476
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
477
|
+
eventTime?: Date | null;
|
|
478
|
+
/**
|
|
479
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
480
|
+
* (for example, GDPR).
|
|
481
|
+
*/
|
|
482
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
483
|
+
/** If present, indicates the action that triggered the event. */
|
|
484
|
+
originatedFrom?: string | null;
|
|
485
|
+
/**
|
|
486
|
+
* 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.
|
|
487
|
+
* 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.
|
|
488
|
+
*/
|
|
489
|
+
entityEventSequence?: string | null;
|
|
490
|
+
}
|
|
491
|
+
/** @oneof */
|
|
492
|
+
interface DomainEventBodyOneOf {
|
|
493
|
+
createdEvent?: EntityCreatedEvent;
|
|
494
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
495
|
+
deletedEvent?: EntityDeletedEvent;
|
|
496
|
+
actionEvent?: ActionEvent;
|
|
497
|
+
}
|
|
498
|
+
interface EntityCreatedEvent {
|
|
499
|
+
entityAsJson?: string;
|
|
500
|
+
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
501
|
+
restoreInfo?: RestoreInfo;
|
|
502
|
+
}
|
|
503
|
+
interface RestoreInfo {
|
|
504
|
+
deletedDate?: Date | null;
|
|
505
|
+
}
|
|
506
|
+
interface EntityUpdatedEvent {
|
|
507
|
+
/**
|
|
508
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
509
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
510
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
511
|
+
*/
|
|
512
|
+
currentEntityAsJson?: string;
|
|
513
|
+
}
|
|
514
|
+
interface EntityDeletedEvent {
|
|
515
|
+
/** Entity that was deleted. */
|
|
516
|
+
deletedEntityAsJson?: string | null;
|
|
517
|
+
}
|
|
518
|
+
interface ActionEvent {
|
|
519
|
+
bodyAsJson?: string;
|
|
520
|
+
}
|
|
521
|
+
interface MessageEnvelope {
|
|
522
|
+
/**
|
|
523
|
+
* App instance ID.
|
|
524
|
+
* @format GUID
|
|
525
|
+
*/
|
|
526
|
+
instanceId?: string | null;
|
|
527
|
+
/**
|
|
528
|
+
* Event type.
|
|
529
|
+
* @maxLength 150
|
|
530
|
+
*/
|
|
531
|
+
eventType?: string;
|
|
532
|
+
/** The identification type and identity data. */
|
|
533
|
+
identity?: IdentificationData;
|
|
534
|
+
/** Stringify payload. */
|
|
535
|
+
data?: string;
|
|
536
|
+
/** Details related to the account */
|
|
537
|
+
accountInfo?: AccountInfo;
|
|
538
|
+
}
|
|
539
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
540
|
+
/**
|
|
541
|
+
* ID of a site visitor that has not logged in to the site.
|
|
542
|
+
* @format GUID
|
|
543
|
+
*/
|
|
544
|
+
anonymousVisitorId?: string;
|
|
545
|
+
/**
|
|
546
|
+
* ID of a site visitor that has logged in to the site.
|
|
547
|
+
* @format GUID
|
|
548
|
+
*/
|
|
549
|
+
memberId?: string;
|
|
550
|
+
/**
|
|
551
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
552
|
+
* @format GUID
|
|
553
|
+
*/
|
|
554
|
+
wixUserId?: string;
|
|
555
|
+
/**
|
|
556
|
+
* ID of an app.
|
|
557
|
+
* @format GUID
|
|
558
|
+
*/
|
|
559
|
+
appId?: string;
|
|
560
|
+
/** @readonly */
|
|
561
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
562
|
+
}
|
|
563
|
+
/** @oneof */
|
|
564
|
+
interface IdentificationDataIdOneOf {
|
|
565
|
+
/**
|
|
566
|
+
* ID of a site visitor that has not logged in to the site.
|
|
567
|
+
* @format GUID
|
|
568
|
+
*/
|
|
569
|
+
anonymousVisitorId?: string;
|
|
570
|
+
/**
|
|
571
|
+
* ID of a site visitor that has logged in to the site.
|
|
572
|
+
* @format GUID
|
|
573
|
+
*/
|
|
574
|
+
memberId?: string;
|
|
575
|
+
/**
|
|
576
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
577
|
+
* @format GUID
|
|
578
|
+
*/
|
|
579
|
+
wixUserId?: string;
|
|
580
|
+
/**
|
|
581
|
+
* ID of an app.
|
|
582
|
+
* @format GUID
|
|
583
|
+
*/
|
|
584
|
+
appId?: string;
|
|
585
|
+
}
|
|
586
|
+
declare enum WebhookIdentityType {
|
|
587
|
+
UNKNOWN = "UNKNOWN",
|
|
588
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
589
|
+
MEMBER = "MEMBER",
|
|
590
|
+
WIX_USER = "WIX_USER",
|
|
591
|
+
APP = "APP"
|
|
592
|
+
}
|
|
593
|
+
/** @enumType */
|
|
594
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
595
|
+
interface AccountInfo {
|
|
596
|
+
/**
|
|
597
|
+
* ID of the Wix account associated with the event.
|
|
598
|
+
* @format GUID
|
|
599
|
+
*/
|
|
600
|
+
accountId?: string | null;
|
|
601
|
+
/**
|
|
602
|
+
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
603
|
+
* @format GUID
|
|
604
|
+
*/
|
|
605
|
+
parentAccountId?: string | null;
|
|
606
|
+
/**
|
|
607
|
+
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
608
|
+
* @format GUID
|
|
609
|
+
*/
|
|
610
|
+
siteId?: string | null;
|
|
611
|
+
}
|
|
269
612
|
interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
270
613
|
/**
|
|
271
614
|
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
@@ -507,98 +850,16 @@ interface ListMenusRequest {
|
|
|
507
850
|
/** Whether to return only menus that are visible to site visitors. */
|
|
508
851
|
onlyVisible?: boolean | null;
|
|
509
852
|
}
|
|
510
|
-
interface CursorPaging {
|
|
511
|
-
/**
|
|
512
|
-
* Number of items to load.
|
|
513
|
-
* @max 500
|
|
514
|
-
*/
|
|
515
|
-
limit?: number | null;
|
|
516
|
-
/**
|
|
517
|
-
* Pointer to the next or previous page in the list of results.
|
|
518
|
-
*
|
|
519
|
-
* You can get the relevant cursor token
|
|
520
|
-
* from the `pagingMetadata` object in the previous call's response.
|
|
521
|
-
* Not relevant for the first request.
|
|
522
|
-
*/
|
|
523
|
-
cursor?: string | null;
|
|
524
|
-
}
|
|
525
853
|
interface ListMenusResponse {
|
|
526
854
|
/** Retrieved menus. */
|
|
527
855
|
menus?: Menu[];
|
|
528
856
|
/** The metadata of the paginated results. */
|
|
529
857
|
pagingMetadata?: CursorPagingMetadata;
|
|
530
858
|
}
|
|
531
|
-
interface CursorPagingMetadata {
|
|
532
|
-
/** Number of items returned in the response. */
|
|
533
|
-
count?: number | null;
|
|
534
|
-
/** Offset that was requested. */
|
|
535
|
-
cursors?: Cursors;
|
|
536
|
-
/**
|
|
537
|
-
* Indicates if there are more results after the current page.
|
|
538
|
-
* If `true`, another page of results can be retrieved.
|
|
539
|
-
* If `false`, this is the last page.
|
|
540
|
-
*/
|
|
541
|
-
hasNext?: boolean | null;
|
|
542
|
-
}
|
|
543
|
-
interface Cursors {
|
|
544
|
-
/** Cursor pointing to next page in the list of results. */
|
|
545
|
-
next?: string | null;
|
|
546
|
-
/** Cursor pointing to previous page in the list of results. */
|
|
547
|
-
prev?: string | null;
|
|
548
|
-
}
|
|
549
859
|
interface QueryMenusRequest {
|
|
550
860
|
/** Query options. */
|
|
551
861
|
query?: CursorQuery;
|
|
552
862
|
}
|
|
553
|
-
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
554
|
-
/** 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`. */
|
|
555
|
-
cursorPaging?: CursorPaging;
|
|
556
|
-
/**
|
|
557
|
-
* Filter object in the following format:
|
|
558
|
-
* `"filter" : {
|
|
559
|
-
* "fieldName1": "value1",
|
|
560
|
-
* "fieldName2":{"$operator":"value2"}
|
|
561
|
-
* }`
|
|
562
|
-
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
|
|
563
|
-
*/
|
|
564
|
-
filter?: Record<string, any> | null;
|
|
565
|
-
/**
|
|
566
|
-
* Sort object in the following format:
|
|
567
|
-
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
568
|
-
*/
|
|
569
|
-
sort?: Sorting[];
|
|
570
|
-
}
|
|
571
|
-
/** @oneof */
|
|
572
|
-
interface CursorQueryPagingMethodOneOf {
|
|
573
|
-
/** 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`. */
|
|
574
|
-
cursorPaging?: CursorPaging;
|
|
575
|
-
}
|
|
576
|
-
interface Sorting {
|
|
577
|
-
/**
|
|
578
|
-
* Name of the field to sort by.
|
|
579
|
-
* @maxLength 512
|
|
580
|
-
*/
|
|
581
|
-
fieldName?: string;
|
|
582
|
-
/** Sort order. */
|
|
583
|
-
order?: SortOrderWithLiterals;
|
|
584
|
-
/**
|
|
585
|
-
* Origin point for geo-distance sorting on a GEO field
|
|
586
|
-
* results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
|
|
587
|
-
*/
|
|
588
|
-
origin?: AddressLocation;
|
|
589
|
-
}
|
|
590
|
-
declare enum SortOrder {
|
|
591
|
-
ASC = "ASC",
|
|
592
|
-
DESC = "DESC"
|
|
593
|
-
}
|
|
594
|
-
/** @enumType */
|
|
595
|
-
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
596
|
-
interface AddressLocation {
|
|
597
|
-
/** Address latitude. */
|
|
598
|
-
latitude?: number | null;
|
|
599
|
-
/** Address longitude. */
|
|
600
|
-
longitude?: number | null;
|
|
601
|
-
}
|
|
602
863
|
interface QueryMenusResponse {
|
|
603
864
|
/** Retrieved menus. */
|
|
604
865
|
menus?: Menu[];
|
|
@@ -696,70 +957,6 @@ interface CloneMenusRequest {
|
|
|
696
957
|
}
|
|
697
958
|
interface CloneMenusResponse {
|
|
698
959
|
}
|
|
699
|
-
interface DomainEvent extends DomainEventBodyOneOf {
|
|
700
|
-
createdEvent?: EntityCreatedEvent;
|
|
701
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
702
|
-
deletedEvent?: EntityDeletedEvent;
|
|
703
|
-
actionEvent?: ActionEvent;
|
|
704
|
-
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
705
|
-
id?: string;
|
|
706
|
-
/**
|
|
707
|
-
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
708
|
-
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
709
|
-
*/
|
|
710
|
-
entityFqdn?: string;
|
|
711
|
-
/**
|
|
712
|
-
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
713
|
-
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
714
|
-
*/
|
|
715
|
-
slug?: string;
|
|
716
|
-
/** ID of the entity associated with the event. */
|
|
717
|
-
entityId?: string;
|
|
718
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
719
|
-
eventTime?: Date | null;
|
|
720
|
-
/**
|
|
721
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
722
|
-
* (for example, GDPR).
|
|
723
|
-
*/
|
|
724
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
725
|
-
/** If present, indicates the action that triggered the event. */
|
|
726
|
-
originatedFrom?: string | null;
|
|
727
|
-
/**
|
|
728
|
-
* 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.
|
|
729
|
-
* 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.
|
|
730
|
-
*/
|
|
731
|
-
entityEventSequence?: string | null;
|
|
732
|
-
}
|
|
733
|
-
/** @oneof */
|
|
734
|
-
interface DomainEventBodyOneOf {
|
|
735
|
-
createdEvent?: EntityCreatedEvent;
|
|
736
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
737
|
-
deletedEvent?: EntityDeletedEvent;
|
|
738
|
-
actionEvent?: ActionEvent;
|
|
739
|
-
}
|
|
740
|
-
interface EntityCreatedEvent {
|
|
741
|
-
entityAsJson?: string;
|
|
742
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
743
|
-
restoreInfo?: RestoreInfo;
|
|
744
|
-
}
|
|
745
|
-
interface RestoreInfo {
|
|
746
|
-
deletedDate?: Date | null;
|
|
747
|
-
}
|
|
748
|
-
interface EntityUpdatedEvent {
|
|
749
|
-
/**
|
|
750
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
751
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
752
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
753
|
-
*/
|
|
754
|
-
currentEntityAsJson?: string;
|
|
755
|
-
}
|
|
756
|
-
interface EntityDeletedEvent {
|
|
757
|
-
/** Entity that was deleted. */
|
|
758
|
-
deletedEntityAsJson?: string | null;
|
|
759
|
-
}
|
|
760
|
-
interface ActionEvent {
|
|
761
|
-
bodyAsJson?: string;
|
|
762
|
-
}
|
|
763
960
|
interface Empty {
|
|
764
961
|
}
|
|
765
962
|
interface SyncContentToMultilingualRequest {
|
|
@@ -771,97 +968,6 @@ interface SyncContentToMultilingualRequest {
|
|
|
771
968
|
}
|
|
772
969
|
interface SyncContentToMultilingualResponse {
|
|
773
970
|
}
|
|
774
|
-
interface MessageEnvelope {
|
|
775
|
-
/**
|
|
776
|
-
* App instance ID.
|
|
777
|
-
* @format GUID
|
|
778
|
-
*/
|
|
779
|
-
instanceId?: string | null;
|
|
780
|
-
/**
|
|
781
|
-
* Event type.
|
|
782
|
-
* @maxLength 150
|
|
783
|
-
*/
|
|
784
|
-
eventType?: string;
|
|
785
|
-
/** The identification type and identity data. */
|
|
786
|
-
identity?: IdentificationData;
|
|
787
|
-
/** Stringify payload. */
|
|
788
|
-
data?: string;
|
|
789
|
-
/** Details related to the account */
|
|
790
|
-
accountInfo?: AccountInfo;
|
|
791
|
-
}
|
|
792
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
793
|
-
/**
|
|
794
|
-
* ID of a site visitor that has not logged in to the site.
|
|
795
|
-
* @format GUID
|
|
796
|
-
*/
|
|
797
|
-
anonymousVisitorId?: string;
|
|
798
|
-
/**
|
|
799
|
-
* ID of a site visitor that has logged in to the site.
|
|
800
|
-
* @format GUID
|
|
801
|
-
*/
|
|
802
|
-
memberId?: string;
|
|
803
|
-
/**
|
|
804
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
805
|
-
* @format GUID
|
|
806
|
-
*/
|
|
807
|
-
wixUserId?: string;
|
|
808
|
-
/**
|
|
809
|
-
* ID of an app.
|
|
810
|
-
* @format GUID
|
|
811
|
-
*/
|
|
812
|
-
appId?: string;
|
|
813
|
-
/** @readonly */
|
|
814
|
-
identityType?: WebhookIdentityTypeWithLiterals;
|
|
815
|
-
}
|
|
816
|
-
/** @oneof */
|
|
817
|
-
interface IdentificationDataIdOneOf {
|
|
818
|
-
/**
|
|
819
|
-
* ID of a site visitor that has not logged in to the site.
|
|
820
|
-
* @format GUID
|
|
821
|
-
*/
|
|
822
|
-
anonymousVisitorId?: string;
|
|
823
|
-
/**
|
|
824
|
-
* ID of a site visitor that has logged in to the site.
|
|
825
|
-
* @format GUID
|
|
826
|
-
*/
|
|
827
|
-
memberId?: string;
|
|
828
|
-
/**
|
|
829
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
830
|
-
* @format GUID
|
|
831
|
-
*/
|
|
832
|
-
wixUserId?: string;
|
|
833
|
-
/**
|
|
834
|
-
* ID of an app.
|
|
835
|
-
* @format GUID
|
|
836
|
-
*/
|
|
837
|
-
appId?: string;
|
|
838
|
-
}
|
|
839
|
-
declare enum WebhookIdentityType {
|
|
840
|
-
UNKNOWN = "UNKNOWN",
|
|
841
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
842
|
-
MEMBER = "MEMBER",
|
|
843
|
-
WIX_USER = "WIX_USER",
|
|
844
|
-
APP = "APP"
|
|
845
|
-
}
|
|
846
|
-
/** @enumType */
|
|
847
|
-
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
848
|
-
interface AccountInfo {
|
|
849
|
-
/**
|
|
850
|
-
* ID of the Wix account associated with the event.
|
|
851
|
-
* @format GUID
|
|
852
|
-
*/
|
|
853
|
-
accountId?: string | null;
|
|
854
|
-
/**
|
|
855
|
-
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
856
|
-
* @format GUID
|
|
857
|
-
*/
|
|
858
|
-
parentAccountId?: string | null;
|
|
859
|
-
/**
|
|
860
|
-
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
861
|
-
* @format GUID
|
|
862
|
-
*/
|
|
863
|
-
siteId?: string | null;
|
|
864
|
-
}
|
|
865
971
|
interface DuplicateMenuRequest {
|
|
866
972
|
/**
|
|
867
973
|
* Menu id to be duplicated.
|
|
@@ -952,4 +1058,4 @@ declare function getMenuSiteUrl(): __PublicMethodMetaInfo<'GET', {
|
|
|
952
1058
|
}, GetMenuSiteUrlRequest$1, GetMenuSiteUrlRequest, GetMenuSiteUrlResponse$1, GetMenuSiteUrlResponse>;
|
|
953
1059
|
declare function queryMenusSiteUrl(): __PublicMethodMetaInfo<'POST', {}, QueryMenusSiteUrlRequest$1, QueryMenusSiteUrlRequest, QueryMenusSiteUrlResponse$1, QueryMenusSiteUrlResponse>;
|
|
954
1060
|
|
|
955
|
-
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 };
|
|
1061
|
+
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 MenuExportRow as MenuExportRowOriginal, 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 QueryMenuExportRowsRequest as QueryMenuExportRowsRequestOriginal, type QueryMenuExportRowsResponse as QueryMenuExportRowsResponseOriginal, 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 };
|