@wix/events 1.0.11 → 1.0.13

package/build/cjs/src/events-v1-event.universal.d.ts

@@ -0,0 +1,1784 @@
+export declare const __debug: {
+    verboseLogging: {
+        on: () => boolean;
+        off: () => boolean;
+    };
+};
+export interface Event {
+    /**
+     * Event ID.
+     * @readonly
+     */
+    _id?: string;
+    /** Event location. */
+    location?: Location;
+    /** Event scheduling. */
+    scheduling?: Scheduling;
+    /** Event title. */
+    title?: string;
+    /** Event description. */
+    description?: string;
+    /** Rich-text content displayed in Wix UI - "About Event" section (HTML). */
+    about?: string;
+    /** Main event image. */
+    mainImage?: string;
+    /** Event slug URL (generated from event title). */
+    slug?: string;
+    /** ISO 639-1 language code of the event (used in content translations). */
+    language?: string;
+    /** Event creation timestamp. */
+    created?: Date;
+    /** Event modified timestamp. */
+    modified?: Date;
+    /** Event status. */
+    status?: EventStatus;
+    /** RSVP or ticketing registration details. */
+    registration?: Registration;
+    /** "Add to calendar" URLs. */
+    calendarLinks?: CalendarLinks;
+    /** Event page URL components. */
+    eventPageUrl?: SiteUrl;
+    /** Event registration form. */
+    form?: Form;
+    /** Event dashboard summary of RSVP / ticket sales. */
+    dashboard?: Dashboard;
+    /** Instance ID of the site where event is hosted. */
+    instanceId?: string;
+    /** Guest list configuration. */
+    guestListConfig?: GuestListConfig;
+    /** Event creator user ID. */
+    userId?: string;
+    /** Event discussion feed. For internal use. */
+    feed?: Feed;
+    /** Online conferencing details. */
+    onlineConferencing?: OnlineConferencing;
+    /** SEO settings. */
+    seoSettings?: SeoSettings;
+    /** Assigned contacts label key. */
+    assignedContactsLabel?: string | null;
+    /** Agenda details. */
+    agenda?: Agenda;
+    /** Categories this event is assigned to. */
+    categories?: Category[];
+}
+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 break down of the street to number and street name */
+    streetAddress?: StreetAddress;
+    /** Main address line (usually street and number) as free text */
+    addressLine1?: 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 Scheduling {
+    /** Schedule configuration. */
+    config?: ScheduleConfig;
+    /** Formatted schedule representation. */
+    formatted?: string;
+    /** Formatted start date of the event (empty for TBD schedules). */
+    startDateFormatted?: string;
+    /** Formatted start time of the event (empty for TBD schedules). */
+    startTimeFormatted?: string;
+}
+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 declare enum EventStatus {
+    /** Event is public and scheduled to start */
+    SCHEDULED = "SCHEDULED",
+    /** Event has started */
+    STARTED = "STARTED",
+    /** Event has ended */
+    ENDED = "ENDED",
+    /** Event was canceled */
+    CANCELED = "CANCELED",
+    /** Event is not public and needs to be published */
+    DRAFT = "DRAFT"
+}
+export interface Registration {
+    /** Event type. */
+    type?: EventType;
+    /** Event registration status. */
+    status?: RegistrationStatus;
+    /** RSVP collection details. */
+    rsvpCollection?: RsvpCollection;
+    /** Ticketing details. */
+    ticketing?: Ticketing;
+    /** External registration details. */
+    external?: ExternalEvent;
+    /** Types of users allowed to register. */
+    restrictedTo?: VisitorType;
+    /** Initial event type which was set when creating an event. */
+    initialType?: EventType;
+}
+export declare enum EventType {
+    /** Type not available for this request fieldset */
+    NA_EVENT_TYPE = "NA_EVENT_TYPE",
+    /** Registration via RSVP */
+    RSVP = "RSVP",
+    /** Registration via ticket purchase */
+    TICKETS = "TICKETS",
+    /** External registration */
+    EXTERNAL = "EXTERNAL",
+    /** Registration not available */
+    NO_REGISTRATION = "NO_REGISTRATION"
+}
+export declare enum RegistrationStatus {
+    /** Registration status is not applicable */
+    NA_REGISTRATION_STATUS = "NA_REGISTRATION_STATUS",
+    /** Registration to event is closed */
+    CLOSED = "CLOSED",
+    /** Registration to event is closed manually */
+    CLOSED_MANUALLY = "CLOSED_MANUALLY",
+    /** Registration is open via RSVP */
+    OPEN_RSVP = "OPEN_RSVP",
+    /** Registration to event waitlist is open via RSVP */
+    OPEN_RSVP_WAITLIST = "OPEN_RSVP_WAITLIST",
+    /** Registration is open via ticket purchase */
+    OPEN_TICKETS = "OPEN_TICKETS",
+    /** Registration is open via external URL */
+    OPEN_EXTERNAL = "OPEN_EXTERNAL",
+    /** Registration will be open via RSVP */
+    SCHEDULED_RSVP = "SCHEDULED_RSVP"
+}
+export interface RsvpCollection {
+    /** RSVP collection configuration. */
+    config?: RsvpCollectionConfig;
+}
+export interface RsvpCollectionConfig {
+    /** Defines the supported RSVP statuses. */
+    rsvpStatusOptions?: RsvpStatusOptions;
+    /**
+     * Total guest limit available to register to the event.
+     * Additional guests per RSVP are counted towards total guests.
+     */
+    limit?: number | null;
+    /** Whether a waitlist is opened when total guest limit is reached, allowing guests to create RSVP with WAITING RSVP status. */
+    waitlist?: boolean;
+    /** Registration start timestamp. */
+    startDate?: Date;
+    /** Registration end timestamp. */
+    endDate?: Date;
+}
+export declare enum RsvpStatusOptions {
+    /** Only YES RSVP status is available for RSVP registration */
+    YES_ONLY = "YES_ONLY",
+    /** YES and NO RSVP status options are available for the registration */
+    YES_AND_NO = "YES_AND_NO"
+}
+export interface Ticketing {
+    /** Deprecated. */
+    lowestPrice?: string | null;
+    /** Deprecated. */
+    highestPrice?: string | null;
+    /** Currency used in event transactions. */
+    currency?: string | null;
+    /** Ticketing configuration. */
+    config?: TicketingConfig;
+    /**
+     * Price of lowest priced ticket.
+     * @readonly
+     */
+    lowestTicketPrice?: Money;
+    /**
+     * Price of highest priced ticket.
+     * @readonly
+     */
+    highestTicketPrice?: Money;
+    /**
+     * Formatted price of lowest priced ticket.
+     * @readonly
+     */
+    lowestTicketPriceFormatted?: string | null;
+    /**
+     * Formatted price of highest priced ticket.
+     * @readonly
+     */
+    highestTicketPriceFormatted?: string | null;
+    /**
+     * Whether all tickets are sold for this event.
+     * @readonly
+     */
+    soldOut?: boolean | null;
+}
+export interface TicketingConfig {
+    /** Whether the form must be filled out separately for each ticket. */
+    guestAssignedTickets?: boolean;
+    /** Tax configuration. */
+    taxConfig?: TaxConfig;
+    /** Limit of tickets that can be purchased per order, default 20. */
+    ticketLimitPerOrder?: number;
+}
+export interface TaxConfig {
+    /** Tax application settings. */
+    type?: TaxType;
+    /** Tax name. */
+    name?: string | null;
+    /** Tax rate (e.g.,`21.55`). */
+    rate?: string | null;
+    /** Applies taxes for donations, default true. */
+    appliesToDonations?: boolean | null;
+}
+export declare enum TaxType {
+    /** Tax is included in the ticket price */
+    INCLUDED = "INCLUDED",
+    /** Tax is added to the order at the checkout */
+    ADDED = "ADDED",
+    /** Tax is added to the final total at the checkout */
+    ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
+}
+export interface Money {
+    /** Decimal amount representation. Deprecated, use `value` instead. */
+    amount?: string;
+    /** ISO 4217 format of the currency i.e. `USD`. */
+    currency?: string;
+    /** Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, a single (-), to indicate that the amount is negative. */
+    value?: string | null;
+}
+export interface ExternalEvent {
+    /** External event registration URL. */
+    registration?: string;
+}
+export declare enum VisitorType {
+    /** Site visitor (including member) */
+    VISITOR = "VISITOR",
+    /** Site member */
+    MEMBER = "MEMBER",
+    /** Site visitor or member */
+    VISITOR_OR_MEMBER = "VISITOR_OR_MEMBER"
+}
+export interface CalendarLinks {
+    /** "Add to Google calendar" URL. */
+    google?: string;
+    /** "Download ICS calendar file" URL. */
+    ics?: string;
+}
+/** Site URL components */
+export interface SiteUrl {
+    /**
+     * Base URL. For premium sites, this will be the domain.
+     * For free sites, this would be site URL (e.g `mysite.wixsite.com/mysite`)
+     */
+    base?: string;
+    /** The path to that page - e.g `/my-events/weekly-meetup-2` */
+    path?: string;
+}
+/**
+ * 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 Dashboard {
+    /** Guest RSVP summary. */
+    rsvpSummary?: RsvpSummary;
+    /**
+     * Summary of revenue and tickets sold.
+     * (Archived orders are not included).
+     */
+    ticketingSummary?: TicketingSummary;
+}
+export interface RsvpSummary {
+    /** Total number of RSVPs. */
+    total?: number;
+    /** Number of RSVPs with status `YES`. */
+    yes?: number;
+    /** Number of RSVPs with status `NO`. */
+    no?: number;
+    /** Number of RSVPs in waitlist. */
+    waitlist?: number;
+}
+export interface TicketingSummary {
+    /** Number of tickets sold. */
+    tickets?: number;
+    /**
+     * Total revenue, excluding fees.
+     * (taxes and payment provider fees are not deducted.)
+     */
+    revenue?: Money;
+    /** Whether currency is locked and cannot be changed (generally occurs after the first order in the specified currency has been created). */
+    currencyLocked?: boolean;
+    /** Number of orders placed. */
+    orders?: number;
+    /** Total balance of confirmed transactions. */
+    totalSales?: Money;
+}
+export interface GuestListConfig {
+    /** Whether members can see other members attending the event (defaults to true). */
+    publicGuestList?: boolean;
+}
+export interface Feed {
+    /** Event discussion feed token. */
+    token?: string;
+}
+export interface OnlineConferencing {
+    config?: OnlineConferencingConfig;
+    session?: OnlineConferencingSession;
+}
+export interface OnlineConferencingConfig {
+    /**
+     * Whether online conferencing is enabled (not supported for TBD schedules).
+     * When enabled, links to join conferencing are generated and provided to guests.
+     */
+    enabled?: boolean;
+    /** Conferencing provider ID. */
+    providerId?: string | null;
+    /** Conference type */
+    conferenceType?: ConferenceType;
+}
+export declare enum ConferenceType {
+    /** Everyone in the meeting can publish and subscribe video and audio. */
+    MEETING = "MEETING",
+    /** Guests can only subscribe to video and audio. */
+    WEBINAR = "WEBINAR"
+}
+export interface OnlineConferencingSession {
+    /**
+     * Link for event host to start the online conference session.
+     * @readonly
+     */
+    hostLink?: string;
+    /**
+     * Link for guests to join the online conference session.
+     * @readonly
+     */
+    guestLink?: string;
+    /**
+     * The password required to join online conferencing session (when relevant).
+     * @readonly
+     */
+    password?: string | null;
+    /**
+     * Indicates that session was created successfully on providers side.
+     * @readonly
+     */
+    sessionCreated?: boolean | null;
+    /**
+     * Unique session id
+     * @readonly
+     */
+    sessionId?: string | null;
+}
+export interface SeoSettings {
+    /** URL slug */
+    slug?: string;
+    /** Advanced SEO data */
+    advancedSeoData?: SeoSchema;
+    /**
+     * Hidden from SEO Site Map
+     * @readonly
+     */
+    hidden?: boolean | null;
+}
+/**
+ * The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.
+ * The search engines use this information for ranking purposes, or to display snippets in the search results.
+ * This data will override other sources of tags (for example patterns) and will be included in the <head> section of the HTML document, while not being displayed on the page itself.
+ */
+export interface SeoSchema {
+    /** SEO tags information. */
+    tags?: Tag[];
+    /** SEO general settings. */
+    settings?: Settings;
+}
+export interface Tag {
+    /**
+     * SEO tag type.
+     *
+     *
+     * Supported values: `title`, `meta`, `script`, `link`.
+     */
+    type?: string;
+    /**
+     * A `{'key':'value'} pair object where each SEO tag property (`'name'`, `'content'`, `'rel'`, `'href'`) contains a value.
+     * For example: `{'name': 'description', 'content': 'the description itself'}`.
+     */
+    props?: Record<string, any> | null;
+    /** SEO tag meta data. For example, `{height: 300, width: 240}`. */
+    meta?: Record<string, any> | null;
+    /** SEO tag inner content. For example, `<title> inner content </title>`. */
+    children?: string;
+    /** Whether the tag is a custom tag. */
+    custom?: boolean;
+    /** Whether the tag is disabled. */
+    disabled?: boolean;
+}
+export interface Settings {
+    /**
+     * Whether the auto redirects feature creating `301 redirects` on a slug change is enabled.
+     *
+     *
+     * Default: enabled
+     */
+    preventAutoRedirect?: boolean;
+}
+export interface Agenda {
+    enabled?: boolean;
+    /**
+     * Agenda page URL.
+     * @readonly
+     */
+    pageUrl?: SiteUrl;
+}
+export interface Category {
+    /**
+     * Category ID.
+     * @readonly
+     */
+    _id?: string;
+    /** Category name. */
+    name?: string;
+    /**
+     * Category creation timestamp.
+     * @readonly
+     */
+    _createdDate?: Date;
+    /**
+     * Assigned events count. Deleted events are excluded.
+     * @readonly
+     */
+    assignedEventsCount?: number | null;
+    /** @readonly */
+    counts?: CategoryCounts;
+    /**
+     * Category state. Default - MANUAL.
+     * WIX_EVENTS.MANAGE_AUTO_CATEGORIES permission is required to use other states.
+     * Field will be ignored on update requests.
+     */
+    states?: State[];
+}
+export interface CategoryCounts {
+    /** Assigned events count. Deleted events are excluded. */
+    assignedEventsCount?: number | null;
+    /** Assigned draft events count. */
+    assignedDraftEventsCount?: number | null;
+}
+export declare enum State {
+    /** Created manually by the user. */
+    MANUAL = "MANUAL",
+    /** Created automatically. */
+    AUTO = "AUTO",
+    /** Created when publishing recurring events. */
+    RECURRING_EVENT = "RECURRING_EVENT",
+    /** Category is hidden. */
+    HIDDEN = "HIDDEN",
+    /** Category is used to store component events. */
+    COMPONENT = "COMPONENT"
+}
+export interface EventStarted {
+    /** Event start timestamp in ISO UTC format. */
+    timestamp?: Date;
+    /** Event ID. */
+    eventId?: string;
+}
+export interface EventReminder {
+    /** Reminder timestamp in ISO UTC format. */
+    timestamp?: Date;
+    /** Event ID. */
+    eventId?: string;
+    /** Event location. */
+    location?: Location;
+    /** Event schedule configuration. */
+    scheduleConfig?: ScheduleConfig;
+    /** Event title. */
+    title?: string;
+    /** Event creator user ID. */
+    userId?: string | null;
+    /** Time until the event starts (currently, reminder is triggered 1 day before event starts). */
+    startsIn?: TimeDuration;
+}
+/**
+ * A coarse-grained representation of time duration divided into whole constituting components of days, hours, and minutes.
+ * For example, 25.5 hours duration is represented as `{ days: 1, hours: 1, minutes: 30 }`.
+ */
+export interface TimeDuration {
+    /** Number of days */
+    days?: number;
+    /** Number of hours */
+    hours?: number;
+    /** Number of minutes */
+    minutes?: number;
+}
+export interface EventEnded {
+    /** Event end timestamp in ISO UTC format. */
+    timestamp?: Date;
+    /** Event ID. */
+    eventId?: string;
+}
+export interface QueryEventsRequest {
+    /** Number of items to skip. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */
+    offset?: number;
+    /** Number of items to load per page. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */
+    limit?: number;
+    /**
+     * Controls which event properties are returned. See [Fieldset](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_event-fieldset).
+     * Some fields require additional computation that affects latency.
+     * Use minimum set of required fieldset for best performance.
+     */
+    fieldset?: EventFieldset[];
+    /** Filter. See [supported fields and operators](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-events). */
+    filter?: Record<string, any> | null;
+    /**
+     * 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).
+     */
+    facet?: string[];
+    /** User ID filter, by default any */
+    userId?: string[];
+    /**
+     * 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).
+     */
+    sort?: string;
+    /**
+     * Whether draft events should be returned in the response.
+     * Requires WIX_EVENTS.MANAGE_EVENTS permission.
+     */
+    includeDrafts?: boolean;
+}
+export declare enum EventFieldset {
+    FULL = "FULL",
+    /** Include `description`, `mainImage` and `calendarLinks` in the response. */
+    DETAILS = "DETAILS",
+    /** Include `about` event rich text in the response. */
+    TEXTS = "TEXTS",
+    /** Include `registration` in the response. */
+    REGISTRATION = "REGISTRATION",
+    /** Include `eventPageUrl` in the response. */
+    URLS = "URLS",
+    /** Include `form` in the response. */
+    FORM = "FORM",
+    /** Include `dashboard` in the response. */
+    DASHBOARD = "DASHBOARD",
+    /** Include `feed` in the response. */
+    FEED = "FEED",
+    /** Include `onlineConferencing` in the response. */
+    ONLINE_CONFERENCING_SESSION = "ONLINE_CONFERENCING_SESSION",
+    /** Include `seoSettings` in the response. */
+    SEO_SETTINGS = "SEO_SETTINGS",
+    /** Include `agendaSettings` in the response. */
+    AGENDA = "AGENDA",
+    /** Include `categories` in the response. */
+    CATEGORIES = "CATEGORIES"
+}
+export interface QueryEventsResponse {
+    /** Total number of events that match the given filters. */
+    total?: number;
+    /** Offset. */
+    offset?: number;
+    /** Limit. */
+    limit?: number;
+    /** Events list */
+    events?: Event[];
+    /** Filter facets. */
+    facets?: Record<string, FacetCounts>;
+}
+export interface FacetCounts {
+    /** Facet counts aggregated per value */
+    counts?: Record<string, number>;
+}
+export interface QueryEventsV2Request {
+    query?: QueryV2;
+    /**
+     * Controls which event properties are returned. See [Fieldset](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_event-fieldset).
+     * Some fields require additional computation that affects latency.
+     * Use minimum set of required fieldset for best performance.
+     */
+    fieldset?: EventFieldset[];
+    /**
+     * 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).
+     */
+    facet?: string[];
+    /**
+     * Whether draft events should be returned in the response.
+     * Requires WIX_EVENTS.MANAGE_EVENTS permission.
+     */
+    includeDrafts?: boolean;
+}
+export interface QueryV2 extends QueryV2PagingMethodOneOf {
+    /** Filter. See [supported fields and operators](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-events). */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]
+     * 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).
+     */
+    sort?: Sorting[];
+    /**
+     * Pointer to page of results using offset.
+     * See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).
+     */
+    paging?: Paging;
+}
+/** @oneof */
+export interface QueryV2PagingMethodOneOf {
+    /**
+     * Pointer to page of results using offset.
+     * See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).
+     */
+    paging?: Paging;
+}
+export interface Sorting {
+    /** Name of the field to sort by */
+    fieldName?: string;
+    /** Sort order (ASC/DESC). Defaults to ASC */
+    order?: SortOrder;
+}
+export declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+export interface Paging {
+    /** Number of items to load per page. */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+export interface QueryEventsV2Response {
+    pagingMetadata?: PagingMetadataV2;
+    /** Events list */
+    events?: Event[];
+    /** Filter facets. */
+    facets?: Record<string, FacetCounts>;
+}
+export interface PagingMetadataV2 {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    offset?: number | null;
+    /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
+    total?: number | null;
+    /** Flag that indicates the server failed to calculate the `total` field. */
+    tooManyToCount?: boolean | null;
+    /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
+    cursors?: Cursors;
+}
+export interface Cursors {
+    /** Cursor pointing to next page in the list of results. */
+    next?: string | null;
+    /** Cursor pointing to previous page in the list of results. */
+    prev?: string | null;
+}
+export interface ListEventsRequest {
+    /** Number of items to skip. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */
+    offset?: number;
+    /** Number of items to load per page. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */
+    limit?: number;
+    /**
+     * Controls which event properties are returned. See [Fieldset](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_event-fieldset).
+     * Some fields require additional computation that affects latency of the service.
+     * Use minimum set of required fieldset for best performance.
+     */
+    fieldset?: EventFieldset[];
+    /** Event status. */
+    status?: EventStatus[];
+    /** Event URL slug. */
+    slug?: string;
+    /**
+     * 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).
+     */
+    facet?: string[];
+    /** User ID filter, by default any */
+    userId?: string[];
+    /**
+     * 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).
+     */
+    sort?: string;
+    /** Category filter. */
+    categoryFilter?: CategoryFilter;
+    /**
+     * Whether draft events should be returned in the response.
+     * Requires WIX_EVENTS.MANAGE_EVENTS permission.
+     */
+    includeDrafts?: boolean;
+    /** Recurrence status filter. */
+    recurrenceStatus?: Status[];
+    /** Recurring group id filter. */
+    recurringGroupId?: string[];
+}
+export interface UserFilter {
+    /** User who is related to event */
+    userId?: string;
+    /** Relation of user to event */
+    relation?: Relation[];
+}
+export declare enum Relation {
+    /**
+     * User is attending the event.
+     * User has RSVP with status YES or has ordered tickets.
+     */
+    ATTENDING = "ATTENDING"
+}
+export interface CategoryFilter {
+    /**
+     * If true - only categorised events will be returned.
+     * If false - only not categorised events will be returned.
+     */
+    categorised?: boolean | null;
+    /** Category id filter. */
+    categoryId?: string[];
+    /** Category states filter. Default - any state. */
+    states?: State[];
+}
+export interface ListEventsResponse {
+    /** Total number of events that match the given filters. */
+    total?: number;
+    /** Offset. */
+    offset?: number;
+    /** Limit. */
+    limit?: number;
+    /** Events list. */
+    events?: Event[];
+    /** Filter facets. */
+    facets?: Record<string, FacetCounts>;
+}
+export interface ListUserEventsRequest {
+    paging?: Paging;
+    /**
+     * 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).
+     */
+    sort?: Sorting[];
+    /** Event status. */
+    status?: EventStatus[];
+    /**
+     * Wix user filter, by default any.
+     * 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).
+     */
+    facet?: string[];
+}
+export interface ListUserEventsResponse {
+    pagingMetadata?: PagingMetadataV2;
+    /** Events list. */
+    events?: Event[];
+    /** Filter facets. */
+    facets?: Record<string, FacetCounts>;
+}
+export interface ListCategoryEventsRequest {
+    /** Category ID */
+    categoryId: string;
+    paging?: Paging;
+    /**
+     * Controls which event properties are returned. See [Fieldset](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_event-fieldset).
+     * Some fields require additional computation that affects latency of the service.
+     * Use minimum set of required fieldset for best performance.
+     */
+    fieldset?: EventFieldset[];
+}
+export interface ListCategoryEventsResponse {
+    pagingMetadata?: PagingMetadataV2;
+    /** Events list. */
+    events?: Event[];
+}
+export interface GetEventRequest extends GetEventRequestGetByOneOf {
+    /**
+     * Controls which event properties are returned. See [Fieldset](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_event-fieldset).
+     * Some fields require additional computation that affects latency.
+     * Use minimum set of required fieldset for best performance.
+     */
+    fieldset?: EventFieldset[];
+    /** Event ID. */
+    _id?: string | null;
+    /** URL slug. */
+    slug?: string | null;
+}
+/** @oneof */
+export interface GetEventRequestGetByOneOf {
+    /** Event ID. */
+    _id?: string | null;
+    /** URL slug. */
+    slug?: string | null;
+}
+export interface GetEventResponse {
+    /** Event. */
+    event?: Event;
+}
+export interface FindEventRequest extends FindEventRequestFindByOneOf {
+    /**
+     * Controls which event properties are returned. See [Fieldset](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_event-fieldset).
+     * Some fields require additional computation that affects latency.
+     * Use minimum set of required fieldset for best performance.
+     */
+    fieldset?: EventFieldset[];
+    /** Event ID. */
+    _id?: string | null;
+    /** URL slug. */
+    slug?: string | null;
+}
+/** @oneof */
+export interface FindEventRequestFindByOneOf {
+    /** Event ID. */
+    _id?: string | null;
+    /** URL slug. */
+    slug?: string | null;
+}
+export interface FindEventResponse {
+    /** Event. */
+    event?: Event;
+}
+export interface CreateEventV2Request {
+    /** Event data. */
+    event: EventData;
+    /**
+     * Content language code in ISO 639-1 format.
+     * Used for translating ticket PDF labels, registration form, automatic emails, etc.
+     * Supported languages: ar, bg, cs, da, de, el, en, es, fi, fr, he, hi, hu, id, it, ja, ko, ms, nl, no, pl, pt, ro, ru, sv, th, tl, tr, uk, zh.
+     * Defaults to en.
+     */
+    language?: string | null;
+    /** Whether event should be created as draft. Draft events are hidden from site visitors. */
+    draft?: boolean;
+}
+export interface EventData {
+    /** Event title. */
+    title?: string | null;
+    /** Event description. */
+    description?: string | null;
+    /**
+     * Event location.
+     * Address is required for non TBD event.
+     * Location name is required for TBD event.
+     */
+    location?: Location;
+    /** Event schedule configuration */
+    scheduleConfig?: ScheduleConfig;
+    /**
+     * Main event image. Printed in ticket PDF.
+     * Currently, only images previously saved in Wix Media are supported.
+     */
+    mainImage?: string;
+    /** RSVP collection configuration. Can be used to set limits. */
+    rsvpCollectionConfig?: RsvpCollectionConfig;
+    /** Guest list configuration */
+    guestListConfig?: GuestListConfig;
+    /** Rich-text content for About Event section (HTML). */
+    about?: string | null;
+    /** Registration configuration */
+    registrationConfig?: RegistrationConfig;
+    /** Online conferencing configuration */
+    onlineConferencingConfig?: OnlineConferencingConfig;
+    /** SEO settings */
+    seoSettings?: SeoSettings;
+    /** Agenda configuration */
+    agenda?: Agenda;
+}
+export interface RegistrationConfig {
+    /** External event registration URL (for external events only). */
+    externalRegistrationUrl?: string | null;
+    /** Whether registration is closed. */
+    pausedRegistration?: boolean;
+    /** Ticketing configuration. */
+    ticketingConfig?: TicketingConfig;
+    /** Types of users allowed to register. */
+    restrictedTo?: VisitorType;
+    /** Whether registration is disabled. */
+    disabledRegistration?: boolean;
+    /**
+     * Initial event type. Only RSVP and TICKETS are allowed when creating an event.
+     * Updating this field is not allowed.
+     */
+    initialType?: EventType;
+}
+export interface CreateEventV2Response {
+    /** Created event. */
+    event?: Event;
+}
+export interface EventCreated {
+    /** Event created timestamp in ISO UTC format. */
+    timestamp?: Date;
+    /** Event ID. */
+    eventId?: string;
+    /** Event location. */
+    location?: Location;
+    /** Event schedule configuration. */
+    scheduleConfig?: ScheduleConfig;
+    /** Event title. */
+    title?: string;
+    /** Event creator user ID. */
+    userId?: string | null;
+    /** Event status. */
+    status?: EventStatus;
+    /** Instance ID. Indicates the original app instance which current event was derived from. */
+    derivedFromInstanceId?: string | null;
+    /** Event ID. Indicates the original event which current event was derived from. */
+    derivedFromEventId?: string | null;
+}
+export interface EventPublished {
+    /** Event publish timestamp in ISO UTC format. */
+    timestamp?: Date;
+    /** Event ID. */
+    eventId?: string;
+    /** Event status. */
+    status?: EventStatus;
+    /**
+     * Event ID. Indicates the original event which current event was derived from.
+     * Can be used to track the original event and add missing information.
+     */
+    derivedFromEventId?: string | null;
+}
+export interface CopyEventRequest {
+    /** Event ID. */
+    eventId: string;
+    /**
+     * If true, event will be copied as draft.
+     * Otherwise copied event will be published, unless it is draft.
+     */
+    draft?: boolean;
+}
+export interface CopyEventResponse {
+    /** Copied event. */
+    event?: Event;
+}
+export interface EventCopied {
+    /** Event created timestamp in ISO UTC format. */
+    timestamp?: Date;
+    /** Event ID. */
+    eventId?: string;
+    /** Event location. */
+    location?: Location;
+    /** Event schedule configuration. */
+    scheduleConfig?: ScheduleConfig;
+    /** Event title. */
+    title?: string;
+    /** Event creator user ID. */
+    userId?: string | null;
+    /** Event status. */
+    status?: EventStatus;
+    /** Instance ID. Indicates the original app instance which current event was derived from. */
+    derivedFromInstanceId?: string | null;
+    /** Event ID. Indicates the original event which current event was derived from. */
+    derivedFromEventId?: string | null;
+    /**
+     * Map of copied ticket definitions from original event.
+     * Key represents ticket def id in the original event.
+     * Value represents ticket def id in the newly created event.
+     */
+    ticketDefinitions?: Record<string, string>;
+}
+export interface CopyEventV2Request {
+    /** Event ID. */
+    _id: string;
+    /** Event data to update (partial) */
+    event?: EventData;
+    /**
+     * Set of field paths to update.
+     * <!--ONLY:REST-->
+     * Fields will be auto-populated from the `event` entity unless added to the request explicitly.
+     * <!--END:ONLY:REST-->
+     * Behavior follows [google.protobuf.FieldMask](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask) semantics.
+     */
+    fields?: string[];
+    /**
+     * If true, event will be copied as draft.
+     * Otherwise copied event will be published, unless it is draft.
+     */
+    draft?: boolean;
+}
+export interface CopyEventV2Response {
+    /** Copied event. */
+    event?: Event;
+}
+export interface UpdateEventRequest {
+    /** Event ID. */
+    _id: string;
+    /** Event data to update (partial) */
+    event?: EventData;
+    /**
+     * Set of field paths to update.
+     * <!--ONLY:REST-->
+     * Fields will be auto-populated from the `event` entity unless added to the request explicitly.
+     * <!--END:ONLY:REST-->
+     * Behavior follows [google.protobuf.FieldMask](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask) semantics.
+     */
+    fields?: string[];
+    /**
+     * Content language code in ISO 639-1 format.
+     * Used for translating ticket PDF labels, registration form, automatic emails, etc.
+     * Supported languages: ar, bg, cs, da, de, el, en, es, fi, fr, he, hi, hu, id, it, ja, ko, ms, nl, no, pl, pt, ro, ru, sv, th, tl, tr, uk, zh.
+     * Defaults to en.
+     */
+    language?: string | null;
+}
+export interface UpdateEventResponse {
+    /** Updated event. */
+    event?: Event;
+}
+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 PublishDraftEventRequest {
+    /** Event ID. */
+    _id: string;
+}
+export interface PublishDraftEventResponse {
+    /** Published event. */
+    event?: Event;
+}
+export interface CancelEventRequest {
+    /** Event ID. */
+    _id: string;
+}
+export interface CancelEventResponse {
+    /** Canceled event. */
+    event?: Event;
+}
+export interface EventCanceled {
+    /** Event canceled timestamp in ISO UTC format. */
+    timestamp?: Date;
+    /** Event ID. */
+    eventId?: string;
+    /** Event title */
+    title?: string;
+    /** Event creator user ID. */
+    userId?: string | null;
+}
+export interface BulkCancelEventsRequest {
+    /** Filter. See [supported fields and operators](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-events). */
+    filter: Record<string, any> | null;
+}
+export interface BulkCancelEventsResponse {
+}
+export interface DeleteEventRequest {
+    /** Event ID. */
+    _id: string;
+}
+export interface DeleteEventResponse {
+    /** Deleted event ID. */
+    _id?: string;
+}
+export interface EventDeleted {
+    /** Event deleted timestamp in ISO UTC format. */
+    timestamp?: Date;
+    /** Event ID. */
+    eventId?: string;
+    /** Event title. */
+    title?: string;
+    /** Event creator user ID. */
+    userId?: string | null;
+}
+export interface BulkDeleteEventsRequest {
+    /** Filter. See [supported fields and operators](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-events). */
+    filter: Record<string, any> | null;
+}
+export interface BulkDeleteEventsResponse {
+}
+export interface GetRecurringEventStateRequest {
+    /** Recurring event category id. */
+    categoryId?: string;
+}
+export interface GetRecurringEventStateResponse {
+    /** Recurring event category id. */
+    categoryId?: string | null;
+    inconsistentState?: boolean;
+    actual?: RecurringEventState;
+    desired?: RecurringEventState;
+}
+export interface RecurringEventState {
+    recurringNext?: RecurringEventDetails;
+    recurringLastEnded?: RecurringEventDetails;
+    recurringLastCanceled?: RecurringEventDetails;
+}
+export interface RecurringEventDetails {
+    eventId?: string | null;
+    /** Event slug */
+    slug?: string | null;
+    /** Event start timestamp. */
+    startDate?: Date;
+    /** Event end timestamp. */
+    endDate?: Date;
+    recurrenceStatus?: Status;
+}
+export interface UpdateRecurringStatusRequest {
+    /** Recurring event category id. */
+    categoryId?: string;
+}
+export interface UpdateRecurringStatusResponse {
+}
+/**
+ * Retrieves a list of up to 1,000 events, given the provided [paging](https://dev.wix.com/api/rest/getting-started/pagination), [filtering and sorting](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-events).
+ * @public
+ * @documentationMaturity preview
+ */
+export declare function query(options?: QueryOptions): Promise<QueryEventsResponse>;
+export interface QueryOptions {
+    /** Number of items to skip. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */
+    offset?: number;
+    /** Number of items to load per page. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */
+    limit?: number;
+    /**
+     * Controls which event properties are returned. See [Fieldset](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_event-fieldset).
+     * Some fields require additional computation that affects latency.
+     * Use minimum set of required fieldset for best performance.
+     */
+    fieldset?: EventFieldset[];
+    /** Filter. See [supported fields and operators](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-events). */
+    filter?: Record<string, any> | null;
+    /**
+     * 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).
+     */
+    facet?: string[];
+    /** User ID filter, by default any */
+    userId?: string[];
+    /**
+     * 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).
+     */
+    sort?: string;
+    /**
+     * Whether draft events should be returned in the response.
+     * Requires WIX_EVENTS.MANAGE_EVENTS permission.
+     */
+    includeDrafts?: boolean;
+}
+/**
+ * Retrieves a list of up to 1,000 events, given the provided paging, filtering and sorting.
+ *
+ * ** Important **:
+ * - All results are for one specific business, resolved from the request context.
+ *
+ * Query object support:
+ * - `filter` - supported, see [filtering and sorting](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-events).
+ * - `sort` - supported, see [filtering and sorting](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-events).
+ * - `paging` - supported, see [paging](https://dev.wix.com/api/rest/getting-started/pagination).
+ * - `fields` - not supported.
+ * - `fieldsets` - not supported, use request-level `fieldset` instead.
+ * - `cursorPaging` - not supported, use offset pagination instead.
+ *
+ * Defaults:
+ * - When filter is not specified, returns all events that caller is authorized to read.
+ * - When sorting is not specified, defaults to `created` in `DESC` order.
+ * @public
+ * @documentationMaturity preview
+ */
+export declare function queryEventsV2(options?: QueryEventsV2Options): Promise<QueryEventsV2Response>;
+export interface QueryEventsV2Options {
+    query?: QueryV2;
+    /**
+     * Controls which event properties are returned. See [Fieldset](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_event-fieldset).
+     * Some fields require additional computation that affects latency.
+     * Use minimum set of required fieldset for best performance.
+     */
+    fieldset?: EventFieldset[];
+    /**
+     * 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).
+     */
+    facet?: string[];
+    /**
+     * Whether draft events should be returned in the response.
+     * Requires WIX_EVENTS.MANAGE_EVENTS permission.
+     */
+    includeDrafts?: boolean;
+}
+/**
+ * Retrieves a list of up to 100 events, given the provided [paging](https://dev.wix.com/api/rest/getting-started/pagination), [filtering & sorting](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-events).
+ * @public
+ * @documentationMaturity preview
+ */
+export declare function listEvents(options?: ListEventsOptions): Promise<ListEventsResponse>;
+export interface ListEventsOptions {
+    /** Number of items to skip. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */
+    offset?: number;
+    /** Number of items to load per page. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */
+    limit?: number;
+    /**
+     * Controls which event properties are returned. See [Fieldset](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_event-fieldset).
+     * Some fields require additional computation that affects latency of the service.
+     * Use minimum set of required fieldset for best performance.
+     */
+    fieldset?: EventFieldset[];
+    /** Event status. */
+    status?: EventStatus[];
+    /** Event URL slug. */
+    slug?: string;
+    /**
+     * 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).
+     */
+    facet?: string[];
+    /** User ID filter, by default any */
+    userId?: string[];
+    /**
+     * 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).
+     */
+    sort?: string;
+    /** Category filter. */
+    categoryFilter?: CategoryFilter;
+    /**
+     * Whether draft events should be returned in the response.
+     * Requires WIX_EVENTS.MANAGE_EVENTS permission.
+     */
+    includeDrafts?: boolean;
+    /** Recurrence status filter. */
+    recurrenceStatus?: Status[];
+    /** Recurring group id filter. */
+    recurringGroupId?: string[];
+}
+/**
+ * Retrieves a list of up to 100 events, given the provided [paging](https://dev.wix.com/api/rest/getting-started/pagination) and category_id.
+ * Events are sorted by the sort index defined by CategoryManagement.
+ * @param categoryId - Category ID
+ * @public
+ * @documentationMaturity preview
+ * @requiredField categoryId
+ */
+export declare function listCategoryEvents(categoryId: string, options?: ListCategoryEventsOptions): Promise<ListCategoryEventsResponse>;
+export interface ListCategoryEventsOptions {
+    paging?: Paging;
+    /**
+     * Controls which event properties are returned. See [Fieldset](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_event-fieldset).
+     * Some fields require additional computation that affects latency of the service.
+     * Use minimum set of required fieldset for best performance.
+     */
+    fieldset?: EventFieldset[];
+}
+/**
+ * Retrieves an event by ID or URL slug.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField GetEventRequest
+ */
+export declare function getEvent(options?: GetEventOptions): Promise<GetEventResponse>;
+export interface GetEventOptions {
+    /** Event ID. */
+    _id?: string | null;
+    /** URL slug. */
+    slug?: string | null;
+    /**
+     * Controls which event properties are returned. See [Fieldset](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_event-fieldset).
+     * Some fields require additional computation that affects latency.
+     * Use minimum set of required fieldset for best performance.
+     */
+    fieldset?: EventFieldset[];
+}
+/**
+ * Finds an event by ID or URL slug. In contrast to Get Event endpoint which returns not found error,
+ * Find Event returns empty response when an event is not found.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField FindEventRequest
+ */
+export declare function findEvent(options?: FindEventOptions): Promise<FindEventResponse>;
+export interface FindEventOptions {
+    /** Event ID. */
+    _id?: string | null;
+    /** URL slug. */
+    slug?: string | null;
+    /**
+     * Controls which event properties are returned. See [Fieldset](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_event-fieldset).
+     * Some fields require additional computation that affects latency.
+     * Use minimum set of required fieldset for best performance.
+     */
+    fieldset?: EventFieldset[];
+}
+/**
+ * Creates a new event, with a default registration form in the given language.
+ * Default registration form includes first name, last name, and email inputs.
+ * To learn more about registration form and customize it, see [Registration Form](https://dev.wix.com/api/rest/wix-events/wix-events/registration-form/about-the-registration-form-api).
+ * The event is automatically configured to send daily summary reports of new registrations to site business email.
+ * RegistrationConfig.initialType is required - allowed value when creating is RSVP or TICKETS.
+ * @param event - Event data.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField event
+ * @requiredField event.location
+ * @requiredField event.scheduleConfig
+ * @requiredField event.title
+ */
+export declare function createEventV2(event: EventData, options?: CreateEventV2Options): Promise<CreateEventV2Response>;
+export interface CreateEventV2Options {
+    /**
+     * Content language code in ISO 639-1 format.
+     * Used for translating ticket PDF labels, registration form, automatic emails, etc.
+     * Supported languages: ar, bg, cs, da, de, el, en, es, fi, fr, he, hi, hu, id, it, ja, ko, ms, nl, no, pl, pt, ro, ru, sv, th, tl, tr, uk, zh.
+     * Defaults to en.
+     */
+    language?: string | null;
+    /** Whether event should be created as draft. Draft events are hidden from site visitors. */
+    draft?: boolean;
+}
+/**
+ * Copies an event, including its registration form, notifications and tickets configuration - scheduled two weeks from the original event.
+ * Multilingual translations are also copied to the new event.
+ *
+ * When an event with same title already exists, appends (1), (2), ... to it. For example, copying an event titled "My Event" creates "My Event (1)".
+ * Very long event titles are cropped: "Daily stand-up ev... (2)".
+ * @param eventId - Event ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField eventId
+ */
+export declare function copy(eventId: string, options?: CopyOptions): Promise<CopyEventResponse>;
+export interface CopyOptions {
+    /**
+     * If true, event will be copied as draft.
+     * Otherwise copied event will be published, unless it is draft.
+     */
+    draft?: boolean;
+}
+/**
+ * Copies an event, including its registration form, notifications and tickets configuration - scheduled two weeks from the original event.
+ * Multilingual translations are also copied to the new event.
+ * Supports partial update of the original event fields. See [Partial Updates](https://dev.wix.com/api/rest/wix-events/wix-events/partial-updates) for more information.
+ *
+ * When an event with same title already exists, appends (1), (2), ... to it. For example, copying an event titled "My Event" creates "My Event (1)".
+ * Very long event titles are cropped: "Daily stand-up ev... (2)".
+ * @param _id - Event ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ */
+export declare function copyEventV2(_id: string, options?: CopyEventV2Options): Promise<CopyEventV2Response>;
+export interface CopyEventV2Options {
+    /** Event data to update (partial) */
+    event?: EventData;
+    /**
+     * Set of field paths to update.
+     * <!--ONLY:REST-->
+     * Fields will be auto-populated from the `event` entity unless added to the request explicitly.
+     * <!--END:ONLY:REST-->
+     * Behavior follows [google.protobuf.FieldMask](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask) semantics.
+     */
+    fields?: string[];
+    /**
+     * If true, event will be copied as draft.
+     * Otherwise copied event will be published, unless it is draft.
+     */
+    draft?: boolean;
+}
+/**
+ * Updates an event's parameters. See [Partial Updates](https://dev.wix.com/api/rest/wix-events/wix-events/partial-updates) for more information.
+ * @param _id - Event ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ */
+export declare function updateEvent(_id: string, options?: UpdateEventOptions): Promise<UpdateEventResponse>;
+export interface UpdateEventOptions {
+    /** Event data to update (partial) */
+    event?: EventData;
+    /**
+     * Set of field paths to update.
+     * <!--ONLY:REST-->
+     * Fields will be auto-populated from the `event` entity unless added to the request explicitly.
+     * <!--END:ONLY:REST-->
+     * Behavior follows [google.protobuf.FieldMask](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask) semantics.
+     */
+    fields?: string[];
+    /**
+     * Content language code in ISO 639-1 format.
+     * Used for translating ticket PDF labels, registration form, automatic emails, etc.
+     * Supported languages: ar, bg, cs, da, de, el, en, es, fi, fr, he, hi, hu, id, it, ja, ko, ms, nl, no, pl, pt, ro, ru, sv, th, tl, tr, uk, zh.
+     * Defaults to en.
+     */
+    language?: string | null;
+}
+/**
+ * Publishes draft event so that it becomes available to site visitors.
+ * If recurring events are set, category with state RECURRING_EVENT will be created.
+ * All recurring events will be assigned to this category.
+ * @param _id - Event ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ */
+export declare function publishDraftEvent(_id: string): Promise<PublishDraftEventResponse>;
+/**
+ * Cancels an event and closes registration.
+ * If event cancellation notifications are enabled, canceling an event automatically sends cancellation emails and/or push notifications to registered guests.
+ * @param _id - Event ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ */
+export declare function cancelEvent(_id: string): Promise<CancelEventResponse>;
+/**
+ * Cancels events by filter.
+ * If event cancellation notifications are enabled, canceling an event automatically sends cancellation emails and/or push notifications to registered guests.
+ * @param filter - Filter. See [supported fields and operators](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-events).
+ * @public
+ * @documentationMaturity preview
+ * @requiredField filter
+ */
+export declare function bulkCancelEvents(filter: Record<string, any> | null): Promise<void>;
+/**
+ * Deletes an event.
+ * Deleted events are not returned via API. The only way to retrieve them is via GDPR access request.
+ * @param _id - Event ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ */
+export declare function deleteEvent(_id: string): Promise<DeleteEventResponse>;
+/**
+ * Deletes events by filter.
+ * Deleted events are not returned via API. The only way to retrieve them is via GDPR access request.
+ * @param filter - Filter. See [supported fields and operators](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-events).
+ * @public
+ * @documentationMaturity preview
+ * @requiredField filter
+ */
+export declare function bulkDeleteEvents(filter: Record<string, any> | null): Promise<void>;