@wix/events 1.0.13 → 1.0.15

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

@@ -0,0 +1,1439 @@
+export declare const __debug: {
+    verboseLogging: {
+        on: () => boolean;
+        off: () => boolean;
+    };
+};
+export interface Order {
+    /** Unique order number. */
+    orderNumber?: string;
+    /** Reservation ID. */
+    reservationId?: string;
+    /**
+     * Payment snapshot ID.
+     * Empty for FREE order.
+     * @readonly
+     */
+    snapshotId?: string;
+    /** Event ID. */
+    eventId?: string;
+    /** Contact ID of buyer (resolved using email address). */
+    contactId?: string;
+    /** Member ID of buyer (if relevant). */
+    memberId?: string;
+    /**
+     * RSVP created timestamp.
+     * @readonly
+     */
+    created?: Date;
+    /** Guest first name. */
+    firstName?: string;
+    /** Guest last name. */
+    lastName?: string;
+    /** Guest email. */
+    email?: string;
+    /** Checkout form response. When each purchased ticket is assigned to a guest, guest forms are returned for each ticket, and buyer info is returned. */
+    checkoutForm?: FormResponse;
+    /** Whether the order is confirmed (triggered once payment gateway processes the payment and funds reach the merchant's account). */
+    confirmed?: boolean;
+    /** Order status. */
+    status?: OrderStatus;
+    /** Payment method used for purchase, e.g., "payPal", "creditCard", etc. */
+    method?: string;
+    /** Tickets ordered. */
+    ticketsQuantity?: number;
+    /** Total order price. */
+    totalPrice?: Money;
+    /** URL to ticket PDF. */
+    ticketsPdf?: string;
+    /** Tickets (generated after payment). */
+    tickets?: TicketingTicket[];
+    /** Whether the order is archived. */
+    archived?: boolean;
+    /** Whether the order is anonymized by GDPR delete. */
+    anonymized?: boolean;
+    /** Guest full name. */
+    fullName?: string;
+    /** Order invoice. */
+    invoice?: Invoice;
+    /** Whether all tickets in order are checked-in. */
+    fullyCheckedIn?: boolean;
+    /** Internal order payment details */
+    paymentDetails?: PaymentDetails;
+    /** Checkout channel type */
+    channel?: ChannelType;
+}
+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 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 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 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 CheckIn {
+    /** Time of check-in */
+    created?: Date;
+}
+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 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;
+}
+export interface Invoice {
+    /** Items listed in the invoice. */
+    items?: Item[];
+    /** Total cart amount. */
+    total?: Money;
+    /** Discount applied to cart. */
+    discount?: Discount;
+    /** Tax applied to cart. */
+    tax?: Tax;
+    /** Total cart amount before discount, tax, and fees. */
+    subTotal?: Money;
+    /**
+     * Total amount of 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 service fee is added.
+     */
+    grandTotal?: Money;
+    /**
+     * Fees applied to the cart.
+     * @readonly
+     */
+    fees?: Fee[];
+    /** Total revenue, excluding fees. (Taxes and payment provider fees are not deducted). */
+    revenue?: Money;
+    /** URL to invoice preview. Returned only if order is paid. */
+    previewUrl?: string | null;
+}
+export interface Item {
+    /** Unique line item ID. */
+    _id?: string;
+    /** Line item quantity. */
+    quantity?: number;
+    /** Line item mame. */
+    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[];
+}
+export interface Discount {
+    /** Total discount amount. */
+    amount?: Money;
+    /** Total charge after applied discount. */
+    afterDiscount?: Money;
+    /** Discount coupon code. */
+    code?: string;
+    /** Discount coupon name. */
+    name?: string;
+    /** Discount coupon ID. */
+    couponId?: string;
+    /** Discount items. */
+    discounts?: DiscountItem[];
+}
+export interface DiscountItem extends DiscountItemDiscountOneOf {
+    /** Total discount amount. */
+    amount?: Money;
+    /** Coupon discount. */
+    coupon?: CouponDiscount;
+    /** Pricing plan discount. */
+    paidPlan?: PaidPlanDiscount;
+}
+/** @oneof */
+export interface DiscountItemDiscountOneOf {
+    /** Coupon discount. */
+    coupon?: CouponDiscount;
+    /** Pricing plan discount. */
+    paidPlan?: PaidPlanDiscount;
+}
+export interface CouponDiscount {
+    /** Discount coupon name. */
+    name?: string;
+    /** Discount coupon code. */
+    code?: string;
+    /** Discount coupon ID. */
+    couponId?: string;
+}
+export interface PaidPlanDiscount extends PaidPlanDiscountDiscountOneOf {
+    /** Name of pricing plan. */
+    name?: string;
+    /** Discount by percentage applied to tickets. */
+    percentDiscount?: PercentDiscount;
+}
+/** @oneof */
+export interface PaidPlanDiscountDiscountOneOf {
+    /** Discount by percentage applied to tickets. */
+    percentDiscount?: PercentDiscount;
+}
+export interface PercentDiscount {
+    /** Percent rate. */
+    rate?: string;
+    /** Number of discounted tickets. */
+    quantityDiscounted?: number;
+}
+export interface Tax {
+    /** Tax type. */
+    type?: TaxType;
+    /**
+     * Tax name.
+     * @readonly
+     */
+    name?: string;
+    /** Tax rate. */
+    rate?: string;
+    /** Taxable amount. */
+    taxable?: Money;
+    /** Total tax amount. */
+    amount?: Money;
+}
+export declare enum TaxType {
+    /** Tax is included in the ticket price */
+    INCLUDED = "INCLUDED",
+    /** Tax is added to the order at the checkout */
+    ADDED = "ADDED",
+    /** Tax is added to the final total at the checkout */
+    ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
+}
+export interface Fee {
+    /** Fee identifier. */
+    name?: FeeName;
+    /** How fee is calculated. */
+    type?: FeeType;
+    /**
+     * Fee rate.
+     * @readonly
+     */
+    rate?: string;
+    /** Total amount of fee charges. */
+    amount?: Money;
+}
+export declare enum FeeName {
+    /** Wix service fee charges applied to the line item. */
+    WIX_FEE = "WIX_FEE"
+}
+export declare enum FeeType {
+    /** Fee is added to the ticket price at checkout */
+    FEE_ADDED = "FEE_ADDED",
+    /** Seller absorbs the fee. It is 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"
+}
+export interface PaymentDetails {
+    /** Wix Payments transaction */
+    transaction?: PaymentTransaction;
+}
+export interface PaymentTransaction {
+    /**
+     * Wix Payments transaction id
+     * @readonly
+     */
+    transactionId?: string;
+    /**
+     * Transaction Payment method e.g., "payPal", "creditCard", etc.
+     * @readonly
+     */
+    method?: string;
+}
+export interface OrderDeleted {
+    /** Order deleted timestamp in ISO UTC format. */
+    timestamp?: Date;
+    /** 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;
+    /** Whether order was anonymized by GDPR delete. */
+    anonymized?: boolean;
+    /** Order type. */
+    orderType?: OrderType;
+    /** Whether event was triggered by GDPR delete request. */
+    triggeredByAnonymizeRequest?: boolean;
+    /** Tickets generated after payment. */
+    tickets?: Ticket[];
+}
+export 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"
+}
+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;
+    /** Anonymized tickets no longer contain personally identifiable information (PII). */
+    anonymized?: boolean;
+}
+export interface ListOrdersRequest {
+    /** Offset. */
+    offset?: number;
+    /** Limit. */
+    limit?: number;
+    /** Controls which data is returned. Fieldsets are `TICKETS`, `DETAILS`, `FORM`, and `INVOICE`. */
+    fieldset?: OrderFieldset[];
+    /** Status. */
+    status?: OrderStatus[];
+    /** Event ID. */
+    eventId?: string[];
+    /** Order number. */
+    orderNumber?: string[];
+    /** Site member ID. */
+    memberId?: string[];
+    /** Field facets, */
+    facet?: string[];
+    /** Textual search filter - search is performed on "full_name", "email" and "order_number". */
+    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-orders).
+     */
+    sort?: string;
+    /** Order tag. */
+    tag?: OrderTag[];
+}
+export declare enum OrderFieldset {
+    /** Include tickets in response */
+    TICKETS = "TICKETS",
+    /** Include order details: status, first_name, last_name, email, created, etc. */
+    DETAILS = "DETAILS",
+    /** Include checkout_form */
+    FORM = "FORM",
+    /** Include invoice */
+    INVOICE = "INVOICE"
+}
+export declare enum OrderTag {
+    /** Return only confirmed orders */
+    CONFIRMED = "CONFIRMED",
+    /** Return only unconfirmed orders */
+    UNCONFIRMED = "UNCONFIRMED",
+    /** Return only member orders */
+    MEMBER = "MEMBER",
+    /** Return only archived orders */
+    ARCHIVED = "ARCHIVED",
+    /** Return only non archived orders */
+    NON_ARCHIVED = "NON_ARCHIVED",
+    /** Return only orders with all guests checked-in */
+    FULLY_CHECKED_IN = "FULLY_CHECKED_IN",
+    /** Return only orders with no guests checked-in */
+    NOT_FULLY_CHECKED_IN = "NOT_FULLY_CHECKED_IN"
+}
+export interface ListOrdersResponse {
+    /** Total orders matching the given filters. */
+    total?: number;
+    /** Offset. */
+    offset?: number;
+    /** Limit. */
+    limit?: number;
+    /** Orders. */
+    orders?: Order[];
+    /** Filter facets. */
+    facets?: Record<string, FacetCounts>;
+    /** Meta data of search results. */
+    searchMetaData?: SearchMetaData;
+    /** Order data enriched facets. */
+    orderFacets?: OrderFacets;
+}
+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 OrderFacets {
+    /** Filter facets. */
+    facets?: Record<string, OrderFacetCounts>;
+}
+export interface OrderFacetCounts {
+    /** Facet counts aggregated per value */
+    counts?: Record<string, Counts>;
+}
+export interface Counts {
+    /** Number or orders */
+    count?: number;
+    /** Number of tickets within orders */
+    tickets?: number;
+    /** Number of tickets with check-in */
+    ticketsCheckIn?: number;
+}
+export interface GetOrderRequest {
+    /** Event ID. */
+    eventId: string;
+    /** Unique order number. */
+    orderNumber: string;
+    /** Controls which data is returned. Fieldsets are `TICKETS`, `DETAILS`, `FORM`, and `INVOICE`. */
+    fieldset?: OrderFieldset[];
+}
+export interface GetOrderResponse {
+    /** Requested order. */
+    order?: Order;
+    /** "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 UpdateOrderRequest {
+    /** Event ID. */
+    eventId: string;
+    /** Unique order number. */
+    orderNumber: string;
+    /** Set of field paths to update. */
+    fields: string[];
+    /** Checkout form. */
+    checkoutForm?: FormResponse;
+    /** Whether order is archived. */
+    archived?: boolean;
+}
+export interface UpdateOrderResponse {
+    /** Updated order. */
+    order?: Order;
+}
+export interface OrderUpdated {
+    /** Order updated timestamp in ISO UTC format. */
+    timestamp?: Date;
+    /** Site language when Order initiated */
+    language?: 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;
+    /** 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 BulkUpdateOrdersRequest {
+    /** Event ID. */
+    eventId: string;
+    orderNumber?: string[];
+    /** Set of fields to update. */
+    fields?: string[];
+    /** Whether to archive the order. */
+    archived?: boolean;
+}
+export interface BulkUpdateOrdersResponse {
+    /** Updated orders. */
+    orders?: Order[];
+}
+export interface ConfirmOrderRequest {
+    /** Event ID. */
+    eventId: string;
+    /** Order numbers. */
+    orderNumber?: string[];
+}
+export interface ConfirmOrderResponse {
+    /** Confirmed orders. */
+    orders?: Order[];
+}
+export interface GetSummaryRequest {
+    /** Event ID. */
+    eventId?: string | null;
+}
+export interface GetSummaryResponse {
+    /** Ticket sales grouped by currency. */
+    sales?: TicketSales[];
+}
+export interface TicketSales {
+    /** Total balance of confirmed transactions. */
+    total?: Money;
+    /** Total number of confirmed orders. */
+    totalOrders?: number;
+    /** Total number of tickets purchased. */
+    totalTickets?: number;
+    /** Total revenue, excluding fees (taxes and payment provider fees are not deducted). */
+    revenue?: Money;
+}
+export interface GetInvoicePreviewRequest {
+    /** Event ID. */
+    eventId?: string;
+    /** Order number. */
+    orderNumber?: string;
+}
+export interface RawHttpResponse {
+    body?: Uint8Array;
+    statusCode?: number | null;
+    headers?: HeadersEntry[];
+}
+export interface HeadersEntry {
+    key?: string;
+    value?: string;
+}
+export interface GetPaymentInfoRequest {
+    /** Event ID. */
+    eventId?: string;
+    /** Order number. */
+    orderNumber?: string;
+}
+export interface GetPaymentInfoResponse {
+    transactions?: PaymentTransactionSummary[];
+    status?: string | null;
+    /** @readonly */
+    transactionId?: string | null;
+}
+export interface PaymentTransactionSummary {
+    /**
+     * Wix Payments transaction id
+     * @readonly
+     */
+    transactionId?: string;
+    /**
+     * Final transaction status
+     * @readonly
+     */
+    finalTransactionStatus?: string;
+    /** Transaction events */
+    events?: PaymentTransactionEvent[];
+}
+export interface PaymentTransactionEvent {
+    /**
+     * Order snapshot id
+     * @readonly
+     */
+    snapshotId?: string;
+    /**
+     * Transaction status
+     * @readonly
+     */
+    transactionStatus?: string;
+    /**
+     * Transaction Payment method e.g., "payPal", "creditCard", etc.
+     * @readonly
+     */
+    paymentMethod?: string;
+    /**
+     * Transaction payment amount
+     * @readonly
+     */
+    paymentAmount?: Money;
+    /**
+     * Crated date
+     * @readonly
+     */
+    _createdDate?: Date;
+    /**
+     * Reason code
+     * @readonly
+     */
+    reasonCode?: string | null;
+    /**
+     * Refunded amount
+     * @readonly
+     */
+    refundedAmount?: Money;
+}
+export interface OrderConfirmed {
+    /** Order confirmation timestamp in ISO UTC. */
+    timestamp?: Date;
+    /** Site language when Order initiated */
+    language?: string | null;
+    /** Notifications silenced for this domain event. */
+    silent?: boolean | 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;
+    /** Buyer first name. */
+    firstName?: string;
+    /** Buyer last name. */
+    lastName?: string;
+    /** Buyer email address. */
+    email?: string;
+    /** Checkout form response. */
+    checkoutForm?: FormResponse;
+    /** 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[];
+    /** Invoice. */
+    invoice?: Invoice;
+    /** Reservation ID associated with this order. */
+    reservationId?: string;
+}
+export interface OrderPaid {
+    /** Order paid timestamp in ISO UTC. */
+    timestamp?: Date;
+    /** Event ID. */
+    eventId?: string;
+    /** Unique order number. */
+    orderNumber?: string;
+    /** Reservation ID associated with this order. */
+    reservationId?: string;
+}
+export interface ReservationCreated {
+    /** Reservation created timestamp in ISO UTC format. */
+    timestamp?: Date;
+    /** Event ID. */
+    eventId?: string;
+    /**
+     * Reservation ID.
+     * Can be used to retrieve a reservation invoice.
+     */
+    reservationId?: string;
+    /** Reservation expiration timestamp. */
+    expires?: Date;
+    /** Reservation status. */
+    status?: ReservationStatus;
+}
+export declare enum ReservationStatus {
+    /**
+     * Reservation is pending confirmation.
+     * The reservation will expire after the expiration due time.
+     */
+    RESERVATION_PENDING = "RESERVATION_PENDING",
+    /** The reservation was confirmed and will not expire. */
+    RESERVATION_CONFIRMED = "RESERVATION_CONFIRMED",
+    /** The reservation was canceled because of non payment. */
+    RESERVATION_CANCELED = "RESERVATION_CANCELED",
+    /** The reservation was canceled manually by the buyer. */
+    RESERVATION_CANCELED_MANUALLY = "RESERVATION_CANCELED_MANUALLY",
+    /** The reservation has expired. */
+    RESERVATION_EXPIRED = "RESERVATION_EXPIRED"
+}
+export interface ReservationUpdated {
+    /** Reservation updated timestamp. */
+    timestamp?: Date;
+    /** Event ID. */
+    eventId?: string;
+    /**
+     * Reservation ID.
+     * Can be used to retrieve a reservation invoice.
+     */
+    reservationId?: string;
+    /** Reservation status. */
+    status?: ReservationStatus;
+    /** Reservation expiration timestamp. */
+    expires?: Date;
+}
+export interface GetCheckoutOptionsRequest {
+}
+export interface GetCheckoutOptionsResponse {
+    /** Whether any payment method is configured and available for payment. */
+    paymentMethodConfigured?: boolean;
+    /** Whether coupons are accepted at checkout. */
+    acceptCoupons?: boolean;
+    /** Whether premium services are enabled. Enabled for free if site does not sell any paid tickets. Selling tickets for a fee requires a premium feature "events_sell_tickets". */
+    premiumServices?: boolean;
+    /** Whether there are any paid tickets available for sale. */
+    paidTickets?: boolean;
+}
+export interface ListAvailableTicketsRequest {
+    /** Event ID. If not provided, available tickets for all events in the site will be returned. */
+    eventId?: string;
+    /** Offset. */
+    offset?: number;
+    /** Limit. */
+    limit?: number;
+    /**
+     * 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-available-tickets).
+     */
+    sort?: string;
+    state?: State[];
+}
+export declare enum State {
+    INCLUDE_HIDDEN_NOT_ON_SALE = "INCLUDE_HIDDEN_NOT_ON_SALE"
+}
+export interface ListAvailableTicketsResponse {
+    /** Ticket definitions meta data. */
+    metaData?: ResponseMetaData;
+    /** Ticket definitions. */
+    definitions?: TicketDefinition[];
+}
+export interface ResponseMetaData {
+    /** Number of items in the response. */
+    count?: number;
+    /** Offset of items. */
+    offset?: number;
+    /** Total number of matching items. */
+    total?: number;
+}
+export interface TicketDefinition {
+    /** Ticket definition ID. */
+    _id?: string;
+    /** Ticket price. */
+    price?: Money;
+    /** Whether the ticket is free (read only). */
+    free?: boolean;
+    /** Ticket name. */
+    name?: string;
+    /** Ticket description. */
+    description?: string;
+    /**
+     * Limit of tickets that can be purchased per checkout.
+     * Set to 20 for unlimited ticket definition.
+     */
+    limitPerCheckout?: number;
+    /** Custom sort index. */
+    orderIndex?: number;
+    /** Policy information plain text block, as printed on the ticket. */
+    policy?: string;
+    /** Sensitive dashboard data. */
+    dashboard?: Dashboard;
+    /** Event ID associated with the ticket. */
+    eventId?: string;
+    /**
+     * Configuration of the fixed-rate Wix service fee that is applied at checkout to each ticket sold.
+     * @readonly
+     */
+    wixFeeConfig?: WixFeeConfig;
+    /** Ticket sale period. */
+    salePeriod?: TicketSalePeriod;
+    /**
+     * Ticket sale status.
+     * @readonly
+     */
+    saleStatus?: TicketSaleStatus;
+    /** Ticket state. */
+    state?: State[];
+}
+export interface Dashboard {
+    /** Whether ticket is hidden and cannot be sold. */
+    hidden?: boolean;
+    /** Number of tickets sold and reserved. */
+    sold?: number;
+    /** Whether the ticket has limited quantity. */
+    limited?: boolean;
+    /** Ticket limit. `NULL` for unlimited ticket definitions. */
+    quantity?: number | null;
+    /** Number of unsold tickets. `NULL` for unlimited ticket definitions. */
+    unsold?: number | null;
+    /** Number of tickets sold. */
+    ticketsSold?: number;
+    /** Number of tickets reserved. */
+    ticketsReserved?: number;
+}
+export interface WixFeeConfig {
+    /** Fee calculation method. */
+    type?: FeeType;
+}
+export interface TicketSalePeriod {
+    /** Ticket sale start timestamp. */
+    startDate?: Date;
+    /** Ticket sale end timestamp. */
+    endDate?: Date;
+    /** Whether to hide this ticket if it's not on sale */
+    hideNotOnSale?: boolean;
+}
+export declare enum TicketSaleStatus {
+    /** Ticket sale is scheduled to start */
+    SALE_SCHEDULED = "SALE_SCHEDULED",
+    /** Ticket sale has started */
+    SALE_STARTED = "SALE_STARTED",
+    /** Ticket sale has ended */
+    SALE_ENDED = "SALE_ENDED"
+}
+export interface TicketPricing extends TicketPricingPriceOneOf {
+    /** Ticket price which is read only. */
+    fixedPrice?: Money;
+    /** Min price per ticket, customizable. */
+    minPrice?: Money;
+    /** Ticket pricing options. */
+    pricingOptions?: PricingOptions;
+}
+/** @oneof */
+export interface TicketPricingPriceOneOf {
+    /** Ticket price which is read only. */
+    fixedPrice?: Money;
+    /** Min price per ticket, customizable. */
+    minPrice?: Money;
+    /** Ticket pricing options. */
+    pricingOptions?: PricingOptions;
+}
+export interface PricingOptions {
+    /** Multiple ticket pricing options. */
+    options?: PricingOption[];
+}
+export interface PricingOption {
+    /** Ticket pricing option ID. */
+    _id?: string | null;
+    /** Ticket pricing option name. */
+    name?: string | null;
+    /** Ticket pricing option price. */
+    price?: Money;
+}
+export declare enum Type {
+    STANDARD = "STANDARD",
+    DONATION = "DONATION"
+}
+export interface QueryAvailableTicketsRequest {
+    /** Offset. */
+    offset?: number;
+    /** Limit. */
+    limit?: number;
+    /** Ticket definition. */
+    filter?: Record<string, any> | null;
+    fieldset?: TicketDefinitionFieldset[];
+    /** Sort order, defaults to "created:asc". */
+    sort?: string;
+}
+export declare enum TicketDefinitionFieldset {
+    /** Include policy in the response. */
+    POLICY = "POLICY",
+    /** Include dashboard in the response. */
+    DASHBOARD = "DASHBOARD"
+}
+export interface QueryAvailableTicketsResponse {
+    /** Ticket definitions meta data. */
+    metaData?: ResponseMetaData;
+    /** Ticket definitions. */
+    definitions?: TicketDefinition[];
+}
+export interface CreateReservationRequest {
+    /** Event ID. */
+    eventId: string;
+    /** Tickets to reserve. */
+    ticketQuantities?: TicketReservationQuantity[];
+    /** Whether to ignore the available ticket limits upon reservation. */
+    ignoreLimits?: boolean;
+    /** Whether to allow reservation for hidden tickets. */
+    allowHiddenTickets?: boolean;
+}
+export interface TicketReservationQuantity {
+    /** Ticket definition ID. */
+    ticketDefinitionId?: string;
+    /** Quantity of tickets to reserve. */
+    quantity?: number;
+    /** Ticket price to charge - overriding the ticket price. */
+    priceOverride?: string | null;
+}
+export interface CreateReservationResponse {
+    /** Reservation ID. */
+    _id?: string;
+    /** Reservation expiration timestamp. */
+    expires?: Date;
+    /** Ticket reservations. */
+    reservations?: TicketReservation[];
+    /** Reservation invoice. */
+    invoice?: Invoice;
+}
+export interface TicketReservation {
+    /** Quantity of reserved tickets. */
+    quantity?: number;
+    /** An object containing ticket information. */
+    ticket?: TicketDefinition;
+}
+export interface CancelReservationRequest {
+    /** Event ID. */
+    eventId: string;
+    /** Reservation ID. */
+    _id: string;
+}
+export interface CancelReservationResponse {
+}
+export interface GetInvoiceRequest {
+    /** Event ID. */
+    eventId: string;
+    /** Reservation ID. */
+    reservationId: string;
+    /** Optional discount to be applied on the returned invoice. */
+    withDiscount?: DiscountRequest;
+    /** Optional benefit granted by the pricing plan to be applied on the returned invoice. */
+    paidPlanBenefit?: PaidPlanBenefit;
+}
+export interface DiscountRequest {
+    /** Discount coupon code. */
+    couponCode?: string;
+}
+export interface PaidPlanBenefit {
+    /** Pricing plan ID. */
+    planOrderId?: string;
+    /** Pricing plan benefit ID. */
+    benefitId?: string;
+}
+export interface GetInvoiceResponse {
+    /** Invoice with applied discount. */
+    invoice?: Invoice;
+    /** Discount errors, if relevant. */
+    discountErrors?: DiscountErrors;
+    /** Time when the reservation expires. */
+    expires?: Date;
+    /** Reservation status. */
+    reservationStatus?: ReservationStatus;
+    /** Whether this reservation is already used in checkout. */
+    reservationOccupied?: boolean;
+    /** Ticket reservations. */
+    reservations?: TicketReservation[];
+}
+export interface DiscountErrors {
+    /** Object containing error information. */
+    error?: Error[];
+}
+export interface Error {
+    /** A code identifying the error type. */
+    code?: string;
+}
+export interface CheckoutRequest {
+    /** Event ID. */
+    eventId: string;
+    /** Ticket reservation ID. */
+    reservationId?: string;
+    /** Member ID (if empty - no site member is associated to this order). */
+    memberId?: string;
+    /** Discount to apply on the invoice. */
+    discount?: DiscountRequest;
+    /** Buyer details. */
+    buyer?: Buyer;
+    /** Guest details. */
+    guests?: Guest[];
+    /** Benefit granted by the pricing plan. */
+    paidPlanBenefit?: PaidPlanBenefit;
+    /** Options controlling the checkout process. */
+    options?: CheckoutOptions;
+}
+export interface Buyer {
+    /** Buyer first name. */
+    firstName?: string;
+    /** Buyer last name. */
+    lastName?: string;
+    /** Buyer email. */
+    email?: string;
+}
+export interface Guest {
+    /** Specific guest info. */
+    form?: FormResponse;
+}
+export interface CheckoutOptions {
+    /** Whether to ignore settings to notify contacts or users. */
+    silent?: boolean;
+    /** Whether the payment is to be done in person between the buyer and the merchant. When true, the completed order is created with status OFFLINE_PENDING and inPerson payment method. */
+    payInPerson?: boolean;
+    /** Whether to ignore form validation. */
+    ignoreFormValidation?: boolean;
+}
+export interface CheckoutResponse {
+    /** Created order. */
+    order?: Order;
+    /** Time when the order expires, applies to orders with status = INITIATED. */
+    expires?: Date;
+    /** Ticket reservations. */
+    reservations?: TicketReservation[];
+}
+export interface OrderInitiated {
+    /** Order initiated timestamp in ISO UTC format. */
+    timestamp?: Date;
+    /** Site language when Order initiated */
+    language?: 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;
+    /** Guest first name. */
+    firstName?: string;
+    /** Guest last name. */
+    lastName?: string;
+    /** Guest email address. */
+    email?: string;
+    /** Checkout form response. */
+    checkoutForm?: FormResponse;
+    /** Order status. */
+    status?: OrderStatus;
+    /** Invoice. */
+    invoice?: Invoice;
+    /** Reservation ID associated with this order. */
+    reservationId?: string;
+}
+export interface UpdateCheckoutRequest {
+    /** Event ID. */
+    eventId: string;
+    /** Unique order number. */
+    orderNumber: string;
+    /** Buyer details. */
+    buyer?: Buyer;
+    /** Guest details. */
+    guests?: Guest[];
+    /** Member ID (if empty - no site member is associated to this order). */
+    memberId?: string | null;
+    /** Discount to apply on the invoice. */
+    discount?: DiscountRequest;
+    /** Benefit granted by the pricing plan. */
+    paidPlanBenefit?: PaidPlanBenefit;
+}
+export interface UpdateCheckoutResponse {
+    /** Updated order. */
+    order?: Order;
+}
+export interface PosCheckoutRequest {
+    /** Event ID. */
+    eventId?: string;
+    /** Ticket reservation ID. */
+    reservationId?: string;
+    /**
+     * Payment details ID.
+     * Not required if reservation total is 0. In this case the order will be created with status Free and no payment.
+     */
+    paymentDetailsId?: string | null;
+}
+export interface PosCheckoutResponse {
+    /** Created order. */
+    order?: Order;
+    /** Time when the order expires, applies to orders with status = INITIATED. */
+    expires?: Date;
+    /** Ticket reservations. */
+    reservations?: TicketReservation[];
+}
+/**
+ * Returns checkout meta data used in checkout UX.
+ * > Note: This function is restricted and only runs if you elevate permissions using the [wix-auth.elevate()](https://www.wix.com/velo/reference/wix-auth/elevate) function.
+ * @public
+ * @documentationMaturity preview
+ */
+export declare function getCheckoutOptions(): Promise<GetCheckoutOptionsResponse>;
+/**
+ * Returns tickets available to reserve.
+ * > Note: This function is restricted and only runs if you elevate permissions using the [wix-auth.elevate()](https://www.wix.com/velo/reference/wix-auth/elevate) function.
+ * @public
+ * @documentationMaturity preview
+ * @param options - An object representing the available options for retrieving a list of tickets available for reservation.
+ */
+export declare function listAvailableTickets(options?: ListAvailableTicketsOptions): Promise<ListAvailableTicketsResponse>;
+export interface ListAvailableTicketsOptions {
+    /** Event ID. If not provided, available tickets for all events in the site will be returned. */
+    eventId?: string;
+    /** Offset. */
+    offset?: number;
+    /** Limit. */
+    limit?: number;
+    /** Sort order, defaults to "created:asc". */
+    sort?: string;
+    state?: State[];
+}
+/**
+ * Returns tickets available to reserve.
+ * > Note: The fieldsets in this function are restricted and only run if you elevate permissions using the [wix-auth.elevate()](https://www.wix.com/velo/reference/wix-auth/elevate) function.
+ * @public
+ * @documentationMaturity preview
+ * @param options - An object representing the available options for retrieving a list of tickets available for reservation.
+ */
+export declare function queryAvailableTickets(options?: QueryAvailableTicketsOptions): Promise<QueryAvailableTicketsResponse>;
+export interface QueryAvailableTicketsOptions {
+    /** Offset. */
+    offset?: number;
+    /** Limit. */
+    limit?: number;
+    /** Ticket definition. */
+    filter?: Record<string, any> | null;
+    fieldset?: TicketDefinitionFieldset[];
+    /** Sort order, defaults to "created:asc". */
+    sort?: string;
+}
+/**
+ * Reserves tickets for 20 minutes.
+ * Reserved tickets are deducted from tickets stock and cannot be bought by another party.
+ * When the reservation expires, the tickets are added back in the stock.
+ * > Note: This function is restricted and only runs if you elevate permissions using the [wix-auth.elevate()](https://www.wix.com/velo/reference/wix-auth/elevate) function.
+ * @param eventId - Event ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField eventId
+ * @param options - An object representing the available options for creating a reservation.
+ */
+export declare function createReservation(eventId: string, options?: CreateReservationOptions): Promise<CreateReservationResponse>;
+export interface CreateReservationOptions {
+    /** Tickets to reserve. */
+    ticketQuantities?: TicketReservationQuantity[];
+    /** Whether to ignore the available ticket limits upon reservation. */
+    ignoreLimits?: boolean;
+    /** Whether to allow reservation for hidden tickets. */
+    allowHiddenTickets?: boolean;
+}
+/**
+ * Cancels ticket reservation and returns tickets to stock.
+ *
+ * > Note: This function is restricted and only runs if you elevate permissions using the [wix-auth.elevate()](https://www.wix.com/velo/reference/wix-auth/elevate) function.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField identifiers
+ * @requiredField identifiers.eventId
+ * @requiredField identifiers.id
+ * @param identifiers - An object containing identifiers for the reservation to be cancelled.
+ */
+export declare function cancelReservation(identifiers: CancelReservationIdentifiers): Promise<void>;
+export interface CancelReservationIdentifiers {
+    /** Event ID. */
+    eventId: string;
+    /** Reservation ID. */
+    _id: string;
+}
+/**
+ * Generates a preview of a reservation invoice, including the given coupon or pricing plan.
+ * > Note: This function is restricted and only runs if you elevate permissions using the [wix-auth.elevate()](https://www.wix.com/velo/reference/wix-auth/elevate) function.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField identifiers
+ * @requiredField identifiers.eventId
+ * @requiredField identifiers.reservationId
+ * @param options - An object representing the available options for generating a preview of a reservation invoice.
+ * @param identifiers - An object containing identifiers for the reservation invoice preview to be generated.
+ */
+export declare function getInvoice(identifiers: GetInvoiceIdentifiers, options?: GetInvoiceOptions): Promise<GetInvoiceResponse>;
+export interface GetInvoiceIdentifiers {
+    /** Event ID. */
+    eventId: string;
+    /** Reservation ID. */
+    reservationId: string;
+}
+export interface GetInvoiceOptions {
+    /** Optional discount to be applied on the returned invoice. */
+    withDiscount?: DiscountRequest;
+    /** Optional benefit granted by the pricing plan to be applied on the returned invoice. */
+    paidPlanBenefit?: PaidPlanBenefit;
+}
+/**
+ * Checkout reserved tickets.
+ * Creates order and associates it with a site contact.
+ * Guest details must be sent according to Registration Form input fields.
+ * (To change an existing "INITIATED, "PENDING", or "OFFLINE_PENDING" order, call the [Update Checkout](https://dev.wix.com/api/rest/wix-events/wix-events/checkout/update-checkout) endpoint).
+ * > Note: This function is restricted and only runs if you elevate permissions using the [wix-auth.elevate()](https://www.wix.com/velo/reference/wix-auth/elevate) function.
+ * @param eventId - Event ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField eventId
+ * @requiredField options.guests.form
+ * @param options - An object representing the available options for checking out a reserved ticket.
+ */
+export declare function checkout(eventId: string, options?: CheckoutOptionsForRequest): Promise<CheckoutResponse>;
+export interface CheckoutOptionsForRequest {
+    /** Ticket reservation ID. */
+    reservationId?: string;
+    /** Member ID (if empty - no site member is associated to this order). */
+    memberId?: string;
+    /** Discount to apply on the invoice. */
+    discount?: DiscountRequest;
+    /** Buyer details. */
+    buyer?: Buyer;
+    /** Guest details. */
+    guests?: Guest[];
+    /** Benefit granted by the pricing plan. */
+    paidPlanBenefit?: PaidPlanBenefit;
+    /** Options controlling the checkout process. */
+    options?: CheckoutOptions;
+}
+/**
+ * Updates order and tickets (supported only for unconfirmed orders).
+ * Guest details must be sent according to Registration Form input fields.
+ * > Note: This function is restricted and only runs if you elevate permissions using the [wix-auth.elevate()](https://www.wix.com/velo/reference/wix-auth/elevate) function.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField identifiers
+ * @requiredField identifiers.eventId
+ * @requiredField identifiers.orderNumber
+ * @param options - An object representing the available options for updating an order and tickets.
+ * @param identifiers - An object containing identifiers for the order and tickets to be updated.
+ */
+export declare function updateCheckout(identifiers: UpdateCheckoutIdentifiers, options?: UpdateCheckoutOptions): Promise<UpdateCheckoutResponse>;
+export interface UpdateCheckoutIdentifiers {
+    /** Event ID. */
+    eventId: string;
+    /** Unique order number. */
+    orderNumber: string;
+}
+export interface UpdateCheckoutOptions {
+    /** Buyer details. */
+    buyer?: Buyer;
+    /** Guest details. */
+    guests?: Guest[];
+    /** Member ID (if empty - no site member is associated to this order). */
+    memberId?: string | null;
+    /** Discount to apply on the invoice. */
+    discount?: DiscountRequest;
+    /** Benefit granted by the pricing plan. */
+    paidPlanBenefit?: PaidPlanBenefit;
+}