import { CreateTicketReservationRequest as CreateTicketReservationRequest$1, CreateTicketReservationResponse as CreateTicketReservationResponse$1, GetTicketReservationRequest as GetTicketReservationRequest$1, GetTicketReservationResponse as GetTicketReservationResponse$1, DeleteTicketReservationRequest as DeleteTicketReservationRequest$1, DeleteTicketReservationResponse as DeleteTicketReservationResponse$1, BulkUpdateTicketReservationTagsRequest as BulkUpdateTicketReservationTagsRequest$1, BulkUpdateTicketReservationTagsResponse as BulkUpdateTicketReservationTagsResponse$1, BulkUpdateTicketReservationTagsByFilterRequest as BulkUpdateTicketReservationTagsByFilterRequest$1, BulkUpdateTicketReservationTagsByFilterResponse as BulkUpdateTicketReservationTagsByFilterResponse$1, CancelTicketReservationRequest as CancelTicketReservationRequest$1, CancelTicketReservationResponse as CancelTicketReservationResponse$1 } from './index.typings.js'; import '@wix/sdk-types'; /** * A ticket reservation holds tickets for a specified time period during the checkout process. * * When a site visitor selects tickets for an event, a ticket reservation is created to temporarily * reserve those tickets while the visitor completes their purchase. The reservation prevents other * visitors from purchasing the same tickets and includes pricing, seat information (if applicable), * and an expiration time. */ interface TicketReservation { /** * Ticket reservation ID. * @format GUID * @readonly */ id?: string | null; /** * Revision number, which increments by 1 each time the ticket reservation is updated. To prevent conflicting changes, the current revision must be passed when updating the ticket reservation. * @readonly */ revision?: string | null; /** * Date and time the ticket reservation was created. * @readonly */ createdDate?: Date | null; /** * Date and time the ticket reservation was updated. * @readonly */ updatedDate?: Date | null; /** * Date and time when a `PENDING` ticket reservation will automatically expire if not confirmed. * * When a reservation expires, tickets are released back to the available inventory. * Expiration time is calculated based on the event's reservation duration settings. To set the reservation duration, call [Create Event](https://dev.wix.com/docs/api-reference/business-solutions/events/events-v3/create-event) API. * * **Note:** This field only applies to `PENDING` reservations. * @readonly */ expirationDate?: Date | null; /** * Reservation status. * @readonly */ status?: ReservationStatusWithLiterals; /** * ID of the site member who created this reservation. * * Only returned when the reservation was created by a logged-in site member. * * Learn more about [identities](https://dev.wix.com/docs/api-reference/articles/get-started/about-identities). * @format GUID * @readonly */ memberId?: string | null; /** * ID of the site visitor who created this reservation. * * Returned for both logged-in members and anonymous visitors. * * Learn more about [identities](https://dev.wix.com/docs/api-reference/articles/get-started/about-identities). * @format GUID * @readonly */ visitorId?: string | null; /** * List of ticket line items included in this reservation. * * Each line item represents tickets of the same type, pricing option, and seating arrangement. * Multiple line items are created when reserving different ticket types or seating sections. * @minSize 1 * @maxSize 50 */ tickets?: TicketLineItem[]; /** * Advanced configuration options that modify default reservation behavior. * * Use these settings to override standard validation rules, such as availability limits or hidden ticket restrictions. * @immutable */ additionalReservationSettings?: AdditionalReservationSettings; /** * Extended fields allow you to add custom properties beyond the standard reservation data. * * Learn more about [extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions). */ extendedFields?: ExtendedFields; /** * Tags allow you to classify ticket reservations. * * Learn more about [tags](https://dev.wix.com/docs/rest/business-management/tags/introduction). */ tags?: Tags; } declare enum ReservationStatus { /** Initial state when tickets are reserved. Will automatically expire after the expiration time if not confirmed. */ PENDING = "PENDING", /** Reservation is confirmed and tickets are secured. No expiration time applies. */ CONFIRMED = "CONFIRMED", /** Reservation was cancelled due to payment failure or system timeout, and tickets were released back to inventory. */ CANCELED = "CANCELED", /** Reservation was manually cancelled by the site owner, and tickets were released back to inventory. */ CANCELED_MANUALLY = "CANCELED_MANUALLY", /** Reservation exceeded its expiration time and tickets were released back to inventory. */ EXPIRED = "EXPIRED" } /** @enumType */ type ReservationStatusWithLiterals = ReservationStatus | 'PENDING' | 'CONFIRMED' | 'CANCELED' | 'CANCELED_MANUALLY' | 'EXPIRED'; interface TicketLineItem { /** * Ticket line item ID. * @format GUID * @readonly */ ticketLineItemId?: string | null; /** * ID of the event these tickets are for. * @format GUID * @readonly */ eventId?: string | null; /** * ID of the [ticket definition](https://dev.wix.com/docs/api-reference/business-solutions/events/ticket-definitions-v3/introduction) being reserved. * @format GUID */ ticketDefinitionId?: string | null; /** * Number of tickets to reserve for this line item. * @min 1 * @max 50 */ quantity?: number | null; /** Detailed information about the tickets in this line item. */ ticketInfo?: TicketInfo; /** * Snapshot of event configuration at the time of reservation creation. * * Preserves settings like reservation duration and ticket limits to ensure consistent behavior even if event settings change after reservation creation. * @readonly */ eventSettingsSnapshot?: EventSettingsSnapshot; /** * Number of tickets that are removed from this line item after manually updating reservation in the dashboard. * @max 50 * @readonly */ removedQuantity?: number | null; /** * Terms and conditions that apply to this ticket type. * @minLength 1 * @maxLength 50000 * @readonly */ policy?: string | null; /** * Display name of the ticket type for this line item. * @minLength 1 * @maxLength 30 * @readonly */ ticketName?: string | null; /** * Price per individual ticket in this line item. * * Represents the base price for one ticket before any quantity calculations. This price includes any pricing option discounts but excludes service fees. * @readonly */ price?: CommonMoney; /** * Total price for all tickets in this line item. * * Calculated as `price` multiplied by `quantity`. This represents the subtotal for this line item before taxes and service fees are applied. * @readonly */ subTotal?: CommonMoney; } interface TicketInfo { /** * Unique identifier for the assigned seat at the event venue. * * Required for events with assigned seating. Each ticket in the line item can have a different seat assignment within the same section or area. * @minLength 1 * @maxLength 36 */ seatId?: string | null; /** * Detailed seat location information. * * Includes section, row, seat number, and other venue-specific identifiers to help customers locate their assigned seats. * @readonly */ seatInfo?: SeatInfo; /** * The guest enters the ticket price. This pricing method is applied to donation. * @format DECIMAL_VALUE * @decimalValue options { maxScale:4 } * @immutable */ guestPrice?: string | null; /** * ID of the pricing option selected for this ticket. * @format GUID */ pricingOptionId?: string | null; /** * Display name of the selected pricing option. * @readonly * @maxLength 200 */ pricingOptionName?: string | null; /** * Pricing plan benefits applied to this ticket. * * Contains information about subscription plan discounts or benefits that affect the ticket pricing for this customer. */ pricingPlan?: PricingPlan; /** * Override price that replaces the standard ticket price. * * Used for promotional pricing, staff discounts, or other special pricing that differs from the standard ticket definition price. * @format DECIMAL_VALUE * @decimalValue options { maxScale:4 } * @immutable */ priceOverride?: string | null; } interface SeatInfo { /** * High-level division of the venue, where the place is located, such as `Orchestra`, `Balcony`, or `VIP Section`. * @readonly * @maxLength 20 */ sectionLabel?: string | null; /** * General admission or general seating area label. * @readonly * @maxLength 50 */ areaLabel?: string | null; /** * Table label for events with table seating. * @readonly * @maxLength 50 */ tableLabel?: string | null; /** * Row label within a section. * @readonly * @maxLength 50 */ rowLabel?: string | null; /** * Individual seat label within a row or at a table. * @readonly * @maxLength 4 */ seatLabel?: string | null; /** * Seating plan ID from the Wix Events & Tickets app. * @readonly * @format GUID */ configurationId?: string | null; } declare enum Type { /** Standard ticket pricing. */ STANDARD = "STANDARD", /** Donation ticket pricing. */ DONATION = "DONATION" } /** @enumType */ type TypeWithLiterals = Type | 'STANDARD' | 'DONATION'; interface PricingPlan { /** * Order ID of the pricing plan purchase. * * References the specific order through which the customer acquired their subscription plan benefits. * @format GUID */ orderId?: string; /** * Unique identifier of the pricing plan. * * References the specific subscription plan that grants pricing benefits or discounts for this ticket reservation. * @format GUID */ planId?: string; } interface EventSettingsSnapshot { } declare enum CheckoutType { /** Checkout using Events App. */ EVENTS_APP = "EVENTS_APP", /** Checkout using Ecomm Platform. */ ECOMM_PLATFORM = "ECOMM_PLATFORM" } /** @enumType */ type CheckoutTypeWithLiterals = CheckoutType | 'EVENTS_APP' | 'ECOMM_PLATFORM'; /** * Money. * Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003. */ interface CommonMoney { /** * Monetary amount. Decimal string with a period as a decimal separator (for example, 3.99). Optionally, a single (-), to indicate that the amount is negative. * @format DECIMAL_VALUE */ value?: string; /** * Currency code. Must be a valid [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code (for example, USD). * @format CURRENCY */ currency?: string; } interface ServiceFee { /** * How fee is calculated. * @readonly */ type?: FeeTypeWithLiterals; /** * Fee rate. * @format DECIMAL_VALUE * @readonly * @decimalValue options { maxScale:1 } */ rate?: string; } declare enum FeeType { /** 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" } /** @enumType */ type FeeTypeWithLiterals = FeeType | 'FEE_INCLUDED' | 'FEE_ADDED_AT_CHECKOUT'; /** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */ interface CatalogReference { /** * ID of the item within the catalog it belongs to. * @minLength 1 * @maxLength 36 */ catalogItemId?: string; /** * ID of the app providing the catalog. * * You can get your app's ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/). * * For items from Wix catalogs, the following values always apply: * + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"` * + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"` * + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"` * @minLength 1 */ appId?: string; /** * Additional item details in `key:value` pairs. * * Use this optional field for more specificity with item selection. The values of the `options` field differ depending on which catalog is providing the items. * * For Wix Stores products, learn more about integrating with [Catalog V3](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/e-commerce-integration) * or [Catalog V1](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v1/catalog/e-commerce-integration), depending on [the version the site uses](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-versioning/introduction). */ options?: Record | null; } interface AdditionalReservationSettings { /** * Whether to bypass ticket availability limits when creating the reservation. * * When `true`, allows creating reservations even if tickets appear sold out. Use with caution as this can lead to overselling. Typically used for admin purposes or special circumstances. */ disableTicketLimitValidation?: boolean | null; /** * Whether to allow reservations for tickets marked as hidden. * * Hidden tickets are not displayed in the standard ticket selection on the site. Enable this to allow reservations for hidden tickets through direct API calls. */ enableHiddenTicketReservation?: boolean | null; } interface ExtendedFields { /** * Extended field data. Each key corresponds to the namespace of the app that created the extended fields. * The value of each key is structured according to the schema defined when the extended fields were configured. * * You can only access fields for which you have the appropriate permissions. * * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields). */ namespaces?: Record>; } /** * Common object for tags. * Should be use as in this example: * message Foo { * string id = 1; * ... * Tags tags = 5 * } * * example of taggable entity * { * id: "123" * tags: { * tags: { * tag_ids:["11","22"] * }, * private_tags: { * tag_ids: ["33", "44"] * } * } * } */ interface Tags { /** Tags that require an additional permission in order to access them, normally not given to site members or visitors. */ privateTags?: TagList; /** Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. */ tags?: TagList; } interface TagList { /** * List of tag IDs. * @maxSize 100 * @maxLength 5 */ tagIds?: string[]; } interface TicketReservationBalanceUpdated { /** Current event ticket reservation balance */ balance?: TicketReservationBalance; } interface TicketReservationBalance { /** * The unique identifier of the event * @format GUID */ eventId?: string; /** * Collection of balance information for each ticket definition in the event * @maxSize 100 */ ticketDefinitionBalances?: TicketDefinitionBalance[]; /** * Date and time when the balance record was created * @readonly */ createdDate?: Date | null; /** * Date and time when the balance record was last updated * @readonly */ updatedDate?: Date | null; } /** * Represents the current state of reservations for a specific ticket definition. * Contains counts of confirmed tickets, pending tickets, and the total. */ interface TicketDefinitionBalance { /** * The unique identifier of the ticket definition * @format GUID */ ticketDefinitionId?: string; /** Number of confirmed tickets */ confirmedTickets?: number; /** Number of tickets in pending state (reserved but not yet confirmed) */ pendingTickets?: number; /** Total number of tickets (confirmed + pending) */ totalTickets?: number; } interface CreateCheckoutRequest { /** * Ticket reservation ID to create checkout from. * @format GUID */ ticketReservationId?: string | null; } interface CreateCheckoutResponse { /** * Created checkout ID. * @format GUID */ checkoutId?: string | null; } interface DomainEvent extends DomainEventBodyOneOf { createdEvent?: EntityCreatedEvent; updatedEvent?: EntityUpdatedEvent; deletedEvent?: EntityDeletedEvent; actionEvent?: ActionEvent; /** Event ID. With this ID you can easily spot duplicated events and ignore them. */ id?: string; /** * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities. * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`. */ entityFqdn?: string; /** * Event action name, placed at the top level to make it easier for users to dispatch messages. * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`. */ slug?: string; /** ID of the entity associated with the event. */ entityId?: string; /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */ eventTime?: Date | null; /** * Whether the event was triggered as a result of a privacy regulation application * (for example, GDPR). */ triggeredByAnonymizeRequest?: boolean | null; /** If present, indicates the action that triggered the event. */ originatedFrom?: string | null; /** * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at `16:00` and then again at `16:01`, the second update will always have a higher sequence number. * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it. */ entityEventSequence?: string | null; } /** @oneof */ interface DomainEventBodyOneOf { createdEvent?: EntityCreatedEvent; updatedEvent?: EntityUpdatedEvent; deletedEvent?: EntityDeletedEvent; actionEvent?: ActionEvent; } interface EntityCreatedEvent { entityAsJson?: string; /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */ restoreInfo?: RestoreInfo; } interface RestoreInfo { deletedDate?: Date | null; } interface EntityUpdatedEvent { /** * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff. * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects. * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it. */ currentEntityAsJson?: string; } interface EntityDeletedEvent { /** Entity that was deleted. */ deletedEntityAsJson?: string | null; } interface ActionEvent { bodyAsJson?: string; } 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; /** Details related to the account */ accountInfo?: AccountInfo; } 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?: WebhookIdentityTypeWithLiterals; } /** @oneof */ 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; } declare enum WebhookIdentityType { UNKNOWN = "UNKNOWN", ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR", MEMBER = "MEMBER", WIX_USER = "WIX_USER", APP = "APP" } /** @enumType */ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP'; interface AccountInfo { /** * ID of the Wix account associated with the event. * @format GUID */ accountId?: string | null; /** * ID of the parent Wix account. Only included when accountId belongs to a child account. * @format GUID */ parentAccountId?: string | null; /** * ID of the Wix site associated with the event. Only included when the event is tied to a specific site. * @format GUID */ siteId?: string | null; } interface CreateTicketReservationRequest { /** * Ticket reservation details to create. * * Must include at least one ticket line item with valid ticket definition ID * and quantity. Additional settings like seat assignments and pricing options * can be specified in the ticket info. */ ticketReservation: TicketReservation; } interface CreateTicketReservationResponse { /** The created ticket reservation. */ ticketReservation?: TicketReservation; /** Promotion-related errors that occurred during reservation creation. */ promotionErrors?: PromotionErrors; } interface PromotionErrors { /** * Errors. * @maxSize 10 * @readonly */ error?: Error[]; } declare enum PromotionType { /** Unknown promotion type. This value isn't used. */ UNKNOWN_PROMOTION_TYPE = "UNKNOWN_PROMOTION_TYPE", /** Error after failing to apply a promotion that doesn't fit into specific categories. */ OTHER = "OTHER", /** Error after failing to apply the coupon code. */ COUPON_CODE = "COUPON_CODE", /** Error after failing to apply the paid plan benefit. */ PAID_PLAN_BENEFIT = "PAID_PLAN_BENEFIT", /** Error after failing to apply the gift card. */ GIFT_CARD = "GIFT_CARD" } /** @enumType */ type PromotionTypeWithLiterals = PromotionType | 'UNKNOWN_PROMOTION_TYPE' | 'OTHER' | 'COUPON_CODE' | 'PAID_PLAN_BENEFIT' | 'GIFT_CARD'; interface Error { /** Promotion type. */ promotionType?: PromotionTypeWithLiterals; /** * Error code from the service provider. * @maxLength 50 * @readonly */ code?: string | null; /** * Additional error message. * @maxLength 200 * @readonly */ message?: string | null; } interface GetTicketReservationRequest { /** * ID of the ticket reservation to retrieve. * @format GUID */ ticketReservationId: string; } interface GetTicketReservationResponse { /** The requested ticket reservation. */ ticketReservation?: TicketReservation; /** Promotion-related errors associated with this reservation. */ promotionErrors?: PromotionErrors; } interface GetCurrentTicketReservationRequest { } interface GetCurrentTicketReservationResponse { /** The current visitor's TicketReservation. */ ticketReservation?: TicketReservation; /** Promotions errors */ promotionErrors?: PromotionErrors; } interface UpdateTicketReservationRequest { /** TicketReservation to be updated, may be partial. */ ticketReservation?: TicketReservation; /** Updates reservation but does not save changes. */ previewReservation?: boolean; } interface UpdateTicketReservationResponse { /** Updated TicketReservation. */ ticketReservation?: TicketReservation; /** Promotions errors */ promotionErrors?: PromotionErrors; } interface UpdateCurrentTicketReservationRequest { /** TicketReservation to be updated, may be partial. */ ticketReservation?: TicketReservation; /** Updates reservation but does not save changes. */ previewReservation?: boolean; } interface UpdateCurrentTicketReservationResponse { /** Updated TicketReservation. */ ticketReservation?: TicketReservation; /** Promotions errors. */ promotionErrors?: PromotionErrors; } interface AddTicketsToCurrentTicketReservationRequest { /** * @minSize 1 * @maxSize 50 */ tickets?: TicketLineItem[]; } interface AddTicketsToCurrentTicketReservationResponse { /** Updated TicketReservation. */ ticketReservation?: TicketReservation; } interface AddTicketsToTicketReservationRequest { /** * ID of the ticket reservation to add tickets to. * @format GUID */ ticketReservationId?: string; /** * Tickets to add to a reservation. * @minSize 1 * @maxSize 50 */ tickets?: TicketLineItem[]; } interface AddTicketsToTicketReservationResponse { /** Updated TicketReservation. */ ticketReservation?: TicketReservation; } interface RemoveTicketsFromCurrentTicketReservationRequest { /** * Ticket line item IDs. * @format GUID * @minSize 1 * @maxSize 50 */ ticketLineItemIds?: string[] | null; } interface RemoveTicketsFromCurrentTicketReservationResponse { /** Updated TicketReservation. */ ticketReservation?: TicketReservation; } interface RemoveTicketsFromTicketReservationRequest { /** * ID of the ticket reservation to add tickets to. * @format GUID */ ticketReservationId?: string; /** * Ticket line item IDs. * @format GUID * @minSize 1 * @maxSize 50 */ ticketLineItemIds?: string[] | null; } interface RemoveTicketsFromTicketReservationResponse { /** Updated TicketReservation. */ ticketReservation?: TicketReservation; } interface DeleteTicketReservationRequest { /** * ID of the ticket reservation to delete. * @format GUID */ ticketReservationId: string; } interface DeleteTicketReservationResponse { /** Deleted ticket reservation. */ ticketReservation?: TicketReservation; } interface DeleteCurrentTicketReservationRequest { } interface DeleteCurrentTicketReservationResponse { /** Deleted TicketReservation. */ ticketReservation?: TicketReservation; } interface BulkUpdateTicketReservationTagsRequest { /** * List of ticket reservation IDs to update. * @minSize 1 * @maxSize 100 * @format GUID */ ids: string[]; /** Tags to add to the specified reservations. */ assignTags: Tags; /** Tags to remove from the specified reservations. */ unassignTags?: Tags; } interface BulkUpdateTicketReservationTagsResponse { /** * Results of the bulk tag update operation. * @minSize 1 * @maxSize 100 */ results?: BulkUpdateTicketReservationTagsResult[]; /** Metadata about the bulk update operation. */ bulkActionMetadata?: BulkActionMetadata; } interface ItemMetadata { /** * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). * @format GUID */ id?: string | null; /** Index of the item within the request array. Allows for correlation between request and response items. */ originalIndex?: number; /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */ success?: boolean; /** Details about the error in case of failure. */ error?: ApplicationError; } interface ApplicationError { /** Error code. */ code?: string; /** Description of the error. */ description?: string; /** Data related to the error. */ data?: Record | null; } interface BulkUpdateTicketReservationTagsResult { /** Metadata for the individual reservation update operation. */ itemMetadata?: ItemMetadata; } interface BulkActionMetadata { /** Number of items that were successfully processed. */ totalSuccesses?: number; /** Number of items that couldn't be processed. */ totalFailures?: number; /** Number of failures without details because detailed failure threshold was exceeded. */ undetailedFailures?: number; } interface BulkUpdateTicketReservationTagsByFilterRequest { /** Filter criteria to select reservations for tag updates. */ filter: Record | null; /** Tags to add to matching reservations. */ assignTags: Tags; /** Tags to remove from matching reservations. */ unassignTags?: Tags; } interface BulkUpdateTicketReservationTagsByFilterResponse { /** * Job ID for tracking the asynchronous operation. * * Use this ID to monitor the progress and status of the bulk tag update operation. * The operation runs in the background and may take time to complete for large datasets. * @format GUID */ jobId?: string; } interface ConfirmTicketReservationRequest { /** * ID of the TicketReservation to confirm. * @format GUID */ ticketReservationId?: string; } interface ConfirmTicketReservationResponse { /** The confirmed TicketReservation. */ ticketReservation?: TicketReservation; } interface CancelTicketReservationRequest { /** * ID of the ticket reservation to cancel. * @format GUID */ ticketReservationId: string; } interface CancelTicketReservationResponse { /** The canceled ticket reservation. */ ticketReservation?: TicketReservation; } interface CancelTicketReservationOnGracePeriodEndRequest { /** * ID of the TicketReservation to cancel. * @format GUID */ ticketReservationId?: string; } interface CancelTicketReservationOnGracePeriodEndResponse { } interface ExpireTicketReservationRequest { /** * ID of the TicketReservation to expire. * @format GUID */ ticketReservationId?: string; } interface ExpireTicketReservationResponse { /** The expired TicketReservation. */ ticketReservation?: TicketReservation; } interface UpdateTicketReservationCancelableRequest { /** * ID of the TicketReservation to update. * @format GUID */ ticketReservationId?: string | null; /** Whether TicketReservation can be canceled. */ cancelable?: boolean | null; } interface UpdateTicketReservationCancelableResponse { } interface Empty { } /** Triggered when an order is archived. */ interface OrderArchived { /** * Event ID to which the order belongs. * @format GUID */ eventId?: string; /** * Unique order number. * @maxLength 36 */ orderNumber?: string; /** * Reservation ID associated with the order. * @format GUID */ reservationId?: string; /** Order status. */ status?: OrderStatusWithLiterals; /** * Archived tickets. * @maxSize 50 */ tickets?: Ticket[]; } declare enum OrderStatus { /** Order status isn't available for this request fieldset. */ NA_ORDER_STATUS = "NA_ORDER_STATUS", /** Order is confirmed, no payment is required. */ FREE = "FREE", /** Order was paid, but the payment gateway suspended the payment. */ PENDING = "PENDING", /** Order is paid. */ 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 waiting for 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" } /** @enumType */ type OrderStatusWithLiterals = OrderStatus | 'NA_ORDER_STATUS' | 'FREE' | 'PENDING' | 'PAID' | 'OFFLINE_PENDING' | 'INITIATED' | 'CANCELED' | 'DECLINED' | 'AUTHORIZED' | 'VOIDED' | 'PARTIALLY_PAID'; 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; } interface CheckIn { /** Time of a ticket's check-in. */ created?: Date | null; } interface Money { /** * *Deprecated:** Use `value` instead. * @format DECIMAL_VALUE * @deprecated */ amount?: string; /** * 3-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. For example, `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; } interface FormResponse { /** * Form field inputs. * @maxSize 200 */ inputValues?: InputValue[]; } interface InputValue { /** * Form field input name. * @maxLength 100 */ inputName?: string; /** * Form field value. * @maxLength 5000 */ value?: string; /** * Form field values. * @maxSize 100 * @maxLength 5000 */ values?: string[]; } interface FormattedAddress { /** * 1-line address representation. * @maxLength 200 */ formatted?: string; /** Address components. */ address?: Address; } /** Physical address */ 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 */ interface AddressStreetOneOf { /** Street name and number. */ streetAddress?: StreetAddress; /** Main address line, usually street and number as free text. */ addressLine?: string | null; } interface StreetAddress { /** Street number. */ number?: string; /** Street name. */ name?: string; } interface AddressLocation { /** Address latitude. */ latitude?: number | null; /** Address longitude. */ longitude?: number | null; } interface Subdivision { /** Short subdivision code. */ code?: string; /** Subdivision full name. */ name?: string; } 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" } /** @enumType */ type SubdivisionTypeWithLiterals = SubdivisionType | 'UNKNOWN_SUBDIVISION_TYPE' | 'ADMINISTRATIVE_AREA_LEVEL_1' | 'ADMINISTRATIVE_AREA_LEVEL_2' | 'ADMINISTRATIVE_AREA_LEVEL_3' | 'ADMINISTRATIVE_AREA_LEVEL_4' | 'ADMINISTRATIVE_AREA_LEVEL_5' | 'COUNTRY'; /** Subdivision Concordance values */ 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; } interface OnlineConferencingLogin { /** * Link URL to the online conference. * @format WEB_URL * @readonly */ link?: string; /** * Password for the online conference. * @readonly */ password?: string | null; } /** Triggered when an order is unarchived. */ interface OrderUnarchived { /** * Event ID to which the order belongs. * @format GUID */ eventId?: string; /** * Unique order number. * @maxLength 36 */ orderNumber?: string; /** * Reservation ID associated with the order. * @format GUID */ reservationId?: string; /** Order status. */ status?: OrderStatusWithLiterals; /** * Unarchived tickets. * @maxSize 50 */ tickets?: Ticket[]; } /** Triggered when a ticket in an order is canceled. */ interface OrderTicketsCanceled { /** * Event ID to which the order belongs. * @format GUID */ eventId?: string; /** * Unique order number. * @maxLength 36 */ orderNumber?: string; /** * Reservation ID associated with the order. * @format GUID */ reservationId?: string; /** Order status. */ status?: OrderStatusWithLiterals; /** * Only canceled tickets. * @maxSize 50 */ canceledTickets?: Ticket[]; } interface QueryEventsWithPaidReservationsRequest { /** * Event keys. * @minSize 1 * @maxSize 100 */ eventKeys?: EventKey[]; } /** Event key. */ interface EventKey { /** * Instance ID. * @format GUID */ instanceId?: string | null; /** * Event ID. * @format GUID */ eventId?: string | null; } interface QueryEventsWithPaidReservationsResponse { /** * Event IDs. * @format GUID * @maxSize 100 */ eventIds?: string[] | null; } interface FixArchivedTicketReservationRequest { /** * ID of the ticket reservation to fix. * @format GUID */ ticketReservationId?: string; } interface FixArchivedTicketReservationResponse { /** The found ticket reservation. */ ticketReservation?: TicketReservation; } /** @docsIgnore */ type CreateTicketReservationApplicationErrors = { code?: 'TICKET_DEFINITION_NOT_FOUND'; description?: string; data?: Record; } | { code?: 'EVENT_NOT_FOUND'; description?: string; data?: Record; } | { code?: 'UNSUPPORTED_PRICING_OPTION'; description?: string; data?: Record; }; /** @docsIgnore */ type GetTicketReservationApplicationErrors = { code?: 'TICKET_RESERVATION_NOT_FOUND'; description?: string; data?: Record; }; /** @docsIgnore */ type CancelTicketReservationApplicationErrors = { code?: 'TICKET_RESERVATION_NOT_FOUND'; description?: string; data?: Record; }; type __PublicMethodMetaInfo = { getUrl: (context: any) => string; httpMethod: K; path: string; pathParams: M; __requestType: T; __originalRequestType: S; __responseType: Q; __originalResponseType: R; }; declare function createTicketReservation(): __PublicMethodMetaInfo<'POST', {}, CreateTicketReservationRequest$1, CreateTicketReservationRequest, CreateTicketReservationResponse$1, CreateTicketReservationResponse>; declare function getTicketReservation(): __PublicMethodMetaInfo<'GET', { ticketReservationId: string; }, GetTicketReservationRequest$1, GetTicketReservationRequest, GetTicketReservationResponse$1, GetTicketReservationResponse>; declare function deleteTicketReservation(): __PublicMethodMetaInfo<'DELETE', { ticketReservationId: string; }, DeleteTicketReservationRequest$1, DeleteTicketReservationRequest, DeleteTicketReservationResponse$1, DeleteTicketReservationResponse>; declare function bulkUpdateTicketReservationTags(): __PublicMethodMetaInfo<'POST', {}, BulkUpdateTicketReservationTagsRequest$1, BulkUpdateTicketReservationTagsRequest, BulkUpdateTicketReservationTagsResponse$1, BulkUpdateTicketReservationTagsResponse>; declare function bulkUpdateTicketReservationTagsByFilter(): __PublicMethodMetaInfo<'POST', {}, BulkUpdateTicketReservationTagsByFilterRequest$1, BulkUpdateTicketReservationTagsByFilterRequest, BulkUpdateTicketReservationTagsByFilterResponse$1, BulkUpdateTicketReservationTagsByFilterResponse>; declare function cancelTicketReservation(): __PublicMethodMetaInfo<'POST', { ticketReservationId: string; }, CancelTicketReservationRequest$1, CancelTicketReservationRequest, CancelTicketReservationResponse$1, CancelTicketReservationResponse>; export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, type AddTicketsToCurrentTicketReservationRequest as AddTicketsToCurrentTicketReservationRequestOriginal, type AddTicketsToCurrentTicketReservationResponse as AddTicketsToCurrentTicketReservationResponseOriginal, type AddTicketsToTicketReservationRequest as AddTicketsToTicketReservationRequestOriginal, type AddTicketsToTicketReservationResponse as AddTicketsToTicketReservationResponseOriginal, type AdditionalReservationSettings as AdditionalReservationSettingsOriginal, type AddressLocation as AddressLocationOriginal, type Address as AddressOriginal, type AddressStreetOneOf as AddressStreetOneOfOriginal, type ApplicationError as ApplicationErrorOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type BulkUpdateTicketReservationTagsByFilterRequest as BulkUpdateTicketReservationTagsByFilterRequestOriginal, type BulkUpdateTicketReservationTagsByFilterResponse as BulkUpdateTicketReservationTagsByFilterResponseOriginal, type BulkUpdateTicketReservationTagsRequest as BulkUpdateTicketReservationTagsRequestOriginal, type BulkUpdateTicketReservationTagsResponse as BulkUpdateTicketReservationTagsResponseOriginal, type BulkUpdateTicketReservationTagsResult as BulkUpdateTicketReservationTagsResultOriginal, type CancelTicketReservationApplicationErrors as CancelTicketReservationApplicationErrorsOriginal, type CancelTicketReservationOnGracePeriodEndRequest as CancelTicketReservationOnGracePeriodEndRequestOriginal, type CancelTicketReservationOnGracePeriodEndResponse as CancelTicketReservationOnGracePeriodEndResponseOriginal, type CancelTicketReservationRequest as CancelTicketReservationRequestOriginal, type CancelTicketReservationResponse as CancelTicketReservationResponseOriginal, type CatalogReference as CatalogReferenceOriginal, type CheckIn as CheckInOriginal, CheckoutType as CheckoutTypeOriginal, type CheckoutTypeWithLiterals as CheckoutTypeWithLiteralsOriginal, type CommonMoney as CommonMoneyOriginal, type ConfirmTicketReservationRequest as ConfirmTicketReservationRequestOriginal, type ConfirmTicketReservationResponse as ConfirmTicketReservationResponseOriginal, type CreateCheckoutRequest as CreateCheckoutRequestOriginal, type CreateCheckoutResponse as CreateCheckoutResponseOriginal, type CreateTicketReservationApplicationErrors as CreateTicketReservationApplicationErrorsOriginal, type CreateTicketReservationRequest as CreateTicketReservationRequestOriginal, type CreateTicketReservationResponse as CreateTicketReservationResponseOriginal, type DeleteCurrentTicketReservationRequest as DeleteCurrentTicketReservationRequestOriginal, type DeleteCurrentTicketReservationResponse as DeleteCurrentTicketReservationResponseOriginal, type DeleteTicketReservationRequest as DeleteTicketReservationRequestOriginal, type DeleteTicketReservationResponse as DeleteTicketReservationResponseOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type Error as ErrorOriginal, type EventKey as EventKeyOriginal, type EventSettingsSnapshot as EventSettingsSnapshotOriginal, type ExpireTicketReservationRequest as ExpireTicketReservationRequestOriginal, type ExpireTicketReservationResponse as ExpireTicketReservationResponseOriginal, type ExtendedFields as ExtendedFieldsOriginal, FeeType as FeeTypeOriginal, type FeeTypeWithLiterals as FeeTypeWithLiteralsOriginal, type FixArchivedTicketReservationRequest as FixArchivedTicketReservationRequestOriginal, type FixArchivedTicketReservationResponse as FixArchivedTicketReservationResponseOriginal, type FormResponse as FormResponseOriginal, type FormattedAddress as FormattedAddressOriginal, type GetCurrentTicketReservationRequest as GetCurrentTicketReservationRequestOriginal, type GetCurrentTicketReservationResponse as GetCurrentTicketReservationResponseOriginal, type GetTicketReservationApplicationErrors as GetTicketReservationApplicationErrorsOriginal, type GetTicketReservationRequest as GetTicketReservationRequestOriginal, type GetTicketReservationResponse as GetTicketReservationResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type InputValue as InputValueOriginal, type ItemMetadata as ItemMetadataOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type Money as MoneyOriginal, type OnlineConferencingLogin as OnlineConferencingLoginOriginal, type OrderArchived as OrderArchivedOriginal, OrderStatus as OrderStatusOriginal, type OrderStatusWithLiterals as OrderStatusWithLiteralsOriginal, type OrderTicketsCanceled as OrderTicketsCanceledOriginal, type OrderUnarchived as OrderUnarchivedOriginal, type PricingPlan as PricingPlanOriginal, type PromotionErrors as PromotionErrorsOriginal, PromotionType as PromotionTypeOriginal, type PromotionTypeWithLiterals as PromotionTypeWithLiteralsOriginal, type QueryEventsWithPaidReservationsRequest as QueryEventsWithPaidReservationsRequestOriginal, type QueryEventsWithPaidReservationsResponse as QueryEventsWithPaidReservationsResponseOriginal, type RemoveTicketsFromCurrentTicketReservationRequest as RemoveTicketsFromCurrentTicketReservationRequestOriginal, type RemoveTicketsFromCurrentTicketReservationResponse as RemoveTicketsFromCurrentTicketReservationResponseOriginal, type RemoveTicketsFromTicketReservationRequest as RemoveTicketsFromTicketReservationRequestOriginal, type RemoveTicketsFromTicketReservationResponse as RemoveTicketsFromTicketReservationResponseOriginal, ReservationStatus as ReservationStatusOriginal, type ReservationStatusWithLiterals as ReservationStatusWithLiteralsOriginal, type RestoreInfo as RestoreInfoOriginal, type SeatInfo as SeatInfoOriginal, type ServiceFee as ServiceFeeOriginal, type StandardDetails as StandardDetailsOriginal, type StreetAddress as StreetAddressOriginal, type Subdivision as SubdivisionOriginal, SubdivisionType as SubdivisionTypeOriginal, type SubdivisionTypeWithLiterals as SubdivisionTypeWithLiteralsOriginal, type TagList as TagListOriginal, type Tags as TagsOriginal, type TicketDefinitionBalance as TicketDefinitionBalanceOriginal, type TicketInfo as TicketInfoOriginal, type TicketLineItem as TicketLineItemOriginal, type Ticket as TicketOriginal, type TicketReservationBalance as TicketReservationBalanceOriginal, type TicketReservationBalanceUpdated as TicketReservationBalanceUpdatedOriginal, type TicketReservation as TicketReservationOriginal, Type as TypeOriginal, type TypeWithLiterals as TypeWithLiteralsOriginal, type UpdateCurrentTicketReservationRequest as UpdateCurrentTicketReservationRequestOriginal, type UpdateCurrentTicketReservationResponse as UpdateCurrentTicketReservationResponseOriginal, type UpdateTicketReservationCancelableRequest as UpdateTicketReservationCancelableRequestOriginal, type UpdateTicketReservationCancelableResponse as UpdateTicketReservationCancelableResponseOriginal, type UpdateTicketReservationRequest as UpdateTicketReservationRequestOriginal, type UpdateTicketReservationResponse as UpdateTicketReservationResponseOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, bulkUpdateTicketReservationTags, bulkUpdateTicketReservationTagsByFilter, cancelTicketReservation, createTicketReservation, deleteTicketReservation, getTicketReservation };