import { QueryEventGuestsRequest as QueryEventGuestsRequest$1, QueryEventGuestsResponse as QueryEventGuestsResponse$1 } from './index.typings.js';
import '@wix/sdk-types';
interface EventGuest {
/**
* Guest ID.
* @format GUID
*/
id?: string | null;
/**
* Event ID.
* @format GUID
*/
eventId?: string | null;
/**
* RSVP ID.
**Note:** Only applicable when `guestType` is `"RSVP"`.
* @format GUID
*/
rsvpId?: string | null;
/**
* Order number.
**Note:** Only applicable when `guestType` is `"BUYER"` or `"TICKET_HOLDER"`.
* @maxLength 36
*/
orderNumber?: string | null;
/**
* Ticket number.
**Note:** Only applicable when `guestType` is `"TICKET_HOLDER"`.
* @maxLength 36
*/
ticketNumber?: string | null;
/**
* List of names, numbers, and definition IDs for each ticket.
* @maxSize 50
*/
tickets?: TicketDetails[];
/**
* Guest's contact ID. See the Contacts API for more details.
* @format GUID
*/
contactId?: string | null;
/** Guest details.
Returned only when the `guestDetails` fieldset is sent in the request. */
guestDetails?: GuestDetails;
/**
* Attendance status. The attendance status updates based on status values in an RSVP object (for RSVP events) or in an Order object (for ticketed events).
* For more information, see [Guest Attendance Status Mapping](https://dev.wix.com/docs/api-reference/business-solutions/events/registration/event-guests/guest-attendance-status-mapping).
**Note:** For `guestType` of `"BUYER"` or `"TICKET_HOLDER"` the `"IN_WAITLIST"` value is not applicable.
*/
attendanceStatus?: AttendanceStatusWithLiterals;
/**
* Secondary language code in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. Used when the event ticket should be translated into another language.
* @format LANGUAGE
*/
secondaryLanguageCode?: string | null;
/** Date and time the guest was created in `yyyy-mm-ddThh:mm:sssZ` format. */
createdDate?: Date | null;
/** Date and time the guest was updated in `yyyy-mm-ddThh:mm:sssZ` format. */
updatedDate?: Date | null;
/** Date and time of guest's latest attendance status update. */
attendanceStatusUpdatedDate?: Date | null;
/**
* Site member ID.
* @format GUID
*/
memberId?: string | null;
/** Guest type. */
guestType?: GuestTypeWithLiterals;
/**
* Locale in [IETF BCP 47](https://en.wikipedia.org/wiki/IETF_language_tag) format. Used when the event date and time on a ticket should be formatted into another locale.
* @format LANGUAGE_TAG
*/
locale?: string | null;
/**
* Number of total guests in an event (registered guests + additional ones).
* @readonly
*/
totalGuests?: number | null;
/**
* Revision number, which increments by 1 each time the guest is updated.
* @readonly
*/
revision?: string | null;
/**
* Additional Details
* @readonly
*/
additionalDetails?: AdditionalDetails;
}
interface TicketDetails {
/**
* Ticket number.
* @maxLength 36
*/
number?: string;
/**
* Ticket definition ID.
* @format GUID
*/
definitionId?: string | null;
/**
* Ticket name.
* @minLength 1
* @maxLength 30
*/
name?: string | null;
}
interface TicketGuestDetails {
/** The login details for the guest to access the online conference event. */
onlineConferencingLogin?: OnlineConferencingLogin;
/**
* First name.
* @maxLength 255
*/
firstName?: string | null;
/**
* Last name.
* @maxLength 255
*/
lastName?: string | null;
}
interface OnlineConferencingLogin {
/**
* Link URL to the online conference.
* @format WEB_URL
* @readonly
*/
link?: string;
/**
* Password for the online conference.
* @readonly
*/
password?: string | null;
}
interface GuestDetails {
/**
* Email.
* @format EMAIL
*/
email?: string | null;
/**
* First name.
* @maxLength 255
*/
firstName?: string | null;
/**
* Last name.
* @maxLength 255
*/
lastName?: string | null;
/** Form response. */
formResponse?: FormResponse;
/** Whether the guest has checked into the event. */
checkedIn?: boolean;
/** The login details for the guest to access the online conference event. */
onlineConferencingLogin?: OnlineConferencingLogin;
/**
* Phone extracted from form response. If multiples phone inputs are present, first one is returned.
* @maxLength 200
*/
phone?: string | null;
/**
* Address extracted from form response. If multiples address inputs are present, first one is returned.
* @maxLength 200
*/
address?: string | null;
}
interface FormResponse {
/**
* Form field inputs.
* @maxSize 200
*/
inputValues?: InputValue[];
}
interface InputValue {
/**
* Form field input name.
* @maxLength 100
*/
inputName?: string;
/**
* Form field value.
* @maxLength 5000
*/
value?: string;
/**
* Form field values.
* @maxSize 100
* @maxLength 5000
*/
values?: string[];
}
interface FormattedAddress {
/**
* 1-line address representation.
* @maxLength 200
*/
formatted?: string;
/** Address components. */
address?: Address;
}
/** Physical address */
interface Address extends AddressStreetOneOf {
/** Street name and number. */
streetAddress?: StreetAddress;
/** Main address line, usually street and number as free text. */
addressLine?: string | null;
/**
* Country code.
* @format COUNTRY
*/
country?: string | null;
/** Subdivision shorthand. Usually, a short code (2 or 3 letters) that represents a state, region, prefecture, or province. e.g. NY */
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, and Floor. */
addressLine2?: string | null;
}
/** @oneof */
interface AddressStreetOneOf {
/** Street name and number. */
streetAddress?: StreetAddress;
/** Main address line, usually street and number as free text. */
addressLine?: string | null;
}
interface StreetAddress {
/** Street number. */
number?: string;
/** Street name. */
name?: string;
}
interface AddressLocation {
/** Address latitude. */
latitude?: number | null;
/** Address longitude. */
longitude?: number | null;
}
interface Subdivision {
/** Short subdivision code. */
code?: string;
/** Subdivision full name. */
name?: string;
}
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"
}
/** @enumType */
type SubdivisionTypeWithLiterals = SubdivisionType | 'UNKNOWN_SUBDIVISION_TYPE' | 'ADMINISTRATIVE_AREA_LEVEL_1' | 'ADMINISTRATIVE_AREA_LEVEL_2' | 'ADMINISTRATIVE_AREA_LEVEL_3' | 'ADMINISTRATIVE_AREA_LEVEL_4' | 'ADMINISTRATIVE_AREA_LEVEL_5' | 'COUNTRY';
/** Subdivision Concordance values */
interface StandardDetails {
/**
* subdivision iso-3166-2 code according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). e.g. US-NY, GB-SCT, NO-30
* @maxLength 20
*/
iso31662?: string | null;
}
interface FormSubmission {
/**
* Form ID.
* @readonly
* @format GUID
*/
formId?: string | null;
/**
* Form submission ID.
* @readonly
* @format GUID
*/
submissionId?: string | null;
/** Form submissions. */
submissions?: Record;
}
declare enum AttendanceStatus {
/** Not attending. */
NOT_ATTENDING = "NOT_ATTENDING",
/** Attending. */
ATTENDING = "ATTENDING",
/** In a waiting list. */
IN_WAITLIST = "IN_WAITLIST"
}
/** @enumType */
type AttendanceStatusWithLiterals = AttendanceStatus | 'NOT_ATTENDING' | 'ATTENDING' | 'IN_WAITLIST';
declare enum GuestType {
/** An invited guest, no ticket necessary. */
RSVP = "RSVP",
/** The guest who bought the ticket. */
BUYER = "BUYER",
/** The guest for whom the ticket was bought. */
TICKET_HOLDER = "TICKET_HOLDER"
}
/** @enumType */
type GuestTypeWithLiterals = GuestType | 'RSVP' | 'BUYER' | 'TICKET_HOLDER';
interface AdditionalDetails {
/** Date and time the source entity (RSVP or Order) was created. */
createdDate?: Date | null;
/** Date and time the source entity (RSVP or Order) was updated. */
updatedDate?: Date | null;
/** Rsvp Status */
rsvpStatus?: RsvpStatusWithLiterals;
/** Order Status */
orderStatus?: OrderStatusWithLiterals;
}
declare enum RsvpStatus {
/** Guest is attending the event. */
YES = "YES",
/** Guest isn't attending the event. */
NO = "NO",
/** Guest is on a waitlist. */
WAITLIST = "WAITLIST"
}
/** @enumType */
type RsvpStatusWithLiterals = RsvpStatus | 'YES' | 'NO' | 'WAITLIST';
declare enum OrderStatus {
/** Order status is not available for this request fieldset. */
UNKNOW_ORDER_STATUS = "UNKNOW_ORDER_STATUS",
/** Order is confirmed, no payment is required. */
FREE = "FREE",
/** Order was paid, but the payment gateway suspended the payment. */
PENDING = "PENDING",
/** Order is paid. */
PAID = "PAID",
/** Order is confirmed but has be paid via offline payment. Status needs to be manually updated to `"PAID"`. */
OFFLINE_PENDING = "OFFLINE_PENDING",
/** Order is awaiting for payment at the cashier. */
INITIATED = "INITIATED",
/** Order is canceled. */
CANCELED = "CANCELED",
/** Order payment is declined. */
DECLINED = "DECLINED",
/** Order payment is authorized. */
AUTHORIZED = "AUTHORIZED",
/** Order payment is voided. */
VOIDED = "VOIDED",
/** Order is partially paid with less than the total amount. */
PARTIALLY_PAID = "PARTIALLY_PAID"
}
/** @enumType */
type OrderStatusWithLiterals = OrderStatus | 'UNKNOW_ORDER_STATUS' | 'FREE' | 'PENDING' | 'PAID' | 'OFFLINE_PENDING' | 'INITIATED' | 'CANCELED' | 'DECLINED' | 'AUTHORIZED' | 'VOIDED' | 'PARTIALLY_PAID';
interface GuestCountUpdated {
/** Guest. */
guest?: EventGuest;
/**
* Guest count updates.
* @maxSize 2
*/
guestCountUpdates?: GuestCountUpdate[];
}
interface GuestCountUpdate {
/** Attendance status. */
attendanceStatus?: AttendanceStatusWithLiterals;
/** Total guest count change. */
totalGuestsDelta?: number;
/** Guest count change. */
countDelta?: number;
}
interface MemberEventStatusUpdated {
/**
* Event id.
* @format GUID
*/
eventId?: string | null;
/**
* Member id.
* @format GUID
*/
memberId?: string | null;
/** Member event status. */
status?: MemberEventStatusUpdatedEventTypeWithLiterals;
}
declare enum MemberEventStatusUpdatedEventType {
/**
* Triggered every time a guest with a specified member ID is added to the event.
* This event can also be triggered if an existing guest changed their member ID.
*/
MEMBER_JOINED = "MEMBER_JOINED",
/**
* Triggered every time a guest with a specified member ID is removed from the event.
* This event can also be triggered if an existing guest changed their member ID.
*/
MEMBER_LEFT = "MEMBER_LEFT",
/**
* Triggered every time a guest with a specified member ID whose status is `"ATTENDING"` is added to the event.
* This event can also be triggered if an existing guest changed their member ID or changed their status to `"ATTENDING"`.
*/
ATTENDING_MEMBER_JOINED = "ATTENDING_MEMBER_JOINED",
/**
* Triggered when the last guest with a specified member ID is removed from the event or their status changes to `"NOT_ATTENDING"`.
* Once triggered there are no more attending guests with a specified member ID in the event.
* This event can also be triggered if the last existing guest changed their member ID or their status to `"NOT_ATTENDING"`.
*/
LAST_ATTENDING_MEMBER_LEFT = "LAST_ATTENDING_MEMBER_LEFT"
}
/** @enumType */
type MemberEventStatusUpdatedEventTypeWithLiterals = MemberEventStatusUpdatedEventType | 'MEMBER_JOINED' | 'MEMBER_LEFT' | 'ATTENDING_MEMBER_JOINED' | 'LAST_ATTENDING_MEMBER_LEFT';
interface ContactEventStatusUpdated {
/**
* Event id.
* @format GUID
*/
eventId?: string | null;
/**
* Contact id.
* @format GUID
*/
contactId?: string | null;
/** Contact event status. */
status?: EventTypeWithLiterals;
}
declare enum EventType {
/**
* Triggered every time a guest with a specified contact ID is added to the event.
* This event can also be triggered if an existing guest changed their contact ID.
*/
CONTACT_JOINED = "CONTACT_JOINED",
/**
* Triggered every time a guest with a specified contact ID is removed from the event.
* This event can also be triggered if an existing guest changed their contact ID.
*/
CONTACT_LEFT = "CONTACT_LEFT",
/**
* Triggred when the last guest with a specified contact ID is removed from the event.
* Once triggered there are no more guests with a specified contact ID in the event.
* This event can also be triggered if the last existing guest changed their contact ID.
*/
LAST_CONTACT_LEFT = "LAST_CONTACT_LEFT"
}
/** @enumType */
type EventTypeWithLiterals = EventType | 'CONTACT_JOINED' | 'CONTACT_LEFT' | 'LAST_CONTACT_LEFT';
interface GuestCheckedIn {
/** Event guest */
guest?: EventGuest;
/** Event details */
eventDetails?: EventDetails;
}
interface EventDetails {
/**
* Event title.
* @minLength 1
* @maxLength 120
* @readonly
*/
title?: string | null;
/**
* Event short description.
* @maxLength 500
* @readonly
*/
shortDescription?: string | null;
/**
* Event location.
* @readonly
*/
location?: Location;
/**
* Event date and time settings.
* @readonly
*/
dateAndTimeSettings?: DateAndTimeSettings;
/**
* Event page URL components.
* @readonly
*/
eventPageUrl?: PageUrl;
/**
* Event status.
* @readonly
*/
status?: StatusWithLiterals;
}
interface Location {
/**
* Location name. This value is displayed instead of the address when the location is defined as TBD by setting the `locationTbd` property to `true`.
* @maxLength 50
*/
name?: string | null;
/** Location type. */
type?: LocationTypeWithLiterals;
/** Exact location address. */
address?: CommonAddress;
/** Whether the event location is TBD. */
locationTbd?: boolean | null;
}
declare enum LocationType {
/** Event is on-site at a specific physical location. */
VENUE = "VENUE",
/** Event is online, such as a virtual video conference. */
ONLINE = "ONLINE"
}
/** @enumType */
type LocationTypeWithLiterals = LocationType | 'VENUE' | 'ONLINE';
/** Physical address */
interface CommonAddress extends CommonAddressStreetOneOf {
/** Street address. */
streetAddress?: CommonStreetAddress;
/**
* Primary address information (street and building number).
* @maxLength 250
*/
addressLine?: string | null;
/**
* 2-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format.
* @format COUNTRY
*/
country?: string | null;
/**
* Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2).
* @maxLength 20
*/
subdivision?: string | null;
/**
* City name.
* @maxLength 100
*/
city?: string | null;
/**
* Zip or postal code.
* @maxLength 100
*/
postalCode?: string | null;
/**
* Secondary address information (suite or apartment number and room number).
* @maxLength 250
*/
addressLine2?: string | null;
}
/** @oneof */
interface CommonAddressStreetOneOf {
/** Street address. */
streetAddress?: CommonStreetAddress;
/**
* Primary address information (street and building number).
* @maxLength 250
*/
addressLine?: string | null;
}
interface CommonStreetAddress {
/**
* Street number.
* @maxLength 100
*/
number?: string;
/**
* Street name.
* @maxLength 250
*/
name?: string;
}
interface CommonAddressLocation {
/**
* Address latitude coordinates.
* @min -90
* @max 90
*/
latitude?: number | null;
/**
* Address longitude coordinates.
* @min -180
* @max 180
*/
longitude?: number | null;
}
interface CommonSubdivision {
/**
* Short subdivision code.
* @maxLength 100
*/
code?: string;
/**
* Subdivision full name.
* @maxLength 250
*/
name?: string;
}
declare enum SubdivisionSubdivisionType {
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"
}
/** @enumType */
type SubdivisionSubdivisionTypeWithLiterals = SubdivisionSubdivisionType | 'UNKNOWN_SUBDIVISION_TYPE' | 'ADMINISTRATIVE_AREA_LEVEL_1' | 'ADMINISTRATIVE_AREA_LEVEL_2' | 'ADMINISTRATIVE_AREA_LEVEL_3' | 'ADMINISTRATIVE_AREA_LEVEL_4' | 'ADMINISTRATIVE_AREA_LEVEL_5' | 'COUNTRY';
interface DateAndTimeSettings {
/** Whether the event date and time are TBD. */
dateAndTimeTbd?: boolean | null;
/**
* Message that is displayed when time and date is TBD.
*
* **Note:** This field is only used when the `dateAndTimeTbd` field value is `true`.
* @maxLength 100
*/
dateAndTimeTbdMessage?: string | null;
/**
* Event start date.
*
* **Note:** This field is only returned when the `dateAndTimeTbd` field value is `false`.
*/
startDate?: Date | null;
/**
* Event end date.
*
* **Note:** This field is only returned when the `dateAndTimeTbd` field value is `false`.
*/
endDate?: Date | null;
/**
* Event time zone ID in the [TZ database](https://www.iana.org/time-zones) format.
*
* **Note:** This field is only returned when the `dateAndTimeTbd` field value is `false`.
* @maxLength 100
*/
timeZoneId?: string | null;
/** Whether the end date is hidden in the formatted date and time. */
hideEndDate?: boolean | null;
/** Whether the time zone is displayed in the formatted schedule. */
showTimeZone?: boolean | null;
/**
* Repeating event status.
* @readonly
*/
recurrenceStatus?: RecurrenceStatusStatusWithLiterals;
/** Event repetitions. */
recurringEvents?: Recurrences;
/** Formatted date and time settings. */
formatted?: Formatted;
}
declare enum RecurrenceStatusStatus {
/** Event happens only once and can last multiple days. */
ONE_TIME = "ONE_TIME",
/** A series of events that repeat. */
RECURRING = "RECURRING",
/** Next event in a schedule of recurring events. */
RECURRING_UPCOMING = "RECURRING_UPCOMING",
/** Latest event that ended in a schedule of recurring events. */
RECURRING_RECENTLY_ENDED = "RECURRING_RECENTLY_ENDED",
/** Latest canceled event in a schedule of recurring events */
RECURRING_RECENTLY_CANCELED = "RECURRING_RECENTLY_CANCELED"
}
/** @enumType */
type RecurrenceStatusStatusWithLiterals = RecurrenceStatusStatus | 'ONE_TIME' | 'RECURRING' | 'RECURRING_UPCOMING' | 'RECURRING_RECENTLY_ENDED' | 'RECURRING_RECENTLY_CANCELED';
interface Recurrences {
/**
* Individual event dates for recurring events.
*
* *Note:** Each date must be manually calculated and provided. There is no support for automatic generation using recurrence rules or patterns (for example, "Weekly").
*
* When you create a recurring event:
* - Each occurrence is created as an independent event with its own unique ID.
* - All occurrences in the series share the same `categoryId`, which allows you to identify all events in the recurring series.
* - To retrieve all events in a recurring series, query events by `recurringEvents.categoryId`.
* - Each event in the series can be independently updated or deleted using its individual event ID.
* @maxSize 1000
*/
individualEventDates?: Occurrence[];
/**
* Recurring event category ID.
*
* This read-only field is automatically generated and shared by all events in a recurring series. Use this ID to query and retrieve all occurrences of a recurring event.
* @readonly
* @maxLength 100
*/
categoryId?: string | null;
}
interface Occurrence {
/** Event start date. */
startDate?: Date | null;
/** Event end date. */
endDate?: Date | null;
/**
* Event time zone ID in the [TZ database](https://www.iana.org/time-zones) format.
* @maxLength 100
*/
timeZoneId?: string | null;
/** Whether the time zone is displayed in a formatted schedule. */
showTimeZone?: boolean;
}
interface Formatted {
/**
* Formatted date and time representation.
* Example of formatting when an event lasts multiple days and is in the UTC time zone: `September 1, 2015 at 10:20 AM – September 5, 2015 at 12:14 PM`.
* Example of formatting when an event lasts 1 day and is in the GMT+2 time zone: `February 1, 2018, 12:10 – 2:50 PM GMT+2`.
* @readonly
* @maxLength 500
*/
dateAndTime?: string | null;
/**
* Formatted start date of the event. Empty for TBD schedules.
* @readonly
* @maxLength 500
*/
startDate?: string | null;
/**
* Formatted start time of the event. Empty for TBD schedules.
* @readonly
* @maxLength 500
*/
startTime?: string | null;
/**
* Formatted end date of the event. Empty for TBD schedules or when the end date is hidden.
* @readonly
* @maxLength 500
*/
endDate?: string | null;
/**
* Formatted end time of the event. Empty for TBD schedules or when the end date is hidden.
* @readonly
* @maxLength 500
*/
endTime?: string | null;
}
interface PageUrl {
/**
* The base URL. For premium sites, the base is the domain. For free sites, the base is the Wix site URL (for example, `https://mysite.wixsite.com/mysite`).
* @maxLength 500
*/
base?: string;
/**
* The path to the page. For example, `/product-page/a-product`.
* @maxLength 500
*/
path?: string;
}
declare enum Status {
/** Event is published and scheduled to start. */
UPCOMING = "UPCOMING",
/** Event has started. */
STARTED = "STARTED",
/** Event has ended. */
ENDED = "ENDED",
/** Event is canceled. */
CANCELED = "CANCELED",
/** Event is not public. */
DRAFT = "DRAFT"
}
/** @enumType */
type StatusWithLiterals = Status | 'UPCOMING' | 'STARTED' | 'ENDED' | 'CANCELED' | 'DRAFT';
interface NotifyGuestAction {
/** Event guest. */
guest?: EventGuest;
/** Task context. */
taskContext?: TaskContext;
}
interface TaskContext {
/** Task id. */
id?: string | null;
/** Notify action type. */
type?: NotifyActionTypeWithLiterals;
/** Timing. Used for EVENT_STARTS */
timing?: TimingWithLiterals;
/** Event context. */
event?: EventDetails;
/** Order context. */
order?: OrderDetails;
}
declare enum NotifyActionType {
UNKNOWN = "UNKNOWN",
EMAIL = "EMAIL",
AUTOMATION_TRIGGER = "AUTOMATION_TRIGGER",
PUSH = "PUSH",
EVENT_CANCELED = "EVENT_CANCELED",
EVENT_STARTS = "EVENT_STARTS",
ORDER_CANCELED = "ORDER_CANCELED"
}
/** @enumType */
type NotifyActionTypeWithLiterals = NotifyActionType | 'UNKNOWN' | 'EMAIL' | 'AUTOMATION_TRIGGER' | 'PUSH' | 'EVENT_CANCELED' | 'EVENT_STARTS' | 'ORDER_CANCELED';
declare enum Timing {
/** Instant. */
NOW = "NOW",
/** 24 hours prior. */
STARTS_IN_1_DAY = "STARTS_IN_1_DAY",
/** 3 days prior. */
STARTS_IN_3_DAYS = "STARTS_IN_3_DAYS",
/** 7 days prior. */
STARTS_IN_1_WEEK = "STARTS_IN_1_WEEK",
/** 1 hour prior. */
STARTS_IN_1_HOUR = "STARTS_IN_1_HOUR",
/** 30 minutes prior. */
STARTS_IN_30_MINUTES = "STARTS_IN_30_MINUTES",
/** 2 hours prior. */
STARTS_IN_2_HOURS = "STARTS_IN_2_HOURS"
}
/** @enumType */
type TimingWithLiterals = Timing | 'NOW' | 'STARTS_IN_1_DAY' | 'STARTS_IN_3_DAYS' | 'STARTS_IN_1_WEEK' | 'STARTS_IN_1_HOUR' | 'STARTS_IN_30_MINUTES' | 'STARTS_IN_2_HOURS';
interface OrderDetails {
/** Order status */
orderStatus?: TicketingOrderStatusWithLiterals;
/** Invoice */
invoice?: Invoice;
}
declare enum TicketingOrderStatus {
/** Order status isn't available for this request fieldset. */
NA_ORDER_STATUS = "NA_ORDER_STATUS",
/** Order is confirmed, no payment is required. */
FREE = "FREE",
/** Order was paid, but the payment gateway suspended the payment. */
PENDING = "PENDING",
/** Order is paid. */
PAID = "PAID",
/** Order is confirmed but must be paid via offline payment. Status needs to be manually updated to `"PAID"`. */
OFFLINE_PENDING = "OFFLINE_PENDING",
/** Order is waiting for payment at the cashier. */
INITIATED = "INITIATED",
/** Order is canceled. */
CANCELED = "CANCELED",
/** Order payment is declined. */
DECLINED = "DECLINED",
/** Order payment is authorized. */
AUTHORIZED = "AUTHORIZED",
/** Order payment is voided. */
VOIDED = "VOIDED",
/** Order is partially paid with less than the total amount. */
PARTIALLY_PAID = "PARTIALLY_PAID"
}
/** @enumType */
type TicketingOrderStatusWithLiterals = TicketingOrderStatus | 'NA_ORDER_STATUS' | 'FREE' | 'PENDING' | 'PAID' | 'OFFLINE_PENDING' | 'INITIATED' | 'CANCELED' | 'DECLINED' | 'AUTHORIZED' | 'VOIDED' | 'PARTIALLY_PAID';
interface Invoice {
items?: Item[];
/**
* Total cart amount.
* @deprecated
*/
total?: Money;
/** Discount applied to a cart. */
discount?: Discount;
/** Tax applied to a cart. */
tax?: Tax;
/** Total cart amount before discount, tax, and fees. */
subTotal?: Money;
/**
* Total amount of a cart after discount, tax, and fees.
* Grand total is calculated in the following order:
* 1. Total prices of all items in the cart are calculated.
* 2. Discount is subtracted from the cart, if applicable.
* 3. Tax is added, if applicable.
* 4. Wix ticket service fee is added.
*/
grandTotal?: Money;
/**
* Fees applied to the cart.
* @readonly
*/
fees?: Fee[];
/** Total revenue, excluding fees. Taxes and payment provider fees aren't deducted. */
revenue?: Money;
/** Invoice preview URL. Only returned if the order is paid. */
previewUrl?: string | null;
}
interface Item {
/**
* Unique line item ID.
* @format GUID
*/
id?: string;
/**
* Line item quantity.
* @min 1
* @max 50
*/
quantity?: number;
/** Line item name. */
name?: string;
/** Line item price. */
price?: Money;
/** Total price for line items. Always equal to price * quantity. */
total?: Money;
/** Discount applied to the line item. */
discount?: Discount;
/** Tax applied to the item. */
tax?: Tax;
/**
* Fees applied to the item.
* @readonly
*/
fees?: Fee[];
}
interface Money {
/**
* *Deprecated:** Use `value` instead.
* @format DECIMAL_VALUE
* @deprecated
*/
amount?: string;
/**
* 3-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. For example, `USD`.
* @format CURRENCY
*/
currency?: string;
/**
* Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, starts with a single (-), to indicate that the amount is negative.
* @format DECIMAL_VALUE
*/
value?: string | null;
}
interface Discount {
/** Total discount amount. */
amount?: Money;
/** Total sum after the discount. */
afterDiscount?: Money;
/**
* Discount coupon code.
* @deprecated
*/
code?: string;
/**
* Discount coupon name.
* @deprecated
*/
name?: string;
/**
* Discount coupon ID.
* @deprecated
*/
couponId?: string;
/** Discount items. */
discounts?: DiscountItem[];
}
interface DiscountItem extends DiscountItemDiscountOneOf {
/** Coupon discount. */
coupon?: CouponDiscount;
/** Pricing plan discount. */
paidPlan?: PaidPlanDiscount;
/** Total discount amount. */
amount?: Money;
}
/** @oneof */
interface DiscountItemDiscountOneOf {
/** Coupon discount. */
coupon?: CouponDiscount;
/** Pricing plan discount. */
paidPlan?: PaidPlanDiscount;
}
interface CouponDiscount {
/** Discount coupon name. **Deprecated:** Use `invoice.discounts.coupon.name` instead. */
name?: string;
/** Discount coupon code. **Deprecated:** Use `invoice.discounts.coupon.code` instead. */
code?: string;
/** Discount coupon ID. **Deprecated:** Use `invoice.discounts.coupon.couponId` instead. */
couponId?: string;
}
interface PaidPlanDiscount extends PaidPlanDiscountDiscountOneOf {
/** Discount by percentage applied to tickets. */
percentDiscount?: PercentDiscount;
/** Name of pricing plan. */
name?: string;
}
/** @oneof */
interface PaidPlanDiscountDiscountOneOf {
/** Discount by percentage applied to tickets. */
percentDiscount?: PercentDiscount;
}
interface PercentDiscount {
/**
* Percent rate.
* @decimalValue options { gte:0.01, lte:100, maxScale:2 }
*/
rate?: string;
/** Number of discounted tickets. */
quantityDiscounted?: number;
}
interface Tax {
/** Tax type. */
type?: TaxTypeWithLiterals;
/**
* Tax name.
* @readonly
*/
name?: string;
/**
* Tax rate.
* @format DECIMAL_VALUE
*/
rate?: string;
/** Taxable amount. */
taxable?: Money;
/** Total tax amount. */
amount?: Money;
}
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"
}
/** @enumType */
type TaxTypeWithLiterals = TaxType | 'INCLUDED' | 'ADDED' | 'ADDED_AT_CHECKOUT';
interface Fee {
/** Fee identifier. */
name?: FeeNameWithLiterals;
/** How fee is calculated. */
type?: FeeTypeWithLiterals;
/**
* Fee rate.
* @format DECIMAL_VALUE
* @readonly
*/
rate?: string;
/** Total amount of fee charges. */
amount?: Money;
}
declare enum FeeName {
/** Wix ticket service fee charges applied to the line item. */
WIX_FEE = "WIX_FEE"
}
/** @enumType */
type FeeNameWithLiterals = FeeName | 'WIX_FEE';
declare enum FeeType {
/** Fee is added to the ticket price at checkout. */
FEE_ADDED = "FEE_ADDED",
/** Seller absorbs the fee. It's deducted from the ticket price. */
FEE_INCLUDED = "FEE_INCLUDED",
/** Fee is added to the ticket price at checkout. */
FEE_ADDED_AT_CHECKOUT = "FEE_ADDED_AT_CHECKOUT"
}
/** @enumType */
type FeeTypeWithLiterals = FeeType | 'FEE_ADDED' | 'FEE_INCLUDED' | 'FEE_ADDED_AT_CHECKOUT';
interface GuestEventCanceled {
/** Event guest. */
guest?: EventGuest;
/** Event context. */
event?: EventDetails;
}
interface GuestEventStarts {
/** Event guest. */
guest?: EventGuest;
/** Event context. */
event?: EventDetails;
/** Timing */
timing?: TimingWithLiterals;
}
interface GuestOrderCanceled {
/** Event guest. */
guest?: EventGuest;
/** Event context. */
event?: EventDetails;
/** Order context. */
order?: OrderDetails;
}
interface GuestOrderConfirmed {
/** Order buyer. */
guest?: EventGuest;
/**
* Ticket holders.
* @maxSize 50
*/
ticketHolders?: EventGuest[];
/** Order context. */
order?: OrderDetails;
}
interface DomainEvent extends DomainEventBodyOneOf {
createdEvent?: EntityCreatedEvent;
updatedEvent?: EntityUpdatedEvent;
deletedEvent?: EntityDeletedEvent;
actionEvent?: ActionEvent;
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
id?: string;
/**
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
*/
entityFqdn?: string;
/**
* Event action name, placed at the top level to make it easier for users to dispatch messages.
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
*/
slug?: string;
/** ID of the entity associated with the event. */
entityId?: string;
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
eventTime?: Date | null;
/**
* Whether the event was triggered as a result of a privacy regulation application
* (for example, GDPR).
*/
triggeredByAnonymizeRequest?: boolean | null;
/** If present, indicates the action that triggered the event. */
originatedFrom?: string | null;
/**
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
*/
entityEventSequence?: string | null;
}
/** @oneof */
interface DomainEventBodyOneOf {
createdEvent?: EntityCreatedEvent;
updatedEvent?: EntityUpdatedEvent;
deletedEvent?: EntityDeletedEvent;
actionEvent?: ActionEvent;
}
interface EntityCreatedEvent {
entityAsJson?: string;
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
restoreInfo?: RestoreInfo;
}
interface RestoreInfo {
deletedDate?: Date | null;
}
interface EntityUpdatedEvent {
/**
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
*/
currentEntityAsJson?: string;
}
interface EntityDeletedEvent {
/** Entity that was deleted. */
deletedEntityAsJson?: string | null;
}
interface ActionEvent {
bodyAsJson?: string;
}
interface MessageEnvelope {
/**
* App instance ID.
* @format GUID
*/
instanceId?: string | null;
/**
* Event type.
* @maxLength 150
*/
eventType?: string;
/** The identification type and identity data. */
identity?: IdentificationData;
/** Stringify payload. */
data?: string;
/** Details related to the account */
accountInfo?: AccountInfo;
}
interface IdentificationData extends IdentificationDataIdOneOf {
/**
* ID of a site visitor that has not logged in to the site.
* @format GUID
*/
anonymousVisitorId?: string;
/**
* ID of a site visitor that has logged in to the site.
* @format GUID
*/
memberId?: string;
/**
* ID of a Wix user (site owner, contributor, etc.).
* @format GUID
*/
wixUserId?: string;
/**
* ID of an app.
* @format GUID
*/
appId?: string;
/** @readonly */
identityType?: WebhookIdentityTypeWithLiterals;
}
/** @oneof */
interface IdentificationDataIdOneOf {
/**
* ID of a site visitor that has not logged in to the site.
* @format GUID
*/
anonymousVisitorId?: string;
/**
* ID of a site visitor that has logged in to the site.
* @format GUID
*/
memberId?: string;
/**
* ID of a Wix user (site owner, contributor, etc.).
* @format GUID
*/
wixUserId?: string;
/**
* ID of an app.
* @format GUID
*/
appId?: string;
}
declare enum WebhookIdentityType {
UNKNOWN = "UNKNOWN",
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
MEMBER = "MEMBER",
WIX_USER = "WIX_USER",
APP = "APP"
}
/** @enumType */
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
interface AccountInfo {
/**
* ID of the Wix account associated with the event.
* @format GUID
*/
accountId?: string | null;
/**
* ID of the parent Wix account. Only included when accountId belongs to a child account.
* @format GUID
*/
parentAccountId?: string | null;
/**
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
* @format GUID
*/
siteId?: string | null;
}
interface QueryEventGuestsRequest {
/** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
query: QueryV2;
/**
* Predefined sets of fields to return.
* @maxSize 3
*/
fields?: RequestedFieldsEnumRequestedFieldsWithLiterals[];
}
interface QueryV2 extends QueryV2PagingMethodOneOf {
/** Paging options to limit and skip the number of items. */
paging?: Paging;
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
cursorPaging?: CursorPaging;
/** Filter object in the following format:
`"filter" : { "fieldName1": "value1", "fieldName2":{"$operator":"value2"} }`.
**Example:**
`"filter" : { "eventId": "sd3f-jhds-4fs77", "ticketNumber": {"$startsWith":"478"} }`
See [supported fields and operators](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort) for more information. */
filter?: Record | null;
/** Sort object in the following format:
`[{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]`
**Example:**
`[{"fieldName":"createdDate","direction":"DESC"}]`
See [supported fields](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort) for more information. */
sort?: Sorting[];
/**
* Currently the only supported fieldset is `guestDetails`. The `WIX_EVENTS.READ_GUESTS_DETAILS` permission is required to access the guest details.
See [field projection](https://dev.wix.com/api/rest/getting-started/field-projection) for more information.
* @deprecated Currently the only supported fieldset is `guestDetails`. The `WIX_EVENTS.READ_GUESTS_DETAILS` permission is required to access the guest details.
See [field projection](https://dev.wix.com/api/rest/getting-started/field-projection) for more information.
* @replacedBy fields
* @targetRemovalDate 2024-06-30
*/
fieldsets?: string[];
}
/** @oneof */
interface QueryV2PagingMethodOneOf {
/** Paging options to limit and skip the number of items. */
paging?: Paging;
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
cursorPaging?: CursorPaging;
}
interface Sorting {
/**
* Name of the field to sort by.
* @maxLength 512
*/
fieldName?: string;
/** Sort order. */
order?: SortOrderWithLiterals;
}
declare enum SortOrder {
ASC = "ASC",
DESC = "DESC"
}
/** @enumType */
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
interface Paging {
/**
* Number of items to load.
* @max 1000
*/
limit?: number | null;
/** Number of items to skip in the current sort order. */
offset?: number | null;
}
interface CursorPaging {
/**
* Maximum number of items to return in the results.
* @max 1000
*/
limit?: number | null;
/**
* Pointer to the next or previous page in the list of results.
*
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
* Not relevant for the first request.
* @maxLength 16000
*/
cursor?: string | null;
}
declare enum RequestedFieldsEnumRequestedFields {
/** Returns `guestDetails` and `tickets`. */
GUEST_DETAILS = "GUEST_DETAILS",
/** Returns `totalGuests`. */
GUEST_TOTAL = "GUEST_TOTAL"
}
/** @enumType */
type RequestedFieldsEnumRequestedFieldsWithLiterals = RequestedFieldsEnumRequestedFields | 'GUEST_DETAILS' | 'GUEST_TOTAL';
interface QueryEventGuestsResponse {
/** List of guests. */
guests?: EventGuest[];
/** Metadata for the paginated results. */
pagingMetadata?: PagingMetadataV2;
}
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;
}
interface Cursors {
/**
* Cursor string pointing to the next page in the list of results.
* @maxLength 16000
*/
next?: string | null;
/**
* Cursor pointing to the previous page in the list of results.
* @maxLength 16000
*/
prev?: string | null;
}
interface StreamEventGuestsRequest {
/** Filter. */
filter?: Record | null;
/** Task context. */
taskContext?: TaskContext;
}
interface Empty {
}
interface SecondaryLanguagesRequest {
/**
* Guest event id.
* @format GUID
*/
eventId?: string;
}
interface SecondaryLanguagesResponse {
/**
* Aggregated guests secondary languages.
* @format LANGUAGE
*/
secondaryLanguages?: string[];
/** Aggregated guests languages. */
languages?: Language[];
}
interface Language {
/**
* Guest language.
* @format LANGUAGE
*/
language?: string | null;
/**
* Guest locale.
* @format LANGUAGE_TAG
*/
locale?: string | null;
}
/** Triggered when an order is confirmed. */
interface OrderConfirmed {
/** Date and time the order was confirmed. */
timestamp?: Date | null;
/**
* Site language when the order was initiated.
* @format LANGUAGE
*/
language?: string | null;
/** Notifications silenced for this domain event. */
silent?: boolean | null;
/**
* Locale in which the order was created.
* @format LANGUAGE_TAG
*/
locale?: string | null;
/**
* Event ID to which the order belongs.
* @format GUID
*/
eventId?: string;
/** Unique order number. */
orderNumber?: string;
/** Contact ID associated with the order. */
contactId?: string;
/**
* Member ID associated with the order.
* @format GUID
*/
memberId?: string | null;
/**
* Date and time the order was created.
* @readonly
*/
created?: Date | null;
/**
* Date and time the order was updated.
* @readonly
*/
updated?: Date | null;
/** Buyer first name. */
firstName?: string;
/** Buyer last name. */
lastName?: string;
/** Buyer email address. */
email?: string;
/** Checkout form response. */
checkoutForm?: FormResponse;
/** Order status. */
status?: TicketingOrderStatusWithLiterals;
/** Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc. */
method?: string | null;
/** Tickets (generated after payment). */
tickets?: Ticket[];
/** Invoice. */
invoice?: Invoice;
/** Reservation ID associated with the order. */
reservationId?: string;
}
interface Ticket {
/** Unique issued ticket number. */
ticketNumber?: string;
/**
* Ticket definition ID.
* @format GUID
*/
ticketDefinitionId?: string;
/** Ticket check-in. */
checkIn?: CheckIn;
/** Ticket price. */
price?: Money;
/** Whether ticket is archived. */
archived?: boolean;
/** Guest first name. */
firstName?: string | null;
/** Guest last name. */
lastName?: string | null;
/** Guest email. */
email?: string | null;
/**
* Contact ID associated with this ticket.
* @format GUID
*/
contactId?: string | null;
/** Whether ticket is confirmed */
confirmed?: boolean;
/**
* Member ID associated with this ticket.
* @format GUID
*/
memberId?: string | null;
/** Ticket form response (only assigned tickets contain separate forms). */
form?: FormResponse;
/** Ticket name. */
ticketName?: string;
/** Anonymized tickets no longer contain personally identifiable information (PII). */
anonymized?: boolean;
/** URL and password to online conference */
onlineConferencingLogin?: OnlineConferencingLogin;
/**
* Seat ID associated with this ticket.
* @maxLength 36
*/
seatId?: string | null;
/** Whether ticket is canceled. */
canceled?: boolean | null;
}
interface CheckIn {
/** Time of a ticket's check-in. */
created?: Date | null;
}
/** Triggered when an order is updated. */
interface OrderUpdated {
/** Date and time the order was updated. */
timestamp?: Date | null;
/**
* Site language when the order was initiated.
* @format LANGUAGE
*/
language?: string | null;
/**
* Locale in which the order was created.
* @format LANGUAGE_TAG
*/
locale?: string | null;
/**
* Event ID to which the order belongs.
* @format GUID
*/
eventId?: string;
/** Unique order number. */
orderNumber?: string;
/** Contact ID associated with the order. */
contactId?: string;
/**
* Member ID associated with the order.
* @format GUID
*/
memberId?: string | null;
/**
* Date and time the order was created.
* @readonly
*/
created?: Date | null;
/**
* Date and time the order was updated.
* @readonly
*/
updated?: Date | null;
/** Buyer first name. */
firstName?: string;
/** Buyer last name. */
lastName?: string;
/** Buyer email. */
email?: string;
/** Checkout form response. */
checkoutForm?: FormResponse;
/** Whether order is confirmed - occurs once payment gateway processes the payment and funds reach merchant's account. */
confirmed?: boolean;
/** Order status. */
status?: TicketingOrderStatusWithLiterals;
/** Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc. */
method?: string | null;
/** Tickets generated after payment. */
tickets?: Ticket[];
/** Whether order was archived and excluded from results. */
archived?: boolean;
/** Whether event was triggered by GDPR delete request. */
triggeredByAnonymizeRequest?: boolean;
}
/** Triggered when an order is deleted. */
interface OrderDeleted {
/** Date and time the order was deleted. */
timestamp?: Date | null;
/**
* Event ID to which the order belongs.
* @format GUID
*/
eventId?: string;
/** Unique order number. */
orderNumber?: string;
/** Contact ID associated with the order. */
contactId?: string;
/**
* Member ID associated with the order.
* @format GUID
*/
memberId?: string | null;
/**
* Date and time the order was created.
* @readonly
*/
created?: Date | null;
/**
* Date and time the order was updated.
* @readonly
*/
updated?: Date | null;
/** Whether the order was anonymized by GDPR delete. */
anonymized?: boolean;
/** Order type. */
orderType?: OrderTypeWithLiterals;
/** Whether the event was triggered by GDPR delete request. */
triggeredByAnonymizeRequest?: boolean;
/** Tickets generated after payment. */
tickets?: Ticket[];
}
declare enum OrderType {
/** Buyer form is used for all tickets. */
UNASSIGNED_TICKETS = "UNASSIGNED_TICKETS",
/** Each order ticket has its own form. */
ASSIGNED_TICKETS = "ASSIGNED_TICKETS"
}
/** @enumType */
type OrderTypeWithLiterals = OrderType | 'UNASSIGNED_TICKETS' | 'ASSIGNED_TICKETS';
interface EventDeleted {
/** Event deleted timestamp in ISO UTC format. */
timestamp?: Date | null;
/**
* Event ID.
* @format GUID
*/
eventId?: string;
/** Event title. */
title?: string;
/**
* Event creator user ID.
* @format GUID
*/
userId?: string | null;
}
interface Task {
key?: TaskKey;
executeAt?: Date | null;
payload?: string | null;
}
interface TaskKey {
appId?: string;
instanceId?: string;
subjectId?: string | null;
}
interface ListGuestListPreviewsRequest {
/**
* Event ids.
* @format GUID
* @maxSize 50
*/
eventIds?: string[];
/** Cursor paging. */
cursorPaging?: CursorPaging;
/**
* Requested fields.
* @maxSize 5
*/
fields?: RequestedFieldsWithLiterals[];
}
declare enum RequestedFields {
/** Member guests. */
MEMBER_GUESTS = "MEMBER_GUESTS",
/** Waitlist count. */
WAITLIST_COUNT = "WAITLIST_COUNT"
}
/** @enumType */
type RequestedFieldsWithLiterals = RequestedFields | 'MEMBER_GUESTS' | 'WAITLIST_COUNT';
interface ListGuestListPreviewsResponse {
/**
* List of guests.
* @maxSize 50
*/
previews?: GuestListPreview[];
/** Metadata for the paginated results. */
pagingMetadata?: PagingMetadataV2;
}
interface GuestListPreview {
/**
* Event id.
* @format GUID
*/
eventId?: string;
/** Attending guests count. */
attending?: GuestCount;
/** Waiting guests count. */
inWaitlist?: GuestCount;
/** Not attending guests count. */
notAttending?: GuestCount;
/** Latest attending members. */
latestAttendingMembers?: MemberGuests;
/** If present, indicates that current member is attending. */
currentMemberGuest?: MemberGuest;
}
interface GuestCount {
/** Total guest count. For Rsvp Event every RSVP guest and additional guest count, for Ticketed Event count of TICKET_HOLDER */
totalEventGuests?: number;
/** EventGuest count (RSVP, TICKET_HOLDER, BUYER); */
count?: number;
}
interface MemberGuests {
/**
* Member guests
* @maxSize 8
*/
guests?: MemberGuest[];
}
interface MemberGuest {
/**
* Member id
* @format GUID
*/
memberId?: string;
}
interface UpdateGuestRequest {
/** Updated guest */
guest?: EventGuest;
/** Guest revision */
revision?: string | null;
}
interface UpdateGuestResponse {
/** Updated guest */
guest?: EventGuest;
}
type __PublicMethodMetaInfo = {
getUrl: (context: any) => string;
httpMethod: K;
path: string;
pathParams: M;
__requestType: T;
__originalRequestType: S;
__responseType: Q;
__originalResponseType: R;
};
declare function queryGuests(): __PublicMethodMetaInfo<'POST', {}, QueryEventGuestsRequest$1, QueryEventGuestsRequest, QueryEventGuestsResponse$1, QueryEventGuestsResponse>;
export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, type AdditionalDetails as AdditionalDetailsOriginal, type AddressLocation as AddressLocationOriginal, type Address as AddressOriginal, type AddressStreetOneOf as AddressStreetOneOfOriginal, AttendanceStatus as AttendanceStatusOriginal, type AttendanceStatusWithLiterals as AttendanceStatusWithLiteralsOriginal, type CheckIn as CheckInOriginal, type CommonAddressLocation as CommonAddressLocationOriginal, type CommonAddress as CommonAddressOriginal, type CommonAddressStreetOneOf as CommonAddressStreetOneOfOriginal, type CommonStreetAddress as CommonStreetAddressOriginal, type CommonSubdivision as CommonSubdivisionOriginal, type ContactEventStatusUpdated as ContactEventStatusUpdatedOriginal, type CouponDiscount as CouponDiscountOriginal, type CursorPaging as CursorPagingOriginal, type Cursors as CursorsOriginal, type DateAndTimeSettings as DateAndTimeSettingsOriginal, type DiscountItemDiscountOneOf as DiscountItemDiscountOneOfOriginal, type DiscountItem as DiscountItemOriginal, type Discount as DiscountOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type EventDeleted as EventDeletedOriginal, type EventDetails as EventDetailsOriginal, type EventGuest as EventGuestOriginal, EventType as EventTypeOriginal, type EventTypeWithLiterals as EventTypeWithLiteralsOriginal, FeeName as FeeNameOriginal, type FeeNameWithLiterals as FeeNameWithLiteralsOriginal, type Fee as FeeOriginal, FeeType as FeeTypeOriginal, type FeeTypeWithLiterals as FeeTypeWithLiteralsOriginal, type FormResponse as FormResponseOriginal, type FormSubmission as FormSubmissionOriginal, type FormattedAddress as FormattedAddressOriginal, type Formatted as FormattedOriginal, type GuestCheckedIn as GuestCheckedInOriginal, type GuestCount as GuestCountOriginal, type GuestCountUpdate as GuestCountUpdateOriginal, type GuestCountUpdated as GuestCountUpdatedOriginal, type GuestDetails as GuestDetailsOriginal, type GuestEventCanceled as GuestEventCanceledOriginal, type GuestEventStarts as GuestEventStartsOriginal, type GuestListPreview as GuestListPreviewOriginal, type GuestOrderCanceled as GuestOrderCanceledOriginal, type GuestOrderConfirmed as GuestOrderConfirmedOriginal, GuestType as GuestTypeOriginal, type GuestTypeWithLiterals as GuestTypeWithLiteralsOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type InputValue as InputValueOriginal, type Invoice as InvoiceOriginal, type Item as ItemOriginal, type Language as LanguageOriginal, type ListGuestListPreviewsRequest as ListGuestListPreviewsRequestOriginal, type ListGuestListPreviewsResponse as ListGuestListPreviewsResponseOriginal, type Location as LocationOriginal, LocationType as LocationTypeOriginal, type LocationTypeWithLiterals as LocationTypeWithLiteralsOriginal, MemberEventStatusUpdatedEventType as MemberEventStatusUpdatedEventTypeOriginal, type MemberEventStatusUpdatedEventTypeWithLiterals as MemberEventStatusUpdatedEventTypeWithLiteralsOriginal, type MemberEventStatusUpdated as MemberEventStatusUpdatedOriginal, type MemberGuest as MemberGuestOriginal, type MemberGuests as MemberGuestsOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type Money as MoneyOriginal, NotifyActionType as NotifyActionTypeOriginal, type NotifyActionTypeWithLiterals as NotifyActionTypeWithLiteralsOriginal, type NotifyGuestAction as NotifyGuestActionOriginal, type Occurrence as OccurrenceOriginal, type OnlineConferencingLogin as OnlineConferencingLoginOriginal, type OrderConfirmed as OrderConfirmedOriginal, type OrderDeleted as OrderDeletedOriginal, type OrderDetails as OrderDetailsOriginal, OrderStatus as OrderStatusOriginal, type OrderStatusWithLiterals as OrderStatusWithLiteralsOriginal, OrderType as OrderTypeOriginal, type OrderTypeWithLiterals as OrderTypeWithLiteralsOriginal, type OrderUpdated as OrderUpdatedOriginal, type PageUrl as PageUrlOriginal, type PagingMetadataV2 as PagingMetadataV2Original, type Paging as PagingOriginal, type PaidPlanDiscountDiscountOneOf as PaidPlanDiscountDiscountOneOfOriginal, type PaidPlanDiscount as PaidPlanDiscountOriginal, type PercentDiscount as PercentDiscountOriginal, type QueryEventGuestsRequest as QueryEventGuestsRequestOriginal, type QueryEventGuestsResponse as QueryEventGuestsResponseOriginal, type QueryV2 as QueryV2Original, type QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOfOriginal, RecurrenceStatusStatus as RecurrenceStatusStatusOriginal, type RecurrenceStatusStatusWithLiterals as RecurrenceStatusStatusWithLiteralsOriginal, type Recurrences as RecurrencesOriginal, RequestedFieldsEnumRequestedFields as RequestedFieldsEnumRequestedFieldsOriginal, type RequestedFieldsEnumRequestedFieldsWithLiterals as RequestedFieldsEnumRequestedFieldsWithLiteralsOriginal, RequestedFields as RequestedFieldsOriginal, type RequestedFieldsWithLiterals as RequestedFieldsWithLiteralsOriginal, type RestoreInfo as RestoreInfoOriginal, RsvpStatus as RsvpStatusOriginal, type RsvpStatusWithLiterals as RsvpStatusWithLiteralsOriginal, type SecondaryLanguagesRequest as SecondaryLanguagesRequestOriginal, type SecondaryLanguagesResponse as SecondaryLanguagesResponseOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, type StandardDetails as StandardDetailsOriginal, Status as StatusOriginal, type StatusWithLiterals as StatusWithLiteralsOriginal, type StreamEventGuestsRequest as StreamEventGuestsRequestOriginal, type StreetAddress as StreetAddressOriginal, type Subdivision as SubdivisionOriginal, SubdivisionSubdivisionType as SubdivisionSubdivisionTypeOriginal, type SubdivisionSubdivisionTypeWithLiterals as SubdivisionSubdivisionTypeWithLiteralsOriginal, SubdivisionType as SubdivisionTypeOriginal, type SubdivisionTypeWithLiterals as SubdivisionTypeWithLiteralsOriginal, type TaskContext as TaskContextOriginal, type TaskKey as TaskKeyOriginal, type Task as TaskOriginal, type Tax as TaxOriginal, TaxType as TaxTypeOriginal, type TaxTypeWithLiterals as TaxTypeWithLiteralsOriginal, type TicketDetails as TicketDetailsOriginal, type TicketGuestDetails as TicketGuestDetailsOriginal, type Ticket as TicketOriginal, TicketingOrderStatus as TicketingOrderStatusOriginal, type TicketingOrderStatusWithLiterals as TicketingOrderStatusWithLiteralsOriginal, Timing as TimingOriginal, type TimingWithLiterals as TimingWithLiteralsOriginal, type UpdateGuestRequest as UpdateGuestRequestOriginal, type UpdateGuestResponse as UpdateGuestResponseOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, queryGuests };