@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.
@@ -27,7 +27,7 @@ export interface Form {
27
27
  */
28
28
  export interface InputControl {
29
29
  /** Field control type. */
30
- type?: InputControlType;
30
+ type?: InputControlTypeWithLiterals;
31
31
  /** Whether the control is mandatory (such as `name` & `email`). When `true`, only the label can be changed. */
32
32
  system?: boolean;
33
33
  /**
@@ -74,6 +74,8 @@ export declare enum InputControlType {
74
74
  /** Fields for entering year, month, and day. */
75
75
  DATE = "DATE"
76
76
  }
77
+ /** @enumType */
78
+ export type InputControlTypeWithLiterals = InputControlType | 'INPUT' | 'TEXTAREA' | 'DROPDOWN' | 'RADIO' | 'CHECKBOX' | 'NAME' | 'GUEST_CONTROL' | 'ADDRESS_SHORT' | 'ADDRESS_FULL' | 'DATE';
77
79
  /** Child inputs. */
78
80
  export interface Input {
79
81
  /** Field name. */
@@ -97,7 +99,7 @@ export interface Input {
97
99
  * Type which determines field format.
98
100
  * Used to validate submitted response.
99
101
  */
100
- type?: ValueType;
102
+ type?: ValueTypeWithLiterals;
101
103
  /**
102
104
  * The maximum number of accepted values for array input.
103
105
  *
@@ -124,6 +126,8 @@ export declare enum ValueType {
124
126
  DATE_TIME = "DATE_TIME",
125
127
  ADDRESS = "ADDRESS"
126
128
  }
129
+ /** @enumType */
130
+ export type ValueTypeWithLiterals = ValueType | 'TEXT' | 'NUMBER' | 'TEXT_ARRAY' | 'DATE_TIME' | 'ADDRESS';
127
131
  /**
128
132
  * Describes initially selected option when an input has multiple choices.
129
133
  * Defaults to first (0th) option if not configured.
@@ -284,6 +288,8 @@ export declare enum RequestedFields {
284
288
  /** Include soft deleted input controls in the response. */
285
289
  DELETED = "DELETED"
286
290
  }
291
+ /** @enumType */
292
+ export type RequestedFieldsWithLiterals = RequestedFields | 'UNKNOWN_REQUESTED_FIELD' | 'DELETED';
287
293
  export interface GetFormResponse {
288
294
  /**
289
295
  * Currently published event form.
@@ -659,7 +665,7 @@ export interface Location {
659
665
  */
660
666
  address?: string | null;
661
667
  /** Location type. */
662
- type?: LocationType;
668
+ type?: LocationTypeWithLiterals;
663
669
  /**
664
670
  * Full address derived from formatted single line `address`.
665
671
  * When `full_address` is used to create or update the event, deprecated `address` and `coordinates` are ignored.
@@ -695,6 +701,8 @@ export declare enum LocationType {
695
701
  VENUE = "VENUE",
696
702
  ONLINE = "ONLINE"
697
703
  }
704
+ /** @enumType */
705
+ export type LocationTypeWithLiterals = LocationType | 'VENUE' | 'ONLINE';
698
706
  /** Physical address */
699
707
  export interface Address extends AddressStreetOneOf {
700
708
  /** a break down of the street to number and street name */
@@ -774,6 +782,8 @@ export declare enum SubdivisionType {
774
782
  /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
775
783
  COUNTRY = "COUNTRY"
776
784
  }
785
+ /** @enumType */
786
+ 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';
777
787
  export interface ScheduleConfig {
778
788
  /**
779
789
  * Defines event as TBD (To Be Determined) schedule.
@@ -817,7 +827,7 @@ export interface Recurrences {
817
827
  * Recurrence status.
818
828
  * @readonly
819
829
  */
820
- status?: Status;
830
+ status?: StatusWithLiterals;
821
831
  }
822
832
  export interface Occurrence {
823
833
  /** Event start timestamp. */
@@ -844,6 +854,8 @@ export declare enum Status {
844
854
  /** Marks the most recent canceled occurrence of the recurring event. */
845
855
  RECURRING_LAST_CANCELED = "RECURRING_LAST_CANCELED"
846
856
  }
857
+ /** @enumType */
858
+ export type StatusWithLiterals = Status | 'ONE_TIME' | 'RECURRING' | 'RECURRING_NEXT' | 'RECURRING_LAST_ENDED' | 'RECURRING_LAST_CANCELED';
847
859
  export interface Event {
848
860
  /**
849
861
  * Event ID.
@@ -872,7 +884,7 @@ export interface Event {
872
884
  /** Event modified timestamp. */
873
885
  modified?: Date | null;
874
886
  /** Event status. */
875
- status?: EventStatus;
887
+ status?: EventStatusWithLiterals;
876
888
  /** RSVP or ticketing registration details. */
877
889
  registration?: Registration;
878
890
  /** "Add to calendar" URLs. */
@@ -938,11 +950,13 @@ export declare enum EventStatus {
938
950
  /** Event was canceled */
939
951
  CANCELED = "CANCELED"
940
952
  }
953
+ /** @enumType */
954
+ export type EventStatusWithLiterals = EventStatus | 'SCHEDULED' | 'STARTED' | 'ENDED' | 'CANCELED';
941
955
  export interface Registration {
942
956
  /** Event type. */
943
- type?: EventType;
957
+ type?: EventTypeWithLiterals;
944
958
  /** Event registration status. */
945
- status?: RegistrationStatus;
959
+ status?: RegistrationStatusWithLiterals;
946
960
  /** RSVP collection details. */
947
961
  rsvpCollection?: RsvpCollection;
948
962
  /** Ticketing details. */
@@ -950,9 +964,9 @@ export interface Registration {
950
964
  /** External registration details. */
951
965
  external?: ExternalEvent;
952
966
  /** Types of users allowed to register. */
953
- restrictedTo?: VisitorType;
967
+ restrictedTo?: VisitorTypeWithLiterals;
954
968
  /** Initial event type which was set when creating an event. */
955
- initialType?: EventType;
969
+ initialType?: EventTypeWithLiterals;
956
970
  }
957
971
  export declare enum EventType {
958
972
  /** Type not available for this request fieldset */
@@ -966,6 +980,8 @@ export declare enum EventType {
966
980
  /** Registration not available */
967
981
  NO_REGISTRATION = "NO_REGISTRATION"
968
982
  }
983
+ /** @enumType */
984
+ export type EventTypeWithLiterals = EventType | 'NA_EVENT_TYPE' | 'RSVP' | 'TICKETS' | 'EXTERNAL' | 'NO_REGISTRATION';
969
985
  export declare enum RegistrationStatus {
970
986
  /** Registration status is not applicable */
971
987
  NA_REGISTRATION_STATUS = "NA_REGISTRATION_STATUS",
@@ -984,13 +1000,15 @@ export declare enum RegistrationStatus {
984
1000
  /** Registration will be open via RSVP */
985
1001
  SCHEDULED_RSVP = "SCHEDULED_RSVP"
986
1002
  }
1003
+ /** @enumType */
1004
+ export type RegistrationStatusWithLiterals = RegistrationStatus | 'NA_REGISTRATION_STATUS' | 'CLOSED' | 'CLOSED_MANUALLY' | 'OPEN_RSVP' | 'OPEN_RSVP_WAITLIST' | 'OPEN_TICKETS' | 'OPEN_EXTERNAL' | 'SCHEDULED_RSVP';
987
1005
  export interface RsvpCollection {
988
1006
  /** RSVP collection configuration. */
989
1007
  config?: RsvpCollectionConfig;
990
1008
  }
991
1009
  export interface RsvpCollectionConfig {
992
1010
  /** Defines the supported RSVP statuses. */
993
- rsvpStatusOptions?: RsvpStatusOptions;
1011
+ rsvpStatusOptions?: RsvpStatusOptionsWithLiterals;
994
1012
  /**
995
1013
  * Total guest limit available to register to the event.
996
1014
  * Additional guests per RSVP are counted towards total guests.
@@ -1009,6 +1027,8 @@ export declare enum RsvpStatusOptions {
1009
1027
  /** YES and NO RSVP status options are available for the registration */
1010
1028
  YES_AND_NO = "YES_AND_NO"
1011
1029
  }
1030
+ /** @enumType */
1031
+ export type RsvpStatusOptionsWithLiterals = RsvpStatusOptions | 'YES_ONLY' | 'YES_AND_NO';
1012
1032
  export interface Ticketing {
1013
1033
  /**
1014
1034
  * Deprecated.
@@ -1069,7 +1089,7 @@ export interface TicketingConfig {
1069
1089
  }
1070
1090
  export interface TaxConfig {
1071
1091
  /** Tax application settings. */
1072
- type?: TaxType;
1092
+ type?: TaxTypeWithLiterals;
1073
1093
  /**
1074
1094
  * Tax name.
1075
1095
  * @minLength 1
@@ -1092,6 +1112,8 @@ export declare enum TaxType {
1092
1112
  /** Tax is added to the final total at the checkout. */
1093
1113
  ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
1094
1114
  }
1115
+ /** @enumType */
1116
+ export type TaxTypeWithLiterals = TaxType | 'INCLUDED' | 'ADDED' | 'ADDED_AT_CHECKOUT';
1095
1117
  export interface Money {
1096
1118
  /**
1097
1119
  * *Deprecated:** Use `value` instead.
@@ -1122,6 +1144,8 @@ export declare enum VisitorType {
1122
1144
  /** Site visitor or member */
1123
1145
  VISITOR_OR_MEMBER = "VISITOR_OR_MEMBER"
1124
1146
  }
1147
+ /** @enumType */
1148
+ export type VisitorTypeWithLiterals = VisitorType | 'VISITOR' | 'MEMBER' | 'VISITOR_OR_MEMBER';
1125
1149
  export interface CalendarLinks {
1126
1150
  /** "Add to Google calendar" URL. */
1127
1151
  google?: string;
@@ -1196,7 +1220,7 @@ export interface OnlineConferencingConfig {
1196
1220
  */
1197
1221
  providerId?: string | null;
1198
1222
  /** Conference type */
1199
- conferenceType?: ConferenceType;
1223
+ conferenceType?: ConferenceTypeWithLiterals;
1200
1224
  }
1201
1225
  export declare enum ConferenceType {
1202
1226
  /** Everyone in the meeting can publish and subscribe video and audio. */
@@ -1204,6 +1228,8 @@ export declare enum ConferenceType {
1204
1228
  /** Guests can only subscribe to video and audio. */
1205
1229
  WEBINAR = "WEBINAR"
1206
1230
  }
1231
+ /** @enumType */
1232
+ export type ConferenceTypeWithLiterals = ConferenceType | 'MEETING' | 'WEBINAR';
1207
1233
  export interface OnlineConferencingSession {
1208
1234
  /**
1209
1235
  * Link for event host to start the online conference session.
@@ -1348,7 +1374,7 @@ export interface Category {
1348
1374
  * **Note:** The WIX_EVENTS.MANAGE_AUTO_CATEGORIES permission scope is required to use states other than `MANUAL`.
1349
1375
  * @maxSize 3
1350
1376
  */
1351
- states?: State[];
1377
+ states?: StateWithLiterals[];
1352
1378
  }
1353
1379
  export interface CategoryCounts {
1354
1380
  /** Total number of draft events assigned to the category. */
@@ -1366,6 +1392,8 @@ export declare enum State {
1366
1392
  /** Category is hidden. */
1367
1393
  HIDDEN = "HIDDEN"
1368
1394
  }
1395
+ /** @enumType */
1396
+ export type StateWithLiterals = State | 'MANUAL' | 'AUTO' | 'RECURRING_EVENT' | 'HIDDEN';
1369
1397
  export interface EventDisplaySettings {
1370
1398
  /** Whether event details button is hidden. Only available for events with no registration. */
1371
1399
  hideEventDetailsButton?: boolean | null;
@@ -1438,9 +1466,9 @@ export interface Node extends NodeDataOneOf {
1438
1466
  /** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
1439
1467
  layoutCellData?: LayoutCellData;
1440
1468
  /** 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. */
1441
- type?: NodeType;
1469
+ type?: NodeTypeWithLiterals;
1442
1470
  /** Node ID. */
1443
- _id?: string;
1471
+ id?: string;
1444
1472
  /** A list of child nodes. */
1445
1473
  nodes?: Node[];
1446
1474
  /** Padding and background color styling for the node. */
@@ -1539,6 +1567,8 @@ export declare enum NodeType {
1539
1567
  LAYOUT = "LAYOUT",
1540
1568
  LAYOUT_CELL = "LAYOUT_CELL"
1541
1569
  }
1570
+ /** @enumType */
1571
+ 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';
1542
1572
  export interface NodeStyle {
1543
1573
  /** The top padding value in pixels. */
1544
1574
  paddingTop?: string | null;
@@ -1551,7 +1581,7 @@ export interface ButtonData {
1551
1581
  /** Styling for the button's container. */
1552
1582
  containerData?: PluginContainerData;
1553
1583
  /** The button type. */
1554
- type?: ButtonDataType;
1584
+ type?: ButtonDataTypeWithLiterals;
1555
1585
  /** Styling for the button. */
1556
1586
  styles?: Styles;
1557
1587
  /** The text to display on the button. */
@@ -1592,7 +1622,7 @@ export interface PluginContainerData {
1592
1622
  /** The width of the node when it's displayed. */
1593
1623
  width?: PluginContainerDataWidth;
1594
1624
  /** The node's alignment within its container. */
1595
- alignment?: PluginContainerDataAlignment;
1625
+ alignment?: PluginContainerDataAlignmentWithLiterals;
1596
1626
  /** Spoiler cover settings for the node. */
1597
1627
  spoiler?: Spoiler;
1598
1628
  /** The height of the node when it's displayed. */
@@ -1610,6 +1640,8 @@ export declare enum WidthType {
1610
1640
  /** coast-to-coast display */
1611
1641
  FULL_WIDTH = "FULL_WIDTH"
1612
1642
  }
1643
+ /** @enumType */
1644
+ export type WidthTypeWithLiterals = WidthType | 'CONTENT' | 'SMALL' | 'ORIGINAL' | 'FULL_WIDTH';
1613
1645
  export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
1614
1646
  /**
1615
1647
  * One of the following predefined width options:
@@ -1618,7 +1650,7 @@ export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOn
1618
1650
  * `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
1619
1651
  * `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
1620
1652
  */
1621
- size?: WidthType;
1653
+ size?: WidthTypeWithLiterals;
1622
1654
  /** A custom width value in pixels. */
1623
1655
  custom?: string | null;
1624
1656
  }
@@ -1631,7 +1663,7 @@ export interface PluginContainerDataWidthDataOneOf {
1631
1663
  * `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
1632
1664
  * `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
1633
1665
  */
1634
- size?: WidthType;
1666
+ size?: WidthTypeWithLiterals;
1635
1667
  /** A custom width value in pixels. */
1636
1668
  custom?: string | null;
1637
1669
  }
@@ -1643,6 +1675,8 @@ export declare enum PluginContainerDataAlignment {
1643
1675
  /** Right Alignment */
1644
1676
  RIGHT = "RIGHT"
1645
1677
  }
1678
+ /** @enumType */
1679
+ export type PluginContainerDataAlignmentWithLiterals = PluginContainerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
1646
1680
  export interface Spoiler {
1647
1681
  /** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
1648
1682
  enabled?: boolean | null;
@@ -1661,6 +1695,8 @@ export declare enum ButtonDataType {
1661
1695
  /** Triggers custom action that is defined in plugin configuration by the consumer */
1662
1696
  ACTION = "ACTION"
1663
1697
  }
1698
+ /** @enumType */
1699
+ export type ButtonDataTypeWithLiterals = ButtonDataType | 'LINK' | 'ACTION';
1664
1700
  export interface Styles {
1665
1701
  /**
1666
1702
  * Deprecated: Use `borderWidth` and `borderRadius` instead.
@@ -1726,7 +1762,7 @@ export interface Link extends LinkDataOneOf {
1726
1762
  * `PARENT` - Opens the linked document in the link's parent frame.
1727
1763
  * `TOP` - Opens the linked document in the full body of the link's browser tab or window.
1728
1764
  */
1729
- target?: Target;
1765
+ target?: TargetWithLiterals;
1730
1766
  /** The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document. */
1731
1767
  rel?: Rel;
1732
1768
  /** A serialized object used for a custom or external link panel. */
@@ -1749,6 +1785,8 @@ export declare enum Target {
1749
1785
  /** Opens the linked document in the full body of the window */
1750
1786
  TOP = "TOP"
1751
1787
  }
1788
+ /** @enumType */
1789
+ export type TargetWithLiterals = Target | 'SELF' | 'BLANK' | 'PARENT' | 'TOP';
1752
1790
  export interface Rel {
1753
1791
  /** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
1754
1792
  nofollow?: boolean | null;
@@ -1765,7 +1803,7 @@ export interface CodeBlockData {
1765
1803
  }
1766
1804
  export interface TextStyle {
1767
1805
  /** Text alignment. Defaults to `AUTO`. */
1768
- textAlignment?: TextAlignment;
1806
+ textAlignment?: TextAlignmentWithLiterals;
1769
1807
  /** 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. */
1770
1808
  lineHeight?: string | null;
1771
1809
  }
@@ -1781,15 +1819,17 @@ export declare enum TextAlignment {
1781
1819
  /** 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 */
1782
1820
  JUSTIFY = "JUSTIFY"
1783
1821
  }
1822
+ /** @enumType */
1823
+ export type TextAlignmentWithLiterals = TextAlignment | 'AUTO' | 'LEFT' | 'RIGHT' | 'CENTER' | 'JUSTIFY';
1784
1824
  export interface DividerData {
1785
1825
  /** Styling for the divider's container. */
1786
1826
  containerData?: PluginContainerData;
1787
1827
  /** Divider line style. */
1788
- lineStyle?: LineStyle;
1828
+ lineStyle?: LineStyleWithLiterals;
1789
1829
  /** Divider width. */
1790
- width?: Width;
1830
+ width?: WidthWithLiterals;
1791
1831
  /** Divider alignment. */
1792
- alignment?: Alignment;
1832
+ alignment?: AlignmentWithLiterals;
1793
1833
  }
1794
1834
  export declare enum LineStyle {
1795
1835
  /** Single Line */
@@ -1801,6 +1841,8 @@ export declare enum LineStyle {
1801
1841
  /** Dotted Line */
1802
1842
  DOTTED = "DOTTED"
1803
1843
  }
1844
+ /** @enumType */
1845
+ export type LineStyleWithLiterals = LineStyle | 'SINGLE' | 'DOUBLE' | 'DASHED' | 'DOTTED';
1804
1846
  export declare enum Width {
1805
1847
  /** Large line */
1806
1848
  LARGE = "LARGE",
@@ -1809,6 +1851,8 @@ export declare enum Width {
1809
1851
  /** Small line */
1810
1852
  SMALL = "SMALL"
1811
1853
  }
1854
+ /** @enumType */
1855
+ export type WidthWithLiterals = Width | 'LARGE' | 'MEDIUM' | 'SMALL';
1812
1856
  export declare enum Alignment {
1813
1857
  /** Center alignment */
1814
1858
  CENTER = "CENTER",
@@ -1817,6 +1861,8 @@ export declare enum Alignment {
1817
1861
  /** Right alignment */
1818
1862
  RIGHT = "RIGHT"
1819
1863
  }
1864
+ /** @enumType */
1865
+ export type AlignmentWithLiterals = Alignment | 'CENTER' | 'LEFT' | 'RIGHT';
1820
1866
  export interface FileData {
1821
1867
  /** Styling for the file's container. */
1822
1868
  containerData?: PluginContainerData;
@@ -1848,6 +1894,8 @@ export declare enum ViewMode {
1848
1894
  /** Mini PDF view */
1849
1895
  MINI = "MINI"
1850
1896
  }
1897
+ /** @enumType */
1898
+ export type ViewModeWithLiterals = ViewMode | 'NONE' | 'FULL' | 'MINI';
1851
1899
  export interface FileSource extends FileSourceDataOneOf {
1852
1900
  /** The absolute URL for the file's source. */
1853
1901
  url?: string | null;
@@ -1857,7 +1905,7 @@ export interface FileSource extends FileSourceDataOneOf {
1857
1905
  */
1858
1906
  custom?: string | null;
1859
1907
  /** An ID that's resolved to a URL by a resolver function. */
1860
- _id?: string | null;
1908
+ id?: string | null;
1861
1909
  /** Indicates whether the file's source is private. Defaults to `false`. */
1862
1910
  private?: boolean | null;
1863
1911
  }
@@ -1871,7 +1919,7 @@ export interface FileSourceDataOneOf {
1871
1919
  */
1872
1920
  custom?: string | null;
1873
1921
  /** An ID that's resolved to a URL by a resolver function. */
1874
- _id?: string | null;
1922
+ id?: string | null;
1875
1923
  }
1876
1924
  export interface PDFSettings {
1877
1925
  /**
@@ -1880,7 +1928,7 @@ export interface PDFSettings {
1880
1928
  * `FULL` : A full page view of the PDF is displayed.
1881
1929
  * `MINI` : A mini view of the PDF is displayed.
1882
1930
  */
1883
- viewMode?: ViewMode;
1931
+ viewMode?: ViewModeWithLiterals;
1884
1932
  /** Sets whether the PDF download button is disabled. Defaults to `false`. */
1885
1933
  disableDownload?: boolean | null;
1886
1934
  /** Sets whether the PDF print button is disabled. Defaults to `false`. */
@@ -1967,18 +2015,24 @@ export declare enum LayoutType {
1967
2015
  /** Fullsize images type */
1968
2016
  FULLSIZE = "FULLSIZE"
1969
2017
  }
2018
+ /** @enumType */
2019
+ export type LayoutTypeWithLiterals = LayoutType | 'COLLAGE' | 'MASONRY' | 'GRID' | 'THUMBNAIL' | 'SLIDER' | 'SLIDESHOW' | 'PANORAMA' | 'COLUMN' | 'MAGIC' | 'FULLSIZE';
1970
2020
  export declare enum Orientation {
1971
2021
  /** Rows Orientation */
1972
2022
  ROWS = "ROWS",
1973
2023
  /** Columns Orientation */
1974
2024
  COLUMNS = "COLUMNS"
1975
2025
  }
2026
+ /** @enumType */
2027
+ export type OrientationWithLiterals = Orientation | 'ROWS' | 'COLUMNS';
1976
2028
  export declare enum Crop {
1977
2029
  /** Crop to fill */
1978
2030
  FILL = "FILL",
1979
2031
  /** Crop to fit */
1980
2032
  FIT = "FIT"
1981
2033
  }
2034
+ /** @enumType */
2035
+ export type CropWithLiterals = Crop | 'FILL' | 'FIT';
1982
2036
  export declare enum ThumbnailsAlignment {
1983
2037
  /** Top alignment */
1984
2038
  TOP = "TOP",
@@ -1991,13 +2045,15 @@ export declare enum ThumbnailsAlignment {
1991
2045
  /** No thumbnail */
1992
2046
  NONE = "NONE"
1993
2047
  }
2048
+ /** @enumType */
2049
+ export type ThumbnailsAlignmentWithLiterals = ThumbnailsAlignment | 'TOP' | 'RIGHT' | 'BOTTOM' | 'LEFT' | 'NONE';
1994
2050
  export interface Layout {
1995
2051
  /** Gallery layout type. */
1996
- type?: LayoutType;
2052
+ type?: LayoutTypeWithLiterals;
1997
2053
  /** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
1998
2054
  horizontalScroll?: boolean | null;
1999
2055
  /** Gallery orientation. */
2000
- orientation?: Orientation;
2056
+ orientation?: OrientationWithLiterals;
2001
2057
  /** The number of columns to display on full size screens. */
2002
2058
  numberOfColumns?: number | null;
2003
2059
  /** The number of columns to display on mobile screens. */
@@ -2009,13 +2065,13 @@ export interface ItemStyle {
2009
2065
  /** Item ratio */
2010
2066
  ratio?: number | null;
2011
2067
  /** Sets how item images are cropped. */
2012
- crop?: Crop;
2068
+ crop?: CropWithLiterals;
2013
2069
  /** The spacing between items in pixels. */
2014
2070
  spacing?: number | null;
2015
2071
  }
2016
2072
  export interface Thumbnails {
2017
2073
  /** Thumbnail alignment. */
2018
- placement?: ThumbnailsAlignment;
2074
+ placement?: ThumbnailsAlignmentWithLiterals;
2019
2075
  /** Spacing between thumbnails in pixels. */
2020
2076
  spacing?: number | null;
2021
2077
  }
@@ -2031,7 +2087,7 @@ export interface GIFData {
2031
2087
  /** Width in pixels. */
2032
2088
  width?: number;
2033
2089
  /** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
2034
- gifType?: GIFType;
2090
+ gifType?: GIFTypeWithLiterals;
2035
2091
  }
2036
2092
  export interface GIF {
2037
2093
  /**
@@ -2054,6 +2110,8 @@ export declare enum GIFType {
2054
2110
  NORMAL = "NORMAL",
2055
2111
  STICKER = "STICKER"
2056
2112
  }
2113
+ /** @enumType */
2114
+ export type GIFTypeWithLiterals = GIFType | 'NORMAL' | 'STICKER';
2057
2115
  export interface HeadingData {
2058
2116
  /** Heading level from 1-6. */
2059
2117
  level?: number;
@@ -2075,7 +2133,7 @@ export interface HTMLData extends HTMLDataDataOneOf {
2075
2133
  /** Styling for the HTML node's container. Height property is irrelevant for HTML embeds when autoHeight is set to `true`. */
2076
2134
  containerData?: PluginContainerData;
2077
2135
  /** The type of HTML code. */
2078
- source?: Source;
2136
+ source?: SourceWithLiterals;
2079
2137
  /** If container height is aligned with its content height. Defaults to `true`. */
2080
2138
  autoHeight?: boolean | null;
2081
2139
  }
@@ -2095,6 +2153,8 @@ export declare enum Source {
2095
2153
  HTML = "HTML",
2096
2154
  ADSENSE = "ADSENSE"
2097
2155
  }
2156
+ /** @enumType */
2157
+ export type SourceWithLiterals = Source | 'HTML' | 'ADSENSE';
2098
2158
  export interface ImageData {
2099
2159
  /** Styling for the image's container. */
2100
2160
  containerData?: PluginContainerData;
@@ -2159,6 +2219,8 @@ export declare enum Position {
2159
2219
  /** Thumbnail hidden and not displayed */
2160
2220
  HIDDEN = "HIDDEN"
2161
2221
  }
2222
+ /** @enumType */
2223
+ export type PositionWithLiterals = Position | 'START' | 'END' | 'TOP' | 'HIDDEN';
2162
2224
  export interface LinkPreviewDataStyles {
2163
2225
  /**
2164
2226
  * Background color as a hexadecimal value.
@@ -2190,7 +2252,7 @@ export interface LinkPreviewDataStyles {
2190
2252
  */
2191
2253
  borderColor?: string | null;
2192
2254
  /** Position of thumbnail. Defaults to `START`. */
2193
- thumbnailPosition?: Position;
2255
+ thumbnailPosition?: PositionWithLiterals;
2194
2256
  }
2195
2257
  export interface MapData {
2196
2258
  /** Styling for the map's container. */
@@ -2220,7 +2282,7 @@ export interface MapSettings {
2220
2282
  /** Initial zoom value. */
2221
2283
  initialZoom?: number | null;
2222
2284
  /** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
2223
- mapType?: MapType;
2285
+ mapType?: MapTypeWithLiterals;
2224
2286
  }
2225
2287
  export declare enum MapType {
2226
2288
  /** Roadmap map type */
@@ -2232,6 +2294,8 @@ export declare enum MapType {
2232
2294
  /** Terrain map type */
2233
2295
  TERRAIN = "TERRAIN"
2234
2296
  }
2297
+ /** @enumType */
2298
+ export type MapTypeWithLiterals = MapType | 'ROADMAP' | 'SATELITE' | 'HYBRID' | 'TERRAIN';
2235
2299
  export interface ParagraphData {
2236
2300
  /** Styling for the paragraph text. */
2237
2301
  textStyle?: TextStyle;
@@ -2258,23 +2322,27 @@ export declare enum ViewRole {
2258
2322
  /** Anyone can see the results, even if one didn't vote */
2259
2323
  EVERYONE = "EVERYONE"
2260
2324
  }
2325
+ /** @enumType */
2326
+ export type ViewRoleWithLiterals = ViewRole | 'CREATOR' | 'VOTERS' | 'EVERYONE';
2261
2327
  export declare enum VoteRole {
2262
2328
  /** Logged in member */
2263
2329
  SITE_MEMBERS = "SITE_MEMBERS",
2264
2330
  /** Anyone */
2265
2331
  ALL = "ALL"
2266
2332
  }
2333
+ /** @enumType */
2334
+ export type VoteRoleWithLiterals = VoteRole | 'SITE_MEMBERS' | 'ALL';
2267
2335
  export interface Permissions {
2268
2336
  /** Sets who can view the poll results. */
2269
- view?: ViewRole;
2337
+ view?: ViewRoleWithLiterals;
2270
2338
  /** Sets who can vote. */
2271
- vote?: VoteRole;
2339
+ vote?: VoteRoleWithLiterals;
2272
2340
  /** Sets whether one voter can vote multiple times. Defaults to `false`. */
2273
2341
  allowMultipleVotes?: boolean | null;
2274
2342
  }
2275
2343
  export interface Option {
2276
2344
  /** Option ID. */
2277
- _id?: string | null;
2345
+ id?: string | null;
2278
2346
  /** Option title. */
2279
2347
  title?: string | null;
2280
2348
  /** The image displayed with the option. */
@@ -2294,17 +2362,21 @@ export declare enum PollLayoutType {
2294
2362
  /** Grid */
2295
2363
  GRID = "GRID"
2296
2364
  }
2365
+ /** @enumType */
2366
+ export type PollLayoutTypeWithLiterals = PollLayoutType | 'LIST' | 'GRID';
2297
2367
  export declare enum PollLayoutDirection {
2298
2368
  /** Left-to-right */
2299
2369
  LTR = "LTR",
2300
2370
  /** Right-to-left */
2301
2371
  RTL = "RTL"
2302
2372
  }
2373
+ /** @enumType */
2374
+ export type PollLayoutDirectionWithLiterals = PollLayoutDirection | 'LTR' | 'RTL';
2303
2375
  export interface PollLayout {
2304
2376
  /** The layout for displaying the voting options. */
2305
- type?: PollLayoutType;
2377
+ type?: PollLayoutTypeWithLiterals;
2306
2378
  /** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
2307
- direction?: PollLayoutDirection;
2379
+ direction?: PollLayoutDirectionWithLiterals;
2308
2380
  /** Sets whether to display the main poll image. Defaults to `false`. */
2309
2381
  enableImage?: boolean | null;
2310
2382
  }
@@ -2320,6 +2392,8 @@ export declare enum BackgroundType {
2320
2392
  /** Gradiant background type */
2321
2393
  GRADIENT = "GRADIENT"
2322
2394
  }
2395
+ /** @enumType */
2396
+ export type BackgroundTypeWithLiterals = BackgroundType | 'COLOR' | 'IMAGE' | 'GRADIENT';
2323
2397
  export interface Gradient {
2324
2398
  /** The gradient angle in degrees. */
2325
2399
  angle?: number | null;
@@ -2345,7 +2419,7 @@ export interface Background extends BackgroundBackgroundOneOf {
2345
2419
  /** Details for a gradient background. */
2346
2420
  gradient?: Gradient;
2347
2421
  /** Background type. For each option, include the relevant details. */
2348
- type?: BackgroundType;
2422
+ type?: BackgroundTypeWithLiterals;
2349
2423
  }
2350
2424
  /** @oneof */
2351
2425
  export interface BackgroundBackgroundOneOf {
@@ -2371,7 +2445,7 @@ export interface OptionDesign {
2371
2445
  }
2372
2446
  export interface Poll {
2373
2447
  /** Poll ID. */
2374
- _id?: string | null;
2448
+ id?: string | null;
2375
2449
  /** Poll title. */
2376
2450
  title?: string | null;
2377
2451
  /** Poll creator ID. */
@@ -2424,7 +2498,7 @@ export interface Decoration extends DecorationDataOneOf {
2424
2498
  /** Data for a strikethrough decoration. Defaults to `true`. */
2425
2499
  strikethroughData?: boolean | null;
2426
2500
  /** The type of decoration to apply. */
2427
- type?: DecorationType;
2501
+ type?: DecorationTypeWithLiterals;
2428
2502
  }
2429
2503
  /** @oneof */
2430
2504
  export interface DecorationDataOneOf {
@@ -2462,6 +2536,8 @@ export declare enum DecorationType {
2462
2536
  EXTERNAL = "EXTERNAL",
2463
2537
  STRIKETHROUGH = "STRIKETHROUGH"
2464
2538
  }
2539
+ /** @enumType */
2540
+ export type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL' | 'STRIKETHROUGH';
2465
2541
  export interface AnchorData {
2466
2542
  /** The target node's ID. */
2467
2543
  anchor?: string;
@@ -2482,11 +2558,11 @@ export interface MentionData {
2482
2558
  /** The version of the user's name that appears after the `@` character in the mention. */
2483
2559
  slug?: string;
2484
2560
  /** Mentioned user's ID. */
2485
- _id?: string | null;
2561
+ id?: string | null;
2486
2562
  }
2487
2563
  export interface FontSizeData {
2488
2564
  /** The units used for the font size. */
2489
- unit?: FontType;
2565
+ unit?: FontTypeWithLiterals;
2490
2566
  /** Font size value. */
2491
2567
  value?: number | null;
2492
2568
  }
@@ -2494,9 +2570,11 @@ export declare enum FontType {
2494
2570
  PX = "PX",
2495
2571
  EM = "EM"
2496
2572
  }
2573
+ /** @enumType */
2574
+ export type FontTypeWithLiterals = FontType | 'PX' | 'EM';
2497
2575
  export interface SpoilerData {
2498
2576
  /** Spoiler ID. */
2499
- _id?: string | null;
2577
+ id?: string | null;
2500
2578
  }
2501
2579
  export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
2502
2580
  /** Data for embedded Wix Bookings content. */
@@ -2504,7 +2582,7 @@ export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
2504
2582
  /** Data for embedded Wix Events content. */
2505
2583
  eventData?: EventData;
2506
2584
  /** The type of Wix App content being embedded. */
2507
- type?: AppType;
2585
+ type?: AppTypeWithLiterals;
2508
2586
  /** The ID of the embedded content. */
2509
2587
  itemId?: string | null;
2510
2588
  /** The name of the embedded content. */
@@ -2531,6 +2609,8 @@ export declare enum AppType {
2531
2609
  EVENT = "EVENT",
2532
2610
  BOOKING = "BOOKING"
2533
2611
  }
2612
+ /** @enumType */
2613
+ export type AppTypeWithLiterals = AppType | 'PRODUCT' | 'EVENT' | 'BOOKING';
2534
2614
  export interface BookingData {
2535
2615
  /** Booking duration in minutes. */
2536
2616
  durations?: string | null;
@@ -2609,9 +2689,9 @@ export interface CollapsibleListData {
2609
2689
  /** If `true`, only one item can be expanded at a time. Defaults to `false`. */
2610
2690
  expandOnlyOne?: boolean | null;
2611
2691
  /** Sets which items are expanded when the page loads. */
2612
- initialExpandedItems?: InitialExpandedItems;
2692
+ initialExpandedItems?: InitialExpandedItemsWithLiterals;
2613
2693
  /** The direction of the text in the list. Either left-to-right or right-to-left. */
2614
- direction?: Direction;
2694
+ direction?: DirectionWithLiterals;
2615
2695
  /** If `true`, The collapsible item will appear in search results as an FAQ. */
2616
2696
  isQapageData?: boolean | null;
2617
2697
  }
@@ -2623,12 +2703,16 @@ export declare enum InitialExpandedItems {
2623
2703
  /** All items collapsed initally */
2624
2704
  NONE = "NONE"
2625
2705
  }
2706
+ /** @enumType */
2707
+ export type InitialExpandedItemsWithLiterals = InitialExpandedItems | 'FIRST' | 'ALL' | 'NONE';
2626
2708
  export declare enum Direction {
2627
2709
  /** Left-to-right */
2628
2710
  LTR = "LTR",
2629
2711
  /** Right-to-left */
2630
2712
  RTL = "RTL"
2631
2713
  }
2714
+ /** @enumType */
2715
+ export type DirectionWithLiterals = Direction | 'LTR' | 'RTL';
2632
2716
  export interface TableData {
2633
2717
  /** Styling for the table's container. */
2634
2718
  containerData?: PluginContainerData;
@@ -2666,9 +2750,11 @@ export declare enum VerticalAlignment {
2666
2750
  /** Bottom alignment */
2667
2751
  BOTTOM = "BOTTOM"
2668
2752
  }
2753
+ /** @enumType */
2754
+ export type VerticalAlignmentWithLiterals = VerticalAlignment | 'TOP' | 'MIDDLE' | 'BOTTOM';
2669
2755
  export interface CellStyle {
2670
2756
  /** Vertical alignment for the cell's text. */
2671
- verticalAlignment?: VerticalAlignment;
2757
+ verticalAlignment?: VerticalAlignmentWithLiterals;
2672
2758
  /**
2673
2759
  * Cell background color as a hexadecimal value.
2674
2760
  * @format COLOR_HEX
@@ -2707,6 +2793,8 @@ export declare enum NullValue {
2707
2793
  /** Null value. */
2708
2794
  NULL_VALUE = "NULL_VALUE"
2709
2795
  }
2796
+ /** @enumType */
2797
+ export type NullValueWithLiterals = NullValue | 'NULL_VALUE';
2710
2798
  /**
2711
2799
  * `ListValue` is a wrapper around a repeated field of values.
2712
2800
  *
@@ -2804,7 +2892,7 @@ export interface TextNodeStyle {
2804
2892
  }
2805
2893
  export interface Badge {
2806
2894
  /** Badge type. */
2807
- type?: Type;
2895
+ type?: TypeWithLiterals;
2808
2896
  /**
2809
2897
  * Badge text.
2810
2898
  * @maxLength 50
@@ -2821,6 +2909,8 @@ export declare enum Type {
2821
2909
  /** 3rd priority badge type. */
2822
2910
  THIRD_PRIORITY = "THIRD_PRIORITY"
2823
2911
  }
2912
+ /** @enumType */
2913
+ export type TypeWithLiterals = Type | 'UNKNOWN_BADGE_TYPE' | 'FIRST_PRIORITY' | 'SECOND_PRIORITY' | 'THIRD_PRIORITY';
2824
2914
  export interface DiscardDraftRequest {
2825
2915
  /**
2826
2916
  * Event ID to which the form belongs.
@@ -2835,25 +2925,21 @@ export interface DomainEvent extends DomainEventBodyOneOf {
2835
2925
  updatedEvent?: EntityUpdatedEvent;
2836
2926
  deletedEvent?: EntityDeletedEvent;
2837
2927
  actionEvent?: ActionEvent;
2838
- /**
2839
- * Unique event ID.
2840
- * Allows clients to ignore duplicate webhooks.
2841
- */
2928
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
2842
2929
  _id?: string;
2843
2930
  /**
2844
- * Assumes actions are also always typed to an entity_type
2845
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
2931
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
2932
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
2846
2933
  */
2847
2934
  entityFqdn?: string;
2848
2935
  /**
2849
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
2850
- * This is although the created/updated/deleted notion is duplication of the oneof types
2851
- * Example: created/updated/deleted/started/completed/email_opened
2936
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
2937
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
2852
2938
  */
2853
2939
  slug?: string;
2854
2940
  /** ID of the entity associated with the event. */
2855
2941
  entityId?: string;
2856
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
2942
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
2857
2943
  eventTime?: Date | null;
2858
2944
  /**
2859
2945
  * Whether the event was triggered as a result of a privacy regulation application
@@ -2863,12 +2949,8 @@ export interface DomainEvent extends DomainEventBodyOneOf {
2863
2949
  /** If present, indicates the action that triggered the event. */
2864
2950
  originatedFrom?: string | null;
2865
2951
  /**
2866
- * A sequence number defining the order of updates to the underlying entity.
2867
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
2868
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
2869
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
2870
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
2871
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
2952
+ * 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.
2953
+ * 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.
2872
2954
  */
2873
2955
  entityEventSequence?: string | null;
2874
2956
  }
@@ -2894,7 +2976,7 @@ export interface EntityUpdatedEvent {
2894
2976
  currentEntity?: string;
2895
2977
  }
2896
2978
  export interface EntityDeletedEvent {
2897
- /** Entity that was deleted */
2979
+ /** Entity that was deleted. */
2898
2980
  deletedEntity?: string | null;
2899
2981
  }
2900
2982
  export interface ActionEvent {
@@ -2938,7 +3020,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
2938
3020
  */
2939
3021
  appId?: string;
2940
3022
  /** @readonly */
2941
- identityType?: WebhookIdentityType;
3023
+ identityType?: WebhookIdentityTypeWithLiterals;
2942
3024
  }
2943
3025
  /** @oneof */
2944
3026
  export interface IdentificationDataIdOneOf {
@@ -2970,6 +3052,8 @@ export declare enum WebhookIdentityType {
2970
3052
  WIX_USER = "WIX_USER",
2971
3053
  APP = "APP"
2972
3054
  }
3055
+ /** @enumType */
3056
+ export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
2973
3057
  export interface BaseEventMetadata {
2974
3058
  /**
2975
3059
  * App instance ID.