@wix/auto_sdk_events_wix-events-v-2 1.0.38 → 1.0.40

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.
@@ -19,11 +19,14 @@ interface V3Event {
19
19
  title?: string | null;
20
20
  /**
21
21
  * Short description that appears under the event title.
22
+ * **Note:** This field is returned only when the `DETAILS` fieldset is included in the request.
22
23
  * @maxLength 500
23
24
  */
24
25
  shortDescription?: string | null;
25
26
  /**
26
- * Detailed description of an event. You can enter the description using rich text format (add various types of markups, such as underlines, italics, bolding, color codes, bullet lists, and links by using HTML formatting tags).
27
+ * Detailed description of an event.
28
+ *
29
+ * This field is deprecated.
27
30
  * @maxLength 50000
28
31
  * @deprecated Detailed description of an event.
29
32
  *
@@ -53,13 +56,7 @@ interface V3Event {
53
56
  */
54
57
  _updatedDate?: Date | null;
55
58
  /**
56
- * Event status:
57
- *
58
- * - `UPCOMING`: Event is published and scheduled to start.
59
- * - `STARTED`: Event has started.
60
- * - `ENDED`: Event has ended.
61
- * - `CANCELED`: Event is canceled.
62
- * - `DRAFT`: Event is not published.
59
+ * Event status.
63
60
  * @readonly
64
61
  */
65
62
  status?: StatusWithLiterals;
@@ -124,11 +121,7 @@ interface V3Event {
124
121
  agendaSettings?: AgendaSettings;
125
122
  /** Visual settings for event. */
126
123
  eventDisplaySettings?: V3EventDisplaySettings;
127
- /**
128
- * Event description with rich content.
129
- *
130
- * For the event description to appear on your site, connect the [Rich Content Viewer](https://dev.wix.com/docs/velo/velo-only-apis/$w/rich-content-viewer/introduction) element, and assign the description value to the viewer.
131
- */
124
+ /** Event description. <widget src="https://apps.wix.com/_serverless/ricos-playground-services/goto/api-component" plugins="emoji,audio,codeBlock,collapsibleList,divider,emoji,file,gallery,giphy,hashtag,heading,html,image,indent,lineSpacing,link,linkPreview,spoiler,video" exampleid="9b569a8d-0fc1-40f4-987f-8bd40ecc72d0">Fallback Message for SSR and Error</widget> */
132
125
  description?: RichContent;
133
126
  /**
134
127
  * Event publish timestamp.
@@ -142,12 +135,7 @@ interface Location {
142
135
  * @maxLength 50
143
136
  */
144
137
  name?: string | null;
145
- /**
146
- * Location type:
147
- *
148
- * - `VENUE`: The event is on-site at a specific physical location.
149
- * - `ONLINE`: The event is online, such as a virtual video conference.
150
- */
138
+ /** Location type. */
151
139
  type?: LocationTypeWithLiterals;
152
140
  /** Exact location address. */
153
141
  address?: CommonAddress;
@@ -269,6 +257,8 @@ interface DateAndTimeSettings {
269
257
  dateAndTimeTbd?: boolean | null;
270
258
  /**
271
259
  * Message that is displayed when time and date is TBD.
260
+ *
261
+ * **Note:** This field is only used when the `dateAndTimeTbd` field value is `true`.
272
262
  * @maxLength 100
273
263
  */
274
264
  dateAndTimeTbdMessage?: string | null;
@@ -296,13 +286,7 @@ interface DateAndTimeSettings {
296
286
  /** Whether the time zone is displayed in the formatted schedule. */
297
287
  showTimeZone?: boolean | null;
298
288
  /**
299
- * Repeating event status. Possible values:
300
- *
301
- * - `ONE_TIME`: The event happens only once and can last multiple days.
302
- * - `RECURRING`: A series of events that repeat.
303
- * - `RECURRING_UPCOMING`: Next event in a schedule of recurring events.
304
- * - `RECURRING_RECENTLY_ENDED`: Latest event that ended in a schedule of recurring events.
305
- * - `RECURRING_RECENTLY_CANCELED`: Latest canceled event tin a schedule of recurring events.
289
+ * Repeating event status.
306
290
  * @readonly
307
291
  */
308
292
  recurrenceStatus?: RecurrenceStatusStatusWithLiterals;
@@ -329,7 +313,7 @@ declare enum RecurrenceStatusStatus {
329
313
  type RecurrenceStatusStatusWithLiterals = RecurrenceStatusStatus | 'UNKNOWN_STATUS' | 'ONE_TIME' | 'RECURRING' | 'RECURRING_UPCOMING' | 'RECURRING_RECENTLY_ENDED' | 'RECURRING_RECENTLY_CANCELED';
330
314
  interface Recurrences {
331
315
  /**
332
- * Individual event dates info.
316
+ * Individual event dates.
333
317
  * @maxSize 1000
334
318
  */
335
319
  individualEventDates?: Occurrence[];
@@ -355,9 +339,8 @@ interface Occurrence {
355
339
  }
356
340
  interface Formatted {
357
341
  /**
358
- * Formatted date and time representation.
359
- *
360
- * Example of formatting when an event lasts multiple days and is in the UTC time zone: `September 1, 2015 at 10:20 AM – September 5, 2015 at 12:14 PM`.
342
+ * Formatted date and time representation. <br>
343
+ * Example of formatting when an event lasts multiple days and is in the UTC time zone: `September 1, 2015 at 10:20 AM – September 5, 2015 at 12:14 PM`. <br>
361
344
  * Example of formatting when an event lasts 1 day and is in the GMT+2 time zone: `February 1, 2018, 12:10 – 2:50 PM GMT+2`.
362
345
  * @readonly
363
346
  * @maxLength 500
@@ -424,27 +407,12 @@ declare enum Status {
424
407
  type StatusWithLiterals = Status | 'UNKNOWN_EVENT_STATUS' | 'UPCOMING' | 'STARTED' | 'ENDED' | 'CANCELED' | 'DRAFT';
425
408
  interface Registration {
426
409
  /**
427
- * Current registration type:
428
- *
429
- * - `RSVP`: Guests register by RSVPing to the event.
430
- * - `TICKETING`: Guests register by buying tickets.
431
- * - `EXTERNAL`: Guests register externally using some other site or platform.
432
- * - `NONE`: No registration is required, all guests can attend. This registration type is for only displaying the event details on a site.
433
- *
434
- * The property value might change to `EXTERNAL` or `NONE` after initial event creation, depending on any additional configuration applied to the event.
410
+ * Current registration type.
435
411
  * @readonly
436
412
  */
437
413
  type?: RegistrationTypeTypeWithLiterals;
438
414
  /**
439
- * Registration status. Possible values:
440
- *
441
- * - `CLOSED_AUTOMATICALLY`: Registration is closed after tickets are sold out.
442
- * - `CLOSED_MANUALLY`: Registration is closed when the `registration.registrationDisabled` property is set to `true`.
443
- * - `OPEN_RSVP`: Guests can start RSVPing to the event.
444
- * - `OPEN_RSVP_WAITLIST_ONLY`: Guest list has reached the maximum, new guests are added to a waitlist.
445
- * - `OPEN_TICKETS`: Guests can buy tickets to the event.
446
- * - `OPEN_EXTERNAL`: Guests register on a different page or web address.
447
- * - `SCHEDULED_RSVP`: Registration via RSVP is scheduled for the future.
415
+ * Registration status.
448
416
  * @readonly
449
417
  */
450
418
  status?: RegistrationStatusStatusWithLiterals;
@@ -454,20 +422,10 @@ interface Registration {
454
422
  tickets?: TicketsRegistration;
455
423
  /** External registration details. */
456
424
  external?: ExternalRegistration;
457
- /**
458
- * Types of guests allowed to register. Possible values:
459
- *
460
- * - `VISITOR_OR_MEMBER`: All site visitors can RSVP to the event.
461
- * - `MEMBER`: Only people who have signed up as members of your site are able to RSVP to the event.
462
- */
425
+ /** Types of guests allowed to register. */
463
426
  allowedGuestTypes?: GuestTypeTypeWithLiterals;
464
427
  /**
465
- * Initial event type which is set when creating an event. Possible values:
466
- *
467
- * - `RSVP`: Guests register by RSVPing to the event.
468
- * - `TICKETING`: Guests register by buying tickets.
469
- *
470
- * This property value never changes.
428
+ * Initial event type which is set when creating an event.
471
429
  * @immutable
472
430
  */
473
431
  initialType?: InitialRegistrationTypeTypeWithLiterals;
@@ -485,13 +443,13 @@ declare enum RegistrationTypeType {
485
443
  TICKETING = "TICKETING",
486
444
  /** Guests register externally using some other site or platform. */
487
445
  EXTERNAL = "EXTERNAL",
488
- /** 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. */
446
+ /** 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` or `TICKETING `to `EXTERNAL` or `NONE` after the event is created, depending on any additional configurations applied to the event. */
489
447
  NONE = "NONE"
490
448
  }
491
449
  /** @enumType */
492
450
  type RegistrationTypeTypeWithLiterals = RegistrationTypeType | 'UNKNOWN_REGISTRATION_TYPE' | 'RSVP' | 'TICKETING' | 'EXTERNAL' | 'NONE';
493
451
  declare enum RegistrationStatusStatus {
494
- /** Registration status is not applicable */
452
+ /** Registration status isn't applicable. */
495
453
  UNKNOWN_REGISTRATION_STATUS = "UNKNOWN_REGISTRATION_STATUS",
496
454
  /** Registration is closed after tickets are sold out. */
497
455
  CLOSED_AUTOMATICALLY = "CLOSED_AUTOMATICALLY",
@@ -515,7 +473,7 @@ interface RsvpRegistration {
515
473
  responseType?: ResponseTypeWithLiterals;
516
474
  /** How many guests can RSVP to an event. */
517
475
  limit?: number | null;
518
- /** 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. */
476
+ /** Whether a waitlist is opened when the total guest limit is reached. If `true`, guests can RSVP to an event and are automatically added to the waitlist with the `IN_WAITLIST` status. */
519
477
  waitlistEnabled?: boolean;
520
478
  /** Registration start date. */
521
479
  startDate?: Date | null;
@@ -536,7 +494,7 @@ interface TicketsRegistration {
536
494
  /** Whether the registration form must be filled out separately for each ticket. */
537
495
  guestsAssignedSeparately?: boolean;
538
496
  /**
539
- * Ticket limit per order.
497
+ * Ticket limit per order. <br>
540
498
  * Default: 20 tickets.
541
499
  * @max 50
542
500
  */
@@ -589,12 +547,7 @@ interface Money {
589
547
  formattedValue?: string | null;
590
548
  }
591
549
  interface TaxSettings {
592
- /**
593
- * Tax application settings:
594
- *
595
- * - `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.
596
- * - `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.
597
- */
550
+ /** Tax application settings. */
598
551
  type?: TaxTypeWithLiterals;
599
552
  /**
600
553
  * Tax name.
@@ -603,7 +556,7 @@ interface TaxSettings {
603
556
  */
604
557
  name?: string | null;
605
558
  /**
606
- * Tax rate (for example,`21.55`).
559
+ * Tax rate. For example, `21.55`.
607
560
  * @decimalValue options { gte:0.001, lte:100, maxScale:3 }
608
561
  */
609
562
  rate?: string | null;
@@ -614,9 +567,9 @@ interface TaxSettings {
614
567
  declare enum TaxType {
615
568
  /** Unknown tax type. */
616
569
  UNKNOWN_TAX_TYPE = "UNKNOWN_TAX_TYPE",
617
- /** Deduct the fee from the ticket price for a seller. For example, if you're selling tickets for $10, a ticket ticket service fee of $0.25 is deducted from the price and you'll get $9.75. */
570
+ /** 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. */
618
571
  INCLUDED_IN_PRICE = "INCLUDED_IN_PRICE",
619
- /** 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. */
572
+ /** 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 service fee of $0.25 and pays $10.25 in total. */
620
573
  ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
621
574
  }
622
575
  /** @enumType */
@@ -650,7 +603,7 @@ declare enum InitialRegistrationTypeType {
650
603
  type InitialRegistrationTypeTypeWithLiterals = InitialRegistrationTypeType | 'UNKNOWN_INITIAL_REGISTRATION_TYPE' | 'RSVP' | 'TICKETING';
651
604
  interface CalendarUrls {
652
605
  /**
653
- * "Add to Google calendar" URL.
606
+ * "Add to Google Calendar" URL.
654
607
  * @readonly
655
608
  */
656
609
  google?: string;
@@ -922,7 +875,7 @@ interface TicketsUnavailableMessages {
922
875
  interface Summaries {
923
876
  /** RSVP summary of guests. */
924
877
  rsvps?: Rsvps;
925
- /** Summary of revenue and sold tickets. Archived orders are not included. */
878
+ /** Summary of revenue and sold tickets. Archived orders aren't included. */
926
879
  tickets?: Tickets;
927
880
  }
928
881
  interface EventsMoney {
@@ -933,7 +886,7 @@ interface EventsMoney {
933
886
  */
934
887
  amount?: string;
935
888
  /**
936
- * Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
889
+ * 3-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. For example, `USD`.
937
890
  * @format CURRENCY
938
891
  */
939
892
  currency?: string;
@@ -977,7 +930,7 @@ interface Tickets {
977
930
  */
978
931
  revenue?: EventsMoney;
979
932
  /**
980
- * Whether the currency is locked and cant be changed.
933
+ * Whether the currency is locked and can't be changed.
981
934
  * @readonly
982
935
  */
983
936
  currencyLocked?: boolean;
@@ -993,7 +946,7 @@ interface Tickets {
993
946
  totalSales?: EventsMoney;
994
947
  }
995
948
  interface GuestListSettings {
996
- /** Whether the guest list is public for all guests. */
949
+ /** Whether the guest list is displayed publicly to all guests. */
997
950
  displayedPublicly?: boolean;
998
951
  }
999
952
  interface Feed {
@@ -1001,19 +954,14 @@ interface Feed {
1001
954
  token?: string;
1002
955
  }
1003
956
  interface OnlineConferencing {
1004
- /** Whether online conferencing is enabled. Not applicable for events, where date and time are TBD. When enabled, links to join the conference are generated and provided to guests. */
957
+ /** Whether online conferencing is enabled. Not applicable for events where date and time are TBD. When enabled, links to join the conference are generated and provided to guests. */
1005
958
  enabled?: boolean;
1006
959
  /**
1007
960
  * Conference host ID.
1008
961
  * @format GUID
1009
962
  */
1010
963
  providerId?: string | null;
1011
- /**
1012
- * Conference type. Possible values:
1013
- *
1014
- * - `MEETING`: Guests can do some actions during the conference, for example talk, turn on camera and show their screen.
1015
- * - `WEBINAR`: Guests can only watch the conference.
1016
- */
964
+ /** Conference type. */
1017
965
  type?: ConferenceTypeTypeWithLiterals;
1018
966
  /** Online conferencing session information. */
1019
967
  session?: OnlineConferencingSession;
@@ -1064,7 +1012,7 @@ interface SeoSettings {
1064
1012
  /** Advanced SEO data. */
1065
1013
  advancedSeoData?: SeoSchema;
1066
1014
  /**
1067
- * Whether the slug is hidden from the SEO Site Map.
1015
+ * Whether the slug is hidden from the SEO sitemap.
1068
1016
  * @readonly
1069
1017
  */
1070
1018
  hidden?: boolean | null;
@@ -1615,7 +1563,7 @@ interface DividerData {
1615
1563
  /** Divider width. */
1616
1564
  width?: WidthWithLiterals;
1617
1565
  /** Divider alignment. */
1618
- alignment?: AlignmentWithLiterals;
1566
+ alignment?: DividerDataAlignmentWithLiterals;
1619
1567
  }
1620
1568
  declare enum LineStyle {
1621
1569
  /** Single Line */
@@ -1639,7 +1587,7 @@ declare enum Width {
1639
1587
  }
1640
1588
  /** @enumType */
1641
1589
  type WidthWithLiterals = Width | 'LARGE' | 'MEDIUM' | 'SMALL';
1642
- declare enum Alignment {
1590
+ declare enum DividerDataAlignment {
1643
1591
  /** Center alignment */
1644
1592
  CENTER = "CENTER",
1645
1593
  /** Left alignment */
@@ -1648,7 +1596,7 @@ declare enum Alignment {
1648
1596
  RIGHT = "RIGHT"
1649
1597
  }
1650
1598
  /** @enumType */
1651
- type AlignmentWithLiterals = Alignment | 'CENTER' | 'LEFT' | 'RIGHT';
1599
+ type DividerDataAlignmentWithLiterals = DividerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
1652
1600
  interface FileData {
1653
1601
  /** Styling for the file's container. */
1654
1602
  containerData?: PluginContainerData;
@@ -1773,7 +1721,7 @@ interface ItemDataOneOf {
1773
1721
  }
1774
1722
  interface GalleryOptions {
1775
1723
  /** Gallery layout. */
1776
- layout?: Layout;
1724
+ layout?: GalleryOptionsLayout;
1777
1725
  /** Styling for gallery items. */
1778
1726
  item?: ItemStyle;
1779
1727
  /** Styling for gallery thumbnail images. */
@@ -1833,7 +1781,7 @@ declare enum ThumbnailsAlignment {
1833
1781
  }
1834
1782
  /** @enumType */
1835
1783
  type ThumbnailsAlignmentWithLiterals = ThumbnailsAlignment | 'TOP' | 'RIGHT' | 'BOTTOM' | 'LEFT' | 'NONE';
1836
- interface Layout {
1784
+ interface GalleryOptionsLayout {
1837
1785
  /** Gallery layout type. */
1838
1786
  type?: LayoutTypeWithLiterals;
1839
1787
  /** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
@@ -1995,7 +1943,7 @@ interface LinkPreviewData {
1995
1943
  /** Styling for the link preview. */
1996
1944
  styles?: LinkPreviewDataStyles;
1997
1945
  }
1998
- declare enum Position {
1946
+ declare enum StylesPosition {
1999
1947
  /** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
2000
1948
  START = "START",
2001
1949
  /** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
@@ -2006,7 +1954,7 @@ declare enum Position {
2006
1954
  HIDDEN = "HIDDEN"
2007
1955
  }
2008
1956
  /** @enumType */
2009
- type PositionWithLiterals = Position | 'START' | 'END' | 'TOP' | 'HIDDEN';
1957
+ type StylesPositionWithLiterals = StylesPosition | 'START' | 'END' | 'TOP' | 'HIDDEN';
2010
1958
  interface LinkPreviewDataStyles {
2011
1959
  /**
2012
1960
  * Background color as a hexadecimal value.
@@ -2038,7 +1986,7 @@ interface LinkPreviewDataStyles {
2038
1986
  */
2039
1987
  borderColor?: string | null;
2040
1988
  /** Position of thumbnail. Defaults to `START`. */
2041
- thumbnailPosition?: PositionWithLiterals;
1989
+ thumbnailPosition?: StylesPositionWithLiterals;
2042
1990
  }
2043
1991
  interface MapData {
2044
1992
  /** Styling for the map's container. */
@@ -2392,6 +2340,32 @@ interface AppEmbedData extends AppEmbedDataAppDataOneOf {
2392
2340
  url?: string | null;
2393
2341
  /** An image for the embedded content. */
2394
2342
  image?: Media;
2343
+ /** Whether to hide the image. */
2344
+ hideImage?: boolean | null;
2345
+ /** Whether to hide the title. */
2346
+ hideTitle?: boolean | null;
2347
+ /** Whether to hide the price. */
2348
+ hidePrice?: boolean | null;
2349
+ /** Whether to hide the description (Event and Booking). */
2350
+ hideDescription?: boolean | null;
2351
+ /** Whether to hide the date and time (Event). */
2352
+ hideDateTime?: boolean | null;
2353
+ /** Whether to hide the location (Event). */
2354
+ hideLocation?: boolean | null;
2355
+ /** Whether to hide the duration (Booking). */
2356
+ hideDuration?: boolean | null;
2357
+ /** Whether to hide the button. */
2358
+ hideButton?: boolean | null;
2359
+ /** Whether to hide the ribbon. */
2360
+ hideRibbon?: boolean | null;
2361
+ /** Button styling options. */
2362
+ buttonStyles?: ButtonStyles;
2363
+ /** Image styling options. */
2364
+ imageStyles?: ImageStyles;
2365
+ /** Ribbon styling options. */
2366
+ ribbonStyles?: RibbonStyles;
2367
+ /** Card styling options. */
2368
+ cardStyles?: CardStyles;
2395
2369
  }
2396
2370
  /** @oneof */
2397
2371
  interface AppEmbedDataAppDataOneOf {
@@ -2400,6 +2374,66 @@ interface AppEmbedDataAppDataOneOf {
2400
2374
  /** Data for embedded Wix Events content. */
2401
2375
  eventData?: EventData;
2402
2376
  }
2377
+ declare enum Position {
2378
+ /** Image positioned at the start (left in LTR layouts, right in RTL layouts) */
2379
+ START = "START",
2380
+ /** Image positioned at the end (right in LTR layouts, left in RTL layouts) */
2381
+ END = "END",
2382
+ /** Image positioned at the top */
2383
+ TOP = "TOP"
2384
+ }
2385
+ /** @enumType */
2386
+ type PositionWithLiterals = Position | 'START' | 'END' | 'TOP';
2387
+ declare enum AspectRatio {
2388
+ /** 1:1 aspect ratio */
2389
+ SQUARE = "SQUARE",
2390
+ /** 16:9 aspect ratio */
2391
+ RECTANGLE = "RECTANGLE"
2392
+ }
2393
+ /** @enumType */
2394
+ type AspectRatioWithLiterals = AspectRatio | 'SQUARE' | 'RECTANGLE';
2395
+ declare enum Resizing {
2396
+ /** Fill the container, may crop the image */
2397
+ FILL = "FILL",
2398
+ /** Fit the image within the container */
2399
+ FIT = "FIT"
2400
+ }
2401
+ /** @enumType */
2402
+ type ResizingWithLiterals = Resizing | 'FILL' | 'FIT';
2403
+ declare enum Placement {
2404
+ /** Ribbon placed on the image */
2405
+ IMAGE = "IMAGE",
2406
+ /** Ribbon placed on the product information */
2407
+ PRODUCT_INFO = "PRODUCT_INFO"
2408
+ }
2409
+ /** @enumType */
2410
+ type PlacementWithLiterals = Placement | 'IMAGE' | 'PRODUCT_INFO';
2411
+ declare enum CardStylesType {
2412
+ /** Card with visible border and background */
2413
+ CONTAINED = "CONTAINED",
2414
+ /** Card without visible border */
2415
+ FRAMELESS = "FRAMELESS"
2416
+ }
2417
+ /** @enumType */
2418
+ type CardStylesTypeWithLiterals = CardStylesType | 'CONTAINED' | 'FRAMELESS';
2419
+ declare enum Alignment {
2420
+ /** Content aligned to start (left in LTR layouts, right in RTL layouts) */
2421
+ START = "START",
2422
+ /** Content centered */
2423
+ CENTER = "CENTER",
2424
+ /** Content aligned to end (right in LTR layouts, left in RTL layouts) */
2425
+ END = "END"
2426
+ }
2427
+ /** @enumType */
2428
+ type AlignmentWithLiterals = Alignment | 'START' | 'CENTER' | 'END';
2429
+ declare enum Layout {
2430
+ /** Elements stacked vertically */
2431
+ STACKED = "STACKED",
2432
+ /** Elements arranged horizontally */
2433
+ SIDE_BY_SIDE = "SIDE_BY_SIDE"
2434
+ }
2435
+ /** @enumType */
2436
+ type LayoutWithLiterals = Layout | 'STACKED' | 'SIDE_BY_SIDE';
2403
2437
  declare enum AppType {
2404
2438
  PRODUCT = "PRODUCT",
2405
2439
  EVENT = "EVENT",
@@ -2417,6 +2451,122 @@ interface EventData {
2417
2451
  /** Event location. */
2418
2452
  location?: string | null;
2419
2453
  }
2454
+ interface ButtonStyles {
2455
+ /** Text to display on the button. */
2456
+ buttonText?: string | null;
2457
+ /** Border width in pixels. */
2458
+ borderWidth?: number | null;
2459
+ /** Border radius in pixels. */
2460
+ borderRadius?: number | null;
2461
+ /**
2462
+ * Border color as a hexadecimal value.
2463
+ * @format COLOR_HEX
2464
+ */
2465
+ borderColor?: string | null;
2466
+ /**
2467
+ * Text color as a hexadecimal value.
2468
+ * @format COLOR_HEX
2469
+ */
2470
+ textColor?: string | null;
2471
+ /**
2472
+ * Background color as a hexadecimal value.
2473
+ * @format COLOR_HEX
2474
+ */
2475
+ backgroundColor?: string | null;
2476
+ /**
2477
+ * Border color as a hexadecimal value (hover state).
2478
+ * @format COLOR_HEX
2479
+ */
2480
+ borderColorHover?: string | null;
2481
+ /**
2482
+ * Text color as a hexadecimal value (hover state).
2483
+ * @format COLOR_HEX
2484
+ */
2485
+ textColorHover?: string | null;
2486
+ /**
2487
+ * Background color as a hexadecimal value (hover state).
2488
+ * @format COLOR_HEX
2489
+ */
2490
+ backgroundColorHover?: string | null;
2491
+ /** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
2492
+ buttonSize?: string | null;
2493
+ }
2494
+ interface ImageStyles {
2495
+ /** Whether to hide the image. */
2496
+ hideImage?: boolean | null;
2497
+ /** Position of image. Defaults to `START`. */
2498
+ imagePosition?: PositionWithLiterals;
2499
+ /** Aspect ratio for the image. Defaults to `SQUARE`. */
2500
+ aspectRatio?: AspectRatioWithLiterals;
2501
+ /** How the image should be resized. Defaults to `FILL`. */
2502
+ resizing?: ResizingWithLiterals;
2503
+ /**
2504
+ * Image border color as a hexadecimal value.
2505
+ * @format COLOR_HEX
2506
+ */
2507
+ borderColor?: string | null;
2508
+ /** Image border width in pixels. */
2509
+ borderWidth?: number | null;
2510
+ /** Image border radius in pixels. */
2511
+ borderRadius?: number | null;
2512
+ }
2513
+ interface RibbonStyles {
2514
+ /** Text to display on the ribbon. */
2515
+ ribbonText?: string | null;
2516
+ /**
2517
+ * Ribbon background color as a hexadecimal value.
2518
+ * @format COLOR_HEX
2519
+ */
2520
+ backgroundColor?: string | null;
2521
+ /**
2522
+ * Ribbon text color as a hexadecimal value.
2523
+ * @format COLOR_HEX
2524
+ */
2525
+ textColor?: string | null;
2526
+ /**
2527
+ * Ribbon border color as a hexadecimal value.
2528
+ * @format COLOR_HEX
2529
+ */
2530
+ borderColor?: string | null;
2531
+ /** Ribbon border width in pixels. */
2532
+ borderWidth?: number | null;
2533
+ /** Ribbon border radius in pixels. */
2534
+ borderRadius?: number | null;
2535
+ /** Placement of the ribbon. Defaults to `IMAGE`. */
2536
+ ribbonPlacement?: PlacementWithLiterals;
2537
+ }
2538
+ interface CardStyles {
2539
+ /**
2540
+ * Card background color as a hexadecimal value.
2541
+ * @format COLOR_HEX
2542
+ */
2543
+ backgroundColor?: string | null;
2544
+ /**
2545
+ * Card border color as a hexadecimal value.
2546
+ * @format COLOR_HEX
2547
+ */
2548
+ borderColor?: string | null;
2549
+ /** Card border width in pixels. */
2550
+ borderWidth?: number | null;
2551
+ /** Card border radius in pixels. */
2552
+ borderRadius?: number | null;
2553
+ /** Card type. Defaults to `CONTAINED`. */
2554
+ type?: CardStylesTypeWithLiterals;
2555
+ /** Content alignment. Defaults to `START`. */
2556
+ alignment?: AlignmentWithLiterals;
2557
+ /** Layout for title and price. Defaults to `STACKED`. */
2558
+ titlePriceLayout?: LayoutWithLiterals;
2559
+ /**
2560
+ * Title text color as a hexadecimal value.
2561
+ * @format COLOR_HEX
2562
+ */
2563
+ titleColor?: string | null;
2564
+ /**
2565
+ * Text color as a hexadecimal value.
2566
+ * @format COLOR_HEX
2567
+ */
2568
+ textColor?: string | null;
2569
+ }
2420
2570
  interface VideoData {
2421
2571
  /** Styling for the video's container. */
2422
2572
  containerData?: PluginContainerData;
@@ -2722,7 +2872,7 @@ interface EventEventStarted {
2722
2872
  * @format GUID
2723
2873
  */
2724
2874
  eventId?: string;
2725
- /** True if at least one guest is registered to the event with any attendance status. */
2875
+ /** Whether at least 1 guest is registered to the event with any attendance status. */
2726
2876
  hasGuests?: boolean | null;
2727
2877
  }
2728
2878
  interface EventEventEnded {
@@ -2733,7 +2883,7 @@ interface EventEventEnded {
2733
2883
  * @format GUID
2734
2884
  */
2735
2885
  eventId?: string;
2736
- /** True if at least one guest is registered to the event with any attendance status. */
2886
+ /** Whether at least 1 guest is registered to the event with any attendance status. */
2737
2887
  hasGuests?: boolean | null;
2738
2888
  }
2739
2889
  interface EventEventReminder {
@@ -2759,9 +2909,9 @@ interface EventEventReminder {
2759
2909
  * @format GUID
2760
2910
  */
2761
2911
  userId?: string | null;
2762
- /** Time until the start of event (currently, reminder letter is triggered 1 day before the start of event). */
2912
+ /** Time until the start of event. By default, the reminder letter is triggered 1 day before the start of event. */
2763
2913
  startsIn?: TimeDuration;
2764
- /** True if at least one guest is registered to the event with any attendance status. */
2914
+ /** Whether at least 1 guest is registered to the event with any attendance status. */
2765
2915
  hasGuests?: boolean | null;
2766
2916
  }
2767
2917
  interface EventEventPublished {
@@ -2843,7 +2993,7 @@ interface EventCloned {
2843
2993
  ticketDefinitions?: Record<string, string>;
2844
2994
  }
2845
2995
  interface EventEventCanceled {
2846
- /** Event cancelation timestamp in ISO UTC format. */
2996
+ /** Event cancellation timestamp in ISO UTC format. */
2847
2997
  timestamp?: Date | null;
2848
2998
  /**
2849
2999
  * Event ID.
@@ -2861,7 +3011,7 @@ interface EventEventCanceled {
2861
3011
  * @format GUID
2862
3012
  */
2863
3013
  userId?: string | null;
2864
- /** True if at least one guest is registered to the event with any attendance status. */
3014
+ /** Whether at least 1 guest is registered to the event with any attendance status. */
2865
3015
  hasGuests?: boolean | null;
2866
3016
  }
2867
3017
  interface CreateEventRequest {
@@ -2913,12 +3063,12 @@ interface CloneEventRequest {
2913
3063
  * @format GUID
2914
3064
  */
2915
3065
  eventId: string;
2916
- /** Field values to be changed when cloning the event. */
3066
+ /** Event info to change in the cloned event. */
2917
3067
  event?: V3Event;
2918
3068
  /** Whether to clone the event as a draft. */
2919
3069
  draft?: boolean;
2920
3070
  /**
2921
- * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
3071
+ * Predefined sets of fields to return.
2922
3072
  * @maxSize 20
2923
3073
  */
2924
3074
  fields?: RequestedFieldsWithLiterals[];
@@ -2939,7 +3089,7 @@ interface CloneEventFromOtherSiteRequest {
2939
3089
  */
2940
3090
  instanceId?: string | null;
2941
3091
  /**
2942
- * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
3092
+ * Predefined sets of fields to return.
2943
3093
  * @maxSize 20
2944
3094
  */
2945
3095
  fields?: RequestedFieldsWithLiterals[];
@@ -2949,10 +3099,10 @@ interface CloneEventFromOtherSiteResponse {
2949
3099
  event?: V3Event;
2950
3100
  }
2951
3101
  interface UpdateEventRequest {
2952
- /** Field values to be changed. */
3102
+ /** Event info to update. */
2953
3103
  event?: V3Event;
2954
3104
  /**
2955
- * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
3105
+ * Predefined sets of fields to return.
2956
3106
  * @maxSize 20
2957
3107
  */
2958
3108
  fields?: RequestedFieldsWithLiterals[];
@@ -2968,7 +3118,7 @@ interface PublishDraftEventRequest {
2968
3118
  */
2969
3119
  eventId: string;
2970
3120
  /**
2971
- * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
3121
+ * Predefined sets of fields to return.
2972
3122
  * @maxSize 20
2973
3123
  */
2974
3124
  fields?: RequestedFieldsWithLiterals[];
@@ -2984,7 +3134,7 @@ interface CancelEventRequest {
2984
3134
  */
2985
3135
  eventId: string;
2986
3136
  /**
2987
- * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
3137
+ * Predefined sets of fields to return.
2988
3138
  * @maxSize 20
2989
3139
  */
2990
3140
  fields?: RequestedFieldsWithLiterals[];
@@ -2994,7 +3144,7 @@ interface CancelEventResponse {
2994
3144
  event?: V3Event;
2995
3145
  }
2996
3146
  interface BulkCancelEventsByFilterRequest {
2997
- /** Filter. */
3147
+ /** Filter. For supported filters, see the table in [Query Events](https://dev.wix.com/docs/sdk/backend-modules/events/wix-events-v2/query-events). */
2998
3148
  filter?: CommonQueryV2;
2999
3149
  }
3000
3150
  interface CommonQueryV2 extends CommonQueryV2PagingMethodOneOf {
@@ -3066,13 +3216,13 @@ interface DeleteEventResponse {
3066
3216
  eventId?: string;
3067
3217
  }
3068
3218
  interface BulkDeleteEventsByFilterRequest {
3069
- /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
3219
+ /** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/get-started/api-query-language) for more details. */
3070
3220
  filter?: CommonQueryV2;
3071
3221
  }
3072
3222
  interface BulkDeleteEventsByFilterResponse {
3073
3223
  }
3074
3224
  interface QueryEventsRequest {
3075
- /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
3225
+ /** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/get-started/api-query-language) for more details. */
3076
3226
  query?: CommonQueryV2;
3077
3227
  /**
3078
3228
  * Predefined sets of fields to return.
@@ -3110,7 +3260,7 @@ interface CommonCursors {
3110
3260
  prev?: string | null;
3111
3261
  }
3112
3262
  interface ExportEventsRequest {
3113
- /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
3263
+ /** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/get-started/api-query-language) for more details. */
3114
3264
  query?: QueryV2;
3115
3265
  }
3116
3266
  interface QueryV2 extends QueryV2PagingMethodOneOf {
@@ -3259,12 +3409,12 @@ interface ListUserEventsRequest {
3259
3409
  }
3260
3410
  interface UserFilter {
3261
3411
  /**
3262
- * User who is related to event
3412
+ * User who is related to the event.
3263
3413
  * @format GUID
3264
3414
  */
3265
3415
  userId?: string;
3266
3416
  /**
3267
- * Relation of user to event.
3417
+ * Relation of user to the event.
3268
3418
  * @minSize 1
3269
3419
  * @maxSize 20
3270
3420
  */
@@ -4509,7 +4659,7 @@ interface EventCanceledEnvelope {
4509
4659
  metadata: EventMetadata;
4510
4660
  }
4511
4661
  /**
4512
- * Triggered when event is canceled.
4662
+ * Triggered when an event is canceled.
4513
4663
  * @permissionScope Manage Stores
4514
4664
  * @permissionScopeId SCOPE.STORES.MANAGE-STORES
4515
4665
  * @permissionScope Read Events - all read permissions
@@ -4549,7 +4699,7 @@ interface EventClonedEnvelope {
4549
4699
  metadata: EventMetadata;
4550
4700
  }
4551
4701
  /**
4552
- * Triggered when event is cloned.
4702
+ * Triggered when an event is cloned.
4553
4703
  * @permissionScope Manage Stores
4554
4704
  * @permissionScopeId SCOPE.STORES.MANAGE-STORES
4555
4705
  * @permissionScope Read Events - all read permissions
@@ -4589,7 +4739,7 @@ interface EventCreatedEnvelope {
4589
4739
  metadata: EventMetadata;
4590
4740
  }
4591
4741
  /**
4592
- * Triggered when event is created.
4742
+ * Triggered when an event is created.
4593
4743
  * @permissionScope Manage Stores
4594
4744
  * @permissionScopeId SCOPE.STORES.MANAGE-STORES
4595
4745
  * @permissionScope Read Events - all read permissions
@@ -4628,7 +4778,7 @@ interface EventDeletedEnvelope {
4628
4778
  metadata: EventMetadata;
4629
4779
  }
4630
4780
  /**
4631
- * Triggered when event is deleted.
4781
+ * Triggered when an event is deleted.
4632
4782
  * @permissionScope Manage Stores
4633
4783
  * @permissionScopeId SCOPE.STORES.MANAGE-STORES
4634
4784
  * @permissionScope Read Events - all read permissions
@@ -4668,7 +4818,7 @@ interface EventEndedEnvelope {
4668
4818
  metadata: EventMetadata;
4669
4819
  }
4670
4820
  /**
4671
- * Triggered when event has ended.
4821
+ * Triggered when an event has ended.
4672
4822
  * @permissionScope Manage Stores
4673
4823
  * @permissionScopeId SCOPE.STORES.MANAGE-STORES
4674
4824
  * @permissionScope Read Events - all read permissions
@@ -4708,7 +4858,7 @@ interface EventPublishedEnvelope {
4708
4858
  metadata: EventMetadata;
4709
4859
  }
4710
4860
  /**
4711
- * Triggered when event is published.
4861
+ * Triggered when an event is published.
4712
4862
  * @permissionScope Manage Stores
4713
4863
  * @permissionScopeId SCOPE.STORES.MANAGE-STORES
4714
4864
  * @permissionScope Read Events - all read permissions
@@ -4794,7 +4944,7 @@ interface EventStartedEnvelope {
4794
4944
  metadata: EventMetadata;
4795
4945
  }
4796
4946
  /**
4797
- * Triggered when event has started.
4947
+ * Triggered when an event has started.
4798
4948
  * @permissionScope Manage Stores
4799
4949
  * @permissionScopeId SCOPE.STORES.MANAGE-STORES
4800
4950
  * @permissionScope Read Events - all read permissions
@@ -4834,7 +4984,7 @@ interface EventUpdatedEnvelope {
4834
4984
  metadata: EventMetadata;
4835
4985
  }
4836
4986
  /**
4837
- * Triggered when event is updated.
4987
+ * Triggered when an event is updated.
4838
4988
  * @permissionScope Manage Stores
4839
4989
  * @permissionScopeId SCOPE.STORES.MANAGE-STORES
4840
4990
  * @permissionScope Read Events - all read permissions
@@ -4871,13 +5021,9 @@ interface EventUpdatedEnvelope {
4871
5021
  declare function onEventUpdated(handler: (event: EventUpdatedEnvelope) => void | Promise<void>): void;
4872
5022
  type EventNonNullablePaths = `_id` | `location.type` | `location.address.streetAddress.number` | `location.address.streetAddress.name` | `dateAndTimeSettings.recurrenceStatus` | `dateAndTimeSettings.recurringEvents.individualEventDates` | `dateAndTimeSettings.recurringEvents.individualEventDates.${number}.showTimeZone` | `slug` | `status` | `registration.type` | `registration.status` | `registration.rsvp.responseType` | `registration.rsvp.waitlistEnabled` | `registration.tickets.guestsAssignedSeparately` | `registration.tickets.ticketLimitPerOrder` | `registration.tickets.lowestPrice.value` | `registration.tickets.lowestPrice.currency` | `registration.tickets.taxSettings.type` | `registration.allowedGuestTypes` | `registration.initialType` | `registration.registrationPaused` | `registration.registrationDisabled` | `calendarUrls.google` | `calendarUrls.ics` | `form.controls` | `form.controls.${number}.type` | `form.controls.${number}.system` | `form.controls.${number}.name` | `form.controls.${number}.label` | `form.controls.${number}.orderIndex` | `form.controls.${number}._id` | `form.messages.rsvp.rsvpYesOption` | `form.messages.rsvp.rsvpNoOption` | `form.messages.rsvp.positiveMessages.title` | `form.messages.rsvp.positiveMessages.confirmation.title` | `form.messages.rsvp.positiveMessages.confirmation.message` | `form.messages.rsvp.positiveMessages.confirmation.addToCalendarActionLabel` | `form.messages.rsvp.positiveMessages.confirmation.shareActionLabel` | `form.messages.rsvp.negativeMessages.title` | `form.messages.rsvp.negativeMessages.confirmation.title` | `form.messages.rsvp.negativeMessages.confirmation.shareActionLabel` | `form.messages.rsvp.submitActionLabel` | `form.messages.checkout.title` | `form.messages.checkout.submitActionLabel` | `form.messages.checkout.confirmation.title` | `form.messages.checkout.confirmation.message` | `form.messages.checkout.confirmation.downloadTicketsLabel` | `form.messages.checkout.confirmation.addToCalendarLabel` | `form.messages.checkout.confirmation.shareEventLabel` | `form.messages.registrationClosed.message` | `form.messages.registrationClosed.exploreEventsActionLabel` | `form.messages.ticketsUnavailable.message` | `form.messages.ticketsUnavailable.exploreEventsActionLabel` | `summaries.rsvps.totalCount` | `summaries.rsvps.yesCount` | `summaries.rsvps.noCount` | `summaries.rsvps.waitlistCount` | `summaries.tickets.ticketsSold` | `summaries.tickets.revenue.amount` | `summaries.tickets.revenue.currency` | `summaries.tickets.currencyLocked` | `summaries.tickets.totalOrders` | `instanceId` | `guestListSettings.displayedPublicly` | `userId` | `onlineConferencing.enabled` | `onlineConferencing.type` | `onlineConferencing.session.hostLink` | `onlineConferencing.session.guestLink` | `seoSettings.slug` | `seoSettings.advancedSeoData.tags` | `seoSettings.advancedSeoData.tags.${number}.type` | `seoSettings.advancedSeoData.tags.${number}.children` | `seoSettings.advancedSeoData.tags.${number}.custom` | `seoSettings.advancedSeoData.tags.${number}.disabled` | `seoSettings.advancedSeoData.settings.preventAutoRedirect` | `seoSettings.advancedSeoData.settings.keywords` | `seoSettings.advancedSeoData.settings.keywords.${number}.term` | `seoSettings.advancedSeoData.settings.keywords.${number}.isMain` | `agendaSettings.enabled`;
4873
5023
  /**
4874
- * Creates an event.
4875
- *
4876
- *
4877
- * The event includes a default registration form in the selected language, which consists of input fields for first name, last name, and email. See [Registration Form](https://www.wix.com/velo/reference/wix-events-v2/forms/introduction) for more information.
4878
- *
4879
- * You can create the event as a draft by setting the draft value to true. Otherwise, the event is published right away.
4880
- *
5024
+ * Creates an event. <br> <br>
5025
+ * The event includes a default registration form in the selected language, which consists of input fields for first name, last name, and email. See the Registration Form API ([SDK](https://dev.wix.com/docs/sdk/backend-modules/events/forms/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/events/form/about-the-registration-form-api)) for more information. <br> <br>
5026
+ * You can create the event as a draft by setting `draft` to `true`. Otherwise, the event is published right away. <br> <br>
4881
5027
  * The event is automatically set up to send daily summary reports of new guests to your business email.
4882
5028
  * @param event - Event data.
4883
5029
  * @public
@@ -4906,11 +5052,10 @@ interface CreateEventOptions {
4906
5052
  fields?: RequestedFieldsWithLiterals[];
4907
5053
  }
4908
5054
  /**
4909
- * Clones an event, including the registration form, notifications, multilingual translations and ticket configuration from the original event.
4910
- *
4911
- *
4912
- * The new event's date is automatically set to 14 days from the original event date.
4913
- * If an event with the same title already exists, the new event's title gets a sequence number. For example, if you clone an event named "Leather Crafting 101", the new event's title is "Leather Crafting 101 (1)". You can change the required entity field values while cloning an event.
5055
+ * Clones an event, including the registration form, notifications, multilingual translations and ticket configuration from the original event. <br> <br>
5056
+ * The new event's date is automatically set to 14 days from the original event date. <br> <br>
5057
+ * If an event with the same `title` already exists, the new event's `title` gets a sequence number. For example, if you clone an event named `"Leather Crafting 101"`, the new event's title is `"Leather Crafting 101 (1)"`. <br> <br>
5058
+ * You can change the required entity field values while cloning an event.
4914
5059
  * @param eventId - Event ID.
4915
5060
  * @public
4916
5061
  * @requiredField eventId
@@ -4923,12 +5068,12 @@ declare function cloneEvent(eventId: string, options?: CloneEventOptions): Promi
4923
5068
  [P in EventNonNullablePaths]: `event.${P}`;
4924
5069
  }[EventNonNullablePaths]>>;
4925
5070
  interface CloneEventOptions {
4926
- /** Field values to be changed when cloning the event. */
5071
+ /** Event info to change in the cloned event. */
4927
5072
  event?: V3Event;
4928
5073
  /** Whether to clone the event as a draft. */
4929
5074
  draft?: boolean;
4930
5075
  /**
4931
- * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
5076
+ * Predefined sets of fields to return.
4932
5077
  * @maxSize 20
4933
5078
  */
4934
5079
  fields?: RequestedFieldsWithLiterals[];
@@ -4949,7 +5094,6 @@ declare function updateEvent(_id: string, options?: UpdateEventOptions): Promise
4949
5094
  __validationErrorsType?: UpdateEventValidationErrors;
4950
5095
  }>;
4951
5096
  interface UpdateEventOptions {
4952
- /** Event to update. */
4953
5097
  event: {
4954
5098
  /**
4955
5099
  * Event ID.
@@ -4969,11 +5113,14 @@ interface UpdateEventOptions {
4969
5113
  title?: string | null;
4970
5114
  /**
4971
5115
  * Short description that appears under the event title.
5116
+ * **Note:** This field is returned only when the `DETAILS` fieldset is included in the request.
4972
5117
  * @maxLength 500
4973
5118
  */
4974
5119
  shortDescription?: string | null;
4975
5120
  /**
4976
- * Detailed description of an event. You can enter the description using rich text format (add various types of markups, such as underlines, italics, bolding, color codes, bullet lists, and links by using HTML formatting tags).
5121
+ * Detailed description of an event.
5122
+ *
5123
+ * This field is deprecated.
4977
5124
  * @maxLength 50000
4978
5125
  * @deprecated Detailed description of an event.
4979
5126
  *
@@ -5003,13 +5150,7 @@ interface UpdateEventOptions {
5003
5150
  */
5004
5151
  _updatedDate?: Date | null;
5005
5152
  /**
5006
- * Event status. Possible values:
5007
- *
5008
- * - `UPCOMING`: The event is published and scheduled to start.
5009
- * - `STARTED`: The event has started.
5010
- * - `ENDED`: The event has ended.
5011
- * - `CANCELED`: The event is canceled.
5012
- * - `DRAFT`: The event is not published.
5153
+ * Event status.
5013
5154
  * @readonly
5014
5155
  */
5015
5156
  status?: StatusWithLiterals;
@@ -5074,11 +5215,7 @@ interface UpdateEventOptions {
5074
5215
  agendaSettings?: AgendaSettings;
5075
5216
  /** Visual settings for event. */
5076
5217
  eventDisplaySettings?: V3EventDisplaySettings;
5077
- /**
5078
- * Event description with rich content.
5079
- *
5080
- * For the event description to appear on your site, connect the [Rich Content Viewer](https://dev.wix.com/docs/velo/velo-only-apis/$w/rich-content-viewer/introduction) element, and assign the description value to the viewer.
5081
- */
5218
+ /** Event description. <widget src="https://apps.wix.com/_serverless/ricos-playground-services/goto/api-component" plugins="emoji,audio,codeBlock,collapsibleList,divider,emoji,file,gallery,giphy,hashtag,heading,html,image,indent,lineSpacing,link,linkPreview,spoiler,video" exampleid="9b569a8d-0fc1-40f4-987f-8bd40ecc72d0">Fallback Message for SSR and Error</widget> */
5082
5219
  description?: RichContent;
5083
5220
  /**
5084
5221
  * Event publish timestamp.
@@ -5087,16 +5224,14 @@ interface UpdateEventOptions {
5087
5224
  publishedDate?: Date | null;
5088
5225
  };
5089
5226
  /**
5090
- * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
5227
+ * Predefined sets of fields to return.
5091
5228
  * @maxSize 20
5092
5229
  */
5093
5230
  fields?: RequestedFieldsWithLiterals[];
5094
5231
  }
5095
5232
  /**
5096
- * Publishes a draft event to your live site. Once published, the event's status changes from `DRAFT` to `UPCOMING.`
5097
- *
5098
- *
5099
- * It's impossible to revert the `DRAFT` status after publishing. The only option is to clone the event, and then delete the original one.
5233
+ * Publishes a draft event to your live site. Once published, the event's status changes from `"DRAFT"` to `"UPCOMING"`. <br> <br>
5234
+ * It's impossible to revert the `"DRAFT"` status after publishing. The only option is to clone the event, then delete the original.
5100
5235
  * @param eventId - Event ID.
5101
5236
  * @public
5102
5237
  * @requiredField eventId
@@ -5112,16 +5247,14 @@ declare function publishDraftEvent(eventId: string, options?: PublishDraftEventO
5112
5247
  }>;
5113
5248
  interface PublishDraftEventOptions {
5114
5249
  /**
5115
- * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
5250
+ * Predefined sets of fields to return.
5116
5251
  * @maxSize 20
5117
5252
  */
5118
5253
  fields?: RequestedFieldsWithLiterals[];
5119
5254
  }
5120
5255
  /**
5121
- * Cancels an event.
5122
- *
5123
- *
5124
- * After cancellation, registration for an event is closed. To reuse the event, [clone](https://www.wix.com/velo/reference/wix-events-v2/wixeventsv2/cloneevent) and [publish](https://www.wix.com/velo/reference/wix-events-v2/wixeventsv2/publishdraftevent) it again.
5256
+ * Cancels an event. <br> <br>
5257
+ * After cancellation, registration for an event is closed. To reuse the event, call Clone Event and Publish Event to publish it again. <br> <br>
5125
5258
  * If event cancellation notifications are enabled, canceling an event automatically triggers the sending of cancellation emails and/or push notifications to registered guests.
5126
5259
  * @param eventId - Event ID.
5127
5260
  * @public
@@ -5138,16 +5271,14 @@ declare function cancelEvent(eventId: string, options?: CancelEventOptions): Pro
5138
5271
  }>;
5139
5272
  interface CancelEventOptions {
5140
5273
  /**
5141
- * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
5274
+ * Predefined sets of fields to return.
5142
5275
  * @maxSize 20
5143
5276
  */
5144
5277
  fields?: RequestedFieldsWithLiterals[];
5145
5278
  }
5146
5279
  /**
5147
- * Cancels multiple events that meet the given criteria.
5148
- *
5149
- *
5150
- * After cancellation, registration for an event is closed. To reuse the event, [clone](https://www.wix.com/velo/reference/wix-events-v2/wixeventsv2/cloneevent) and [publish](https://www.wix.com/velo/reference/wix-events-v2/wixeventsv2/publishdraftevent) it again.
5280
+ * Cancels multiple events that meet the specified criteria. <br> <br>
5281
+ * After cancellation, registration for an event is closed. To reuse the event, call Clone Event and Publish Event to publish it again. <br> <br>
5151
5282
  * If event cancellation notifications are enabled, canceling an event automatically triggers the sending of cancellation emails and/or push notifications to registered guests.
5152
5283
  * @public
5153
5284
  * @requiredField options.filter.filter
@@ -5158,11 +5289,11 @@ interface CancelEventOptions {
5158
5289
  */
5159
5290
  declare function bulkCancelEventsByFilter(options?: NonNullablePaths<BulkCancelEventsByFilterOptions, `filter.filter`>): Promise<void>;
5160
5291
  interface BulkCancelEventsByFilterOptions {
5161
- /** Filter. */
5292
+ /** Filter.For supported filters, see the table in [Query Events](https://dev.wix.com/docs/sdk/backend-modules/events/wix-events-v2/query-events). */
5162
5293
  filter?: CommonQueryV2;
5163
5294
  }
5164
5295
  /**
5165
- * Permanently deletes an event. <br> <br>
5296
+ * Deletes an event. <br> <br>
5166
5297
  * You can retrieve the deleted event through a GDPR access request.
5167
5298
  * @param eventId - Event ID.
5168
5299
  * @public
@@ -5173,9 +5304,7 @@ interface BulkCancelEventsByFilterOptions {
5173
5304
  */
5174
5305
  declare function deleteEvent(eventId: string): Promise<NonNullablePaths<DeleteEventResponse, `eventId`>>;
5175
5306
  /**
5176
- * Permanently deletes multiple events that meet the given criteria.
5177
- *
5178
- *
5307
+ * Deletes multiple events that meet the specified criteria. <br> <br>
5179
5308
  * You can retrieve the deleted events through a GDPR access request.
5180
5309
  * @public
5181
5310
  * @requiredField options.filter.filter
@@ -5186,18 +5315,18 @@ declare function deleteEvent(eventId: string): Promise<NonNullablePaths<DeleteEv
5186
5315
  */
5187
5316
  declare function bulkDeleteEventsByFilter(options?: NonNullablePaths<BulkDeleteEventsByFilterOptions, `filter.filter`>): Promise<void>;
5188
5317
  interface BulkDeleteEventsByFilterOptions {
5189
- /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
5318
+ /** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/get-started/api-query-language) for more details. */
5190
5319
  filter?: CommonQueryV2;
5191
5320
  }
5192
5321
  /**
5193
5322
  * Creates a query to retrieve a list of events.
5194
5323
  *
5195
5324
  *
5196
- * The `queryEvents()` function builds a query to retrieve a list of events and returns a [`EventsQueryBuilder`](https://www.wix.com/velo/reference/wix-events-v2/wixeventsv2/eventsquerybuilder) object.
5325
+ * The `queryEvents()` method builds a query to retrieve a list of events and returns a [`EventsQueryBuilder`](https://www.wix.com/velo/reference/wix-events-v2/wixeventsv2/eventsquerybuilder) object.
5197
5326
  *
5198
- * The returned object contains the query definition, which is typically used to run the query using the [`find()`](https://www.wix.com/velo/reference/wix-events-v2/wixeventsv2/eventsquerybuilder/find) function.
5327
+ * The returned object contains the query definition, which is typically used to run the query using the [`find()`](https://www.wix.com/velo/reference/wix-events-v2/wixeventsv2/eventsquerybuilder/find) method.
5199
5328
  *
5200
- * You can refine the query by chaining `EventsQueryBuilder` functions onto the query. `EventsQueryBuilder` functions enable you to sort, filter, and control the results `queryEvents()` returns.
5329
+ * You can refine the query by chaining `EventsQueryBuilder` methods onto the query. `EventsQueryBuilder` methods enable you to sort, filter, and control the results `queryEvents()` returns.
5201
5330
  *
5202
5331
  * `queryEvents()` runs with these `EventsQueryBuilder` defaults, which you can override:
5203
5332
  *
@@ -5205,7 +5334,7 @@ interface BulkDeleteEventsByFilterOptions {
5205
5334
  * - [`limit(50)`](https://www.wix.com/velo/reference/wix-events-v2/wixeventsv2/eventsquerybuilder/limit)
5206
5335
  * - [`descending("_createdDate")`](https://www.wix.com/velo/reference/wix-events-v2/wixeventsv2/eventsquerybuilder/descending)
5207
5336
  *
5208
- * The functions that are chained to `queryEvents()` are applied in the order they're called. For example, if you apply `ascending('title')` and then `descending('status')`, the results are sorted first by the `title`, and then, if there are multiple results with the same `title`, the items are sorted by `status`.
5337
+ * The methods that are chained to `queryEvents()` are applied in the order they're called. For example, if you apply `ascending('title')` and then `descending('status')`, the results are sorted first by the `title`, and then, if there are multiple results with the same `title`, the items are sorted by `status`.
5209
5338
  * @public
5210
5339
  * @param options - Optional fields.
5211
5340
  * @permissionId WIX_EVENTS.READ_EVENTS
@@ -5325,10 +5454,9 @@ interface GetEventOptions {
5325
5454
  fields?: RequestedFieldsWithLiterals[];
5326
5455
  }
5327
5456
  /**
5328
- * Retrieves an event by the `slug` URL.
5329
- *
5457
+ * Retrieves an event by the slug URL.
5330
5458
  *
5331
- * The slug is the end of an event URL that refers to a specific event. For example, if an events' URL is `https://example.com/events/event/{my-event-slug}`, the slug is `my-event-slug`.
5459
+ * The slug is the end of an event URL that refers to a specific event. For example, if an event's URL is `https://example.com/events/event/{my-event-slug}`, the slug is `my-event-slug`.
5332
5460
  * @param slug - URL slug.
5333
5461
  * @public
5334
5462
  * @requiredField slug
@@ -5346,4 +5474,4 @@ interface GetEventBySlugOptions {
5346
5474
  fields?: RequestedFieldsWithLiterals[];
5347
5475
  }
5348
5476
 
5349
- export { type ActionEvent, type Address, type AddressLocation, type AddressStreetOneOf, type Agenda, type AgendaSettings, Alignment, type AlignmentWithLiterals, type AnchorData, type AppEmbedData, type AppEmbedDataAppDataOneOf, AppType, type AppTypeWithLiterals, type AudioData, type Background, type BackgroundBackgroundOneOf, BackgroundType, type BackgroundTypeWithLiterals, type Badge, type BadgeList, BadgeTypeType, type BadgeTypeTypeWithLiterals, type BaseEventMetadata, type BlockquoteData, type BookingData, type Border, type BorderColors, type BulkCancelEventsByFilterOptions, type BulkCancelEventsByFilterRequest, type BulkCancelEventsByFilterResponse, type BulkDeleteEventsByFilterOptions, type BulkDeleteEventsByFilterRequest, type BulkDeleteEventsByFilterResponse, type BulletedListData, type ButtonData, ButtonDataType, type ButtonDataTypeWithLiterals, type CalendarLinks, type CalendarUrls, type CancelEventApplicationErrors, type CancelEventOptions, type CancelEventRequest, type CancelEventResponse, type CaptionData, type Category, type CategoryCounts, CategoryTypeType, type CategoryTypeTypeWithLiterals, type CellStyle, type CheckoutFormMessages, type CloneEventFromOtherSiteRequest, type CloneEventFromOtherSiteResponse, type CloneEventOptions, type CloneEventRequest, type CloneEventResponse, type CodeBlockData, type CollapsibleListData, type ColorData, type Colors, type CommonAddress, type CommonAddressLocation, type CommonAddressStreetOneOf, type CommonCursors, type CommonPaging, type CommonPagingMetadataV2, type CommonQueryV2, type CommonQueryV2PagingMethodOneOf, CommonSortOrder, type CommonSortOrderWithLiterals, type CommonSorting, type CommonStreetAddress, type CommonSubdivision, ConferenceType, ConferenceTypeType, type ConferenceTypeTypeWithLiterals, type ConferenceTypeWithLiterals, type CountEventsByStatusApplicationErrors, type CountEventsByStatusOptions, type CountEventsByStatusRequest, type CountEventsByStatusResponse, type CreateEventApplicationErrors, type CreateEventOptions, type CreateEventRequest, type CreateEventResponse, type CreateEventValidationErrors, Crop, type CropWithLiterals, type CursorPaging, type Cursors, type Dashboard, type DateAndTimeSettings, type Decoration, type DecorationDataOneOf, DecorationType, type DecorationTypeWithLiterals, type DeleteEventRequest, type DeleteEventResponse, type Design, type Dimensions, Direction, type DirectionWithLiterals, type DividerData, type DocumentStyle, type DomainEvent, type DomainEventBodyOneOf, type EmbedData, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type Event, type EventCanceled, type EventCanceledEnvelope, type EventCategories, type EventCategory, type EventCloned, type EventClonedEnvelope, type EventCopied, type EventCreated, type EventCreatedEnvelope, type EventData, type EventDeleted, type EventDeletedEnvelope, type EventDisplaySettings, type EventEnded, type EventEndedEnvelope, type EventEventCanceled, type EventEventEnded, type EventEventPublished, type EventEventReminder, type EventEventStarted, type EventMetadata, type EventPublished, type EventPublishedEnvelope, type EventReminder, type EventReminderEnvelope, type EventStarted, type EventStartedEnvelope, EventStatus, type EventStatusWithLiterals, EventType, type EventTypeWithLiterals, type EventUpdated, type EventUpdatedEnvelope, type EventsFeed, type EventsLabellingSettings, type EventsLocation, type EventsMoney, type EventsOccurrence, type EventsOnlineConferencing, type EventsOnlineConferencingSession, type EventsQueryBuilder, type EventsQueryResult, EventsRecurrenceStatusStatus, type EventsRecurrenceStatusStatusWithLiterals, type EventsRecurrences, type EventsRegistration, type EventsSeoSettings, EventsTaxType, type EventsTaxTypeWithLiterals, type ExportEventsRequest, type ExportEventsResponse, type ExternalEvent, type ExternalRegistration, type FacetCounts, type Feed, type FileData, type FileSource, type FileSourceDataOneOf, type FindEventRequest, type FindEventRequestFindByOneOf, type FindEventResponse, type FontSizeData, FontType, type FontTypeWithLiterals, type Form, type FormMessages, type Formatted, type GIF, type GIFData, GIFType, type GIFTypeWithLiterals, type GalleryData, type GalleryOptions, type GetEventBySlugOptions, type GetEventBySlugRequest, type GetEventBySlugResponse, type GetEventOptions, type GetEventRequest, type GetEventResponse, type Gradient, type GuestListConfig, type GuestListSettings, GuestTypeType, type GuestTypeTypeWithLiterals, type HTMLData, type HTMLDataDataOneOf, type HeadingData, type Height, type IdentificationData, type IdentificationDataIdOneOf, type Image, type ImageData, type ImageDataStyles, InitialExpandedItems, type InitialExpandedItemsWithLiterals, InitialRegistrationTypeType, type InitialRegistrationTypeTypeWithLiterals, type Input, type InputControl, InputControlType, type InputControlTypeWithLiterals, type Item, type ItemDataOneOf, type ItemStyle, type Keyword, type Label, type LabellingSettings, type Layout, type LayoutCellData, LayoutType, type LayoutTypeWithLiterals, LineStyle, type LineStyleWithLiterals, type Link, type LinkData, type LinkDataOneOf, type LinkPreviewData, type LinkPreviewDataStyles, type ListEventsByCategoryRequest, type ListEventsByCategoryResponse, type ListUserEventsRequest, type ListUserEventsResponse, type ListValue, type Location, LocationLocationType, type LocationLocationTypeWithLiterals, LocationType, type LocationTypeWithLiterals, type MapCoordinates, type MapData, type MapSettings, MapType, type MapTypeWithLiterals, type Media, type MentionData, type MessageEnvelope, type Metadata, type Money, type Negative, type NegativeResponseConfirmation, type Node, type NodeDataOneOf, type NodeStyle, NodeType, type NodeTypeWithLiterals, NullValue, type NullValueWithLiterals, type Occurrence, type Oembed, type OnlineConferencing, type OnlineConferencingConfig, type OnlineConferencingSession, type Option, type OptionDesign, type OptionLayout, type OptionSelection, type OptionSelectionSelectedOptionOneOf, type OrderedListData, Orientation, type OrientationWithLiterals, type PDFSettings, type Paging, type PagingMetadataV2, type ParagraphData, type Permissions, type PlaybackOptions, type PluginContainerData, PluginContainerDataAlignment, type PluginContainerDataAlignmentWithLiterals, type PluginContainerDataWidth, type PluginContainerDataWidthDataOneOf, type Poll, type PollData, type PollDataLayout, type PollDesign, type PollLayout, PollLayoutDirection, type PollLayoutDirectionWithLiterals, PollLayoutType, type PollLayoutTypeWithLiterals, type PollSettings, Position, type PositionWithLiterals, type Positive, type PositiveResponseConfirmation, type PublishDraftEventApplicationErrors, type PublishDraftEventOptions, type PublishDraftEventRequest, type PublishDraftEventResponse, type QueryEventsApplicationErrors, type QueryEventsOptions, type QueryEventsRequest, type QueryEventsResponse, type QueryV2, type QueryV2PagingMethodOneOf, RecurrenceStatusStatus, type RecurrenceStatusStatusWithLiterals, type Recurrences, type Registration, type RegistrationClosedMessages, RegistrationStatus, RegistrationStatusStatus, type RegistrationStatusStatusWithLiterals, type RegistrationStatusWithLiterals, RegistrationTypeType, type RegistrationTypeTypeWithLiterals, type Rel, Relation, type RelationWithLiterals, RequestedFields, type RequestedFieldsWithLiterals, type ResponseConfirmation, ResponseType, type ResponseTypeWithLiterals, type RestoreInfo, type RichContent, type RsvpCollection, type RsvpCollectionConfig, type RsvpFormMessages, type RsvpRegistration, RsvpStatusOptions, type RsvpStatusOptionsWithLiterals, type RsvpSummary, type Rsvps, type ScheduleConfig, type Scheduling, type SeoSchema, type SeoSettings, type Settings, type SiteUrl, SortOrder, type SortOrderWithLiterals, type Sorting, Source, type SourceWithLiterals, type Spoiler, type SpoilerData, State, type StateWithLiterals, Status, type StatusWithLiterals, type StreetAddress, type Styles, type StylesBorder, type Subdivision, SubdivisionSubdivisionType, type SubdivisionSubdivisionTypeWithLiterals, SubdivisionType, type SubdivisionTypeWithLiterals, type Summaries, type TableCellData, type TableData, type Tag, Target, type TargetWithLiterals, type TaxConfig, type TaxSettings, TaxType, type TaxTypeWithLiterals, TextAlignment, type TextAlignmentWithLiterals, type TextData, type TextNodeStyle, type TextStyle, type Thumbnails, ThumbnailsAlignment, type ThumbnailsAlignmentWithLiterals, type Ticketing, type TicketingConfig, type TicketingSummary, type Tickets, type TicketsRegistration, type TicketsUnavailableMessages, type TimeDuration, Type, type TypeWithLiterals, type UpdateEventApplicationErrors, type UpdateEventOptions, type UpdateEventRequest, type UpdateEventResponse, type UpdateEventValidationErrors, type UserFilter, type V3Badge, type V3Event, type V3EventDisplaySettings, ValueType, type ValueTypeWithLiterals, VerticalAlignment, type VerticalAlignmentWithLiterals, type Video, type VideoData, ViewMode, type ViewModeWithLiterals, ViewRole, type ViewRoleWithLiterals, VisitorType, type VisitorTypeWithLiterals, VoteRole, type VoteRoleWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, Width, WidthType, type WidthTypeWithLiterals, type WidthWithLiterals, bulkCancelEventsByFilter, bulkDeleteEventsByFilter, cancelEvent, cloneEvent, countEventsByStatus, createEvent, deleteEvent, getEvent, getEventBySlug, onEventCanceled, onEventCloned, onEventCreated, onEventDeleted, onEventEnded, onEventPublished, onEventReminder, onEventStarted, onEventUpdated, publishDraftEvent, queryEvents, updateEvent };
5477
+ export { type ActionEvent, type Address, type AddressLocation, type AddressStreetOneOf, type Agenda, type AgendaSettings, Alignment, type AlignmentWithLiterals, type AnchorData, type AppEmbedData, type AppEmbedDataAppDataOneOf, AppType, type AppTypeWithLiterals, AspectRatio, type AspectRatioWithLiterals, type AudioData, type Background, type BackgroundBackgroundOneOf, BackgroundType, type BackgroundTypeWithLiterals, type Badge, type BadgeList, BadgeTypeType, type BadgeTypeTypeWithLiterals, type BaseEventMetadata, type BlockquoteData, type BookingData, type Border, type BorderColors, type BulkCancelEventsByFilterOptions, type BulkCancelEventsByFilterRequest, type BulkCancelEventsByFilterResponse, type BulkDeleteEventsByFilterOptions, type BulkDeleteEventsByFilterRequest, type BulkDeleteEventsByFilterResponse, type BulletedListData, type ButtonData, ButtonDataType, type ButtonDataTypeWithLiterals, type ButtonStyles, type CalendarLinks, type CalendarUrls, type CancelEventApplicationErrors, type CancelEventOptions, type CancelEventRequest, type CancelEventResponse, type CaptionData, type CardStyles, CardStylesType, type CardStylesTypeWithLiterals, type Category, type CategoryCounts, CategoryTypeType, type CategoryTypeTypeWithLiterals, type CellStyle, type CheckoutFormMessages, type CloneEventFromOtherSiteRequest, type CloneEventFromOtherSiteResponse, type CloneEventOptions, type CloneEventRequest, type CloneEventResponse, type CodeBlockData, type CollapsibleListData, type ColorData, type Colors, type CommonAddress, type CommonAddressLocation, type CommonAddressStreetOneOf, type CommonCursors, type CommonPaging, type CommonPagingMetadataV2, type CommonQueryV2, type CommonQueryV2PagingMethodOneOf, CommonSortOrder, type CommonSortOrderWithLiterals, type CommonSorting, type CommonStreetAddress, type CommonSubdivision, ConferenceType, ConferenceTypeType, type ConferenceTypeTypeWithLiterals, type ConferenceTypeWithLiterals, type CountEventsByStatusApplicationErrors, type CountEventsByStatusOptions, type CountEventsByStatusRequest, type CountEventsByStatusResponse, type CreateEventApplicationErrors, type CreateEventOptions, type CreateEventRequest, type CreateEventResponse, type CreateEventValidationErrors, Crop, type CropWithLiterals, type CursorPaging, type Cursors, type Dashboard, type DateAndTimeSettings, type Decoration, type DecorationDataOneOf, DecorationType, type DecorationTypeWithLiterals, type DeleteEventRequest, type DeleteEventResponse, type Design, type Dimensions, Direction, type DirectionWithLiterals, type DividerData, DividerDataAlignment, type DividerDataAlignmentWithLiterals, type DocumentStyle, type DomainEvent, type DomainEventBodyOneOf, type EmbedData, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type Event, type EventCanceled, type EventCanceledEnvelope, type EventCategories, type EventCategory, type EventCloned, type EventClonedEnvelope, type EventCopied, type EventCreated, type EventCreatedEnvelope, type EventData, type EventDeleted, type EventDeletedEnvelope, type EventDisplaySettings, type EventEnded, type EventEndedEnvelope, type EventEventCanceled, type EventEventEnded, type EventEventPublished, type EventEventReminder, type EventEventStarted, type EventMetadata, type EventPublished, type EventPublishedEnvelope, type EventReminder, type EventReminderEnvelope, type EventStarted, type EventStartedEnvelope, EventStatus, type EventStatusWithLiterals, EventType, type EventTypeWithLiterals, type EventUpdated, type EventUpdatedEnvelope, type EventsFeed, type EventsLabellingSettings, type EventsLocation, type EventsMoney, type EventsOccurrence, type EventsOnlineConferencing, type EventsOnlineConferencingSession, type EventsQueryBuilder, type EventsQueryResult, EventsRecurrenceStatusStatus, type EventsRecurrenceStatusStatusWithLiterals, type EventsRecurrences, type EventsRegistration, type EventsSeoSettings, EventsTaxType, type EventsTaxTypeWithLiterals, type ExportEventsRequest, type ExportEventsResponse, type ExternalEvent, type ExternalRegistration, type FacetCounts, type Feed, type FileData, type FileSource, type FileSourceDataOneOf, type FindEventRequest, type FindEventRequestFindByOneOf, type FindEventResponse, type FontSizeData, FontType, type FontTypeWithLiterals, type Form, type FormMessages, type Formatted, type GIF, type GIFData, GIFType, type GIFTypeWithLiterals, type GalleryData, type GalleryOptions, type GalleryOptionsLayout, type GetEventBySlugOptions, type GetEventBySlugRequest, type GetEventBySlugResponse, type GetEventOptions, type GetEventRequest, type GetEventResponse, type Gradient, type GuestListConfig, type GuestListSettings, GuestTypeType, type GuestTypeTypeWithLiterals, type HTMLData, type HTMLDataDataOneOf, type HeadingData, type Height, type IdentificationData, type IdentificationDataIdOneOf, type Image, type ImageData, type ImageDataStyles, type ImageStyles, InitialExpandedItems, type InitialExpandedItemsWithLiterals, InitialRegistrationTypeType, type InitialRegistrationTypeTypeWithLiterals, type Input, type InputControl, InputControlType, type InputControlTypeWithLiterals, type Item, type ItemDataOneOf, type ItemStyle, type Keyword, type Label, type LabellingSettings, Layout, type LayoutCellData, LayoutType, type LayoutTypeWithLiterals, type LayoutWithLiterals, LineStyle, type LineStyleWithLiterals, type Link, type LinkData, type LinkDataOneOf, type LinkPreviewData, type LinkPreviewDataStyles, type ListEventsByCategoryRequest, type ListEventsByCategoryResponse, type ListUserEventsRequest, type ListUserEventsResponse, type ListValue, type Location, LocationLocationType, type LocationLocationTypeWithLiterals, LocationType, type LocationTypeWithLiterals, type MapCoordinates, type MapData, type MapSettings, MapType, type MapTypeWithLiterals, type Media, type MentionData, type MessageEnvelope, type Metadata, type Money, type Negative, type NegativeResponseConfirmation, type Node, type NodeDataOneOf, type NodeStyle, NodeType, type NodeTypeWithLiterals, NullValue, type NullValueWithLiterals, type Occurrence, type Oembed, type OnlineConferencing, type OnlineConferencingConfig, type OnlineConferencingSession, type Option, type OptionDesign, type OptionLayout, type OptionSelection, type OptionSelectionSelectedOptionOneOf, type OrderedListData, Orientation, type OrientationWithLiterals, type PDFSettings, type Paging, type PagingMetadataV2, type ParagraphData, type Permissions, Placement, type PlacementWithLiterals, type PlaybackOptions, type PluginContainerData, PluginContainerDataAlignment, type PluginContainerDataAlignmentWithLiterals, type PluginContainerDataWidth, type PluginContainerDataWidthDataOneOf, type Poll, type PollData, type PollDataLayout, type PollDesign, type PollLayout, PollLayoutDirection, type PollLayoutDirectionWithLiterals, PollLayoutType, type PollLayoutTypeWithLiterals, type PollSettings, Position, type PositionWithLiterals, type Positive, type PositiveResponseConfirmation, type PublishDraftEventApplicationErrors, type PublishDraftEventOptions, type PublishDraftEventRequest, type PublishDraftEventResponse, type QueryEventsApplicationErrors, type QueryEventsOptions, type QueryEventsRequest, type QueryEventsResponse, type QueryV2, type QueryV2PagingMethodOneOf, RecurrenceStatusStatus, type RecurrenceStatusStatusWithLiterals, type Recurrences, type Registration, type RegistrationClosedMessages, RegistrationStatus, RegistrationStatusStatus, type RegistrationStatusStatusWithLiterals, type RegistrationStatusWithLiterals, RegistrationTypeType, type RegistrationTypeTypeWithLiterals, type Rel, Relation, type RelationWithLiterals, RequestedFields, type RequestedFieldsWithLiterals, Resizing, type ResizingWithLiterals, type ResponseConfirmation, ResponseType, type ResponseTypeWithLiterals, type RestoreInfo, type RibbonStyles, type RichContent, type RsvpCollection, type RsvpCollectionConfig, type RsvpFormMessages, type RsvpRegistration, RsvpStatusOptions, type RsvpStatusOptionsWithLiterals, type RsvpSummary, type Rsvps, type ScheduleConfig, type Scheduling, type SeoSchema, type SeoSettings, type Settings, type SiteUrl, SortOrder, type SortOrderWithLiterals, type Sorting, Source, type SourceWithLiterals, type Spoiler, type SpoilerData, State, type StateWithLiterals, Status, type StatusWithLiterals, type StreetAddress, type Styles, type StylesBorder, StylesPosition, type StylesPositionWithLiterals, type Subdivision, SubdivisionSubdivisionType, type SubdivisionSubdivisionTypeWithLiterals, SubdivisionType, type SubdivisionTypeWithLiterals, type Summaries, type TableCellData, type TableData, type Tag, Target, type TargetWithLiterals, type TaxConfig, type TaxSettings, TaxType, type TaxTypeWithLiterals, TextAlignment, type TextAlignmentWithLiterals, type TextData, type TextNodeStyle, type TextStyle, type Thumbnails, ThumbnailsAlignment, type ThumbnailsAlignmentWithLiterals, type Ticketing, type TicketingConfig, type TicketingSummary, type Tickets, type TicketsRegistration, type TicketsUnavailableMessages, type TimeDuration, Type, type TypeWithLiterals, type UpdateEventApplicationErrors, type UpdateEventOptions, type UpdateEventRequest, type UpdateEventResponse, type UpdateEventValidationErrors, type UserFilter, type V3Badge, type V3Event, type V3EventDisplaySettings, ValueType, type ValueTypeWithLiterals, VerticalAlignment, type VerticalAlignmentWithLiterals, type Video, type VideoData, ViewMode, type ViewModeWithLiterals, ViewRole, type ViewRoleWithLiterals, VisitorType, type VisitorTypeWithLiterals, VoteRole, type VoteRoleWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, Width, WidthType, type WidthTypeWithLiterals, type WidthWithLiterals, bulkCancelEventsByFilter, bulkDeleteEventsByFilter, cancelEvent, cloneEvent, countEventsByStatus, createEvent, deleteEvent, getEvent, getEventBySlug, onEventCanceled, onEventCloned, onEventCreated, onEventDeleted, onEventEnded, onEventPublished, onEventReminder, onEventStarted, onEventUpdated, publishDraftEvent, queryEvents, updateEvent };