@wix/auto_sdk_events_wix-events-v-2 1.0.6 → 1.0.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (21) hide show
  1. package/build/cjs/src/events-v3-event-wix-events-v-2.types.d.ts +644 -149
  2. package/build/cjs/src/events-v3-event-wix-events-v-2.types.js.map +1 -1
  3. package/build/cjs/src/events-v3-event-wix-events-v-2.universal.d.ts +703 -156
  4. package/build/cjs/src/events-v3-event-wix-events-v-2.universal.js +8 -0
  5. package/build/cjs/src/events-v3-event-wix-events-v-2.universal.js.map +1 -1
  6. package/build/es/src/events-v3-event-wix-events-v-2.types.d.ts +644 -149
  7. package/build/es/src/events-v3-event-wix-events-v-2.types.js.map +1 -1
  8. package/build/es/src/events-v3-event-wix-events-v-2.universal.d.ts +703 -156
  9. package/build/es/src/events-v3-event-wix-events-v-2.universal.js +8 -0
  10. package/build/es/src/events-v3-event-wix-events-v-2.universal.js.map +1 -1
  11. package/build/internal/cjs/src/events-v3-event-wix-events-v-2.types.d.ts +644 -149
  12. package/build/internal/cjs/src/events-v3-event-wix-events-v-2.types.js.map +1 -1
  13. package/build/internal/cjs/src/events-v3-event-wix-events-v-2.universal.d.ts +703 -156
  14. package/build/internal/cjs/src/events-v3-event-wix-events-v-2.universal.js +8 -0
  15. package/build/internal/cjs/src/events-v3-event-wix-events-v-2.universal.js.map +1 -1
  16. package/build/internal/es/src/events-v3-event-wix-events-v-2.types.d.ts +644 -149
  17. package/build/internal/es/src/events-v3-event-wix-events-v-2.types.js.map +1 -1
  18. package/build/internal/es/src/events-v3-event-wix-events-v-2.universal.d.ts +703 -156
  19. package/build/internal/es/src/events-v3-event-wix-events-v-2.universal.js +8 -0
  20. package/build/internal/es/src/events-v3-event-wix-events-v-2.universal.js.map +1 -1
  21. package/package.json +2 -2
@@ -1,6 +1,7 @@
1
1
  export interface V3Event {
2
2
  /**
3
3
  * Event ID.
4
+ * @format GUID
4
5
  * @readonly
5
6
  */
6
7
  id?: string;
@@ -8,17 +9,23 @@ export interface V3Event {
8
9
  location?: Location;
9
10
  /** Event date and time settings. */
10
11
  dateAndTimeSettings?: DateAndTimeSettings;
11
- /** Event title. */
12
+ /**
13
+ * Event title.
14
+ * @minLength 1
15
+ * @maxLength 120
16
+ */
12
17
  title?: string | null;
13
18
  /**
14
19
  * Short description that appears under the event title. <br>
15
20
  * **Note:** This field is returned only when the `DETAILS` fieldset is included in the request.
21
+ * @maxLength 500
16
22
  */
17
23
  shortDescription?: string | null;
18
24
  /**
19
25
  * Detailed description of an event.
20
26
  *
21
27
  * This field is deprecated.
28
+ * @maxLength 50000
22
29
  * @deprecated Detailed description of an event.
23
30
  *
24
31
  * This field is deprecated.
@@ -87,6 +94,7 @@ export interface V3Event {
87
94
  /**
88
95
  * ID of the user who created the event.
89
96
  * @readonly
97
+ * @format GUID
90
98
  */
91
99
  userId?: string;
92
100
  /**
@@ -120,7 +128,10 @@ export interface V3Event {
120
128
  publishedDate?: Date | null;
121
129
  }
122
130
  export interface Location {
123
- /** Location name. This value is displayed instead of the address when the location is defined as TBD by setting the `locationTbd` property to `true`. */
131
+ /**
132
+ * Location name. This value is displayed instead of the address when the location is defined as TBD by setting the `locationTbd` property to `true`.
133
+ * @maxLength 50
134
+ */
124
135
  name?: string | null;
125
136
  /** Location type. */
126
137
  type?: LocationType;
@@ -141,42 +152,83 @@ export declare enum LocationType {
141
152
  export interface CommonAddress extends CommonAddressStreetOneOf {
142
153
  /** Street address. */
143
154
  streetAddress?: CommonStreetAddress;
144
- /** Primary address information (street and building number). */
155
+ /**
156
+ * Primary address information (street and building number).
157
+ * @maxLength 250
158
+ */
145
159
  addressLine?: string | null;
146
- /** 2-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */
160
+ /**
161
+ * 2-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format.
162
+ * @format COUNTRY
163
+ */
147
164
  country?: string | null;
148
- /** Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */
165
+ /**
166
+ * Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2).
167
+ * @maxLength 20
168
+ */
149
169
  subdivision?: string | null;
150
- /** City name. */
170
+ /**
171
+ * City name.
172
+ * @maxLength 100
173
+ */
151
174
  city?: string | null;
152
- /** Zip or postal code. */
175
+ /**
176
+ * Zip or postal code.
177
+ * @maxLength 100
178
+ */
153
179
  postalCode?: string | null;
154
- /** Secondary address information (suite or apartment number and room number). */
180
+ /**
181
+ * Secondary address information (suite or apartment number and room number).
182
+ * @maxLength 250
183
+ */
155
184
  addressLine2?: string | null;
156
185
  }
157
186
  /** @oneof */
158
187
  export interface CommonAddressStreetOneOf {
159
188
  /** Street address. */
160
189
  streetAddress?: CommonStreetAddress;
161
- /** Primary address information (street and building number). */
190
+ /**
191
+ * Primary address information (street and building number).
192
+ * @maxLength 250
193
+ */
162
194
  addressLine?: string | null;
163
195
  }
164
196
  export interface CommonStreetAddress {
165
- /** Street number. */
197
+ /**
198
+ * Street number.
199
+ * @maxLength 100
200
+ */
166
201
  number?: string;
167
- /** Street name. */
202
+ /**
203
+ * Street name.
204
+ * @maxLength 250
205
+ */
168
206
  name?: string;
169
207
  }
170
208
  export interface CommonAddressLocation {
171
- /** Address latitude coordinates. */
209
+ /**
210
+ * Address latitude coordinates.
211
+ * @min -90
212
+ * @max 90
213
+ */
172
214
  latitude?: number | null;
173
- /** Address longitude coordinates. */
215
+ /**
216
+ * Address longitude coordinates.
217
+ * @min -180
218
+ * @max 180
219
+ */
174
220
  longitude?: number | null;
175
221
  }
176
222
  export interface CommonSubdivision {
177
- /** Short subdivision code. */
223
+ /**
224
+ * Short subdivision code.
225
+ * @maxLength 100
226
+ */
178
227
  code?: string;
179
- /** Subdivision full name. */
228
+ /**
229
+ * Subdivision full name.
230
+ * @maxLength 250
231
+ */
180
232
  name?: string;
181
233
  }
182
234
  export declare enum SubdivisionSubdivisionType {
@@ -197,13 +249,19 @@ export declare enum SubdivisionSubdivisionType {
197
249
  export interface DateAndTimeSettings {
198
250
  /** Whether the event date and time are TBD. */
199
251
  dateAndTimeTbd?: boolean | null;
200
- /** Message that is displayed when time and date is TBD. */
252
+ /**
253
+ * Message that is displayed when time and date is TBD.
254
+ * @maxLength 100
255
+ */
201
256
  dateAndTimeTbdMessage?: string | null;
202
257
  /** Event start date. */
203
258
  startDate?: Date | null;
204
259
  /** Event end date. */
205
260
  endDate?: Date | null;
206
- /** Event time zone ID in the [TZ database](https://www.iana.org/time-zones) format. */
261
+ /**
262
+ * Event time zone ID in the [TZ database](https://www.iana.org/time-zones) format.
263
+ * @maxLength 100
264
+ */
207
265
  timeZoneId?: string | null;
208
266
  /** Whether the end date is hidden in the formatted date and time. */
209
267
  hideEndDate?: boolean | null;
@@ -234,11 +292,15 @@ export declare enum RecurrenceStatusStatus {
234
292
  RECURRING_RECENTLY_CANCELED = "RECURRING_RECENTLY_CANCELED"
235
293
  }
236
294
  export interface Recurrences {
237
- /** Individual event dates. */
295
+ /**
296
+ * Individual event dates.
297
+ * @maxSize 1000
298
+ */
238
299
  individualEventDates?: Occurrence[];
239
300
  /**
240
301
  * Recurring event category ID.
241
302
  * @readonly
303
+ * @maxLength 100
242
304
  */
243
305
  categoryId?: string | null;
244
306
  }
@@ -247,7 +309,10 @@ export interface Occurrence {
247
309
  startDate?: Date | null;
248
310
  /** Event end date. */
249
311
  endDate?: Date | null;
250
- /** Event time zone ID in the [TZ database](https://www.iana.org/time-zones) format. */
312
+ /**
313
+ * Event time zone ID in the [TZ database](https://www.iana.org/time-zones) format.
314
+ * @maxLength 100
315
+ */
251
316
  timeZoneId?: string | null;
252
317
  /** Whether the time zone is displayed in a formatted schedule. */
253
318
  showTimeZone?: boolean;
@@ -258,26 +323,31 @@ export interface Formatted {
258
323
  * 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>
259
324
  * 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`.
260
325
  * @readonly
326
+ * @maxLength 500
261
327
  */
262
328
  dateAndTime?: string | null;
263
329
  /**
264
330
  * Formatted start date of the event. Empty for TBD schedules.
265
331
  * @readonly
332
+ * @maxLength 500
266
333
  */
267
334
  startDate?: string | null;
268
335
  /**
269
336
  * Formatted start time of the event. Empty for TBD schedules.
270
337
  * @readonly
338
+ * @maxLength 500
271
339
  */
272
340
  startTime?: string | null;
273
341
  /**
274
342
  * Formatted end date of the event. Empty for TBD schedules or when the end date is hidden.
275
343
  * @readonly
344
+ * @maxLength 500
276
345
  */
277
346
  endDate?: string | null;
278
347
  /**
279
348
  * Formatted end time of the event. Empty for TBD schedules or when the end date is hidden.
280
349
  * @readonly
350
+ * @maxLength 500
281
351
  */
282
352
  endTime?: string | null;
283
353
  }
@@ -288,9 +358,15 @@ export interface Formatted {
288
358
  export interface TimeDuration {
289
359
  /** Number of days. */
290
360
  days?: number;
291
- /** Number of hours. */
361
+ /**
362
+ * Number of hours.
363
+ * @max 24
364
+ */
292
365
  hours?: number;
293
- /** Number of minutes. */
366
+ /**
367
+ * Number of minutes.
368
+ * @max 60
369
+ */
294
370
  minutes?: number;
295
371
  }
296
372
  export declare enum Status {
@@ -308,9 +384,15 @@ export declare enum Status {
308
384
  DRAFT = "DRAFT"
309
385
  }
310
386
  export interface PageUrl {
311
- /** The base URL. For premium sites, the base is the domain. For free sites, the base is the Wix site URL (for example, `https://mysite.wixsite.com/mysite`). */
387
+ /**
388
+ * The base URL. For premium sites, the base is the domain. For free sites, the base is the Wix site URL (for example, `https://mysite.wixsite.com/mysite`).
389
+ * @maxLength 500
390
+ */
312
391
  base?: string;
313
- /** The path to the page. For example, `/product-page/a-product`. */
392
+ /**
393
+ * The path to the page. For example, `/product-page/a-product`.
394
+ * @maxLength 500
395
+ */
314
396
  path?: string;
315
397
  }
316
398
  export interface Registration {
@@ -332,7 +414,10 @@ export interface Registration {
332
414
  external?: ExternalRegistration;
333
415
  /** Types of guests allowed to register. */
334
416
  allowedGuestTypes?: GuestTypeType;
335
- /** Initial event type which is set when creating an event. */
417
+ /**
418
+ * Initial event type which is set when creating an event.
419
+ * @immutable
420
+ */
336
421
  initialType?: InitialRegistrationTypeType;
337
422
  /** Whether the registration is paused. */
338
423
  registrationPaused?: boolean;
@@ -395,6 +480,7 @@ export interface TicketsRegistration {
395
480
  /**
396
481
  * Ticket limit per order. <br>
397
482
  * Default: 20 tickets.
483
+ * @max 50
398
484
  */
399
485
  ticketLimitPerOrder?: number;
400
486
  /** Ticket price currency. */
@@ -422,9 +508,15 @@ export interface TicketsRegistration {
422
508
  * Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.
423
509
  */
424
510
  export interface Money {
425
- /** Amount of money in decimal form. A period is used as a decimal separator (for example, `3.99`). */
511
+ /**
512
+ * Amount of money in decimal form. A period is used as a decimal separator (for example, `3.99`).
513
+ * @format DECIMAL_VALUE
514
+ */
426
515
  value?: string;
427
- /** Currency code in 3-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. */
516
+ /**
517
+ * Currency code in 3-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
518
+ * @format CURRENCY
519
+ */
428
520
  currency?: string;
429
521
  /**
430
522
  * Amount of money in decimal form. A period or comma are used as a decimal separator (for example, `1 000,30`).
@@ -435,9 +527,16 @@ export interface Money {
435
527
  export interface TaxSettings {
436
528
  /** Tax application settings. */
437
529
  type?: TaxType;
438
- /** Tax name. */
530
+ /**
531
+ * Tax name.
532
+ * @minLength 1
533
+ * @maxLength 10
534
+ */
439
535
  name?: string | null;
440
- /** Tax rate (for example,`21.55`). */
536
+ /**
537
+ * Tax rate (for example,`21.55`).
538
+ * @decimalValue options - {gte:0.001,lte:100,maxScale:3}
539
+ */
441
540
  rate?: string | null;
442
541
  /** Apply tax to donations. */
443
542
  appliedToDonations?: boolean | null;
@@ -452,7 +551,10 @@ export declare enum TaxType {
452
551
  ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
453
552
  }
454
553
  export interface ExternalRegistration {
455
- /** External event registration URL. */
554
+ /**
555
+ * External event registration URL.
556
+ * @format WEB_URL
557
+ */
456
558
  url?: string | null;
457
559
  }
458
560
  export declare enum GuestTypeType {
@@ -472,7 +574,11 @@ export declare enum InitialRegistrationTypeType {
472
574
  TICKETING = "TICKETING"
473
575
  }
474
576
  export interface CommonImage {
475
- /** WixMedia image ID. */
577
+ /**
578
+ * WixMedia image ID.
579
+ * @minLength 1
580
+ * @maxLength 200
581
+ */
476
582
  id?: string;
477
583
  /** Image URL. */
478
584
  url?: string;
@@ -627,21 +733,29 @@ export declare enum ValueType {
627
733
  * Defaults to first (0th) option if not configured.
628
734
  */
629
735
  export interface OptionSelection extends OptionSelectionSelectedOptionOneOf {
630
- /** 0-based index from predefined `input.options` which is selected initially. */
736
+ /**
737
+ * 0-based index from predefined `input.options` which is selected initially.
738
+ * @max 199
739
+ */
631
740
  optionIndex?: number;
632
741
  /**
633
742
  * Placeholder hint describing expected choices (such as "Please select").
634
743
  * Considered an empty choice.
744
+ * @maxLength 200
635
745
  */
636
746
  placeholderText?: string;
637
747
  }
638
748
  /** @oneof */
639
749
  export interface OptionSelectionSelectedOptionOneOf {
640
- /** 0-based index from predefined `input.options` which is selected initially. */
750
+ /**
751
+ * 0-based index from predefined `input.options` which is selected initially.
752
+ * @max 199
753
+ */
641
754
  optionIndex?: number;
642
755
  /**
643
756
  * Placeholder hint describing expected choices (such as "Please select").
644
757
  * Considered an empty choice.
758
+ * @maxLength 200
645
759
  */
646
760
  placeholderText?: string;
647
761
  }
@@ -753,12 +867,19 @@ export interface Summaries {
753
867
  export interface EventsMoney {
754
868
  /**
755
869
  * *Deprecated:** Use `value` instead.
870
+ * @format DECIMAL_VALUE
756
871
  * @deprecated
757
872
  */
758
873
  amount?: string;
759
- /** ISO 4217 format of the currency e.g., `USD`. */
874
+ /**
875
+ * ISO 4217 format of the currency e.g., `USD`.
876
+ * @format CURRENCY
877
+ */
760
878
  currency?: string;
761
- /** Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, starts with a single (-), to indicate that the amount is negative. */
879
+ /**
880
+ * Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, starts with a single (-), to indicate that the amount is negative.
881
+ * @format DECIMAL_VALUE
882
+ */
762
883
  value?: string | null;
763
884
  }
764
885
  export interface Rsvps {
@@ -821,7 +942,10 @@ export interface Feed {
821
942
  export interface OnlineConferencing {
822
943
  /** 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. */
823
944
  enabled?: boolean;
824
- /** Conference host ID. */
945
+ /**
946
+ * Conference host ID.
947
+ * @format GUID
948
+ */
825
949
  providerId?: string | null;
826
950
  /** Conference type. */
827
951
  type?: ConferenceTypeType;
@@ -864,7 +988,10 @@ export interface OnlineConferencingSession {
864
988
  sessionId?: string | null;
865
989
  }
866
990
  export interface SeoSettings {
867
- /** URL slug. */
991
+ /**
992
+ * URL slug.
993
+ * @maxLength 130
994
+ */
868
995
  slug?: string;
869
996
  /** Advanced SEO data. */
870
997
  advancedSeoData?: SeoSchema;
@@ -890,7 +1017,10 @@ export interface Keyword {
890
1017
  term?: string;
891
1018
  /** Whether the keyword is the main focus keyword. */
892
1019
  isMain?: boolean;
893
- /** The source that added the keyword terms to the SEO settings. */
1020
+ /**
1021
+ * The source that added the keyword terms to the SEO settings.
1022
+ * @maxLength 1000
1023
+ */
894
1024
  origin?: string | null;
895
1025
  }
896
1026
  export interface Tag {
@@ -923,7 +1053,10 @@ export interface Settings {
923
1053
  * Default: `false` (Auto Redirect is enabled.)
924
1054
  */
925
1055
  preventAutoRedirect?: boolean;
926
- /** User-selected keyword terms for a specific page. */
1056
+ /**
1057
+ * User-selected keyword terms for a specific page.
1058
+ * @maxSize 5
1059
+ */
927
1060
  keywords?: Keyword[];
928
1061
  }
929
1062
  export interface AgendaSettings {
@@ -936,16 +1069,24 @@ export interface AgendaSettings {
936
1069
  pageUrl?: PageUrl;
937
1070
  }
938
1071
  export interface EventCategories {
939
- /** Event categories. */
1072
+ /**
1073
+ * Event categories.
1074
+ * @maxSize 10
1075
+ */
940
1076
  categories?: EventCategory[];
941
1077
  }
942
1078
  export interface EventCategory {
943
1079
  /**
944
1080
  * Category ID.
1081
+ * @format GUID
945
1082
  * @readonly
946
1083
  */
947
1084
  id?: string;
948
- /** Category name. */
1085
+ /**
1086
+ * Category name.
1087
+ * @minLength 1
1088
+ * @maxLength 30
1089
+ */
949
1090
  name?: string;
950
1091
  /**
951
1092
  * Category creation timestamp.
@@ -1575,11 +1716,20 @@ export interface GIFData {
1575
1716
  gifType?: GIFType;
1576
1717
  }
1577
1718
  export interface GIF {
1578
- /** GIF format URL. */
1719
+ /**
1720
+ * GIF format URL.
1721
+ * @format WEB_URL
1722
+ */
1579
1723
  gif?: string | null;
1580
- /** MP4 format URL. */
1724
+ /**
1725
+ * MP4 format URL.
1726
+ * @format WEB_URL
1727
+ */
1581
1728
  mp4?: string | null;
1582
- /** Thumbnail URL. */
1729
+ /**
1730
+ * Thumbnail URL.
1731
+ * @format WEB_URL
1732
+ */
1583
1733
  still?: string | null;
1584
1734
  }
1585
1735
  export declare enum GIFType {
@@ -1653,7 +1803,10 @@ export interface ImageData {
1653
1803
  export interface StylesBorder {
1654
1804
  /** Border width in pixels. */
1655
1805
  width?: number | null;
1656
- /** Border color. */
1806
+ /**
1807
+ * Border color as a hexadecimal value.
1808
+ * @format COLOR_HEX
1809
+ */
1657
1810
  color?: string | null;
1658
1811
  /** Border radius in pixels. */
1659
1812
  radius?: number | null;
@@ -1807,13 +1960,22 @@ export declare enum BackgroundType {
1807
1960
  export interface Gradient {
1808
1961
  /** The gradient angle in degrees. */
1809
1962
  angle?: number | null;
1810
- /** The start color as a hexademical value. */
1963
+ /**
1964
+ * The start color as a hexademical value.
1965
+ * @format COLOR_HEX
1966
+ */
1811
1967
  startColor?: string | null;
1812
- /** The end color as a hexademical value. */
1968
+ /**
1969
+ * The end color as a hexademical value.
1970
+ * @format COLOR_HEX
1971
+ */
1813
1972
  lastColor?: string | null;
1814
1973
  }
1815
1974
  export interface Background extends BackgroundBackgroundOneOf {
1816
- /** The background color as a hexademical value. */
1975
+ /**
1976
+ * The background color as a hexademical value.
1977
+ * @format COLOR_HEX
1978
+ */
1817
1979
  color?: string | null;
1818
1980
  /** An image to use for the background. */
1819
1981
  image?: Media;
@@ -1824,7 +1986,10 @@ export interface Background extends BackgroundBackgroundOneOf {
1824
1986
  }
1825
1987
  /** @oneof */
1826
1988
  export interface BackgroundBackgroundOneOf {
1827
- /** The background color as a hexademical value. */
1989
+ /**
1990
+ * The background color as a hexademical value.
1991
+ * @format COLOR_HEX
1992
+ */
1828
1993
  color?: string | null;
1829
1994
  /** An image to use for the background. */
1830
1995
  image?: Media;
@@ -2136,17 +2301,32 @@ export declare enum VerticalAlignment {
2136
2301
  export interface CellStyle {
2137
2302
  /** Vertical alignment for the cell's text. */
2138
2303
  verticalAlignment?: VerticalAlignment;
2139
- /** Cell background color as a hexadecimal value. */
2304
+ /**
2305
+ * Cell background color as a hexadecimal value.
2306
+ * @format COLOR_HEX
2307
+ */
2140
2308
  backgroundColor?: string | null;
2141
2309
  }
2142
2310
  export interface BorderColors {
2143
- /** Left border color as a hexadecimal value. */
2311
+ /**
2312
+ * Left border color as a hexadecimal value.
2313
+ * @format COLOR_HEX
2314
+ */
2144
2315
  left?: string | null;
2145
- /** Right border color as a hexadecimal value. */
2316
+ /**
2317
+ * Right border color as a hexadecimal value.
2318
+ * @format COLOR_HEX
2319
+ */
2146
2320
  right?: string | null;
2147
- /** Top border color as a hexadecimal value. */
2321
+ /**
2322
+ * Top border color as a hexadecimal value.
2323
+ * @format COLOR_HEX
2324
+ */
2148
2325
  top?: string | null;
2149
- /** Bottom border color as a hexadecimal value. */
2326
+ /**
2327
+ * Bottom border color as a hexadecimal value.
2328
+ * @format COLOR_HEX
2329
+ */
2150
2330
  bottom?: string | null;
2151
2331
  }
2152
2332
  /**
@@ -2257,27 +2437,43 @@ export interface TextNodeStyle {
2257
2437
  export interface EventEventStarted {
2258
2438
  /** Event schedule configuration. */
2259
2439
  timestamp?: Date | null;
2260
- /** Event ID. */
2440
+ /**
2441
+ * Event ID.
2442
+ * @format GUID
2443
+ */
2261
2444
  eventId?: string;
2262
2445
  }
2263
2446
  export interface EventEventEnded {
2264
2447
  /** Event end timestamp in ISO UTC format. */
2265
2448
  timestamp?: Date | null;
2266
- /** Event ID. */
2449
+ /**
2450
+ * Event ID.
2451
+ * @format GUID
2452
+ */
2267
2453
  eventId?: string;
2268
2454
  }
2269
2455
  export interface EventEventReminder {
2270
2456
  /** Reminder timestamp in ISO UTC format. */
2271
2457
  timestamp?: Date | null;
2272
- /** Event ID. */
2458
+ /**
2459
+ * Event ID.
2460
+ * @format GUID
2461
+ */
2273
2462
  eventId?: string;
2274
2463
  /** Event location. */
2275
2464
  location?: Location;
2276
2465
  /** Event schedule configuration. */
2277
2466
  dateAndTimeSettings?: DateAndTimeSettings;
2278
- /** Event title. */
2467
+ /**
2468
+ * Event title.
2469
+ * @minLength 1
2470
+ * @maxLength 120
2471
+ */
2279
2472
  title?: string;
2280
- /** ID of the user who created the event. */
2473
+ /**
2474
+ * ID of the user who created the event.
2475
+ * @format GUID
2476
+ */
2281
2477
  userId?: string | null;
2282
2478
  /** Time until the start of event (currently, reminder letter is triggered 1 day before the start of event). */
2283
2479
  startsIn?: TimeDuration;
@@ -2285,18 +2481,29 @@ export interface EventEventReminder {
2285
2481
  export interface EventEventPublished {
2286
2482
  /** Event publishing timestamp in ISO UTC format. */
2287
2483
  timestamp?: Date | null;
2288
- /** Event ID. */
2484
+ /**
2485
+ * Event ID.
2486
+ * @format GUID
2487
+ */
2289
2488
  eventId?: string;
2290
2489
  /** Event status. */
2291
2490
  status?: Status;
2292
2491
  /**
2293
2492
  * Event ID. Indicates the original event from which the current event was derived from.
2294
2493
  * Can be used to track the original event and add missing information.
2494
+ * @format GUID
2295
2495
  */
2296
2496
  derivedFromEventId?: string | null;
2297
- /** Event title. */
2497
+ /**
2498
+ * Event title.
2499
+ * @minLength 1
2500
+ * @maxLength 120
2501
+ */
2298
2502
  title?: string | null;
2299
- /** Short description that appears under the event title. */
2503
+ /**
2504
+ * Short description that appears under the event title.
2505
+ * @maxLength 500
2506
+ */
2300
2507
  shortDescription?: string | null;
2301
2508
  /** Event location. */
2302
2509
  location?: Location;
@@ -2310,21 +2517,37 @@ export interface EventEventPublished {
2310
2517
  export interface EventCloned {
2311
2518
  /** Event creation timestamp in ISO UTC format. */
2312
2519
  timestamp?: Date | null;
2313
- /** Event ID. */
2520
+ /**
2521
+ * Event ID.
2522
+ * @format GUID
2523
+ */
2314
2524
  eventId?: string;
2315
2525
  /** Event location. */
2316
2526
  location?: Location;
2317
2527
  /** Event date and time settings. */
2318
2528
  dateAndTimeSettings?: DateAndTimeSettings;
2319
- /** Event title. */
2529
+ /**
2530
+ * Event title.
2531
+ * @minLength 1
2532
+ * @maxLength 120
2533
+ */
2320
2534
  title?: string;
2321
- /** ID of the user who created the event. */
2535
+ /**
2536
+ * ID of the user who created the event.
2537
+ * @format GUID
2538
+ */
2322
2539
  userId?: string | null;
2323
2540
  /** Event status. */
2324
2541
  status?: Status;
2325
- /** Instance ID. Indicates the original app instance from which current event was derived from. */
2542
+ /**
2543
+ * Instance ID. Indicates the original app instance from which current event was derived from.
2544
+ * @format GUID
2545
+ */
2326
2546
  derivedFromInstanceId?: string | null;
2327
- /** Event ID. Indicates the original event from which current event was derived from. */
2547
+ /**
2548
+ * Event ID. Indicates the original event from which current event was derived from.
2549
+ * @format GUID
2550
+ */
2328
2551
  derivedFromEventId?: string | null;
2329
2552
  /**
2330
2553
  * Map of copied ticket definitions from the original event. <br>
@@ -2336,11 +2559,21 @@ export interface EventCloned {
2336
2559
  export interface EventEventCanceled {
2337
2560
  /** Event cancelation timestamp in ISO UTC format. */
2338
2561
  timestamp?: Date | null;
2339
- /** Event ID. */
2562
+ /**
2563
+ * Event ID.
2564
+ * @format GUID
2565
+ */
2340
2566
  eventId?: string;
2341
- /** Event title. */
2567
+ /**
2568
+ * Event title.
2569
+ * @minLength 1
2570
+ * @maxLength 120
2571
+ */
2342
2572
  title?: string;
2343
- /** ID of the user who created the event. */
2573
+ /**
2574
+ * ID of the user who created the event.
2575
+ * @format GUID
2576
+ */
2344
2577
  userId?: string | null;
2345
2578
  }
2346
2579
  export interface CreateEventRequest {
@@ -2348,7 +2581,10 @@ export interface CreateEventRequest {
2348
2581
  event: V3Event;
2349
2582
  /** Whether to create the event as a draft. */
2350
2583
  draft?: boolean;
2351
- /** Predefined sets of fields to return. */
2584
+ /**
2585
+ * Predefined sets of fields to return.
2586
+ * @maxSize 20
2587
+ */
2352
2588
  fields?: RequestedFields[];
2353
2589
  }
2354
2590
  export declare enum RequestedFields {
@@ -2382,13 +2618,19 @@ export interface CreateEventResponse {
2382
2618
  event?: V3Event;
2383
2619
  }
2384
2620
  export interface CloneEventRequest {
2385
- /** Event ID. */
2621
+ /**
2622
+ * Event ID.
2623
+ * @format GUID
2624
+ */
2386
2625
  eventId: string;
2387
2626
  /** Field values to be changed when cloning the event. */
2388
2627
  event?: V3Event;
2389
2628
  /** Whether to clone the event as a draft. */
2390
2629
  draft?: boolean;
2391
- /** Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned. */
2630
+ /**
2631
+ * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
2632
+ * @maxSize 20
2633
+ */
2392
2634
  fields?: RequestedFields[];
2393
2635
  }
2394
2636
  export interface CloneEventResponse {
@@ -2398,7 +2640,10 @@ export interface CloneEventResponse {
2398
2640
  export interface UpdateEventRequest {
2399
2641
  /** Field values to be changed. */
2400
2642
  event?: V3Event;
2401
- /** Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned. */
2643
+ /**
2644
+ * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
2645
+ * @maxSize 20
2646
+ */
2402
2647
  fields?: RequestedFields[];
2403
2648
  }
2404
2649
  export interface UpdateEventResponse {
@@ -2406,9 +2651,15 @@ export interface UpdateEventResponse {
2406
2651
  event?: V3Event;
2407
2652
  }
2408
2653
  export interface PublishDraftEventRequest {
2409
- /** Event ID. */
2654
+ /**
2655
+ * Event ID.
2656
+ * @format GUID
2657
+ */
2410
2658
  eventId: string;
2411
- /** Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned. */
2659
+ /**
2660
+ * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
2661
+ * @maxSize 20
2662
+ */
2412
2663
  fields?: RequestedFields[];
2413
2664
  }
2414
2665
  export interface PublishDraftEventResponse {
@@ -2416,9 +2667,15 @@ export interface PublishDraftEventResponse {
2416
2667
  event?: V3Event;
2417
2668
  }
2418
2669
  export interface CancelEventRequest {
2419
- /** Event ID. */
2670
+ /**
2671
+ * Event ID.
2672
+ * @format GUID
2673
+ */
2420
2674
  eventId: string;
2421
- /** Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned. */
2675
+ /**
2676
+ * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
2677
+ * @maxSize 20
2678
+ */
2422
2679
  fields?: RequestedFields[];
2423
2680
  }
2424
2681
  export interface CancelEventResponse {
@@ -2443,6 +2700,7 @@ export interface CommonQueryV2 extends CommonQueryV2PagingMethodOneOf {
2443
2700
  /**
2444
2701
  * Sort object in the following format:
2445
2702
  * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
2703
+ * @maxSize 20
2446
2704
  */
2447
2705
  sort?: CommonSorting[];
2448
2706
  }
@@ -2452,7 +2710,10 @@ export interface CommonQueryV2PagingMethodOneOf {
2452
2710
  paging?: CommonPaging;
2453
2711
  }
2454
2712
  export interface CommonSorting {
2455
- /** Name of the field to sort by. */
2713
+ /**
2714
+ * Name of the field to sort by.
2715
+ * @maxLength 100
2716
+ */
2456
2717
  fieldName?: string;
2457
2718
  /**
2458
2719
  * Sort order.
@@ -2467,7 +2728,10 @@ export declare enum CommonSortOrder {
2467
2728
  DESC = "DESC"
2468
2729
  }
2469
2730
  export interface CommonPaging {
2470
- /** Number of items to return. See [Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging#getting-started_sorting-and-paging_paging) for more information. */
2731
+ /**
2732
+ * Number of items to return. See [Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging#getting-started_sorting-and-paging_paging) for more information.
2733
+ * @max 1000
2734
+ */
2471
2735
  limit?: number | null;
2472
2736
  /** Number of items to skip in the current sort order. */
2473
2737
  offset?: number | null;
@@ -2475,11 +2739,17 @@ export interface CommonPaging {
2475
2739
  export interface BulkCancelEventsByFilterResponse {
2476
2740
  }
2477
2741
  export interface DeleteEventRequest {
2478
- /** Event ID. */
2742
+ /**
2743
+ * Event ID.
2744
+ * @format GUID
2745
+ */
2479
2746
  eventId: string;
2480
2747
  }
2481
2748
  export interface DeleteEventResponse {
2482
- /** Deleted event ID. */
2749
+ /**
2750
+ * Deleted event ID.
2751
+ * @format GUID
2752
+ */
2483
2753
  eventId?: string;
2484
2754
  }
2485
2755
  export interface BulkDeleteEventsByFilterRequest {
@@ -2491,7 +2761,10 @@ export interface BulkDeleteEventsByFilterResponse {
2491
2761
  export interface QueryEventsRequest {
2492
2762
  /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
2493
2763
  query?: CommonQueryV2;
2494
- /** Predefined sets of fields to return. */
2764
+ /**
2765
+ * Predefined sets of fields to return.
2766
+ * @maxSize 20
2767
+ */
2495
2768
  fields?: RequestedFields[];
2496
2769
  /**
2497
2770
  * Whether draft events should be returned in the response. <br>
@@ -2557,7 +2830,10 @@ export interface QueryV2PagingMethodOneOf {
2557
2830
  cursorPaging?: CursorPaging;
2558
2831
  }
2559
2832
  export interface Sorting {
2560
- /** Name of the field to sort by. */
2833
+ /**
2834
+ * Name of the field to sort by.
2835
+ * @maxLength 512
2836
+ */
2561
2837
  fieldName?: string;
2562
2838
  /** Sort order. */
2563
2839
  order?: SortOrder;
@@ -2573,13 +2849,17 @@ export interface Paging {
2573
2849
  offset?: number | null;
2574
2850
  }
2575
2851
  export interface CursorPaging {
2576
- /** Maximum number of items to return in the results. */
2852
+ /**
2853
+ * Maximum number of items to return in the results.
2854
+ * @max 100
2855
+ */
2577
2856
  limit?: number | null;
2578
2857
  /**
2579
2858
  * Pointer to the next or previous page in the list of results.
2580
2859
  *
2581
2860
  * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
2582
2861
  * Not relevant for the first request.
2862
+ * @maxLength 16000
2583
2863
  */
2584
2864
  cursor?: string | null;
2585
2865
  }
@@ -2602,15 +2882,25 @@ export interface PagingMetadataV2 {
2602
2882
  cursors?: Cursors;
2603
2883
  }
2604
2884
  export interface Cursors {
2605
- /** Cursor string pointing to the next page in the list of results. */
2885
+ /**
2886
+ * Cursor string pointing to the next page in the list of results.
2887
+ * @maxLength 16000
2888
+ */
2606
2889
  next?: string | null;
2607
- /** Cursor pointing to the previous page in the list of results. */
2890
+ /**
2891
+ * Cursor pointing to the previous page in the list of results.
2892
+ * @maxLength 16000
2893
+ */
2608
2894
  prev?: string | null;
2609
2895
  }
2610
2896
  export interface CountEventsByStatusRequest {
2611
2897
  /** Filter object in the following format: <br/> `"filter" : { "fieldName1": "value1" }`. */
2612
2898
  filter?: Record<string, any> | null;
2613
- /** Parameters to count events by. */
2899
+ /**
2900
+ * Parameters to count events by.
2901
+ * @maxLength 100
2902
+ * @maxSize 20
2903
+ */
2614
2904
  facet?: string[];
2615
2905
  /**
2616
2906
  * Whether draft events should be returned in the response. <br>
@@ -2634,22 +2924,35 @@ export interface ListUserEventsRequest {
2634
2924
  /**
2635
2925
  * Sort order, defaults to `"created:asc"`.
2636
2926
  * See [supported fields](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-events).
2927
+ * @maxSize 20
2637
2928
  */
2638
2929
  sort?: CommonSorting[];
2639
- /** Event status. */
2930
+ /**
2931
+ * Event status.
2932
+ * @maxSize 20
2933
+ */
2640
2934
  status?: Status[];
2641
2935
  /** Allows to filter events by user relation to the event among all wix sites. */
2642
2936
  userFilter?: UserFilter;
2643
2937
  /**
2644
2938
  * Filter facets to include in the response.
2645
2939
  * See [supported facets](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-events).
2940
+ * @maxLength 100
2941
+ * @maxSize 20
2646
2942
  */
2647
2943
  facet?: string[];
2648
2944
  }
2649
2945
  export interface UserFilter {
2650
- /** User who is related to event */
2946
+ /**
2947
+ * User who is related to event
2948
+ * @format GUID
2949
+ */
2651
2950
  userId?: string;
2652
- /** Relation of user to event. */
2951
+ /**
2952
+ * Relation of user to event.
2953
+ * @minSize 1
2954
+ * @maxSize 20
2955
+ */
2653
2956
  relation?: Relation[];
2654
2957
  }
2655
2958
  export declare enum Relation {
@@ -2665,11 +2968,17 @@ export interface ListUserEventsResponse {
2665
2968
  facets?: Record<string, FacetCounts>;
2666
2969
  }
2667
2970
  export interface ListEventsByCategoryRequest {
2668
- /** Category ID. */
2971
+ /**
2972
+ * Category ID.
2973
+ * @format GUID
2974
+ */
2669
2975
  categoryId?: string;
2670
2976
  /** Paging options to limit and skip the number of items. */
2671
2977
  paging?: CommonPaging;
2672
- /** Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned. */
2978
+ /**
2979
+ * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
2980
+ * @maxSize 20
2981
+ */
2673
2982
  fields?: RequestedFields[];
2674
2983
  }
2675
2984
  export interface ListEventsByCategoryResponse {
@@ -2679,9 +2988,15 @@ export interface ListEventsByCategoryResponse {
2679
2988
  events?: V3Event[];
2680
2989
  }
2681
2990
  export interface GetEventRequest {
2682
- /** Event ID. */
2991
+ /**
2992
+ * Event ID.
2993
+ * @format GUID
2994
+ */
2683
2995
  eventId: string | null;
2684
- /** Predefined sets of fields to return. */
2996
+ /**
2997
+ * Predefined sets of fields to return.
2998
+ * @maxSize 20
2999
+ */
2685
3000
  fields?: RequestedFields[];
2686
3001
  }
2687
3002
  export interface GetEventResponse {
@@ -2689,8 +3004,13 @@ export interface GetEventResponse {
2689
3004
  event?: V3Event;
2690
3005
  }
2691
3006
  export interface GetEventBySlugRequest {
2692
- /** URL slug. */
3007
+ /**
3008
+ * URL slug.
3009
+ * @minLength 1
3010
+ * @maxLength 130
3011
+ */
2693
3012
  slug: string | null;
3013
+ /** @maxSize 20 */
2694
3014
  fields?: RequestedFields[];
2695
3015
  }
2696
3016
  export interface GetEventBySlugResponse {
@@ -2698,18 +3018,35 @@ export interface GetEventBySlugResponse {
2698
3018
  event?: V3Event;
2699
3019
  }
2700
3020
  export interface FindEventRequest extends FindEventRequestFindByOneOf {
2701
- /** Event ID. */
3021
+ /**
3022
+ * Event ID.
3023
+ * @format GUID
3024
+ */
2702
3025
  eventId?: string | null;
2703
- /** URL slug. */
3026
+ /**
3027
+ * URL slug.
3028
+ * @minLength 1
3029
+ * @maxLength 130
3030
+ */
2704
3031
  slug?: string | null;
2705
- /** Predefined sets of fields to return. */
3032
+ /**
3033
+ * Predefined sets of fields to return.
3034
+ * @maxSize 20
3035
+ */
2706
3036
  fields?: RequestedFields[];
2707
3037
  }
2708
3038
  /** @oneof */
2709
3039
  export interface FindEventRequestFindByOneOf {
2710
- /** Event ID. */
3040
+ /**
3041
+ * Event ID.
3042
+ * @format GUID
3043
+ */
2711
3044
  eventId?: string | null;
2712
- /** URL slug. */
3045
+ /**
3046
+ * URL slug.
3047
+ * @minLength 1
3048
+ * @maxLength 130
3049
+ */
2713
3050
  slug?: string | null;
2714
3051
  }
2715
3052
  export interface FindEventResponse {
@@ -2719,7 +3056,10 @@ export interface FindEventResponse {
2719
3056
  export interface EventCreated {
2720
3057
  /** Event created timestamp in ISO UTC format. */
2721
3058
  timestamp?: Date | null;
2722
- /** Event ID. */
3059
+ /**
3060
+ * Event ID.
3061
+ * @format GUID
3062
+ */
2723
3063
  eventId?: string;
2724
3064
  /** Event location. */
2725
3065
  location?: EventsLocation;
@@ -2727,23 +3067,38 @@ export interface EventCreated {
2727
3067
  scheduleConfig?: ScheduleConfig;
2728
3068
  /** Event title. */
2729
3069
  title?: string;
2730
- /** Event creator user ID. */
3070
+ /**
3071
+ * Event creator user ID.
3072
+ * @maxLength 36
3073
+ */
2731
3074
  userId?: string | null;
2732
3075
  /** Event status. */
2733
3076
  status?: EventStatus;
2734
- /** Instance ID. Indicates the original app instance which current event was derived from. */
3077
+ /**
3078
+ * Instance ID. Indicates the original app instance which current event was derived from.
3079
+ * @format GUID
3080
+ */
2735
3081
  derivedFromInstanceId?: string | null;
2736
- /** Event ID. Indicates the original event which current event was derived from. */
3082
+ /**
3083
+ * Event ID. Indicates the original event which current event was derived from.
3084
+ * @format GUID
3085
+ */
2737
3086
  derivedFromEventId?: string | null;
2738
3087
  /** Event that was created. */
2739
3088
  event?: Event;
2740
3089
  }
2741
3090
  export interface EventsLocation {
2742
- /** Location name. */
3091
+ /**
3092
+ * Location name.
3093
+ * @maxLength 50
3094
+ */
2743
3095
  name?: string | null;
2744
3096
  /** Location map coordinates. */
2745
3097
  coordinates?: MapCoordinates;
2746
- /** Single line address representation. */
3098
+ /**
3099
+ * Single line address representation.
3100
+ * @maxLength 300
3101
+ */
2747
3102
  address?: string | null;
2748
3103
  /** Location type. */
2749
3104
  type?: LocationLocationType;
@@ -2765,9 +3120,17 @@ export interface EventsLocation {
2765
3120
  tbd?: boolean | null;
2766
3121
  }
2767
3122
  export interface MapCoordinates {
2768
- /** Latitude. */
3123
+ /**
3124
+ * Latitude.
3125
+ * @min -90
3126
+ * @max 90
3127
+ */
2769
3128
  lat?: number;
2770
- /** Longitude. */
3129
+ /**
3130
+ * Longitude.
3131
+ * @min -180
3132
+ * @max 180
3133
+ */
2771
3134
  lng?: number;
2772
3135
  }
2773
3136
  export declare enum LocationLocationType {
@@ -2780,7 +3143,10 @@ export interface Address extends AddressStreetOneOf {
2780
3143
  streetAddress?: StreetAddress;
2781
3144
  /** Main address line (usually street and number) as free text */
2782
3145
  addressLine?: string | null;
2783
- /** country code */
3146
+ /**
3147
+ * country code
3148
+ * @format COUNTRY
3149
+ */
2784
3150
  country?: string | null;
2785
3151
  /** subdivision (usually state or region) code according to ISO 3166-2 */
2786
3152
  subdivision?: string | null;
@@ -2798,7 +3164,10 @@ export interface Address extends AddressStreetOneOf {
2798
3164
  geocode?: AddressLocation;
2799
3165
  /** country full-name */
2800
3166
  countryFullname?: string | null;
2801
- /** multi-level subdivisions from top to bottom */
3167
+ /**
3168
+ * multi-level subdivisions from top to bottom
3169
+ * @maxSize 6
3170
+ */
2802
3171
  subdivisions?: Subdivision[];
2803
3172
  }
2804
3173
  /** @oneof */
@@ -2815,9 +3184,17 @@ export interface StreetAddress {
2815
3184
  name?: string;
2816
3185
  }
2817
3186
  export interface AddressLocation {
2818
- /** address latitude coordinates */
3187
+ /**
3188
+ * address latitude coordinates
3189
+ * @min -90
3190
+ * @max 90
3191
+ */
2819
3192
  latitude?: number | null;
2820
- /** address longitude coordinates */
3193
+ /**
3194
+ * address longitude coordinates
3195
+ * @min -180
3196
+ * @max 180
3197
+ */
2821
3198
  longitude?: number | null;
2822
3199
  }
2823
3200
  export interface Subdivision {
@@ -2848,13 +3225,19 @@ export interface ScheduleConfig {
2848
3225
  * `startDate`, `endDate` and `timeZoneId` are not required when schedule is TBD.
2849
3226
  */
2850
3227
  scheduleTbd?: boolean;
2851
- /** TBD message. */
3228
+ /**
3229
+ * TBD message.
3230
+ * @maxLength 100
3231
+ */
2852
3232
  scheduleTbdMessage?: string | null;
2853
3233
  /** Event start timestamp. */
2854
3234
  startDate?: Date | null;
2855
3235
  /** Event end timestamp. */
2856
3236
  endDate?: Date | null;
2857
- /** Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`. */
3237
+ /**
3238
+ * Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`.
3239
+ * @maxLength 100
3240
+ */
2858
3241
  timeZoneId?: string | null;
2859
3242
  /** Whether end date is hidden in the formatted schedule. */
2860
3243
  endDateHidden?: boolean;
@@ -2864,7 +3247,10 @@ export interface ScheduleConfig {
2864
3247
  recurrences?: EventsRecurrences;
2865
3248
  }
2866
3249
  export interface EventsRecurrences {
2867
- /** Event occurrences. */
3250
+ /**
3251
+ * Event occurrences.
3252
+ * @maxSize 1000
3253
+ */
2868
3254
  occurrences?: EventsOccurrence[];
2869
3255
  /**
2870
3256
  * Recurring event category ID.
@@ -2882,7 +3268,10 @@ export interface EventsOccurrence {
2882
3268
  startDate?: Date | null;
2883
3269
  /** Event end timestamp. */
2884
3270
  endDate?: Date | null;
2885
- /** Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`. */
3271
+ /**
3272
+ * Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`.
3273
+ * @maxLength 100
3274
+ */
2886
3275
  timeZoneId?: string | null;
2887
3276
  /** Whether time zone is displayed in formatted schedule. */
2888
3277
  showTimeZone?: boolean;
@@ -2912,6 +3301,7 @@ export declare enum EventStatus {
2912
3301
  export interface Event {
2913
3302
  /**
2914
3303
  * Event ID.
3304
+ * @format GUID
2915
3305
  * @readonly
2916
3306
  */
2917
3307
  id?: string;
@@ -2951,7 +3341,10 @@ export interface Event {
2951
3341
  instanceId?: string;
2952
3342
  /** Guest list configuration. */
2953
3343
  guestListConfig?: GuestListConfig;
2954
- /** Event creator user ID. */
3344
+ /**
3345
+ * Event creator user ID.
3346
+ * @maxLength 36
3347
+ */
2955
3348
  userId?: string;
2956
3349
  /** Event discussion feed. For internal use. */
2957
3350
  feed?: EventsFeed;
@@ -2990,7 +3383,11 @@ export interface Scheduling {
2990
3383
  endTimeFormatted?: string;
2991
3384
  }
2992
3385
  export interface Image {
2993
- /** WixMedia image ID. */
3386
+ /**
3387
+ * WixMedia image ID.
3388
+ * @minLength 1
3389
+ * @maxLength 200
3390
+ */
2994
3391
  id?: string | null;
2995
3392
  /** Image URL. */
2996
3393
  url?: string;
@@ -3118,17 +3515,31 @@ export interface TicketingConfig {
3118
3515
  guestAssignedTickets?: boolean;
3119
3516
  /** Tax configuration. */
3120
3517
  taxConfig?: TaxConfig;
3121
- /** Limit of tickets that can be purchased per order, default 20. */
3518
+ /**
3519
+ * Limit of tickets that can be purchased per order, default 20.
3520
+ * @max 50
3521
+ */
3122
3522
  ticketLimitPerOrder?: number;
3123
- /** Duration for which the tickets being bought are reserved. */
3523
+ /**
3524
+ * Duration for which the tickets being bought are reserved.
3525
+ * @min 5
3526
+ * @max 30
3527
+ */
3124
3528
  reservationDurationInMinutes?: number | null;
3125
3529
  }
3126
3530
  export interface TaxConfig {
3127
3531
  /** Tax application settings. */
3128
3532
  type?: EventsTaxType;
3129
- /** Tax name. */
3533
+ /**
3534
+ * Tax name.
3535
+ * @minLength 1
3536
+ * @maxLength 10
3537
+ */
3130
3538
  name?: string | null;
3131
- /** Tax rate (e.g.,`21.55`). */
3539
+ /**
3540
+ * Tax rate (e.g.,`21.55`).
3541
+ * @decimalValue options - {gte:0.001,lte:100,maxScale:3}
3542
+ */
3132
3543
  rate?: string | null;
3133
3544
  /** Applies taxes for donations, default true. */
3134
3545
  appliesToDonations?: boolean | null;
@@ -3221,7 +3632,10 @@ export interface OnlineConferencingConfig {
3221
3632
  * When enabled, links to join conferencing are generated and provided to guests.
3222
3633
  */
3223
3634
  enabled?: boolean;
3224
- /** Conferencing provider ID. */
3635
+ /**
3636
+ * Conferencing provider ID.
3637
+ * @format GUID
3638
+ */
3225
3639
  providerId?: string | null;
3226
3640
  /** Conference type */
3227
3641
  conferenceType?: ConferenceType;
@@ -3260,7 +3674,10 @@ export interface EventsOnlineConferencingSession {
3260
3674
  sessionId?: string | null;
3261
3675
  }
3262
3676
  export interface EventsSeoSettings {
3263
- /** URL slug */
3677
+ /**
3678
+ * URL slug
3679
+ * @maxLength 130
3680
+ */
3264
3681
  slug?: string;
3265
3682
  /** Advanced SEO data */
3266
3683
  advancedSeoData?: SeoSchema;
@@ -3282,10 +3699,15 @@ export interface Agenda {
3282
3699
  export interface Category {
3283
3700
  /**
3284
3701
  * Category ID.
3702
+ * @format GUID
3285
3703
  * @readonly
3286
3704
  */
3287
3705
  id?: string;
3288
- /** Category name. */
3706
+ /**
3707
+ * Category name.
3708
+ * @minLength 1
3709
+ * @maxLength 30
3710
+ */
3289
3711
  name?: string;
3290
3712
  /**
3291
3713
  * Date and time when category was created.
@@ -3308,6 +3730,7 @@ export interface Category {
3308
3730
  * Default: `MANUAL`.
3309
3731
  *
3310
3732
  * **Note:** The WIX_EVENTS.MANAGE_AUTO_CATEGORIES permission scope is required to use states other than `MANUAL`.
3733
+ * @maxSize 3
3311
3734
  */
3312
3735
  states?: State[];
3313
3736
  }
@@ -3340,7 +3763,10 @@ export interface Empty {
3340
3763
  export interface EventUpdated {
3341
3764
  /** Event update timestamp in ISO UTC format. */
3342
3765
  timestamp?: Date | null;
3343
- /** Event ID. */
3766
+ /**
3767
+ * Event ID.
3768
+ * @format GUID
3769
+ */
3344
3770
  eventId?: string;
3345
3771
  /** Event location. */
3346
3772
  location?: EventsLocation;
@@ -3359,17 +3785,26 @@ export interface EventUpdated {
3359
3785
  export interface EventDeleted {
3360
3786
  /** Event deleted timestamp in ISO UTC format. */
3361
3787
  timestamp?: Date | null;
3362
- /** Event ID. */
3788
+ /**
3789
+ * Event ID.
3790
+ * @format GUID
3791
+ */
3363
3792
  eventId?: string;
3364
3793
  /** Event title. */
3365
3794
  title?: string;
3366
- /** Event creator user ID. */
3795
+ /**
3796
+ * Event creator user ID.
3797
+ * @format GUID
3798
+ */
3367
3799
  userId?: string | null;
3368
3800
  }
3369
3801
  export interface EventCopied {
3370
3802
  /** Event created timestamp in ISO UTC format. */
3371
3803
  timestamp?: Date | null;
3372
- /** Event ID. */
3804
+ /**
3805
+ * Event ID.
3806
+ * @format GUID
3807
+ */
3373
3808
  eventId?: string;
3374
3809
  /** Event location. */
3375
3810
  location?: EventsLocation;
@@ -3377,13 +3812,22 @@ export interface EventCopied {
3377
3812
  scheduleConfig?: ScheduleConfig;
3378
3813
  /** Event title. */
3379
3814
  title?: string;
3380
- /** Event creator user ID. */
3815
+ /**
3816
+ * Event creator user ID.
3817
+ * @format GUID
3818
+ */
3381
3819
  userId?: string | null;
3382
3820
  /** Event status. */
3383
3821
  status?: EventStatus;
3384
- /** Instance ID. Indicates the original app instance which current event was derived from. */
3822
+ /**
3823
+ * Instance ID. Indicates the original app instance which current event was derived from.
3824
+ * @format GUID
3825
+ */
3385
3826
  derivedFromInstanceId?: string | null;
3386
- /** Event ID. Indicates the original event which current event was derived from. */
3827
+ /**
3828
+ * Event ID. Indicates the original event which current event was derived from.
3829
+ * @format GUID
3830
+ */
3387
3831
  derivedFromEventId?: string | null;
3388
3832
  /**
3389
3833
  * Map of copied ticket definitions from original event.
@@ -3395,7 +3839,10 @@ export interface EventCopied {
3395
3839
  export interface EventPublished {
3396
3840
  /** Event publish timestamp in ISO UTC format. */
3397
3841
  timestamp?: Date | null;
3398
- /** Event ID. */
3842
+ /**
3843
+ * Event ID.
3844
+ * @format GUID
3845
+ */
3399
3846
  eventId?: string;
3400
3847
  /** Event status. */
3401
3848
  status?: EventStatus;
@@ -3420,29 +3867,44 @@ export interface EventPublished {
3420
3867
  export interface EventCanceled {
3421
3868
  /** Event canceled timestamp in ISO UTC format. */
3422
3869
  timestamp?: Date | null;
3423
- /** Event ID. */
3870
+ /**
3871
+ * Event ID.
3872
+ * @format GUID
3873
+ */
3424
3874
  eventId?: string;
3425
3875
  /** Event title */
3426
3876
  title?: string;
3427
- /** Event creator user ID. */
3877
+ /**
3878
+ * Event creator user ID.
3879
+ * @format GUID
3880
+ */
3428
3881
  userId?: string | null;
3429
3882
  }
3430
3883
  export interface EventStarted {
3431
3884
  /** Event start timestamp in ISO UTC format. */
3432
3885
  timestamp?: Date | null;
3433
- /** Event ID. */
3886
+ /**
3887
+ * Event ID.
3888
+ * @format GUID
3889
+ */
3434
3890
  eventId?: string;
3435
3891
  }
3436
3892
  export interface EventEnded {
3437
3893
  /** Event end timestamp in ISO UTC format. */
3438
3894
  timestamp?: Date | null;
3439
- /** Event ID. */
3895
+ /**
3896
+ * Event ID.
3897
+ * @format GUID
3898
+ */
3440
3899
  eventId?: string;
3441
3900
  }
3442
3901
  export interface EventReminder {
3443
3902
  /** Reminder timestamp in ISO UTC format. */
3444
3903
  timestamp?: Date | null;
3445
- /** Event ID. */
3904
+ /**
3905
+ * Event ID.
3906
+ * @format GUID
3907
+ */
3446
3908
  eventId?: string;
3447
3909
  /** Event location. */
3448
3910
  location?: EventsLocation;
@@ -3450,7 +3912,10 @@ export interface EventReminder {
3450
3912
  scheduleConfig?: ScheduleConfig;
3451
3913
  /** Event title. */
3452
3914
  title?: string;
3453
- /** Event creator user ID. */
3915
+ /**
3916
+ * Event creator user ID.
3917
+ * @format GUID
3918
+ */
3454
3919
  userId?: string | null;
3455
3920
  /** Time until the event starts (currently, reminder is triggered 1 day before event starts). */
3456
3921
  startsIn?: TimeDuration;
@@ -3528,9 +3993,15 @@ export interface ActionEvent {
3528
3993
  bodyAsJson?: string;
3529
3994
  }
3530
3995
  export interface MessageEnvelope {
3531
- /** App instance ID. */
3996
+ /**
3997
+ * App instance ID.
3998
+ * @format GUID
3999
+ */
3532
4000
  instanceId?: string | null;
3533
- /** Event type. */
4001
+ /**
4002
+ * Event type.
4003
+ * @maxLength 150
4004
+ */
3534
4005
  eventType?: string;
3535
4006
  /** The identification type and identity data. */
3536
4007
  identity?: IdentificationData;
@@ -3538,26 +4009,50 @@ export interface MessageEnvelope {
3538
4009
  data?: string;
3539
4010
  }
3540
4011
  export interface IdentificationData extends IdentificationDataIdOneOf {
3541
- /** ID of a site visitor that has not logged in to the site. */
4012
+ /**
4013
+ * ID of a site visitor that has not logged in to the site.
4014
+ * @format GUID
4015
+ */
3542
4016
  anonymousVisitorId?: string;
3543
- /** ID of a site visitor that has logged in to the site. */
4017
+ /**
4018
+ * ID of a site visitor that has logged in to the site.
4019
+ * @format GUID
4020
+ */
3544
4021
  memberId?: string;
3545
- /** ID of a Wix user (site owner, contributor, etc.). */
4022
+ /**
4023
+ * ID of a Wix user (site owner, contributor, etc.).
4024
+ * @format GUID
4025
+ */
3546
4026
  wixUserId?: string;
3547
- /** ID of an app. */
4027
+ /**
4028
+ * ID of an app.
4029
+ * @format GUID
4030
+ */
3548
4031
  appId?: string;
3549
4032
  /** @readonly */
3550
4033
  identityType?: WebhookIdentityType;
3551
4034
  }
3552
4035
  /** @oneof */
3553
4036
  export interface IdentificationDataIdOneOf {
3554
- /** ID of a site visitor that has not logged in to the site. */
4037
+ /**
4038
+ * ID of a site visitor that has not logged in to the site.
4039
+ * @format GUID
4040
+ */
3555
4041
  anonymousVisitorId?: string;
3556
- /** ID of a site visitor that has logged in to the site. */
4042
+ /**
4043
+ * ID of a site visitor that has logged in to the site.
4044
+ * @format GUID
4045
+ */
3557
4046
  memberId?: string;
3558
- /** ID of a Wix user (site owner, contributor, etc.). */
4047
+ /**
4048
+ * ID of a Wix user (site owner, contributor, etc.).
4049
+ * @format GUID
4050
+ */
3559
4051
  wixUserId?: string;
3560
- /** ID of an app. */
4052
+ /**
4053
+ * ID of an app.
4054
+ * @format GUID
4055
+ */
3561
4056
  appId?: string;
3562
4057
  }
3563
4058
  export declare enum WebhookIdentityType {