@wix/auto_sdk_events_forms 1.0.4 → 1.0.6

package/build/es/src/events-v1-form-forms.types.d.ts

@@ -122,21 +122,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;
 }
@@ -258,7 +266,10 @@ export interface FormInputControlDeleted {
     deletedInputControl?: InputControl;
 }
 export interface GetFormRequest {
-    /** Event ID. */
+    /**
+     * Event ID.
+     * @format GUID
+     */
     eventId: string;
 }
 export declare enum RequestedFields {
@@ -295,7 +306,10 @@ export interface AddControlRequest extends AddControlRequestControlOneOf {
     text?: TextControl;
     /** Single-choice radio button style input control. */
     radioButton?: RadioButtonControl;
-    /** Event ID. */
+    /**
+     * Event ID.
+     * @format GUID
+     */
     eventId: string;
 }
 /** @oneof */
@@ -318,7 +332,10 @@ export interface AddControlRequestControlOneOf {
     radioButton?: RadioButtonControl;
 }
 export interface PhoneControl {
-    /** Phone input label. */
+    /**
+     * Phone input label.
+     * @maxLength 100
+     */
     label?: string;
     /** Whether phone input is required. */
     mandatory?: boolean;
@@ -332,21 +349,42 @@ export interface AddressControl {
     mandatory?: boolean;
 }
 export interface AddressControlLabels {
-    /** Single-line address input label. */
+    /**
+     * Single-line address input label.
+     * @maxLength 100
+     */
     addressLine?: string;
-    /** Country input label. */
+    /**
+     * Country input label.
+     * @maxLength 100
+     */
     country?: string;
-    /** Subdivision input label. */
+    /**
+     * Subdivision input label.
+     * @maxLength 100
+     */
     subdivision?: string;
-    /** City input label. */
+    /**
+     * City input label.
+     * @maxLength 100
+     */
     city?: string;
-    /** Postal code input label. */
+    /**
+     * Postal code input label.
+     * @maxLength 100
+     */
     postalCode?: string;
-    /** Street address input label. */
+    /**
+     * Street address input label.
+     * @maxLength 100
+     */
     streetAddress?: string;
 }
 export interface DateControl {
-    /** Input control label. */
+    /**
+     * Input control label.
+     * @maxLength 100
+     */
     label?: string;
     /** Whether date input is required */
     mandatory?: boolean;
@@ -356,19 +394,37 @@ export interface AdditionalGuestsControl {
     labels?: Labels;
     /** Whether individual guest names are required. */
     namesMandatory?: boolean;
-    /** Maximum number of additional guests. */
+    /**
+     * Maximum number of additional guests.
+     * @min 1
+     * @max 10
+     */
     maxGuests?: number;
 }
 export interface Labels {
-    /** Input label for a single guest. */
+    /**
+     * Input label for a single guest.
+     * @maxLength 200
+     */
     single?: string;
-    /** Input label for multiple guests. */
+    /**
+     * Input label for multiple guests.
+     * @maxLength 200
+     */
     multiple?: string;
 }
 export interface DropdownControl {
-    /** Input control label. */
+    /**
+     * Input control label.
+     * @maxLength 200
+     */
     label?: string;
-    /** Predefined options guests can choose from. */
+    /**
+     * Predefined options guests can choose from.
+     * @minSize 2
+     * @maxSize 200
+     * @maxLength 200
+     */
     options?: string[];
     /** Whether choice is required. */
     mandatory?: boolean;
@@ -376,25 +432,47 @@ export interface DropdownControl {
     defaultOptionSelection?: OptionSelection;
 }
 export interface RadioButtonControl {
-    /** Input control label. */
+    /**
+     * Input control label.
+     * @maxLength 200
+     */
     label?: string;
-    /** Predefined options guests can choose from. */
+    /**
+     * Predefined options guests can choose from.
+     * @minSize 2
+     * @maxSize 200
+     * @maxLength 200
+     */
     options?: string[];
 }
 export interface CheckboxControl {
-    /** Input control label. */
+    /**
+     * Input control label.
+     * @maxLength 200
+     */
     label?: string;
     /** Whether at least one checkbox is required. */
     mandatory?: boolean;
-    /** Predefined options guests can choose from. */
+    /**
+     * Predefined options guests can choose from.
+     * @minSize 1
+     * @maxSize 200
+     * @maxLength 200
+     */
     options?: string[];
 }
 export interface TextControl {
-    /** Input control label. */
+    /**
+     * Input control label.
+     * @maxLength 200
+     */
     label?: string;
     /** Whether text input is required. */
     mandatory?: boolean;
-    /** Maximum number of characters allowed. */
+    /**
+     * Maximum number of characters allowed.
+     * @max 1000
+     */
     maxLength?: number;
     /** Whether input control should allow multiple lines in text. */
     multiLine?: boolean;
@@ -428,7 +506,10 @@ export interface UpdateControlRequest extends UpdateControlRequestControlOneOf {
     email?: EmailControl;
     /** Single-choice radio style input control. */
     radioButton?: RadioButtonControl;
-    /** Event ID. */
+    /**
+     * Event ID.
+     * @format GUID
+     */
     eventId: string;
     /** Unique input control ID. */
     id: string;
@@ -463,13 +544,22 @@ export interface NameControl {
     labels?: NameControlLabels;
 }
 export interface NameControlLabels {
-    /** First name input label */
+    /**
+     * First name input label
+     * @maxLength 100
+     */
     firstName?: string;
-    /** Last name input label */
+    /**
+     * Last name input label
+     * @maxLength 100
+     */
     lastName?: string;
 }
 export interface EmailControl {
-    /** Email input label. */
+    /**
+     * Email input label.
+     * @maxLength 100
+     */
     label?: string;
 }
 export interface UpdateControlResponse {
@@ -477,9 +567,15 @@ export interface UpdateControlResponse {
     form?: Form;
 }
 export interface DeleteControlRequest {
-    /** Event ID. */
+    /**
+     * Event ID.
+     * @format GUID
+     */
     eventId: string;
-    /** Unique input control ID. */
+    /**
+     * Unique input control ID.
+     * @maxLength 100
+     */
     id: string;
 }
 export interface DeleteControlResponse {
@@ -487,7 +583,10 @@ export interface DeleteControlResponse {
     form?: Form;
 }
 export interface UpdateMessagesRequest {
-    /** Event ID. */
+    /**
+     * Event ID.
+     * @format GUID
+     */
     eventId: string;
     /**
      * Set of field paths, specifying which parts of this resource to update.
@@ -503,7 +602,10 @@ export interface UpdateMessagesResponse {
     form?: Form;
 }
 export interface PublishDraftRequest {
-    /** Event ID. */
+    /**
+     * Event ID.
+     * @format GUID
+     */
     eventId: string;
 }
 export interface PublishDraftResponse {
@@ -513,7 +615,10 @@ export interface PublishDraftResponse {
 export interface EventUpdated {
     /** Event update timestamp in ISO UTC format. */
     timestamp?: Date | null;
-    /** Event ID. */
+    /**
+     * Event ID.
+     * @format GUID
+     */
     eventId?: string;
     /** Event location. */
     location?: Location;
@@ -530,11 +635,17 @@ export interface EventUpdated {
     event?: Event;
 }
 export interface Location {
-    /** 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?: LocationType;
@@ -556,9 +667,17 @@ export interface Location {
     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 LocationType {
@@ -571,7 +690,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;
@@ -589,7 +711,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 */
@@ -606,9 +731,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 {
@@ -639,13 +772,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;
@@ -655,7 +794,10 @@ export interface ScheduleConfig {
     recurrences?: Recurrences;
 }
 export interface Recurrences {
-    /** Event occurrences. */
+    /**
+     * Event occurrences.
+     * @maxSize 1000
+     */
     occurrences?: Occurrence[];
     /**
      * Recurring event category ID.
@@ -673,7 +815,10 @@ export interface Occurrence {
     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;
@@ -693,6 +838,7 @@ export declare enum Status {
 export interface Event {
     /**
      * Event ID.
+     * @format GUID
      * @readonly
      */
     id?: string;
@@ -732,7 +878,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?: Feed;
@@ -771,7 +920,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;
@@ -909,17 +1062,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?: TaxType;
-    /** 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;
@@ -935,12 +1102,19 @@ export declare enum TaxType {
 export interface Money {
     /**
      * *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 ExternalEvent {
@@ -1023,7 +1197,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;
@@ -1062,7 +1239,10 @@ export interface OnlineConferencingSession {
     sessionId?: string | null;
 }
 export interface SeoSettings {
-    /** URL slug */
+    /**
+     * URL slug
+     * @maxLength 130
+     */
     slug?: string;
     /** Advanced SEO data */
     advancedSeoData?: SeoSchema;
@@ -1088,7 +1268,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 {
@@ -1121,7 +1304,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 Agenda {
@@ -1136,10 +1322,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.
@@ -1162,6 +1353,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[];
 }
@@ -1787,11 +1979,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 {
@@ -1865,7 +2066,10 @@ export interface ImageData {
 export interface StylesBorder {
     /** Border width in pixels. */
     width?: number | null;
-    /** Border color. */
+    /**
+     * Border color as a hexadecimal value.
+     * @format COLOR_HEX
+     */
     color?: string | null;
     /** Border radius in pixels. */
     radius?: number | null;
@@ -2019,13 +2223,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;
@@ -2036,7 +2249,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;
@@ -2348,17 +2564,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;
 }
 /**
@@ -2467,7 +2698,10 @@ export interface TextNodeStyle {
     lineHeight?: string | null;
 }
 export interface DiscardDraftRequest {
-    /** Event ID. */
+    /**
+     * Event ID.
+     * @format GUID
+     */
     eventId: string;
 }
 export interface DiscardDraftResponse {
@@ -2545,9 +2779,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;
@@ -2555,26 +2795,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 {