@wix/events 1.0.11 → 1.0.13

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

@@ -0,0 +1,657 @@
+/**
+ * The form defines which elements are rendered in the Wix UI during the registration process (RSVP or checkout).
+ * It also contains customizable messages and labels.
+ *
+ *
+ * A form is an ordered list of controls (blocks), which accept guest information into a field input.
+ *
+ * Each control contains one or more nested inputs. For example, `Name` control has two inputs:
+ * - First Name
+ * - Last Name
+ *
+ * By default, name and email controls are always required and are pinned to the top of the form.
+ */
+export interface Form {
+    /** Nested fields as an ordered list. */
+    controls?: InputControl[];
+    /** Set of configured form messages. */
+    messages?: FormMessages;
+}
+/**
+ * A block of nested fields.
+ * Used to aggregate similar inputs like First Name and Last Name.
+ */
+export interface InputControl {
+    /** Field control type. */
+    type?: InputControlType;
+    /** Whether control is mandatory (such as name & email). When true, only label can be changed. */
+    system?: boolean;
+    /** Deprecated: Use `id`. */
+    name?: string;
+    /** Child inputs. */
+    inputs?: Input[];
+    /** Deprecated: use `inputs.label`. */
+    label?: string;
+    /** Field controls are sorted by this value in ascending order. */
+    orderIndex?: number;
+    /** Unique control ID. */
+    id?: string;
+}
+export declare enum InputControlType {
+    /** Single text value field. */
+    INPUT = "INPUT",
+    /** Single text value field. */
+    TEXTAREA = "TEXTAREA",
+    /** Single-choice field of predefined values. */
+    DROPDOWN = "DROPDOWN",
+    /** Single-choice field of predefined values. */
+    RADIO = "RADIO",
+    /** Multiple-choice field of predefined values. */
+    CHECKBOX = "CHECKBOX",
+    /** First and last name fields. */
+    NAME = "NAME",
+    /** Additional guests and respective guest names fields. */
+    GUEST_CONTROL = "GUEST_CONTROL",
+    /** Single-line address field. */
+    ADDRESS_SHORT = "ADDRESS_SHORT",
+    /** Full address field. */
+    ADDRESS_FULL = "ADDRESS_FULL",
+    /** Year, month and day fields. */
+    DATE = "DATE"
+}
+/** An input of one or multiple text values */
+export interface Input {
+    /** Field name. */
+    name?: string;
+    /** Deprecated: use `ValueType.TEXT_ARRAY`. */
+    array?: boolean;
+    /** Main field label */
+    label?: string;
+    /** Additional labels for multi-valued fields such as address. */
+    additionalLabels?: Record<string, string>;
+    /** Predefined choice options for fields, such as dropdown. */
+    options?: string[];
+    /** Whether field is mandatory. */
+    mandatory?: boolean;
+    /** Maximum number of accepted characters (relevant for text fields). */
+    maxLength?: number;
+    /**
+     * Type which determines field format.
+     * Used to validate submitted response.
+     */
+    type?: ValueType;
+    /**
+     * A maximum accepted values for array input.
+     * Only applicable for inputs of valueType: TEXT_ARRAY.
+     */
+    maxSize?: number | null;
+    /**
+     * Preselected option.
+     * Currently only applicable for dropdown.
+     */
+    defaultOptionSelection?: OptionSelection;
+    /**
+     * Additional labels for multi-valued fields such as address.
+     * @readonly
+     */
+    labels?: Label[];
+}
+export declare enum ValueType {
+    TEXT = "TEXT",
+    NUMBER = "NUMBER",
+    TEXT_ARRAY = "TEXT_ARRAY",
+    DATE_TIME = "DATE_TIME",
+    ADDRESS = "ADDRESS"
+}
+/**
+ * Describes initially selected option when an input has multiple choices.
+ * Defaults to first (0th) option if not configured.
+ */
+export interface OptionSelection extends OptionSelectionSelectedOptionOneOf {
+    /** 0-based index from predefined `input.options` which is selected initially. */
+    optionIndex?: number;
+    /**
+     * Placeholder hint describing expected choices (such as "Please select").
+     * Considered an empty choice.
+     */
+    placeholderText?: string;
+}
+/** @oneof */
+export interface OptionSelectionSelectedOptionOneOf {
+    /** 0-based index from predefined `input.options` which is selected initially. */
+    optionIndex?: number;
+    /**
+     * Placeholder hint describing expected choices (such as "Please select").
+     * Considered an empty choice.
+     */
+    placeholderText?: string;
+}
+export interface Label {
+    /** Field name. */
+    name?: string;
+    /** Field label. */
+    label?: string;
+}
+/**
+ * Defines form messages shown in UI before, during, and after registration flow.
+ * It enables configuration of form titles, response labels, "thank you" messages, and call-to-action texts.
+ */
+export interface FormMessages {
+    /** RSVP form messages. */
+    rsvp?: RsvpFormMessages;
+    /** Checkout form messages. */
+    checkout?: CheckoutFormMessages;
+    /** Messages shown when event registration is closed. */
+    registrationClosed?: RegistrationClosedMessages;
+    /** Messages shown when event tickets are unavailable. */
+    ticketsUnavailable?: TicketsUnavailableMessages;
+}
+export interface RsvpFormMessages {
+    /** Label text indicating RSVP `YES` response. */
+    rsvpYesOption?: string;
+    /** Label text indicating RSVP `NO` response. */
+    rsvpNoOption?: string;
+    /** Messages shown for RSVP = `YES`. */
+    positiveMessages?: Positive;
+    /** Messages shown for RSVP = `WAITING` (when event is full and waitlist is available). */
+    waitlistMessages?: Positive;
+    /** Messages shown for RSVP = `NO`. */
+    negativeMessages?: Negative;
+    /** "Submit form" call-to-action label text. */
+    submitActionLabel?: string;
+}
+/** Confirmation messages shown after registration. */
+export interface PositiveResponseConfirmation {
+    /** Confirmation message title. */
+    title?: string;
+    /** Confirmation message text. */
+    message?: string;
+    /** "Add to calendar" call-to-action label text. */
+    addToCalendarActionLabel?: string;
+    /** "Share event" call-to-action label text. */
+    shareActionLabel?: string;
+}
+/** Confirmation messages shown after registration. */
+export interface ResponseConfirmation {
+    /** Confirmation message title. */
+    title?: string;
+    /** "Share event" call-to-action label text. */
+    shareActionLabel?: string;
+}
+/** Set of messages shown during registration when RSVP response is positive. */
+export interface Positive {
+    /** Main form title for positive response. */
+    title?: string;
+    /** Confirmation messages shown after registration. */
+    confirmation?: PositiveResponseConfirmation;
+}
+/** A set of messages shown during registration with negative response */
+export interface Negative {
+    /** Main form title for negative response. */
+    title?: string;
+    /** Confirmation messages shown after registration. */
+    confirmation?: ResponseConfirmation;
+}
+export interface CheckoutFormMessages {
+    /** Main form title for response. */
+    title?: string;
+    /** Submit form call-to-action label text. */
+    submitActionLabel?: string;
+}
+export interface RegistrationClosedMessages {
+    /** Message shown when event registration is closed. */
+    message?: string;
+    /** "Explore other events" call-to-action label text. */
+    exploreEventsActionLabel?: string;
+}
+export interface TicketsUnavailableMessages {
+    /** Message shown when event tickets are unavailable. */
+    message?: string;
+    /** "Explore other events" call-to-action label text. */
+    exploreEventsActionLabel?: string;
+}
+export interface FormInputControlAdded {
+    /** Event ID. */
+    eventId?: string;
+    /** Input control. */
+    inputControl?: InputControl;
+}
+export interface FormInputControlUpdated {
+    /** Event ID. */
+    eventId?: string;
+    /** Input control. */
+    updatedInputControl?: InputControl;
+}
+export interface FormInputControlDeleted {
+    /** Event ID. */
+    eventId?: string;
+    /** Input control. */
+    deletedInputControl?: InputControl;
+}
+export interface GetFormRequest {
+    /** Event ID. */
+    eventId: string;
+}
+export interface GetFormResponse {
+    /**
+     * Currently published event form.
+     * Published form is visible to site visitors.
+     */
+    form?: Form;
+    /**
+     * Draft event form.
+     * Not available to visitors unless published.
+     */
+    draftForm?: Form;
+}
+export interface AddControlRequest extends AddControlRequestControlOneOf {
+    /** Event ID. */
+    eventId: string;
+    /** Phone number input control. */
+    phone?: PhoneControl;
+    /** Single-line or full address input control. */
+    address?: AddressControl;
+    /** Day, month, year date input control. */
+    date?: DateControl;
+    /** Additional guests input control. */
+    additionalGuests?: AdditionalGuestsControl;
+    /** Single-choice dropdown style input control. */
+    dropdown?: DropdownControl;
+    /** Multiple-choice checkbox style input control. */
+    checkbox?: CheckboxControl;
+    /** Free-form text input control. */
+    text?: TextControl;
+    /** Single-choice radio button style input control. */
+    radioButton?: RadioButtonControl;
+}
+/** @oneof */
+export interface AddControlRequestControlOneOf {
+    /** Phone number input control. */
+    phone?: PhoneControl;
+    /** Single-line or full address input control. */
+    address?: AddressControl;
+    /** Day, month, year date input control. */
+    date?: DateControl;
+    /** Additional guests input control. */
+    additionalGuests?: AdditionalGuestsControl;
+    /** Single-choice dropdown style input control. */
+    dropdown?: DropdownControl;
+    /** Multiple-choice checkbox style input control. */
+    checkbox?: CheckboxControl;
+    /** Free-form text input control. */
+    text?: TextControl;
+    /** Single-choice radio button style input control. */
+    radioButton?: RadioButtonControl;
+}
+export interface PhoneControl {
+    /** Phone input label. */
+    label?: string;
+    /** Whether phone input is required. */
+    mandatory?: boolean;
+}
+export interface AddressControl {
+    /** Address control labels for each input. */
+    labels?: AddressControlLabels;
+    /** Whether address is multi-line (consisting of multiple fields such as country, city, postal code). When false, address is single-line. */
+    full?: boolean;
+    /** Whether address input is required. */
+    mandatory?: boolean;
+}
+export interface AddressControlLabels {
+    /** Single-line address input label. */
+    addressLine?: string;
+    /** Country input label. */
+    country?: string;
+    /** Subdivision input label. */
+    subdivision?: string;
+    /** City input label. */
+    city?: string;
+    /** Postal code input label. */
+    postalCode?: string;
+    /** Street address input label. */
+    streetAddress?: string;
+}
+export interface DateControl {
+    /** Input control label. */
+    label?: string;
+    /** Whether date input is required */
+    mandatory?: boolean;
+}
+export interface AdditionalGuestsControl {
+    /** Additional guests control labels for each input. */
+    labels?: Labels;
+    /** Whether individual guest names are required. */
+    namesMandatory?: boolean;
+    /** Maximum number of additional guests. */
+    maxGuests?: number;
+}
+export interface Labels {
+    /** Input label for a single guest. */
+    single?: string;
+    /** Input label for multiple guests. */
+    multiple?: string;
+}
+export interface DropdownControl {
+    /** Input control label. */
+    label?: string;
+    /** Predefined options guests can choose from. */
+    options?: string[];
+    /** Whether choice is required. */
+    mandatory?: boolean;
+    /** Preselected option. */
+    defaultOptionSelection?: OptionSelection;
+}
+export interface RadioButtonControl {
+    /** Input control label. */
+    label?: string;
+    /** Predefined options guests can choose from. */
+    options?: string[];
+}
+export interface CheckboxControl {
+    /** Input control label. */
+    label?: string;
+    /** Whether at least one checkbox is required. */
+    mandatory?: boolean;
+    /** Predefined options guests can choose from. */
+    options?: string[];
+}
+export interface TextControl {
+    /** Input control label. */
+    label?: string;
+    /** Whether text input is required. */
+    mandatory?: boolean;
+    /** Maximum number of characters allowed. */
+    maxLength?: number;
+    /** Whether input control should allow multiple lines in text. */
+    multiLine?: boolean;
+    /** Whether input control should be displayed as a comment. */
+    comment?: boolean;
+}
+export interface AddControlResponse {
+    /** Generated unique input control ID. */
+    id?: string;
+    /** Modified draft event form. */
+    form?: Form;
+}
+export interface UpdateControlRequest extends UpdateControlRequestControlOneOf {
+    /** Event ID. */
+    eventId: string;
+    /** Unique input control ID. */
+    id: string;
+    /** Index used to sort input controls in ascending order. */
+    orderIndex?: number;
+    /** Phone number input control. */
+    phone?: PhoneControl;
+    /** Single-line or full address input control. */
+    address?: AddressControl;
+    /** Day, month, year date input control. */
+    date?: DateControl;
+    /** Additional guests input control. */
+    additionalGuests?: AdditionalGuestsControl;
+    /** Single-choice dropdown style input control. */
+    dropdown?: DropdownControl;
+    /** Multiple-choice checkbox style input control. */
+    checkbox?: CheckboxControl;
+    /** Free-form text input control. */
+    text?: TextControl;
+    /** Main guest name input control. */
+    name?: NameControl;
+    /** Main guest email input control. */
+    email?: EmailControl;
+    /** Single-choice radio style input control. */
+    radioButton?: RadioButtonControl;
+}
+/** @oneof */
+export interface UpdateControlRequestControlOneOf {
+    /** Phone number input control. */
+    phone?: PhoneControl;
+    /** Single-line or full address input control. */
+    address?: AddressControl;
+    /** Day, month, year date input control. */
+    date?: DateControl;
+    /** Additional guests input control. */
+    additionalGuests?: AdditionalGuestsControl;
+    /** Single-choice dropdown style input control. */
+    dropdown?: DropdownControl;
+    /** Multiple-choice checkbox style input control. */
+    checkbox?: CheckboxControl;
+    /** Free-form text input control. */
+    text?: TextControl;
+    /** Main guest name input control. */
+    name?: NameControl;
+    /** Main guest email input control. */
+    email?: EmailControl;
+    /** Single-choice radio style input control. */
+    radioButton?: RadioButtonControl;
+}
+export interface NameControl {
+    /** Name control labels of each input */
+    labels?: NameControlLabels;
+}
+export interface NameControlLabels {
+    /** First name input label */
+    firstName?: string;
+    /** Last name input label */
+    lastName?: string;
+}
+export interface EmailControl {
+    /** Email input label. */
+    label?: string;
+}
+export interface UpdateControlResponse {
+    /** Modified draft event form. */
+    form?: Form;
+}
+export interface DeleteControlRequest {
+    /** Event ID. */
+    eventId: string;
+    /** Unique input control ID. */
+    id: string;
+}
+export interface DeleteControlResponse {
+    /** Modified draft event form */
+    form?: Form;
+}
+export interface UpdateMessagesRequest {
+    /** Event ID. */
+    eventId: string;
+    /**
+     * Set of field paths, specifying which parts of this resource to update.
+     * When fields are empty, request is interpreted as full update.
+     * Behavior follows [google.protobuf.FieldMask](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask) semantics.
+     */
+    fields: string[];
+    /** Set of configured form messages. */
+    messages?: FormMessages;
+}
+export interface UpdateMessagesResponse {
+    /** Modified draft event form. */
+    form?: Form;
+}
+export interface PublishDraftRequest {
+    /** Event ID. */
+    eventId: string;
+}
+export interface PublishDraftResponse {
+    /** Published event form. */
+    form?: Form;
+}
+export interface EventUpdated {
+    /** Event update timestamp in ISO UTC format. */
+    timestamp?: Date;
+    /** Event ID. */
+    eventId?: string;
+    /** Event location. */
+    location?: Location;
+    /** Event schedule configuration. */
+    scheduleConfig?: ScheduleConfig;
+    /** Event title. */
+    title?: string;
+    /** Whether schedule configuration was updated. */
+    scheduleConfigUpdated?: boolean;
+}
+export interface Location {
+    /** Location name. */
+    name?: string | null;
+    /** Location map coordinates. */
+    coordinates?: MapCoordinates;
+    /** Single line address representation. */
+    address?: string | null;
+    /** Location type. */
+    type?: LocationType;
+    /**
+     * Full address derived from formatted single line `address`.
+     * When `full_address` is used to create or update the event, deprecated `address` and `coordinates` are ignored.
+     * If provided `full_address` has empty `formatted_address` or `coordinates`, it will be auto-completed using Atlas service.
+     *
+     * Migration notes:
+     * - `full_address.formatted_address` is equivalent to `address`.
+     * - `full_address.geocode` is equivalent to `coordinates`.
+     */
+    fullAddress?: Address;
+    /**
+     * Defines event location as TBD (To Be Determined).
+     * When event location is not yet defined, `name` is displayed instead of location address.
+     * `coordinates`, `address`, `type` and `full_address` are not required when location is TBD.
+     */
+    tbd?: boolean | null;
+}
+export interface MapCoordinates {
+    /** Latitude. */
+    lat?: number;
+    /** Longitude. */
+    lng?: number;
+}
+export declare enum LocationType {
+    VENUE = "VENUE",
+    ONLINE = "ONLINE"
+}
+/** Physical address */
+export interface Address extends AddressStreetOneOf {
+    /** country code */
+    country?: string | null;
+    /** subdivision (usually state or region) code according to ISO 3166-2 */
+    subdivision?: string | null;
+    /** city name */
+    city?: string | null;
+    /** zip/postal code */
+    postalCode?: string | null;
+    /** Free text providing more detailed address info. Usually contains Apt, Suite, Floor */
+    addressLine2?: string | null;
+    /** A string containing the human-readable address of this location */
+    formattedAddress?: string | null;
+    /** Free text for human-to-human textual orientation aid purposes */
+    hint?: string | null;
+    /** coordinates of the physical address */
+    geocode?: AddressLocation;
+    /** country full-name */
+    countryFullname?: string | null;
+    /** multi-level subdivisions from top to bottom */
+    subdivisions?: Subdivision[];
+    /** a break down of the street to number and street name */
+    streetAddress?: StreetAddress;
+    /** Main address line (usually street and number) as free text */
+    addressLine?: string | null;
+}
+/** @oneof */
+export interface AddressStreetOneOf {
+    /** a break down of the street to number and street name */
+    streetAddress?: StreetAddress;
+    /** Main address line (usually street and number) as free text */
+    addressLine?: string | null;
+}
+export interface StreetAddress {
+    /** street number */
+    number?: string;
+    /** street name */
+    name?: string;
+}
+export interface AddressLocation {
+    latitude?: number | null;
+    longitude?: number | null;
+}
+export interface Subdivision {
+    /** subdivision short code */
+    code?: string;
+    /** subdivision full-name */
+    name?: string;
+}
+export declare enum SubdivisionType {
+    UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
+    /** State */
+    ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
+    /** County */
+    ADMINISTRATIVE_AREA_LEVEL_2 = "ADMINISTRATIVE_AREA_LEVEL_2",
+    /** City/town */
+    ADMINISTRATIVE_AREA_LEVEL_3 = "ADMINISTRATIVE_AREA_LEVEL_3",
+    /** Neighborhood/quarter */
+    ADMINISTRATIVE_AREA_LEVEL_4 = "ADMINISTRATIVE_AREA_LEVEL_4",
+    /** Street/block */
+    ADMINISTRATIVE_AREA_LEVEL_5 = "ADMINISTRATIVE_AREA_LEVEL_5",
+    /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
+    COUNTRY = "COUNTRY"
+}
+export interface ScheduleConfig {
+    /**
+     * Defines event as TBD (To Be Determined) schedule.
+     * When event time is not yet defined, TBD message is displayed instead of event start and end times.
+     * `startDate`, `endDate` and `timeZoneId` are not required when schedule is TBD.
+     */
+    scheduleTbd?: boolean;
+    /** TBD message. */
+    scheduleTbdMessage?: string | null;
+    /** Event start timestamp. */
+    startDate?: Date;
+    /** Event end timestamp. */
+    endDate?: Date;
+    /** Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`. */
+    timeZoneId?: string | null;
+    /** Whether end date is hidden in the formatted schedule. */
+    endDateHidden?: boolean;
+    /** Whether time zone is displayed in formatted schedule. */
+    showTimeZone?: boolean;
+    /** Event recurrences. */
+    recurrences?: Recurrences;
+}
+export interface Recurrences {
+    /** Event occurrences. */
+    occurrences?: Occurrence[];
+    /**
+     * Recurring event category ID.
+     * @readonly
+     */
+    categoryId?: string | null;
+    /**
+     * Recurrence status.
+     * @readonly
+     */
+    status?: Status;
+}
+export interface Occurrence {
+    /** Event start timestamp. */
+    startDate?: Date;
+    /** Event end timestamp. */
+    endDate?: Date;
+    /** Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`. */
+    timeZoneId?: string | null;
+    /** Whether time zone is displayed in formatted schedule. */
+    showTimeZone?: boolean;
+}
+export declare enum Status {
+    /** Event occurs only once. */
+    ONE_TIME = "ONE_TIME",
+    /** Event is recurring. */
+    RECURRING = "RECURRING",
+    /** Marks the next upcoming occurrence of the recurring event. */
+    RECURRING_NEXT = "RECURRING_NEXT",
+    /** Marks the most recent ended occurrence of the recurring event. */
+    RECURRING_LAST_ENDED = "RECURRING_LAST_ENDED",
+    /** Marks the most recent canceled occurrence of the recurring event. */
+    RECURRING_LAST_CANCELED = "RECURRING_LAST_CANCELED"
+}
+export interface DiscardDraftRequest {
+    /** Event ID. */
+    eventId: string;
+}
+export interface DiscardDraftResponse {
+}