@wix/auto_sdk_events_tickets 1.0.6 → 1.0.8

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

@@ -0,0 +1,773 @@
+export interface TicketingTicket {
+    /** Unique ticket number (issued automatically). */
+    ticketNumber?: string;
+    /** Associated order number. */
+    orderNumber?: string;
+    /**
+     * Ticket definition ID.
+     * @format GUID
+     */
+    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`.
+     * @deprecated
+     */
+    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`.
+     * @deprecated
+     */
+    ticketPdf?: string;
+    /**
+     * Ticket owner member ID.
+     * @format GUID
+     */
+    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
+     * @format WEB_URL
+     * @readonly
+     */
+    walletPassUrl?: string;
+    /**
+     * Whether ticket is canceled.
+     * @readonly
+     */
+    canceled?: boolean | null;
+}
+export interface Money {
+    /**
+     * *Deprecated:** Use `value` instead.
+     * @format DECIMAL_VALUE
+     * @deprecated
+     */
+    amount?: string;
+    /**
+     * ISO 4217 format of the currency e.g., `USD`.
+     * @format CURRENCY
+     */
+    currency?: string;
+    /**
+     * Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, starts with a single (-), to indicate that the amount is negative.
+     * @format DECIMAL_VALUE
+     */
+    value?: string | null;
+}
+export interface CheckIn {
+    /** Time of check-in */
+    created?: Date | null;
+}
+export declare enum OrderStatus {
+    /** Order status not available for this request fieldset. */
+    NA_ORDER_STATUS = "NA_ORDER_STATUS",
+    /** Order is confirmed and payment isn't required. */
+    FREE = "FREE",
+    /** Order is paid for but the payment gateway has suspended the payment. */
+    PENDING = "PENDING",
+    /** Order is paid via a payment gateway. */
+    PAID = "PAID",
+    /** Order is confirmed but must be paid via offline payment. Status needs to be manually updated to `PAID`. */
+    OFFLINE_PENDING = "OFFLINE_PENDING",
+    /** Order is awaiting payment at the cashier. */
+    INITIATED = "INITIATED",
+    /** Order is canceled. */
+    CANCELED = "CANCELED",
+    /** Order payment is declined. */
+    DECLINED = "DECLINED",
+    /** Order payment is authorized. */
+    AUTHORIZED = "AUTHORIZED",
+    /** Order payment is voided. */
+    VOIDED = "VOIDED",
+    /** Order is partially paid with less than the total amount. */
+    PARTIALLY_PAID = "PARTIALLY_PAID"
+}
+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.
+     * @format EMAIL
+     */
+    email?: string | null;
+    /** Full form response. */
+    form?: FormResponse;
+    /**
+     * Contact ID associated with this guest.
+     * @format GUID
+     */
+    contactId?: string | null;
+    /**
+     * Guest phone number.
+     * @format PHONE
+     */
+    phone?: string | null;
+}
+export interface FormResponse {
+    /**
+     * Input values entered when filling the form.
+     * @maxSize 200
+     */
+    inputValues?: InputValue[];
+}
+export interface InputValue {
+    /**
+     * Input field name.
+     * @maxLength 100
+     */
+    inputName?: string;
+    /**
+     * Text entered into the input field.
+     * @maxLength 5000
+     */
+    value?: string;
+    /**
+     * Multiple selection values. For example, the array is filled if several checkboxes are ticked.
+     * @maxSize 100
+     * @maxLength 5000
+     */
+    values?: string[];
+}
+export interface FormattedAddress {
+    /**
+     * One line address representation.
+     * @maxLength 200
+     */
+    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.
+     * @format COUNTRY
+     */
+    country?: string | null;
+    /** Subdivision shorthand. Usually, a short code (2 or 3 letters) that represents a state, region, prefecture, or province. e.g. NY */
+    subdivision?: string | null;
+    /** City name. */
+    city?: string | null;
+    /** Zip/postal code. */
+    postalCode?: string | null;
+    /** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */
+    addressLine2?: string | null;
+}
+/** @oneof */
+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"
+}
+/** Subdivision Concordance values */
+export interface StandardDetails {
+    /**
+     * subdivision iso-3166-2 code according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). e.g. US-NY, GB-SCT, NO-30
+     * @maxLength 20
+     */
+    iso31662?: string | null;
+}
+export declare enum ChannelType {
+    /** Buyer created the order via an online channel such as a website or mobile app. */
+    ONLINE = "ONLINE",
+    /** Sales person created the order and collected the money. */
+    OFFLINE_POS = "OFFLINE_POS"
+}
+export interface TicketDetails {
+    /**
+     * Unique seat id in the event venue.
+     * @minLength 1
+     * @maxLength 36
+     */
+    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.
+     * @min 1
+     * @max 50
+     */
+    capacity?: number | null;
+    /**
+     * Custom pricing of ticket.
+     * @format DECIMAL_VALUE
+     */
+    priceOverride?: string | null;
+    /**
+     * Pricing option id.
+     * @format GUID
+     */
+    pricingOptionId?: string | null;
+    /**
+     * Pricing option name.
+     * @readonly
+     */
+    pricingOptionName?: string | null;
+}
+export interface ListTicketsRequest {
+    /**
+     * Event IDs.
+     * @format GUID
+     */
+    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).
+     * @max 100
+     */
+    limit?: number;
+    /**
+     * Order numbers.
+     * @minLength 1
+     * @maxLength 36
+     * @maxSize 20
+     */
+    orderNumber?: string[];
+    /**
+     * Ticket numbers.
+     * @minLength 1
+     * @maxLength 36
+     * @maxSize 50
+     */
+    ticketNumber?: string[];
+    /**
+     * Textual search filter - search is performed on "orderFullName", "guestFullName", and "ticketNumber".
+     * @maxLength 200
+     */
+    searchPhrase?: string;
+    /**
+     * Order statuses.
+     * @maxSize 20
+     */
+    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).
+     * @maxSize 20
+     */
+    fieldset?: TicketFieldset[];
+    /**
+     * Ticket states.
+     * @maxSize 20
+     */
+    state?: State[];
+    /**
+     * Site member IDs.
+     * @format GUID
+     * @maxSize 500
+     */
+    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).
+     * @maxLength 100
+     * @maxSize 20
+     */
+    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).
+     * @maxLength 100
+     */
+    sort?: string;
+    /**
+     * Guest contact IDs.
+     * @format GUID
+     * @maxSize 100
+     */
+    contactId?: string[];
+    /**
+     * Ticket definition IDs.
+     * @format GUID
+     * @maxSize 10
+     */
+    ticketDefinitionId?: string[];
+    /**
+     * Seat IDs.
+     * @maxLength 36
+     * @maxSize 50
+     */
+    seatId?: string[];
+}
+export declare enum TicketFieldset {
+    /** Include guest details in the ticket response. */
+    GUEST_DETAILS = "GUEST_DETAILS",
+    /** Include ticket details in the ticket response. */
+    TICKET_DETAILS = "TICKET_DETAILS",
+    /** Include individual guest form in the 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.
+     * @max 100
+     */
+    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.
+     * @format GUID
+     */
+    eventId: string;
+    /**
+     * Unique ticket number.
+     * @maxLength 36
+     */
+    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).
+     * @maxSize 20
+     */
+    fieldset?: TicketFieldset[];
+}
+export interface GetTicketResponse {
+    /** Ticket. */
+    ticket?: TicketingTicket;
+}
+export interface CheckInTicketRequest {
+    /**
+     * Event ID.
+     * @format GUID
+     */
+    eventId: string;
+    /**
+     * Tickets to check-in.
+     * @minLength 1
+     * @maxLength 36
+     * @minSize 1
+     * @maxSize 100
+     */
+    ticketNumber?: string[];
+}
+export interface CheckInTicketResponse {
+    /** Updated tickets. */
+    tickets?: TicketingTicket[];
+}
+export interface OrderUpdated {
+    /** Order updated timestamp in ISO UTC format. */
+    timestamp?: Date | null;
+    /**
+     * Site language when Order initiated
+     * @format LANGUAGE
+     */
+    language?: string | null;
+    /**
+     * Locale in which Order was created.
+     * @format LANGUAGE_TAG
+     */
+    locale?: string | null;
+    /**
+     * Event ID.
+     * @format GUID
+     */
+    eventId?: string;
+    /** Unique order number. */
+    orderNumber?: string;
+    /** Contact ID associated with this order. */
+    contactId?: string;
+    /**
+     * Member ID associated with this order.
+     * @format GUID
+     */
+    memberId?: string | null;
+    /**
+     * Order created timestamp.
+     * @readonly
+     */
+    created?: Date | null;
+    /**
+     * Order updated timestamp.
+     * @readonly
+     */
+    updated?: Date | null;
+    /** Buyer first name. */
+    firstName?: string;
+    /** Buyer last name. */
+    lastName?: string;
+    /** Buyer email. */
+    email?: string;
+    /** Checkout form response. */
+    checkoutForm?: FormResponse;
+    /** Whether order is confirmed - occurs once payment gateway processes the payment and funds reach merchant's account. */
+    confirmed?: boolean;
+    /** Order status. */
+    status?: 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.
+     * @format GUID
+     */
+    ticketDefinitionId?: string;
+    /** Ticket check-in. */
+    checkIn?: CheckIn;
+    /** Ticket price. */
+    price?: Money;
+    /** Whether ticket is archived. */
+    archived?: boolean;
+    /** Guest first name. */
+    firstName?: string | null;
+    /** Guest last name. */
+    lastName?: string | null;
+    /** Guest email. */
+    email?: string | null;
+    /**
+     * Contact ID associated with this ticket.
+     * @format GUID
+     */
+    contactId?: string | null;
+    /** Whether ticket is confirmed */
+    confirmed?: boolean;
+    /**
+     * Member ID associated with this ticket.
+     * @format GUID
+     */
+    memberId?: string | null;
+    /** Ticket form response (only assigned tickets contain separate forms). */
+    form?: FormResponse;
+    /** Ticket name. */
+    ticketName?: string;
+    /** Anonymized tickets no longer contain personally identifiable information (PII). */
+    anonymized?: boolean;
+    /** URL and password to online conference */
+    onlineConferencingLogin?: OnlineConferencingLogin;
+    /**
+     * Seat ID associated with this ticket.
+     * @maxLength 36
+     */
+    seatId?: string | null;
+    /** Whether ticket is canceled. */
+    canceled?: boolean | null;
+}
+export interface OnlineConferencingLogin {
+    /**
+     * Link URL to the online conference.
+     * @format WEB_URL
+     * @readonly
+     */
+    link?: string;
+    /**
+     * Password for the online conference.
+     * @readonly
+     */
+    password?: string | null;
+}
+export interface DeleteTicketCheckInRequest {
+    /**
+     * Event ID.
+     * @format GUID
+     */
+    eventId: string;
+    /**
+     * Tickets to delete check-ins for.
+     * @minLength 1
+     * @maxLength 36
+     * @minSize 1
+     * @maxSize 100
+     */
+    ticketNumber?: string[];
+}
+export interface DeleteTicketCheckInResponse {
+    /** Updated tickets. */
+    tickets?: TicketingTicket[];
+}
+export interface UpdateTicketRequest {
+    /**
+     * Event ID.
+     * @format GUID
+     */
+    eventId: string;
+    /**
+     * Unique ticket number.
+     * @minLength 1
+     * @maxLength 36
+     */
+    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.
+     * @format GUID
+     */
+    eventId: string;
+    /**
+     * Unique ticket numbers.
+     * @minLength 1
+     * @maxLength 36
+     * @minSize 1
+     * @maxSize 100
+     */
+    ticketNumber?: string[];
+    /** Whether tickets are archived. */
+    archived?: boolean;
+}
+export interface BulkUpdateTicketsResponse {
+    /** Updated tickets. */
+    tickets?: TicketingTicket[];
+}
+export interface GetDemoTicketRequest {
+    /**
+     * Ticket definition ID.
+     * @format GUID
+     */
+    definitionId?: string;
+}
+export interface GetDemoTicketResponse {
+    /** Ticket. */
+    ticket?: TicketingTicket;
+}
+export interface MessageEnvelope {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+export interface IdentificationData extends IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityType;
+}
+/** @oneof */
+export interface IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+}
+export declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}