@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,12 +9,20 @@ 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
- /** Short description that appears under the event title. */
18
+ /**
19
+ * Short description that appears under the event title.
20
+ * @maxLength 500
21
+ */
14
22
  shortDescription?: string | null;
15
23
  /**
16
24
  * 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).
25
+ * @maxLength 50000
17
26
  * @deprecated Detailed description of an event.
18
27
  *
19
28
  * This field is deprecated.
@@ -88,6 +97,7 @@ export interface V3Event {
88
97
  /**
89
98
  * ID of the user who created the event.
90
99
  * @readonly
100
+ * @format GUID
91
101
  */
92
102
  userId?: string;
93
103
  /**
@@ -125,7 +135,10 @@ export interface V3Event {
125
135
  publishedDate?: Date | null;
126
136
  }
127
137
  export interface Location {
128
- /** Location name. This value is displayed instead of the address when the location is defined as TBD by setting the `locationTbd` property to `true`. */
138
+ /**
139
+ * Location name. This value is displayed instead of the address when the location is defined as TBD by setting the `locationTbd` property to `true`.
140
+ * @maxLength 50
141
+ */
129
142
  name?: string | null;
130
143
  /**
131
144
  * Location type:
@@ -151,42 +164,83 @@ export declare enum LocationType {
151
164
  export interface CommonAddress extends CommonAddressStreetOneOf {
152
165
  /** Street address. */
153
166
  streetAddress?: CommonStreetAddress;
154
- /** Primary address information (street and building number). */
167
+ /**
168
+ * Primary address information (street and building number).
169
+ * @maxLength 250
170
+ */
155
171
  addressLine1?: string | null;
156
- /** 2-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */
172
+ /**
173
+ * 2-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format.
174
+ * @format COUNTRY
175
+ */
157
176
  country?: string | null;
158
- /** Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */
177
+ /**
178
+ * Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2).
179
+ * @maxLength 20
180
+ */
159
181
  subdivision?: string | null;
160
- /** City name. */
182
+ /**
183
+ * City name.
184
+ * @maxLength 100
185
+ */
161
186
  city?: string | null;
162
- /** Zip or postal code. */
187
+ /**
188
+ * Zip or postal code.
189
+ * @maxLength 100
190
+ */
163
191
  postalCode?: string | null;
164
- /** Secondary address information (suite or apartment number and room number). */
192
+ /**
193
+ * Secondary address information (suite or apartment number and room number).
194
+ * @maxLength 250
195
+ */
165
196
  addressLine2?: string | null;
166
197
  }
167
198
  /** @oneof */
168
199
  export interface CommonAddressStreetOneOf {
169
200
  /** Street address. */
170
201
  streetAddress?: CommonStreetAddress;
171
- /** Primary address information (street and building number). */
202
+ /**
203
+ * Primary address information (street and building number).
204
+ * @maxLength 250
205
+ */
172
206
  addressLine?: string | null;
173
207
  }
174
208
  export interface CommonStreetAddress {
175
- /** Street number. */
209
+ /**
210
+ * Street number.
211
+ * @maxLength 100
212
+ */
176
213
  number?: string;
177
- /** Street name. */
214
+ /**
215
+ * Street name.
216
+ * @maxLength 250
217
+ */
178
218
  name?: string;
179
219
  }
180
220
  export interface CommonAddressLocation {
181
- /** Address latitude coordinates. */
221
+ /**
222
+ * Address latitude coordinates.
223
+ * @min -90
224
+ * @max 90
225
+ */
182
226
  latitude?: number | null;
183
- /** Address longitude coordinates. */
227
+ /**
228
+ * Address longitude coordinates.
229
+ * @min -180
230
+ * @max 180
231
+ */
184
232
  longitude?: number | null;
185
233
  }
186
234
  export interface CommonSubdivision {
187
- /** Short subdivision code. */
235
+ /**
236
+ * Short subdivision code.
237
+ * @maxLength 100
238
+ */
188
239
  code?: string;
189
- /** Subdivision full name. */
240
+ /**
241
+ * Subdivision full name.
242
+ * @maxLength 250
243
+ */
190
244
  name?: string;
191
245
  }
192
246
  export declare enum SubdivisionSubdivisionType {
@@ -207,7 +261,10 @@ export declare enum SubdivisionSubdivisionType {
207
261
  export interface DateAndTimeSettings {
208
262
  /** Whether the event date and time are TBD. */
209
263
  dateAndTimeTbd?: boolean | null;
210
- /** Message that is displayed when time and date is TBD. */
264
+ /**
265
+ * Message that is displayed when time and date is TBD.
266
+ * @maxLength 100
267
+ */
211
268
  dateAndTimeTbdMessage?: string | null;
212
269
  /**
213
270
  * Event start date.
@@ -225,6 +282,7 @@ export interface DateAndTimeSettings {
225
282
  * Event time zone ID in the TZ database format.
226
283
  *
227
284
  * **Note:** You need to write this field in the snake case, instead of a camel case. For example, `time_zone_id`.
285
+ * @maxLength 100
228
286
  */
229
287
  timeZoneId?: string | null;
230
288
  /** Whether the end date is hidden in the formatted date and time. */
@@ -262,11 +320,15 @@ export declare enum RecurrenceStatusStatus {
262
320
  RECURRING_RECENTLY_CANCELED = "RECURRING_RECENTLY_CANCELED"
263
321
  }
264
322
  export interface Recurrences {
265
- /** Individual event dates info. */
323
+ /**
324
+ * Individual event dates info.
325
+ * @maxSize 1000
326
+ */
266
327
  individualEventDates?: Occurrence[];
267
328
  /**
268
329
  * Recurring event category ID.
269
330
  * @readonly
331
+ * @maxLength 100
270
332
  */
271
333
  categoryId?: string | null;
272
334
  }
@@ -275,7 +337,10 @@ export interface Occurrence {
275
337
  startDate?: Date | null;
276
338
  /** Event end date. */
277
339
  endDate?: Date | null;
278
- /** Event time zone ID in the [TZ database](https://www.iana.org/time-zones) format. */
340
+ /**
341
+ * Event time zone ID in the [TZ database](https://www.iana.org/time-zones) format.
342
+ * @maxLength 100
343
+ */
279
344
  timeZoneId?: string | null;
280
345
  /** Whether the time zone is displayed in a formatted schedule. */
281
346
  showTimeZone?: boolean;
@@ -287,26 +352,31 @@ export interface Formatted {
287
352
  * 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`.
288
353
  * 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`.
289
354
  * @readonly
355
+ * @maxLength 500
290
356
  */
291
357
  dateAndTime?: string | null;
292
358
  /**
293
359
  * Formatted start date of the event. Empty for TBD schedules.
294
360
  * @readonly
361
+ * @maxLength 500
295
362
  */
296
363
  startDate?: string | null;
297
364
  /**
298
365
  * Formatted start time of the event. Empty for TBD schedules.
299
366
  * @readonly
367
+ * @maxLength 500
300
368
  */
301
369
  startTime?: string | null;
302
370
  /**
303
371
  * Formatted end date of the event. Empty for TBD schedules or when the end date is hidden.
304
372
  * @readonly
373
+ * @maxLength 500
305
374
  */
306
375
  endDate?: string | null;
307
376
  /**
308
377
  * Formatted end time of the event. Empty for TBD schedules or when the end date is hidden.
309
378
  * @readonly
379
+ * @maxLength 500
310
380
  */
311
381
  endTime?: string | null;
312
382
  }
@@ -317,9 +387,15 @@ export interface Formatted {
317
387
  export interface TimeDuration {
318
388
  /** Number of days. */
319
389
  days?: number;
320
- /** Number of hours. */
390
+ /**
391
+ * Number of hours.
392
+ * @max 24
393
+ */
321
394
  hours?: number;
322
- /** Number of minutes. */
395
+ /**
396
+ * Number of minutes.
397
+ * @max 60
398
+ */
323
399
  minutes?: number;
324
400
  }
325
401
  export declare enum Status {
@@ -382,6 +458,7 @@ export interface Registration {
382
458
  * - `TICKETING`: Guests register by buying tickets.
383
459
  *
384
460
  * This property value never changes.
461
+ * @immutable
385
462
  */
386
463
  initialType?: InitialRegistrationTypeType;
387
464
  /** Whether the registration is paused. */
@@ -445,6 +522,7 @@ export interface TicketsRegistration {
445
522
  /**
446
523
  * Ticket limit per order.
447
524
  * Default: 20 tickets.
525
+ * @max 50
448
526
  */
449
527
  ticketLimitPerOrder?: number;
450
528
  /** Ticket price currency. */
@@ -472,9 +550,15 @@ export interface TicketsRegistration {
472
550
  * Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.
473
551
  */
474
552
  export interface Money {
475
- /** Amount of money in decimal form. A period is used as a decimal separator (for example, `3.99`). */
553
+ /**
554
+ * Amount of money in decimal form. A period is used as a decimal separator (for example, `3.99`).
555
+ * @format DECIMAL_VALUE
556
+ */
476
557
  value?: string;
477
- /** Currency code in 3-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. */
558
+ /**
559
+ * Currency code in 3-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
560
+ * @format CURRENCY
561
+ */
478
562
  currency?: string;
479
563
  /**
480
564
  * Amount of money in decimal form. A period or comma are used as a decimal separator (for example, `1 000,30`).
@@ -490,9 +574,16 @@ export interface TaxSettings {
490
574
  * - `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.
491
575
  */
492
576
  type?: TaxType;
493
- /** Tax name. */
577
+ /**
578
+ * Tax name.
579
+ * @minLength 1
580
+ * @maxLength 10
581
+ */
494
582
  name?: string | null;
495
- /** Tax rate (for example,`21.55`). */
583
+ /**
584
+ * Tax rate (for example,`21.55`).
585
+ * @decimalValue options - {gte:0.001,lte:100,maxScale:3}
586
+ */
496
587
  rate?: string | null;
497
588
  /** Apply tax to donations. */
498
589
  appliedToDonations?: boolean | null;
@@ -507,7 +598,10 @@ export declare enum TaxType {
507
598
  ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
508
599
  }
509
600
  export interface ExternalRegistration {
510
- /** External event registration URL. */
601
+ /**
602
+ * External event registration URL.
603
+ * @format WEB_URL
604
+ */
511
605
  url?: string | null;
512
606
  }
513
607
  export declare enum GuestTypeType {
@@ -662,21 +756,29 @@ export declare enum ValueType {
662
756
  * Defaults to first (0th) option if not configured.
663
757
  */
664
758
  export interface OptionSelection extends OptionSelectionSelectedOptionOneOf {
665
- /** 0-based index from predefined `input.options` which is selected initially. */
759
+ /**
760
+ * 0-based index from predefined `input.options` which is selected initially.
761
+ * @max 199
762
+ */
666
763
  optionIndex?: number;
667
764
  /**
668
765
  * Placeholder hint describing expected choices (such as "Please select").
669
766
  * Considered an empty choice.
767
+ * @maxLength 200
670
768
  */
671
769
  placeholderText?: string;
672
770
  }
673
771
  /** @oneof */
674
772
  export interface OptionSelectionSelectedOptionOneOf {
675
- /** 0-based index from predefined `input.options` which is selected initially. */
773
+ /**
774
+ * 0-based index from predefined `input.options` which is selected initially.
775
+ * @max 199
776
+ */
676
777
  optionIndex?: number;
677
778
  /**
678
779
  * Placeholder hint describing expected choices (such as "Please select").
679
780
  * Considered an empty choice.
781
+ * @maxLength 200
680
782
  */
681
783
  placeholderText?: string;
682
784
  }
@@ -788,12 +890,19 @@ export interface Summaries {
788
890
  export interface EventsMoney {
789
891
  /**
790
892
  * *Deprecated:** Use `value` instead.
893
+ * @format DECIMAL_VALUE
791
894
  * @deprecated
792
895
  */
793
896
  amount?: string;
794
- /** ISO 4217 format of the currency e.g., `USD`. */
897
+ /**
898
+ * ISO 4217 format of the currency e.g., `USD`.
899
+ * @format CURRENCY
900
+ */
795
901
  currency?: string;
796
- /** 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. */
902
+ /**
903
+ * 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.
904
+ * @format DECIMAL_VALUE
905
+ */
797
906
  value?: string | null;
798
907
  }
799
908
  export interface Rsvps {
@@ -856,7 +965,10 @@ export interface Feed {
856
965
  export interface OnlineConferencing {
857
966
  /** 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. */
858
967
  enabled?: boolean;
859
- /** Conference host ID. */
968
+ /**
969
+ * Conference host ID.
970
+ * @format GUID
971
+ */
860
972
  providerId?: string | null;
861
973
  /**
862
974
  * Conference type. Possible values:
@@ -904,7 +1016,10 @@ export interface OnlineConferencingSession {
904
1016
  sessionId?: string | null;
905
1017
  }
906
1018
  export interface SeoSettings {
907
- /** URL slug. */
1019
+ /**
1020
+ * URL slug.
1021
+ * @maxLength 130
1022
+ */
908
1023
  slug?: string;
909
1024
  /** Advanced SEO data. */
910
1025
  advancedSeoData?: SeoSchema;
@@ -930,7 +1045,10 @@ export interface Keyword {
930
1045
  term?: string;
931
1046
  /** Whether the keyword is the main focus keyword. */
932
1047
  isMain?: boolean;
933
- /** The source that added the keyword terms to the SEO settings. */
1048
+ /**
1049
+ * The source that added the keyword terms to the SEO settings.
1050
+ * @maxLength 1000
1051
+ */
934
1052
  origin?: string | null;
935
1053
  }
936
1054
  export interface Tag {
@@ -963,7 +1081,10 @@ export interface Settings {
963
1081
  * Default: `false` (Auto Redirect is enabled.)
964
1082
  */
965
1083
  preventAutoRedirect?: boolean;
966
- /** User-selected keyword terms for a specific page. */
1084
+ /**
1085
+ * User-selected keyword terms for a specific page.
1086
+ * @maxSize 5
1087
+ */
967
1088
  keywords?: Keyword[];
968
1089
  }
969
1090
  export interface AgendaSettings {
@@ -976,16 +1097,24 @@ export interface AgendaSettings {
976
1097
  pageUrl?: string;
977
1098
  }
978
1099
  export interface EventCategories {
979
- /** Event categories. */
1100
+ /**
1101
+ * Event categories.
1102
+ * @maxSize 10
1103
+ */
980
1104
  categories?: EventCategory[];
981
1105
  }
982
1106
  export interface EventCategory {
983
1107
  /**
984
1108
  * Category ID.
1109
+ * @format GUID
985
1110
  * @readonly
986
1111
  */
987
1112
  _id?: string;
988
- /** Category name. */
1113
+ /**
1114
+ * Category name.
1115
+ * @minLength 1
1116
+ * @maxLength 30
1117
+ */
989
1118
  name?: string;
990
1119
  /**
991
1120
  * Category creation timestamp.
@@ -1615,11 +1744,20 @@ export interface GIFData {
1615
1744
  gifType?: GIFType;
1616
1745
  }
1617
1746
  export interface GIF {
1618
- /** GIF format URL. */
1747
+ /**
1748
+ * GIF format URL.
1749
+ * @format WEB_URL
1750
+ */
1619
1751
  gif?: string | null;
1620
- /** MP4 format URL. */
1752
+ /**
1753
+ * MP4 format URL.
1754
+ * @format WEB_URL
1755
+ */
1621
1756
  mp4?: string | null;
1622
- /** Thumbnail URL. */
1757
+ /**
1758
+ * Thumbnail URL.
1759
+ * @format WEB_URL
1760
+ */
1623
1761
  still?: string | null;
1624
1762
  }
1625
1763
  export declare enum GIFType {
@@ -1693,7 +1831,10 @@ export interface ImageData {
1693
1831
  export interface StylesBorder {
1694
1832
  /** Border width in pixels. */
1695
1833
  width?: number | null;
1696
- /** Border color. */
1834
+ /**
1835
+ * Border color as a hexadecimal value.
1836
+ * @format COLOR_HEX
1837
+ */
1697
1838
  color?: string | null;
1698
1839
  /** Border radius in pixels. */
1699
1840
  radius?: number | null;
@@ -1847,13 +1988,22 @@ export declare enum BackgroundType {
1847
1988
  export interface Gradient {
1848
1989
  /** The gradient angle in degrees. */
1849
1990
  angle?: number | null;
1850
- /** The start color as a hexademical value. */
1991
+ /**
1992
+ * The start color as a hexademical value.
1993
+ * @format COLOR_HEX
1994
+ */
1851
1995
  startColor?: string | null;
1852
- /** The end color as a hexademical value. */
1996
+ /**
1997
+ * The end color as a hexademical value.
1998
+ * @format COLOR_HEX
1999
+ */
1853
2000
  lastColor?: string | null;
1854
2001
  }
1855
2002
  export interface Background extends BackgroundBackgroundOneOf {
1856
- /** The background color as a hexademical value. */
2003
+ /**
2004
+ * The background color as a hexademical value.
2005
+ * @format COLOR_HEX
2006
+ */
1857
2007
  color?: string | null;
1858
2008
  /** An image to use for the background. */
1859
2009
  image?: Media;
@@ -1864,7 +2014,10 @@ export interface Background extends BackgroundBackgroundOneOf {
1864
2014
  }
1865
2015
  /** @oneof */
1866
2016
  export interface BackgroundBackgroundOneOf {
1867
- /** The background color as a hexademical value. */
2017
+ /**
2018
+ * The background color as a hexademical value.
2019
+ * @format COLOR_HEX
2020
+ */
1868
2021
  color?: string | null;
1869
2022
  /** An image to use for the background. */
1870
2023
  image?: Media;
@@ -2176,17 +2329,32 @@ export declare enum VerticalAlignment {
2176
2329
  export interface CellStyle {
2177
2330
  /** Vertical alignment for the cell's text. */
2178
2331
  verticalAlignment?: VerticalAlignment;
2179
- /** Cell background color as a hexadecimal value. */
2332
+ /**
2333
+ * Cell background color as a hexadecimal value.
2334
+ * @format COLOR_HEX
2335
+ */
2180
2336
  backgroundColor?: string | null;
2181
2337
  }
2182
2338
  export interface BorderColors {
2183
- /** Left border color as a hexadecimal value. */
2339
+ /**
2340
+ * Left border color as a hexadecimal value.
2341
+ * @format COLOR_HEX
2342
+ */
2184
2343
  left?: string | null;
2185
- /** Right border color as a hexadecimal value. */
2344
+ /**
2345
+ * Right border color as a hexadecimal value.
2346
+ * @format COLOR_HEX
2347
+ */
2186
2348
  right?: string | null;
2187
- /** Top border color as a hexadecimal value. */
2349
+ /**
2350
+ * Top border color as a hexadecimal value.
2351
+ * @format COLOR_HEX
2352
+ */
2188
2353
  top?: string | null;
2189
- /** Bottom border color as a hexadecimal value. */
2354
+ /**
2355
+ * Bottom border color as a hexadecimal value.
2356
+ * @format COLOR_HEX
2357
+ */
2190
2358
  bottom?: string | null;
2191
2359
  }
2192
2360
  /**
@@ -2297,27 +2465,43 @@ export interface TextNodeStyle {
2297
2465
  export interface EventEventStarted {
2298
2466
  /** Event schedule configuration. */
2299
2467
  timestamp?: Date | null;
2300
- /** Event ID. */
2468
+ /**
2469
+ * Event ID.
2470
+ * @format GUID
2471
+ */
2301
2472
  eventId?: string;
2302
2473
  }
2303
2474
  export interface EventEventEnded {
2304
2475
  /** Event end timestamp in ISO UTC format. */
2305
2476
  timestamp?: Date | null;
2306
- /** Event ID. */
2477
+ /**
2478
+ * Event ID.
2479
+ * @format GUID
2480
+ */
2307
2481
  eventId?: string;
2308
2482
  }
2309
2483
  export interface EventEventReminder {
2310
2484
  /** Reminder timestamp in ISO UTC format. */
2311
2485
  timestamp?: Date | null;
2312
- /** Event ID. */
2486
+ /**
2487
+ * Event ID.
2488
+ * @format GUID
2489
+ */
2313
2490
  eventId?: string;
2314
2491
  /** Event location. */
2315
2492
  location?: Location;
2316
2493
  /** Event schedule configuration. */
2317
2494
  dateAndTimeSettings?: DateAndTimeSettings;
2318
- /** Event title. */
2495
+ /**
2496
+ * Event title.
2497
+ * @minLength 1
2498
+ * @maxLength 120
2499
+ */
2319
2500
  title?: string;
2320
- /** ID of the user who created the event. */
2501
+ /**
2502
+ * ID of the user who created the event.
2503
+ * @format GUID
2504
+ */
2321
2505
  userId?: string | null;
2322
2506
  /** Time until the start of event (currently, reminder letter is triggered 1 day before the start of event). */
2323
2507
  startsIn?: TimeDuration;
@@ -2325,18 +2509,29 @@ export interface EventEventReminder {
2325
2509
  export interface EventEventPublished {
2326
2510
  /** Event publishing timestamp in ISO UTC format. */
2327
2511
  timestamp?: Date | null;
2328
- /** Event ID. */
2512
+ /**
2513
+ * Event ID.
2514
+ * @format GUID
2515
+ */
2329
2516
  eventId?: string;
2330
2517
  /** Event status. */
2331
2518
  status?: Status;
2332
2519
  /**
2333
2520
  * Event ID. Indicates the original event from which the current event was derived from.
2334
2521
  * Can be used to track the original event and add missing information.
2522
+ * @format GUID
2335
2523
  */
2336
2524
  derivedFromEventId?: string | null;
2337
- /** Event title. */
2525
+ /**
2526
+ * Event title.
2527
+ * @minLength 1
2528
+ * @maxLength 120
2529
+ */
2338
2530
  title?: string | null;
2339
- /** Short description that appears under the event title. */
2531
+ /**
2532
+ * Short description that appears under the event title.
2533
+ * @maxLength 500
2534
+ */
2340
2535
  shortDescription?: string | null;
2341
2536
  /** Event location. */
2342
2537
  location?: Location;
@@ -2350,21 +2545,37 @@ export interface EventEventPublished {
2350
2545
  export interface EventCloned {
2351
2546
  /** Event creation timestamp in ISO UTC format. */
2352
2547
  timestamp?: Date | null;
2353
- /** Event ID. */
2548
+ /**
2549
+ * Event ID.
2550
+ * @format GUID
2551
+ */
2354
2552
  eventId?: string;
2355
2553
  /** Event location. */
2356
2554
  location?: Location;
2357
2555
  /** Event date and time settings. */
2358
2556
  dateAndTimeSettings?: DateAndTimeSettings;
2359
- /** Event title. */
2557
+ /**
2558
+ * Event title.
2559
+ * @minLength 1
2560
+ * @maxLength 120
2561
+ */
2360
2562
  title?: string;
2361
- /** ID of the user who created the event. */
2563
+ /**
2564
+ * ID of the user who created the event.
2565
+ * @format GUID
2566
+ */
2362
2567
  userId?: string | null;
2363
2568
  /** Event status. */
2364
2569
  status?: Status;
2365
- /** Instance ID. Indicates the original app instance from which current event was derived from. */
2570
+ /**
2571
+ * Instance ID. Indicates the original app instance from which current event was derived from.
2572
+ * @format GUID
2573
+ */
2366
2574
  derivedFromInstanceId?: string | null;
2367
- /** Event ID. Indicates the original event from which current event was derived from. */
2575
+ /**
2576
+ * Event ID. Indicates the original event from which current event was derived from.
2577
+ * @format GUID
2578
+ */
2368
2579
  derivedFromEventId?: string | null;
2369
2580
  /**
2370
2581
  * Map of copied ticket definitions from the original event. <br>
@@ -2376,11 +2587,21 @@ export interface EventCloned {
2376
2587
  export interface EventEventCanceled {
2377
2588
  /** Event cancelation timestamp in ISO UTC format. */
2378
2589
  timestamp?: Date | null;
2379
- /** Event ID. */
2590
+ /**
2591
+ * Event ID.
2592
+ * @format GUID
2593
+ */
2380
2594
  eventId?: string;
2381
- /** Event title. */
2595
+ /**
2596
+ * Event title.
2597
+ * @minLength 1
2598
+ * @maxLength 120
2599
+ */
2382
2600
  title?: string;
2383
- /** ID of the user who created the event. */
2601
+ /**
2602
+ * ID of the user who created the event.
2603
+ * @format GUID
2604
+ */
2384
2605
  userId?: string | null;
2385
2606
  }
2386
2607
  export interface CreateEventRequest {
@@ -2388,7 +2609,10 @@ export interface CreateEventRequest {
2388
2609
  event: V3Event;
2389
2610
  /** Whether to create the event as a draft. */
2390
2611
  draft?: boolean;
2391
- /** Predefined sets of fields to return. */
2612
+ /**
2613
+ * Predefined sets of fields to return.
2614
+ * @maxSize 20
2615
+ */
2392
2616
  fields?: RequestedFields[];
2393
2617
  }
2394
2618
  export declare enum RequestedFields {
@@ -2422,13 +2646,19 @@ export interface CreateEventResponse {
2422
2646
  event?: V3Event;
2423
2647
  }
2424
2648
  export interface CloneEventRequest {
2425
- /** Event ID. */
2649
+ /**
2650
+ * Event ID.
2651
+ * @format GUID
2652
+ */
2426
2653
  eventId: string;
2427
2654
  /** Field values to be changed when cloning the event. */
2428
2655
  event?: V3Event;
2429
2656
  /** Whether to clone the event as a draft. */
2430
2657
  draft?: boolean;
2431
- /** Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned. */
2658
+ /**
2659
+ * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
2660
+ * @maxSize 20
2661
+ */
2432
2662
  fields?: RequestedFields[];
2433
2663
  }
2434
2664
  export interface CloneEventResponse {
@@ -2438,7 +2668,10 @@ export interface CloneEventResponse {
2438
2668
  export interface UpdateEventRequest {
2439
2669
  /** Field values to be changed. */
2440
2670
  event?: V3Event;
2441
- /** Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned. */
2671
+ /**
2672
+ * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
2673
+ * @maxSize 20
2674
+ */
2442
2675
  fields?: RequestedFields[];
2443
2676
  }
2444
2677
  export interface UpdateEventResponse {
@@ -2446,9 +2679,15 @@ export interface UpdateEventResponse {
2446
2679
  event?: V3Event;
2447
2680
  }
2448
2681
  export interface PublishDraftEventRequest {
2449
- /** Event ID. */
2682
+ /**
2683
+ * Event ID.
2684
+ * @format GUID
2685
+ */
2450
2686
  eventId: string;
2451
- /** Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned. */
2687
+ /**
2688
+ * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
2689
+ * @maxSize 20
2690
+ */
2452
2691
  fields?: RequestedFields[];
2453
2692
  }
2454
2693
  export interface PublishDraftEventResponse {
@@ -2456,9 +2695,15 @@ export interface PublishDraftEventResponse {
2456
2695
  event?: V3Event;
2457
2696
  }
2458
2697
  export interface CancelEventRequest {
2459
- /** Event ID. */
2698
+ /**
2699
+ * Event ID.
2700
+ * @format GUID
2701
+ */
2460
2702
  eventId: string;
2461
- /** Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned. */
2703
+ /**
2704
+ * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
2705
+ * @maxSize 20
2706
+ */
2462
2707
  fields?: RequestedFields[];
2463
2708
  }
2464
2709
  export interface CancelEventResponse {
@@ -2483,6 +2728,7 @@ export interface CommonQueryV2 extends CommonQueryV2PagingMethodOneOf {
2483
2728
  /**
2484
2729
  * Sort object in the following format:
2485
2730
  * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
2731
+ * @maxSize 20
2486
2732
  */
2487
2733
  sort?: CommonSorting[];
2488
2734
  }
@@ -2492,7 +2738,10 @@ export interface CommonQueryV2PagingMethodOneOf {
2492
2738
  paging?: CommonPaging;
2493
2739
  }
2494
2740
  export interface CommonSorting {
2495
- /** Name of the field to sort by. */
2741
+ /**
2742
+ * Name of the field to sort by.
2743
+ * @maxLength 100
2744
+ */
2496
2745
  fieldName?: string;
2497
2746
  /**
2498
2747
  * Sort order.
@@ -2507,7 +2756,10 @@ export declare enum CommonSortOrder {
2507
2756
  DESC = "DESC"
2508
2757
  }
2509
2758
  export interface CommonPaging {
2510
- /** 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. */
2759
+ /**
2760
+ * 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.
2761
+ * @max 1000
2762
+ */
2511
2763
  limit?: number | null;
2512
2764
  /** Number of items to skip in the current sort order. */
2513
2765
  offset?: number | null;
@@ -2515,11 +2767,17 @@ export interface CommonPaging {
2515
2767
  export interface BulkCancelEventsByFilterResponse {
2516
2768
  }
2517
2769
  export interface DeleteEventRequest {
2518
- /** Event ID. */
2770
+ /**
2771
+ * Event ID.
2772
+ * @format GUID
2773
+ */
2519
2774
  eventId: string;
2520
2775
  }
2521
2776
  export interface DeleteEventResponse {
2522
- /** Deleted event ID. */
2777
+ /**
2778
+ * Deleted event ID.
2779
+ * @format GUID
2780
+ */
2523
2781
  eventId?: string;
2524
2782
  }
2525
2783
  export interface BulkDeleteEventsByFilterRequest {
@@ -2531,7 +2789,10 @@ export interface BulkDeleteEventsByFilterResponse {
2531
2789
  export interface QueryEventsRequest {
2532
2790
  /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
2533
2791
  query?: CommonQueryV2;
2534
- /** Predefined sets of fields to return. */
2792
+ /**
2793
+ * Predefined sets of fields to return.
2794
+ * @maxSize 20
2795
+ */
2535
2796
  fields?: RequestedFields[];
2536
2797
  /**
2537
2798
  * Whether draft events should be returned in the response. <br>
@@ -2597,7 +2858,10 @@ export interface QueryV2PagingMethodOneOf {
2597
2858
  cursorPaging?: CursorPaging;
2598
2859
  }
2599
2860
  export interface Sorting {
2600
- /** Name of the field to sort by. */
2861
+ /**
2862
+ * Name of the field to sort by.
2863
+ * @maxLength 512
2864
+ */
2601
2865
  fieldName?: string;
2602
2866
  /** Sort order. */
2603
2867
  order?: SortOrder;
@@ -2613,13 +2877,17 @@ export interface Paging {
2613
2877
  offset?: number | null;
2614
2878
  }
2615
2879
  export interface CursorPaging {
2616
- /** Maximum number of items to return in the results. */
2880
+ /**
2881
+ * Maximum number of items to return in the results.
2882
+ * @max 100
2883
+ */
2617
2884
  limit?: number | null;
2618
2885
  /**
2619
2886
  * Pointer to the next or previous page in the list of results.
2620
2887
  *
2621
2888
  * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
2622
2889
  * Not relevant for the first request.
2890
+ * @maxLength 16000
2623
2891
  */
2624
2892
  cursor?: string | null;
2625
2893
  }
@@ -2642,15 +2910,25 @@ export interface PagingMetadataV2 {
2642
2910
  cursors?: Cursors;
2643
2911
  }
2644
2912
  export interface Cursors {
2645
- /** Cursor string pointing to the next page in the list of results. */
2913
+ /**
2914
+ * Cursor string pointing to the next page in the list of results.
2915
+ * @maxLength 16000
2916
+ */
2646
2917
  next?: string | null;
2647
- /** Cursor pointing to the previous page in the list of results. */
2918
+ /**
2919
+ * Cursor pointing to the previous page in the list of results.
2920
+ * @maxLength 16000
2921
+ */
2648
2922
  prev?: string | null;
2649
2923
  }
2650
2924
  export interface CountEventsByStatusRequest {
2651
2925
  /** Filter object in the following format: <br/> `"filter" : { "fieldName1": "value1" }`. */
2652
2926
  filter?: Record<string, any> | null;
2653
- /** Parameters to count events by. */
2927
+ /**
2928
+ * Parameters to count events by.
2929
+ * @maxLength 100
2930
+ * @maxSize 20
2931
+ */
2654
2932
  facet?: string[];
2655
2933
  /**
2656
2934
  * Whether draft events should be returned in the response. <br>
@@ -2674,22 +2952,35 @@ export interface ListUserEventsRequest {
2674
2952
  /**
2675
2953
  * Sort order, defaults to `"created:asc"`.
2676
2954
  * 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).
2955
+ * @maxSize 20
2677
2956
  */
2678
2957
  sort?: CommonSorting[];
2679
- /** Event status. */
2958
+ /**
2959
+ * Event status.
2960
+ * @maxSize 20
2961
+ */
2680
2962
  status?: Status[];
2681
2963
  /** Allows to filter events by user relation to the event among all wix sites. */
2682
2964
  userFilter?: UserFilter;
2683
2965
  /**
2684
2966
  * Filter facets to include in the response.
2685
2967
  * 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).
2968
+ * @maxLength 100
2969
+ * @maxSize 20
2686
2970
  */
2687
2971
  facet?: string[];
2688
2972
  }
2689
2973
  export interface UserFilter {
2690
- /** User who is related to event */
2974
+ /**
2975
+ * User who is related to event
2976
+ * @format GUID
2977
+ */
2691
2978
  userId?: string;
2692
- /** Relation of user to event. */
2979
+ /**
2980
+ * Relation of user to event.
2981
+ * @minSize 1
2982
+ * @maxSize 20
2983
+ */
2693
2984
  relation?: Relation[];
2694
2985
  }
2695
2986
  export declare enum Relation {
@@ -2705,11 +2996,17 @@ export interface ListUserEventsResponse {
2705
2996
  facets?: Record<string, FacetCounts>;
2706
2997
  }
2707
2998
  export interface ListEventsByCategoryRequest {
2708
- /** Category ID. */
2999
+ /**
3000
+ * Category ID.
3001
+ * @format GUID
3002
+ */
2709
3003
  categoryId?: string;
2710
3004
  /** Paging options to limit and skip the number of items. */
2711
3005
  paging?: CommonPaging;
2712
- /** Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned. */
3006
+ /**
3007
+ * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
3008
+ * @maxSize 20
3009
+ */
2713
3010
  fields?: RequestedFields[];
2714
3011
  }
2715
3012
  export interface ListEventsByCategoryResponse {
@@ -2719,9 +3016,15 @@ export interface ListEventsByCategoryResponse {
2719
3016
  events?: V3Event[];
2720
3017
  }
2721
3018
  export interface GetEventRequest {
2722
- /** Event ID. */
3019
+ /**
3020
+ * Event ID.
3021
+ * @format GUID
3022
+ */
2723
3023
  eventId: string | null;
2724
- /** Predefined sets of fields to return. */
3024
+ /**
3025
+ * Predefined sets of fields to return.
3026
+ * @maxSize 20
3027
+ */
2725
3028
  fields?: RequestedFields[];
2726
3029
  }
2727
3030
  export interface GetEventResponse {
@@ -2729,8 +3032,13 @@ export interface GetEventResponse {
2729
3032
  event?: V3Event;
2730
3033
  }
2731
3034
  export interface GetEventBySlugRequest {
2732
- /** URL slug. */
3035
+ /**
3036
+ * URL slug.
3037
+ * @minLength 1
3038
+ * @maxLength 130
3039
+ */
2733
3040
  slug: string | null;
3041
+ /** @maxSize 20 */
2734
3042
  fields?: RequestedFields[];
2735
3043
  }
2736
3044
  export interface GetEventBySlugResponse {
@@ -2738,18 +3046,35 @@ export interface GetEventBySlugResponse {
2738
3046
  event?: V3Event;
2739
3047
  }
2740
3048
  export interface FindEventRequest extends FindEventRequestFindByOneOf {
2741
- /** Event ID. */
3049
+ /**
3050
+ * Event ID.
3051
+ * @format GUID
3052
+ */
2742
3053
  eventId?: string | null;
2743
- /** URL slug. */
3054
+ /**
3055
+ * URL slug.
3056
+ * @minLength 1
3057
+ * @maxLength 130
3058
+ */
2744
3059
  slug?: string | null;
2745
- /** Predefined sets of fields to return. */
3060
+ /**
3061
+ * Predefined sets of fields to return.
3062
+ * @maxSize 20
3063
+ */
2746
3064
  fields?: RequestedFields[];
2747
3065
  }
2748
3066
  /** @oneof */
2749
3067
  export interface FindEventRequestFindByOneOf {
2750
- /** Event ID. */
3068
+ /**
3069
+ * Event ID.
3070
+ * @format GUID
3071
+ */
2751
3072
  eventId?: string | null;
2752
- /** URL slug. */
3073
+ /**
3074
+ * URL slug.
3075
+ * @minLength 1
3076
+ * @maxLength 130
3077
+ */
2753
3078
  slug?: string | null;
2754
3079
  }
2755
3080
  export interface FindEventResponse {
@@ -2759,7 +3084,10 @@ export interface FindEventResponse {
2759
3084
  export interface EventCreated {
2760
3085
  /** Event created timestamp in ISO UTC format. */
2761
3086
  timestamp?: Date | null;
2762
- /** Event ID. */
3087
+ /**
3088
+ * Event ID.
3089
+ * @format GUID
3090
+ */
2763
3091
  eventId?: string;
2764
3092
  /** Event location. */
2765
3093
  location?: EventsLocation;
@@ -2767,23 +3095,38 @@ export interface EventCreated {
2767
3095
  scheduleConfig?: ScheduleConfig;
2768
3096
  /** Event title. */
2769
3097
  title?: string;
2770
- /** Event creator user ID. */
3098
+ /**
3099
+ * Event creator user ID.
3100
+ * @maxLength 36
3101
+ */
2771
3102
  userId?: string | null;
2772
3103
  /** Event status. */
2773
3104
  status?: EventStatus;
2774
- /** Instance ID. Indicates the original app instance which current event was derived from. */
3105
+ /**
3106
+ * Instance ID. Indicates the original app instance which current event was derived from.
3107
+ * @format GUID
3108
+ */
2775
3109
  derivedFromInstanceId?: string | null;
2776
- /** Event ID. Indicates the original event which current event was derived from. */
3110
+ /**
3111
+ * Event ID. Indicates the original event which current event was derived from.
3112
+ * @format GUID
3113
+ */
2777
3114
  derivedFromEventId?: string | null;
2778
3115
  /** Event that was created. */
2779
3116
  event?: Event;
2780
3117
  }
2781
3118
  export interface EventsLocation {
2782
- /** Location name. */
3119
+ /**
3120
+ * Location name.
3121
+ * @maxLength 50
3122
+ */
2783
3123
  name?: string | null;
2784
3124
  /** Location map coordinates. */
2785
3125
  coordinates?: MapCoordinates;
2786
- /** Single line address representation. */
3126
+ /**
3127
+ * Single line address representation.
3128
+ * @maxLength 300
3129
+ */
2787
3130
  address?: string | null;
2788
3131
  /** Location type. */
2789
3132
  type?: LocationLocationType;
@@ -2805,9 +3148,17 @@ export interface EventsLocation {
2805
3148
  tbd?: boolean | null;
2806
3149
  }
2807
3150
  export interface MapCoordinates {
2808
- /** Latitude. */
3151
+ /**
3152
+ * Latitude.
3153
+ * @min -90
3154
+ * @max 90
3155
+ */
2809
3156
  lat?: number;
2810
- /** Longitude. */
3157
+ /**
3158
+ * Longitude.
3159
+ * @min -180
3160
+ * @max 180
3161
+ */
2811
3162
  lng?: number;
2812
3163
  }
2813
3164
  export declare enum LocationLocationType {
@@ -2820,7 +3171,10 @@ export interface Address extends AddressStreetOneOf {
2820
3171
  streetAddress?: StreetAddress;
2821
3172
  /** Main address line (usually street and number) as free text */
2822
3173
  addressLine1?: string | null;
2823
- /** country code */
3174
+ /**
3175
+ * country code
3176
+ * @format COUNTRY
3177
+ */
2824
3178
  country?: string | null;
2825
3179
  /** subdivision (usually state or region) code according to ISO 3166-2 */
2826
3180
  subdivision?: string | null;
@@ -2836,7 +3190,10 @@ export interface Address extends AddressStreetOneOf {
2836
3190
  location?: AddressLocation;
2837
3191
  /** country full-name */
2838
3192
  countryFullname?: string | null;
2839
- /** multi-level subdivisions from top to bottom */
3193
+ /**
3194
+ * multi-level subdivisions from top to bottom
3195
+ * @maxSize 6
3196
+ */
2840
3197
  subdivisions?: Subdivision[];
2841
3198
  }
2842
3199
  /** @oneof */
@@ -2853,9 +3210,17 @@ export interface StreetAddress {
2853
3210
  name?: string;
2854
3211
  }
2855
3212
  export interface AddressLocation {
2856
- /** address latitude coordinates */
3213
+ /**
3214
+ * address latitude coordinates
3215
+ * @min -90
3216
+ * @max 90
3217
+ */
2857
3218
  latitude?: number | null;
2858
- /** address longitude coordinates */
3219
+ /**
3220
+ * address longitude coordinates
3221
+ * @min -180
3222
+ * @max 180
3223
+ */
2859
3224
  longitude?: number | null;
2860
3225
  }
2861
3226
  export interface Subdivision {
@@ -2886,13 +3251,19 @@ export interface ScheduleConfig {
2886
3251
  * `startDate`, `endDate` and `timeZoneId` are not required when schedule is TBD.
2887
3252
  */
2888
3253
  scheduleTbd?: boolean;
2889
- /** TBD message. */
3254
+ /**
3255
+ * TBD message.
3256
+ * @maxLength 100
3257
+ */
2890
3258
  scheduleTbdMessage?: string | null;
2891
3259
  /** Event start timestamp. */
2892
3260
  startDate?: Date | null;
2893
3261
  /** Event end timestamp. */
2894
3262
  endDate?: Date | null;
2895
- /** Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`. */
3263
+ /**
3264
+ * Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`.
3265
+ * @maxLength 100
3266
+ */
2896
3267
  timeZoneId?: string | null;
2897
3268
  /** Whether end date is hidden in the formatted schedule. */
2898
3269
  endDateHidden?: boolean;
@@ -2902,7 +3273,10 @@ export interface ScheduleConfig {
2902
3273
  recurrences?: EventsRecurrences;
2903
3274
  }
2904
3275
  export interface EventsRecurrences {
2905
- /** Event occurrences. */
3276
+ /**
3277
+ * Event occurrences.
3278
+ * @maxSize 1000
3279
+ */
2906
3280
  occurrences?: EventsOccurrence[];
2907
3281
  /**
2908
3282
  * Recurring event category ID.
@@ -2920,7 +3294,10 @@ export interface EventsOccurrence {
2920
3294
  startDate?: Date | null;
2921
3295
  /** Event end timestamp. */
2922
3296
  endDate?: Date | null;
2923
- /** Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`. */
3297
+ /**
3298
+ * Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`.
3299
+ * @maxLength 100
3300
+ */
2924
3301
  timeZoneId?: string | null;
2925
3302
  /** Whether time zone is displayed in formatted schedule. */
2926
3303
  showTimeZone?: boolean;
@@ -2950,6 +3327,7 @@ export declare enum EventStatus {
2950
3327
  export interface Event {
2951
3328
  /**
2952
3329
  * Event ID.
3330
+ * @format GUID
2953
3331
  * @readonly
2954
3332
  */
2955
3333
  _id?: string;
@@ -2989,7 +3367,10 @@ export interface Event {
2989
3367
  instanceId?: string;
2990
3368
  /** Guest list configuration. */
2991
3369
  guestListConfig?: GuestListConfig;
2992
- /** Event creator user ID. */
3370
+ /**
3371
+ * Event creator user ID.
3372
+ * @maxLength 36
3373
+ */
2993
3374
  userId?: string;
2994
3375
  /** Event discussion feed. For internal use. */
2995
3376
  feed?: EventsFeed;
@@ -3144,17 +3525,31 @@ export interface TicketingConfig {
3144
3525
  guestAssignedTickets?: boolean;
3145
3526
  /** Tax configuration. */
3146
3527
  taxConfig?: TaxConfig;
3147
- /** Limit of tickets that can be purchased per order, default 20. */
3528
+ /**
3529
+ * Limit of tickets that can be purchased per order, default 20.
3530
+ * @max 50
3531
+ */
3148
3532
  ticketLimitPerOrder?: number;
3149
- /** Duration for which the tickets being bought are reserved. */
3533
+ /**
3534
+ * Duration for which the tickets being bought are reserved.
3535
+ * @min 5
3536
+ * @max 30
3537
+ */
3150
3538
  reservationDurationInMinutes?: number | null;
3151
3539
  }
3152
3540
  export interface TaxConfig {
3153
3541
  /** Tax application settings. */
3154
3542
  type?: EventsTaxType;
3155
- /** Tax name. */
3543
+ /**
3544
+ * Tax name.
3545
+ * @minLength 1
3546
+ * @maxLength 10
3547
+ */
3156
3548
  name?: string | null;
3157
- /** Tax rate (e.g.,`21.55`). */
3549
+ /**
3550
+ * Tax rate (e.g.,`21.55`).
3551
+ * @decimalValue options - {gte:0.001,lte:100,maxScale:3}
3552
+ */
3158
3553
  rate?: string | null;
3159
3554
  /** Applies taxes for donations, default true. */
3160
3555
  appliesToDonations?: boolean | null;
@@ -3247,7 +3642,10 @@ export interface OnlineConferencingConfig {
3247
3642
  * When enabled, links to join conferencing are generated and provided to guests.
3248
3643
  */
3249
3644
  enabled?: boolean;
3250
- /** Conferencing provider ID. */
3645
+ /**
3646
+ * Conferencing provider ID.
3647
+ * @format GUID
3648
+ */
3251
3649
  providerId?: string | null;
3252
3650
  /** Conference type */
3253
3651
  conferenceType?: ConferenceType;
@@ -3286,7 +3684,10 @@ export interface EventsOnlineConferencingSession {
3286
3684
  sessionId?: string | null;
3287
3685
  }
3288
3686
  export interface EventsSeoSettings {
3289
- /** URL slug */
3687
+ /**
3688
+ * URL slug
3689
+ * @maxLength 130
3690
+ */
3290
3691
  slug?: string;
3291
3692
  /** Advanced SEO data */
3292
3693
  advancedSeoData?: SeoSchema;
@@ -3308,10 +3709,15 @@ export interface Agenda {
3308
3709
  export interface Category {
3309
3710
  /**
3310
3711
  * Category ID.
3712
+ * @format GUID
3311
3713
  * @readonly
3312
3714
  */
3313
3715
  _id?: string;
3314
- /** Category name. */
3716
+ /**
3717
+ * Category name.
3718
+ * @minLength 1
3719
+ * @maxLength 30
3720
+ */
3315
3721
  name?: string;
3316
3722
  /**
3317
3723
  * Date and time when category was created.
@@ -3334,6 +3740,7 @@ export interface Category {
3334
3740
  * Default: `MANUAL`.
3335
3741
  *
3336
3742
  * **Note:** The WIX_EVENTS.MANAGE_AUTO_CATEGORIES permission scope is required to use states other than `MANUAL`.
3743
+ * @maxSize 3
3337
3744
  */
3338
3745
  states?: State[];
3339
3746
  }
@@ -3366,7 +3773,10 @@ export interface Empty {
3366
3773
  export interface EventUpdated {
3367
3774
  /** Event update timestamp in ISO UTC format. */
3368
3775
  timestamp?: Date | null;
3369
- /** Event ID. */
3776
+ /**
3777
+ * Event ID.
3778
+ * @format GUID
3779
+ */
3370
3780
  eventId?: string;
3371
3781
  /** Event location. */
3372
3782
  location?: EventsLocation;
@@ -3385,17 +3795,26 @@ export interface EventUpdated {
3385
3795
  export interface EventDeleted {
3386
3796
  /** Event deleted timestamp in ISO UTC format. */
3387
3797
  timestamp?: Date | null;
3388
- /** Event ID. */
3798
+ /**
3799
+ * Event ID.
3800
+ * @format GUID
3801
+ */
3389
3802
  eventId?: string;
3390
3803
  /** Event title. */
3391
3804
  title?: string;
3392
- /** Event creator user ID. */
3805
+ /**
3806
+ * Event creator user ID.
3807
+ * @format GUID
3808
+ */
3393
3809
  userId?: string | null;
3394
3810
  }
3395
3811
  export interface EventCopied {
3396
3812
  /** Event created timestamp in ISO UTC format. */
3397
3813
  timestamp?: Date | null;
3398
- /** Event ID. */
3814
+ /**
3815
+ * Event ID.
3816
+ * @format GUID
3817
+ */
3399
3818
  eventId?: string;
3400
3819
  /** Event location. */
3401
3820
  location?: EventsLocation;
@@ -3403,13 +3822,22 @@ export interface EventCopied {
3403
3822
  scheduleConfig?: ScheduleConfig;
3404
3823
  /** Event title. */
3405
3824
  title?: string;
3406
- /** Event creator user ID. */
3825
+ /**
3826
+ * Event creator user ID.
3827
+ * @format GUID
3828
+ */
3407
3829
  userId?: string | null;
3408
3830
  /** Event status. */
3409
3831
  status?: EventStatus;
3410
- /** Instance ID. Indicates the original app instance which current event was derived from. */
3832
+ /**
3833
+ * Instance ID. Indicates the original app instance which current event was derived from.
3834
+ * @format GUID
3835
+ */
3411
3836
  derivedFromInstanceId?: string | null;
3412
- /** Event ID. Indicates the original event which current event was derived from. */
3837
+ /**
3838
+ * Event ID. Indicates the original event which current event was derived from.
3839
+ * @format GUID
3840
+ */
3413
3841
  derivedFromEventId?: string | null;
3414
3842
  /**
3415
3843
  * Map of copied ticket definitions from original event.
@@ -3421,7 +3849,10 @@ export interface EventCopied {
3421
3849
  export interface EventPublished {
3422
3850
  /** Event publish timestamp in ISO UTC format. */
3423
3851
  timestamp?: Date | null;
3424
- /** Event ID. */
3852
+ /**
3853
+ * Event ID.
3854
+ * @format GUID
3855
+ */
3425
3856
  eventId?: string;
3426
3857
  /** Event status. */
3427
3858
  status?: EventStatus;
@@ -3446,29 +3877,44 @@ export interface EventPublished {
3446
3877
  export interface EventCanceled {
3447
3878
  /** Event canceled timestamp in ISO UTC format. */
3448
3879
  timestamp?: Date | null;
3449
- /** Event ID. */
3880
+ /**
3881
+ * Event ID.
3882
+ * @format GUID
3883
+ */
3450
3884
  eventId?: string;
3451
3885
  /** Event title */
3452
3886
  title?: string;
3453
- /** Event creator user ID. */
3887
+ /**
3888
+ * Event creator user ID.
3889
+ * @format GUID
3890
+ */
3454
3891
  userId?: string | null;
3455
3892
  }
3456
3893
  export interface EventStarted {
3457
3894
  /** Event start timestamp in ISO UTC format. */
3458
3895
  timestamp?: Date | null;
3459
- /** Event ID. */
3896
+ /**
3897
+ * Event ID.
3898
+ * @format GUID
3899
+ */
3460
3900
  eventId?: string;
3461
3901
  }
3462
3902
  export interface EventEnded {
3463
3903
  /** Event end timestamp in ISO UTC format. */
3464
3904
  timestamp?: Date | null;
3465
- /** Event ID. */
3905
+ /**
3906
+ * Event ID.
3907
+ * @format GUID
3908
+ */
3466
3909
  eventId?: string;
3467
3910
  }
3468
3911
  export interface EventReminder {
3469
3912
  /** Reminder timestamp in ISO UTC format. */
3470
3913
  timestamp?: Date | null;
3471
- /** Event ID. */
3914
+ /**
3915
+ * Event ID.
3916
+ * @format GUID
3917
+ */
3472
3918
  eventId?: string;
3473
3919
  /** Event location. */
3474
3920
  location?: EventsLocation;
@@ -3476,7 +3922,10 @@ export interface EventReminder {
3476
3922
  scheduleConfig?: ScheduleConfig;
3477
3923
  /** Event title. */
3478
3924
  title?: string;
3479
- /** Event creator user ID. */
3925
+ /**
3926
+ * Event creator user ID.
3927
+ * @format GUID
3928
+ */
3480
3929
  userId?: string | null;
3481
3930
  /** Time until the event starts (currently, reminder is triggered 1 day before event starts). */
3482
3931
  startsIn?: TimeDuration;
@@ -3552,9 +4001,15 @@ export interface ActionEvent {
3552
4001
  body?: string;
3553
4002
  }
3554
4003
  export interface MessageEnvelope {
3555
- /** App instance ID. */
4004
+ /**
4005
+ * App instance ID.
4006
+ * @format GUID
4007
+ */
3556
4008
  instanceId?: string | null;
3557
- /** Event type. */
4009
+ /**
4010
+ * Event type.
4011
+ * @maxLength 150
4012
+ */
3558
4013
  eventType?: string;
3559
4014
  /** The identification type and identity data. */
3560
4015
  identity?: IdentificationData;
@@ -3562,26 +4017,50 @@ export interface MessageEnvelope {
3562
4017
  data?: string;
3563
4018
  }
3564
4019
  export interface IdentificationData extends IdentificationDataIdOneOf {
3565
- /** ID of a site visitor that has not logged in to the site. */
4020
+ /**
4021
+ * ID of a site visitor that has not logged in to the site.
4022
+ * @format GUID
4023
+ */
3566
4024
  anonymousVisitorId?: string;
3567
- /** ID of a site visitor that has logged in to the site. */
4025
+ /**
4026
+ * ID of a site visitor that has logged in to the site.
4027
+ * @format GUID
4028
+ */
3568
4029
  memberId?: string;
3569
- /** ID of a Wix user (site owner, contributor, etc.). */
4030
+ /**
4031
+ * ID of a Wix user (site owner, contributor, etc.).
4032
+ * @format GUID
4033
+ */
3570
4034
  wixUserId?: string;
3571
- /** ID of an app. */
4035
+ /**
4036
+ * ID of an app.
4037
+ * @format GUID
4038
+ */
3572
4039
  appId?: string;
3573
4040
  /** @readonly */
3574
4041
  identityType?: WebhookIdentityType;
3575
4042
  }
3576
4043
  /** @oneof */
3577
4044
  export interface IdentificationDataIdOneOf {
3578
- /** ID of a site visitor that has not logged in to the site. */
4045
+ /**
4046
+ * ID of a site visitor that has not logged in to the site.
4047
+ * @format GUID
4048
+ */
3579
4049
  anonymousVisitorId?: string;
3580
- /** ID of a site visitor that has logged in to the site. */
4050
+ /**
4051
+ * ID of a site visitor that has logged in to the site.
4052
+ * @format GUID
4053
+ */
3581
4054
  memberId?: string;
3582
- /** ID of a Wix user (site owner, contributor, etc.). */
4055
+ /**
4056
+ * ID of a Wix user (site owner, contributor, etc.).
4057
+ * @format GUID
4058
+ */
3583
4059
  wixUserId?: string;
3584
- /** ID of an app. */
4060
+ /**
4061
+ * ID of an app.
4062
+ * @format GUID
4063
+ */
3585
4064
  appId?: string;
3586
4065
  }
3587
4066
  export declare enum WebhookIdentityType {
@@ -4103,9 +4582,15 @@ export interface GetEventBySlugResponseNonNullableFields {
4103
4582
  event?: V3EventNonNullableFields;
4104
4583
  }
4105
4584
  export interface BaseEventMetadata {
4106
- /** App instance ID. */
4585
+ /**
4586
+ * App instance ID.
4587
+ * @format GUID
4588
+ */
4107
4589
  instanceId?: string | null;
4108
- /** Event type. */
4590
+ /**
4591
+ * Event type.
4592
+ * @maxLength 150
4593
+ */
4109
4594
  eventType?: string;
4110
4595
  /** The identification type and identity data. */
4111
4596
  identity?: IdentificationData;
@@ -4170,6 +4655,8 @@ export interface EventCanceledEnvelope {
4170
4655
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
4171
4656
  * @permissionScope Manage Restaurants - all permissions
4172
4657
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
4658
+ * @permissionScope Set Up Automations
4659
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
4173
4660
  * @permissionScope Manage Guest List
4174
4661
  * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
4175
4662
  * @permissionScope Manage Events
@@ -4202,6 +4689,8 @@ export interface EventClonedEnvelope {
4202
4689
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
4203
4690
  * @permissionScope Manage Restaurants - all permissions
4204
4691
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
4692
+ * @permissionScope Set Up Automations
4693
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
4205
4694
  * @permissionScope Manage Guest List
4206
4695
  * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
4207
4696
  * @permissionScope Manage Events
@@ -4234,6 +4723,8 @@ export interface EventCreatedEnvelope {
4234
4723
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
4235
4724
  * @permissionScope Manage Restaurants - all permissions
4236
4725
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
4726
+ * @permissionScope Set Up Automations
4727
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
4237
4728
  * @permissionScope Manage Guest List
4238
4729
  * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
4239
4730
  * @permissionScope Manage Events
@@ -4265,6 +4756,8 @@ export interface EventDeletedEnvelope {
4265
4756
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
4266
4757
  * @permissionScope Manage Restaurants - all permissions
4267
4758
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
4759
+ * @permissionScope Set Up Automations
4760
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
4268
4761
  * @permissionScope Manage Guest List
4269
4762
  * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
4270
4763
  * @permissionScope Manage Events
@@ -4297,6 +4790,8 @@ export interface EventEndedEnvelope {
4297
4790
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
4298
4791
  * @permissionScope Manage Restaurants - all permissions
4299
4792
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
4793
+ * @permissionScope Set Up Automations
4794
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
4300
4795
  * @permissionScope Manage Guest List
4301
4796
  * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
4302
4797
  * @permissionScope Manage Events
@@ -4329,6 +4824,8 @@ export interface EventPublishedEnvelope {
4329
4824
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
4330
4825
  * @permissionScope Manage Restaurants - all permissions
4331
4826
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
4827
+ * @permissionScope Set Up Automations
4828
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
4332
4829
  * @permissionScope Manage Guest List
4333
4830
  * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
4334
4831
  * @permissionScope Manage Events
@@ -4367,6 +4864,8 @@ export interface EventReminderEnvelope {
4367
4864
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
4368
4865
  * @permissionScope Manage Restaurants - all permissions
4369
4866
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
4867
+ * @permissionScope Set Up Automations
4868
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
4370
4869
  * @permissionScope Manage Guest List
4371
4870
  * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
4372
4871
  * @permissionScope Manage Events
@@ -4399,6 +4898,8 @@ export interface EventStartedEnvelope {
4399
4898
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
4400
4899
  * @permissionScope Manage Restaurants - all permissions
4401
4900
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
4901
+ * @permissionScope Set Up Automations
4902
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
4402
4903
  * @permissionScope Manage Guest List
4403
4904
  * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
4404
4905
  * @permissionScope Manage Events
@@ -4431,6 +4932,8 @@ export interface EventUpdatedEnvelope {
4431
4932
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
4432
4933
  * @permissionScope Manage Restaurants - all permissions
4433
4934
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
4935
+ * @permissionScope Set Up Automations
4936
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
4434
4937
  * @permissionScope Manage Guest List
4435
4938
  * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
4436
4939
  * @permissionScope Manage Events
@@ -4473,7 +4976,10 @@ export declare function createEvent(event: V3Event, options?: CreateEventOptions
4473
4976
  export interface CreateEventOptions {
4474
4977
  /** Whether to create the event as a draft. */
4475
4978
  draft?: boolean;
4476
- /** Predefined sets of fields to return. */
4979
+ /**
4980
+ * Predefined sets of fields to return.
4981
+ * @maxSize 20
4982
+ */
4477
4983
  fields?: RequestedFields[];
4478
4984
  }
4479
4985
  /**
@@ -4502,7 +5008,10 @@ export interface CloneEventOptions {
4502
5008
  event?: V3Event;
4503
5009
  /** Whether to clone the event as a draft. */
4504
5010
  draft?: boolean;
4505
- /** Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned. */
5011
+ /**
5012
+ * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
5013
+ * @maxSize 20
5014
+ */
4506
5015
  fields?: RequestedFields[];
4507
5016
  }
4508
5017
  /**
@@ -4528,6 +5037,7 @@ export interface UpdateEventOptions {
4528
5037
  event: {
4529
5038
  /**
4530
5039
  * Event ID.
5040
+ * @format GUID
4531
5041
  * @readonly
4532
5042
  */
4533
5043
  _id?: string;
@@ -4535,12 +5045,20 @@ export interface UpdateEventOptions {
4535
5045
  location?: Location;
4536
5046
  /** Event date and time settings. */
4537
5047
  dateAndTimeSettings?: DateAndTimeSettings;
4538
- /** Event title. */
5048
+ /**
5049
+ * Event title.
5050
+ * @minLength 1
5051
+ * @maxLength 120
5052
+ */
4539
5053
  title?: string | null;
4540
- /** Short description that appears under the event title. */
5054
+ /**
5055
+ * Short description that appears under the event title.
5056
+ * @maxLength 500
5057
+ */
4541
5058
  shortDescription?: string | null;
4542
5059
  /**
4543
5060
  * 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).
5061
+ * @maxLength 50000
4544
5062
  * @deprecated Detailed description of an event.
4545
5063
  *
4546
5064
  * This field is deprecated.
@@ -4615,6 +5133,7 @@ export interface UpdateEventOptions {
4615
5133
  /**
4616
5134
  * ID of the user who created the event.
4617
5135
  * @readonly
5136
+ * @format GUID
4618
5137
  */
4619
5138
  userId?: string;
4620
5139
  /**
@@ -4651,7 +5170,10 @@ export interface UpdateEventOptions {
4651
5170
  */
4652
5171
  publishedDate?: Date | null;
4653
5172
  };
4654
- /** Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned. */
5173
+ /**
5174
+ * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
5175
+ * @maxSize 20
5176
+ */
4655
5177
  fields?: RequestedFields[];
4656
5178
  }
4657
5179
  /**
@@ -4675,7 +5197,10 @@ export interface UpdateEventOptions {
4675
5197
  */
4676
5198
  export declare function publishDraftEvent(eventId: string, options?: PublishDraftEventOptions): Promise<PublishDraftEventResponse & PublishDraftEventResponseNonNullableFields>;
4677
5199
  export interface PublishDraftEventOptions {
4678
- /** Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned. */
5200
+ /**
5201
+ * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
5202
+ * @maxSize 20
5203
+ */
4679
5204
  fields?: RequestedFields[];
4680
5205
  }
4681
5206
  /**
@@ -4700,7 +5225,10 @@ export interface PublishDraftEventOptions {
4700
5225
  */
4701
5226
  export declare function cancelEvent(eventId: string, options?: CancelEventOptions): Promise<CancelEventResponse & CancelEventResponseNonNullableFields>;
4702
5227
  export interface CancelEventOptions {
4703
- /** Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned. */
5228
+ /**
5229
+ * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
5230
+ * @maxSize 20
5231
+ */
4704
5232
  fields?: RequestedFields[];
4705
5233
  }
4706
5234
  /**
@@ -4802,6 +5330,8 @@ export interface BulkDeleteEventsByFilterOptions {
4802
5330
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
4803
5331
  * @permissionScope Manage Restaurants - all permissions
4804
5332
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
5333
+ * @permissionScope Set Up Automations
5334
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
4805
5335
  * @permissionScope Manage Guest List
4806
5336
  * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
4807
5337
  * @permissionScope Manage Events
@@ -4813,7 +5343,10 @@ export interface BulkDeleteEventsByFilterOptions {
4813
5343
  */
4814
5344
  export declare function queryEvents(options?: QueryEventsOptions): EventsQueryBuilder;
4815
5345
  export interface QueryEventsOptions {
4816
- /** Predefined sets of fields to return. */
5346
+ /**
5347
+ * Predefined sets of fields to return.
5348
+ * @maxSize 20
5349
+ */
4817
5350
  fields?: RequestedFields[] | undefined;
4818
5351
  /**
4819
5352
  * Whether draft events should be returned in the response. <br>
@@ -4893,6 +5426,8 @@ export interface EventsQueryBuilder {
4893
5426
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
4894
5427
  * @permissionScope Manage Restaurants - all permissions
4895
5428
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
5429
+ * @permissionScope Set Up Automations
5430
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
4896
5431
  * @permissionScope Manage Guest List
4897
5432
  * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
4898
5433
  * @permissionScope Manage Events
@@ -4905,7 +5440,11 @@ export declare function countEventsByStatus(options?: CountEventsByStatusOptions
4905
5440
  export interface CountEventsByStatusOptions {
4906
5441
  /** Filter object in the following format: <br/> `"filter" : { "fieldName1": "value1" }`. */
4907
5442
  filter?: Record<string, any> | null;
4908
- /** Parameters to count events by. */
5443
+ /**
5444
+ * Parameters to count events by.
5445
+ * @maxLength 100
5446
+ * @maxSize 20
5447
+ */
4909
5448
  facet?: string[];
4910
5449
  /**
4911
5450
  * Whether draft events should be returned in the response. <br>
@@ -4936,6 +5475,8 @@ export interface CountEventsByStatusOptions {
4936
5475
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
4937
5476
  * @permissionScope Manage Restaurants - all permissions
4938
5477
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
5478
+ * @permissionScope Set Up Automations
5479
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
4939
5480
  * @permissionScope Manage Guest List
4940
5481
  * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
4941
5482
  * @permissionScope Manage Events
@@ -4947,7 +5488,10 @@ export interface CountEventsByStatusOptions {
4947
5488
  */
4948
5489
  export declare function getEvent(eventId: string | null, options?: GetEventOptions): Promise<V3Event & V3EventNonNullableFields>;
4949
5490
  export interface GetEventOptions {
4950
- /** Predefined sets of fields to return. */
5491
+ /**
5492
+ * Predefined sets of fields to return.
5493
+ * @maxSize 20
5494
+ */
4951
5495
  fields?: RequestedFields[];
4952
5496
  }
4953
5497
  /**
@@ -4976,6 +5520,8 @@ export interface GetEventOptions {
4976
5520
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
4977
5521
  * @permissionScope Manage Restaurants - all permissions
4978
5522
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
5523
+ * @permissionScope Set Up Automations
5524
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
4979
5525
  * @permissionScope Manage Guest List
4980
5526
  * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
4981
5527
  * @permissionScope Manage Events
@@ -4986,6 +5532,7 @@ export interface GetEventOptions {
4986
5532
  */
4987
5533
  export declare function getEventBySlug(slug: string | null, options?: GetEventBySlugOptions): Promise<GetEventBySlugResponse & GetEventBySlugResponseNonNullableFields>;
4988
5534
  export interface GetEventBySlugOptions {
5535
+ /** @maxSize 20 */
4989
5536
  fields?: RequestedFields[];
4990
5537
  }
4991
5538
  export {};