@wix/events 1.0.13 → 1.0.15

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

@@ -0,0 +1,448 @@
+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 {
+    /** 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. */
+    addressLine?: 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;
+}
+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 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;
+    /** 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 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 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;
+    /**
+     * Set of field paths, specifying which parts of this resource to update.
+     * When `fields` is empty, the request is interpreted as a full update.
+     * Behavior follows [google.protobuf.FieldMask](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask) semantics.
+     */
+    fields: 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;
+}

package/build/cjs/src/events-v1-ticket.types.js

@@ -0,0 +1,76 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.State = exports.TicketFieldset = exports.ChannelType = exports.SubdivisionType = exports.OrderStatus = void 0;
+var OrderStatus;
+(function (OrderStatus) {
+    /** Order status not available for this request fieldset */
+    OrderStatus["NA_ORDER_STATUS"] = "NA_ORDER_STATUS";
+    /** Order is confirmed, no payment required */
+    OrderStatus["FREE"] = "FREE";
+    /** Order was paid but payment gateway suspended the payment. Eventually changes to PAID */
+    OrderStatus["PENDING"] = "PENDING";
+    /** Order paid via payment gateway */
+    OrderStatus["PAID"] = "PAID";
+    /** Order confirmed but has to be paid via offline payment and status manually updated to PAID */
+    OrderStatus["OFFLINE_PENDING"] = "OFFLINE_PENDING";
+    /** Order is awaiting for payment in Cashier */
+    OrderStatus["INITIATED"] = "INITIATED";
+    /** Order was canceled */
+    OrderStatus["CANCELED"] = "CANCELED";
+    /** Order payment was declined */
+    OrderStatus["DECLINED"] = "DECLINED";
+})(OrderStatus = exports.OrderStatus || (exports.OrderStatus = {}));
+var SubdivisionType;
+(function (SubdivisionType) {
+    SubdivisionType["UNKNOWN_SUBDIVISION_TYPE"] = "UNKNOWN_SUBDIVISION_TYPE";
+    /** State */
+    SubdivisionType["ADMINISTRATIVE_AREA_LEVEL_1"] = "ADMINISTRATIVE_AREA_LEVEL_1";
+    /** County */
+    SubdivisionType["ADMINISTRATIVE_AREA_LEVEL_2"] = "ADMINISTRATIVE_AREA_LEVEL_2";
+    /** City/town */
+    SubdivisionType["ADMINISTRATIVE_AREA_LEVEL_3"] = "ADMINISTRATIVE_AREA_LEVEL_3";
+    /** Neighborhood/quarter */
+    SubdivisionType["ADMINISTRATIVE_AREA_LEVEL_4"] = "ADMINISTRATIVE_AREA_LEVEL_4";
+    /** Street/block */
+    SubdivisionType["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. */
+    SubdivisionType["COUNTRY"] = "COUNTRY";
+})(SubdivisionType = exports.SubdivisionType || (exports.SubdivisionType = {}));
+var ChannelType;
+(function (ChannelType) {
+    /** Buyer created order via one of the online channels (website, mobile app, etc.) */
+    ChannelType["ONLINE"] = "ONLINE";
+    /** Order created and money collected by the sales person */
+    ChannelType["OFFLINE_POS"] = "OFFLINE_POS";
+})(ChannelType = exports.ChannelType || (exports.ChannelType = {}));
+var TicketFieldset;
+(function (TicketFieldset) {
+    /** Include guest details in ticket response */
+    TicketFieldset["GUEST_DETAILS"] = "GUEST_DETAILS";
+    /** Include ticket details in ticket response */
+    TicketFieldset["TICKET_DETAILS"] = "TICKET_DETAILS";
+    /** Include individual guest form in ticket response */
+    TicketFieldset["GUEST_FORM"] = "GUEST_FORM";
+})(TicketFieldset = exports.TicketFieldset || (exports.TicketFieldset = {}));
+var State;
+(function (State) {
+    /** Returns only archived orders' tickets */
+    State["ORDER_ARCHIVED"] = "ORDER_ARCHIVED";
+    /** Returns only non-archived orders' tickets */
+    State["ORDER_ACTIVE"] = "ORDER_ACTIVE";
+    /** Returns only archived tickets */
+    State["TICKET_ARCHIVED"] = "TICKET_ARCHIVED";
+    /** Returns only non-archived tickets */
+    State["TICKET_ACTIVE"] = "TICKET_ACTIVE";
+    /** Returns only checked-in tickets */
+    State["CHECKED_IN"] = "CHECKED_IN";
+    /** Returns only non-checked-in tickets */
+    State["NON_CHECKED_IN"] = "NON_CHECKED_IN";
+    /** Returns only free tickets */
+    State["FREE"] = "FREE";
+    /** Returns only paid tickets */
+    State["PAID"] = "PAID";
+    /** Returns only member tickets */
+    State["MEMBER"] = "MEMBER";
+})(State = exports.State || (exports.State = {}));
+//# sourceMappingURL=events-v1-ticket.types.js.map

package/build/cjs/src/events-v1-ticket.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"events-v1-ticket.types.js","sourceRoot":"","sources":["../../../src/events-v1-ticket.types.ts"],"names":[],"mappings":";;;AA2EA,IAAY,WAiBX;AAjBD,WAAY,WAAW;IACrB,2DAA2D;IAC3D,kDAAmC,CAAA;IACnC,8CAA8C;IAC9C,4BAAa,CAAA;IACb,2FAA2F;IAC3F,kCAAmB,CAAA;IACnB,qCAAqC;IACrC,4BAAa,CAAA;IACb,iGAAiG;IACjG,kDAAmC,CAAA;IACnC,+CAA+C;IAC/C,sCAAuB,CAAA;IACvB,yBAAyB;IACzB,oCAAqB,CAAA;IACrB,iCAAiC;IACjC,oCAAqB,CAAA;AACvB,CAAC,EAjBW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAiBtB;AAqFD,IAAY,eAcX;AAdD,WAAY,eAAe;IACzB,wEAAqD,CAAA;IACrD,YAAY;IACZ,8EAA2D,CAAA;IAC3D,aAAa;IACb,8EAA2D,CAAA;IAC3D,gBAAgB;IAChB,8EAA2D,CAAA;IAC3D,2BAA2B;IAC3B,8EAA2D,CAAA;IAC3D,mBAAmB;IACnB,8EAA2D,CAAA;IAC3D,8IAA8I;IAC9I,sCAAmB,CAAA;AACrB,CAAC,EAdW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAc1B;AAED,IAAY,WAKX;AALD,WAAY,WAAW;IACrB,qFAAqF;IACrF,gCAAiB,CAAA;IACjB,4DAA4D;IAC5D,0CAA2B,CAAA;AAC7B,CAAC,EALW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAKtB;AA2ED,IAAY,cAOX;AAPD,WAAY,cAAc;IACxB,+CAA+C;IAC/C,iDAA+B,CAAA;IAC/B,gDAAgD;IAChD,mDAAiC,CAAA;IACjC,uDAAuD;IACvD,2CAAyB,CAAA;AAC3B,CAAC,EAPW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAOzB;AAED,IAAY,KAmBX;AAnBD,WAAY,KAAK;IACf,4CAA4C;IAC5C,0CAAiC,CAAA;IACjC,gDAAgD;IAChD,sCAA6B,CAAA;IAC7B,oCAAoC;IACpC,4CAAmC,CAAA;IACnC,wCAAwC;IACxC,wCAA+B,CAAA;IAC/B,sCAAsC;IACtC,kCAAyB,CAAA;IACzB,0CAA0C;IAC1C,0CAAiC,CAAA;IACjC,gCAAgC;IAChC,sBAAa,CAAA;IACb,gCAAgC;IAChC,sBAAa,CAAA;IACb,kCAAkC;IAClC,0BAAiB,CAAA;AACnB,CAAC,EAnBW,KAAK,GAAL,aAAK,KAAL,aAAK,QAmBhB"}