@wix/auto_sdk_events_wix-events-v-2 1.0.5 → 1.0.7

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 (45) hide show
  1. package/build/cjs/src/events-v3-event-wix-events-v-2.context.d.ts +1 -1
  2. package/build/cjs/src/events-v3-event-wix-events-v-2.http.js +11 -0
  3. package/build/cjs/src/events-v3-event-wix-events-v-2.http.js.map +1 -1
  4. package/build/cjs/src/events-v3-event-wix-events-v-2.public.d.ts +1 -1
  5. package/build/cjs/src/events-v3-event-wix-events-v-2.public.js +3 -0
  6. package/build/cjs/src/events-v3-event-wix-events-v-2.public.js.map +1 -1
  7. package/build/cjs/src/events-v3-event-wix-events-v-2.types.d.ts +661 -148
  8. package/build/cjs/src/events-v3-event-wix-events-v-2.types.js.map +1 -1
  9. package/build/cjs/src/events-v3-event-wix-events-v-2.universal.d.ts +725 -155
  10. package/build/cjs/src/events-v3-event-wix-events-v-2.universal.js +8 -0
  11. package/build/cjs/src/events-v3-event-wix-events-v-2.universal.js.map +1 -1
  12. package/build/es/src/events-v3-event-wix-events-v-2.context.d.ts +1 -1
  13. package/build/es/src/events-v3-event-wix-events-v-2.http.js +11 -0
  14. package/build/es/src/events-v3-event-wix-events-v-2.http.js.map +1 -1
  15. package/build/es/src/events-v3-event-wix-events-v-2.public.d.ts +1 -1
  16. package/build/es/src/events-v3-event-wix-events-v-2.public.js +3 -0
  17. package/build/es/src/events-v3-event-wix-events-v-2.public.js.map +1 -1
  18. package/build/es/src/events-v3-event-wix-events-v-2.types.d.ts +661 -148
  19. package/build/es/src/events-v3-event-wix-events-v-2.types.js.map +1 -1
  20. package/build/es/src/events-v3-event-wix-events-v-2.universal.d.ts +725 -155
  21. package/build/es/src/events-v3-event-wix-events-v-2.universal.js +8 -0
  22. package/build/es/src/events-v3-event-wix-events-v-2.universal.js.map +1 -1
  23. package/build/internal/cjs/src/events-v3-event-wix-events-v-2.context.d.ts +1 -1
  24. package/build/internal/cjs/src/events-v3-event-wix-events-v-2.http.js +11 -0
  25. package/build/internal/cjs/src/events-v3-event-wix-events-v-2.http.js.map +1 -1
  26. package/build/internal/cjs/src/events-v3-event-wix-events-v-2.public.d.ts +1 -1
  27. package/build/internal/cjs/src/events-v3-event-wix-events-v-2.public.js +3 -0
  28. package/build/internal/cjs/src/events-v3-event-wix-events-v-2.public.js.map +1 -1
  29. package/build/internal/cjs/src/events-v3-event-wix-events-v-2.types.d.ts +661 -148
  30. package/build/internal/cjs/src/events-v3-event-wix-events-v-2.types.js.map +1 -1
  31. package/build/internal/cjs/src/events-v3-event-wix-events-v-2.universal.d.ts +725 -155
  32. package/build/internal/cjs/src/events-v3-event-wix-events-v-2.universal.js +8 -0
  33. package/build/internal/cjs/src/events-v3-event-wix-events-v-2.universal.js.map +1 -1
  34. package/build/internal/es/src/events-v3-event-wix-events-v-2.context.d.ts +1 -1
  35. package/build/internal/es/src/events-v3-event-wix-events-v-2.http.js +11 -0
  36. package/build/internal/es/src/events-v3-event-wix-events-v-2.http.js.map +1 -1
  37. package/build/internal/es/src/events-v3-event-wix-events-v-2.public.d.ts +1 -1
  38. package/build/internal/es/src/events-v3-event-wix-events-v-2.public.js +3 -0
  39. package/build/internal/es/src/events-v3-event-wix-events-v-2.public.js.map +1 -1
  40. package/build/internal/es/src/events-v3-event-wix-events-v-2.types.d.ts +661 -148
  41. package/build/internal/es/src/events-v3-event-wix-events-v-2.types.js.map +1 -1
  42. package/build/internal/es/src/events-v3-event-wix-events-v-2.universal.d.ts +725 -155
  43. package/build/internal/es/src/events-v3-event-wix-events-v-2.universal.js +8 -0
  44. package/build/internal/es/src/events-v3-event-wix-events-v-2.universal.js.map +1 -1
  45. 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
  /**
@@ -113,9 +121,17 @@ export interface V3Event {
113
121
  eventDisplaySettings?: V3EventDisplaySettings;
114
122
  /** Event description. <widget src="https://apps.wix.com/_serverless/ricos-playground-services/goto/api-component" plugins="emoji,audio,codeBlock,collapsibleList,divider,emoji,file,gallery,giphy,hashtag,heading,html,image,indent,lineSpacing,link,linkPreview,spoiler,video" exampleid="9b569a8d-0fc1-40f4-987f-8bd40ecc72d0">Fallback Message for SSR and Error</widget> */
115
123
  description?: RichContent;
124
+ /**
125
+ * Event publish timestamp.
126
+ * @readonly
127
+ */
128
+ publishedDate?: Date | null;
116
129
  }
117
130
  export interface Location {
118
- /** 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
+ */
119
135
  name?: string | null;
120
136
  /** Location type. */
121
137
  type?: LocationType;
@@ -136,42 +152,83 @@ export declare enum LocationType {
136
152
  export interface CommonAddress extends CommonAddressStreetOneOf {
137
153
  /** Street address. */
138
154
  streetAddress?: CommonStreetAddress;
139
- /** Primary address information (street and building number). */
155
+ /**
156
+ * Primary address information (street and building number).
157
+ * @maxLength 250
158
+ */
140
159
  addressLine?: string | null;
141
- /** 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
+ */
142
164
  country?: string | null;
143
- /** 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
+ */
144
169
  subdivision?: string | null;
145
- /** City name. */
170
+ /**
171
+ * City name.
172
+ * @maxLength 100
173
+ */
146
174
  city?: string | null;
147
- /** Zip or postal code. */
175
+ /**
176
+ * Zip or postal code.
177
+ * @maxLength 100
178
+ */
148
179
  postalCode?: string | null;
149
- /** 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
+ */
150
184
  addressLine2?: string | null;
151
185
  }
152
186
  /** @oneof */
153
187
  export interface CommonAddressStreetOneOf {
154
188
  /** Street address. */
155
189
  streetAddress?: CommonStreetAddress;
156
- /** Primary address information (street and building number). */
190
+ /**
191
+ * Primary address information (street and building number).
192
+ * @maxLength 250
193
+ */
157
194
  addressLine?: string | null;
158
195
  }
159
196
  export interface CommonStreetAddress {
160
- /** Street number. */
197
+ /**
198
+ * Street number.
199
+ * @maxLength 100
200
+ */
161
201
  number?: string;
162
- /** Street name. */
202
+ /**
203
+ * Street name.
204
+ * @maxLength 250
205
+ */
163
206
  name?: string;
164
207
  }
165
208
  export interface CommonAddressLocation {
166
- /** Address latitude coordinates. */
209
+ /**
210
+ * Address latitude coordinates.
211
+ * @min -90
212
+ * @max 90
213
+ */
167
214
  latitude?: number | null;
168
- /** Address longitude coordinates. */
215
+ /**
216
+ * Address longitude coordinates.
217
+ * @min -180
218
+ * @max 180
219
+ */
169
220
  longitude?: number | null;
170
221
  }
171
222
  export interface CommonSubdivision {
172
- /** Short subdivision code. */
223
+ /**
224
+ * Short subdivision code.
225
+ * @maxLength 100
226
+ */
173
227
  code?: string;
174
- /** Subdivision full name. */
228
+ /**
229
+ * Subdivision full name.
230
+ * @maxLength 250
231
+ */
175
232
  name?: string;
176
233
  }
177
234
  export declare enum SubdivisionSubdivisionType {
@@ -192,13 +249,19 @@ export declare enum SubdivisionSubdivisionType {
192
249
  export interface DateAndTimeSettings {
193
250
  /** Whether the event date and time are TBD. */
194
251
  dateAndTimeTbd?: boolean | null;
195
- /** 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
+ */
196
256
  dateAndTimeTbdMessage?: string | null;
197
257
  /** Event start date. */
198
258
  startDate?: Date | null;
199
259
  /** Event end date. */
200
260
  endDate?: Date | null;
201
- /** 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
+ */
202
265
  timeZoneId?: string | null;
203
266
  /** Whether the end date is hidden in the formatted date and time. */
204
267
  hideEndDate?: boolean | null;
@@ -229,11 +292,15 @@ export declare enum RecurrenceStatusStatus {
229
292
  RECURRING_RECENTLY_CANCELED = "RECURRING_RECENTLY_CANCELED"
230
293
  }
231
294
  export interface Recurrences {
232
- /** Individual event dates. */
295
+ /**
296
+ * Individual event dates.
297
+ * @maxSize 1000
298
+ */
233
299
  individualEventDates?: Occurrence[];
234
300
  /**
235
301
  * Recurring event category ID.
236
302
  * @readonly
303
+ * @maxLength 100
237
304
  */
238
305
  categoryId?: string | null;
239
306
  }
@@ -242,7 +309,10 @@ export interface Occurrence {
242
309
  startDate?: Date | null;
243
310
  /** Event end date. */
244
311
  endDate?: Date | null;
245
- /** 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
+ */
246
316
  timeZoneId?: string | null;
247
317
  /** Whether the time zone is displayed in a formatted schedule. */
248
318
  showTimeZone?: boolean;
@@ -253,26 +323,31 @@ export interface Formatted {
253
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>
254
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`.
255
325
  * @readonly
326
+ * @maxLength 500
256
327
  */
257
328
  dateAndTime?: string | null;
258
329
  /**
259
330
  * Formatted start date of the event. Empty for TBD schedules.
260
331
  * @readonly
332
+ * @maxLength 500
261
333
  */
262
334
  startDate?: string | null;
263
335
  /**
264
336
  * Formatted start time of the event. Empty for TBD schedules.
265
337
  * @readonly
338
+ * @maxLength 500
266
339
  */
267
340
  startTime?: string | null;
268
341
  /**
269
342
  * Formatted end date of the event. Empty for TBD schedules or when the end date is hidden.
270
343
  * @readonly
344
+ * @maxLength 500
271
345
  */
272
346
  endDate?: string | null;
273
347
  /**
274
348
  * Formatted end time of the event. Empty for TBD schedules or when the end date is hidden.
275
349
  * @readonly
350
+ * @maxLength 500
276
351
  */
277
352
  endTime?: string | null;
278
353
  }
@@ -283,9 +358,15 @@ export interface Formatted {
283
358
  export interface TimeDuration {
284
359
  /** Number of days. */
285
360
  days?: number;
286
- /** Number of hours. */
361
+ /**
362
+ * Number of hours.
363
+ * @max 24
364
+ */
287
365
  hours?: number;
288
- /** Number of minutes. */
366
+ /**
367
+ * Number of minutes.
368
+ * @max 60
369
+ */
289
370
  minutes?: number;
290
371
  }
291
372
  export declare enum Status {
@@ -303,9 +384,15 @@ export declare enum Status {
303
384
  DRAFT = "DRAFT"
304
385
  }
305
386
  export interface PageUrl {
306
- /** 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
+ */
307
391
  base?: string;
308
- /** 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
+ */
309
396
  path?: string;
310
397
  }
311
398
  export interface Registration {
@@ -327,7 +414,10 @@ export interface Registration {
327
414
  external?: ExternalRegistration;
328
415
  /** Types of guests allowed to register. */
329
416
  allowedGuestTypes?: GuestTypeType;
330
- /** 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
+ */
331
421
  initialType?: InitialRegistrationTypeType;
332
422
  /** Whether the registration is paused. */
333
423
  registrationPaused?: boolean;
@@ -390,6 +480,7 @@ export interface TicketsRegistration {
390
480
  /**
391
481
  * Ticket limit per order. <br>
392
482
  * Default: 20 tickets.
483
+ * @max 50
393
484
  */
394
485
  ticketLimitPerOrder?: number;
395
486
  /** Ticket price currency. */
@@ -417,9 +508,15 @@ export interface TicketsRegistration {
417
508
  * Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.
418
509
  */
419
510
  export interface Money {
420
- /** 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
+ */
421
515
  value?: string;
422
- /** 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
+ */
423
520
  currency?: string;
424
521
  /**
425
522
  * Amount of money in decimal form. A period or comma are used as a decimal separator (for example, `1 000,30`).
@@ -430,9 +527,16 @@ export interface Money {
430
527
  export interface TaxSettings {
431
528
  /** Tax application settings. */
432
529
  type?: TaxType;
433
- /** Tax name. */
530
+ /**
531
+ * Tax name.
532
+ * @minLength 1
533
+ * @maxLength 10
534
+ */
434
535
  name?: string | null;
435
- /** 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
+ */
436
540
  rate?: string | null;
437
541
  /** Apply tax to donations. */
438
542
  appliedToDonations?: boolean | null;
@@ -447,7 +551,10 @@ export declare enum TaxType {
447
551
  ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
448
552
  }
449
553
  export interface ExternalRegistration {
450
- /** External event registration URL. */
554
+ /**
555
+ * External event registration URL.
556
+ * @format WEB_URL
557
+ */
451
558
  url?: string | null;
452
559
  }
453
560
  export declare enum GuestTypeType {
@@ -467,7 +574,11 @@ export declare enum InitialRegistrationTypeType {
467
574
  TICKETING = "TICKETING"
468
575
  }
469
576
  export interface CommonImage {
470
- /** WixMedia image ID. */
577
+ /**
578
+ * WixMedia image ID.
579
+ * @minLength 1
580
+ * @maxLength 200
581
+ */
471
582
  id?: string;
472
583
  /** Image URL. */
473
584
  url?: string;
@@ -622,21 +733,29 @@ export declare enum ValueType {
622
733
  * Defaults to first (0th) option if not configured.
623
734
  */
624
735
  export interface OptionSelection extends OptionSelectionSelectedOptionOneOf {
625
- /** 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
+ */
626
740
  optionIndex?: number;
627
741
  /**
628
742
  * Placeholder hint describing expected choices (such as "Please select").
629
743
  * Considered an empty choice.
744
+ * @maxLength 200
630
745
  */
631
746
  placeholderText?: string;
632
747
  }
633
748
  /** @oneof */
634
749
  export interface OptionSelectionSelectedOptionOneOf {
635
- /** 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
+ */
636
754
  optionIndex?: number;
637
755
  /**
638
756
  * Placeholder hint describing expected choices (such as "Please select").
639
757
  * Considered an empty choice.
758
+ * @maxLength 200
640
759
  */
641
760
  placeholderText?: string;
642
761
  }
@@ -748,12 +867,19 @@ export interface Summaries {
748
867
  export interface EventsMoney {
749
868
  /**
750
869
  * *Deprecated:** Use `value` instead.
870
+ * @format DECIMAL_VALUE
751
871
  * @deprecated
752
872
  */
753
873
  amount?: string;
754
- /** ISO 4217 format of the currency e.g., `USD`. */
874
+ /**
875
+ * ISO 4217 format of the currency e.g., `USD`.
876
+ * @format CURRENCY
877
+ */
755
878
  currency?: string;
756
- /** 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
+ */
757
883
  value?: string | null;
758
884
  }
759
885
  export interface Rsvps {
@@ -816,7 +942,10 @@ export interface Feed {
816
942
  export interface OnlineConferencing {
817
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. */
818
944
  enabled?: boolean;
819
- /** Conference host ID. */
945
+ /**
946
+ * Conference host ID.
947
+ * @format GUID
948
+ */
820
949
  providerId?: string | null;
821
950
  /** Conference type. */
822
951
  type?: ConferenceTypeType;
@@ -859,7 +988,10 @@ export interface OnlineConferencingSession {
859
988
  sessionId?: string | null;
860
989
  }
861
990
  export interface SeoSettings {
862
- /** URL slug. */
991
+ /**
992
+ * URL slug.
993
+ * @maxLength 130
994
+ */
863
995
  slug?: string;
864
996
  /** Advanced SEO data. */
865
997
  advancedSeoData?: SeoSchema;
@@ -885,7 +1017,10 @@ export interface Keyword {
885
1017
  term?: string;
886
1018
  /** Whether the keyword is the main focus keyword. */
887
1019
  isMain?: boolean;
888
- /** 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
+ */
889
1024
  origin?: string | null;
890
1025
  }
891
1026
  export interface Tag {
@@ -918,7 +1053,10 @@ export interface Settings {
918
1053
  * Default: `false` (Auto Redirect is enabled.)
919
1054
  */
920
1055
  preventAutoRedirect?: boolean;
921
- /** User-selected keyword terms for a specific page. */
1056
+ /**
1057
+ * User-selected keyword terms for a specific page.
1058
+ * @maxSize 5
1059
+ */
922
1060
  keywords?: Keyword[];
923
1061
  }
924
1062
  export interface AgendaSettings {
@@ -931,16 +1069,24 @@ export interface AgendaSettings {
931
1069
  pageUrl?: PageUrl;
932
1070
  }
933
1071
  export interface EventCategories {
934
- /** Event categories. */
1072
+ /**
1073
+ * Event categories.
1074
+ * @maxSize 10
1075
+ */
935
1076
  categories?: EventCategory[];
936
1077
  }
937
1078
  export interface EventCategory {
938
1079
  /**
939
1080
  * Category ID.
1081
+ * @format GUID
940
1082
  * @readonly
941
1083
  */
942
1084
  id?: string;
943
- /** Category name. */
1085
+ /**
1086
+ * Category name.
1087
+ * @minLength 1
1088
+ * @maxLength 30
1089
+ */
944
1090
  name?: string;
945
1091
  /**
946
1092
  * Category creation timestamp.
@@ -1570,11 +1716,20 @@ export interface GIFData {
1570
1716
  gifType?: GIFType;
1571
1717
  }
1572
1718
  export interface GIF {
1573
- /** GIF format URL. */
1719
+ /**
1720
+ * GIF format URL.
1721
+ * @format WEB_URL
1722
+ */
1574
1723
  gif?: string | null;
1575
- /** MP4 format URL. */
1724
+ /**
1725
+ * MP4 format URL.
1726
+ * @format WEB_URL
1727
+ */
1576
1728
  mp4?: string | null;
1577
- /** Thumbnail URL. */
1729
+ /**
1730
+ * Thumbnail URL.
1731
+ * @format WEB_URL
1732
+ */
1578
1733
  still?: string | null;
1579
1734
  }
1580
1735
  export declare enum GIFType {
@@ -1640,6 +1795,22 @@ export interface ImageData {
1640
1795
  caption?: string | null;
1641
1796
  /** Sets whether the image's download button is disabled. Defaults to `false`. */
1642
1797
  disableDownload?: boolean | null;
1798
+ /** Sets whether the image is decorative and does not need an explanation. Defaults to `false`. */
1799
+ decorative?: boolean | null;
1800
+ /** Styling for the image. */
1801
+ styles?: ImageDataStyles;
1802
+ }
1803
+ export interface StylesBorder {
1804
+ /** Border width in pixels. */
1805
+ width?: number | null;
1806
+ /** Border color. */
1807
+ color?: string | null;
1808
+ /** Border radius in pixels. */
1809
+ radius?: number | null;
1810
+ }
1811
+ export interface ImageDataStyles {
1812
+ /** Border attributes. */
1813
+ border?: StylesBorder;
1643
1814
  }
1644
1815
  export interface LinkPreviewData {
1645
1816
  /** Styling for the link preview's container. */
@@ -1786,13 +1957,22 @@ export declare enum BackgroundType {
1786
1957
  export interface Gradient {
1787
1958
  /** The gradient angle in degrees. */
1788
1959
  angle?: number | null;
1789
- /** The start color as a hexademical value. */
1960
+ /**
1961
+ * The start color as a hexademical value.
1962
+ * @format COLOR_HEX
1963
+ */
1790
1964
  startColor?: string | null;
1791
- /** The end color as a hexademical value. */
1965
+ /**
1966
+ * The end color as a hexademical value.
1967
+ * @format COLOR_HEX
1968
+ */
1792
1969
  lastColor?: string | null;
1793
1970
  }
1794
1971
  export interface Background extends BackgroundBackgroundOneOf {
1795
- /** The background color as a hexademical value. */
1972
+ /**
1973
+ * The background color as a hexademical value.
1974
+ * @format COLOR_HEX
1975
+ */
1796
1976
  color?: string | null;
1797
1977
  /** An image to use for the background. */
1798
1978
  image?: Media;
@@ -1803,7 +1983,10 @@ export interface Background extends BackgroundBackgroundOneOf {
1803
1983
  }
1804
1984
  /** @oneof */
1805
1985
  export interface BackgroundBackgroundOneOf {
1806
- /** The background color as a hexademical value. */
1986
+ /**
1987
+ * The background color as a hexademical value.
1988
+ * @format COLOR_HEX
1989
+ */
1807
1990
  color?: string | null;
1808
1991
  /** An image to use for the background. */
1809
1992
  image?: Media;
@@ -2115,17 +2298,32 @@ export declare enum VerticalAlignment {
2115
2298
  export interface CellStyle {
2116
2299
  /** Vertical alignment for the cell's text. */
2117
2300
  verticalAlignment?: VerticalAlignment;
2118
- /** Cell background color as a hexadecimal value. */
2301
+ /**
2302
+ * Cell background color as a hexadecimal value.
2303
+ * @format COLOR_HEX
2304
+ */
2119
2305
  backgroundColor?: string | null;
2120
2306
  }
2121
2307
  export interface BorderColors {
2122
- /** Left border color as a hexadecimal value. */
2308
+ /**
2309
+ * Left border color as a hexadecimal value.
2310
+ * @format COLOR_HEX
2311
+ */
2123
2312
  left?: string | null;
2124
- /** Right border color as a hexadecimal value. */
2313
+ /**
2314
+ * Right border color as a hexadecimal value.
2315
+ * @format COLOR_HEX
2316
+ */
2125
2317
  right?: string | null;
2126
- /** Top border color as a hexadecimal value. */
2318
+ /**
2319
+ * Top border color as a hexadecimal value.
2320
+ * @format COLOR_HEX
2321
+ */
2127
2322
  top?: string | null;
2128
- /** Bottom border color as a hexadecimal value. */
2323
+ /**
2324
+ * Bottom border color as a hexadecimal value.
2325
+ * @format COLOR_HEX
2326
+ */
2129
2327
  bottom?: string | null;
2130
2328
  }
2131
2329
  /**
@@ -2236,27 +2434,43 @@ export interface TextNodeStyle {
2236
2434
  export interface EventEventStarted {
2237
2435
  /** Event schedule configuration. */
2238
2436
  timestamp?: Date | null;
2239
- /** Event ID. */
2437
+ /**
2438
+ * Event ID.
2439
+ * @format GUID
2440
+ */
2240
2441
  eventId?: string;
2241
2442
  }
2242
2443
  export interface EventEventEnded {
2243
2444
  /** Event end timestamp in ISO UTC format. */
2244
2445
  timestamp?: Date | null;
2245
- /** Event ID. */
2446
+ /**
2447
+ * Event ID.
2448
+ * @format GUID
2449
+ */
2246
2450
  eventId?: string;
2247
2451
  }
2248
2452
  export interface EventEventReminder {
2249
2453
  /** Reminder timestamp in ISO UTC format. */
2250
2454
  timestamp?: Date | null;
2251
- /** Event ID. */
2455
+ /**
2456
+ * Event ID.
2457
+ * @format GUID
2458
+ */
2252
2459
  eventId?: string;
2253
2460
  /** Event location. */
2254
2461
  location?: Location;
2255
2462
  /** Event schedule configuration. */
2256
2463
  dateAndTimeSettings?: DateAndTimeSettings;
2257
- /** Event title. */
2464
+ /**
2465
+ * Event title.
2466
+ * @minLength 1
2467
+ * @maxLength 120
2468
+ */
2258
2469
  title?: string;
2259
- /** ID of the user who created the event. */
2470
+ /**
2471
+ * ID of the user who created the event.
2472
+ * @format GUID
2473
+ */
2260
2474
  userId?: string | null;
2261
2475
  /** Time until the start of event (currently, reminder letter is triggered 1 day before the start of event). */
2262
2476
  startsIn?: TimeDuration;
@@ -2264,18 +2478,29 @@ export interface EventEventReminder {
2264
2478
  export interface EventEventPublished {
2265
2479
  /** Event publishing timestamp in ISO UTC format. */
2266
2480
  timestamp?: Date | null;
2267
- /** Event ID. */
2481
+ /**
2482
+ * Event ID.
2483
+ * @format GUID
2484
+ */
2268
2485
  eventId?: string;
2269
2486
  /** Event status. */
2270
2487
  status?: Status;
2271
2488
  /**
2272
2489
  * Event ID. Indicates the original event from which the current event was derived from.
2273
2490
  * Can be used to track the original event and add missing information.
2491
+ * @format GUID
2274
2492
  */
2275
2493
  derivedFromEventId?: string | null;
2276
- /** Event title. */
2494
+ /**
2495
+ * Event title.
2496
+ * @minLength 1
2497
+ * @maxLength 120
2498
+ */
2277
2499
  title?: string | null;
2278
- /** Short description that appears under the event title. */
2500
+ /**
2501
+ * Short description that appears under the event title.
2502
+ * @maxLength 500
2503
+ */
2279
2504
  shortDescription?: string | null;
2280
2505
  /** Event location. */
2281
2506
  location?: Location;
@@ -2289,21 +2514,37 @@ export interface EventEventPublished {
2289
2514
  export interface EventCloned {
2290
2515
  /** Event creation timestamp in ISO UTC format. */
2291
2516
  timestamp?: Date | null;
2292
- /** Event ID. */
2517
+ /**
2518
+ * Event ID.
2519
+ * @format GUID
2520
+ */
2293
2521
  eventId?: string;
2294
2522
  /** Event location. */
2295
2523
  location?: Location;
2296
2524
  /** Event date and time settings. */
2297
2525
  dateAndTimeSettings?: DateAndTimeSettings;
2298
- /** Event title. */
2526
+ /**
2527
+ * Event title.
2528
+ * @minLength 1
2529
+ * @maxLength 120
2530
+ */
2299
2531
  title?: string;
2300
- /** ID of the user who created the event. */
2532
+ /**
2533
+ * ID of the user who created the event.
2534
+ * @format GUID
2535
+ */
2301
2536
  userId?: string | null;
2302
2537
  /** Event status. */
2303
2538
  status?: Status;
2304
- /** Instance ID. Indicates the original app instance from which current event was derived from. */
2539
+ /**
2540
+ * Instance ID. Indicates the original app instance from which current event was derived from.
2541
+ * @format GUID
2542
+ */
2305
2543
  derivedFromInstanceId?: string | null;
2306
- /** Event ID. Indicates the original event from which current event was derived from. */
2544
+ /**
2545
+ * Event ID. Indicates the original event from which current event was derived from.
2546
+ * @format GUID
2547
+ */
2307
2548
  derivedFromEventId?: string | null;
2308
2549
  /**
2309
2550
  * Map of copied ticket definitions from the original event. <br>
@@ -2315,11 +2556,21 @@ export interface EventCloned {
2315
2556
  export interface EventEventCanceled {
2316
2557
  /** Event cancelation timestamp in ISO UTC format. */
2317
2558
  timestamp?: Date | null;
2318
- /** Event ID. */
2559
+ /**
2560
+ * Event ID.
2561
+ * @format GUID
2562
+ */
2319
2563
  eventId?: string;
2320
- /** Event title. */
2564
+ /**
2565
+ * Event title.
2566
+ * @minLength 1
2567
+ * @maxLength 120
2568
+ */
2321
2569
  title?: string;
2322
- /** ID of the user who created the event. */
2570
+ /**
2571
+ * ID of the user who created the event.
2572
+ * @format GUID
2573
+ */
2323
2574
  userId?: string | null;
2324
2575
  }
2325
2576
  export interface CreateEventRequest {
@@ -2327,7 +2578,10 @@ export interface CreateEventRequest {
2327
2578
  event: V3Event;
2328
2579
  /** Whether to create the event as a draft. */
2329
2580
  draft?: boolean;
2330
- /** Predefined sets of fields to return. */
2581
+ /**
2582
+ * Predefined sets of fields to return.
2583
+ * @maxSize 20
2584
+ */
2331
2585
  fields?: RequestedFields[];
2332
2586
  }
2333
2587
  export declare enum RequestedFields {
@@ -2361,13 +2615,19 @@ export interface CreateEventResponse {
2361
2615
  event?: V3Event;
2362
2616
  }
2363
2617
  export interface CloneEventRequest {
2364
- /** Event ID. */
2618
+ /**
2619
+ * Event ID.
2620
+ * @format GUID
2621
+ */
2365
2622
  eventId: string;
2366
2623
  /** Field values to be changed when cloning the event. */
2367
2624
  event?: V3Event;
2368
2625
  /** Whether to clone the event as a draft. */
2369
2626
  draft?: boolean;
2370
- /** Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned. */
2627
+ /**
2628
+ * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
2629
+ * @maxSize 20
2630
+ */
2371
2631
  fields?: RequestedFields[];
2372
2632
  }
2373
2633
  export interface CloneEventResponse {
@@ -2377,7 +2637,10 @@ export interface CloneEventResponse {
2377
2637
  export interface UpdateEventRequest {
2378
2638
  /** Field values to be changed. */
2379
2639
  event?: V3Event;
2380
- /** Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned. */
2640
+ /**
2641
+ * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
2642
+ * @maxSize 20
2643
+ */
2381
2644
  fields?: RequestedFields[];
2382
2645
  }
2383
2646
  export interface UpdateEventResponse {
@@ -2385,9 +2648,15 @@ export interface UpdateEventResponse {
2385
2648
  event?: V3Event;
2386
2649
  }
2387
2650
  export interface PublishDraftEventRequest {
2388
- /** Event ID. */
2651
+ /**
2652
+ * Event ID.
2653
+ * @format GUID
2654
+ */
2389
2655
  eventId: string;
2390
- /** Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned. */
2656
+ /**
2657
+ * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
2658
+ * @maxSize 20
2659
+ */
2391
2660
  fields?: RequestedFields[];
2392
2661
  }
2393
2662
  export interface PublishDraftEventResponse {
@@ -2395,9 +2664,15 @@ export interface PublishDraftEventResponse {
2395
2664
  event?: V3Event;
2396
2665
  }
2397
2666
  export interface CancelEventRequest {
2398
- /** Event ID. */
2667
+ /**
2668
+ * Event ID.
2669
+ * @format GUID
2670
+ */
2399
2671
  eventId: string;
2400
- /** Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned. */
2672
+ /**
2673
+ * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
2674
+ * @maxSize 20
2675
+ */
2401
2676
  fields?: RequestedFields[];
2402
2677
  }
2403
2678
  export interface CancelEventResponse {
@@ -2422,6 +2697,7 @@ export interface CommonQueryV2 extends CommonQueryV2PagingMethodOneOf {
2422
2697
  /**
2423
2698
  * Sort object in the following format:
2424
2699
  * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
2700
+ * @maxSize 20
2425
2701
  */
2426
2702
  sort?: CommonSorting[];
2427
2703
  }
@@ -2431,7 +2707,10 @@ export interface CommonQueryV2PagingMethodOneOf {
2431
2707
  paging?: CommonPaging;
2432
2708
  }
2433
2709
  export interface CommonSorting {
2434
- /** Name of the field to sort by. */
2710
+ /**
2711
+ * Name of the field to sort by.
2712
+ * @maxLength 100
2713
+ */
2435
2714
  fieldName?: string;
2436
2715
  /**
2437
2716
  * Sort order.
@@ -2446,7 +2725,10 @@ export declare enum CommonSortOrder {
2446
2725
  DESC = "DESC"
2447
2726
  }
2448
2727
  export interface CommonPaging {
2449
- /** 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. */
2728
+ /**
2729
+ * 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.
2730
+ * @max 1000
2731
+ */
2450
2732
  limit?: number | null;
2451
2733
  /** Number of items to skip in the current sort order. */
2452
2734
  offset?: number | null;
@@ -2454,11 +2736,17 @@ export interface CommonPaging {
2454
2736
  export interface BulkCancelEventsByFilterResponse {
2455
2737
  }
2456
2738
  export interface DeleteEventRequest {
2457
- /** Event ID. */
2739
+ /**
2740
+ * Event ID.
2741
+ * @format GUID
2742
+ */
2458
2743
  eventId: string;
2459
2744
  }
2460
2745
  export interface DeleteEventResponse {
2461
- /** Deleted event ID. */
2746
+ /**
2747
+ * Deleted event ID.
2748
+ * @format GUID
2749
+ */
2462
2750
  eventId?: string;
2463
2751
  }
2464
2752
  export interface BulkDeleteEventsByFilterRequest {
@@ -2470,7 +2758,10 @@ export interface BulkDeleteEventsByFilterResponse {
2470
2758
  export interface QueryEventsRequest {
2471
2759
  /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
2472
2760
  query?: CommonQueryV2;
2473
- /** Predefined sets of fields to return. */
2761
+ /**
2762
+ * Predefined sets of fields to return.
2763
+ * @maxSize 20
2764
+ */
2474
2765
  fields?: RequestedFields[];
2475
2766
  /**
2476
2767
  * Whether draft events should be returned in the response. <br>
@@ -2536,7 +2827,10 @@ export interface QueryV2PagingMethodOneOf {
2536
2827
  cursorPaging?: CursorPaging;
2537
2828
  }
2538
2829
  export interface Sorting {
2539
- /** Name of the field to sort by. */
2830
+ /**
2831
+ * Name of the field to sort by.
2832
+ * @maxLength 512
2833
+ */
2540
2834
  fieldName?: string;
2541
2835
  /** Sort order. */
2542
2836
  order?: SortOrder;
@@ -2552,13 +2846,17 @@ export interface Paging {
2552
2846
  offset?: number | null;
2553
2847
  }
2554
2848
  export interface CursorPaging {
2555
- /** Maximum number of items to return in the results. */
2849
+ /**
2850
+ * Maximum number of items to return in the results.
2851
+ * @max 100
2852
+ */
2556
2853
  limit?: number | null;
2557
2854
  /**
2558
2855
  * Pointer to the next or previous page in the list of results.
2559
2856
  *
2560
2857
  * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
2561
2858
  * Not relevant for the first request.
2859
+ * @maxLength 16000
2562
2860
  */
2563
2861
  cursor?: string | null;
2564
2862
  }
@@ -2581,15 +2879,25 @@ export interface PagingMetadataV2 {
2581
2879
  cursors?: Cursors;
2582
2880
  }
2583
2881
  export interface Cursors {
2584
- /** Cursor string pointing to the next page in the list of results. */
2882
+ /**
2883
+ * Cursor string pointing to the next page in the list of results.
2884
+ * @maxLength 16000
2885
+ */
2585
2886
  next?: string | null;
2586
- /** Cursor pointing to the previous page in the list of results. */
2887
+ /**
2888
+ * Cursor pointing to the previous page in the list of results.
2889
+ * @maxLength 16000
2890
+ */
2587
2891
  prev?: string | null;
2588
2892
  }
2589
2893
  export interface CountEventsByStatusRequest {
2590
2894
  /** Filter object in the following format: <br/> `"filter" : { "fieldName1": "value1" }`. */
2591
2895
  filter?: Record<string, any> | null;
2592
- /** Parameters to count events by. */
2896
+ /**
2897
+ * Parameters to count events by.
2898
+ * @maxLength 100
2899
+ * @maxSize 20
2900
+ */
2593
2901
  facet?: string[];
2594
2902
  /**
2595
2903
  * Whether draft events should be returned in the response. <br>
@@ -2613,22 +2921,35 @@ export interface ListUserEventsRequest {
2613
2921
  /**
2614
2922
  * Sort order, defaults to `"created:asc"`.
2615
2923
  * 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).
2924
+ * @maxSize 20
2616
2925
  */
2617
2926
  sort?: CommonSorting[];
2618
- /** Event status. */
2927
+ /**
2928
+ * Event status.
2929
+ * @maxSize 20
2930
+ */
2619
2931
  status?: Status[];
2620
2932
  /** Allows to filter events by user relation to the event among all wix sites. */
2621
2933
  userFilter?: UserFilter;
2622
2934
  /**
2623
2935
  * Filter facets to include in the response.
2624
2936
  * 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).
2937
+ * @maxLength 100
2938
+ * @maxSize 20
2625
2939
  */
2626
2940
  facet?: string[];
2627
2941
  }
2628
2942
  export interface UserFilter {
2629
- /** User who is related to event */
2943
+ /**
2944
+ * User who is related to event
2945
+ * @format GUID
2946
+ */
2630
2947
  userId?: string;
2631
- /** Relation of user to event. */
2948
+ /**
2949
+ * Relation of user to event.
2950
+ * @minSize 1
2951
+ * @maxSize 20
2952
+ */
2632
2953
  relation?: Relation[];
2633
2954
  }
2634
2955
  export declare enum Relation {
@@ -2644,11 +2965,17 @@ export interface ListUserEventsResponse {
2644
2965
  facets?: Record<string, FacetCounts>;
2645
2966
  }
2646
2967
  export interface ListEventsByCategoryRequest {
2647
- /** Category ID. */
2968
+ /**
2969
+ * Category ID.
2970
+ * @format GUID
2971
+ */
2648
2972
  categoryId?: string;
2649
2973
  /** Paging options to limit and skip the number of items. */
2650
2974
  paging?: CommonPaging;
2651
- /** Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned. */
2975
+ /**
2976
+ * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
2977
+ * @maxSize 20
2978
+ */
2652
2979
  fields?: RequestedFields[];
2653
2980
  }
2654
2981
  export interface ListEventsByCategoryResponse {
@@ -2658,9 +2985,15 @@ export interface ListEventsByCategoryResponse {
2658
2985
  events?: V3Event[];
2659
2986
  }
2660
2987
  export interface GetEventRequest {
2661
- /** Event ID. */
2988
+ /**
2989
+ * Event ID.
2990
+ * @format GUID
2991
+ */
2662
2992
  eventId: string | null;
2663
- /** Predefined sets of fields to return. */
2993
+ /**
2994
+ * Predefined sets of fields to return.
2995
+ * @maxSize 20
2996
+ */
2664
2997
  fields?: RequestedFields[];
2665
2998
  }
2666
2999
  export interface GetEventResponse {
@@ -2668,8 +3001,13 @@ export interface GetEventResponse {
2668
3001
  event?: V3Event;
2669
3002
  }
2670
3003
  export interface GetEventBySlugRequest {
2671
- /** URL slug. */
3004
+ /**
3005
+ * URL slug.
3006
+ * @minLength 1
3007
+ * @maxLength 130
3008
+ */
2672
3009
  slug: string | null;
3010
+ /** @maxSize 20 */
2673
3011
  fields?: RequestedFields[];
2674
3012
  }
2675
3013
  export interface GetEventBySlugResponse {
@@ -2677,18 +3015,35 @@ export interface GetEventBySlugResponse {
2677
3015
  event?: V3Event;
2678
3016
  }
2679
3017
  export interface FindEventRequest extends FindEventRequestFindByOneOf {
2680
- /** Event ID. */
3018
+ /**
3019
+ * Event ID.
3020
+ * @format GUID
3021
+ */
2681
3022
  eventId?: string | null;
2682
- /** URL slug. */
3023
+ /**
3024
+ * URL slug.
3025
+ * @minLength 1
3026
+ * @maxLength 130
3027
+ */
2683
3028
  slug?: string | null;
2684
- /** Predefined sets of fields to return. */
3029
+ /**
3030
+ * Predefined sets of fields to return.
3031
+ * @maxSize 20
3032
+ */
2685
3033
  fields?: RequestedFields[];
2686
3034
  }
2687
3035
  /** @oneof */
2688
3036
  export interface FindEventRequestFindByOneOf {
2689
- /** Event ID. */
3037
+ /**
3038
+ * Event ID.
3039
+ * @format GUID
3040
+ */
2690
3041
  eventId?: string | null;
2691
- /** URL slug. */
3042
+ /**
3043
+ * URL slug.
3044
+ * @minLength 1
3045
+ * @maxLength 130
3046
+ */
2692
3047
  slug?: string | null;
2693
3048
  }
2694
3049
  export interface FindEventResponse {
@@ -2698,7 +3053,10 @@ export interface FindEventResponse {
2698
3053
  export interface EventCreated {
2699
3054
  /** Event created timestamp in ISO UTC format. */
2700
3055
  timestamp?: Date | null;
2701
- /** Event ID. */
3056
+ /**
3057
+ * Event ID.
3058
+ * @format GUID
3059
+ */
2702
3060
  eventId?: string;
2703
3061
  /** Event location. */
2704
3062
  location?: EventsLocation;
@@ -2706,23 +3064,38 @@ export interface EventCreated {
2706
3064
  scheduleConfig?: ScheduleConfig;
2707
3065
  /** Event title. */
2708
3066
  title?: string;
2709
- /** Event creator user ID. */
3067
+ /**
3068
+ * Event creator user ID.
3069
+ * @maxLength 36
3070
+ */
2710
3071
  userId?: string | null;
2711
3072
  /** Event status. */
2712
3073
  status?: EventStatus;
2713
- /** Instance ID. Indicates the original app instance which current event was derived from. */
3074
+ /**
3075
+ * Instance ID. Indicates the original app instance which current event was derived from.
3076
+ * @format GUID
3077
+ */
2714
3078
  derivedFromInstanceId?: string | null;
2715
- /** Event ID. Indicates the original event which current event was derived from. */
3079
+ /**
3080
+ * Event ID. Indicates the original event which current event was derived from.
3081
+ * @format GUID
3082
+ */
2716
3083
  derivedFromEventId?: string | null;
2717
3084
  /** Event that was created. */
2718
3085
  event?: Event;
2719
3086
  }
2720
3087
  export interface EventsLocation {
2721
- /** Location name. */
3088
+ /**
3089
+ * Location name.
3090
+ * @maxLength 50
3091
+ */
2722
3092
  name?: string | null;
2723
3093
  /** Location map coordinates. */
2724
3094
  coordinates?: MapCoordinates;
2725
- /** Single line address representation. */
3095
+ /**
3096
+ * Single line address representation.
3097
+ * @maxLength 300
3098
+ */
2726
3099
  address?: string | null;
2727
3100
  /** Location type. */
2728
3101
  type?: LocationLocationType;
@@ -2744,9 +3117,17 @@ export interface EventsLocation {
2744
3117
  tbd?: boolean | null;
2745
3118
  }
2746
3119
  export interface MapCoordinates {
2747
- /** Latitude. */
3120
+ /**
3121
+ * Latitude.
3122
+ * @min -90
3123
+ * @max 90
3124
+ */
2748
3125
  lat?: number;
2749
- /** Longitude. */
3126
+ /**
3127
+ * Longitude.
3128
+ * @min -180
3129
+ * @max 180
3130
+ */
2750
3131
  lng?: number;
2751
3132
  }
2752
3133
  export declare enum LocationLocationType {
@@ -2759,7 +3140,10 @@ export interface Address extends AddressStreetOneOf {
2759
3140
  streetAddress?: StreetAddress;
2760
3141
  /** Main address line (usually street and number) as free text */
2761
3142
  addressLine?: string | null;
2762
- /** country code */
3143
+ /**
3144
+ * country code
3145
+ * @format COUNTRY
3146
+ */
2763
3147
  country?: string | null;
2764
3148
  /** subdivision (usually state or region) code according to ISO 3166-2 */
2765
3149
  subdivision?: string | null;
@@ -2777,7 +3161,10 @@ export interface Address extends AddressStreetOneOf {
2777
3161
  geocode?: AddressLocation;
2778
3162
  /** country full-name */
2779
3163
  countryFullname?: string | null;
2780
- /** multi-level subdivisions from top to bottom */
3164
+ /**
3165
+ * multi-level subdivisions from top to bottom
3166
+ * @maxSize 6
3167
+ */
2781
3168
  subdivisions?: Subdivision[];
2782
3169
  }
2783
3170
  /** @oneof */
@@ -2794,9 +3181,17 @@ export interface StreetAddress {
2794
3181
  name?: string;
2795
3182
  }
2796
3183
  export interface AddressLocation {
2797
- /** address latitude coordinates */
3184
+ /**
3185
+ * address latitude coordinates
3186
+ * @min -90
3187
+ * @max 90
3188
+ */
2798
3189
  latitude?: number | null;
2799
- /** address longitude coordinates */
3190
+ /**
3191
+ * address longitude coordinates
3192
+ * @min -180
3193
+ * @max 180
3194
+ */
2800
3195
  longitude?: number | null;
2801
3196
  }
2802
3197
  export interface Subdivision {
@@ -2827,13 +3222,19 @@ export interface ScheduleConfig {
2827
3222
  * `startDate`, `endDate` and `timeZoneId` are not required when schedule is TBD.
2828
3223
  */
2829
3224
  scheduleTbd?: boolean;
2830
- /** TBD message. */
3225
+ /**
3226
+ * TBD message.
3227
+ * @maxLength 100
3228
+ */
2831
3229
  scheduleTbdMessage?: string | null;
2832
3230
  /** Event start timestamp. */
2833
3231
  startDate?: Date | null;
2834
3232
  /** Event end timestamp. */
2835
3233
  endDate?: Date | null;
2836
- /** Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`. */
3234
+ /**
3235
+ * Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`.
3236
+ * @maxLength 100
3237
+ */
2837
3238
  timeZoneId?: string | null;
2838
3239
  /** Whether end date is hidden in the formatted schedule. */
2839
3240
  endDateHidden?: boolean;
@@ -2843,7 +3244,10 @@ export interface ScheduleConfig {
2843
3244
  recurrences?: EventsRecurrences;
2844
3245
  }
2845
3246
  export interface EventsRecurrences {
2846
- /** Event occurrences. */
3247
+ /**
3248
+ * Event occurrences.
3249
+ * @maxSize 1000
3250
+ */
2847
3251
  occurrences?: EventsOccurrence[];
2848
3252
  /**
2849
3253
  * Recurring event category ID.
@@ -2861,7 +3265,10 @@ export interface EventsOccurrence {
2861
3265
  startDate?: Date | null;
2862
3266
  /** Event end timestamp. */
2863
3267
  endDate?: Date | null;
2864
- /** Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`. */
3268
+ /**
3269
+ * Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`.
3270
+ * @maxLength 100
3271
+ */
2865
3272
  timeZoneId?: string | null;
2866
3273
  /** Whether time zone is displayed in formatted schedule. */
2867
3274
  showTimeZone?: boolean;
@@ -2891,6 +3298,7 @@ export declare enum EventStatus {
2891
3298
  export interface Event {
2892
3299
  /**
2893
3300
  * Event ID.
3301
+ * @format GUID
2894
3302
  * @readonly
2895
3303
  */
2896
3304
  id?: string;
@@ -2930,7 +3338,10 @@ export interface Event {
2930
3338
  instanceId?: string;
2931
3339
  /** Guest list configuration. */
2932
3340
  guestListConfig?: GuestListConfig;
2933
- /** Event creator user ID. */
3341
+ /**
3342
+ * Event creator user ID.
3343
+ * @maxLength 36
3344
+ */
2934
3345
  userId?: string;
2935
3346
  /** Event discussion feed. For internal use. */
2936
3347
  feed?: EventsFeed;
@@ -2969,7 +3380,11 @@ export interface Scheduling {
2969
3380
  endTimeFormatted?: string;
2970
3381
  }
2971
3382
  export interface Image {
2972
- /** WixMedia image ID. */
3383
+ /**
3384
+ * WixMedia image ID.
3385
+ * @minLength 1
3386
+ * @maxLength 200
3387
+ */
2973
3388
  id?: string | null;
2974
3389
  /** Image URL. */
2975
3390
  url?: string;
@@ -3097,17 +3512,31 @@ export interface TicketingConfig {
3097
3512
  guestAssignedTickets?: boolean;
3098
3513
  /** Tax configuration. */
3099
3514
  taxConfig?: TaxConfig;
3100
- /** Limit of tickets that can be purchased per order, default 20. */
3515
+ /**
3516
+ * Limit of tickets that can be purchased per order, default 20.
3517
+ * @max 50
3518
+ */
3101
3519
  ticketLimitPerOrder?: number;
3102
- /** Duration for which the tickets being bought are reserved. */
3520
+ /**
3521
+ * Duration for which the tickets being bought are reserved.
3522
+ * @min 5
3523
+ * @max 30
3524
+ */
3103
3525
  reservationDurationInMinutes?: number | null;
3104
3526
  }
3105
3527
  export interface TaxConfig {
3106
3528
  /** Tax application settings. */
3107
3529
  type?: EventsTaxType;
3108
- /** Tax name. */
3530
+ /**
3531
+ * Tax name.
3532
+ * @minLength 1
3533
+ * @maxLength 10
3534
+ */
3109
3535
  name?: string | null;
3110
- /** Tax rate (e.g.,`21.55`). */
3536
+ /**
3537
+ * Tax rate (e.g.,`21.55`).
3538
+ * @decimalValue options - {gte:0.001,lte:100,maxScale:3}
3539
+ */
3111
3540
  rate?: string | null;
3112
3541
  /** Applies taxes for donations, default true. */
3113
3542
  appliesToDonations?: boolean | null;
@@ -3200,7 +3629,10 @@ export interface OnlineConferencingConfig {
3200
3629
  * When enabled, links to join conferencing are generated and provided to guests.
3201
3630
  */
3202
3631
  enabled?: boolean;
3203
- /** Conferencing provider ID. */
3632
+ /**
3633
+ * Conferencing provider ID.
3634
+ * @format GUID
3635
+ */
3204
3636
  providerId?: string | null;
3205
3637
  /** Conference type */
3206
3638
  conferenceType?: ConferenceType;
@@ -3239,7 +3671,10 @@ export interface EventsOnlineConferencingSession {
3239
3671
  sessionId?: string | null;
3240
3672
  }
3241
3673
  export interface EventsSeoSettings {
3242
- /** URL slug */
3674
+ /**
3675
+ * URL slug
3676
+ * @maxLength 130
3677
+ */
3243
3678
  slug?: string;
3244
3679
  /** Advanced SEO data */
3245
3680
  advancedSeoData?: SeoSchema;
@@ -3261,10 +3696,15 @@ export interface Agenda {
3261
3696
  export interface Category {
3262
3697
  /**
3263
3698
  * Category ID.
3699
+ * @format GUID
3264
3700
  * @readonly
3265
3701
  */
3266
3702
  id?: string;
3267
- /** Category name. */
3703
+ /**
3704
+ * Category name.
3705
+ * @minLength 1
3706
+ * @maxLength 30
3707
+ */
3268
3708
  name?: string;
3269
3709
  /**
3270
3710
  * Date and time when category was created.
@@ -3287,6 +3727,7 @@ export interface Category {
3287
3727
  * Default: `MANUAL`.
3288
3728
  *
3289
3729
  * **Note:** The WIX_EVENTS.MANAGE_AUTO_CATEGORIES permission scope is required to use states other than `MANUAL`.
3730
+ * @maxSize 3
3290
3731
  */
3291
3732
  states?: State[];
3292
3733
  }
@@ -3319,7 +3760,10 @@ export interface Empty {
3319
3760
  export interface EventUpdated {
3320
3761
  /** Event update timestamp in ISO UTC format. */
3321
3762
  timestamp?: Date | null;
3322
- /** Event ID. */
3763
+ /**
3764
+ * Event ID.
3765
+ * @format GUID
3766
+ */
3323
3767
  eventId?: string;
3324
3768
  /** Event location. */
3325
3769
  location?: EventsLocation;
@@ -3338,17 +3782,26 @@ export interface EventUpdated {
3338
3782
  export interface EventDeleted {
3339
3783
  /** Event deleted timestamp in ISO UTC format. */
3340
3784
  timestamp?: Date | null;
3341
- /** Event ID. */
3785
+ /**
3786
+ * Event ID.
3787
+ * @format GUID
3788
+ */
3342
3789
  eventId?: string;
3343
3790
  /** Event title. */
3344
3791
  title?: string;
3345
- /** Event creator user ID. */
3792
+ /**
3793
+ * Event creator user ID.
3794
+ * @format GUID
3795
+ */
3346
3796
  userId?: string | null;
3347
3797
  }
3348
3798
  export interface EventCopied {
3349
3799
  /** Event created timestamp in ISO UTC format. */
3350
3800
  timestamp?: Date | null;
3351
- /** Event ID. */
3801
+ /**
3802
+ * Event ID.
3803
+ * @format GUID
3804
+ */
3352
3805
  eventId?: string;
3353
3806
  /** Event location. */
3354
3807
  location?: EventsLocation;
@@ -3356,13 +3809,22 @@ export interface EventCopied {
3356
3809
  scheduleConfig?: ScheduleConfig;
3357
3810
  /** Event title. */
3358
3811
  title?: string;
3359
- /** Event creator user ID. */
3812
+ /**
3813
+ * Event creator user ID.
3814
+ * @format GUID
3815
+ */
3360
3816
  userId?: string | null;
3361
3817
  /** Event status. */
3362
3818
  status?: EventStatus;
3363
- /** Instance ID. Indicates the original app instance which current event was derived from. */
3819
+ /**
3820
+ * Instance ID. Indicates the original app instance which current event was derived from.
3821
+ * @format GUID
3822
+ */
3364
3823
  derivedFromInstanceId?: string | null;
3365
- /** Event ID. Indicates the original event which current event was derived from. */
3824
+ /**
3825
+ * Event ID. Indicates the original event which current event was derived from.
3826
+ * @format GUID
3827
+ */
3366
3828
  derivedFromEventId?: string | null;
3367
3829
  /**
3368
3830
  * Map of copied ticket definitions from original event.
@@ -3374,7 +3836,10 @@ export interface EventCopied {
3374
3836
  export interface EventPublished {
3375
3837
  /** Event publish timestamp in ISO UTC format. */
3376
3838
  timestamp?: Date | null;
3377
- /** Event ID. */
3839
+ /**
3840
+ * Event ID.
3841
+ * @format GUID
3842
+ */
3378
3843
  eventId?: string;
3379
3844
  /** Event status. */
3380
3845
  status?: EventStatus;
@@ -3399,29 +3864,44 @@ export interface EventPublished {
3399
3864
  export interface EventCanceled {
3400
3865
  /** Event canceled timestamp in ISO UTC format. */
3401
3866
  timestamp?: Date | null;
3402
- /** Event ID. */
3867
+ /**
3868
+ * Event ID.
3869
+ * @format GUID
3870
+ */
3403
3871
  eventId?: string;
3404
3872
  /** Event title */
3405
3873
  title?: string;
3406
- /** Event creator user ID. */
3874
+ /**
3875
+ * Event creator user ID.
3876
+ * @format GUID
3877
+ */
3407
3878
  userId?: string | null;
3408
3879
  }
3409
3880
  export interface EventStarted {
3410
3881
  /** Event start timestamp in ISO UTC format. */
3411
3882
  timestamp?: Date | null;
3412
- /** Event ID. */
3883
+ /**
3884
+ * Event ID.
3885
+ * @format GUID
3886
+ */
3413
3887
  eventId?: string;
3414
3888
  }
3415
3889
  export interface EventEnded {
3416
3890
  /** Event end timestamp in ISO UTC format. */
3417
3891
  timestamp?: Date | null;
3418
- /** Event ID. */
3892
+ /**
3893
+ * Event ID.
3894
+ * @format GUID
3895
+ */
3419
3896
  eventId?: string;
3420
3897
  }
3421
3898
  export interface EventReminder {
3422
3899
  /** Reminder timestamp in ISO UTC format. */
3423
3900
  timestamp?: Date | null;
3424
- /** Event ID. */
3901
+ /**
3902
+ * Event ID.
3903
+ * @format GUID
3904
+ */
3425
3905
  eventId?: string;
3426
3906
  /** Event location. */
3427
3907
  location?: EventsLocation;
@@ -3429,7 +3909,10 @@ export interface EventReminder {
3429
3909
  scheduleConfig?: ScheduleConfig;
3430
3910
  /** Event title. */
3431
3911
  title?: string;
3432
- /** Event creator user ID. */
3912
+ /**
3913
+ * Event creator user ID.
3914
+ * @format GUID
3915
+ */
3433
3916
  userId?: string | null;
3434
3917
  /** Time until the event starts (currently, reminder is triggered 1 day before event starts). */
3435
3918
  startsIn?: TimeDuration;
@@ -3507,9 +3990,15 @@ export interface ActionEvent {
3507
3990
  bodyAsJson?: string;
3508
3991
  }
3509
3992
  export interface MessageEnvelope {
3510
- /** App instance ID. */
3993
+ /**
3994
+ * App instance ID.
3995
+ * @format GUID
3996
+ */
3511
3997
  instanceId?: string | null;
3512
- /** Event type. */
3998
+ /**
3999
+ * Event type.
4000
+ * @maxLength 150
4001
+ */
3513
4002
  eventType?: string;
3514
4003
  /** The identification type and identity data. */
3515
4004
  identity?: IdentificationData;
@@ -3517,26 +4006,50 @@ export interface MessageEnvelope {
3517
4006
  data?: string;
3518
4007
  }
3519
4008
  export interface IdentificationData extends IdentificationDataIdOneOf {
3520
- /** ID of a site visitor that has not logged in to the site. */
4009
+ /**
4010
+ * ID of a site visitor that has not logged in to the site.
4011
+ * @format GUID
4012
+ */
3521
4013
  anonymousVisitorId?: string;
3522
- /** ID of a site visitor that has logged in to the site. */
4014
+ /**
4015
+ * ID of a site visitor that has logged in to the site.
4016
+ * @format GUID
4017
+ */
3523
4018
  memberId?: string;
3524
- /** ID of a Wix user (site owner, contributor, etc.). */
4019
+ /**
4020
+ * ID of a Wix user (site owner, contributor, etc.).
4021
+ * @format GUID
4022
+ */
3525
4023
  wixUserId?: string;
3526
- /** ID of an app. */
4024
+ /**
4025
+ * ID of an app.
4026
+ * @format GUID
4027
+ */
3527
4028
  appId?: string;
3528
4029
  /** @readonly */
3529
4030
  identityType?: WebhookIdentityType;
3530
4031
  }
3531
4032
  /** @oneof */
3532
4033
  export interface IdentificationDataIdOneOf {
3533
- /** ID of a site visitor that has not logged in to the site. */
4034
+ /**
4035
+ * ID of a site visitor that has not logged in to the site.
4036
+ * @format GUID
4037
+ */
3534
4038
  anonymousVisitorId?: string;
3535
- /** ID of a site visitor that has logged in to the site. */
4039
+ /**
4040
+ * ID of a site visitor that has logged in to the site.
4041
+ * @format GUID
4042
+ */
3536
4043
  memberId?: string;
3537
- /** ID of a Wix user (site owner, contributor, etc.). */
4044
+ /**
4045
+ * ID of a Wix user (site owner, contributor, etc.).
4046
+ * @format GUID
4047
+ */
3538
4048
  wixUserId?: string;
3539
- /** ID of an app. */
4049
+ /**
4050
+ * ID of an app.
4051
+ * @format GUID
4052
+ */
3540
4053
  appId?: string;
3541
4054
  }
3542
4055
  export declare enum WebhookIdentityType {