@wix/events 1.0.174 → 1.0.176

package/build/cjs/src/events-v1-ticket.types.d.ts

@@ -1,791 +0,0 @@
-export interface TicketingTicket {
-    /** Unique ticket number (issued automatically). */
-    ticketNumber?: string;
-    /** Associated order number. */
-    orderNumber?: string;
-    /** Ticket definition ID. */
-    ticketDefinitionId?: string;
-    /** Ticket name. */
-    name?: string;
-    /** Ticket price. */
-    price?: Money;
-    /**
-     * Whether ticket requires payment.
-     * @readonly
-     */
-    free?: boolean;
-    /** Ticket policy (as displayed in PDF). */
-    policy?: string;
-    /** Deprecated, use `check_in_url`. */
-    qrCode?: string;
-    /** Ticket check-in. */
-    checkIn?: CheckIn;
-    /** Associated order status. */
-    orderStatus?: OrderStatus;
-    /** Whether order and ticket are visible in order list. */
-    orderArchived?: boolean;
-    /** Buyer full name. */
-    orderFullName?: string;
-    /** Guest full name. */
-    guestFullName?: string | null;
-    /** Guest personal details. */
-    guestDetails?: GuestDetails;
-    /** Whether ticket is visible in guest list. */
-    archived?: boolean;
-    /** Deprecated, use `ticket_pdf_url`. */
-    ticketPdf?: string;
-    /** Ticket owner member ID. */
-    memberId?: string | null;
-    /**
-     * Whether ticket was anonymized by GDPR delete.
-     * Anonymized tickets no longer contain personally identifiable information (PII).
-     */
-    anonymized?: boolean;
-    /**
-     * Ticket check-in URL.
-     * Shown as QR code image in PDF.
-     * Format: `https://www.wixevents.com/check-in/{ticket number},{event id}`
-     * Example: `https://www.wixevents.com/check-in/AAAA-AAAA-BB021,00000000-0000-0000-0000-000000000000`
-     */
-    checkInUrl?: string;
-    /** URL for ticket PDF download. */
-    ticketPdfUrl?: string;
-    /** Associated order checkout channel type */
-    channel?: ChannelType;
-    /**
-     * URL to download ticket in .pkpass format for Apple Wallet
-     * @readonly
-     */
-    walletPassUrl?: string;
-}
-export interface Money {
-    /** *Deprecated:** Use `value` instead. */
-    amount?: string;
-    /** ISO 4217 format of the currency i.e. `USD`. */
-    currency?: string;
-    /** Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, a single (-), to indicate that the amount is negative. */
-    value?: string | null;
-}
-export interface CheckIn {
-    /** Time of check-in */
-    created?: Date;
-}
-export declare enum OrderStatus {
-    /** Order status not available for this request fieldset */
-    NA_ORDER_STATUS = "NA_ORDER_STATUS",
-    /** Order is confirmed, no payment required */
-    FREE = "FREE",
-    /** Order was paid but payment gateway suspended the payment. Eventually changes to PAID */
-    PENDING = "PENDING",
-    /** Order paid via payment gateway */
-    PAID = "PAID",
-    /** Order confirmed but has to be paid via offline payment and status manually updated to PAID */
-    OFFLINE_PENDING = "OFFLINE_PENDING",
-    /** Order is awaiting for payment in Cashier */
-    INITIATED = "INITIATED",
-    /** Order was canceled */
-    CANCELED = "CANCELED",
-    /** Order payment was declined */
-    DECLINED = "DECLINED"
-}
-export interface GuestDetails {
-    /** Whether ticket belongs to assigned guest. */
-    guestAssigned?: boolean;
-    /** Guest first name. */
-    firstName?: string | null;
-    /** Guest last name. */
-    lastName?: string | null;
-    /** Guest email. */
-    email?: string | null;
-    /** Full form response. */
-    form?: FormResponse;
-    /** Contact ID associated with this guest. */
-    contactId?: string | null;
-}
-export interface FormResponse {
-    inputValues?: InputValue[];
-}
-export interface InputValue {
-    inputName?: string;
-    value?: string;
-    values?: string[];
-}
-export interface FormattedAddress {
-    /** One line address representation. */
-    formatted?: string;
-    /** Address components (optional). */
-    address?: Address;
-}
-/** Physical address */
-export 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. */
-    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;
-}
-/** @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 ChannelType {
-    /** Buyer created order via one of the online channels (website, mobile app, etc.) */
-    ONLINE = "ONLINE",
-    /** Order created and money collected by the sales person */
-    OFFLINE_POS = "OFFLINE_POS"
-}
-export interface TicketDetails {
-    /** Unique seat id in the event venue. */
-    seatId?: string | null;
-    /**
-     * Optional sector label.
-     * @readonly
-     */
-    sectionLabel?: string | null;
-    /**
-     * Area label.
-     * @readonly
-     */
-    areaLabel?: string | null;
-    /**
-     * Table label.
-     * @readonly
-     */
-    tableLabel?: string | null;
-    /**
-     * Row label.
-     * @readonly
-     */
-    rowLabel?: string | null;
-    /**
-     * Seat label in a row or table.
-     * @readonly
-     */
-    seatLabel?: string | null;
-    /** Number of places in the spot. If not provided - defaults to 1. */
-    capacity?: number | null;
-    /** Custom pricing of ticket. */
-    priceOverride?: string | null;
-    /** Pricing option id. */
-    pricingOptionId?: string | null;
-    /**
-     * Pricing option name.
-     * @readonly
-     */
-    pricingOptionName?: string | null;
-}
-export interface ListTicketsRequest {
-    /** Event IDs. */
-    eventId: string[];
-    /** Offset. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */
-    offset?: number;
-    /** Number of items to load per page. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */
-    limit?: number;
-    /** Order numbers. */
-    orderNumber?: string[];
-    /** Ticket numbers. */
-    ticketNumber?: string[];
-    /** Textual search filter - search is performed on "orderFullName", "guestFullName", and "ticketNumber". */
-    searchPhrase?: string;
-    /** Order statuses. */
-    orderStatus?: OrderStatus[];
-    /** Set of fields to return in the response. See [Fieldsets](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_ticket-fieldset). */
-    fieldset?: TicketFieldset[];
-    /** Ticket states. */
-    state?: State[];
-    /** Site member IDs. */
-    memberId?: string[];
-    /**
-     * Filter facets.
-     * See [supported facets](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-tickets).
-     */
-    facet?: string[];
-    /**
-     * Sort order. Defaults to "ticket_number: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-tickets).
-     */
-    sort?: string;
-    /** Guest contact IDs. */
-    contactId?: string[];
-    /** Ticket definition IDs. */
-    ticketDefinitionId?: string[];
-}
-export declare enum TicketFieldset {
-    /** Include guest details in ticket response */
-    GUEST_DETAILS = "GUEST_DETAILS",
-    /** Include ticket details in ticket response */
-    TICKET_DETAILS = "TICKET_DETAILS",
-    /** Include individual guest form in ticket response */
-    GUEST_FORM = "GUEST_FORM"
-}
-export declare enum State {
-    /** Returns only archived orders' tickets */
-    ORDER_ARCHIVED = "ORDER_ARCHIVED",
-    /** Returns only non-archived orders' tickets */
-    ORDER_ACTIVE = "ORDER_ACTIVE",
-    /** Returns only archived tickets */
-    TICKET_ARCHIVED = "TICKET_ARCHIVED",
-    /** Returns only non-archived tickets */
-    TICKET_ACTIVE = "TICKET_ACTIVE",
-    /** Returns only checked-in tickets */
-    CHECKED_IN = "CHECKED_IN",
-    /** Returns only non-checked-in tickets */
-    NON_CHECKED_IN = "NON_CHECKED_IN",
-    /** Returns only free tickets */
-    FREE = "FREE",
-    /** Returns only paid tickets */
-    PAID = "PAID",
-    /** Returns only member tickets */
-    MEMBER = "MEMBER"
-}
-export interface ListTicketsResponse {
-    /** Total tickets matching the given filters. */
-    total?: number;
-    /** Offset. */
-    offset?: number;
-    /** Limit. */
-    limit?: number;
-    /** Tickets. */
-    tickets?: TicketingTicket[];
-    /** Facets. */
-    facets?: Record<string, FacetCounts>;
-}
-export interface FacetCounts {
-    /** Facet counts aggregated per value */
-    counts?: Record<string, number>;
-}
-export interface TicketFacets {
-    /** Filter facets. */
-    facets?: Record<string, TicketFacetCounts>;
-}
-export interface TicketFacetCounts {
-    /** Facet totals, aggregated per filter. */
-    counts?: Record<string, Counts>;
-}
-export interface Counts {
-    /** Number of tickets. */
-    count?: number;
-    /** Number of checked in tickets. */
-    checkedIn?: number;
-}
-export interface GetTicketRequest {
-    /** Event ID. */
-    eventId: string;
-    /** Unique ticket number. */
-    ticketNumber: string;
-    /** Set of fields to return in the response. See [Fieldsets](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_ticket-fieldset). */
-    fieldset?: TicketFieldset[];
-}
-export interface GetTicketResponse {
-    /** Ticket. */
-    ticket?: TicketingTicket;
-}
-export interface CheckInTicketRequest {
-    /** Event ID. */
-    eventId: string;
-    /** Tickets to check-in. */
-    ticketNumber?: string[];
-}
-export interface CheckInTicketResponse {
-    /** Updated tickets. */
-    tickets?: TicketingTicket[];
-}
-export interface OrderUpdated {
-    /** Order updated timestamp in ISO UTC format. */
-    timestamp?: Date;
-    /** Site language when Order initiated */
-    language?: string | null;
-    /** Locale in which Order was created. */
-    locale?: string | null;
-    /** Event ID. */
-    eventId?: string;
-    /** Unique order number. */
-    orderNumber?: string;
-    /** Contact ID associated with this order. */
-    contactId?: string;
-    /** Member ID associated with this order. */
-    memberId?: string | null;
-    /**
-     * Order created timestamp.
-     * @readonly
-     */
-    created?: Date;
-    /**
-     * Order updated timestamp.
-     * @readonly
-     */
-    updated?: Date;
-    /** 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?: OrderStatus;
-    /** 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;
-}
-export interface Ticket {
-    /** Unique issued ticket number. */
-    ticketNumber?: string;
-    /** Ticket definition ID. */
-    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. */
-    contactId?: string | null;
-    /** Whether ticket is confirmed */
-    confirmed?: boolean;
-    /** Member ID associated with this ticket. */
-    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;
-}
-export interface OnlineConferencingLogin {
-    /**
-     * Link URL to the online conference.
-     * @readonly
-     */
-    link?: string;
-    /**
-     * Password for the online conference.
-     * @readonly
-     */
-    password?: string | null;
-}
-export interface DeleteTicketCheckInRequest {
-    /** Event ID. */
-    eventId: string;
-    /** Tickets to delete check-ins for. */
-    ticketNumber?: string[];
-}
-export interface DeleteTicketCheckInResponse {
-    /** Updated tickets. */
-    tickets?: TicketingTicket[];
-}
-export interface UpdateTicketRequest {
-    /** Event ID. */
-    eventId: string;
-    /** Unique ticket number. */
-    ticketNumber: string;
-    /** Whether ticket is archived. */
-    archived?: boolean;
-    /** Assigned guest details. */
-    guestDetails?: GuestDetailsUpdate;
-}
-export interface GuestDetailsUpdate {
-    /**
-     * Assigned guest form.
-     * To update non-assigned guest form, use [Update Order](https://dev.wix.com/api/rest/wix-events/wix-events/order/update-order).
-     *
-     * Does not support partial updates - entire form object will be replaced when `guestDetails.form` is masked.
-     */
-    form?: FormResponse;
-}
-export interface UpdateTicketResponse {
-    /** Updated ticket. */
-    ticket?: TicketingTicket;
-}
-export interface BulkUpdateTicketsRequest {
-    /** Event ID. */
-    eventId: string;
-    /** Unique ticket numbers. */
-    ticketNumber?: string[];
-    /** Whether tickets are archived. */
-    archived?: boolean;
-}
-export interface BulkUpdateTicketsResponse {
-    /** Updated tickets. */
-    tickets?: TicketingTicket[];
-}
-export interface GetDemoTicketRequest {
-    /** Ticket definition ID. */
-    definitionId?: string;
-}
-export interface GetDemoTicketResponse {
-    /** Ticket. */
-    ticket?: TicketingTicket;
-}
-export interface ListTicketsResponseNonNullableFields {
-    total: number;
-    offset: number;
-    limit: number;
-    tickets: {
-        ticketNumber: string;
-        orderNumber: string;
-        ticketDefinitionId: string;
-        name: string;
-        price?: {
-            amount: string;
-            currency: string;
-        };
-        free: boolean;
-        policy: string;
-        qrCode: string;
-        orderStatus: OrderStatus;
-        orderArchived: boolean;
-        orderFullName: string;
-        guestDetails?: {
-            guestAssigned: boolean;
-            form?: {
-                inputValues: {
-                    inputName: string;
-                    value: string;
-                    values: string[];
-                    address?: {
-                        formatted: string;
-                        address?: {
-                            streetAddress?: {
-                                number: string;
-                                name: string;
-                                apt: string;
-                            };
-                            subdivisions: {
-                                code: string;
-                                name: string;
-                                type: SubdivisionType;
-                            }[];
-                        };
-                    };
-                }[];
-            };
-        };
-        archived: boolean;
-        ticketPdf: string;
-        anonymized: boolean;
-        checkInUrl: string;
-        ticketPdfUrl: string;
-        channel: ChannelType;
-        walletPassUrl: string;
-    }[];
-    ticketFacets?: {
-        facets?: {
-            counts?: {
-                count: number;
-                checkedIn: number;
-            };
-        };
-    };
-}
-export interface GetTicketResponseNonNullableFields {
-    ticket?: {
-        ticketNumber: string;
-        orderNumber: string;
-        ticketDefinitionId: string;
-        name: string;
-        price?: {
-            amount: string;
-            currency: string;
-        };
-        free: boolean;
-        policy: string;
-        qrCode: string;
-        orderStatus: OrderStatus;
-        orderArchived: boolean;
-        orderFullName: string;
-        guestDetails?: {
-            guestAssigned: boolean;
-            form?: {
-                inputValues: {
-                    inputName: string;
-                    value: string;
-                    values: string[];
-                    address?: {
-                        formatted: string;
-                        address?: {
-                            streetAddress?: {
-                                number: string;
-                                name: string;
-                                apt: string;
-                            };
-                            subdivisions: {
-                                code: string;
-                                name: string;
-                                type: SubdivisionType;
-                            }[];
-                        };
-                    };
-                }[];
-            };
-        };
-        archived: boolean;
-        ticketPdf: string;
-        anonymized: boolean;
-        checkInUrl: string;
-        ticketPdfUrl: string;
-        channel: ChannelType;
-        walletPassUrl: string;
-    };
-}
-export interface CheckInTicketResponseNonNullableFields {
-    tickets: {
-        ticketNumber: string;
-        orderNumber: string;
-        ticketDefinitionId: string;
-        name: string;
-        price?: {
-            amount: string;
-            currency: string;
-        };
-        free: boolean;
-        policy: string;
-        qrCode: string;
-        orderStatus: OrderStatus;
-        orderArchived: boolean;
-        orderFullName: string;
-        guestDetails?: {
-            guestAssigned: boolean;
-            form?: {
-                inputValues: {
-                    inputName: string;
-                    value: string;
-                    values: string[];
-                    address?: {
-                        formatted: string;
-                        address?: {
-                            streetAddress?: {
-                                number: string;
-                                name: string;
-                                apt: string;
-                            };
-                            subdivisions: {
-                                code: string;
-                                name: string;
-                                type: SubdivisionType;
-                            }[];
-                        };
-                    };
-                }[];
-            };
-        };
-        archived: boolean;
-        ticketPdf: string;
-        anonymized: boolean;
-        checkInUrl: string;
-        ticketPdfUrl: string;
-        channel: ChannelType;
-        walletPassUrl: string;
-    }[];
-}
-export interface DeleteTicketCheckInResponseNonNullableFields {
-    tickets: {
-        ticketNumber: string;
-        orderNumber: string;
-        ticketDefinitionId: string;
-        name: string;
-        price?: {
-            amount: string;
-            currency: string;
-        };
-        free: boolean;
-        policy: string;
-        qrCode: string;
-        orderStatus: OrderStatus;
-        orderArchived: boolean;
-        orderFullName: string;
-        guestDetails?: {
-            guestAssigned: boolean;
-            form?: {
-                inputValues: {
-                    inputName: string;
-                    value: string;
-                    values: string[];
-                    address?: {
-                        formatted: string;
-                        address?: {
-                            streetAddress?: {
-                                number: string;
-                                name: string;
-                                apt: string;
-                            };
-                            subdivisions: {
-                                code: string;
-                                name: string;
-                                type: SubdivisionType;
-                            }[];
-                        };
-                    };
-                }[];
-            };
-        };
-        archived: boolean;
-        ticketPdf: string;
-        anonymized: boolean;
-        checkInUrl: string;
-        ticketPdfUrl: string;
-        channel: ChannelType;
-        walletPassUrl: string;
-    }[];
-}
-export interface UpdateTicketResponseNonNullableFields {
-    ticket?: {
-        ticketNumber: string;
-        orderNumber: string;
-        ticketDefinitionId: string;
-        name: string;
-        price?: {
-            amount: string;
-            currency: string;
-        };
-        free: boolean;
-        policy: string;
-        qrCode: string;
-        orderStatus: OrderStatus;
-        orderArchived: boolean;
-        orderFullName: string;
-        guestDetails?: {
-            guestAssigned: boolean;
-            form?: {
-                inputValues: {
-                    inputName: string;
-                    value: string;
-                    values: string[];
-                    address?: {
-                        formatted: string;
-                        address?: {
-                            streetAddress?: {
-                                number: string;
-                                name: string;
-                                apt: string;
-                            };
-                            subdivisions: {
-                                code: string;
-                                name: string;
-                                type: SubdivisionType;
-                            }[];
-                        };
-                    };
-                }[];
-            };
-        };
-        archived: boolean;
-        ticketPdf: string;
-        anonymized: boolean;
-        checkInUrl: string;
-        ticketPdfUrl: string;
-        channel: ChannelType;
-        walletPassUrl: string;
-    };
-}
-export interface BulkUpdateTicketsResponseNonNullableFields {
-    tickets: {
-        ticketNumber: string;
-        orderNumber: string;
-        ticketDefinitionId: string;
-        name: string;
-        price?: {
-            amount: string;
-            currency: string;
-        };
-        free: boolean;
-        policy: string;
-        qrCode: string;
-        orderStatus: OrderStatus;
-        orderArchived: boolean;
-        orderFullName: string;
-        guestDetails?: {
-            guestAssigned: boolean;
-            form?: {
-                inputValues: {
-                    inputName: string;
-                    value: string;
-                    values: string[];
-                    address?: {
-                        formatted: string;
-                        address?: {
-                            streetAddress?: {
-                                number: string;
-                                name: string;
-                                apt: string;
-                            };
-                            subdivisions: {
-                                code: string;
-                                name: string;
-                                type: SubdivisionType;
-                            }[];
-                        };
-                    };
-                }[];
-            };
-        };
-        archived: boolean;
-        ticketPdf: string;
-        anonymized: boolean;
-        checkInUrl: string;
-        ticketPdfUrl: string;
-        channel: ChannelType;
-        walletPassUrl: string;
-    }[];
-}