@wix/auto_sdk_events_forms 1.0.26 → 1.0.28

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.
@@ -26,7 +26,7 @@ export interface Form {
26
26
  */
27
27
  export interface InputControl {
28
28
  /** Field control type. */
29
- type?: InputControlType;
29
+ type?: InputControlTypeWithLiterals;
30
30
  /** Whether the control is mandatory (such as `name` & `email`). When `true`, only the label can be changed. */
31
31
  system?: boolean;
32
32
  /**
@@ -73,6 +73,8 @@ export declare enum InputControlType {
73
73
  /** Fields for entering year, month, and day. */
74
74
  DATE = "DATE"
75
75
  }
76
+ /** @enumType */
77
+ export type InputControlTypeWithLiterals = InputControlType | 'INPUT' | 'TEXTAREA' | 'DROPDOWN' | 'RADIO' | 'CHECKBOX' | 'NAME' | 'GUEST_CONTROL' | 'ADDRESS_SHORT' | 'ADDRESS_FULL' | 'DATE';
76
78
  /** Child inputs. */
77
79
  export interface Input {
78
80
  /** Field name. */
@@ -96,7 +98,7 @@ export interface Input {
96
98
  * Type which determines field format.
97
99
  * Used to validate submitted response.
98
100
  */
99
- type?: ValueType;
101
+ type?: ValueTypeWithLiterals;
100
102
  /**
101
103
  * The maximum number of accepted values for array input.
102
104
  *
@@ -123,6 +125,8 @@ export declare enum ValueType {
123
125
  DATE_TIME = "DATE_TIME",
124
126
  ADDRESS = "ADDRESS"
125
127
  }
128
+ /** @enumType */
129
+ export type ValueTypeWithLiterals = ValueType | 'TEXT' | 'NUMBER' | 'TEXT_ARRAY' | 'DATE_TIME' | 'ADDRESS';
126
130
  /**
127
131
  * Describes initially selected option when an input has multiple choices.
128
132
  * Defaults to first (0th) option if not configured.
@@ -283,6 +287,8 @@ export declare enum RequestedFields {
283
287
  /** Include soft deleted input controls in the response. */
284
288
  DELETED = "DELETED"
285
289
  }
290
+ /** @enumType */
291
+ export type RequestedFieldsWithLiterals = RequestedFields | 'UNKNOWN_REQUESTED_FIELD' | 'DELETED';
286
292
  export interface GetFormResponse {
287
293
  /**
288
294
  * Currently published event form.
@@ -658,7 +664,7 @@ export interface Location {
658
664
  */
659
665
  address?: string | null;
660
666
  /** Location type. */
661
- type?: LocationType;
667
+ type?: LocationTypeWithLiterals;
662
668
  /**
663
669
  * Full address derived from formatted single line `address`.
664
670
  * When `full_address` is used to create or update the event, deprecated `address` and `coordinates` are ignored.
@@ -694,6 +700,8 @@ export declare enum LocationType {
694
700
  VENUE = "VENUE",
695
701
  ONLINE = "ONLINE"
696
702
  }
703
+ /** @enumType */
704
+ export type LocationTypeWithLiterals = LocationType | 'VENUE' | 'ONLINE';
697
705
  /** Physical address */
698
706
  export interface Address extends AddressStreetOneOf {
699
707
  /** a break down of the street to number and street name */
@@ -775,6 +783,8 @@ export declare enum SubdivisionType {
775
783
  /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
776
784
  COUNTRY = "COUNTRY"
777
785
  }
786
+ /** @enumType */
787
+ 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';
778
788
  export interface ScheduleConfig {
779
789
  /**
780
790
  * Defines event as TBD (To Be Determined) schedule.
@@ -818,7 +828,7 @@ export interface Recurrences {
818
828
  * Recurrence status.
819
829
  * @readonly
820
830
  */
821
- status?: Status;
831
+ status?: StatusWithLiterals;
822
832
  }
823
833
  export interface Occurrence {
824
834
  /** Event start timestamp. */
@@ -845,6 +855,8 @@ export declare enum Status {
845
855
  /** Marks the most recent canceled occurrence of the recurring event. */
846
856
  RECURRING_LAST_CANCELED = "RECURRING_LAST_CANCELED"
847
857
  }
858
+ /** @enumType */
859
+ export type StatusWithLiterals = Status | 'ONE_TIME' | 'RECURRING' | 'RECURRING_NEXT' | 'RECURRING_LAST_ENDED' | 'RECURRING_LAST_CANCELED';
848
860
  export interface Event {
849
861
  /**
850
862
  * Event ID.
@@ -873,7 +885,7 @@ export interface Event {
873
885
  /** Event modified timestamp. */
874
886
  modified?: Date | null;
875
887
  /** Event status. */
876
- status?: EventStatus;
888
+ status?: EventStatusWithLiterals;
877
889
  /** RSVP or ticketing registration details. */
878
890
  registration?: Registration;
879
891
  /** "Add to calendar" URLs. */
@@ -955,11 +967,13 @@ export declare enum EventStatus {
955
967
  /** Event was canceled */
956
968
  CANCELED = "CANCELED"
957
969
  }
970
+ /** @enumType */
971
+ export type EventStatusWithLiterals = EventStatus | 'SCHEDULED' | 'STARTED' | 'ENDED' | 'CANCELED';
958
972
  export interface Registration {
959
973
  /** Event type. */
960
- type?: EventType;
974
+ type?: EventTypeWithLiterals;
961
975
  /** Event registration status. */
962
- status?: RegistrationStatus;
976
+ status?: RegistrationStatusWithLiterals;
963
977
  /** RSVP collection details. */
964
978
  rsvpCollection?: RsvpCollection;
965
979
  /** Ticketing details. */
@@ -967,9 +981,9 @@ export interface Registration {
967
981
  /** External registration details. */
968
982
  external?: ExternalEvent;
969
983
  /** Types of users allowed to register. */
970
- restrictedTo?: VisitorType;
984
+ restrictedTo?: VisitorTypeWithLiterals;
971
985
  /** Initial event type which was set when creating an event. */
972
- initialType?: EventType;
986
+ initialType?: EventTypeWithLiterals;
973
987
  }
974
988
  export declare enum EventType {
975
989
  /** Type not available for this request fieldset */
@@ -983,6 +997,8 @@ export declare enum EventType {
983
997
  /** Registration not available */
984
998
  NO_REGISTRATION = "NO_REGISTRATION"
985
999
  }
1000
+ /** @enumType */
1001
+ export type EventTypeWithLiterals = EventType | 'NA_EVENT_TYPE' | 'RSVP' | 'TICKETS' | 'EXTERNAL' | 'NO_REGISTRATION';
986
1002
  export declare enum RegistrationStatus {
987
1003
  /** Registration status is not applicable */
988
1004
  NA_REGISTRATION_STATUS = "NA_REGISTRATION_STATUS",
@@ -1001,13 +1017,15 @@ export declare enum RegistrationStatus {
1001
1017
  /** Registration will be open via RSVP */
1002
1018
  SCHEDULED_RSVP = "SCHEDULED_RSVP"
1003
1019
  }
1020
+ /** @enumType */
1021
+ export type RegistrationStatusWithLiterals = RegistrationStatus | 'NA_REGISTRATION_STATUS' | 'CLOSED' | 'CLOSED_MANUALLY' | 'OPEN_RSVP' | 'OPEN_RSVP_WAITLIST' | 'OPEN_TICKETS' | 'OPEN_EXTERNAL' | 'SCHEDULED_RSVP';
1004
1022
  export interface RsvpCollection {
1005
1023
  /** RSVP collection configuration. */
1006
1024
  config?: RsvpCollectionConfig;
1007
1025
  }
1008
1026
  export interface RsvpCollectionConfig {
1009
1027
  /** Defines the supported RSVP statuses. */
1010
- rsvpStatusOptions?: RsvpStatusOptions;
1028
+ rsvpStatusOptions?: RsvpStatusOptionsWithLiterals;
1011
1029
  /**
1012
1030
  * Total guest limit available to register to the event.
1013
1031
  * Additional guests per RSVP are counted towards total guests.
@@ -1026,6 +1044,8 @@ export declare enum RsvpStatusOptions {
1026
1044
  /** YES and NO RSVP status options are available for the registration */
1027
1045
  YES_AND_NO = "YES_AND_NO"
1028
1046
  }
1047
+ /** @enumType */
1048
+ export type RsvpStatusOptionsWithLiterals = RsvpStatusOptions | 'YES_ONLY' | 'YES_AND_NO';
1029
1049
  export interface Ticketing {
1030
1050
  /**
1031
1051
  * Deprecated.
@@ -1086,7 +1106,7 @@ export interface TicketingConfig {
1086
1106
  }
1087
1107
  export interface TaxConfig {
1088
1108
  /** Tax application settings. */
1089
- type?: TaxType;
1109
+ type?: TaxTypeWithLiterals;
1090
1110
  /**
1091
1111
  * Tax name.
1092
1112
  * @minLength 1
@@ -1109,6 +1129,8 @@ export declare enum TaxType {
1109
1129
  /** Tax is added to the final total at the checkout. */
1110
1130
  ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
1111
1131
  }
1132
+ /** @enumType */
1133
+ export type TaxTypeWithLiterals = TaxType | 'INCLUDED' | 'ADDED' | 'ADDED_AT_CHECKOUT';
1112
1134
  export interface Money {
1113
1135
  /**
1114
1136
  * *Deprecated:** Use `value` instead.
@@ -1139,6 +1161,8 @@ export declare enum VisitorType {
1139
1161
  /** Site visitor or member */
1140
1162
  VISITOR_OR_MEMBER = "VISITOR_OR_MEMBER"
1141
1163
  }
1164
+ /** @enumType */
1165
+ export type VisitorTypeWithLiterals = VisitorType | 'VISITOR' | 'MEMBER' | 'VISITOR_OR_MEMBER';
1142
1166
  export interface CalendarLinks {
1143
1167
  /** "Add to Google calendar" URL. */
1144
1168
  google?: string;
@@ -1213,7 +1237,7 @@ export interface OnlineConferencingConfig {
1213
1237
  */
1214
1238
  providerId?: string | null;
1215
1239
  /** Conference type */
1216
- conferenceType?: ConferenceType;
1240
+ conferenceType?: ConferenceTypeWithLiterals;
1217
1241
  }
1218
1242
  export declare enum ConferenceType {
1219
1243
  /** Everyone in the meeting can publish and subscribe video and audio. */
@@ -1221,6 +1245,8 @@ export declare enum ConferenceType {
1221
1245
  /** Guests can only subscribe to video and audio. */
1222
1246
  WEBINAR = "WEBINAR"
1223
1247
  }
1248
+ /** @enumType */
1249
+ export type ConferenceTypeWithLiterals = ConferenceType | 'MEETING' | 'WEBINAR';
1224
1250
  export interface OnlineConferencingSession {
1225
1251
  /**
1226
1252
  * Link for event host to start the online conference session.
@@ -1365,7 +1391,7 @@ export interface Category {
1365
1391
  * **Note:** The WIX_EVENTS.MANAGE_AUTO_CATEGORIES permission scope is required to use states other than `MANUAL`.
1366
1392
  * @maxSize 3
1367
1393
  */
1368
- states?: State[];
1394
+ states?: StateWithLiterals[];
1369
1395
  }
1370
1396
  export interface CategoryCounts {
1371
1397
  /** Total number of draft events assigned to the category. */
@@ -1383,6 +1409,8 @@ export declare enum State {
1383
1409
  /** Category is hidden. */
1384
1410
  HIDDEN = "HIDDEN"
1385
1411
  }
1412
+ /** @enumType */
1413
+ export type StateWithLiterals = State | 'MANUAL' | 'AUTO' | 'RECURRING_EVENT' | 'HIDDEN';
1386
1414
  export interface EventDisplaySettings {
1387
1415
  /** Whether event details button is hidden. Only available for events with no registration. */
1388
1416
  hideEventDetailsButton?: boolean | null;
@@ -1455,7 +1483,7 @@ export interface Node extends NodeDataOneOf {
1455
1483
  /** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
1456
1484
  layoutCellData?: LayoutCellData;
1457
1485
  /** 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. */
1458
- type?: NodeType;
1486
+ type?: NodeTypeWithLiterals;
1459
1487
  /** Node ID. */
1460
1488
  id?: string;
1461
1489
  /** A list of child nodes. */
@@ -1556,6 +1584,8 @@ export declare enum NodeType {
1556
1584
  LAYOUT = "LAYOUT",
1557
1585
  LAYOUT_CELL = "LAYOUT_CELL"
1558
1586
  }
1587
+ /** @enumType */
1588
+ 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';
1559
1589
  export interface NodeStyle {
1560
1590
  /** The top padding value in pixels. */
1561
1591
  paddingTop?: string | null;
@@ -1568,7 +1598,7 @@ export interface ButtonData {
1568
1598
  /** Styling for the button's container. */
1569
1599
  containerData?: PluginContainerData;
1570
1600
  /** The button type. */
1571
- type?: ButtonDataType;
1601
+ type?: ButtonDataTypeWithLiterals;
1572
1602
  /** Styling for the button. */
1573
1603
  styles?: Styles;
1574
1604
  /** The text to display on the button. */
@@ -1609,7 +1639,7 @@ export interface PluginContainerData {
1609
1639
  /** The width of the node when it's displayed. */
1610
1640
  width?: PluginContainerDataWidth;
1611
1641
  /** The node's alignment within its container. */
1612
- alignment?: PluginContainerDataAlignment;
1642
+ alignment?: PluginContainerDataAlignmentWithLiterals;
1613
1643
  /** Spoiler cover settings for the node. */
1614
1644
  spoiler?: Spoiler;
1615
1645
  /** The height of the node when it's displayed. */
@@ -1627,6 +1657,8 @@ export declare enum WidthType {
1627
1657
  /** coast-to-coast display */
1628
1658
  FULL_WIDTH = "FULL_WIDTH"
1629
1659
  }
1660
+ /** @enumType */
1661
+ export type WidthTypeWithLiterals = WidthType | 'CONTENT' | 'SMALL' | 'ORIGINAL' | 'FULL_WIDTH';
1630
1662
  export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
1631
1663
  /**
1632
1664
  * One of the following predefined width options:
@@ -1635,7 +1667,7 @@ export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOn
1635
1667
  * `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
1636
1668
  * `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
1637
1669
  */
1638
- size?: WidthType;
1670
+ size?: WidthTypeWithLiterals;
1639
1671
  /** A custom width value in pixels. */
1640
1672
  custom?: string | null;
1641
1673
  }
@@ -1648,7 +1680,7 @@ export interface PluginContainerDataWidthDataOneOf {
1648
1680
  * `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
1649
1681
  * `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
1650
1682
  */
1651
- size?: WidthType;
1683
+ size?: WidthTypeWithLiterals;
1652
1684
  /** A custom width value in pixels. */
1653
1685
  custom?: string | null;
1654
1686
  }
@@ -1660,6 +1692,8 @@ export declare enum PluginContainerDataAlignment {
1660
1692
  /** Right Alignment */
1661
1693
  RIGHT = "RIGHT"
1662
1694
  }
1695
+ /** @enumType */
1696
+ export type PluginContainerDataAlignmentWithLiterals = PluginContainerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
1663
1697
  export interface Spoiler {
1664
1698
  /** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
1665
1699
  enabled?: boolean | null;
@@ -1678,6 +1712,8 @@ export declare enum ButtonDataType {
1678
1712
  /** Triggers custom action that is defined in plugin configuration by the consumer */
1679
1713
  ACTION = "ACTION"
1680
1714
  }
1715
+ /** @enumType */
1716
+ export type ButtonDataTypeWithLiterals = ButtonDataType | 'LINK' | 'ACTION';
1681
1717
  export interface Styles {
1682
1718
  /**
1683
1719
  * Deprecated: Use `borderWidth` and `borderRadius` instead.
@@ -1743,7 +1779,7 @@ export interface Link extends LinkDataOneOf {
1743
1779
  * `PARENT` - Opens the linked document in the link's parent frame.
1744
1780
  * `TOP` - Opens the linked document in the full body of the link's browser tab or window.
1745
1781
  */
1746
- target?: Target;
1782
+ target?: TargetWithLiterals;
1747
1783
  /** The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document. */
1748
1784
  rel?: Rel;
1749
1785
  /** A serialized object used for a custom or external link panel. */
@@ -1766,6 +1802,8 @@ export declare enum Target {
1766
1802
  /** Opens the linked document in the full body of the window */
1767
1803
  TOP = "TOP"
1768
1804
  }
1805
+ /** @enumType */
1806
+ export type TargetWithLiterals = Target | 'SELF' | 'BLANK' | 'PARENT' | 'TOP';
1769
1807
  export interface Rel {
1770
1808
  /** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
1771
1809
  nofollow?: boolean | null;
@@ -1782,7 +1820,7 @@ export interface CodeBlockData {
1782
1820
  }
1783
1821
  export interface TextStyle {
1784
1822
  /** Text alignment. Defaults to `AUTO`. */
1785
- textAlignment?: TextAlignment;
1823
+ textAlignment?: TextAlignmentWithLiterals;
1786
1824
  /** 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. */
1787
1825
  lineHeight?: string | null;
1788
1826
  }
@@ -1798,15 +1836,17 @@ export declare enum TextAlignment {
1798
1836
  /** 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 */
1799
1837
  JUSTIFY = "JUSTIFY"
1800
1838
  }
1839
+ /** @enumType */
1840
+ export type TextAlignmentWithLiterals = TextAlignment | 'AUTO' | 'LEFT' | 'RIGHT' | 'CENTER' | 'JUSTIFY';
1801
1841
  export interface DividerData {
1802
1842
  /** Styling for the divider's container. */
1803
1843
  containerData?: PluginContainerData;
1804
1844
  /** Divider line style. */
1805
- lineStyle?: LineStyle;
1845
+ lineStyle?: LineStyleWithLiterals;
1806
1846
  /** Divider width. */
1807
- width?: Width;
1847
+ width?: WidthWithLiterals;
1808
1848
  /** Divider alignment. */
1809
- alignment?: Alignment;
1849
+ alignment?: AlignmentWithLiterals;
1810
1850
  }
1811
1851
  export declare enum LineStyle {
1812
1852
  /** Single Line */
@@ -1818,6 +1858,8 @@ export declare enum LineStyle {
1818
1858
  /** Dotted Line */
1819
1859
  DOTTED = "DOTTED"
1820
1860
  }
1861
+ /** @enumType */
1862
+ export type LineStyleWithLiterals = LineStyle | 'SINGLE' | 'DOUBLE' | 'DASHED' | 'DOTTED';
1821
1863
  export declare enum Width {
1822
1864
  /** Large line */
1823
1865
  LARGE = "LARGE",
@@ -1826,6 +1868,8 @@ export declare enum Width {
1826
1868
  /** Small line */
1827
1869
  SMALL = "SMALL"
1828
1870
  }
1871
+ /** @enumType */
1872
+ export type WidthWithLiterals = Width | 'LARGE' | 'MEDIUM' | 'SMALL';
1829
1873
  export declare enum Alignment {
1830
1874
  /** Center alignment */
1831
1875
  CENTER = "CENTER",
@@ -1834,6 +1878,8 @@ export declare enum Alignment {
1834
1878
  /** Right alignment */
1835
1879
  RIGHT = "RIGHT"
1836
1880
  }
1881
+ /** @enumType */
1882
+ export type AlignmentWithLiterals = Alignment | 'CENTER' | 'LEFT' | 'RIGHT';
1837
1883
  export interface FileData {
1838
1884
  /** Styling for the file's container. */
1839
1885
  containerData?: PluginContainerData;
@@ -1865,6 +1911,8 @@ export declare enum ViewMode {
1865
1911
  /** Mini PDF view */
1866
1912
  MINI = "MINI"
1867
1913
  }
1914
+ /** @enumType */
1915
+ export type ViewModeWithLiterals = ViewMode | 'NONE' | 'FULL' | 'MINI';
1868
1916
  export interface FileSource extends FileSourceDataOneOf {
1869
1917
  /** The absolute URL for the file's source. */
1870
1918
  url?: string | null;
@@ -1897,7 +1945,7 @@ export interface PDFSettings {
1897
1945
  * `FULL` : A full page view of the PDF is displayed.
1898
1946
  * `MINI` : A mini view of the PDF is displayed.
1899
1947
  */
1900
- viewMode?: ViewMode;
1948
+ viewMode?: ViewModeWithLiterals;
1901
1949
  /** Sets whether the PDF download button is disabled. Defaults to `false`. */
1902
1950
  disableDownload?: boolean | null;
1903
1951
  /** Sets whether the PDF print button is disabled. Defaults to `false`. */
@@ -1984,18 +2032,24 @@ export declare enum LayoutType {
1984
2032
  /** Fullsize images type */
1985
2033
  FULLSIZE = "FULLSIZE"
1986
2034
  }
2035
+ /** @enumType */
2036
+ export type LayoutTypeWithLiterals = LayoutType | 'COLLAGE' | 'MASONRY' | 'GRID' | 'THUMBNAIL' | 'SLIDER' | 'SLIDESHOW' | 'PANORAMA' | 'COLUMN' | 'MAGIC' | 'FULLSIZE';
1987
2037
  export declare enum Orientation {
1988
2038
  /** Rows Orientation */
1989
2039
  ROWS = "ROWS",
1990
2040
  /** Columns Orientation */
1991
2041
  COLUMNS = "COLUMNS"
1992
2042
  }
2043
+ /** @enumType */
2044
+ export type OrientationWithLiterals = Orientation | 'ROWS' | 'COLUMNS';
1993
2045
  export declare enum Crop {
1994
2046
  /** Crop to fill */
1995
2047
  FILL = "FILL",
1996
2048
  /** Crop to fit */
1997
2049
  FIT = "FIT"
1998
2050
  }
2051
+ /** @enumType */
2052
+ export type CropWithLiterals = Crop | 'FILL' | 'FIT';
1999
2053
  export declare enum ThumbnailsAlignment {
2000
2054
  /** Top alignment */
2001
2055
  TOP = "TOP",
@@ -2008,13 +2062,15 @@ export declare enum ThumbnailsAlignment {
2008
2062
  /** No thumbnail */
2009
2063
  NONE = "NONE"
2010
2064
  }
2065
+ /** @enumType */
2066
+ export type ThumbnailsAlignmentWithLiterals = ThumbnailsAlignment | 'TOP' | 'RIGHT' | 'BOTTOM' | 'LEFT' | 'NONE';
2011
2067
  export interface Layout {
2012
2068
  /** Gallery layout type. */
2013
- type?: LayoutType;
2069
+ type?: LayoutTypeWithLiterals;
2014
2070
  /** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
2015
2071
  horizontalScroll?: boolean | null;
2016
2072
  /** Gallery orientation. */
2017
- orientation?: Orientation;
2073
+ orientation?: OrientationWithLiterals;
2018
2074
  /** The number of columns to display on full size screens. */
2019
2075
  numberOfColumns?: number | null;
2020
2076
  /** The number of columns to display on mobile screens. */
@@ -2026,13 +2082,13 @@ export interface ItemStyle {
2026
2082
  /** Item ratio */
2027
2083
  ratio?: number | null;
2028
2084
  /** Sets how item images are cropped. */
2029
- crop?: Crop;
2085
+ crop?: CropWithLiterals;
2030
2086
  /** The spacing between items in pixels. */
2031
2087
  spacing?: number | null;
2032
2088
  }
2033
2089
  export interface Thumbnails {
2034
2090
  /** Thumbnail alignment. */
2035
- placement?: ThumbnailsAlignment;
2091
+ placement?: ThumbnailsAlignmentWithLiterals;
2036
2092
  /** Spacing between thumbnails in pixels. */
2037
2093
  spacing?: number | null;
2038
2094
  }
@@ -2048,7 +2104,7 @@ export interface GIFData {
2048
2104
  /** Width in pixels. */
2049
2105
  width?: number;
2050
2106
  /** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
2051
- gifType?: GIFType;
2107
+ gifType?: GIFTypeWithLiterals;
2052
2108
  }
2053
2109
  export interface GIF {
2054
2110
  /**
@@ -2071,6 +2127,8 @@ export declare enum GIFType {
2071
2127
  NORMAL = "NORMAL",
2072
2128
  STICKER = "STICKER"
2073
2129
  }
2130
+ /** @enumType */
2131
+ export type GIFTypeWithLiterals = GIFType | 'NORMAL' | 'STICKER';
2074
2132
  export interface HeadingData {
2075
2133
  /** Heading level from 1-6. */
2076
2134
  level?: number;
@@ -2092,7 +2150,7 @@ export interface HTMLData extends HTMLDataDataOneOf {
2092
2150
  /** Styling for the HTML node's container. Height property is irrelevant for HTML embeds when autoHeight is set to `true`. */
2093
2151
  containerData?: PluginContainerData;
2094
2152
  /** The type of HTML code. */
2095
- source?: Source;
2153
+ source?: SourceWithLiterals;
2096
2154
  /** If container height is aligned with its content height. Defaults to `true`. */
2097
2155
  autoHeight?: boolean | null;
2098
2156
  }
@@ -2112,6 +2170,8 @@ export declare enum Source {
2112
2170
  HTML = "HTML",
2113
2171
  ADSENSE = "ADSENSE"
2114
2172
  }
2173
+ /** @enumType */
2174
+ export type SourceWithLiterals = Source | 'HTML' | 'ADSENSE';
2115
2175
  export interface ImageData {
2116
2176
  /** Styling for the image's container. */
2117
2177
  containerData?: PluginContainerData;
@@ -2176,6 +2236,8 @@ export declare enum Position {
2176
2236
  /** Thumbnail hidden and not displayed */
2177
2237
  HIDDEN = "HIDDEN"
2178
2238
  }
2239
+ /** @enumType */
2240
+ export type PositionWithLiterals = Position | 'START' | 'END' | 'TOP' | 'HIDDEN';
2179
2241
  export interface LinkPreviewDataStyles {
2180
2242
  /**
2181
2243
  * Background color as a hexadecimal value.
@@ -2207,7 +2269,7 @@ export interface LinkPreviewDataStyles {
2207
2269
  */
2208
2270
  borderColor?: string | null;
2209
2271
  /** Position of thumbnail. Defaults to `START`. */
2210
- thumbnailPosition?: Position;
2272
+ thumbnailPosition?: PositionWithLiterals;
2211
2273
  }
2212
2274
  export interface MapData {
2213
2275
  /** Styling for the map's container. */
@@ -2237,7 +2299,7 @@ export interface MapSettings {
2237
2299
  /** Initial zoom value. */
2238
2300
  initialZoom?: number | null;
2239
2301
  /** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
2240
- mapType?: MapType;
2302
+ mapType?: MapTypeWithLiterals;
2241
2303
  }
2242
2304
  export declare enum MapType {
2243
2305
  /** Roadmap map type */
@@ -2249,6 +2311,8 @@ export declare enum MapType {
2249
2311
  /** Terrain map type */
2250
2312
  TERRAIN = "TERRAIN"
2251
2313
  }
2314
+ /** @enumType */
2315
+ export type MapTypeWithLiterals = MapType | 'ROADMAP' | 'SATELITE' | 'HYBRID' | 'TERRAIN';
2252
2316
  export interface ParagraphData {
2253
2317
  /** Styling for the paragraph text. */
2254
2318
  textStyle?: TextStyle;
@@ -2275,17 +2339,21 @@ export declare enum ViewRole {
2275
2339
  /** Anyone can see the results, even if one didn't vote */
2276
2340
  EVERYONE = "EVERYONE"
2277
2341
  }
2342
+ /** @enumType */
2343
+ export type ViewRoleWithLiterals = ViewRole | 'CREATOR' | 'VOTERS' | 'EVERYONE';
2278
2344
  export declare enum VoteRole {
2279
2345
  /** Logged in member */
2280
2346
  SITE_MEMBERS = "SITE_MEMBERS",
2281
2347
  /** Anyone */
2282
2348
  ALL = "ALL"
2283
2349
  }
2350
+ /** @enumType */
2351
+ export type VoteRoleWithLiterals = VoteRole | 'SITE_MEMBERS' | 'ALL';
2284
2352
  export interface Permissions {
2285
2353
  /** Sets who can view the poll results. */
2286
- view?: ViewRole;
2354
+ view?: ViewRoleWithLiterals;
2287
2355
  /** Sets who can vote. */
2288
- vote?: VoteRole;
2356
+ vote?: VoteRoleWithLiterals;
2289
2357
  /** Sets whether one voter can vote multiple times. Defaults to `false`. */
2290
2358
  allowMultipleVotes?: boolean | null;
2291
2359
  }
@@ -2311,17 +2379,21 @@ export declare enum PollLayoutType {
2311
2379
  /** Grid */
2312
2380
  GRID = "GRID"
2313
2381
  }
2382
+ /** @enumType */
2383
+ export type PollLayoutTypeWithLiterals = PollLayoutType | 'LIST' | 'GRID';
2314
2384
  export declare enum PollLayoutDirection {
2315
2385
  /** Left-to-right */
2316
2386
  LTR = "LTR",
2317
2387
  /** Right-to-left */
2318
2388
  RTL = "RTL"
2319
2389
  }
2390
+ /** @enumType */
2391
+ export type PollLayoutDirectionWithLiterals = PollLayoutDirection | 'LTR' | 'RTL';
2320
2392
  export interface PollLayout {
2321
2393
  /** The layout for displaying the voting options. */
2322
- type?: PollLayoutType;
2394
+ type?: PollLayoutTypeWithLiterals;
2323
2395
  /** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
2324
- direction?: PollLayoutDirection;
2396
+ direction?: PollLayoutDirectionWithLiterals;
2325
2397
  /** Sets whether to display the main poll image. Defaults to `false`. */
2326
2398
  enableImage?: boolean | null;
2327
2399
  }
@@ -2337,6 +2409,8 @@ export declare enum BackgroundType {
2337
2409
  /** Gradiant background type */
2338
2410
  GRADIENT = "GRADIENT"
2339
2411
  }
2412
+ /** @enumType */
2413
+ export type BackgroundTypeWithLiterals = BackgroundType | 'COLOR' | 'IMAGE' | 'GRADIENT';
2340
2414
  export interface Gradient {
2341
2415
  /** The gradient angle in degrees. */
2342
2416
  angle?: number | null;
@@ -2362,7 +2436,7 @@ export interface Background extends BackgroundBackgroundOneOf {
2362
2436
  /** Details for a gradient background. */
2363
2437
  gradient?: Gradient;
2364
2438
  /** Background type. For each option, include the relevant details. */
2365
- type?: BackgroundType;
2439
+ type?: BackgroundTypeWithLiterals;
2366
2440
  }
2367
2441
  /** @oneof */
2368
2442
  export interface BackgroundBackgroundOneOf {
@@ -2441,7 +2515,7 @@ export interface Decoration extends DecorationDataOneOf {
2441
2515
  /** Data for a strikethrough decoration. Defaults to `true`. */
2442
2516
  strikethroughData?: boolean | null;
2443
2517
  /** The type of decoration to apply. */
2444
- type?: DecorationType;
2518
+ type?: DecorationTypeWithLiterals;
2445
2519
  }
2446
2520
  /** @oneof */
2447
2521
  export interface DecorationDataOneOf {
@@ -2479,6 +2553,8 @@ export declare enum DecorationType {
2479
2553
  EXTERNAL = "EXTERNAL",
2480
2554
  STRIKETHROUGH = "STRIKETHROUGH"
2481
2555
  }
2556
+ /** @enumType */
2557
+ export type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL' | 'STRIKETHROUGH';
2482
2558
  export interface AnchorData {
2483
2559
  /** The target node's ID. */
2484
2560
  anchor?: string;
@@ -2503,7 +2579,7 @@ export interface MentionData {
2503
2579
  }
2504
2580
  export interface FontSizeData {
2505
2581
  /** The units used for the font size. */
2506
- unit?: FontType;
2582
+ unit?: FontTypeWithLiterals;
2507
2583
  /** Font size value. */
2508
2584
  value?: number | null;
2509
2585
  }
@@ -2511,6 +2587,8 @@ export declare enum FontType {
2511
2587
  PX = "PX",
2512
2588
  EM = "EM"
2513
2589
  }
2590
+ /** @enumType */
2591
+ export type FontTypeWithLiterals = FontType | 'PX' | 'EM';
2514
2592
  export interface SpoilerData {
2515
2593
  /** Spoiler ID. */
2516
2594
  id?: string | null;
@@ -2521,7 +2599,7 @@ export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
2521
2599
  /** Data for embedded Wix Events content. */
2522
2600
  eventData?: EventData;
2523
2601
  /** The type of Wix App content being embedded. */
2524
- type?: AppType;
2602
+ type?: AppTypeWithLiterals;
2525
2603
  /** The ID of the embedded content. */
2526
2604
  itemId?: string | null;
2527
2605
  /** The name of the embedded content. */
@@ -2548,6 +2626,8 @@ export declare enum AppType {
2548
2626
  EVENT = "EVENT",
2549
2627
  BOOKING = "BOOKING"
2550
2628
  }
2629
+ /** @enumType */
2630
+ export type AppTypeWithLiterals = AppType | 'PRODUCT' | 'EVENT' | 'BOOKING';
2551
2631
  export interface BookingData {
2552
2632
  /** Booking duration in minutes. */
2553
2633
  durations?: string | null;
@@ -2626,9 +2706,9 @@ export interface CollapsibleListData {
2626
2706
  /** If `true`, only one item can be expanded at a time. Defaults to `false`. */
2627
2707
  expandOnlyOne?: boolean | null;
2628
2708
  /** Sets which items are expanded when the page loads. */
2629
- initialExpandedItems?: InitialExpandedItems;
2709
+ initialExpandedItems?: InitialExpandedItemsWithLiterals;
2630
2710
  /** The direction of the text in the list. Either left-to-right or right-to-left. */
2631
- direction?: Direction;
2711
+ direction?: DirectionWithLiterals;
2632
2712
  /** If `true`, The collapsible item will appear in search results as an FAQ. */
2633
2713
  isQapageData?: boolean | null;
2634
2714
  }
@@ -2640,12 +2720,16 @@ export declare enum InitialExpandedItems {
2640
2720
  /** All items collapsed initally */
2641
2721
  NONE = "NONE"
2642
2722
  }
2723
+ /** @enumType */
2724
+ export type InitialExpandedItemsWithLiterals = InitialExpandedItems | 'FIRST' | 'ALL' | 'NONE';
2643
2725
  export declare enum Direction {
2644
2726
  /** Left-to-right */
2645
2727
  LTR = "LTR",
2646
2728
  /** Right-to-left */
2647
2729
  RTL = "RTL"
2648
2730
  }
2731
+ /** @enumType */
2732
+ export type DirectionWithLiterals = Direction | 'LTR' | 'RTL';
2649
2733
  export interface TableData {
2650
2734
  /** Styling for the table's container. */
2651
2735
  containerData?: PluginContainerData;
@@ -2683,9 +2767,11 @@ export declare enum VerticalAlignment {
2683
2767
  /** Bottom alignment */
2684
2768
  BOTTOM = "BOTTOM"
2685
2769
  }
2770
+ /** @enumType */
2771
+ export type VerticalAlignmentWithLiterals = VerticalAlignment | 'TOP' | 'MIDDLE' | 'BOTTOM';
2686
2772
  export interface CellStyle {
2687
2773
  /** Vertical alignment for the cell's text. */
2688
- verticalAlignment?: VerticalAlignment;
2774
+ verticalAlignment?: VerticalAlignmentWithLiterals;
2689
2775
  /**
2690
2776
  * Cell background color as a hexadecimal value.
2691
2777
  * @format COLOR_HEX
@@ -2724,6 +2810,8 @@ export declare enum NullValue {
2724
2810
  /** Null value. */
2725
2811
  NULL_VALUE = "NULL_VALUE"
2726
2812
  }
2813
+ /** @enumType */
2814
+ export type NullValueWithLiterals = NullValue | 'NULL_VALUE';
2727
2815
  /**
2728
2816
  * `ListValue` is a wrapper around a repeated field of values.
2729
2817
  *
@@ -2821,7 +2909,7 @@ export interface TextNodeStyle {
2821
2909
  }
2822
2910
  export interface Badge {
2823
2911
  /** Badge type. */
2824
- type?: Type;
2912
+ type?: TypeWithLiterals;
2825
2913
  /**
2826
2914
  * Badge text.
2827
2915
  * @maxLength 50
@@ -2838,6 +2926,8 @@ export declare enum Type {
2838
2926
  /** 3rd priority badge type. */
2839
2927
  THIRD_PRIORITY = "THIRD_PRIORITY"
2840
2928
  }
2929
+ /** @enumType */
2930
+ export type TypeWithLiterals = Type | 'UNKNOWN_BADGE_TYPE' | 'FIRST_PRIORITY' | 'SECOND_PRIORITY' | 'THIRD_PRIORITY';
2841
2931
  export interface DiscardDraftRequest {
2842
2932
  /**
2843
2933
  * Event ID to which the form belongs.
@@ -2852,25 +2942,21 @@ export interface DomainEvent extends DomainEventBodyOneOf {
2852
2942
  updatedEvent?: EntityUpdatedEvent;
2853
2943
  deletedEvent?: EntityDeletedEvent;
2854
2944
  actionEvent?: ActionEvent;
2855
- /**
2856
- * Unique event ID.
2857
- * Allows clients to ignore duplicate webhooks.
2858
- */
2945
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
2859
2946
  id?: string;
2860
2947
  /**
2861
- * Assumes actions are also always typed to an entity_type
2862
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
2948
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
2949
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
2863
2950
  */
2864
2951
  entityFqdn?: string;
2865
2952
  /**
2866
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
2867
- * This is although the created/updated/deleted notion is duplication of the oneof types
2868
- * Example: created/updated/deleted/started/completed/email_opened
2953
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
2954
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
2869
2955
  */
2870
2956
  slug?: string;
2871
2957
  /** ID of the entity associated with the event. */
2872
2958
  entityId?: string;
2873
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
2959
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
2874
2960
  eventTime?: Date | null;
2875
2961
  /**
2876
2962
  * Whether the event was triggered as a result of a privacy regulation application
@@ -2880,12 +2966,8 @@ export interface DomainEvent extends DomainEventBodyOneOf {
2880
2966
  /** If present, indicates the action that triggered the event. */
2881
2967
  originatedFrom?: string | null;
2882
2968
  /**
2883
- * A sequence number defining the order of updates to the underlying entity.
2884
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
2885
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
2886
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
2887
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
2888
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
2969
+ * 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.
2970
+ * 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.
2889
2971
  */
2890
2972
  entityEventSequence?: string | null;
2891
2973
  }
@@ -2913,7 +2995,7 @@ export interface EntityUpdatedEvent {
2913
2995
  currentEntityAsJson?: string;
2914
2996
  }
2915
2997
  export interface EntityDeletedEvent {
2916
- /** Entity that was deleted */
2998
+ /** Entity that was deleted. */
2917
2999
  deletedEntityAsJson?: string | null;
2918
3000
  }
2919
3001
  export interface ActionEvent {
@@ -2957,7 +3039,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
2957
3039
  */
2958
3040
  appId?: string;
2959
3041
  /** @readonly */
2960
- identityType?: WebhookIdentityType;
3042
+ identityType?: WebhookIdentityTypeWithLiterals;
2961
3043
  }
2962
3044
  /** @oneof */
2963
3045
  export interface IdentificationDataIdOneOf {
@@ -2989,3 +3071,5 @@ export declare enum WebhookIdentityType {
2989
3071
  WIX_USER = "WIX_USER",
2990
3072
  APP = "APP"
2991
3073
  }
3074
+ /** @enumType */
3075
+ export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';