@wix/auto_sdk_events_orders 1.0.23 → 1.0.24

package/build/es/{events-v1-order-orders.universal-BK8XPFRp.d.mts → index.typings.d.mts}

@@ -1,3 +1,5 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+
 interface Order {
     /** Unique order number. */
     orderNumber?: string;
@@ -182,6 +184,8 @@ declare enum SubdivisionType {
     /** 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 {
     /**
@@ -618,6 +622,8 @@ declare enum ScheduledActionEnumAction {
     /** Void after the delay. */
     VOID = "VOID"
 }
+/** @enumType */
+type ScheduledActionEnumActionWithLiterals = ScheduledActionEnumAction | 'UNKNOWN_ACTION' | 'CAPTURE' | 'VOID';
 declare enum Action {
     /** Order can be archived. */
     ARCHIVE = "ARCHIVE",
@@ -630,6 +636,8 @@ declare enum Action {
     /** Order can be voided. */
     VOID = "VOID"
 }
+/** @enumType */
+type ActionWithLiterals = Action | 'ARCHIVE' | 'UNARCHIVE' | 'CONFIRM' | 'CAPTURE' | 'VOID';
 interface GiftCardPaymentDetails {
     /**
      * Gift card payment id.
@@ -2245,6 +2253,31 @@ interface QueryEventsWithPaidReservationsResponse {
      */
     eventIds?: string[] | null;
 }
+type UpdateOrderApplicationErrors = {
+    code?: 'ORDER_ACTION_NOT_AVAILABLE';
+    description?: string;
+    data?: Record<string, any>;
+};
+type BulkUpdateOrdersApplicationErrors = {
+    code?: 'ORDER_ACTION_NOT_AVAILABLE';
+    description?: string;
+    data?: Record<string, any>;
+};
+type ConfirmOrderApplicationErrors = {
+    code?: 'ORDER_ACTION_NOT_AVAILABLE';
+    description?: string;
+    data?: Record<string, any>;
+};
+type CaptureAuthorizedPaymentApplicationErrors = {
+    code?: 'ORDER_STATUS_NOT_AUTHORIZED';
+    description?: string;
+    data?: Record<string, any>;
+};
+type VoidAuthorizedPaymentApplicationErrors = {
+    code?: 'ORDER_STATUS_NOT_AUTHORIZED';
+    description?: string;
+    data?: Record<string, any>;
+};
 interface BaseEventMetadata {
     /**
      * App instance ID.
@@ -2263,26 +2296,142 @@ interface OrderDeletedEnvelope {
     data: OrderDeleted;
     metadata: BaseEventMetadata;
 }
+/**
+ * This event is triggered when an order is deleted via GDPR request.
+ * @permissionScope Read Events - all read permissions
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
+ * @permissionScope Manage Events - all permissions
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionScope Read Basic Events Order Info
+ * @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS
+ * @permissionScope Manage Orders
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
+ * @permissionId WIX_EVENTS.READ_ORDERS
+ * @webhook
+ * @eventType wix.events.ticketing.events.OrderDeleted
+ * @serviceIdentifier wix.events.ticketing.OrderManagement
+ * @slug order_deleted
+ */
+declare function onOrderDeleted(handler: (event: OrderDeletedEnvelope) => void | Promise<void>): void;
 interface OrderUpdatedEnvelope {
     data: OrderUpdated;
     metadata: BaseEventMetadata;
 }
+/** @permissionScope Read Events - all read permissions
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
+ * @permissionScope Manage Events - all permissions
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionScope Read Basic Events Order Info
+ * @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS
+ * @permissionScope Manage Orders
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
+ * @permissionId WIX_EVENTS.READ_ORDERS
+ * @webhook
+ * @eventType wix.events.ticketing.events.OrderUpdated
+ * @serviceIdentifier wix.events.ticketing.OrderManagement
+ * @slug order_updated
+ */
+declare function onOrderUpdated(handler: (event: OrderUpdatedEnvelope) => void | Promise<void>): void;
 interface OrderConfirmedEnvelope {
     data: OrderConfirmed;
     metadata: BaseEventMetadata;
 }
+/** @permissionScope Read Events - all read permissions
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
+ * @permissionScope Manage Events - all permissions
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionScope Read Basic Events Order Info
+ * @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS
+ * @permissionScope Manage Orders
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
+ * @permissionId WIX_EVENTS.READ_ORDERS
+ * @webhook
+ * @eventType wix.events.ticketing.events.OrderConfirmed
+ * @serviceIdentifier wix.events.ticketing.CheckoutService
+ * @slug order_confirmed
+ */
+declare function onOrderConfirmed(handler: (event: OrderConfirmedEnvelope) => void | Promise<void>): void;
 interface OrderInitiatedEnvelope {
     data: OrderInitiated;
     metadata: BaseEventMetadata;
 }
+/** @permissionScope Read Events - all read permissions
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
+ * @permissionScope Manage Events - all permissions
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionScope Read Basic Events Order Info
+ * @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS
+ * @permissionScope Manage Orders
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
+ * @permissionId WIX_EVENTS.READ_ORDERS
+ * @webhook
+ * @eventType wix.events.ticketing.events.OrderInitiated
+ * @serviceIdentifier wix.events.ticketing.CheckoutService
+ * @slug order_initiated
+ */
+declare function onOrderInitiated(handler: (event: OrderInitiatedEnvelope) => void | Promise<void>): void;
 interface OrderReservationCreatedEnvelope {
     data: ReservationCreated;
     metadata: BaseEventMetadata;
 }
+/** @permissionScope Read Events - all read permissions
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
+ * @permissionScope Manage Events - all permissions
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionScope Read Basic Events Order Info
+ * @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS
+ * @permissionScope Manage Orders
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
+ * @permissionId WIX_EVENTS.READ_INVOICE
+ * @webhook
+ * @eventType wix.events.ticketing.events.ReservationCreated
+ * @serviceIdentifier wix.events.ticketing.CheckoutService
+ * @slug reservation_created
+ */
+declare function onOrderReservationCreated(handler: (event: OrderReservationCreatedEnvelope) => void | Promise<void>): void;
 interface OrderReservationUpdatedEnvelope {
     data: ReservationUpdated;
     metadata: BaseEventMetadata;
 }
+/** @permissionScope Read Events - all read permissions
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
+ * @permissionScope Manage Events - all permissions
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionScope Read Basic Events Order Info
+ * @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS
+ * @permissionScope Manage Orders
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
+ * @permissionId WIX_EVENTS.READ_INVOICE
+ * @webhook
+ * @eventType wix.events.ticketing.events.ReservationUpdated
+ * @serviceIdentifier wix.events.ticketing.CheckoutService
+ * @slug reservation_updated
+ */
+declare function onOrderReservationUpdated(handler: (event: OrderReservationUpdatedEnvelope) => void | Promise<void>): void;
+type OrderNonNullablePaths = `orderNumber` | `reservationId` | `snapshotId` | `eventId` | `contactId` | `memberId` | `firstName` | `lastName` | `email` | `checkoutForm.inputValues` | `checkoutForm.inputValues.${number}.inputName` | `checkoutForm.inputValues.${number}.value` | `confirmed` | `status` | `method` | `ticketsQuantity` | `totalPrice.amount` | `totalPrice.currency` | `ticketsPdf` | `tickets` | `tickets.${number}.ticketNumber` | `tickets.${number}.orderNumber` | `tickets.${number}.ticketDefinitionId` | `tickets.${number}.name` | `tickets.${number}.price.amount` | `tickets.${number}.price.currency` | `tickets.${number}.free` | `tickets.${number}.policy` | `tickets.${number}.qrCode` | `tickets.${number}.orderStatus` | `tickets.${number}.orderArchived` | `tickets.${number}.orderFullName` | `tickets.${number}.guestDetails.guestAssigned` | `tickets.${number}.archived` | `tickets.${number}.ticketPdf` | `tickets.${number}.anonymized` | `tickets.${number}.checkInUrl` | `tickets.${number}.ticketPdfUrl` | `tickets.${number}.channel` | `tickets.${number}.walletPassUrl` | `archived` | `anonymized` | `fullName` | `invoice.items` | `invoice.items.${number}._id` | `invoice.items.${number}.quantity` | `invoice.items.${number}.name` | `invoice.items.${number}.price.amount` | `invoice.items.${number}.price.currency` | `invoice.items.${number}.discount.code` | `invoice.items.${number}.discount.name` | `invoice.items.${number}.discount.couponId` | `invoice.items.${number}.tax.type` | `invoice.items.${number}.tax.name` | `invoice.items.${number}.tax.rate` | `invoice.fees` | `fullyCheckedIn` | `paymentDetails.transaction.transactionId` | `paymentDetails.transaction.method` | `channel`;
+/**
+ * Retrieves a list of orders, including ticket data.
+ * @public
+ * @param options - An object representing the available options for retrieving a list of orders.
+ * @permissionId WIX_EVENTS.READ_ORDERS
+ * @applicableIdentity APP
+ * @fqn wix.events.ticketing.OrderManagement.ListOrders
+ */
+declare function listOrders(options?: ListOrdersOptions): Promise<NonNullablePaths<ListOrdersResponse, `total` | `offset` | `limit` | {
+    [P in OrderNonNullablePaths]: `orders.${number}.${P}`;
+}[OrderNonNullablePaths]>>;
 interface ListOrdersOptions {
     /** Offset. */
     offset?: number;
@@ -2363,6 +2512,23 @@ interface ListOrdersOptions {
      */
     contactId?: string[];
 }
+/**
+ * Retrieves an order, including ticket data.
+ * <!--
+ * >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
+ * @requiredField identifiers
+ * @requiredField identifiers.eventId
+ * @requiredField identifiers.orderNumber
+ * @param options - An object representing the available options for getting an order.
+ * @param identifiers - An object containing identifiers for the order to be retrieved.
+ * @permissionId WIX_EVENTS.READ_ORDERS
+ * @applicableIdentity APP
+ * @returns Requested order.
+ * @fqn wix.events.ticketing.OrderManagement.GetOrder
+ */
+declare function getOrder(identifiers: NonNullablePaths<GetOrderIdentifiers, `eventId` | `orderNumber`>, options?: GetOrderOptions): Promise<NonNullablePaths<Order, OrderNonNullablePaths>>;
 interface GetOrderIdentifiers {
     /**
      * Event ID to which the order belongs.
@@ -2388,6 +2554,23 @@ interface GetOrderOptions {
      */
     fieldset?: OrderFieldsetWithLiterals[];
 }
+/**
+ * Updates an order.
+ * @public
+ * @requiredField identifiers
+ * @requiredField identifiers.eventId
+ * @requiredField identifiers.orderNumber
+ * @param options - An object representing the available options for updating an order.
+ * @param identifiers - An object containing identifiers for the order to be updated.
+ * @permissionId WIX_EVENTS.MANAGE_ORDERS
+ * @applicableIdentity APP
+ * @fqn wix.events.ticketing.OrderManagement.UpdateOrder
+ */
+declare function updateOrder(identifiers: NonNullablePaths<UpdateOrderIdentifiers, `eventId` | `orderNumber`>, options?: UpdateOrderOptions): Promise<NonNullablePaths<UpdateOrderResponse, {
+    [P in OrderNonNullablePaths]: `order.${P}`;
+}[OrderNonNullablePaths]> & {
+    __applicationErrorsType?: UpdateOrderApplicationErrors;
+}>;
 interface UpdateOrderIdentifiers {
     /**
      * Event ID to which the order belongs.
@@ -2408,6 +2591,21 @@ interface UpdateOrderOptions {
     /** Whether to archive the order. */
     archived?: boolean;
 }
+/**
+ * Archives multiple orders.
+ * @public
+ * @requiredField eventId
+ * @param options - An object representing the available options for confirming an order.
+ * @param eventId - Event ID to which the order belongs.
+ * @permissionId WIX_EVENTS.MANAGE_ORDERS
+ * @applicableIdentity APP
+ * @fqn wix.events.ticketing.OrderManagement.BulkUpdateOrders
+ */
+declare function bulkUpdateOrders(eventId: string, options?: BulkUpdateOrdersOptions): Promise<NonNullablePaths<BulkUpdateOrdersResponse, {
+    [P in OrderNonNullablePaths]: `orders.${number}.${P}`;
+}[OrderNonNullablePaths]> & {
+    __applicationErrorsType?: BulkUpdateOrdersApplicationErrors;
+}>;
 interface BulkUpdateOrdersOptions {
     /**
      * Unique order number.
@@ -2422,6 +2620,25 @@ interface BulkUpdateOrdersOptions {
     /** Whether to archive the order. */
     archived?: boolean;
 }
+/**
+ * Confirms an order.
+ *
+ *
+ * This function changes order status from `INITIATED`, `PENDING`, `OFFLINE_PENDING` to `PAID`.
+ * Confirming orders with `INITIATED` or `PENDING` status triggers an email with the tickets to the buyer (and to additional guests, if provided).
+ * @public
+ * @requiredField eventId
+ * @param options - An object representing the available options for confirming an order.
+ * @param eventId - Event ID to which the order belongs.
+ * @permissionId WIX_EVENTS.MANAGE_ORDERS
+ * @applicableIdentity APP
+ * @fqn wix.events.ticketing.OrderManagement.ConfirmOrder
+ */
+declare function confirmOrder(eventId: string, options?: ConfirmOrderOptions): Promise<NonNullablePaths<ConfirmOrderResponse, {
+    [P in OrderNonNullablePaths]: `orders.${number}.${P}`;
+}[OrderNonNullablePaths]> & {
+    __applicationErrorsType?: ConfirmOrderApplicationErrors;
+}>;
 interface ConfirmOrderOptions {
     /**
      * Order numbers.
@@ -2431,6 +2648,18 @@ interface ConfirmOrderOptions {
      */
     orderNumber?: string[];
 }
+/**
+ * Retrieves a summary of total ticket sales.
+ * <!--
+ * > 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
+ * @param options - An object representing the available options for retrieving a summary of total ticket sales.
+ * @permissionId WIX_EVENTS.READ_ORDERS
+ * @applicableIdentity APP
+ * @fqn wix.events.ticketing.OrderManagement.GetSummary
+ */
+declare function getSummary(options?: GetSummaryOptions): Promise<NonNullablePaths<GetSummaryResponse, `sales` | `sales.${number}.total.amount` | `sales.${number}.total.currency` | `sales.${number}.totalOrders` | `sales.${number}.totalTickets`>>;
 interface GetSummaryOptions {
     /**
      * Event ID to which the order belongs.
@@ -2438,6 +2667,20 @@ interface GetSummaryOptions {
      */
     eventId?: string | null;
 }
+/**
+ * Captures authorized payment asynchronously.
+ * Eventually order will become paid.
+ * For orders with non-authorized payments request will fail.
+ * @param orderNumber - Order number.
+ * @public
+ * @requiredField orderNumber
+ * @permissionId WIX_EVENTS.MANAGE_ORDERS
+ * @applicableIdentity APP
+ * @fqn wix.events.ticketing.OrderManagement.CaptureAuthorizedPayment
+ */
+declare function captureAuthorizedPayment(orderNumber: string, options?: CaptureAuthorizedPaymentOptions): Promise<void & {
+    __applicationErrorsType?: CaptureAuthorizedPaymentApplicationErrors;
+}>;
 interface CaptureAuthorizedPaymentOptions {
     /**
      * Event ID.
@@ -2445,6 +2688,20 @@ interface CaptureAuthorizedPaymentOptions {
      */
     eventId?: string;
 }
+/**
+ * Voids authorized payment asynchronously.
+ * Eventually order will become voided.
+ * For orders with non-authorized payments request will fail.
+ * @param orderNumber - Order number.
+ * @public
+ * @requiredField orderNumber
+ * @permissionId WIX_EVENTS.MANAGE_ORDERS
+ * @applicableIdentity APP
+ * @fqn wix.events.ticketing.OrderManagement.VoidAuthorizedPayment
+ */
+declare function voidAuthorizedPayment(orderNumber: string, options?: VoidAuthorizedPaymentOptions): Promise<void & {
+    __applicationErrorsType?: VoidAuthorizedPaymentApplicationErrors;
+}>;
 interface VoidAuthorizedPaymentOptions {
     /**
      * Event ID.
@@ -2452,6 +2709,28 @@ interface VoidAuthorizedPaymentOptions {
      */
     eventId?: string;
 }
+/**
+ * Retrieves checkout details.
+ * @public
+ * @permissionId WIX_EVENTS.READ_CHECKOUT
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn wix.events.ticketing.CheckoutService.GetCheckoutOptions
+ */
+declare function getCheckoutOptions(): Promise<NonNullablePaths<GetCheckoutOptionsResponse, `paymentMethodConfigured` | `acceptCoupons` | `premiumServices` | `paidTickets` | `acceptGiftCards`>>;
+/**
+ * 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
+ * @param options - An object representing the available options for retrieving a list of tickets available for reservation.
+ * @permissionId WIX_EVENTS.READ_CHECKOUT
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn wix.events.ticketing.CheckoutService.ListAvailableTickets
+ */
+declare function listAvailableTickets(options?: ListAvailableTicketsOptions): Promise<NonNullablePaths<ListAvailableTicketsResponse, `metaData.count` | `metaData.offset` | `metaData.total` | `definitions` | `definitions.${number}._id` | `definitions.${number}.price.amount` | `definitions.${number}.price.currency` | `definitions.${number}.free` | `definitions.${number}.name` | `definitions.${number}.description` | `definitions.${number}.limitPerCheckout` | `definitions.${number}.orderIndex` | `definitions.${number}.policy` | `definitions.${number}.dashboard.hidden` | `definitions.${number}.dashboard.sold` | `definitions.${number}.dashboard.limited` | `definitions.${number}.dashboard.ticketsSold` | `definitions.${number}.dashboard.ticketsReserved` | `definitions.${number}.eventId` | `definitions.${number}.wixFeeConfig.type` | `definitions.${number}.salePeriod.hideNotOnSale` | `definitions.${number}.saleStatus` | `definitions.${number}.pricing.pricingType`>>;
 interface ListAvailableTicketsOptions {
     /**
      * Event ID to list tickets for. If not provided, available tickets for all events in the site will be returned.
@@ -2473,6 +2752,19 @@ interface ListAvailableTicketsOptions {
     sort?: string;
     state?: StateWithLiterals[];
 }
+/**
+ * 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
+ * @param options - An object representing the available options for retrieving a list of tickets available for reservation.
+ * @permissionId WIX_EVENTS.READ_CHECKOUT
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn wix.events.ticketing.CheckoutService.QueryAvailableTickets
+ */
+declare function queryAvailableTickets(options?: QueryAvailableTicketsOptions): Promise<NonNullablePaths<QueryAvailableTicketsResponse, `metaData.count` | `metaData.offset` | `metaData.total` | `definitions` | `definitions.${number}._id` | `definitions.${number}.price.amount` | `definitions.${number}.price.currency` | `definitions.${number}.free` | `definitions.${number}.name` | `definitions.${number}.description` | `definitions.${number}.limitPerCheckout` | `definitions.${number}.orderIndex` | `definitions.${number}.policy` | `definitions.${number}.dashboard.hidden` | `definitions.${number}.dashboard.sold` | `definitions.${number}.dashboard.limited` | `definitions.${number}.dashboard.ticketsSold` | `definitions.${number}.dashboard.ticketsReserved` | `definitions.${number}.eventId` | `definitions.${number}.wixFeeConfig.type` | `definitions.${number}.salePeriod.hideNotOnSale` | `definitions.${number}.saleStatus` | `definitions.${number}.pricing.pricingType`>>;
 interface QueryAvailableTicketsOptions {
     /** Offset. */
     offset?: number;
@@ -2495,6 +2787,22 @@ interface QueryAvailableTicketsOptions {
      */
     sort?: string;
 }
+/**
+ * Reserves tickets for 20 minutes.
+ *
+ *
+ * Reserved tickets are deducted from ticket stock and cannot be bought by another site visitor.
+ * When the reservation expires, the tickets are added back to the stock.
+ * @public
+ * @requiredField eventId
+ * @param options - An object representing the available options for creating a reservation.
+ * @param eventId - Event ID to which the reservation belongs.
+ * @permissionId WIX_EVENTS.CHECKOUT
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn wix.events.ticketing.CheckoutService.CreateReservation
+ */
+declare function createReservation(eventId: string, options?: CreateReservationOptions): Promise<NonNullablePaths<CreateReservationResponse, `_id` | `reservations` | `reservations.${number}.quantity` | `reservations.${number}.ticket._id` | `reservations.${number}.ticket.price.amount` | `reservations.${number}.ticket.price.currency` | `reservations.${number}.ticket.free` | `reservations.${number}.ticket.name` | `reservations.${number}.ticket.description` | `reservations.${number}.ticket.limitPerCheckout` | `reservations.${number}.ticket.orderIndex` | `reservations.${number}.ticket.policy` | `reservations.${number}.ticket.dashboard.hidden` | `reservations.${number}.ticket.dashboard.sold` | `reservations.${number}.ticket.dashboard.limited` | `reservations.${number}.ticket.dashboard.ticketsSold` | `reservations.${number}.ticket.dashboard.ticketsReserved` | `reservations.${number}.ticket.eventId` | `reservations.${number}.ticket.wixFeeConfig.type` | `reservations.${number}.ticket.salePeriod.hideNotOnSale` | `reservations.${number}.ticket.saleStatus` | `reservations.${number}.ticket.pricing.pricingType` | `invoice.items` | `invoice.items.${number}._id` | `invoice.items.${number}.quantity` | `invoice.items.${number}.name` | `invoice.items.${number}.price.amount` | `invoice.items.${number}.price.currency` | `invoice.items.${number}.discount.code` | `invoice.items.${number}.discount.name` | `invoice.items.${number}.discount.couponId` | `invoice.items.${number}.tax.type` | `invoice.items.${number}.tax.name` | `invoice.items.${number}.tax.rate` | `invoice.fees` | `reservationStatus`>>;
 interface CreateReservationOptions {
     /**
      * Tickets to reserve.
@@ -2507,12 +2815,69 @@ interface CreateReservationOptions {
     /** Whether to allow reservations 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.
+ * -->
+ * @param _id - Reservation ID.
+ * @public
+ * @requiredField _id
+ * @requiredField eventId
+ * @param identifiers - An object containing identifiers for the reservation to be cancelled.
+ * @param eventId - Event ID to which the reservation belongs.
+ * @permissionId WIX_EVENTS.CHECKOUT
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn wix.events.ticketing.CheckoutService.CancelReservation
+ */
+declare function cancelReservation(_id: string, eventId: string): Promise<void>;
+/**
+ * Generates a preview of an invoice, including the given coupon or pricing plan.
+ * @param reservationId - Reservation ID.
+ * @public
+ * @requiredField eventId
+ * @requiredField 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.
+ * @param eventId - Event ID to which the invoice belongs.
+ * @permissionId WIX_EVENTS.READ_INVOICE
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn wix.events.ticketing.CheckoutService.GetInvoice
+ */
+declare function getInvoice(reservationId: string, eventId: string, options?: GetInvoiceOptions): Promise<NonNullablePaths<GetInvoiceResponse, `invoice.items` | `invoice.items.${number}._id` | `invoice.items.${number}.quantity` | `invoice.items.${number}.name` | `invoice.items.${number}.price.amount` | `invoice.items.${number}.price.currency` | `invoice.items.${number}.discount.code` | `invoice.items.${number}.discount.name` | `invoice.items.${number}.discount.couponId` | `invoice.items.${number}.tax.type` | `invoice.items.${number}.tax.name` | `invoice.items.${number}.tax.rate` | `invoice.fees` | `discountErrors.error` | `discountErrors.error.${number}.code` | `reservationStatus` | `reservationOccupied` | `reservations` | `reservations.${number}.quantity` | `reservations.${number}.ticket._id` | `reservations.${number}.ticket.price.amount` | `reservations.${number}.ticket.price.currency` | `reservations.${number}.ticket.free` | `reservations.${number}.ticket.name` | `reservations.${number}.ticket.description` | `reservations.${number}.ticket.limitPerCheckout` | `reservations.${number}.ticket.orderIndex` | `reservations.${number}.ticket.policy` | `reservations.${number}.ticket.dashboard.hidden` | `reservations.${number}.ticket.dashboard.sold` | `reservations.${number}.ticket.dashboard.limited` | `reservations.${number}.ticket.dashboard.ticketsSold` | `reservations.${number}.ticket.dashboard.ticketsReserved` | `reservations.${number}.ticket.eventId` | `reservations.${number}.ticket.wixFeeConfig.type` | `reservations.${number}.ticket.salePeriod.hideNotOnSale` | `reservations.${number}.ticket.saleStatus` | `reservations.${number}.ticket.pricing.pricingType`>>;
 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;
 }
+/**
+ * Checkouts the reserved tickets.
+ *
+ *
+ * Creates an order and associates it with a site visitor contact.
+ * Guest details are received from the [Registration Form](https://www.wix.com/velo/reference/wix-events-v2/forms/introduction) input fields.
+ *
+ * There is a possibility to use a separate ready-made Wix checkout form where the user will be redirected from your non-Wix site or a custom ticket picker created with Velo.
+ * To build the checkout form path, get your event base URL by using the [`getEvent()`](https://www.wix.com/velo/reference/wix-events-backend/wixevents/getevent) function and add the following path:
+ * `/{{EVENT_PAGE_SLUG}}/{{SLUG}}/ticket-form?reservationId={{YOUR_RESERVATION_ID}}`
+ *
+ * Example:  `https://johndoe.wixsite.com/weddings/event-details/doe-wedding/ticket-form?reservationId=2be6d34a-2a1e-459f-897b-b4a66e73f69a`
+ * @public
+ * @requiredField eventId
+ * @requiredField options.guests.form
+ * @param options - An object representing the available options for checking out a reserved ticket.
+ * @param eventId - Event ID to which the checkout belongs.
+ * @permissionId WIX_EVENTS.CHECKOUT
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn wix.events.ticketing.CheckoutService.Checkout
+ */
+declare function checkout(eventId: string, options?: NonNullablePaths<CheckoutOptionsForRequest, `guests.${number}.form`>): Promise<NonNullablePaths<CheckoutResponse, {
+    [P in OrderNonNullablePaths]: `order.${P}`;
+}[OrderNonNullablePaths] | `reservations` | `reservations.${number}.quantity` | `reservations.${number}.ticket._id` | `reservations.${number}.ticket.price.amount` | `reservations.${number}.ticket.price.currency` | `reservations.${number}.ticket.free` | `reservations.${number}.ticket.name` | `reservations.${number}.ticket.description` | `reservations.${number}.ticket.limitPerCheckout` | `reservations.${number}.ticket.orderIndex` | `reservations.${number}.ticket.policy` | `reservations.${number}.ticket.dashboard.hidden` | `reservations.${number}.ticket.dashboard.sold` | `reservations.${number}.ticket.dashboard.limited` | `reservations.${number}.ticket.dashboard.ticketsSold` | `reservations.${number}.ticket.dashboard.ticketsReserved` | `reservations.${number}.ticket.eventId` | `reservations.${number}.ticket.wixFeeConfig.type` | `reservations.${number}.ticket.salePeriod.hideNotOnSale` | `reservations.${number}.ticket.saleStatus` | `reservations.${number}.ticket.pricing.pricingType`>>;
 interface CheckoutOptionsForRequest {
     /**
      * Ticket reservation ID.
@@ -2538,6 +2903,26 @@ interface CheckoutOptionsForRequest {
     /** Whether marketing consent was given */
     marketingConsent?: boolean | null;
 }
+/**
+ * Updates order and tickets.
+ *
+ *
+ * Only applicable for orders with `INITIATED`, `PENDING`, `OFFLINE_PENDING` statuses.
+ * @param orderNumber - Unique order number.
+ * @public
+ * @requiredField eventId
+ * @requiredField 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.
+ * @param eventId - Event ID to which the checkout belongs.
+ * @permissionId WIX_EVENTS.CHECKOUT
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn wix.events.ticketing.CheckoutService.UpdateCheckout
+ */
+declare function updateCheckout(orderNumber: string, eventId: string, options?: UpdateCheckoutOptions): Promise<NonNullablePaths<UpdateCheckoutResponse, {
+    [P in OrderNonNullablePaths]: `order.${P}`;
+}[OrderNonNullablePaths]>>;
 interface UpdateCheckoutOptions {
     /** Buyer details. */
     buyer?: Buyer;
@@ -2558,6 +2943,20 @@ interface UpdateCheckoutOptions {
     /** Benefit granted by the pricing plan. */
     paidPlanBenefit?: PaidPlanBenefit;
 }
+/**
+ * Creates order with payment details already initiated via Cashier Pay API.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField eventId
+ * @requiredField options.reservationId
+ * @param eventId - Event ID to which the checkout belongs.
+ * @permissionId WIX_EVENTS.MANAGE_ORDERS
+ * @applicableIdentity APP
+ * @fqn wix.events.ticketing.CheckoutService.PosCheckout
+ */
+declare function posCheckout(eventId: string, options?: NonNullablePaths<PosCheckoutOptions, `reservationId`>): Promise<NonNullablePaths<PosCheckoutResponse, {
+    [P in OrderNonNullablePaths]: `order.${P}`;
+}[OrderNonNullablePaths] | `reservations` | `reservations.${number}.quantity` | `reservations.${number}.ticket._id` | `reservations.${number}.ticket.price.amount` | `reservations.${number}.ticket.price.currency` | `reservations.${number}.ticket.free` | `reservations.${number}.ticket.name` | `reservations.${number}.ticket.description` | `reservations.${number}.ticket.limitPerCheckout` | `reservations.${number}.ticket.orderIndex` | `reservations.${number}.ticket.policy` | `reservations.${number}.ticket.dashboard.hidden` | `reservations.${number}.ticket.dashboard.sold` | `reservations.${number}.ticket.dashboard.limited` | `reservations.${number}.ticket.dashboard.ticketsSold` | `reservations.${number}.ticket.dashboard.ticketsReserved` | `reservations.${number}.ticket.eventId` | `reservations.${number}.ticket.wixFeeConfig.type` | `reservations.${number}.ticket.salePeriod.hideNotOnSale` | `reservations.${number}.ticket.saleStatus` | `reservations.${number}.ticket.pricing.pricingType`>>;
 interface PosCheckoutOptions {
     /**
      * Ticket reservation ID.
@@ -2572,4 +2971,4 @@ interface PosCheckoutOptions {
     paymentDetailsId?: string | null;
 }
 
-export { TicketDefinitionFieldset as $, type OrderReservationCreatedEnvelope as A, type BulkUpdateOrdersOptions as B, type ConfirmOrderOptions as C, type OrderReservationUpdatedEnvelope as D, OrderStatus as E, ChannelType as F, type GetOrderIdentifiers as G, FeeName as H, FeeType as I, ScheduledActionEnumAction as J, Action as K, type ListOrdersOptions as L, OrderType as M, OrderFieldset as N, type Order as O, type PosCheckoutOptions as P, type QueryAvailableTicketsOptions as Q, OrderTag as R, SubdivisionType as S, TaxType as T, type UpdateOrderIdentifiers as U, type VoidAuthorizedPaymentOptions as V, WebhookIdentityType as W, ReservationStatus as X, State as Y, TicketSaleStatus as Z, Type as _, type ListOrdersResponse as a, type OrderPaid as a$, type FormResponse as a0, type InputValue as a1, type FormattedAddress as a2, type Address as a3, type AddressStreetOneOf as a4, type StreetAddress as a5, type AddressLocation as a6, type Subdivision as a7, type StandardDetails as a8, type Money as a9, type Counts as aA, type GetOrderRequest as aB, type GetOrderResponse as aC, type CalendarLinks as aD, type UpdateOrderRequest as aE, type OrderUpdated as aF, type BulkUpdateOrdersRequest as aG, type ConfirmOrderRequest as aH, type GetSummaryRequest as aI, type TicketSales as aJ, type GetInvoicePreviewRequest as aK, type RawHttpResponse as aL, type HeadersEntry as aM, type GetPaymentInfoRequest as aN, type GetPaymentInfoResponse as aO, type PaymentTransactionSummary as aP, type PaymentTransactionEvent as aQ, type CaptureAuthorizedPaymentRequest as aR, type CaptureAuthorizedPaymentResponse as aS, type VoidAuthorizedPaymentRequest as aT, type VoidAuthorizedPaymentResponse as aU, type FindOrderByReservationIdRequest as aV, type FindOrderByReservationIdResponse as aW, type MessageEnvelope as aX, type IdentificationData as aY, type IdentificationDataIdOneOf as aZ, type OrderConfirmed as a_, type TicketingTicket as aa, type CheckIn as ab, type GuestDetails as ac, type TicketDetails as ad, type Invoice as ae, type Item as af, type Discount as ag, type DiscountItem as ah, type DiscountItemDiscountOneOf as ai, type CouponDiscount as aj, type PaidPlanDiscount as ak, type PaidPlanDiscountDiscountOneOf as al, type PercentDiscount as am, type Tax as an, type Fee as ao, type PaymentDetails as ap, type PaymentTransaction as aq, type GiftCardPaymentDetails as ar, type BalanceSummary as as, type OrderDeleted as at, type Ticket as au, type OnlineConferencingLogin as av, type ListOrdersRequest as aw, type FacetCounts as ax, type OrderFacets as ay, type OrderFacetCounts as az, type GetOrderOptions as b, type ReservationCreated as b0, type TicketQuantity as b1, type ReservationCount as b2, type ReservationUpdated as b3, type GetCheckoutOptionsRequest as b4, type ListAvailableTicketsRequest as b5, type ResponseMetaData as b6, type TicketDefinition as b7, type Dashboard as b8, type WixFeeConfig as b9, type GetReservationRequest as bA, type GetReservationResponse as bB, type Reservation as bC, type ConfirmReservationRequest as bD, type ConfirmReservationResponse as bE, type ExpireReservationRequest as bF, type ExpireReservationResponse as bG, type QueryEventsWithPaidReservationsRequest as bH, type EventKey as bI, type QueryEventsWithPaidReservationsResponse as bJ, type BaseEventMetadata as bK, type TicketSalePeriod as ba, type TicketPricing as bb, type TicketPricingPriceOneOf as bc, type PricingOptions as bd, type PricingOption as be, type QueryAvailableTicketsRequest as bf, type CreateReservationRequest as bg, type TicketReservationQuantity as bh, type TicketReservation as bi, type CancelReservationRequest as bj, type CancelReservationResponse as bk, type GetInvoiceRequest as bl, type DiscountRequest as bm, type PaidPlanBenefit as bn, type DiscountErrors as bo, type Error as bp, type GiftCardErrors as bq, type GiftCardErrorsError as br, type CheckoutRequest as bs, type Buyer as bt, type Guest as bu, type CheckoutOptions as bv, type OrderInitiated as bw, type UpdateCheckoutRequest as bx, type OrderPageUrls as by, type PosCheckoutRequest as bz, type UpdateOrderOptions as c, type UpdateOrderResponse as d, type BulkUpdateOrdersResponse as e, type ConfirmOrderResponse as f, type GetSummaryOptions as g, type GetSummaryResponse as h, type CaptureAuthorizedPaymentOptions as i, type GetCheckoutOptionsResponse as j, type ListAvailableTicketsOptions as k, type ListAvailableTicketsResponse as l, type QueryAvailableTicketsResponse as m, type CreateReservationOptions as n, type CreateReservationResponse as o, type GetInvoiceOptions as p, type GetInvoiceResponse as q, type CheckoutOptionsForRequest as r, type CheckoutResponse as s, type UpdateCheckoutOptions as t, type UpdateCheckoutResponse as u, type PosCheckoutResponse as v, type OrderDeletedEnvelope as w, type OrderUpdatedEnvelope as x, type OrderConfirmedEnvelope as y, type OrderInitiatedEnvelope as z };
+export { Action, type ActionWithLiterals, type Address, type AddressLocation, type AddressStreetOneOf, type BalanceSummary, type BaseEventMetadata, type BulkUpdateOrdersApplicationErrors, type BulkUpdateOrdersOptions, type BulkUpdateOrdersRequest, type BulkUpdateOrdersResponse, type Buyer, type CalendarLinks, type CancelReservationRequest, type CancelReservationResponse, type CaptureAuthorizedPaymentApplicationErrors, type CaptureAuthorizedPaymentOptions, type CaptureAuthorizedPaymentRequest, type CaptureAuthorizedPaymentResponse, ChannelType, type ChannelTypeWithLiterals, type CheckIn, type CheckoutOptions, type CheckoutOptionsForRequest, type CheckoutRequest, type CheckoutResponse, type ConfirmOrderApplicationErrors, type ConfirmOrderOptions, type ConfirmOrderRequest, type ConfirmOrderResponse, type ConfirmReservationRequest, type ConfirmReservationResponse, type Counts, type CouponDiscount, type CreateReservationOptions, type CreateReservationRequest, type CreateReservationResponse, type Dashboard, type Discount, type DiscountErrors, type DiscountItem, type DiscountItemDiscountOneOf, type DiscountRequest, type Error, type EventKey, type ExpireReservationRequest, type ExpireReservationResponse, type FacetCounts, type Fee, FeeName, type FeeNameWithLiterals, FeeType, type FeeTypeWithLiterals, type FindOrderByReservationIdRequest, type FindOrderByReservationIdResponse, type FormResponse, type FormattedAddress, type GetCheckoutOptionsRequest, type GetCheckoutOptionsResponse, type GetInvoiceOptions, type GetInvoicePreviewRequest, type GetInvoiceRequest, type GetInvoiceResponse, type GetOrderIdentifiers, type GetOrderOptions, type GetOrderRequest, type GetOrderResponse, type GetPaymentInfoRequest, type GetPaymentInfoResponse, type GetReservationRequest, type GetReservationResponse, type GetSummaryOptions, type GetSummaryRequest, type GetSummaryResponse, type GiftCardErrors, type GiftCardErrorsError, type GiftCardPaymentDetails, type Guest, type GuestDetails, type HeadersEntry, type IdentificationData, type IdentificationDataIdOneOf, type InputValue, type Invoice, type Item, type ListAvailableTicketsOptions, type ListAvailableTicketsRequest, type ListAvailableTicketsResponse, type ListOrdersOptions, type ListOrdersRequest, type ListOrdersResponse, type MessageEnvelope, type Money, type OnlineConferencingLogin, type Order, type OrderConfirmed, type OrderConfirmedEnvelope, type OrderDeleted, type OrderDeletedEnvelope, type OrderFacetCounts, type OrderFacets, OrderFieldset, type OrderFieldsetWithLiterals, type OrderInitiated, type OrderInitiatedEnvelope, type OrderPageUrls, type OrderPaid, type OrderReservationCreatedEnvelope, type OrderReservationUpdatedEnvelope, OrderStatus, type OrderStatusWithLiterals, OrderTag, type OrderTagWithLiterals, OrderType, type OrderTypeWithLiterals, type OrderUpdated, type OrderUpdatedEnvelope, type PaidPlanBenefit, type PaidPlanDiscount, type PaidPlanDiscountDiscountOneOf, type PaymentDetails, type PaymentTransaction, type PaymentTransactionEvent, type PaymentTransactionSummary, type PercentDiscount, type PosCheckoutOptions, type PosCheckoutRequest, type PosCheckoutResponse, type PricingOption, type PricingOptions, type QueryAvailableTicketsOptions, type QueryAvailableTicketsRequest, type QueryAvailableTicketsResponse, type QueryEventsWithPaidReservationsRequest, type QueryEventsWithPaidReservationsResponse, type RawHttpResponse, type Reservation, type ReservationCount, type ReservationCreated, ReservationStatus, type ReservationStatusWithLiterals, type ReservationUpdated, type ResponseMetaData, ScheduledActionEnumAction, type ScheduledActionEnumActionWithLiterals, type StandardDetails, State, type StateWithLiterals, type StreetAddress, type Subdivision, SubdivisionType, type SubdivisionTypeWithLiterals, type Tax, TaxType, type TaxTypeWithLiterals, type Ticket, type TicketDefinition, TicketDefinitionFieldset, type TicketDefinitionFieldsetWithLiterals, type TicketDetails, type TicketPricing, type TicketPricingPriceOneOf, type TicketQuantity, type TicketReservation, type TicketReservationQuantity, type TicketSalePeriod, TicketSaleStatus, type TicketSaleStatusWithLiterals, type TicketSales, type TicketingTicket, Type, type TypeWithLiterals, type UpdateCheckoutOptions, type UpdateCheckoutRequest, type UpdateCheckoutResponse, type UpdateOrderApplicationErrors, type UpdateOrderIdentifiers, type UpdateOrderOptions, type UpdateOrderRequest, type UpdateOrderResponse, type VoidAuthorizedPaymentApplicationErrors, type VoidAuthorizedPaymentOptions, type VoidAuthorizedPaymentRequest, type VoidAuthorizedPaymentResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type WixFeeConfig, bulkUpdateOrders, cancelReservation, captureAuthorizedPayment, checkout, confirmOrder, createReservation, getCheckoutOptions, getInvoice, getOrder, getSummary, listAvailableTickets, listOrders, onOrderConfirmed, onOrderDeleted, onOrderInitiated, onOrderReservationCreated, onOrderReservationUpdated, onOrderUpdated, posCheckout, queryAvailableTickets, updateCheckout, updateOrder, voidAuthorizedPayment };