@wix/events 1.0.154 → 1.0.156

package/build/es/src/events-v3-event.types.d.ts

@@ -1,4 +1,4 @@
-export interface Event {
+export interface V3Event {
     /**
      * Event ID.
      * @readonly
@@ -12,7 +12,7 @@ export interface Event {
     shortDescription?: string | null;
     detailedDescription?: string | null;
     /** Main event image. */
-    mainImage?: Image;
+    mainImage?: CommonImage;
     /**
      * Unique identifier of the event page. The naming is the same as the event title written in kebab case. For example, if your event title is "Leather Crafting 101", then the slug is "leather-crafting-101".
      * @readonly
@@ -61,7 +61,7 @@ export interface Event {
     /** Event schedule details. */
     agendaSettings?: AgendaSettings;
     /** Visual settings for event. */
-    eventDisplaySettings?: EventDisplaySettings;
+    eventDisplaySettings?: V3EventDisplaySettings;
 }
 export interface Location {
     name?: string | null;
@@ -211,7 +211,7 @@ export interface Formatted {
      */
     endTime?: string | null;
 }
-export interface Image {
+export interface CommonImage {
     /** WixMedia image ID. */
     id?: string;
     /** Image URL. */
@@ -850,7 +850,7 @@ export declare enum Type {
     /** Created automatically and used to store component events. */
     COMPONENT = "COMPONENT"
 }
-export interface EventDisplaySettings {
+export interface V3EventDisplaySettings {
     /** Whether event details button is hidden. Only available for events with no registration. */
     hideEventDetailsButton?: boolean | null;
 }
@@ -896,7 +896,7 @@ export interface V3EventEnded {
 }
 export interface CreateEventRequest {
     /** Event data. */
-    event: Event;
+    event: V3Event;
     /** Whether to create the event as a draft. */
     draft?: boolean;
     /**
@@ -943,7 +943,7 @@ export declare enum RequestedFields {
 }
 export interface CreateEventResponse {
     /** Created event. */
-    event?: Event;
+    event?: V3Event;
 }
 export interface V3EventPublished {
     /** Event publishing timestamp in ISO UTC format. */
@@ -962,7 +962,7 @@ export interface CloneEventRequest {
     /** Event ID. */
     eventId: string;
     /** Field values to be changed when cloning the event. */
-    event?: Event;
+    event?: V3Event;
     /** Whether to clone the event as a draft. */
     draft?: boolean;
     /**
@@ -983,7 +983,7 @@ export interface CloneEventRequest {
 }
 export interface CloneEventResponse {
     /** Cloned event. */
-    event?: Event;
+    event?: V3Event;
 }
 export interface EventCloned {
     /** Event creation timestamp in ISO UTC format. */
@@ -1013,7 +1013,7 @@ export interface EventCloned {
 }
 export interface UpdateEventRequest {
     /** Field values to be changed. */
-    event?: Event;
+    event?: V3Event;
     /**
      * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
      * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
@@ -1032,7 +1032,7 @@ export interface UpdateEventRequest {
 }
 export interface UpdateEventResponse {
     /** Updated event. */
-    event?: Event;
+    event?: V3Event;
 }
 export interface PublishDraftEventRequest {
     /** Event ID. */
@@ -1055,7 +1055,7 @@ export interface PublishDraftEventRequest {
 }
 export interface PublishDraftEventResponse {
     /** Published event. */
-    event?: Event;
+    event?: V3Event;
 }
 export interface CancelEventRequest {
     /** Event ID. */
@@ -1078,7 +1078,7 @@ export interface CancelEventRequest {
 }
 export interface CancelEventResponse {
     /** Canceled event. */
-    event?: Event;
+    event?: V3Event;
 }
 export interface V3EventCanceled {
     /** Event cancelation timestamp in ISO UTC format. */
@@ -1181,7 +1181,7 @@ export interface QueryEventsResponse {
     /** Metadata for the paginated results. */
     pagingMetadata?: PagingMetadataV2;
     /** List of events. */
-    events?: Event[];
+    events?: V3Event[];
 }
 export interface PagingMetadataV2 {
     /** Number of items to return. See [Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging#getting-started_sorting-and-paging_paging) for more information. */
@@ -1264,7 +1264,7 @@ export interface ListUserEventsResponse {
     /** Metadata for the paginated results. */
     pagingMetadata?: PagingMetadataV2;
     /** List of events. */
-    events?: Event[];
+    events?: V3Event[];
     /** Filter facets. */
     facets?: Record<string, FacetCounts>;
 }
@@ -1293,7 +1293,7 @@ export interface ListEventsByCategoryResponse {
     /** Metadata for the paginated results. */
     pagingMetadata?: PagingMetadataV2;
     /** List of events. */
-    events?: Event[];
+    events?: V3Event[];
 }
 export interface GetEventRequest {
     /** Event ID. */
@@ -1316,7 +1316,7 @@ export interface GetEventRequest {
 }
 export interface GetEventResponse {
     /** Event. */
-    event?: Event;
+    event?: V3Event;
 }
 export interface GetEventBySlugRequest {
     /** URL slug. */
@@ -1339,7 +1339,7 @@ export interface GetEventBySlugRequest {
 }
 export interface GetEventBySlugResponse {
     /** Event. */
-    event?: Event;
+    event?: V3Event;
 }
 export interface FindEventRequest extends FindEventRequestFindByOneOf {
     /** Event ID. */
@@ -1362,21 +1362,9 @@ export interface FindEventRequestFindByOneOf {
 }
 export interface FindEventResponse {
     /** Event. */
-    event?: Event;
+    event?: V3Event;
 }
-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 Empty {
-}
-export interface EventCopied {
+export interface EventCreated {
     /** Event created timestamp in ISO UTC format. */
     timestamp?: Date;
     /** Event ID. */
@@ -1395,12 +1383,8 @@ export interface EventCopied {
     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>;
+    /** Event that was created. */
+    event?: Event;
 }
 export interface EventsLocation {
     /** Location name. */
@@ -1575,6 +1559,469 @@ export declare enum EventStatus {
     /** Event is not public and needs to be published */
     DRAFT = "DRAFT"
 }
+export interface Event {
+    /**
+     * Event ID.
+     * @readonly
+     */
+    id?: string;
+    /** Event location. */
+    location?: EventsLocation;
+    /** 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?: Image;
+    /** 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?: EventsRegistration;
+    /** "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?: EventsFeed;
+    /** Online conferencing details. */
+    onlineConferencing?: EventsOnlineConferencing;
+    /** SEO settings. */
+    seoSettings?: EventsSeoSettings;
+    /** Assigned contacts label key. */
+    assignedContactsLabel?: string | null;
+    /** Agenda details. */
+    agenda?: Agenda;
+    /** Categories this event is assigned to. */
+    categories?: Category[];
+    /** Visual settings for event. */
+    eventDisplaySettings?: EventDisplaySettings;
+}
+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;
+    /** Formatted end date of the event (empty for TBD schedules or when end date is hidden). */
+    endDateFormatted?: string;
+    /** Formatted end time of the event (empty for TBD schedules or when end date is hidden). */
+    endTimeFormatted?: string;
+}
+export interface Image {
+    /** WixMedia image ID. */
+    id?: string | null;
+    /** Image URL. */
+    url?: string;
+    /** Original image height. */
+    height?: number | null;
+    /** Original image width. */
+    width?: number | null;
+    /** Image alt text. Optional. */
+    altText?: string | null;
+}
+export interface EventsRegistration {
+    /** 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?: EventsMoney;
+    /**
+     * Price of highest priced ticket.
+     * @readonly
+     */
+    highestTicketPrice?: EventsMoney;
+    /**
+     * 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;
+    /** Duration for which the tickets being bought are reserved. */
+    reservationDurationInMinutes?: number | null;
+}
+export interface TaxConfig {
+    /** Tax application settings. */
+    type?: EventsTaxType;
+    /** 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 EventsTaxType {
+    /** 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 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;
+}
+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?: EventsMoney;
+    /** 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?: EventsMoney;
+}
+export interface GuestListConfig {
+    /** Whether members can see other members attending the event (defaults to true). */
+    publicGuestList?: boolean;
+}
+export interface EventsFeed {
+    /** Event discussion feed token. */
+    token?: string;
+}
+export interface EventsOnlineConferencing {
+    config?: OnlineConferencingConfig;
+    session?: EventsOnlineConferencingSession;
+}
+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 EventsOnlineConferencingSession {
+    /**
+     * 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 EventsSeoSettings {
+    /** URL slug */
+    slug?: string;
+    /** Advanced SEO data */
+    advancedSeoData?: SeoSchema;
+    /**
+     * Hidden from SEO Site Map
+     * @readonly
+     */
+    hidden?: boolean | null;
+}
+export interface Agenda {
+    /** Whether the schedule is enabled for the event. */
+    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;
+    /**
+     * Assigned and assigned draft event counts.
+     * @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 EventDisplaySettings {
+    /** Whether event details button is hidden. Only available for events with no registration. */
+    hideEventDetailsButton?: boolean | null;
+}
+export interface Empty {
+}
+export interface EventUpdated {
+    /** Event update timestamp in ISO UTC format. */
+    timestamp?: Date;
+    /** Event ID. */
+    eventId?: string;
+    /** Event location. */
+    location?: EventsLocation;
+    /** Event schedule configuration. */
+    scheduleConfig?: ScheduleConfig;
+    /** Event title. */
+    title?: string;
+    /** Whether schedule configuration was updated. */
+    scheduleConfigUpdated?: boolean;
+    /** Updated event */
+    event?: Event;
+}
+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 EventCopied {
+    /** Event created timestamp in ISO UTC format. */
+    timestamp?: Date;
+    /** Event ID. */
+    eventId?: string;
+    /** Event location. */
+    location?: EventsLocation;
+    /** 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 EventPublished {
     /** Event publish timestamp in ISO UTC format. */
     timestamp?: Date;