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

package/build/cjs/src/events-v3-event-wix-events-v-2.types.d.ts

@@ -1,6 +1,7 @@
 export interface V3Event {
     /**
      * Event ID.
+     * @format GUID
      * @readonly
      */
     id?: string;
@@ -8,17 +9,23 @@ export interface V3Event {
     location?: Location;
     /** Event date and time settings. */
     dateAndTimeSettings?: DateAndTimeSettings;
-    /** Event title. */
+    /**
+     * Event title.
+     * @minLength 1
+     * @maxLength 120
+     */
     title?: string | null;
     /**
      * Short description that appears under the event title. <br>
      * **Note:** This field is returned only when the `DETAILS` fieldset is included in the request.
+     * @maxLength 500
      */
     shortDescription?: string | null;
     /**
      * Detailed description of an event.
      *
      * This field is deprecated.
+     * @maxLength 50000
      * @deprecated Detailed description of an event.
      *
      * This field is deprecated.
@@ -87,6 +94,7 @@ export interface V3Event {
     /**
      * ID of the user who created the event.
      * @readonly
+     * @format GUID
      */
     userId?: string;
     /**
@@ -120,7 +128,10 @@ export interface V3Event {
     publishedDate?: Date | null;
 }
 export interface Location {
-    /** Location name. This value is displayed instead of the address when the location is defined as TBD by setting the `locationTbd` property to `true`. */
+    /**
+     * Location name. This value is displayed instead of the address when the location is defined as TBD by setting the `locationTbd` property to `true`.
+     * @maxLength 50
+     */
     name?: string | null;
     /** Location type. */
     type?: LocationType;
@@ -141,42 +152,83 @@ export declare enum LocationType {
 export interface CommonAddress extends CommonAddressStreetOneOf {
     /** Street address. */
     streetAddress?: CommonStreetAddress;
-    /** Primary address information (street and building number). */
+    /**
+     * Primary address information (street and building number).
+     * @maxLength 250
+     */
     addressLine?: string | null;
-    /** 2-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */
+    /**
+     * 2-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format.
+     * @format COUNTRY
+     */
     country?: string | null;
-    /** Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */
+    /**
+     * Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2).
+     * @maxLength 20
+     */
     subdivision?: string | null;
-    /** City name. */
+    /**
+     * City name.
+     * @maxLength 100
+     */
     city?: string | null;
-    /** Zip or postal code. */
+    /**
+     * Zip or postal code.
+     * @maxLength 100
+     */
     postalCode?: string | null;
-    /** Secondary address information (suite or apartment number and room number). */
+    /**
+     * Secondary address information (suite or apartment number and room number).
+     * @maxLength 250
+     */
     addressLine2?: string | null;
 }
 /** @oneof */
 export interface CommonAddressStreetOneOf {
     /** Street address. */
     streetAddress?: CommonStreetAddress;
-    /** Primary address information (street and building number). */
+    /**
+     * Primary address information (street and building number).
+     * @maxLength 250
+     */
     addressLine?: string | null;
 }
 export interface CommonStreetAddress {
-    /** Street number. */
+    /**
+     * Street number.
+     * @maxLength 100
+     */
     number?: string;
-    /** Street name. */
+    /**
+     * Street name.
+     * @maxLength 250
+     */
     name?: string;
 }
 export interface CommonAddressLocation {
-    /** Address latitude coordinates. */
+    /**
+     * Address latitude coordinates.
+     * @min -90
+     * @max 90
+     */
     latitude?: number | null;
-    /** Address longitude coordinates. */
+    /**
+     * Address longitude coordinates.
+     * @min -180
+     * @max 180
+     */
     longitude?: number | null;
 }
 export interface CommonSubdivision {
-    /** Short subdivision code. */
+    /**
+     * Short subdivision code.
+     * @maxLength 100
+     */
     code?: string;
-    /** Subdivision full name. */
+    /**
+     * Subdivision full name.
+     * @maxLength 250
+     */
     name?: string;
 }
 export declare enum SubdivisionSubdivisionType {
@@ -197,13 +249,19 @@ export declare enum SubdivisionSubdivisionType {
 export interface DateAndTimeSettings {
     /** Whether the event date and time are TBD. */
     dateAndTimeTbd?: boolean | null;
-    /** Message that is displayed when time and date is TBD. */
+    /**
+     * Message that is displayed when time and date is TBD.
+     * @maxLength 100
+     */
     dateAndTimeTbdMessage?: string | null;
     /** Event start date. */
     startDate?: Date | null;
     /** Event end date. */
     endDate?: Date | null;
-    /** Event time zone ID in the [TZ database](https://www.iana.org/time-zones) format. */
+    /**
+     * Event time zone ID in the [TZ database](https://www.iana.org/time-zones) format.
+     * @maxLength 100
+     */
     timeZoneId?: string | null;
     /** Whether the end date is hidden in the formatted date and time. */
     hideEndDate?: boolean | null;
@@ -234,11 +292,15 @@ export declare enum RecurrenceStatusStatus {
     RECURRING_RECENTLY_CANCELED = "RECURRING_RECENTLY_CANCELED"
 }
 export interface Recurrences {
-    /** Individual event dates. */
+    /**
+     * Individual event dates.
+     * @maxSize 1000
+     */
     individualEventDates?: Occurrence[];
     /**
      * Recurring event category ID.
      * @readonly
+     * @maxLength 100
      */
     categoryId?: string | null;
 }
@@ -247,7 +309,10 @@ export interface Occurrence {
     startDate?: Date | null;
     /** Event end date. */
     endDate?: Date | null;
-    /** Event time zone ID in the [TZ database](https://www.iana.org/time-zones) format. */
+    /**
+     * Event time zone ID in the [TZ database](https://www.iana.org/time-zones) format.
+     * @maxLength 100
+     */
     timeZoneId?: string | null;
     /** Whether the time zone is displayed in a formatted schedule. */
     showTimeZone?: boolean;
@@ -258,26 +323,31 @@ export interface Formatted {
      * 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>
      * 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`.
      * @readonly
+     * @maxLength 500
      */
     dateAndTime?: string | null;
     /**
      * Formatted start date of the event. Empty for TBD schedules.
      * @readonly
+     * @maxLength 500
      */
     startDate?: string | null;
     /**
      * Formatted start time of the event. Empty for TBD schedules.
      * @readonly
+     * @maxLength 500
      */
     startTime?: string | null;
     /**
      * Formatted end date of the event. Empty for TBD schedules or when the end date is hidden.
      * @readonly
+     * @maxLength 500
      */
     endDate?: string | null;
     /**
      * Formatted end time of the event. Empty for TBD schedules or when the end date is hidden.
      * @readonly
+     * @maxLength 500
      */
     endTime?: string | null;
 }
@@ -288,9 +358,15 @@ export interface Formatted {
 export interface TimeDuration {
     /** Number of days. */
     days?: number;
-    /** Number of hours. */
+    /**
+     * Number of hours.
+     * @max 24
+     */
     hours?: number;
-    /** Number of minutes. */
+    /**
+     * Number of minutes.
+     * @max 60
+     */
     minutes?: number;
 }
 export declare enum Status {
@@ -308,9 +384,15 @@ export declare enum Status {
     DRAFT = "DRAFT"
 }
 export interface PageUrl {
-    /** 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`). */
+    /**
+     * 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`).
+     * @maxLength 500
+     */
     base?: string;
-    /** The path to the page. For example, `/product-page/a-product`. */
+    /**
+     * The path to the page. For example, `/product-page/a-product`.
+     * @maxLength 500
+     */
     path?: string;
 }
 export interface Registration {
@@ -332,7 +414,10 @@ export interface Registration {
     external?: ExternalRegistration;
     /** Types of guests allowed to register. */
     allowedGuestTypes?: GuestTypeType;
-    /** Initial event type which is set when creating an event. */
+    /**
+     * Initial event type which is set when creating an event.
+     * @immutable
+     */
     initialType?: InitialRegistrationTypeType;
     /** Whether the registration is paused. */
     registrationPaused?: boolean;
@@ -395,6 +480,7 @@ export interface TicketsRegistration {
     /**
      * Ticket limit per order. <br>
      * Default: 20 tickets.
+     * @max 50
      */
     ticketLimitPerOrder?: number;
     /** Ticket price currency. */
@@ -422,9 +508,15 @@ export interface TicketsRegistration {
  * Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.
  */
 export interface Money {
-    /** Amount of money in decimal form. A period is used as a decimal separator (for example, `3.99`). */
+    /**
+     * Amount of money in decimal form. A period is used as a decimal separator (for example, `3.99`).
+     * @format DECIMAL_VALUE
+     */
     value?: string;
-    /** Currency code in 3-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. */
+    /**
+     * Currency code in 3-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
+     * @format CURRENCY
+     */
     currency?: string;
     /**
      * Amount of money in decimal form. A period or comma are used as a decimal separator (for example, `1 000,30`).
@@ -435,9 +527,16 @@ export interface Money {
 export interface TaxSettings {
     /** Tax application settings. */
     type?: TaxType;
-    /** Tax name. */
+    /**
+     * Tax name.
+     * @minLength 1
+     * @maxLength 10
+     */
     name?: string | null;
-    /** Tax rate (for example,`21.55`). */
+    /**
+     * Tax rate (for example,`21.55`).
+     * @decimalValue options - {gte:0.001,lte:100,maxScale:3}
+     */
     rate?: string | null;
     /** Apply tax to donations. */
     appliedToDonations?: boolean | null;
@@ -452,7 +551,10 @@ export declare enum TaxType {
     ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
 }
 export interface ExternalRegistration {
-    /** External event registration URL. */
+    /**
+     * External event registration URL.
+     * @format WEB_URL
+     */
     url?: string | null;
 }
 export declare enum GuestTypeType {
@@ -472,7 +574,11 @@ export declare enum InitialRegistrationTypeType {
     TICKETING = "TICKETING"
 }
 export interface CommonImage {
-    /** WixMedia image ID. */
+    /**
+     * WixMedia image ID.
+     * @minLength 1
+     * @maxLength 200
+     */
     id?: string;
     /** Image URL. */
     url?: string;
@@ -627,21 +733,29 @@ export declare enum ValueType {
  * Defaults to first (0th) option if not configured.
  */
 export interface OptionSelection extends OptionSelectionSelectedOptionOneOf {
-    /** 0-based index from predefined `input.options` which is selected initially. */
+    /**
+     * 0-based index from predefined `input.options` which is selected initially.
+     * @max 199
+     */
     optionIndex?: number;
     /**
      * Placeholder hint describing expected choices (such as "Please select").
      * Considered an empty choice.
+     * @maxLength 200
      */
     placeholderText?: string;
 }
 /** @oneof */
 export interface OptionSelectionSelectedOptionOneOf {
-    /** 0-based index from predefined `input.options` which is selected initially. */
+    /**
+     * 0-based index from predefined `input.options` which is selected initially.
+     * @max 199
+     */
     optionIndex?: number;
     /**
      * Placeholder hint describing expected choices (such as "Please select").
      * Considered an empty choice.
+     * @maxLength 200
      */
     placeholderText?: string;
 }
@@ -753,12 +867,19 @@ export interface Summaries {
 export interface EventsMoney {
     /**
      * *Deprecated:** Use `value` instead.
+     * @format DECIMAL_VALUE
      * @deprecated
      */
     amount?: string;
-    /** ISO 4217 format of the currency e.g., `USD`. */
+    /**
+     * ISO 4217 format of the currency e.g., `USD`.
+     * @format CURRENCY
+     */
     currency?: string;
-    /** 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. */
+    /**
+     * 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.
+     * @format DECIMAL_VALUE
+     */
     value?: string | null;
 }
 export interface Rsvps {
@@ -821,7 +942,10 @@ export interface Feed {
 export interface OnlineConferencing {
     /** 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. */
     enabled?: boolean;
-    /** Conference host ID. */
+    /**
+     * Conference host ID.
+     * @format GUID
+     */
     providerId?: string | null;
     /** Conference type. */
     type?: ConferenceTypeType;
@@ -864,7 +988,10 @@ export interface OnlineConferencingSession {
     sessionId?: string | null;
 }
 export interface SeoSettings {
-    /** URL slug. */
+    /**
+     * URL slug.
+     * @maxLength 130
+     */
     slug?: string;
     /** Advanced SEO data. */
     advancedSeoData?: SeoSchema;
@@ -890,7 +1017,10 @@ export interface Keyword {
     term?: string;
     /** Whether the keyword is the main focus keyword. */
     isMain?: boolean;
-    /** The source that added the keyword terms to the SEO settings. */
+    /**
+     * The source that added the keyword terms to the SEO settings.
+     * @maxLength 1000
+     */
     origin?: string | null;
 }
 export interface Tag {
@@ -923,7 +1053,10 @@ export interface Settings {
      * Default: `false` (Auto Redirect is enabled.)
      */
     preventAutoRedirect?: boolean;
-    /** User-selected keyword terms for a specific page. */
+    /**
+     * User-selected keyword terms for a specific page.
+     * @maxSize 5
+     */
     keywords?: Keyword[];
 }
 export interface AgendaSettings {
@@ -936,16 +1069,24 @@ export interface AgendaSettings {
     pageUrl?: PageUrl;
 }
 export interface EventCategories {
-    /** Event categories. */
+    /**
+     * Event categories.
+     * @maxSize 10
+     */
     categories?: EventCategory[];
 }
 export interface EventCategory {
     /**
      * Category ID.
+     * @format GUID
      * @readonly
      */
     id?: string;
-    /** Category name. */
+    /**
+     * Category name.
+     * @minLength 1
+     * @maxLength 30
+     */
     name?: string;
     /**
      * Category creation timestamp.
@@ -1575,11 +1716,20 @@ export interface GIFData {
     gifType?: GIFType;
 }
 export interface GIF {
-    /** GIF format URL. */
+    /**
+     * GIF format URL.
+     * @format WEB_URL
+     */
     gif?: string | null;
-    /** MP4 format URL. */
+    /**
+     * MP4 format URL.
+     * @format WEB_URL
+     */
     mp4?: string | null;
-    /** Thumbnail URL. */
+    /**
+     * Thumbnail URL.
+     * @format WEB_URL
+     */
     still?: string | null;
 }
 export declare enum GIFType {
@@ -1807,13 +1957,22 @@ export declare enum BackgroundType {
 export interface Gradient {
     /** The gradient angle in degrees. */
     angle?: number | null;
-    /** The start color as a hexademical value. */
+    /**
+     * The start color as a hexademical value.
+     * @format COLOR_HEX
+     */
     startColor?: string | null;
-    /** The end color as a hexademical value. */
+    /**
+     * The end color as a hexademical value.
+     * @format COLOR_HEX
+     */
     lastColor?: string | null;
 }
 export interface Background extends BackgroundBackgroundOneOf {
-    /** The background color as a hexademical value. */
+    /**
+     * The background color as a hexademical value.
+     * @format COLOR_HEX
+     */
     color?: string | null;
     /** An image to use for the background. */
     image?: Media;
@@ -1824,7 +1983,10 @@ export interface Background extends BackgroundBackgroundOneOf {
 }
 /** @oneof */
 export interface BackgroundBackgroundOneOf {
-    /** The background color as a hexademical value. */
+    /**
+     * The background color as a hexademical value.
+     * @format COLOR_HEX
+     */
     color?: string | null;
     /** An image to use for the background. */
     image?: Media;
@@ -2136,17 +2298,32 @@ export declare enum VerticalAlignment {
 export interface CellStyle {
     /** Vertical alignment for the cell's text. */
     verticalAlignment?: VerticalAlignment;
-    /** Cell background color as a hexadecimal value. */
+    /**
+     * Cell background color as a hexadecimal value.
+     * @format COLOR_HEX
+     */
     backgroundColor?: string | null;
 }
 export interface BorderColors {
-    /** Left border color as a hexadecimal value. */
+    /**
+     * Left border color as a hexadecimal value.
+     * @format COLOR_HEX
+     */
     left?: string | null;
-    /** Right border color as a hexadecimal value. */
+    /**
+     * Right border color as a hexadecimal value.
+     * @format COLOR_HEX
+     */
     right?: string | null;
-    /** Top border color as a hexadecimal value. */
+    /**
+     * Top border color as a hexadecimal value.
+     * @format COLOR_HEX
+     */
     top?: string | null;
-    /** Bottom border color as a hexadecimal value. */
+    /**
+     * Bottom border color as a hexadecimal value.
+     * @format COLOR_HEX
+     */
     bottom?: string | null;
 }
 /**
@@ -2257,27 +2434,43 @@ export interface TextNodeStyle {
 export interface EventEventStarted {
     /** Event schedule configuration. */
     timestamp?: Date | null;
-    /** Event ID. */
+    /**
+     * Event ID.
+     * @format GUID
+     */
     eventId?: string;
 }
 export interface EventEventEnded {
     /** Event end timestamp in ISO UTC format. */
     timestamp?: Date | null;
-    /** Event ID. */
+    /**
+     * Event ID.
+     * @format GUID
+     */
     eventId?: string;
 }
 export interface EventEventReminder {
     /** Reminder timestamp in ISO UTC format. */
     timestamp?: Date | null;
-    /** Event ID. */
+    /**
+     * Event ID.
+     * @format GUID
+     */
     eventId?: string;
     /** Event location. */
     location?: Location;
     /** Event schedule configuration. */
     dateAndTimeSettings?: DateAndTimeSettings;
-    /** Event title. */
+    /**
+     * Event title.
+     * @minLength 1
+     * @maxLength 120
+     */
     title?: string;
-    /** ID of the user who created the event. */
+    /**
+     * ID of the user who created the event.
+     * @format GUID
+     */
     userId?: string | null;
     /** Time until the start of event (currently, reminder letter is triggered 1 day before the start of event). */
     startsIn?: TimeDuration;
@@ -2285,18 +2478,29 @@ export interface EventEventReminder {
 export interface EventEventPublished {
     /** Event publishing timestamp in ISO UTC format. */
     timestamp?: Date | null;
-    /** Event ID. */
+    /**
+     * Event ID.
+     * @format GUID
+     */
     eventId?: string;
     /** Event status. */
     status?: Status;
     /**
      * Event ID. Indicates the original event from which the current event was derived from.
      * Can be used to track the original event and add missing information.
+     * @format GUID
      */
     derivedFromEventId?: string | null;
-    /** Event title. */
+    /**
+     * Event title.
+     * @minLength 1
+     * @maxLength 120
+     */
     title?: string | null;
-    /** Short description that appears under the event title. */
+    /**
+     * Short description that appears under the event title.
+     * @maxLength 500
+     */
     shortDescription?: string | null;
     /** Event location. */
     location?: Location;
@@ -2310,21 +2514,37 @@ export interface EventEventPublished {
 export interface EventCloned {
     /** Event creation timestamp in ISO UTC format. */
     timestamp?: Date | null;
-    /** Event ID. */
+    /**
+     * Event ID.
+     * @format GUID
+     */
     eventId?: string;
     /** Event location. */
     location?: Location;
     /** Event date and time settings. */
     dateAndTimeSettings?: DateAndTimeSettings;
-    /** Event title. */
+    /**
+     * Event title.
+     * @minLength 1
+     * @maxLength 120
+     */
     title?: string;
-    /** ID of the user who created the event. */
+    /**
+     * ID of the user who created the event.
+     * @format GUID
+     */
     userId?: string | null;
     /** Event status. */
     status?: Status;
-    /** Instance ID. Indicates the original app instance from which current event was derived from. */
+    /**
+     * Instance ID. Indicates the original app instance from which current event was derived from.
+     * @format GUID
+     */
     derivedFromInstanceId?: string | null;
-    /** Event ID. Indicates the original event from which current event was derived from. */
+    /**
+     * Event ID. Indicates the original event from which current event was derived from.
+     * @format GUID
+     */
     derivedFromEventId?: string | null;
     /**
      * Map of copied ticket definitions from the original event. <br>
@@ -2336,11 +2556,21 @@ export interface EventCloned {
 export interface EventEventCanceled {
     /** Event cancelation timestamp in ISO UTC format. */
     timestamp?: Date | null;
-    /** Event ID. */
+    /**
+     * Event ID.
+     * @format GUID
+     */
     eventId?: string;
-    /** Event title. */
+    /**
+     * Event title.
+     * @minLength 1
+     * @maxLength 120
+     */
     title?: string;
-    /** ID of the user who created the event. */
+    /**
+     * ID of the user who created the event.
+     * @format GUID
+     */
     userId?: string | null;
 }
 export interface CreateEventRequest {
@@ -2348,7 +2578,10 @@ export interface CreateEventRequest {
     event: V3Event;
     /** Whether to create the event as a draft. */
     draft?: boolean;
-    /** Predefined sets of fields to return. */
+    /**
+     * Predefined sets of fields to return.
+     * @maxSize 20
+     */
     fields?: RequestedFields[];
 }
 export declare enum RequestedFields {
@@ -2382,13 +2615,19 @@ export interface CreateEventResponse {
     event?: V3Event;
 }
 export interface CloneEventRequest {
-    /** Event ID. */
+    /**
+     * Event ID.
+     * @format GUID
+     */
     eventId: string;
     /** Field values to be changed when cloning the event. */
     event?: V3Event;
     /** Whether to clone the event as a draft. */
     draft?: boolean;
-    /** Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned. */
+    /**
+     * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
+     * @maxSize 20
+     */
     fields?: RequestedFields[];
 }
 export interface CloneEventResponse {
@@ -2398,7 +2637,10 @@ export interface CloneEventResponse {
 export interface UpdateEventRequest {
     /** Field values to be changed. */
     event?: V3Event;
-    /** Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned. */
+    /**
+     * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
+     * @maxSize 20
+     */
     fields?: RequestedFields[];
 }
 export interface UpdateEventResponse {
@@ -2406,9 +2648,15 @@ export interface UpdateEventResponse {
     event?: V3Event;
 }
 export interface PublishDraftEventRequest {
-    /** Event ID. */
+    /**
+     * Event ID.
+     * @format GUID
+     */
     eventId: string;
-    /** Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned. */
+    /**
+     * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
+     * @maxSize 20
+     */
     fields?: RequestedFields[];
 }
 export interface PublishDraftEventResponse {
@@ -2416,9 +2664,15 @@ export interface PublishDraftEventResponse {
     event?: V3Event;
 }
 export interface CancelEventRequest {
-    /** Event ID. */
+    /**
+     * Event ID.
+     * @format GUID
+     */
     eventId: string;
-    /** Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned. */
+    /**
+     * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
+     * @maxSize 20
+     */
     fields?: RequestedFields[];
 }
 export interface CancelEventResponse {
@@ -2443,6 +2697,7 @@ export interface CommonQueryV2 extends CommonQueryV2PagingMethodOneOf {
     /**
      * Sort object in the following format:
      * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     * @maxSize 20
      */
     sort?: CommonSorting[];
 }
@@ -2452,7 +2707,10 @@ export interface CommonQueryV2PagingMethodOneOf {
     paging?: CommonPaging;
 }
 export interface CommonSorting {
-    /** Name of the field to sort by. */
+    /**
+     * Name of the field to sort by.
+     * @maxLength 100
+     */
     fieldName?: string;
     /**
      * Sort order.
@@ -2467,7 +2725,10 @@ export declare enum CommonSortOrder {
     DESC = "DESC"
 }
 export interface CommonPaging {
-    /** 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. */
+    /**
+     * 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.
+     * @max 1000
+     */
     limit?: number | null;
     /** Number of items to skip in the current sort order. */
     offset?: number | null;
@@ -2475,11 +2736,17 @@ export interface CommonPaging {
 export interface BulkCancelEventsByFilterResponse {
 }
 export interface DeleteEventRequest {
-    /** Event ID. */
+    /**
+     * Event ID.
+     * @format GUID
+     */
     eventId: string;
 }
 export interface DeleteEventResponse {
-    /** Deleted event ID. */
+    /**
+     * Deleted event ID.
+     * @format GUID
+     */
     eventId?: string;
 }
 export interface BulkDeleteEventsByFilterRequest {
@@ -2491,7 +2758,10 @@ export interface BulkDeleteEventsByFilterResponse {
 export interface QueryEventsRequest {
     /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
     query?: CommonQueryV2;
-    /** Predefined sets of fields to return. */
+    /**
+     * Predefined sets of fields to return.
+     * @maxSize 20
+     */
     fields?: RequestedFields[];
     /**
      * Whether draft events should be returned in the response. <br>
@@ -2557,7 +2827,10 @@ export interface QueryV2PagingMethodOneOf {
     cursorPaging?: CursorPaging;
 }
 export interface Sorting {
-    /** Name of the field to sort by. */
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
     fieldName?: string;
     /** Sort order. */
     order?: SortOrder;
@@ -2573,13 +2846,17 @@ export interface Paging {
     offset?: number | null;
 }
 export interface CursorPaging {
-    /** Maximum number of items to return in the results. */
+    /**
+     * Maximum number of items to return in the results.
+     * @max 100
+     */
     limit?: number | null;
     /**
      * Pointer to the next or previous page in the list of results.
      *
      * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
      * Not relevant for the first request.
+     * @maxLength 16000
      */
     cursor?: string | null;
 }
@@ -2602,15 +2879,25 @@ export interface PagingMetadataV2 {
     cursors?: Cursors;
 }
 export interface Cursors {
-    /** Cursor string pointing to the next page in the list of results. */
+    /**
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
+     */
     next?: string | null;
-    /** Cursor pointing to the previous page in the list of results. */
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
     prev?: string | null;
 }
 export interface CountEventsByStatusRequest {
     /** Filter object in the following format: <br/> `"filter" : { "fieldName1": "value1" }`. */
     filter?: Record<string, any> | null;
-    /** Parameters to count events by. */
+    /**
+     * Parameters to count events by.
+     * @maxLength 100
+     * @maxSize 20
+     */
     facet?: string[];
     /**
      * Whether draft events should be returned in the response. <br>
@@ -2634,22 +2921,35 @@ export interface ListUserEventsRequest {
     /**
      * Sort order, defaults to `"created:asc"`.
      * 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).
+     * @maxSize 20
      */
     sort?: CommonSorting[];
-    /** Event status. */
+    /**
+     * Event status.
+     * @maxSize 20
+     */
     status?: Status[];
     /** Allows to filter events by user relation to the event among all wix sites. */
     userFilter?: UserFilter;
     /**
      * Filter facets to include in the response.
      * 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).
+     * @maxLength 100
+     * @maxSize 20
      */
     facet?: string[];
 }
 export interface UserFilter {
-    /** User who is related to event */
+    /**
+     * User who is related to event
+     * @format GUID
+     */
     userId?: string;
-    /** Relation of user to event. */
+    /**
+     * Relation of user to event.
+     * @minSize 1
+     * @maxSize 20
+     */
     relation?: Relation[];
 }
 export declare enum Relation {
@@ -2665,11 +2965,17 @@ export interface ListUserEventsResponse {
     facets?: Record<string, FacetCounts>;
 }
 export interface ListEventsByCategoryRequest {
-    /** Category ID. */
+    /**
+     * Category ID.
+     * @format GUID
+     */
     categoryId?: string;
     /** Paging options to limit and skip the number of items. */
     paging?: CommonPaging;
-    /** Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned. */
+    /**
+     * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
+     * @maxSize 20
+     */
     fields?: RequestedFields[];
 }
 export interface ListEventsByCategoryResponse {
@@ -2679,9 +2985,15 @@ export interface ListEventsByCategoryResponse {
     events?: V3Event[];
 }
 export interface GetEventRequest {
-    /** Event ID. */
+    /**
+     * Event ID.
+     * @format GUID
+     */
     eventId: string | null;
-    /** Predefined sets of fields to return. */
+    /**
+     * Predefined sets of fields to return.
+     * @maxSize 20
+     */
     fields?: RequestedFields[];
 }
 export interface GetEventResponse {
@@ -2689,8 +3001,13 @@ export interface GetEventResponse {
     event?: V3Event;
 }
 export interface GetEventBySlugRequest {
-    /** URL slug. */
+    /**
+     * URL slug.
+     * @minLength 1
+     * @maxLength 130
+     */
     slug: string | null;
+    /** @maxSize 20 */
     fields?: RequestedFields[];
 }
 export interface GetEventBySlugResponse {
@@ -2698,18 +3015,35 @@ export interface GetEventBySlugResponse {
     event?: V3Event;
 }
 export interface FindEventRequest extends FindEventRequestFindByOneOf {
-    /** Event ID. */
+    /**
+     * Event ID.
+     * @format GUID
+     */
     eventId?: string | null;
-    /** URL slug. */
+    /**
+     * URL slug.
+     * @minLength 1
+     * @maxLength 130
+     */
     slug?: string | null;
-    /** Predefined sets of fields to return. */
+    /**
+     * Predefined sets of fields to return.
+     * @maxSize 20
+     */
     fields?: RequestedFields[];
 }
 /** @oneof */
 export interface FindEventRequestFindByOneOf {
-    /** Event ID. */
+    /**
+     * Event ID.
+     * @format GUID
+     */
     eventId?: string | null;
-    /** URL slug. */
+    /**
+     * URL slug.
+     * @minLength 1
+     * @maxLength 130
+     */
     slug?: string | null;
 }
 export interface FindEventResponse {
@@ -2719,7 +3053,10 @@ export interface FindEventResponse {
 export interface EventCreated {
     /** Event created timestamp in ISO UTC format. */
     timestamp?: Date | null;
-    /** Event ID. */
+    /**
+     * Event ID.
+     * @format GUID
+     */
     eventId?: string;
     /** Event location. */
     location?: EventsLocation;
@@ -2727,23 +3064,38 @@ export interface EventCreated {
     scheduleConfig?: ScheduleConfig;
     /** Event title. */
     title?: string;
-    /** Event creator user ID. */
+    /**
+     * Event creator user ID.
+     * @maxLength 36
+     */
     userId?: string | null;
     /** Event status. */
     status?: EventStatus;
-    /** Instance ID. Indicates the original app instance which current event was derived from. */
+    /**
+     * Instance ID. Indicates the original app instance which current event was derived from.
+     * @format GUID
+     */
     derivedFromInstanceId?: string | null;
-    /** Event ID. Indicates the original event which current event was derived from. */
+    /**
+     * Event ID. Indicates the original event which current event was derived from.
+     * @format GUID
+     */
     derivedFromEventId?: string | null;
     /** Event that was created. */
     event?: Event;
 }
 export interface EventsLocation {
-    /** Location name. */
+    /**
+     * Location name.
+     * @maxLength 50
+     */
     name?: string | null;
     /** Location map coordinates. */
     coordinates?: MapCoordinates;
-    /** Single line address representation. */
+    /**
+     * Single line address representation.
+     * @maxLength 300
+     */
     address?: string | null;
     /** Location type. */
     type?: LocationLocationType;
@@ -2765,9 +3117,17 @@ export interface EventsLocation {
     tbd?: boolean | null;
 }
 export interface MapCoordinates {
-    /** Latitude. */
+    /**
+     * Latitude.
+     * @min -90
+     * @max 90
+     */
     lat?: number;
-    /** Longitude. */
+    /**
+     * Longitude.
+     * @min -180
+     * @max 180
+     */
     lng?: number;
 }
 export declare enum LocationLocationType {
@@ -2780,7 +3140,10 @@ export interface Address extends AddressStreetOneOf {
     streetAddress?: StreetAddress;
     /** Main address line (usually street and number) as free text */
     addressLine?: string | null;
-    /** country code */
+    /**
+     * country code
+     * @format COUNTRY
+     */
     country?: string | null;
     /** subdivision (usually state or region) code according to ISO 3166-2 */
     subdivision?: string | null;
@@ -2798,7 +3161,10 @@ export interface Address extends AddressStreetOneOf {
     geocode?: AddressLocation;
     /** country full-name */
     countryFullname?: string | null;
-    /** multi-level subdivisions from top to bottom */
+    /**
+     * multi-level subdivisions from top to bottom
+     * @maxSize 6
+     */
     subdivisions?: Subdivision[];
 }
 /** @oneof */
@@ -2815,9 +3181,17 @@ export interface StreetAddress {
     name?: string;
 }
 export interface AddressLocation {
-    /** address latitude coordinates */
+    /**
+     * address latitude coordinates
+     * @min -90
+     * @max 90
+     */
     latitude?: number | null;
-    /** address longitude coordinates */
+    /**
+     * address longitude coordinates
+     * @min -180
+     * @max 180
+     */
     longitude?: number | null;
 }
 export interface Subdivision {
@@ -2848,13 +3222,19 @@ export interface ScheduleConfig {
      * `startDate`, `endDate` and `timeZoneId` are not required when schedule is TBD.
      */
     scheduleTbd?: boolean;
-    /** TBD message. */
+    /**
+     * TBD message.
+     * @maxLength 100
+     */
     scheduleTbdMessage?: string | null;
     /** Event start timestamp. */
     startDate?: Date | null;
     /** Event end timestamp. */
     endDate?: Date | null;
-    /** Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`. */
+    /**
+     * Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`.
+     * @maxLength 100
+     */
     timeZoneId?: string | null;
     /** Whether end date is hidden in the formatted schedule. */
     endDateHidden?: boolean;
@@ -2864,7 +3244,10 @@ export interface ScheduleConfig {
     recurrences?: EventsRecurrences;
 }
 export interface EventsRecurrences {
-    /** Event occurrences. */
+    /**
+     * Event occurrences.
+     * @maxSize 1000
+     */
     occurrences?: EventsOccurrence[];
     /**
      * Recurring event category ID.
@@ -2882,7 +3265,10 @@ export interface EventsOccurrence {
     startDate?: Date | null;
     /** Event end timestamp. */
     endDate?: Date | null;
-    /** Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`. */
+    /**
+     * Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`.
+     * @maxLength 100
+     */
     timeZoneId?: string | null;
     /** Whether time zone is displayed in formatted schedule. */
     showTimeZone?: boolean;
@@ -2912,6 +3298,7 @@ export declare enum EventStatus {
 export interface Event {
     /**
      * Event ID.
+     * @format GUID
      * @readonly
      */
     id?: string;
@@ -2951,7 +3338,10 @@ export interface Event {
     instanceId?: string;
     /** Guest list configuration. */
     guestListConfig?: GuestListConfig;
-    /** Event creator user ID. */
+    /**
+     * Event creator user ID.
+     * @maxLength 36
+     */
     userId?: string;
     /** Event discussion feed. For internal use. */
     feed?: EventsFeed;
@@ -2990,7 +3380,11 @@ export interface Scheduling {
     endTimeFormatted?: string;
 }
 export interface Image {
-    /** WixMedia image ID. */
+    /**
+     * WixMedia image ID.
+     * @minLength 1
+     * @maxLength 200
+     */
     id?: string | null;
     /** Image URL. */
     url?: string;
@@ -3118,17 +3512,31 @@ export interface TicketingConfig {
     guestAssignedTickets?: boolean;
     /** Tax configuration. */
     taxConfig?: TaxConfig;
-    /** Limit of tickets that can be purchased per order, default 20. */
+    /**
+     * Limit of tickets that can be purchased per order, default 20.
+     * @max 50
+     */
     ticketLimitPerOrder?: number;
-    /** Duration for which the tickets being bought are reserved. */
+    /**
+     * Duration for which the tickets being bought are reserved.
+     * @min 5
+     * @max 30
+     */
     reservationDurationInMinutes?: number | null;
 }
 export interface TaxConfig {
     /** Tax application settings. */
     type?: EventsTaxType;
-    /** Tax name. */
+    /**
+     * Tax name.
+     * @minLength 1
+     * @maxLength 10
+     */
     name?: string | null;
-    /** Tax rate (e.g.,`21.55`). */
+    /**
+     * Tax rate (e.g.,`21.55`).
+     * @decimalValue options - {gte:0.001,lte:100,maxScale:3}
+     */
     rate?: string | null;
     /** Applies taxes for donations, default true. */
     appliesToDonations?: boolean | null;
@@ -3221,7 +3629,10 @@ export interface OnlineConferencingConfig {
      * When enabled, links to join conferencing are generated and provided to guests.
      */
     enabled?: boolean;
-    /** Conferencing provider ID. */
+    /**
+     * Conferencing provider ID.
+     * @format GUID
+     */
     providerId?: string | null;
     /** Conference type */
     conferenceType?: ConferenceType;
@@ -3260,7 +3671,10 @@ export interface EventsOnlineConferencingSession {
     sessionId?: string | null;
 }
 export interface EventsSeoSettings {
-    /** URL slug */
+    /**
+     * URL slug
+     * @maxLength 130
+     */
     slug?: string;
     /** Advanced SEO data */
     advancedSeoData?: SeoSchema;
@@ -3282,10 +3696,15 @@ export interface Agenda {
 export interface Category {
     /**
      * Category ID.
+     * @format GUID
      * @readonly
      */
     id?: string;
-    /** Category name. */
+    /**
+     * Category name.
+     * @minLength 1
+     * @maxLength 30
+     */
     name?: string;
     /**
      * Date and time when category was created.
@@ -3308,6 +3727,7 @@ export interface Category {
      * Default: `MANUAL`.
      *
      * **Note:** The WIX_EVENTS.MANAGE_AUTO_CATEGORIES permission scope is required to use states other than `MANUAL`.
+     * @maxSize 3
      */
     states?: State[];
 }
@@ -3340,7 +3760,10 @@ export interface Empty {
 export interface EventUpdated {
     /** Event update timestamp in ISO UTC format. */
     timestamp?: Date | null;
-    /** Event ID. */
+    /**
+     * Event ID.
+     * @format GUID
+     */
     eventId?: string;
     /** Event location. */
     location?: EventsLocation;
@@ -3359,17 +3782,26 @@ export interface EventUpdated {
 export interface EventDeleted {
     /** Event deleted timestamp in ISO UTC format. */
     timestamp?: Date | null;
-    /** Event ID. */
+    /**
+     * Event ID.
+     * @format GUID
+     */
     eventId?: string;
     /** Event title. */
     title?: string;
-    /** Event creator user ID. */
+    /**
+     * Event creator user ID.
+     * @format GUID
+     */
     userId?: string | null;
 }
 export interface EventCopied {
     /** Event created timestamp in ISO UTC format. */
     timestamp?: Date | null;
-    /** Event ID. */
+    /**
+     * Event ID.
+     * @format GUID
+     */
     eventId?: string;
     /** Event location. */
     location?: EventsLocation;
@@ -3377,13 +3809,22 @@ export interface EventCopied {
     scheduleConfig?: ScheduleConfig;
     /** Event title. */
     title?: string;
-    /** Event creator user ID. */
+    /**
+     * Event creator user ID.
+     * @format GUID
+     */
     userId?: string | null;
     /** Event status. */
     status?: EventStatus;
-    /** Instance ID. Indicates the original app instance which current event was derived from. */
+    /**
+     * Instance ID. Indicates the original app instance which current event was derived from.
+     * @format GUID
+     */
     derivedFromInstanceId?: string | null;
-    /** Event ID. Indicates the original event which current event was derived from. */
+    /**
+     * Event ID. Indicates the original event which current event was derived from.
+     * @format GUID
+     */
     derivedFromEventId?: string | null;
     /**
      * Map of copied ticket definitions from original event.
@@ -3395,7 +3836,10 @@ export interface EventCopied {
 export interface EventPublished {
     /** Event publish timestamp in ISO UTC format. */
     timestamp?: Date | null;
-    /** Event ID. */
+    /**
+     * Event ID.
+     * @format GUID
+     */
     eventId?: string;
     /** Event status. */
     status?: EventStatus;
@@ -3420,29 +3864,44 @@ export interface EventPublished {
 export interface EventCanceled {
     /** Event canceled timestamp in ISO UTC format. */
     timestamp?: Date | null;
-    /** Event ID. */
+    /**
+     * Event ID.
+     * @format GUID
+     */
     eventId?: string;
     /** Event title */
     title?: string;
-    /** Event creator user ID. */
+    /**
+     * Event creator user ID.
+     * @format GUID
+     */
     userId?: string | null;
 }
 export interface EventStarted {
     /** Event start timestamp in ISO UTC format. */
     timestamp?: Date | null;
-    /** Event ID. */
+    /**
+     * Event ID.
+     * @format GUID
+     */
     eventId?: string;
 }
 export interface EventEnded {
     /** Event end timestamp in ISO UTC format. */
     timestamp?: Date | null;
-    /** Event ID. */
+    /**
+     * Event ID.
+     * @format GUID
+     */
     eventId?: string;
 }
 export interface EventReminder {
     /** Reminder timestamp in ISO UTC format. */
     timestamp?: Date | null;
-    /** Event ID. */
+    /**
+     * Event ID.
+     * @format GUID
+     */
     eventId?: string;
     /** Event location. */
     location?: EventsLocation;
@@ -3450,7 +3909,10 @@ export interface EventReminder {
     scheduleConfig?: ScheduleConfig;
     /** Event title. */
     title?: string;
-    /** Event creator user ID. */
+    /**
+     * Event creator user ID.
+     * @format GUID
+     */
     userId?: string | null;
     /** Time until the event starts (currently, reminder is triggered 1 day before event starts). */
     startsIn?: TimeDuration;
@@ -3528,9 +3990,15 @@ export interface ActionEvent {
     bodyAsJson?: string;
 }
 export interface MessageEnvelope {
-    /** App instance ID. */
+    /**
+     * App instance ID.
+     * @format GUID
+     */
     instanceId?: string | null;
-    /** Event type. */
+    /**
+     * Event type.
+     * @maxLength 150
+     */
     eventType?: string;
     /** The identification type and identity data. */
     identity?: IdentificationData;
@@ -3538,26 +4006,50 @@ export interface MessageEnvelope {
     data?: string;
 }
 export interface IdentificationData extends IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
     anonymousVisitorId?: string;
-    /** ID of a site visitor that has logged in to the site. */
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
     memberId?: string;
-    /** ID of a Wix user (site owner, contributor, etc.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
     /** @readonly */
     identityType?: WebhookIdentityType;
 }
 /** @oneof */
 export interface IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
     anonymousVisitorId?: string;
-    /** ID of a site visitor that has logged in to the site. */
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
     memberId?: string;
-    /** ID of a Wix user (site owner, contributor, etc.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
 }
 export declare enum WebhookIdentityType {