@wix/events 1.0.13 → 1.0.15

package/build/es/src/events-v1-rsvp.universal.d.ts

@@ -0,0 +1,652 @@
+export declare const __debug: {
+    verboseLogging: {
+        on: () => boolean;
+        off: () => boolean;
+    };
+};
+export interface Rsvp {
+    /** RSVP ID. */
+    _id?: string;
+    /** Event ID. */
+    eventId?: string;
+    /** Contact ID associated with this RSVP. */
+    contactId?: string;
+    /** Member ID associated with this RSVP. */
+    memberId?: string;
+    /** RSVP created timestamp. */
+    created?: Date;
+    /** RSVP modified timestamp. */
+    modified?: Date;
+    /** First name. */
+    firstName?: string;
+    /** Last name. */
+    lastName?: string;
+    /** Guest email. */
+    email?: string;
+    /** RSVP form response. */
+    rsvpForm?: FormResponse;
+    /** RSVP response status. */
+    status?: RsvpStatus;
+    /** Total number of attendees. */
+    totalGuests?: number;
+    /** List of guests. */
+    guests?: Guest[];
+    /** Whether RSVP is anonymized by GDPR delete. */
+    anonymized?: boolean;
+}
+export interface FormResponse {
+    /** Input values entered upon ticket order. */
+    inputValues?: InputValue[];
+}
+export interface InputValue {
+    /** Unique input name. */
+    inputName?: string;
+    /** Text value representation. */
+    value?: string;
+    /** Text value vector. */
+    values?: string[];
+}
+export interface FormattedAddress {
+    /** One line address representation. */
+    formatted?: string;
+    /** Address components (optional). */
+    address?: Address;
+}
+/** Physical address */
+export interface Address extends AddressStreetOneOf {
+    /** Country code. */
+    country?: string | null;
+    /** Subdivision. Usually a state, region, prefecture, or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/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, and Floor. */
+    addressLine2?: string | null;
+    /** Street name and number. */
+    streetAddress?: StreetAddress;
+    /** Main address line, usually street and number as free text. */
+    addressLine1?: string | null;
+}
+/** @oneof */
+export interface AddressStreetOneOf {
+    /** Street name and number. */
+    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 {
+    /** Address latitude. */
+    latitude?: number | null;
+    /** Address longitude. */
+    longitude?: number | null;
+}
+export interface Subdivision {
+    /** Short subdivision 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 declare enum RsvpStatus {
+    YES = "YES",
+    NO = "NO",
+    WAITING = "WAITING"
+}
+export interface Guest {
+    /** Index in the RSVP guest list. */
+    index?: number;
+    /** Guest full name. */
+    fullName?: string;
+    /** Guest check-in. */
+    checkIn?: CheckIn;
+    /** Unique guest ID per RSVP. */
+    _id?: number;
+}
+export interface CheckIn {
+    /** Time of check-in */
+    created?: Date;
+}
+export interface ListRsvpRequest {
+    /** Number of items to skip. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */
+    offset?: number;
+    /** Number of items to load. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */
+    limit?: number;
+    /** Controls which data is returned. See [Fieldset](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_rsvp-fieldset). */
+    fieldset?: RsvpFieldset[];
+    /** Event ID. */
+    eventId?: string[];
+    /** RSVP ID. */
+    rsvpId?: string[];
+    /** RSVP status. */
+    status?: RsvpStatus[];
+    /** Site member ID. */
+    memberId?: string[];
+    /**
+     * Facet counts 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-rsvps).
+     */
+    facet?: string[];
+    /** Textual search filter - search is performed on "full_name" and "email". */
+    searchPhrase?: string;
+    /** Event creator id filter, by default any. */
+    eventCreatorId?: 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-rsvps).
+     */
+    sort?: string;
+    /** Contact ID. */
+    contactId?: string[];
+    /** RSVP tag */
+    tag?: RsvpTag[];
+}
+export declare enum RsvpFieldset {
+    /** Include RSVP details: created, modified, first_name, last_name, etc. */
+    DETAILS = "DETAILS",
+    /** Include rsvp_form. */
+    FORM = "FORM",
+    /** Include RSVP email. */
+    CONTACT_DETAILS = "CONTACT_DETAILS"
+}
+export declare enum RsvpTag {
+    /** Return only rsvps with all guests checked-in */
+    FULLY_CHECKED_IN = "FULLY_CHECKED_IN",
+    /** Return only rsvps with not all guests checked-in */
+    NOT_FULLY_CHECKED_IN = "NOT_FULLY_CHECKED_IN",
+    /** Return only member rsvp */
+    MEMBER = "MEMBER"
+}
+export interface ListRsvpResponse {
+    /** Total RSVPs matching the given filters. */
+    total?: number;
+    /** Offset. */
+    offset?: number;
+    /** Limit. */
+    limit?: number;
+    /** RSVP list. */
+    rsvps?: Rsvp[];
+    /** Facet query result. */
+    facets?: Record<string, FacetCounts>;
+    /** Meta data of search results. */
+    searchMetaData?: SearchMetaData;
+    /** Rsvp data enriched facets. */
+    rsvpFacets?: RsvpFacets;
+}
+export interface FacetCounts {
+    /** Facet counts aggregated per value */
+    counts?: Record<string, number>;
+}
+export interface SearchMetaData {
+    /** Search results */
+    results?: Result[];
+}
+export interface Result {
+    /** Entity ID */
+    _id?: string;
+    /**
+     * Entity score.
+     * Higher is more relevant to search phrase.
+     */
+    score?: string;
+}
+export interface RsvpFacets {
+    /** Filter facets. */
+    facets?: Record<string, RsvpFacetCounts>;
+}
+export interface RsvpFacetCounts {
+    /** Facet totals, aggregated per filter. */
+    counts?: Record<string, Counts>;
+}
+export interface Counts {
+    /** Number of RSVPs. */
+    count?: number;
+    /** Number of guests within RSVPs. */
+    guests?: number;
+    /** Number of guests who have checked-in. */
+    guestsCheckIn?: number;
+}
+export interface QueryRsvpRequest {
+    /** Offset. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */
+    offset?: number;
+    /** Limit. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */
+    limit?: number;
+    /** Control which data is returned. See [Fieldset](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_rsvp-fieldset). */
+    fieldset?: RsvpFieldset[];
+    /** 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-rsvps). */
+    filter?: Record<string, any> | null;
+    /** Site member ID. */
+    memberId?: 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-rsvps).
+     */
+    facet?: string[];
+    /** Textual search filter - search is performed on "guests.full_name". */
+    searchPhrase?: string;
+    /** Event creator ID. */
+    eventCreatorId?: 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-rsvps).
+     */
+    sort?: string;
+    /** Contact ID. */
+    contactId?: string[];
+    /** RSVP tag */
+    tag?: RsvpTag[];
+}
+export interface QueryRsvpResponse {
+    /** Total RSVPs matching the given filters. */
+    total?: number;
+    /** Offset. */
+    offset?: number;
+    /** Limit. */
+    limit?: number;
+    /** RSVP list. */
+    rsvps?: Rsvp[];
+    /** Facet query result. */
+    facets?: Record<string, FacetCounts>;
+    /** Meta data of search results. */
+    searchMetaData?: SearchMetaData;
+    /** Rsvp data enriched facets. */
+    rsvpFacets?: RsvpFacets;
+}
+export interface GetRsvpRequest {
+    /** Event ID. */
+    eventId?: string;
+    /** RSVP ID. */
+    rsvpId: string;
+    /** Controls which data is returned. See [Fieldset](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_rsvp-fieldset). */
+    fieldset?: RsvpFieldset[];
+}
+export interface GetRsvpResponse {
+    /** RSVP. */
+    rsvp?: Rsvp;
+}
+export interface CreateRsvpRequest {
+    /** Event ID. */
+    eventId?: string;
+    /** RSVP form response. */
+    form?: FormResponse;
+    /** RSVP status. */
+    status?: RsvpStatus;
+    /** Member ID of the RSVP. */
+    memberId?: string | null;
+    /**
+     * Create RSVP options.
+     * WIX_EVENTS.MANAGE_RSVP permission is required.
+     */
+    options?: ModificationOptions;
+}
+export interface ModificationOptions {
+    /** Whether to ignore notification settings (when hen true, no notifications to contact or user are sent). */
+    silent?: boolean;
+    /** Whether to create/update regardless of event guest limit. */
+    ignoreLimits?: boolean;
+    /** Whether to ignore the form validation. */
+    ignoreFormValidation?: boolean;
+}
+export interface CreateRsvpResponse {
+    /** Created RSVP. */
+    rsvp?: Rsvp;
+    /** "Add to calendar" links. */
+    calendarLinks?: CalendarLinks;
+}
+export interface CalendarLinks {
+    /** "Add to Google calendar" URL. */
+    google?: string;
+    /** "Download ICS calendar file" URL. */
+    ics?: string;
+}
+export interface RsvpCreated {
+    /** RSVP created timestamp in ISO UTC format. */
+    timestamp?: Date;
+    /** Site language when RSVP created */
+    language?: string | null;
+    /** Notifications silenced for this domain event. */
+    silent?: boolean | null;
+    /** Event ID. */
+    eventId?: string;
+    /** RSVP ID. */
+    rsvpId?: string;
+    /** Contact ID associated with this RSVP. */
+    contactId?: string;
+    /** Member ID associated with this RSVP. */
+    memberId?: string | null;
+    /** Guest first name. */
+    firstName?: string;
+    /** Guest last name. */
+    lastName?: string;
+    /** Guest email. */
+    email?: string;
+    /** RSVP form response. */
+    rsvpForm?: FormResponse;
+    /** RSVP response status. */
+    status?: RsvpStatus;
+    /** List of all guests. */
+    guests?: Guest[];
+}
+export interface UpdateRsvpRequest {
+    /** Event ID. */
+    eventId: string;
+    /** RSVP ID. */
+    rsvpId: string;
+    /** Set of field paths, specifying which parts of RSVP to update. */
+    fields: string[];
+    /** RSVP form response. */
+    rsvpForm?: FormResponse;
+    /** RSVP response status. */
+    status?: RsvpStatus;
+    /**
+     * Update RSVP options.
+     * WIX_EVENTS.MANAGE_RSVP permission is required.
+     */
+    options?: ModificationOptions;
+}
+export interface UpdateRsvpResponse {
+    /** Updated RSVP. */
+    rsvp?: Rsvp;
+}
+export interface RsvpUpdated {
+    /** RSVP updated timestamp in ISO UTC format. */
+    timestamp?: Date;
+    /** Site language when RSVP created */
+    language?: string | null;
+    /** Event ID. */
+    eventId?: string;
+    /** RSVP ID. */
+    rsvpId?: string;
+    /** Contact ID associated with this RSVP. */
+    contactId?: string;
+    /** Member ID associated with this RSVP. */
+    memberId?: string | null;
+    /** RSVP created timestamp. */
+    created?: Date;
+    /** Guest first name. */
+    firstName?: string;
+    /** Guest last name. */
+    lastName?: string;
+    /** Guest email. */
+    email?: string;
+    /** RSVP form response. */
+    rsvpForm?: FormResponse;
+    /** RSVP response status. */
+    status?: RsvpStatus;
+    /** List of the guests. */
+    guests?: Guest[];
+}
+export interface BulkUpdateRsvpRequest {
+    /** Event ID. */
+    eventId: string;
+    /** RSVPs to update. */
+    rsvpId?: string[];
+    /** Set of fields to update. */
+    fields?: string[];
+    /** New RSVP status. */
+    status?: RsvpStatus;
+}
+export interface BulkUpdateRsvpResponse {
+    /** Updated RSVPs. */
+    rsvps?: Rsvp[];
+}
+export interface DeleteRsvpRequest {
+    /** Event ID. */
+    eventId: string;
+    /** RSVPs to delete. When not returned, all RSVPs associated with this event are deleted. */
+    rsvps?: string[];
+}
+export interface DeleteRsvpResponse {
+}
+export interface RsvpDeleted {
+    /** RSVP deleted timestamp in ISO UTC format. */
+    timestamp?: Date;
+    /** Event ID. */
+    eventId?: string;
+    /** RSVP ID. */
+    rsvpId?: string;
+    /** Contact ID associated with this RSVP. */
+    contactId?: string;
+    /** Member ID associated with this RSVP. */
+    memberId?: string | null;
+    /** Whether RSVP was anonymized by GDPR delete. */
+    anonymized?: boolean;
+}
+export interface CheckInRsvpRequest {
+    /** Event ID. */
+    eventId: string;
+    /** RSVP ID to check-in. */
+    rsvpId: string;
+    /** Guest IDs to check-in. */
+    guestId?: number[];
+}
+export interface CheckInRsvpResponse {
+    /** Updated RSVP. */
+    rsvp?: Rsvp;
+}
+export interface DeleteRsvpCheckInRequest {
+    /** Event ID. */
+    eventId: string;
+    /** RSVP ID to delete check-in. */
+    rsvpId: string;
+    /** Guest IDs to delete check-in. */
+    guestId?: number[];
+}
+export interface DeleteRsvpCheckInResponse {
+    /** Updated RSVP. */
+    rsvp?: Rsvp;
+}
+/**
+ * Retrieves a list of up to 100 RSVPs, 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-rsvps).
+ * @public
+ * @documentationMaturity preview
+ */
+export declare function listRsvp(options?: ListRsvpOptions): Promise<ListRsvpResponse>;
+export interface ListRsvpOptions {
+    /** Number of items to skip. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */
+    offset?: number;
+    /** Number of items to load. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */
+    limit?: number;
+    /** Controls which data is returned. See [Fieldset](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_rsvp-fieldset). */
+    fieldset?: RsvpFieldset[];
+    /** Event ID. */
+    eventId?: string[];
+    /** RSVP ID. */
+    rsvpId?: string[];
+    /** RSVP status. */
+    status?: RsvpStatus[];
+    /** Site member ID. */
+    memberId?: string[];
+    /**
+     * Facet counts 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-rsvps).
+     */
+    facet?: string[];
+    /** Textual search filter - search is performed on "full_name" and "email". */
+    searchPhrase?: string;
+    /** Event creator id filter, by default any. */
+    eventCreatorId?: 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-rsvps).
+     */
+    sort?: string;
+    /** Contact ID. */
+    contactId?: string[];
+    /** RSVP tag */
+    tag?: RsvpTag[];
+}
+/**
+ * Retrieves a list of up to 100 RSVPs, supporting [structurized queries](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-rsvps).
+ * @public
+ * @documentationMaturity preview
+ */
+export declare function queryRsvp(options?: QueryRsvpOptions): Promise<QueryRsvpResponse>;
+export interface QueryRsvpOptions {
+    /** Offset. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */
+    offset?: number;
+    /** Limit. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */
+    limit?: number;
+    /** Control which data is returned. See [Fieldset](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_rsvp-fieldset). */
+    fieldset?: RsvpFieldset[];
+    /** 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-rsvps). */
+    filter?: Record<string, any> | null;
+    /** Site member ID. */
+    memberId?: 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-rsvps).
+     */
+    facet?: string[];
+    /** Textual search filter - search is performed on "guests.full_name". */
+    searchPhrase?: string;
+    /** Event creator ID. */
+    eventCreatorId?: 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-rsvps).
+     */
+    sort?: string;
+    /** Contact ID. */
+    contactId?: string[];
+    /** RSVP tag */
+    tag?: RsvpTag[];
+}
+/**
+ * Retrieves an RSVP.
+ * @param rsvpId - RSVP ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField rsvpId
+ */
+export declare function getRsvp(rsvpId: string, options?: GetRsvpOptions): Promise<GetRsvpResponse>;
+export interface GetRsvpOptions {
+    /** Event ID. */
+    eventId?: string;
+    /** Controls which data is returned. See [Fieldset](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_rsvp-fieldset). */
+    fieldset?: RsvpFieldset[];
+}
+/**
+ * Creates an RSVP, associated with a contact of the site.
+ * @public
+ * @documentationMaturity preview
+ */
+export declare function createRsvp(options?: CreateRsvpOptions): Promise<CreateRsvpResponse>;
+export interface CreateRsvpOptions {
+    /** Event ID. */
+    eventId?: string;
+    /** RSVP form response. */
+    form?: FormResponse;
+    /** RSVP status. */
+    status?: RsvpStatus;
+    /** Member ID of the RSVP. */
+    memberId?: string | null;
+    /**
+     * Create RSVP options.
+     * WIX_EVENTS.MANAGE_RSVP permission is required.
+     */
+    options?: ModificationOptions;
+}
+/**
+ * Updates an RSVP. See [partial updates](https://dev.wix.com/api/wix-events/partial-updates).
+ * @param rsvpId - RSVP ID.
+ * @param eventId - Event ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField eventId
+ * @requiredField options.fields
+ * @requiredField rsvpId
+ */
+export declare function updateRsvp(rsvpId: string, eventId: string, options?: UpdateRsvpOptions): Promise<UpdateRsvpResponse>;
+export interface UpdateRsvpOptions {
+    /** Set of field paths, specifying which parts of RSVP to update. */
+    fields: string[];
+    /** RSVP form response. */
+    rsvpForm?: FormResponse;
+    /** RSVP response status. */
+    status?: RsvpStatus;
+    /**
+     * Update RSVP options.
+     * WIX_EVENTS.MANAGE_RSVP permission is required.
+     */
+    options?: ModificationOptions;
+}
+/**
+ * Updates multiple RSVPs - status only.
+ * @param eventId - Event ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField eventId
+ */
+export declare function bulkUpdateRsvp(eventId: string, options?: BulkUpdateRsvpOptions): Promise<BulkUpdateRsvpResponse>;
+export interface BulkUpdateRsvpOptions {
+    /** RSVPs to update. */
+    rsvpId?: string[];
+    /** Set of fields to update. */
+    fields?: string[];
+    /** New RSVP status. */
+    status?: RsvpStatus;
+}
+/**
+ * Deletes an RSVP.
+ * @param eventId - Event ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField eventId
+ */
+export declare function deleteRsvp(eventId: string, options?: DeleteRsvpOptions): Promise<void>;
+export interface DeleteRsvpOptions {
+    /** RSVPs to delete. When not returned, all RSVPs associated with this event are deleted. */
+    rsvps?: string[];
+}
+/**
+ * Checks-in an RSVP.
+ * @param eventId - Event ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField eventId
+ * @requiredField options.rsvpId
+ */
+export declare function checkInRsvp(eventId: string, options?: CheckInRsvpOptions): Promise<CheckInRsvpResponse>;
+export interface CheckInRsvpOptions {
+    /** RSVP ID to check-in. */
+    rsvpId: string;
+    /** Guest IDs to check-in. */
+    guestId?: number[];
+}
+/**
+ * Deletes an RSVP check-in.
+ * @param eventId - Event ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField eventId
+ * @requiredField options.rsvpId
+ */
+export declare function deleteRsvpCheckIn(eventId: string, options?: DeleteRsvpCheckInOptions): Promise<DeleteRsvpCheckInResponse>;
+export interface DeleteRsvpCheckInOptions {
+    /** RSVP ID to delete check-in. */
+    rsvpId: string;
+    /** Guest IDs to delete check-in. */
+    guestId?: number[];
+}