@wix/auto_sdk_events_wix-events-v-2 1.0.29 → 1.0.31

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.
Files changed (29) hide show
  1. package/build/cjs/src/events-v3-event-wix-events-v-2.http.js +12 -0
  2. package/build/cjs/src/events-v3-event-wix-events-v-2.http.js.map +1 -1
  3. package/build/cjs/src/events-v3-event-wix-events-v-2.types.d.ts +210 -94
  4. package/build/cjs/src/events-v3-event-wix-events-v-2.types.js.map +1 -1
  5. package/build/cjs/src/events-v3-event-wix-events-v-2.universal.d.ts +234 -126
  6. package/build/cjs/src/events-v3-event-wix-events-v-2.universal.js +22 -48
  7. package/build/cjs/src/events-v3-event-wix-events-v-2.universal.js.map +1 -1
  8. package/build/es/src/events-v3-event-wix-events-v-2.http.js +12 -0
  9. package/build/es/src/events-v3-event-wix-events-v-2.http.js.map +1 -1
  10. package/build/es/src/events-v3-event-wix-events-v-2.types.d.ts +210 -94
  11. package/build/es/src/events-v3-event-wix-events-v-2.types.js.map +1 -1
  12. package/build/es/src/events-v3-event-wix-events-v-2.universal.d.ts +234 -126
  13. package/build/es/src/events-v3-event-wix-events-v-2.universal.js +22 -48
  14. package/build/es/src/events-v3-event-wix-events-v-2.universal.js.map +1 -1
  15. package/build/internal/cjs/src/events-v3-event-wix-events-v-2.http.js +12 -0
  16. package/build/internal/cjs/src/events-v3-event-wix-events-v-2.http.js.map +1 -1
  17. package/build/internal/cjs/src/events-v3-event-wix-events-v-2.types.d.ts +210 -94
  18. package/build/internal/cjs/src/events-v3-event-wix-events-v-2.types.js.map +1 -1
  19. package/build/internal/cjs/src/events-v3-event-wix-events-v-2.universal.d.ts +234 -126
  20. package/build/internal/cjs/src/events-v3-event-wix-events-v-2.universal.js +22 -48
  21. package/build/internal/cjs/src/events-v3-event-wix-events-v-2.universal.js.map +1 -1
  22. package/build/internal/es/src/events-v3-event-wix-events-v-2.http.js +12 -0
  23. package/build/internal/es/src/events-v3-event-wix-events-v-2.http.js.map +1 -1
  24. package/build/internal/es/src/events-v3-event-wix-events-v-2.types.d.ts +210 -94
  25. package/build/internal/es/src/events-v3-event-wix-events-v-2.types.js.map +1 -1
  26. package/build/internal/es/src/events-v3-event-wix-events-v-2.universal.d.ts +234 -126
  27. package/build/internal/es/src/events-v3-event-wix-events-v-2.universal.js +22 -48
  28. package/build/internal/es/src/events-v3-event-wix-events-v-2.universal.js.map +1 -1
  29. package/package.json +3 -3
@@ -61,7 +61,7 @@ export interface V3Event {
61
61
  * - `DRAFT`: Event is not published.
62
62
  * @readonly
63
63
  */
64
- status?: Status;
64
+ status?: StatusWithLiterals;
65
65
  /**
66
66
  * RSVP or ticketing registration details. <br>
67
67
  * **Note:** This field is returned only when the `REGISTRATION` fieldset is included in the request.
@@ -147,7 +147,7 @@ export interface Location {
147
147
  * - `VENUE`: The event is on-site at a specific physical location.
148
148
  * - `ONLINE`: The event is online, such as a virtual video conference.
149
149
  */
150
- type?: LocationType;
150
+ type?: LocationTypeWithLiterals;
151
151
  /** Exact location address. */
152
152
  address?: CommonAddress;
153
153
  /** Whether the event location is TBD. */
@@ -161,6 +161,8 @@ export declare enum LocationType {
161
161
  /** Event is online, such as a virtual video conference. */
162
162
  ONLINE = "ONLINE"
163
163
  }
164
+ /** @enumType */
165
+ export type LocationTypeWithLiterals = LocationType | 'UNKNOWN_LOCATION' | 'VENUE' | 'ONLINE';
164
166
  /** Physical address */
165
167
  export interface CommonAddress extends CommonAddressStreetOneOf {
166
168
  /** Street address. */
@@ -259,6 +261,8 @@ export declare enum SubdivisionSubdivisionType {
259
261
  /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
260
262
  COUNTRY = "COUNTRY"
261
263
  }
264
+ /** @enumType */
265
+ export type SubdivisionSubdivisionTypeWithLiterals = SubdivisionSubdivisionType | 'UNKNOWN_SUBDIVISION_TYPE' | 'ADMINISTRATIVE_AREA_LEVEL_1' | 'ADMINISTRATIVE_AREA_LEVEL_2' | 'ADMINISTRATIVE_AREA_LEVEL_3' | 'ADMINISTRATIVE_AREA_LEVEL_4' | 'ADMINISTRATIVE_AREA_LEVEL_5' | 'COUNTRY';
262
266
  export interface DateAndTimeSettings {
263
267
  /** Whether the event date and time are TBD. */
264
268
  dateAndTimeTbd?: boolean | null;
@@ -300,7 +304,7 @@ export interface DateAndTimeSettings {
300
304
  * - `RECURRING_RECENTLY_CANCELED`: Latest canceled event tin a schedule of recurring events.
301
305
  * @readonly
302
306
  */
303
- recurrenceStatus?: RecurrenceStatusStatus;
307
+ recurrenceStatus?: RecurrenceStatusStatusWithLiterals;
304
308
  /** Event repetitions. */
305
309
  recurringEvents?: Recurrences;
306
310
  /** Formatted date and time settings. */
@@ -320,6 +324,8 @@ export declare enum RecurrenceStatusStatus {
320
324
  /** Latest canceled event in a schedule of recurring events */
321
325
  RECURRING_RECENTLY_CANCELED = "RECURRING_RECENTLY_CANCELED"
322
326
  }
327
+ /** @enumType */
328
+ export type RecurrenceStatusStatusWithLiterals = RecurrenceStatusStatus | 'UNKNOWN_STATUS' | 'ONE_TIME' | 'RECURRING' | 'RECURRING_UPCOMING' | 'RECURRING_RECENTLY_ENDED' | 'RECURRING_RECENTLY_CANCELED';
323
329
  export interface Recurrences {
324
330
  /**
325
331
  * Individual event dates info.
@@ -413,6 +419,8 @@ export declare enum Status {
413
419
  /** Event is not public. */
414
420
  DRAFT = "DRAFT"
415
421
  }
422
+ /** @enumType */
423
+ export type StatusWithLiterals = Status | 'UNKNOWN_EVENT_STATUS' | 'UPCOMING' | 'STARTED' | 'ENDED' | 'CANCELED' | 'DRAFT';
416
424
  export interface Registration {
417
425
  /**
418
426
  * Current registration type:
@@ -425,7 +433,7 @@ export interface Registration {
425
433
  * The property value might change to `EXTERNAL` or `NONE` after initial event creation, depending on any additional configuration applied to the event.
426
434
  * @readonly
427
435
  */
428
- type?: RegistrationTypeType;
436
+ type?: RegistrationTypeTypeWithLiterals;
429
437
  /**
430
438
  * Registration status. Possible values:
431
439
  *
@@ -438,7 +446,7 @@ export interface Registration {
438
446
  * - `SCHEDULED_RSVP`: Registration via RSVP is scheduled for the future.
439
447
  * @readonly
440
448
  */
441
- status?: RegistrationStatusStatus;
449
+ status?: RegistrationStatusStatusWithLiterals;
442
450
  /** RSVP registration details. */
443
451
  rsvp?: RsvpRegistration;
444
452
  /** Ticket registration details. */
@@ -451,7 +459,7 @@ export interface Registration {
451
459
  * - `VISITOR_OR_MEMBER`: All site visitors can RSVP to the event.
452
460
  * - `MEMBER`: Only people who have signed up as members of your site are able to RSVP to the event.
453
461
  */
454
- allowedGuestTypes?: GuestTypeType;
462
+ allowedGuestTypes?: GuestTypeTypeWithLiterals;
455
463
  /**
456
464
  * Initial event type which is set when creating an event. Possible values:
457
465
  *
@@ -461,7 +469,7 @@ export interface Registration {
461
469
  * This property value never changes.
462
470
  * @immutable
463
471
  */
464
- initialType?: InitialRegistrationTypeType;
472
+ initialType?: InitialRegistrationTypeTypeWithLiterals;
465
473
  /** Whether the registration is paused. */
466
474
  registrationPaused?: boolean;
467
475
  /** Whether the registration is disabled. */
@@ -479,6 +487,8 @@ export declare enum RegistrationTypeType {
479
487
  /** No registration is required, all guests can attend. This registration type is for only displaying the event details on a site. The property value can be changed from RSVP/TICKETING to EXTERNAL or NONE after the event is created, depending on any additional configurations applied to the event. */
480
488
  NONE = "NONE"
481
489
  }
490
+ /** @enumType */
491
+ export type RegistrationTypeTypeWithLiterals = RegistrationTypeType | 'UNKNOWN_REGISTRATION_TYPE' | 'RSVP' | 'TICKETING' | 'EXTERNAL' | 'NONE';
482
492
  export declare enum RegistrationStatusStatus {
483
493
  /** Registration status is not applicable */
484
494
  UNKNOWN_REGISTRATION_STATUS = "UNKNOWN_REGISTRATION_STATUS",
@@ -497,9 +507,11 @@ export declare enum RegistrationStatusStatus {
497
507
  /** Registration via RSVP is scheduled for the future. */
498
508
  SCHEDULED_RSVP = "SCHEDULED_RSVP"
499
509
  }
510
+ /** @enumType */
511
+ export type RegistrationStatusStatusWithLiterals = RegistrationStatusStatus | 'UNKNOWN_REGISTRATION_STATUS' | 'CLOSED_AUTOMATICALLY' | 'CLOSED_MANUALLY' | 'OPEN_RSVP' | 'OPEN_RSVP_WAITLIST_ONLY' | 'OPEN_TICKETS' | 'OPEN_EXTERNAL' | 'SCHEDULED_RSVP';
500
512
  export interface RsvpRegistration {
501
513
  /** Available answers for registration to an event. */
502
- responseType?: ResponseType;
514
+ responseType?: ResponseTypeWithLiterals;
503
515
  /** How many guests can RSVP to an event. */
504
516
  limit?: number | null;
505
517
  /** Whether a waitlist is opened when the total guest limit is reached. If `true`, guests can RSVP to an event and are automatically put in the waitlist with the `IN_WAITLIST` status. */
@@ -517,6 +529,8 @@ export declare enum ResponseType {
517
529
  /** *Yes** and **No** answers are available to select when RSVP'ing to an event. */
518
530
  YES_AND_NO = "YES_AND_NO"
519
531
  }
532
+ /** @enumType */
533
+ export type ResponseTypeWithLiterals = ResponseType | 'UNKNOWN_RESPONSE_TYPE' | 'YES_ONLY' | 'YES_AND_NO';
520
534
  export interface TicketsRegistration {
521
535
  /** Whether the registration form must be filled out separately for each ticket. */
522
536
  guestsAssignedSeparately?: boolean;
@@ -580,7 +594,7 @@ export interface TaxSettings {
580
594
  * - `INCLUDED_IN_PRICE`: Deduct the fee from the ticket price for a seller. For example, if you're selling tickets for $10, a ticket service fee of $0.25 is deducted from the price and you'll get $9.75.
581
595
  * - `ADDED_AT_CHECKOUT`: Show the fee iin addition to the ticket price at checkout and a guest pays the fee. For example, if you sell tickets for $10, a customer sees a ticket service fee of $0.25 and pays $10.25 in total.
582
596
  */
583
- type?: TaxType;
597
+ type?: TaxTypeWithLiterals;
584
598
  /**
585
599
  * Tax name.
586
600
  * @minLength 1
@@ -604,6 +618,8 @@ export declare enum TaxType {
604
618
  /** Show the fee in addition to the ticket price at checkout and a guest pays the fee. For example, if you sell tickets for $10, a customer sees a ticket ticket service fee of $0.25 and pays $10.25 in total. */
605
619
  ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
606
620
  }
621
+ /** @enumType */
622
+ export type TaxTypeWithLiterals = TaxType | 'UNKNOWN_TAX_TYPE' | 'INCLUDED_IN_PRICE' | 'ADDED_AT_CHECKOUT';
607
623
  export interface ExternalRegistration {
608
624
  /**
609
625
  * External event registration URL.
@@ -619,6 +635,8 @@ export declare enum GuestTypeType {
619
635
  /** Only people who have signed up as members of your site are able to RSVP to the event. */
620
636
  MEMBER = "MEMBER"
621
637
  }
638
+ /** @enumType */
639
+ export type GuestTypeTypeWithLiterals = GuestTypeType | 'UNKNOWN_GUEST_TYPE' | 'VISITOR_OR_MEMBER' | 'MEMBER';
622
640
  export declare enum InitialRegistrationTypeType {
623
641
  /** Unknown initial registration type. */
624
642
  UNKNOWN_INITIAL_REGISTRATION_TYPE = "UNKNOWN_INITIAL_REGISTRATION_TYPE",
@@ -627,6 +645,8 @@ export declare enum InitialRegistrationTypeType {
627
645
  /** Guests register by buying tickets. This property value never changes. */
628
646
  TICKETING = "TICKETING"
629
647
  }
648
+ /** @enumType */
649
+ export type InitialRegistrationTypeTypeWithLiterals = InitialRegistrationTypeType | 'UNKNOWN_INITIAL_REGISTRATION_TYPE' | 'RSVP' | 'TICKETING';
630
650
  export interface CalendarUrls {
631
651
  /**
632
652
  * "Add to Google calendar" URL.
@@ -667,7 +687,7 @@ export interface Form {
667
687
  */
668
688
  export interface InputControl {
669
689
  /** Field control type. */
670
- type?: InputControlType;
690
+ type?: InputControlTypeWithLiterals;
671
691
  /** Whether the control is mandatory (such as `name` & `email`). When `true`, only the label can be changed. */
672
692
  system?: boolean;
673
693
  /**
@@ -714,6 +734,8 @@ export declare enum InputControlType {
714
734
  /** Fields for entering year, month, and day. */
715
735
  DATE = "DATE"
716
736
  }
737
+ /** @enumType */
738
+ export type InputControlTypeWithLiterals = InputControlType | 'INPUT' | 'TEXTAREA' | 'DROPDOWN' | 'RADIO' | 'CHECKBOX' | 'NAME' | 'GUEST_CONTROL' | 'ADDRESS_SHORT' | 'ADDRESS_FULL' | 'DATE';
717
739
  /** Child inputs. */
718
740
  export interface Input {
719
741
  /** Field name. */
@@ -737,7 +759,7 @@ export interface Input {
737
759
  * Type which determines field format.
738
760
  * Used to validate submitted response.
739
761
  */
740
- type?: ValueType;
762
+ type?: ValueTypeWithLiterals;
741
763
  /**
742
764
  * The maximum number of accepted values for array input.
743
765
  *
@@ -764,6 +786,8 @@ export declare enum ValueType {
764
786
  DATE_TIME = "DATE_TIME",
765
787
  ADDRESS = "ADDRESS"
766
788
  }
789
+ /** @enumType */
790
+ export type ValueTypeWithLiterals = ValueType | 'TEXT' | 'NUMBER' | 'TEXT_ARRAY' | 'DATE_TIME' | 'ADDRESS';
767
791
  /**
768
792
  * Describes initially selected option when an input has multiple choices.
769
793
  * Defaults to first (0th) option if not configured.
@@ -989,7 +1013,7 @@ export interface OnlineConferencing {
989
1013
  * - `MEETING`: Guests can do some actions during the conference, for example talk, turn on camera and show their screen.
990
1014
  * - `WEBINAR`: Guests can only watch the conference.
991
1015
  */
992
- type?: ConferenceTypeType;
1016
+ type?: ConferenceTypeTypeWithLiterals;
993
1017
  /** Online conferencing session information. */
994
1018
  session?: OnlineConferencingSession;
995
1019
  }
@@ -1001,6 +1025,8 @@ export declare enum ConferenceTypeType {
1001
1025
  /** Guests can only watch the conference. */
1002
1026
  WEBINAR = "WEBINAR"
1003
1027
  }
1028
+ /** @enumType */
1029
+ export type ConferenceTypeTypeWithLiterals = ConferenceTypeType | 'UNKNOWN_CONFERENCE_TYPE' | 'MEETING' | 'WEBINAR';
1004
1030
  export interface OnlineConferencingSession {
1005
1031
  /**
1006
1032
  * Link for the event host to start the online conference session.
@@ -1143,7 +1169,7 @@ export interface EventCategory {
1143
1169
  * Category type.
1144
1170
  * @readonly
1145
1171
  */
1146
- type?: CategoryTypeType;
1172
+ type?: CategoryTypeTypeWithLiterals;
1147
1173
  }
1148
1174
  export declare enum CategoryTypeType {
1149
1175
  /** Created manually by the user. */
@@ -1151,6 +1177,8 @@ export declare enum CategoryTypeType {
1151
1177
  /** Created automatically when publishing recurring events. */
1152
1178
  RECURRING_EVENT = "RECURRING_EVENT"
1153
1179
  }
1180
+ /** @enumType */
1181
+ export type CategoryTypeTypeWithLiterals = CategoryTypeType | 'MANUAL' | 'RECURRING_EVENT';
1154
1182
  export interface V3EventDisplaySettings {
1155
1183
  /** Whether event details button is hidden. Only available for events with no registration. */
1156
1184
  hideEventDetailsButton?: boolean | null;
@@ -1223,9 +1251,9 @@ export interface Node extends NodeDataOneOf {
1223
1251
  /** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
1224
1252
  layoutCellData?: LayoutCellData;
1225
1253
  /** Node type. Use `APP_EMBED` for nodes that embed content from other Wix apps. Use `EMBED` to embed content in [oEmbed](https://oembed.com/) format. */
1226
- type?: NodeType;
1254
+ type?: NodeTypeWithLiterals;
1227
1255
  /** Node ID. */
1228
- _id?: string;
1256
+ id?: string;
1229
1257
  /** A list of child nodes. */
1230
1258
  nodes?: Node[];
1231
1259
  /** Padding and background color styling for the node. */
@@ -1324,6 +1352,8 @@ export declare enum NodeType {
1324
1352
  LAYOUT = "LAYOUT",
1325
1353
  LAYOUT_CELL = "LAYOUT_CELL"
1326
1354
  }
1355
+ /** @enumType */
1356
+ export type NodeTypeWithLiterals = NodeType | 'PARAGRAPH' | 'TEXT' | 'HEADING' | 'BULLETED_LIST' | 'ORDERED_LIST' | 'LIST_ITEM' | 'BLOCKQUOTE' | 'CODE_BLOCK' | 'VIDEO' | 'DIVIDER' | 'FILE' | 'GALLERY' | 'GIF' | 'HTML' | 'IMAGE' | 'LINK_PREVIEW' | 'MAP' | 'POLL' | 'APP_EMBED' | 'BUTTON' | 'COLLAPSIBLE_LIST' | 'TABLE' | 'EMBED' | 'COLLAPSIBLE_ITEM' | 'COLLAPSIBLE_ITEM_TITLE' | 'COLLAPSIBLE_ITEM_BODY' | 'TABLE_CELL' | 'TABLE_ROW' | 'EXTERNAL' | 'AUDIO' | 'CAPTION' | 'LAYOUT' | 'LAYOUT_CELL';
1327
1357
  export interface NodeStyle {
1328
1358
  /** The top padding value in pixels. */
1329
1359
  paddingTop?: string | null;
@@ -1336,7 +1366,7 @@ export interface ButtonData {
1336
1366
  /** Styling for the button's container. */
1337
1367
  containerData?: PluginContainerData;
1338
1368
  /** The button type. */
1339
- type?: ButtonDataType;
1369
+ type?: ButtonDataTypeWithLiterals;
1340
1370
  /** Styling for the button. */
1341
1371
  styles?: Styles;
1342
1372
  /** The text to display on the button. */
@@ -1377,7 +1407,7 @@ export interface PluginContainerData {
1377
1407
  /** The width of the node when it's displayed. */
1378
1408
  width?: PluginContainerDataWidth;
1379
1409
  /** The node's alignment within its container. */
1380
- alignment?: PluginContainerDataAlignment;
1410
+ alignment?: PluginContainerDataAlignmentWithLiterals;
1381
1411
  /** Spoiler cover settings for the node. */
1382
1412
  spoiler?: Spoiler;
1383
1413
  /** The height of the node when it's displayed. */
@@ -1395,6 +1425,8 @@ export declare enum WidthType {
1395
1425
  /** coast-to-coast display */
1396
1426
  FULL_WIDTH = "FULL_WIDTH"
1397
1427
  }
1428
+ /** @enumType */
1429
+ export type WidthTypeWithLiterals = WidthType | 'CONTENT' | 'SMALL' | 'ORIGINAL' | 'FULL_WIDTH';
1398
1430
  export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
1399
1431
  /**
1400
1432
  * One of the following predefined width options:
@@ -1403,7 +1435,7 @@ export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOn
1403
1435
  * `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
1404
1436
  * `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
1405
1437
  */
1406
- size?: WidthType;
1438
+ size?: WidthTypeWithLiterals;
1407
1439
  /** A custom width value in pixels. */
1408
1440
  custom?: string | null;
1409
1441
  }
@@ -1416,7 +1448,7 @@ export interface PluginContainerDataWidthDataOneOf {
1416
1448
  * `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
1417
1449
  * `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
1418
1450
  */
1419
- size?: WidthType;
1451
+ size?: WidthTypeWithLiterals;
1420
1452
  /** A custom width value in pixels. */
1421
1453
  custom?: string | null;
1422
1454
  }
@@ -1428,6 +1460,8 @@ export declare enum PluginContainerDataAlignment {
1428
1460
  /** Right Alignment */
1429
1461
  RIGHT = "RIGHT"
1430
1462
  }
1463
+ /** @enumType */
1464
+ export type PluginContainerDataAlignmentWithLiterals = PluginContainerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
1431
1465
  export interface Spoiler {
1432
1466
  /** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
1433
1467
  enabled?: boolean | null;
@@ -1446,6 +1480,8 @@ export declare enum ButtonDataType {
1446
1480
  /** Triggers custom action that is defined in plugin configuration by the consumer */
1447
1481
  ACTION = "ACTION"
1448
1482
  }
1483
+ /** @enumType */
1484
+ export type ButtonDataTypeWithLiterals = ButtonDataType | 'LINK' | 'ACTION';
1449
1485
  export interface Styles {
1450
1486
  /**
1451
1487
  * Deprecated: Use `borderWidth` and `borderRadius` instead.
@@ -1511,7 +1547,7 @@ export interface Link extends LinkDataOneOf {
1511
1547
  * `PARENT` - Opens the linked document in the link's parent frame.
1512
1548
  * `TOP` - Opens the linked document in the full body of the link's browser tab or window.
1513
1549
  */
1514
- target?: Target;
1550
+ target?: TargetWithLiterals;
1515
1551
  /** The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document. */
1516
1552
  rel?: Rel;
1517
1553
  /** A serialized object used for a custom or external link panel. */
@@ -1534,6 +1570,8 @@ export declare enum Target {
1534
1570
  /** Opens the linked document in the full body of the window */
1535
1571
  TOP = "TOP"
1536
1572
  }
1573
+ /** @enumType */
1574
+ export type TargetWithLiterals = Target | 'SELF' | 'BLANK' | 'PARENT' | 'TOP';
1537
1575
  export interface Rel {
1538
1576
  /** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
1539
1577
  nofollow?: boolean | null;
@@ -1550,7 +1588,7 @@ export interface CodeBlockData {
1550
1588
  }
1551
1589
  export interface TextStyle {
1552
1590
  /** Text alignment. Defaults to `AUTO`. */
1553
- textAlignment?: TextAlignment;
1591
+ textAlignment?: TextAlignmentWithLiterals;
1554
1592
  /** A CSS `line-height` value for the text expressed as a ratio relative to the font size. For example, if the font size is 20px, a `lineHeight` value of `'1.5'`` results in a line height of 30px. */
1555
1593
  lineHeight?: string | null;
1556
1594
  }
@@ -1566,15 +1604,17 @@ export declare enum TextAlignment {
1566
1604
  /** Text is spaced to line up its left and right edges to the left and right edges of the line box, except for the last line */
1567
1605
  JUSTIFY = "JUSTIFY"
1568
1606
  }
1607
+ /** @enumType */
1608
+ export type TextAlignmentWithLiterals = TextAlignment | 'AUTO' | 'LEFT' | 'RIGHT' | 'CENTER' | 'JUSTIFY';
1569
1609
  export interface DividerData {
1570
1610
  /** Styling for the divider's container. */
1571
1611
  containerData?: PluginContainerData;
1572
1612
  /** Divider line style. */
1573
- lineStyle?: LineStyle;
1613
+ lineStyle?: LineStyleWithLiterals;
1574
1614
  /** Divider width. */
1575
- width?: Width;
1615
+ width?: WidthWithLiterals;
1576
1616
  /** Divider alignment. */
1577
- alignment?: Alignment;
1617
+ alignment?: AlignmentWithLiterals;
1578
1618
  }
1579
1619
  export declare enum LineStyle {
1580
1620
  /** Single Line */
@@ -1586,6 +1626,8 @@ export declare enum LineStyle {
1586
1626
  /** Dotted Line */
1587
1627
  DOTTED = "DOTTED"
1588
1628
  }
1629
+ /** @enumType */
1630
+ export type LineStyleWithLiterals = LineStyle | 'SINGLE' | 'DOUBLE' | 'DASHED' | 'DOTTED';
1589
1631
  export declare enum Width {
1590
1632
  /** Large line */
1591
1633
  LARGE = "LARGE",
@@ -1594,6 +1636,8 @@ export declare enum Width {
1594
1636
  /** Small line */
1595
1637
  SMALL = "SMALL"
1596
1638
  }
1639
+ /** @enumType */
1640
+ export type WidthWithLiterals = Width | 'LARGE' | 'MEDIUM' | 'SMALL';
1597
1641
  export declare enum Alignment {
1598
1642
  /** Center alignment */
1599
1643
  CENTER = "CENTER",
@@ -1602,6 +1646,8 @@ export declare enum Alignment {
1602
1646
  /** Right alignment */
1603
1647
  RIGHT = "RIGHT"
1604
1648
  }
1649
+ /** @enumType */
1650
+ export type AlignmentWithLiterals = Alignment | 'CENTER' | 'LEFT' | 'RIGHT';
1605
1651
  export interface FileData {
1606
1652
  /** Styling for the file's container. */
1607
1653
  containerData?: PluginContainerData;
@@ -1633,6 +1679,8 @@ export declare enum ViewMode {
1633
1679
  /** Mini PDF view */
1634
1680
  MINI = "MINI"
1635
1681
  }
1682
+ /** @enumType */
1683
+ export type ViewModeWithLiterals = ViewMode | 'NONE' | 'FULL' | 'MINI';
1636
1684
  export interface FileSource extends FileSourceDataOneOf {
1637
1685
  /** The absolute URL for the file's source. */
1638
1686
  url?: string | null;
@@ -1642,7 +1690,7 @@ export interface FileSource extends FileSourceDataOneOf {
1642
1690
  */
1643
1691
  custom?: string | null;
1644
1692
  /** An ID that's resolved to a URL by a resolver function. */
1645
- _id?: string | null;
1693
+ id?: string | null;
1646
1694
  /** Indicates whether the file's source is private. Defaults to `false`. */
1647
1695
  private?: boolean | null;
1648
1696
  }
@@ -1656,7 +1704,7 @@ export interface FileSourceDataOneOf {
1656
1704
  */
1657
1705
  custom?: string | null;
1658
1706
  /** An ID that's resolved to a URL by a resolver function. */
1659
- _id?: string | null;
1707
+ id?: string | null;
1660
1708
  }
1661
1709
  export interface PDFSettings {
1662
1710
  /**
@@ -1665,7 +1713,7 @@ export interface PDFSettings {
1665
1713
  * `FULL` : A full page view of the PDF is displayed.
1666
1714
  * `MINI` : A mini view of the PDF is displayed.
1667
1715
  */
1668
- viewMode?: ViewMode;
1716
+ viewMode?: ViewModeWithLiterals;
1669
1717
  /** Sets whether the PDF download button is disabled. Defaults to `false`. */
1670
1718
  disableDownload?: boolean | null;
1671
1719
  /** Sets whether the PDF print button is disabled. Defaults to `false`. */
@@ -1752,18 +1800,24 @@ export declare enum LayoutType {
1752
1800
  /** Fullsize images type */
1753
1801
  FULLSIZE = "FULLSIZE"
1754
1802
  }
1803
+ /** @enumType */
1804
+ export type LayoutTypeWithLiterals = LayoutType | 'COLLAGE' | 'MASONRY' | 'GRID' | 'THUMBNAIL' | 'SLIDER' | 'SLIDESHOW' | 'PANORAMA' | 'COLUMN' | 'MAGIC' | 'FULLSIZE';
1755
1805
  export declare enum Orientation {
1756
1806
  /** Rows Orientation */
1757
1807
  ROWS = "ROWS",
1758
1808
  /** Columns Orientation */
1759
1809
  COLUMNS = "COLUMNS"
1760
1810
  }
1811
+ /** @enumType */
1812
+ export type OrientationWithLiterals = Orientation | 'ROWS' | 'COLUMNS';
1761
1813
  export declare enum Crop {
1762
1814
  /** Crop to fill */
1763
1815
  FILL = "FILL",
1764
1816
  /** Crop to fit */
1765
1817
  FIT = "FIT"
1766
1818
  }
1819
+ /** @enumType */
1820
+ export type CropWithLiterals = Crop | 'FILL' | 'FIT';
1767
1821
  export declare enum ThumbnailsAlignment {
1768
1822
  /** Top alignment */
1769
1823
  TOP = "TOP",
@@ -1776,13 +1830,15 @@ export declare enum ThumbnailsAlignment {
1776
1830
  /** No thumbnail */
1777
1831
  NONE = "NONE"
1778
1832
  }
1833
+ /** @enumType */
1834
+ export type ThumbnailsAlignmentWithLiterals = ThumbnailsAlignment | 'TOP' | 'RIGHT' | 'BOTTOM' | 'LEFT' | 'NONE';
1779
1835
  export interface Layout {
1780
1836
  /** Gallery layout type. */
1781
- type?: LayoutType;
1837
+ type?: LayoutTypeWithLiterals;
1782
1838
  /** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
1783
1839
  horizontalScroll?: boolean | null;
1784
1840
  /** Gallery orientation. */
1785
- orientation?: Orientation;
1841
+ orientation?: OrientationWithLiterals;
1786
1842
  /** The number of columns to display on full size screens. */
1787
1843
  numberOfColumns?: number | null;
1788
1844
  /** The number of columns to display on mobile screens. */
@@ -1794,13 +1850,13 @@ export interface ItemStyle {
1794
1850
  /** Item ratio */
1795
1851
  ratio?: number | null;
1796
1852
  /** Sets how item images are cropped. */
1797
- crop?: Crop;
1853
+ crop?: CropWithLiterals;
1798
1854
  /** The spacing between items in pixels. */
1799
1855
  spacing?: number | null;
1800
1856
  }
1801
1857
  export interface Thumbnails {
1802
1858
  /** Thumbnail alignment. */
1803
- placement?: ThumbnailsAlignment;
1859
+ placement?: ThumbnailsAlignmentWithLiterals;
1804
1860
  /** Spacing between thumbnails in pixels. */
1805
1861
  spacing?: number | null;
1806
1862
  }
@@ -1816,7 +1872,7 @@ export interface GIFData {
1816
1872
  /** Width in pixels. */
1817
1873
  width?: number;
1818
1874
  /** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
1819
- gifType?: GIFType;
1875
+ gifType?: GIFTypeWithLiterals;
1820
1876
  }
1821
1877
  export interface GIF {
1822
1878
  /**
@@ -1839,6 +1895,8 @@ export declare enum GIFType {
1839
1895
  NORMAL = "NORMAL",
1840
1896
  STICKER = "STICKER"
1841
1897
  }
1898
+ /** @enumType */
1899
+ export type GIFTypeWithLiterals = GIFType | 'NORMAL' | 'STICKER';
1842
1900
  export interface HeadingData {
1843
1901
  /** Heading level from 1-6. */
1844
1902
  level?: number;
@@ -1860,7 +1918,7 @@ export interface HTMLData extends HTMLDataDataOneOf {
1860
1918
  /** Styling for the HTML node's container. Height property is irrelevant for HTML embeds when autoHeight is set to `true`. */
1861
1919
  containerData?: PluginContainerData;
1862
1920
  /** The type of HTML code. */
1863
- source?: Source;
1921
+ source?: SourceWithLiterals;
1864
1922
  /** If container height is aligned with its content height. Defaults to `true`. */
1865
1923
  autoHeight?: boolean | null;
1866
1924
  }
@@ -1880,6 +1938,8 @@ export declare enum Source {
1880
1938
  HTML = "HTML",
1881
1939
  ADSENSE = "ADSENSE"
1882
1940
  }
1941
+ /** @enumType */
1942
+ export type SourceWithLiterals = Source | 'HTML' | 'ADSENSE';
1883
1943
  export interface ImageData {
1884
1944
  /** Styling for the image's container. */
1885
1945
  containerData?: PluginContainerData;
@@ -1944,6 +2004,8 @@ export declare enum Position {
1944
2004
  /** Thumbnail hidden and not displayed */
1945
2005
  HIDDEN = "HIDDEN"
1946
2006
  }
2007
+ /** @enumType */
2008
+ export type PositionWithLiterals = Position | 'START' | 'END' | 'TOP' | 'HIDDEN';
1947
2009
  export interface LinkPreviewDataStyles {
1948
2010
  /**
1949
2011
  * Background color as a hexadecimal value.
@@ -1975,7 +2037,7 @@ export interface LinkPreviewDataStyles {
1975
2037
  */
1976
2038
  borderColor?: string | null;
1977
2039
  /** Position of thumbnail. Defaults to `START`. */
1978
- thumbnailPosition?: Position;
2040
+ thumbnailPosition?: PositionWithLiterals;
1979
2041
  }
1980
2042
  export interface MapData {
1981
2043
  /** Styling for the map's container. */
@@ -2005,7 +2067,7 @@ export interface MapSettings {
2005
2067
  /** Initial zoom value. */
2006
2068
  initialZoom?: number | null;
2007
2069
  /** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
2008
- mapType?: MapType;
2070
+ mapType?: MapTypeWithLiterals;
2009
2071
  }
2010
2072
  export declare enum MapType {
2011
2073
  /** Roadmap map type */
@@ -2017,6 +2079,8 @@ export declare enum MapType {
2017
2079
  /** Terrain map type */
2018
2080
  TERRAIN = "TERRAIN"
2019
2081
  }
2082
+ /** @enumType */
2083
+ export type MapTypeWithLiterals = MapType | 'ROADMAP' | 'SATELITE' | 'HYBRID' | 'TERRAIN';
2020
2084
  export interface ParagraphData {
2021
2085
  /** Styling for the paragraph text. */
2022
2086
  textStyle?: TextStyle;
@@ -2043,23 +2107,27 @@ export declare enum ViewRole {
2043
2107
  /** Anyone can see the results, even if one didn't vote */
2044
2108
  EVERYONE = "EVERYONE"
2045
2109
  }
2110
+ /** @enumType */
2111
+ export type ViewRoleWithLiterals = ViewRole | 'CREATOR' | 'VOTERS' | 'EVERYONE';
2046
2112
  export declare enum VoteRole {
2047
2113
  /** Logged in member */
2048
2114
  SITE_MEMBERS = "SITE_MEMBERS",
2049
2115
  /** Anyone */
2050
2116
  ALL = "ALL"
2051
2117
  }
2118
+ /** @enumType */
2119
+ export type VoteRoleWithLiterals = VoteRole | 'SITE_MEMBERS' | 'ALL';
2052
2120
  export interface Permissions {
2053
2121
  /** Sets who can view the poll results. */
2054
- view?: ViewRole;
2122
+ view?: ViewRoleWithLiterals;
2055
2123
  /** Sets who can vote. */
2056
- vote?: VoteRole;
2124
+ vote?: VoteRoleWithLiterals;
2057
2125
  /** Sets whether one voter can vote multiple times. Defaults to `false`. */
2058
2126
  allowMultipleVotes?: boolean | null;
2059
2127
  }
2060
2128
  export interface Option {
2061
2129
  /** Option ID. */
2062
- _id?: string | null;
2130
+ id?: string | null;
2063
2131
  /** Option title. */
2064
2132
  title?: string | null;
2065
2133
  /** The image displayed with the option. */
@@ -2079,17 +2147,21 @@ export declare enum PollLayoutType {
2079
2147
  /** Grid */
2080
2148
  GRID = "GRID"
2081
2149
  }
2150
+ /** @enumType */
2151
+ export type PollLayoutTypeWithLiterals = PollLayoutType | 'LIST' | 'GRID';
2082
2152
  export declare enum PollLayoutDirection {
2083
2153
  /** Left-to-right */
2084
2154
  LTR = "LTR",
2085
2155
  /** Right-to-left */
2086
2156
  RTL = "RTL"
2087
2157
  }
2158
+ /** @enumType */
2159
+ export type PollLayoutDirectionWithLiterals = PollLayoutDirection | 'LTR' | 'RTL';
2088
2160
  export interface PollLayout {
2089
2161
  /** The layout for displaying the voting options. */
2090
- type?: PollLayoutType;
2162
+ type?: PollLayoutTypeWithLiterals;
2091
2163
  /** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
2092
- direction?: PollLayoutDirection;
2164
+ direction?: PollLayoutDirectionWithLiterals;
2093
2165
  /** Sets whether to display the main poll image. Defaults to `false`. */
2094
2166
  enableImage?: boolean | null;
2095
2167
  }
@@ -2105,6 +2177,8 @@ export declare enum BackgroundType {
2105
2177
  /** Gradiant background type */
2106
2178
  GRADIENT = "GRADIENT"
2107
2179
  }
2180
+ /** @enumType */
2181
+ export type BackgroundTypeWithLiterals = BackgroundType | 'COLOR' | 'IMAGE' | 'GRADIENT';
2108
2182
  export interface Gradient {
2109
2183
  /** The gradient angle in degrees. */
2110
2184
  angle?: number | null;
@@ -2130,7 +2204,7 @@ export interface Background extends BackgroundBackgroundOneOf {
2130
2204
  /** Details for a gradient background. */
2131
2205
  gradient?: Gradient;
2132
2206
  /** Background type. For each option, include the relevant details. */
2133
- type?: BackgroundType;
2207
+ type?: BackgroundTypeWithLiterals;
2134
2208
  }
2135
2209
  /** @oneof */
2136
2210
  export interface BackgroundBackgroundOneOf {
@@ -2156,7 +2230,7 @@ export interface OptionDesign {
2156
2230
  }
2157
2231
  export interface Poll {
2158
2232
  /** Poll ID. */
2159
- _id?: string | null;
2233
+ id?: string | null;
2160
2234
  /** Poll title. */
2161
2235
  title?: string | null;
2162
2236
  /** Poll creator ID. */
@@ -2209,7 +2283,7 @@ export interface Decoration extends DecorationDataOneOf {
2209
2283
  /** Data for a strikethrough decoration. Defaults to `true`. */
2210
2284
  strikethroughData?: boolean | null;
2211
2285
  /** The type of decoration to apply. */
2212
- type?: DecorationType;
2286
+ type?: DecorationTypeWithLiterals;
2213
2287
  }
2214
2288
  /** @oneof */
2215
2289
  export interface DecorationDataOneOf {
@@ -2247,6 +2321,8 @@ export declare enum DecorationType {
2247
2321
  EXTERNAL = "EXTERNAL",
2248
2322
  STRIKETHROUGH = "STRIKETHROUGH"
2249
2323
  }
2324
+ /** @enumType */
2325
+ export type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL' | 'STRIKETHROUGH';
2250
2326
  export interface AnchorData {
2251
2327
  /** The target node's ID. */
2252
2328
  anchor?: string;
@@ -2267,11 +2343,11 @@ export interface MentionData {
2267
2343
  /** The version of the user's name that appears after the `@` character in the mention. */
2268
2344
  slug?: string;
2269
2345
  /** Mentioned user's ID. */
2270
- _id?: string | null;
2346
+ id?: string | null;
2271
2347
  }
2272
2348
  export interface FontSizeData {
2273
2349
  /** The units used for the font size. */
2274
- unit?: FontType;
2350
+ unit?: FontTypeWithLiterals;
2275
2351
  /** Font size value. */
2276
2352
  value?: number | null;
2277
2353
  }
@@ -2279,9 +2355,11 @@ export declare enum FontType {
2279
2355
  PX = "PX",
2280
2356
  EM = "EM"
2281
2357
  }
2358
+ /** @enumType */
2359
+ export type FontTypeWithLiterals = FontType | 'PX' | 'EM';
2282
2360
  export interface SpoilerData {
2283
2361
  /** Spoiler ID. */
2284
- _id?: string | null;
2362
+ id?: string | null;
2285
2363
  }
2286
2364
  export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
2287
2365
  /** Data for embedded Wix Bookings content. */
@@ -2289,7 +2367,7 @@ export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
2289
2367
  /** Data for embedded Wix Events content. */
2290
2368
  eventData?: EventData;
2291
2369
  /** The type of Wix App content being embedded. */
2292
- type?: AppType;
2370
+ type?: AppTypeWithLiterals;
2293
2371
  /** The ID of the embedded content. */
2294
2372
  itemId?: string | null;
2295
2373
  /** The name of the embedded content. */
@@ -2316,6 +2394,8 @@ export declare enum AppType {
2316
2394
  EVENT = "EVENT",
2317
2395
  BOOKING = "BOOKING"
2318
2396
  }
2397
+ /** @enumType */
2398
+ export type AppTypeWithLiterals = AppType | 'PRODUCT' | 'EVENT' | 'BOOKING';
2319
2399
  export interface BookingData {
2320
2400
  /** Booking duration in minutes. */
2321
2401
  durations?: string | null;
@@ -2394,9 +2474,9 @@ export interface CollapsibleListData {
2394
2474
  /** If `true`, only one item can be expanded at a time. Defaults to `false`. */
2395
2475
  expandOnlyOne?: boolean | null;
2396
2476
  /** Sets which items are expanded when the page loads. */
2397
- initialExpandedItems?: InitialExpandedItems;
2477
+ initialExpandedItems?: InitialExpandedItemsWithLiterals;
2398
2478
  /** The direction of the text in the list. Either left-to-right or right-to-left. */
2399
- direction?: Direction;
2479
+ direction?: DirectionWithLiterals;
2400
2480
  /** If `true`, The collapsible item will appear in search results as an FAQ. */
2401
2481
  isQapageData?: boolean | null;
2402
2482
  }
@@ -2408,12 +2488,16 @@ export declare enum InitialExpandedItems {
2408
2488
  /** All items collapsed initally */
2409
2489
  NONE = "NONE"
2410
2490
  }
2491
+ /** @enumType */
2492
+ export type InitialExpandedItemsWithLiterals = InitialExpandedItems | 'FIRST' | 'ALL' | 'NONE';
2411
2493
  export declare enum Direction {
2412
2494
  /** Left-to-right */
2413
2495
  LTR = "LTR",
2414
2496
  /** Right-to-left */
2415
2497
  RTL = "RTL"
2416
2498
  }
2499
+ /** @enumType */
2500
+ export type DirectionWithLiterals = Direction | 'LTR' | 'RTL';
2417
2501
  export interface TableData {
2418
2502
  /** Styling for the table's container. */
2419
2503
  containerData?: PluginContainerData;
@@ -2451,9 +2535,11 @@ export declare enum VerticalAlignment {
2451
2535
  /** Bottom alignment */
2452
2536
  BOTTOM = "BOTTOM"
2453
2537
  }
2538
+ /** @enumType */
2539
+ export type VerticalAlignmentWithLiterals = VerticalAlignment | 'TOP' | 'MIDDLE' | 'BOTTOM';
2454
2540
  export interface CellStyle {
2455
2541
  /** Vertical alignment for the cell's text. */
2456
- verticalAlignment?: VerticalAlignment;
2542
+ verticalAlignment?: VerticalAlignmentWithLiterals;
2457
2543
  /**
2458
2544
  * Cell background color as a hexadecimal value.
2459
2545
  * @format COLOR_HEX
@@ -2492,6 +2578,8 @@ export declare enum NullValue {
2492
2578
  /** Null value. */
2493
2579
  NULL_VALUE = "NULL_VALUE"
2494
2580
  }
2581
+ /** @enumType */
2582
+ export type NullValueWithLiterals = NullValue | 'NULL_VALUE';
2495
2583
  /**
2496
2584
  * `ListValue` is a wrapper around a repeated field of values.
2497
2585
  *
@@ -2596,7 +2684,7 @@ export interface BadgeList {
2596
2684
  }
2597
2685
  export interface V3Badge {
2598
2686
  /** Badge type. */
2599
- type?: BadgeTypeType;
2687
+ type?: BadgeTypeTypeWithLiterals;
2600
2688
  /**
2601
2689
  * Badge text.
2602
2690
  * @maxLength 50
@@ -2613,6 +2701,8 @@ export declare enum BadgeTypeType {
2613
2701
  /** 3rd priority badge type. */
2614
2702
  THIRD_PRIORITY = "THIRD_PRIORITY"
2615
2703
  }
2704
+ /** @enumType */
2705
+ export type BadgeTypeTypeWithLiterals = BadgeTypeType | 'UNKNOWN_BADGE_TYPE' | 'FIRST_PRIORITY' | 'SECOND_PRIORITY' | 'THIRD_PRIORITY';
2616
2706
  export interface EventEventStarted {
2617
2707
  /** Event schedule configuration. */
2618
2708
  timestamp?: Date | null;
@@ -2672,7 +2762,7 @@ export interface EventEventPublished {
2672
2762
  */
2673
2763
  eventId?: string;
2674
2764
  /** Event status. */
2675
- status?: Status;
2765
+ status?: StatusWithLiterals;
2676
2766
  /**
2677
2767
  * Event ID. Indicates the original event from which the current event was derived from.
2678
2768
  * Can be used to track the original event and add missing information.
@@ -2723,7 +2813,7 @@ export interface EventCloned {
2723
2813
  */
2724
2814
  userId?: string | null;
2725
2815
  /** Event status. */
2726
- status?: Status;
2816
+ status?: StatusWithLiterals;
2727
2817
  /**
2728
2818
  * Instance ID. Indicates the original app instance from which current event was derived from.
2729
2819
  * @format GUID
@@ -2772,7 +2862,7 @@ export interface CreateEventRequest {
2772
2862
  * Predefined sets of fields to return.
2773
2863
  * @maxSize 20
2774
2864
  */
2775
- fields?: RequestedFields[];
2865
+ fields?: RequestedFieldsWithLiterals[];
2776
2866
  }
2777
2867
  export declare enum RequestedFields {
2778
2868
  /** Unknown requested field. */
@@ -2800,6 +2890,8 @@ export declare enum RequestedFields {
2800
2890
  /** Returns `categories`. */
2801
2891
  CATEGORIES = "CATEGORIES"
2802
2892
  }
2893
+ /** @enumType */
2894
+ export type RequestedFieldsWithLiterals = RequestedFields | 'UNKNOWN_REQUESTED_FIELD' | 'DETAILS' | 'TEXTS' | 'REGISTRATION' | 'URLS' | 'FORM' | 'DASHBOARD' | 'FEED' | 'ONLINE_CONFERENCING_SESSION' | 'SEO_SETTINGS' | 'AGENDA' | 'CATEGORIES';
2803
2895
  export interface CreateEventResponse {
2804
2896
  /** Created event. */
2805
2897
  event?: V3Event;
@@ -2818,7 +2910,7 @@ export interface CloneEventRequest {
2818
2910
  * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
2819
2911
  * @maxSize 20
2820
2912
  */
2821
- fields?: RequestedFields[];
2913
+ fields?: RequestedFieldsWithLiterals[];
2822
2914
  }
2823
2915
  export interface CloneEventResponse {
2824
2916
  /** Cloned event. */
@@ -2839,7 +2931,7 @@ export interface CloneEventFromOtherSiteRequest {
2839
2931
  * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
2840
2932
  * @maxSize 20
2841
2933
  */
2842
- fields?: RequestedFields[];
2934
+ fields?: RequestedFieldsWithLiterals[];
2843
2935
  }
2844
2936
  export interface CloneEventFromOtherSiteResponse {
2845
2937
  /** Cloned event. */
@@ -2852,7 +2944,7 @@ export interface UpdateEventRequest {
2852
2944
  * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
2853
2945
  * @maxSize 20
2854
2946
  */
2855
- fields?: RequestedFields[];
2947
+ fields?: RequestedFieldsWithLiterals[];
2856
2948
  }
2857
2949
  export interface UpdateEventResponse {
2858
2950
  /** Updated event. */
@@ -2868,7 +2960,7 @@ export interface PublishDraftEventRequest {
2868
2960
  * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
2869
2961
  * @maxSize 20
2870
2962
  */
2871
- fields?: RequestedFields[];
2963
+ fields?: RequestedFieldsWithLiterals[];
2872
2964
  }
2873
2965
  export interface PublishDraftEventResponse {
2874
2966
  /** Published event. */
@@ -2884,7 +2976,7 @@ export interface CancelEventRequest {
2884
2976
  * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
2885
2977
  * @maxSize 20
2886
2978
  */
2887
- fields?: RequestedFields[];
2979
+ fields?: RequestedFieldsWithLiterals[];
2888
2980
  }
2889
2981
  export interface CancelEventResponse {
2890
2982
  /** Canceled event. */
@@ -2929,12 +3021,14 @@ export interface CommonSorting {
2929
3021
  *
2930
3022
  * Default: `ASC`.
2931
3023
  */
2932
- order?: CommonSortOrder;
3024
+ order?: CommonSortOrderWithLiterals;
2933
3025
  }
2934
3026
  export declare enum CommonSortOrder {
2935
3027
  ASC = "ASC",
2936
3028
  DESC = "DESC"
2937
3029
  }
3030
+ /** @enumType */
3031
+ export type CommonSortOrderWithLiterals = CommonSortOrder | 'ASC' | 'DESC';
2938
3032
  export interface CommonPaging {
2939
3033
  /**
2940
3034
  * Number of items to return. See [Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging#getting-started_sorting-and-paging_paging) for more information.
@@ -2973,7 +3067,7 @@ export interface QueryEventsRequest {
2973
3067
  * Predefined sets of fields to return.
2974
3068
  * @maxSize 20
2975
3069
  */
2976
- fields?: RequestedFields[];
3070
+ fields?: RequestedFieldsWithLiterals[];
2977
3071
  /**
2978
3072
  * Whether draft events should be returned in the response. <br>
2979
3073
  * **Note:** This parameter requires the `WIX_EVENTS.READ_DRAFT_EVENTS` permission.
@@ -3044,12 +3138,14 @@ export interface Sorting {
3044
3138
  */
3045
3139
  fieldName?: string;
3046
3140
  /** Sort order. */
3047
- order?: SortOrder;
3141
+ order?: SortOrderWithLiterals;
3048
3142
  }
3049
3143
  export declare enum SortOrder {
3050
3144
  ASC = "ASC",
3051
3145
  DESC = "DESC"
3052
3146
  }
3147
+ /** @enumType */
3148
+ export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
3053
3149
  export interface Paging {
3054
3150
  /** Number of items to load. */
3055
3151
  limit?: number | null;
@@ -3139,7 +3235,7 @@ export interface ListUserEventsRequest {
3139
3235
  * Event status.
3140
3236
  * @maxSize 20
3141
3237
  */
3142
- status?: Status[];
3238
+ status?: StatusWithLiterals[];
3143
3239
  /** Allows to filter events by user relation to the event among all wix sites. */
3144
3240
  userFilter?: UserFilter;
3145
3241
  /**
@@ -3161,12 +3257,14 @@ export interface UserFilter {
3161
3257
  * @minSize 1
3162
3258
  * @maxSize 20
3163
3259
  */
3164
- relation?: Relation[];
3260
+ relation?: RelationWithLiterals[];
3165
3261
  }
3166
3262
  export declare enum Relation {
3167
3263
  /** User is attending the event. The user RSVP'd with status of `YES` or has ordered tickets. */
3168
3264
  ATTENDING = "ATTENDING"
3169
3265
  }
3266
+ /** @enumType */
3267
+ export type RelationWithLiterals = Relation | 'ATTENDING';
3170
3268
  export interface ListUserEventsResponse {
3171
3269
  /** Metadata for the paginated results. */
3172
3270
  pagingMetadata?: CommonPagingMetadataV2;
@@ -3187,7 +3285,7 @@ export interface ListEventsByCategoryRequest {
3187
3285
  * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
3188
3286
  * @maxSize 20
3189
3287
  */
3190
- fields?: RequestedFields[];
3288
+ fields?: RequestedFieldsWithLiterals[];
3191
3289
  }
3192
3290
  export interface ListEventsByCategoryResponse {
3193
3291
  /** Metadata for the paginated results. */
@@ -3205,7 +3303,7 @@ export interface GetEventRequest {
3205
3303
  * Predefined sets of fields to return.
3206
3304
  * @maxSize 20
3207
3305
  */
3208
- fields?: RequestedFields[];
3306
+ fields?: RequestedFieldsWithLiterals[];
3209
3307
  }
3210
3308
  export interface GetEventResponse {
3211
3309
  /** Event. */
@@ -3219,7 +3317,7 @@ export interface GetEventBySlugRequest {
3219
3317
  */
3220
3318
  slug: string | null;
3221
3319
  /** @maxSize 20 */
3222
- fields?: RequestedFields[];
3320
+ fields?: RequestedFieldsWithLiterals[];
3223
3321
  }
3224
3322
  export interface GetEventBySlugResponse {
3225
3323
  /** Event. */
@@ -3241,7 +3339,7 @@ export interface FindEventRequest extends FindEventRequestFindByOneOf {
3241
3339
  * Predefined sets of fields to return.
3242
3340
  * @maxSize 20
3243
3341
  */
3244
- fields?: RequestedFields[];
3342
+ fields?: RequestedFieldsWithLiterals[];
3245
3343
  }
3246
3344
  /** @oneof */
3247
3345
  export interface FindEventRequestFindByOneOf {
@@ -3281,7 +3379,7 @@ export interface EventCreated {
3281
3379
  */
3282
3380
  userId?: string | null;
3283
3381
  /** Event status. */
3284
- status?: EventStatus;
3382
+ status?: EventStatusWithLiterals;
3285
3383
  /**
3286
3384
  * Instance ID. Indicates the original app instance which current event was derived from.
3287
3385
  * @format GUID
@@ -3309,7 +3407,7 @@ export interface EventsLocation {
3309
3407
  */
3310
3408
  address?: string | null;
3311
3409
  /** Location type. */
3312
- type?: LocationLocationType;
3410
+ type?: LocationLocationTypeWithLiterals;
3313
3411
  /**
3314
3412
  * Full address derived from formatted single line `address`.
3315
3413
  * When `full_address` is used to create or update the event, deprecated `address` and `coordinates` are ignored.
@@ -3345,6 +3443,8 @@ export declare enum LocationLocationType {
3345
3443
  VENUE = "VENUE",
3346
3444
  ONLINE = "ONLINE"
3347
3445
  }
3446
+ /** @enumType */
3447
+ export type LocationLocationTypeWithLiterals = LocationLocationType | 'VENUE' | 'ONLINE';
3348
3448
  /** Physical address */
3349
3449
  export interface Address extends AddressStreetOneOf {
3350
3450
  /** a break down of the street to number and street name */
@@ -3424,6 +3524,8 @@ export declare enum SubdivisionType {
3424
3524
  /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
3425
3525
  COUNTRY = "COUNTRY"
3426
3526
  }
3527
+ /** @enumType */
3528
+ export type SubdivisionTypeWithLiterals = SubdivisionType | 'UNKNOWN_SUBDIVISION_TYPE' | 'ADMINISTRATIVE_AREA_LEVEL_1' | 'ADMINISTRATIVE_AREA_LEVEL_2' | 'ADMINISTRATIVE_AREA_LEVEL_3' | 'ADMINISTRATIVE_AREA_LEVEL_4' | 'ADMINISTRATIVE_AREA_LEVEL_5' | 'COUNTRY';
3427
3529
  export interface ScheduleConfig {
3428
3530
  /**
3429
3531
  * Defines event as TBD (To Be Determined) schedule.
@@ -3467,7 +3569,7 @@ export interface EventsRecurrences {
3467
3569
  * Recurrence status.
3468
3570
  * @readonly
3469
3571
  */
3470
- status?: EventsRecurrenceStatusStatus;
3572
+ status?: EventsRecurrenceStatusStatusWithLiterals;
3471
3573
  }
3472
3574
  export interface EventsOccurrence {
3473
3575
  /** Event start timestamp. */
@@ -3494,6 +3596,8 @@ export declare enum EventsRecurrenceStatusStatus {
3494
3596
  /** Marks the most recent canceled occurrence of the recurring event. */
3495
3597
  RECURRING_LAST_CANCELED = "RECURRING_LAST_CANCELED"
3496
3598
  }
3599
+ /** @enumType */
3600
+ export type EventsRecurrenceStatusStatusWithLiterals = EventsRecurrenceStatusStatus | 'ONE_TIME' | 'RECURRING' | 'RECURRING_NEXT' | 'RECURRING_LAST_ENDED' | 'RECURRING_LAST_CANCELED';
3497
3601
  export declare enum EventStatus {
3498
3602
  /** Event is public and scheduled to start */
3499
3603
  SCHEDULED = "SCHEDULED",
@@ -3504,6 +3608,8 @@ export declare enum EventStatus {
3504
3608
  /** Event was canceled */
3505
3609
  CANCELED = "CANCELED"
3506
3610
  }
3611
+ /** @enumType */
3612
+ export type EventStatusWithLiterals = EventStatus | 'SCHEDULED' | 'STARTED' | 'ENDED' | 'CANCELED';
3507
3613
  export interface Event {
3508
3614
  /**
3509
3615
  * Event ID.
@@ -3532,7 +3638,7 @@ export interface Event {
3532
3638
  /** Event modified timestamp. */
3533
3639
  modified?: Date | null;
3534
3640
  /** Event status. */
3535
- status?: EventStatus;
3641
+ status?: EventStatusWithLiterals;
3536
3642
  /** RSVP or ticketing registration details. */
3537
3643
  registration?: EventsRegistration;
3538
3644
  /** "Add to calendar" URLs. */
@@ -3590,9 +3696,9 @@ export interface Scheduling {
3590
3696
  }
3591
3697
  export interface EventsRegistration {
3592
3698
  /** Event type. */
3593
- type?: EventType;
3699
+ type?: EventTypeWithLiterals;
3594
3700
  /** Event registration status. */
3595
- status?: RegistrationStatus;
3701
+ status?: RegistrationStatusWithLiterals;
3596
3702
  /** RSVP collection details. */
3597
3703
  rsvpCollection?: RsvpCollection;
3598
3704
  /** Ticketing details. */
@@ -3600,9 +3706,9 @@ export interface EventsRegistration {
3600
3706
  /** External registration details. */
3601
3707
  external?: ExternalEvent;
3602
3708
  /** Types of users allowed to register. */
3603
- restrictedTo?: VisitorType;
3709
+ restrictedTo?: VisitorTypeWithLiterals;
3604
3710
  /** Initial event type which was set when creating an event. */
3605
- initialType?: EventType;
3711
+ initialType?: EventTypeWithLiterals;
3606
3712
  }
3607
3713
  export declare enum EventType {
3608
3714
  /** Type not available for this request fieldset */
@@ -3616,6 +3722,8 @@ export declare enum EventType {
3616
3722
  /** Registration not available */
3617
3723
  NO_REGISTRATION = "NO_REGISTRATION"
3618
3724
  }
3725
+ /** @enumType */
3726
+ export type EventTypeWithLiterals = EventType | 'NA_EVENT_TYPE' | 'RSVP' | 'TICKETS' | 'EXTERNAL' | 'NO_REGISTRATION';
3619
3727
  export declare enum RegistrationStatus {
3620
3728
  /** Registration status is not applicable */
3621
3729
  NA_REGISTRATION_STATUS = "NA_REGISTRATION_STATUS",
@@ -3634,13 +3742,15 @@ export declare enum RegistrationStatus {
3634
3742
  /** Registration will be open via RSVP */
3635
3743
  SCHEDULED_RSVP = "SCHEDULED_RSVP"
3636
3744
  }
3745
+ /** @enumType */
3746
+ export type RegistrationStatusWithLiterals = RegistrationStatus | 'NA_REGISTRATION_STATUS' | 'CLOSED' | 'CLOSED_MANUALLY' | 'OPEN_RSVP' | 'OPEN_RSVP_WAITLIST' | 'OPEN_TICKETS' | 'OPEN_EXTERNAL' | 'SCHEDULED_RSVP';
3637
3747
  export interface RsvpCollection {
3638
3748
  /** RSVP collection configuration. */
3639
3749
  config?: RsvpCollectionConfig;
3640
3750
  }
3641
3751
  export interface RsvpCollectionConfig {
3642
3752
  /** Defines the supported RSVP statuses. */
3643
- rsvpStatusOptions?: RsvpStatusOptions;
3753
+ rsvpStatusOptions?: RsvpStatusOptionsWithLiterals;
3644
3754
  /**
3645
3755
  * Total guest limit available to register to the event.
3646
3756
  * Additional guests per RSVP are counted towards total guests.
@@ -3659,6 +3769,8 @@ export declare enum RsvpStatusOptions {
3659
3769
  /** YES and NO RSVP status options are available for the registration */
3660
3770
  YES_AND_NO = "YES_AND_NO"
3661
3771
  }
3772
+ /** @enumType */
3773
+ export type RsvpStatusOptionsWithLiterals = RsvpStatusOptions | 'YES_ONLY' | 'YES_AND_NO';
3662
3774
  export interface Ticketing {
3663
3775
  /**
3664
3776
  * Deprecated.
@@ -3719,7 +3831,7 @@ export interface TicketingConfig {
3719
3831
  }
3720
3832
  export interface TaxConfig {
3721
3833
  /** Tax application settings. */
3722
- type?: EventsTaxType;
3834
+ type?: EventsTaxTypeWithLiterals;
3723
3835
  /**
3724
3836
  * Tax name.
3725
3837
  * @minLength 1
@@ -3742,6 +3854,8 @@ export declare enum EventsTaxType {
3742
3854
  /** Tax is added to the final total at the checkout. */
3743
3855
  ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
3744
3856
  }
3857
+ /** @enumType */
3858
+ export type EventsTaxTypeWithLiterals = EventsTaxType | 'INCLUDED' | 'ADDED' | 'ADDED_AT_CHECKOUT';
3745
3859
  export interface ExternalEvent {
3746
3860
  /** External event registration URL. */
3747
3861
  registration?: string;
@@ -3754,6 +3868,8 @@ export declare enum VisitorType {
3754
3868
  /** Site visitor or member */
3755
3869
  VISITOR_OR_MEMBER = "VISITOR_OR_MEMBER"
3756
3870
  }
3871
+ /** @enumType */
3872
+ export type VisitorTypeWithLiterals = VisitorType | 'VISITOR' | 'MEMBER' | 'VISITOR_OR_MEMBER';
3757
3873
  export interface CalendarLinks {
3758
3874
  /** "Add to Google calendar" URL. */
3759
3875
  google?: string;
@@ -3828,7 +3944,7 @@ export interface OnlineConferencingConfig {
3828
3944
  */
3829
3945
  providerId?: string | null;
3830
3946
  /** Conference type */
3831
- conferenceType?: ConferenceType;
3947
+ conferenceType?: ConferenceTypeWithLiterals;
3832
3948
  }
3833
3949
  export declare enum ConferenceType {
3834
3950
  /** Everyone in the meeting can publish and subscribe video and audio. */
@@ -3836,6 +3952,8 @@ export declare enum ConferenceType {
3836
3952
  /** Guests can only subscribe to video and audio. */
3837
3953
  WEBINAR = "WEBINAR"
3838
3954
  }
3955
+ /** @enumType */
3956
+ export type ConferenceTypeWithLiterals = ConferenceType | 'MEETING' | 'WEBINAR';
3839
3957
  export interface EventsOnlineConferencingSession {
3840
3958
  /**
3841
3959
  * Link for event host to start the online conference session.
@@ -3922,7 +4040,7 @@ export interface Category {
3922
4040
  * **Note:** The WIX_EVENTS.MANAGE_AUTO_CATEGORIES permission scope is required to use states other than `MANUAL`.
3923
4041
  * @maxSize 3
3924
4042
  */
3925
- states?: State[];
4043
+ states?: StateWithLiterals[];
3926
4044
  }
3927
4045
  export interface CategoryCounts {
3928
4046
  /** Total number of draft events assigned to the category. */
@@ -3940,6 +4058,8 @@ export declare enum State {
3940
4058
  /** Category is hidden. */
3941
4059
  HIDDEN = "HIDDEN"
3942
4060
  }
4061
+ /** @enumType */
4062
+ export type StateWithLiterals = State | 'MANUAL' | 'AUTO' | 'RECURRING_EVENT' | 'HIDDEN';
3943
4063
  export interface EventDisplaySettings {
3944
4064
  /** Whether event details button is hidden. Only available for events with no registration. */
3945
4065
  hideEventDetailsButton?: boolean | null;
@@ -3950,7 +4070,7 @@ export interface EventsLabellingSettings {
3950
4070
  }
3951
4071
  export interface Badge {
3952
4072
  /** Badge type. */
3953
- type?: Type;
4073
+ type?: TypeWithLiterals;
3954
4074
  /**
3955
4075
  * Badge text.
3956
4076
  * @maxLength 50
@@ -3967,6 +4087,8 @@ export declare enum Type {
3967
4087
  /** 3rd priority badge type. */
3968
4088
  THIRD_PRIORITY = "THIRD_PRIORITY"
3969
4089
  }
4090
+ /** @enumType */
4091
+ export type TypeWithLiterals = Type | 'UNKNOWN_BADGE_TYPE' | 'FIRST_PRIORITY' | 'SECOND_PRIORITY' | 'THIRD_PRIORITY';
3970
4092
  export interface Empty {
3971
4093
  }
3972
4094
  export interface EventUpdated {
@@ -4027,7 +4149,7 @@ export interface EventCopied {
4027
4149
  */
4028
4150
  userId?: string | null;
4029
4151
  /** Event status. */
4030
- status?: EventStatus;
4152
+ status?: EventStatusWithLiterals;
4031
4153
  /**
4032
4154
  * Instance ID. Indicates the original app instance which current event was derived from.
4033
4155
  * @format GUID
@@ -4054,7 +4176,7 @@ export interface EventPublished {
4054
4176
  */
4055
4177
  eventId?: string;
4056
4178
  /** Event status. */
4057
- status?: EventStatus;
4179
+ status?: EventStatusWithLiterals;
4058
4180
  /**
4059
4181
  * Event ID. Indicates the original event which current event was derived from.
4060
4182
  * Can be used to track the original event and add missing information.
@@ -4142,25 +4264,21 @@ export interface DomainEvent extends DomainEventBodyOneOf {
4142
4264
  updatedEvent?: EntityUpdatedEvent;
4143
4265
  deletedEvent?: EntityDeletedEvent;
4144
4266
  actionEvent?: ActionEvent;
4145
- /**
4146
- * Unique event ID.
4147
- * Allows clients to ignore duplicate webhooks.
4148
- */
4267
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
4149
4268
  _id?: string;
4150
4269
  /**
4151
- * Assumes actions are also always typed to an entity_type
4152
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
4270
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
4271
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
4153
4272
  */
4154
4273
  entityFqdn?: string;
4155
4274
  /**
4156
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
4157
- * This is although the created/updated/deleted notion is duplication of the oneof types
4158
- * Example: created/updated/deleted/started/completed/email_opened
4275
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
4276
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
4159
4277
  */
4160
4278
  slug?: string;
4161
4279
  /** ID of the entity associated with the event. */
4162
4280
  entityId?: string;
4163
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
4281
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
4164
4282
  eventTime?: Date | null;
4165
4283
  /**
4166
4284
  * Whether the event was triggered as a result of a privacy regulation application
@@ -4170,12 +4288,8 @@ export interface DomainEvent extends DomainEventBodyOneOf {
4170
4288
  /** If present, indicates the action that triggered the event. */
4171
4289
  originatedFrom?: string | null;
4172
4290
  /**
4173
- * A sequence number defining the order of updates to the underlying entity.
4174
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
4175
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
4176
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
4177
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
4178
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
4291
+ * 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.
4292
+ * 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.
4179
4293
  */
4180
4294
  entityEventSequence?: string | null;
4181
4295
  }
@@ -4201,7 +4315,7 @@ export interface EntityUpdatedEvent {
4201
4315
  currentEntity?: string;
4202
4316
  }
4203
4317
  export interface EntityDeletedEvent {
4204
- /** Entity that was deleted */
4318
+ /** Entity that was deleted. */
4205
4319
  deletedEntity?: string | null;
4206
4320
  }
4207
4321
  export interface ActionEvent {
@@ -4245,7 +4359,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
4245
4359
  */
4246
4360
  appId?: string;
4247
4361
  /** @readonly */
4248
- identityType?: WebhookIdentityType;
4362
+ identityType?: WebhookIdentityTypeWithLiterals;
4249
4363
  }
4250
4364
  /** @oneof */
4251
4365
  export interface IdentificationDataIdOneOf {
@@ -4277,6 +4391,8 @@ export declare enum WebhookIdentityType {
4277
4391
  WIX_USER = "WIX_USER",
4278
4392
  APP = "APP"
4279
4393
  }
4394
+ /** @enumType */
4395
+ export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
4280
4396
  export interface BaseEventMetadata {
4281
4397
  /**
4282
4398
  * App instance ID.
@@ -4292,25 +4408,21 @@ export interface BaseEventMetadata {
4292
4408
  identity?: IdentificationData;
4293
4409
  }
4294
4410
  export interface EventMetadata extends BaseEventMetadata {
4295
- /**
4296
- * Unique event ID.
4297
- * Allows clients to ignore duplicate webhooks.
4298
- */
4411
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
4299
4412
  _id?: string;
4300
4413
  /**
4301
- * Assumes actions are also always typed to an entity_type
4302
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
4414
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
4415
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
4303
4416
  */
4304
4417
  entityFqdn?: string;
4305
4418
  /**
4306
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
4307
- * This is although the created/updated/deleted notion is duplication of the oneof types
4308
- * Example: created/updated/deleted/started/completed/email_opened
4419
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
4420
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
4309
4421
  */
4310
4422
  slug?: string;
4311
4423
  /** ID of the entity associated with the event. */
4312
4424
  entityId?: string;
4313
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
4425
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
4314
4426
  eventTime?: Date | null;
4315
4427
  /**
4316
4428
  * Whether the event was triggered as a result of a privacy regulation application
@@ -4320,12 +4432,8 @@ export interface EventMetadata extends BaseEventMetadata {
4320
4432
  /** If present, indicates the action that triggered the event. */
4321
4433
  originatedFrom?: string | null;
4322
4434
  /**
4323
- * A sequence number defining the order of updates to the underlying entity.
4324
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
4325
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
4326
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
4327
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
4328
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
4435
+ * 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.
4436
+ * 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.
4329
4437
  */
4330
4438
  entityEventSequence?: string | null;
4331
4439
  }
@@ -4713,7 +4821,7 @@ export interface CreateEventOptions {
4713
4821
  * Predefined sets of fields to return.
4714
4822
  * @maxSize 20
4715
4823
  */
4716
- fields?: RequestedFields[];
4824
+ fields?: RequestedFieldsWithLiterals[];
4717
4825
  }
4718
4826
  /**
4719
4827
  * Clones an event, including the registration form, notifications, multilingual translations and ticket configuration from the original event.
@@ -4747,7 +4855,7 @@ export interface CloneEventOptions {
4747
4855
  * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
4748
4856
  * @maxSize 20
4749
4857
  */
4750
- fields?: RequestedFields[];
4858
+ fields?: RequestedFieldsWithLiterals[];
4751
4859
  }
4752
4860
  /**
4753
4861
  * Updates an event.
@@ -4831,7 +4939,7 @@ export interface UpdateEventOptions {
4831
4939
  * - `DRAFT`: The event is not published.
4832
4940
  * @readonly
4833
4941
  */
4834
- status?: Status;
4942
+ status?: StatusWithLiterals;
4835
4943
  /**
4836
4944
  * RSVP or ticketing registration details. <br>
4837
4945
  * **Note:** This field is returned only when the `REGISTRATION` fieldset is included in the request.
@@ -4909,7 +5017,7 @@ export interface UpdateEventOptions {
4909
5017
  * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
4910
5018
  * @maxSize 20
4911
5019
  */
4912
- fields?: RequestedFields[];
5020
+ fields?: RequestedFieldsWithLiterals[];
4913
5021
  }
4914
5022
  /**
4915
5023
  * Publishes a draft event to your live site. Once published, the event's status changes from `DRAFT` to `UPCOMING.`
@@ -4938,7 +5046,7 @@ export interface PublishDraftEventOptions {
4938
5046
  * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
4939
5047
  * @maxSize 20
4940
5048
  */
4941
- fields?: RequestedFields[];
5049
+ fields?: RequestedFieldsWithLiterals[];
4942
5050
  }
4943
5051
  /**
4944
5052
  * Cancels an event.
@@ -4968,7 +5076,7 @@ export interface CancelEventOptions {
4968
5076
  * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
4969
5077
  * @maxSize 20
4970
5078
  */
4971
- fields?: RequestedFields[];
5079
+ fields?: RequestedFieldsWithLiterals[];
4972
5080
  }
4973
5081
  /**
4974
5082
  * Cancels multiple events that meet the given criteria.
@@ -5090,7 +5198,7 @@ export interface QueryEventsOptions {
5090
5198
  * Predefined sets of fields to return.
5091
5199
  * @maxSize 20
5092
5200
  */
5093
- fields?: RequestedFields[] | undefined;
5201
+ fields?: RequestedFieldsWithLiterals[] | undefined;
5094
5202
  /**
5095
5203
  * Whether draft events should be returned in the response. <br>
5096
5204
  * **Note:** This parameter requires the `WIX_EVENTS.READ_DRAFT_EVENTS` permission.
@@ -5243,7 +5351,7 @@ export interface GetEventOptions {
5243
5351
  * Predefined sets of fields to return.
5244
5352
  * @maxSize 20
5245
5353
  */
5246
- fields?: RequestedFields[];
5354
+ fields?: RequestedFieldsWithLiterals[];
5247
5355
  }
5248
5356
  /**
5249
5357
  * Retrieves an event by the `slug` URL.
@@ -5290,6 +5398,6 @@ export declare function getEventBySlug(slug: string, options?: GetEventBySlugOpt
5290
5398
  }[EventNonNullablePaths]>>;
5291
5399
  export interface GetEventBySlugOptions {
5292
5400
  /** @maxSize 20 */
5293
- fields?: RequestedFields[];
5401
+ fields?: RequestedFieldsWithLiterals[];
5294
5402
  }
5295
5403
  export {};