@wix/auto_sdk_events_orders 1.0.32 → 1.0.34
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +14 -14
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +14 -22
- package/build/cjs/index.typings.js.map +1 -1
- package/build/es/index.d.mts +14 -14
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +14 -22
- package/build/es/index.typings.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +14 -14
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +14 -22
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/es/index.d.mts +14 -14
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +14 -22
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -2429,7 +2429,7 @@ declare function onOrderReservationUpdated(handler: (event: OrderReservationUpda
|
|
|
2429
2429
|
* @applicableIdentity APP
|
|
2430
2430
|
* @fqn wix.events.ticketing.OrderManagement.ListOrders
|
|
2431
2431
|
*/
|
|
2432
|
-
declare function listOrders(options?: ListOrdersOptions): Promise<NonNullablePaths<ListOrdersResponse, `total` | `offset` | `limit` | `orders` | `orders.${number}.orderNumber` | `orders.${number}.reservationId` | `orders.${number}.snapshotId` | `orders.${number}.eventId` | `orders.${number}.contactId` | `orders.${number}.memberId` | `orders.${number}.firstName` | `orders.${number}.lastName` | `orders.${number}.email` | `orders.${number}.confirmed` | `orders.${number}.status` | `orders.${number}.method` | `orders.${number}.ticketsQuantity` | `orders.${number}.totalPrice.amount` | `orders.${number}.totalPrice.currency` | `orders.${number}.ticketsPdf` | `orders.${number}.archived` | `orders.${number}.anonymized` | `orders.${number}.fullName` | `orders.${number}.invoice.discount.code` | `orders.${number}.invoice.discount.name` | `orders.${number}.invoice.discount.couponId` | `orders.${number}.invoice.tax.type` | `orders.${number}.invoice.tax.name` | `orders.${number}.invoice.tax.rate` | `orders.${number}.fullyCheckedIn` | `orders.${number}.paymentDetails.transaction.transactionId` | `orders.${number}.paymentDetails.transaction.method` | `orders.${number}.channel
|
|
2432
|
+
declare function listOrders(options?: ListOrdersOptions): Promise<NonNullablePaths<ListOrdersResponse, `total` | `offset` | `limit` | `orders` | `orders.${number}.orderNumber` | `orders.${number}.reservationId` | `orders.${number}.snapshotId` | `orders.${number}.eventId` | `orders.${number}.contactId` | `orders.${number}.memberId` | `orders.${number}.firstName` | `orders.${number}.lastName` | `orders.${number}.email` | `orders.${number}.confirmed` | `orders.${number}.status` | `orders.${number}.method` | `orders.${number}.ticketsQuantity` | `orders.${number}.totalPrice.amount` | `orders.${number}.totalPrice.currency` | `orders.${number}.ticketsPdf` | `orders.${number}.archived` | `orders.${number}.anonymized` | `orders.${number}.fullName` | `orders.${number}.invoice.discount.code` | `orders.${number}.invoice.discount.name` | `orders.${number}.invoice.discount.couponId` | `orders.${number}.invoice.tax.type` | `orders.${number}.invoice.tax.name` | `orders.${number}.invoice.tax.rate` | `orders.${number}.fullyCheckedIn` | `orders.${number}.paymentDetails.transaction.transactionId` | `orders.${number}.paymentDetails.transaction.method` | `orders.${number}.channel`, 6>>;
|
|
2433
2433
|
interface ListOrdersOptions {
|
|
2434
2434
|
/** Offset. */
|
|
2435
2435
|
offset?: number;
|
|
@@ -2526,7 +2526,7 @@ interface ListOrdersOptions {
|
|
|
2526
2526
|
* @returns Requested order.
|
|
2527
2527
|
* @fqn wix.events.ticketing.OrderManagement.GetOrder
|
|
2528
2528
|
*/
|
|
2529
|
-
declare function getOrder(identifiers: NonNullablePaths<GetOrderIdentifiers, `eventId` | `orderNumber
|
|
2529
|
+
declare function getOrder(identifiers: NonNullablePaths<GetOrderIdentifiers, `eventId` | `orderNumber`, 2>, options?: GetOrderOptions): Promise<NonNullablePaths<Order, `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}.free` | `tickets.${number}.policy` | `tickets.${number}.orderStatus` | `tickets.${number}.orderArchived` | `tickets.${number}.orderFullName` | `tickets.${number}.guestDetails.guestAssigned` | `tickets.${number}.archived` | `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}.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`, 6>>;
|
|
2530
2530
|
interface GetOrderIdentifiers {
|
|
2531
2531
|
/**
|
|
2532
2532
|
* Event ID to which the order belongs.
|
|
@@ -2564,7 +2564,7 @@ interface GetOrderOptions {
|
|
|
2564
2564
|
* @applicableIdentity APP
|
|
2565
2565
|
* @fqn wix.events.ticketing.OrderManagement.UpdateOrder
|
|
2566
2566
|
*/
|
|
2567
|
-
declare function updateOrder(identifiers: NonNullablePaths<UpdateOrderIdentifiers, `eventId` | `orderNumber
|
|
2567
|
+
declare function updateOrder(identifiers: NonNullablePaths<UpdateOrderIdentifiers, `eventId` | `orderNumber`, 2>, options?: UpdateOrderOptions): Promise<NonNullablePaths<UpdateOrderResponse, `order.orderNumber` | `order.reservationId` | `order.snapshotId` | `order.eventId` | `order.contactId` | `order.memberId` | `order.firstName` | `order.lastName` | `order.email` | `order.checkoutForm.inputValues` | `order.checkoutForm.inputValues.${number}.inputName` | `order.checkoutForm.inputValues.${number}.value` | `order.confirmed` | `order.status` | `order.method` | `order.ticketsQuantity` | `order.totalPrice.amount` | `order.totalPrice.currency` | `order.ticketsPdf` | `order.tickets` | `order.tickets.${number}.ticketNumber` | `order.tickets.${number}.orderNumber` | `order.tickets.${number}.ticketDefinitionId` | `order.tickets.${number}.name` | `order.tickets.${number}.free` | `order.tickets.${number}.policy` | `order.tickets.${number}.orderStatus` | `order.tickets.${number}.orderArchived` | `order.tickets.${number}.orderFullName` | `order.tickets.${number}.guestDetails.guestAssigned` | `order.tickets.${number}.archived` | `order.tickets.${number}.anonymized` | `order.tickets.${number}.checkInUrl` | `order.tickets.${number}.ticketPdfUrl` | `order.tickets.${number}.channel` | `order.tickets.${number}.walletPassUrl` | `order.archived` | `order.anonymized` | `order.fullName` | `order.invoice.items` | `order.invoice.items.${number}._id` | `order.invoice.items.${number}.quantity` | `order.invoice.items.${number}.name` | `order.invoice.items.${number}.discount.code` | `order.invoice.items.${number}.discount.name` | `order.invoice.items.${number}.discount.couponId` | `order.invoice.items.${number}.tax.type` | `order.invoice.items.${number}.tax.name` | `order.invoice.items.${number}.tax.rate` | `order.invoice.fees` | `order.fullyCheckedIn` | `order.paymentDetails.transaction.transactionId` | `order.paymentDetails.transaction.method` | `order.channel`, 7> & {
|
|
2568
2568
|
__applicationErrorsType?: UpdateOrderApplicationErrors;
|
|
2569
2569
|
}>;
|
|
2570
2570
|
interface UpdateOrderIdentifiers {
|
|
@@ -2597,7 +2597,7 @@ interface UpdateOrderOptions {
|
|
|
2597
2597
|
* @applicableIdentity APP
|
|
2598
2598
|
* @fqn wix.events.ticketing.OrderManagement.BulkUpdateOrders
|
|
2599
2599
|
*/
|
|
2600
|
-
declare function bulkUpdateOrders(eventId: string, options?: BulkUpdateOrdersOptions): Promise<NonNullablePaths<BulkUpdateOrdersResponse, `orders` | `orders.${number}.orderNumber` | `orders.${number}.reservationId` | `orders.${number}.snapshotId` | `orders.${number}.eventId` | `orders.${number}.contactId` | `orders.${number}.memberId` | `orders.${number}.firstName` | `orders.${number}.lastName` | `orders.${number}.email` | `orders.${number}.confirmed` | `orders.${number}.status` | `orders.${number}.method` | `orders.${number}.ticketsQuantity` | `orders.${number}.totalPrice.amount` | `orders.${number}.totalPrice.currency` | `orders.${number}.ticketsPdf` | `orders.${number}.archived` | `orders.${number}.anonymized` | `orders.${number}.fullName` | `orders.${number}.invoice.discount.code` | `orders.${number}.invoice.discount.name` | `orders.${number}.invoice.discount.couponId` | `orders.${number}.invoice.tax.type` | `orders.${number}.invoice.tax.name` | `orders.${number}.invoice.tax.rate` | `orders.${number}.fullyCheckedIn` | `orders.${number}.paymentDetails.transaction.transactionId` | `orders.${number}.paymentDetails.transaction.method` | `orders.${number}.channel
|
|
2600
|
+
declare function bulkUpdateOrders(eventId: string, options?: BulkUpdateOrdersOptions): Promise<NonNullablePaths<BulkUpdateOrdersResponse, `orders` | `orders.${number}.orderNumber` | `orders.${number}.reservationId` | `orders.${number}.snapshotId` | `orders.${number}.eventId` | `orders.${number}.contactId` | `orders.${number}.memberId` | `orders.${number}.firstName` | `orders.${number}.lastName` | `orders.${number}.email` | `orders.${number}.confirmed` | `orders.${number}.status` | `orders.${number}.method` | `orders.${number}.ticketsQuantity` | `orders.${number}.totalPrice.amount` | `orders.${number}.totalPrice.currency` | `orders.${number}.ticketsPdf` | `orders.${number}.archived` | `orders.${number}.anonymized` | `orders.${number}.fullName` | `orders.${number}.invoice.discount.code` | `orders.${number}.invoice.discount.name` | `orders.${number}.invoice.discount.couponId` | `orders.${number}.invoice.tax.type` | `orders.${number}.invoice.tax.name` | `orders.${number}.invoice.tax.rate` | `orders.${number}.fullyCheckedIn` | `orders.${number}.paymentDetails.transaction.transactionId` | `orders.${number}.paymentDetails.transaction.method` | `orders.${number}.channel`, 6> & {
|
|
2601
2601
|
__applicationErrorsType?: BulkUpdateOrdersApplicationErrors;
|
|
2602
2602
|
}>;
|
|
2603
2603
|
interface BulkUpdateOrdersOptions {
|
|
@@ -2628,7 +2628,7 @@ interface BulkUpdateOrdersOptions {
|
|
|
2628
2628
|
* @applicableIdentity APP
|
|
2629
2629
|
* @fqn wix.events.ticketing.OrderManagement.ConfirmOrder
|
|
2630
2630
|
*/
|
|
2631
|
-
declare function confirmOrder(eventId: string, options?: ConfirmOrderOptions): Promise<NonNullablePaths<ConfirmOrderResponse, `orders` | `orders.${number}.orderNumber` | `orders.${number}.reservationId` | `orders.${number}.snapshotId` | `orders.${number}.eventId` | `orders.${number}.contactId` | `orders.${number}.memberId` | `orders.${number}.firstName` | `orders.${number}.lastName` | `orders.${number}.email` | `orders.${number}.confirmed` | `orders.${number}.status` | `orders.${number}.method` | `orders.${number}.ticketsQuantity` | `orders.${number}.totalPrice.amount` | `orders.${number}.totalPrice.currency` | `orders.${number}.ticketsPdf` | `orders.${number}.archived` | `orders.${number}.anonymized` | `orders.${number}.fullName` | `orders.${number}.invoice.discount.code` | `orders.${number}.invoice.discount.name` | `orders.${number}.invoice.discount.couponId` | `orders.${number}.invoice.tax.type` | `orders.${number}.invoice.tax.name` | `orders.${number}.invoice.tax.rate` | `orders.${number}.fullyCheckedIn` | `orders.${number}.paymentDetails.transaction.transactionId` | `orders.${number}.paymentDetails.transaction.method` | `orders.${number}.channel
|
|
2631
|
+
declare function confirmOrder(eventId: string, options?: ConfirmOrderOptions): Promise<NonNullablePaths<ConfirmOrderResponse, `orders` | `orders.${number}.orderNumber` | `orders.${number}.reservationId` | `orders.${number}.snapshotId` | `orders.${number}.eventId` | `orders.${number}.contactId` | `orders.${number}.memberId` | `orders.${number}.firstName` | `orders.${number}.lastName` | `orders.${number}.email` | `orders.${number}.confirmed` | `orders.${number}.status` | `orders.${number}.method` | `orders.${number}.ticketsQuantity` | `orders.${number}.totalPrice.amount` | `orders.${number}.totalPrice.currency` | `orders.${number}.ticketsPdf` | `orders.${number}.archived` | `orders.${number}.anonymized` | `orders.${number}.fullName` | `orders.${number}.invoice.discount.code` | `orders.${number}.invoice.discount.name` | `orders.${number}.invoice.discount.couponId` | `orders.${number}.invoice.tax.type` | `orders.${number}.invoice.tax.name` | `orders.${number}.invoice.tax.rate` | `orders.${number}.fullyCheckedIn` | `orders.${number}.paymentDetails.transaction.transactionId` | `orders.${number}.paymentDetails.transaction.method` | `orders.${number}.channel`, 6> & {
|
|
2632
2632
|
__applicationErrorsType?: ConfirmOrderApplicationErrors;
|
|
2633
2633
|
}>;
|
|
2634
2634
|
interface ConfirmOrderOptions {
|
|
@@ -2651,7 +2651,7 @@ interface ConfirmOrderOptions {
|
|
|
2651
2651
|
* @applicableIdentity APP
|
|
2652
2652
|
* @fqn wix.events.ticketing.OrderManagement.GetSummary
|
|
2653
2653
|
*/
|
|
2654
|
-
declare function getSummary(options?: GetSummaryOptions): Promise<NonNullablePaths<GetSummaryResponse, `sales` | `sales.${number}.total.amount` | `sales.${number}.total.currency` | `sales.${number}.totalOrders` | `sales.${number}.totalTickets
|
|
2654
|
+
declare function getSummary(options?: GetSummaryOptions): Promise<NonNullablePaths<GetSummaryResponse, `sales` | `sales.${number}.total.amount` | `sales.${number}.total.currency` | `sales.${number}.totalOrders` | `sales.${number}.totalTickets`, 5>>;
|
|
2655
2655
|
interface GetSummaryOptions {
|
|
2656
2656
|
/**
|
|
2657
2657
|
* Event ID to which the order belongs.
|
|
@@ -2706,10 +2706,9 @@ interface VoidAuthorizedPaymentOptions {
|
|
|
2706
2706
|
* @public
|
|
2707
2707
|
* @permissionId WIX_EVENTS.READ_CHECKOUT
|
|
2708
2708
|
* @applicableIdentity APP
|
|
2709
|
-
* @applicableIdentity VISITOR
|
|
2710
2709
|
* @fqn wix.events.ticketing.CheckoutService.GetCheckoutOptions
|
|
2711
2710
|
*/
|
|
2712
|
-
declare function getCheckoutOptions(): Promise<NonNullablePaths<GetCheckoutOptionsResponse, `paymentMethodConfigured` | `acceptCoupons` | `premiumServices` | `paidTickets` | `acceptGiftCards
|
|
2711
|
+
declare function getCheckoutOptions(): Promise<NonNullablePaths<GetCheckoutOptionsResponse, `paymentMethodConfigured` | `acceptCoupons` | `premiumServices` | `paidTickets` | `acceptGiftCards`, 2>>;
|
|
2713
2712
|
/**
|
|
2714
2713
|
* Returns tickets available to reserve.
|
|
2715
2714
|
* <!--
|
|
@@ -2719,10 +2718,9 @@ declare function getCheckoutOptions(): Promise<NonNullablePaths<GetCheckoutOptio
|
|
|
2719
2718
|
* @param options - An object representing the available options for retrieving a list of tickets available for reservation.
|
|
2720
2719
|
* @permissionId WIX_EVENTS.READ_CHECKOUT
|
|
2721
2720
|
* @applicableIdentity APP
|
|
2722
|
-
* @applicableIdentity VISITOR
|
|
2723
2721
|
* @fqn wix.events.ticketing.CheckoutService.ListAvailableTickets
|
|
2724
2722
|
*/
|
|
2725
|
-
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
|
|
2723
|
+
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`, 5>>;
|
|
2726
2724
|
interface ListAvailableTicketsOptions {
|
|
2727
2725
|
/**
|
|
2728
2726
|
* Event ID to list tickets for. If not specified, available tickets for all events on a site will be returned.
|
|
@@ -2753,10 +2751,9 @@ interface ListAvailableTicketsOptions {
|
|
|
2753
2751
|
* @param options - An object representing the available options for retrieving a list of tickets available for reservation.
|
|
2754
2752
|
* @permissionId WIX_EVENTS.READ_CHECKOUT
|
|
2755
2753
|
* @applicableIdentity APP
|
|
2756
|
-
* @applicableIdentity VISITOR
|
|
2757
2754
|
* @fqn wix.events.ticketing.CheckoutService.QueryAvailableTickets
|
|
2758
2755
|
*/
|
|
2759
|
-
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
|
|
2756
|
+
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`, 5>>;
|
|
2760
2757
|
interface QueryAvailableTicketsOptions {
|
|
2761
2758
|
/** Offset. */
|
|
2762
2759
|
offset?: number;
|
|
@@ -2791,10 +2788,9 @@ interface QueryAvailableTicketsOptions {
|
|
|
2791
2788
|
* @param eventId - Event ID to which the reservation belongs.
|
|
2792
2789
|
* @permissionId WIX_EVENTS.CHECKOUT
|
|
2793
2790
|
* @applicableIdentity APP
|
|
2794
|
-
* @applicableIdentity VISITOR
|
|
2795
2791
|
* @fqn wix.events.ticketing.CheckoutService.CreateReservation
|
|
2796
2792
|
*/
|
|
2797
|
-
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
|
|
2793
|
+
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`, 6>>;
|
|
2798
2794
|
interface CreateReservationOptions {
|
|
2799
2795
|
/**
|
|
2800
2796
|
* Tickets to reserve.
|
|
@@ -2820,7 +2816,6 @@ interface CreateReservationOptions {
|
|
|
2820
2816
|
* @param eventId - Event ID to which the reservation belongs.
|
|
2821
2817
|
* @permissionId WIX_EVENTS.CHECKOUT
|
|
2822
2818
|
* @applicableIdentity APP
|
|
2823
|
-
* @applicableIdentity VISITOR
|
|
2824
2819
|
* @fqn wix.events.ticketing.CheckoutService.CancelReservation
|
|
2825
2820
|
*/
|
|
2826
2821
|
declare function cancelReservation(_id: string, eventId: string): Promise<void>;
|
|
@@ -2835,10 +2830,9 @@ declare function cancelReservation(_id: string, eventId: string): Promise<void>;
|
|
|
2835
2830
|
* @param eventId - Event ID to which the invoice belongs.
|
|
2836
2831
|
* @permissionId WIX_EVENTS.READ_INVOICE
|
|
2837
2832
|
* @applicableIdentity APP
|
|
2838
|
-
* @applicableIdentity VISITOR
|
|
2839
2833
|
* @fqn wix.events.ticketing.CheckoutService.GetInvoice
|
|
2840
2834
|
*/
|
|
2841
|
-
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
|
|
2835
|
+
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`, 6>>;
|
|
2842
2836
|
interface GetInvoiceOptions {
|
|
2843
2837
|
/** Optional discount to be applied on the returned invoice. */
|
|
2844
2838
|
withDiscount?: DiscountRequest;
|
|
@@ -2864,10 +2858,9 @@ interface GetInvoiceOptions {
|
|
|
2864
2858
|
* @param eventId - Event ID to which the checkout belongs.
|
|
2865
2859
|
* @permissionId WIX_EVENTS.CHECKOUT
|
|
2866
2860
|
* @applicableIdentity APP
|
|
2867
|
-
* @applicableIdentity VISITOR
|
|
2868
2861
|
* @fqn wix.events.ticketing.CheckoutService.Checkout
|
|
2869
2862
|
*/
|
|
2870
|
-
declare function checkout(eventId: string, options?: NonNullablePaths<CheckoutOptionsForRequest, `guests.${number}.form
|
|
2863
|
+
declare function checkout(eventId: string, options?: NonNullablePaths<CheckoutOptionsForRequest, `guests.${number}.form`, 4>): Promise<NonNullablePaths<CheckoutResponse, `order.orderNumber` | `order.reservationId` | `order.snapshotId` | `order.eventId` | `order.contactId` | `order.memberId` | `order.firstName` | `order.lastName` | `order.email` | `order.checkoutForm.inputValues` | `order.checkoutForm.inputValues.${number}.inputName` | `order.checkoutForm.inputValues.${number}.value` | `order.confirmed` | `order.status` | `order.method` | `order.ticketsQuantity` | `order.totalPrice.amount` | `order.totalPrice.currency` | `order.ticketsPdf` | `order.tickets` | `order.tickets.${number}.ticketNumber` | `order.tickets.${number}.orderNumber` | `order.tickets.${number}.ticketDefinitionId` | `order.tickets.${number}.name` | `order.tickets.${number}.free` | `order.tickets.${number}.policy` | `order.tickets.${number}.orderStatus` | `order.tickets.${number}.orderArchived` | `order.tickets.${number}.orderFullName` | `order.tickets.${number}.guestDetails.guestAssigned` | `order.tickets.${number}.archived` | `order.tickets.${number}.anonymized` | `order.tickets.${number}.checkInUrl` | `order.tickets.${number}.ticketPdfUrl` | `order.tickets.${number}.channel` | `order.tickets.${number}.walletPassUrl` | `order.archived` | `order.anonymized` | `order.fullName` | `order.invoice.items` | `order.invoice.items.${number}._id` | `order.invoice.items.${number}.quantity` | `order.invoice.items.${number}.name` | `order.invoice.items.${number}.discount.code` | `order.invoice.items.${number}.discount.name` | `order.invoice.items.${number}.discount.couponId` | `order.invoice.items.${number}.tax.type` | `order.invoice.items.${number}.tax.name` | `order.invoice.items.${number}.tax.rate` | `order.invoice.fees` | `order.fullyCheckedIn` | `order.paymentDetails.transaction.transactionId` | `order.paymentDetails.transaction.method` | `order.channel` | `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`, 7>>;
|
|
2871
2864
|
interface CheckoutOptionsForRequest {
|
|
2872
2865
|
/**
|
|
2873
2866
|
* Ticket reservation ID.
|
|
@@ -2907,10 +2900,9 @@ interface CheckoutOptionsForRequest {
|
|
|
2907
2900
|
* @param eventId - Event ID to which the checkout belongs.
|
|
2908
2901
|
* @permissionId WIX_EVENTS.CHECKOUT
|
|
2909
2902
|
* @applicableIdentity APP
|
|
2910
|
-
* @applicableIdentity VISITOR
|
|
2911
2903
|
* @fqn wix.events.ticketing.CheckoutService.UpdateCheckout
|
|
2912
2904
|
*/
|
|
2913
|
-
declare function updateCheckout(orderNumber: string, eventId: string, options?: UpdateCheckoutOptions): Promise<NonNullablePaths<UpdateCheckoutResponse, `order.orderNumber` | `order.reservationId` | `order.snapshotId` | `order.eventId` | `order.contactId` | `order.memberId` | `order.firstName` | `order.lastName` | `order.email` | `order.checkoutForm.inputValues` | `order.checkoutForm.inputValues.${number}.inputName` | `order.checkoutForm.inputValues.${number}.value` | `order.confirmed` | `order.status` | `order.method` | `order.ticketsQuantity` | `order.totalPrice.amount` | `order.totalPrice.currency` | `order.ticketsPdf` | `order.tickets` | `order.tickets.${number}.ticketNumber` | `order.tickets.${number}.orderNumber` | `order.tickets.${number}.ticketDefinitionId` | `order.tickets.${number}.name` | `order.tickets.${number}.free` | `order.tickets.${number}.policy` | `order.tickets.${number}.orderStatus` | `order.tickets.${number}.orderArchived` | `order.tickets.${number}.orderFullName` | `order.tickets.${number}.guestDetails.guestAssigned` | `order.tickets.${number}.archived` | `order.tickets.${number}.anonymized` | `order.tickets.${number}.checkInUrl` | `order.tickets.${number}.ticketPdfUrl` | `order.tickets.${number}.channel` | `order.tickets.${number}.walletPassUrl` | `order.archived` | `order.anonymized` | `order.fullName` | `order.invoice.items` | `order.invoice.items.${number}._id` | `order.invoice.items.${number}.quantity` | `order.invoice.items.${number}.name` | `order.invoice.items.${number}.discount.code` | `order.invoice.items.${number}.discount.name` | `order.invoice.items.${number}.discount.couponId` | `order.invoice.items.${number}.tax.type` | `order.invoice.items.${number}.tax.name` | `order.invoice.items.${number}.tax.rate` | `order.invoice.fees` | `order.fullyCheckedIn` | `order.paymentDetails.transaction.transactionId` | `order.paymentDetails.transaction.method` | `order.channel
|
|
2905
|
+
declare function updateCheckout(orderNumber: string, eventId: string, options?: UpdateCheckoutOptions): Promise<NonNullablePaths<UpdateCheckoutResponse, `order.orderNumber` | `order.reservationId` | `order.snapshotId` | `order.eventId` | `order.contactId` | `order.memberId` | `order.firstName` | `order.lastName` | `order.email` | `order.checkoutForm.inputValues` | `order.checkoutForm.inputValues.${number}.inputName` | `order.checkoutForm.inputValues.${number}.value` | `order.confirmed` | `order.status` | `order.method` | `order.ticketsQuantity` | `order.totalPrice.amount` | `order.totalPrice.currency` | `order.ticketsPdf` | `order.tickets` | `order.tickets.${number}.ticketNumber` | `order.tickets.${number}.orderNumber` | `order.tickets.${number}.ticketDefinitionId` | `order.tickets.${number}.name` | `order.tickets.${number}.free` | `order.tickets.${number}.policy` | `order.tickets.${number}.orderStatus` | `order.tickets.${number}.orderArchived` | `order.tickets.${number}.orderFullName` | `order.tickets.${number}.guestDetails.guestAssigned` | `order.tickets.${number}.archived` | `order.tickets.${number}.anonymized` | `order.tickets.${number}.checkInUrl` | `order.tickets.${number}.ticketPdfUrl` | `order.tickets.${number}.channel` | `order.tickets.${number}.walletPassUrl` | `order.archived` | `order.anonymized` | `order.fullName` | `order.invoice.items` | `order.invoice.items.${number}._id` | `order.invoice.items.${number}.quantity` | `order.invoice.items.${number}.name` | `order.invoice.items.${number}.discount.code` | `order.invoice.items.${number}.discount.name` | `order.invoice.items.${number}.discount.couponId` | `order.invoice.items.${number}.tax.type` | `order.invoice.items.${number}.tax.name` | `order.invoice.items.${number}.tax.rate` | `order.invoice.fees` | `order.fullyCheckedIn` | `order.paymentDetails.transaction.transactionId` | `order.paymentDetails.transaction.method` | `order.channel`, 7>>;
|
|
2914
2906
|
interface UpdateCheckoutOptions {
|
|
2915
2907
|
/** Buyer details. */
|
|
2916
2908
|
buyer?: Buyer;
|
|
@@ -2942,7 +2934,7 @@ interface UpdateCheckoutOptions {
|
|
|
2942
2934
|
* @applicableIdentity APP
|
|
2943
2935
|
* @fqn wix.events.ticketing.CheckoutService.PosCheckout
|
|
2944
2936
|
*/
|
|
2945
|
-
declare function posCheckout(eventId: string, options?: NonNullablePaths<PosCheckoutOptions, `reservationId
|
|
2937
|
+
declare function posCheckout(eventId: string, options?: NonNullablePaths<PosCheckoutOptions, `reservationId`, 2>): Promise<NonNullablePaths<PosCheckoutResponse, `order.orderNumber` | `order.reservationId` | `order.snapshotId` | `order.eventId` | `order.contactId` | `order.memberId` | `order.firstName` | `order.lastName` | `order.email` | `order.checkoutForm.inputValues` | `order.checkoutForm.inputValues.${number}.inputName` | `order.checkoutForm.inputValues.${number}.value` | `order.confirmed` | `order.status` | `order.method` | `order.ticketsQuantity` | `order.totalPrice.amount` | `order.totalPrice.currency` | `order.ticketsPdf` | `order.tickets` | `order.tickets.${number}.ticketNumber` | `order.tickets.${number}.orderNumber` | `order.tickets.${number}.ticketDefinitionId` | `order.tickets.${number}.name` | `order.tickets.${number}.free` | `order.tickets.${number}.policy` | `order.tickets.${number}.orderStatus` | `order.tickets.${number}.orderArchived` | `order.tickets.${number}.orderFullName` | `order.tickets.${number}.guestDetails.guestAssigned` | `order.tickets.${number}.archived` | `order.tickets.${number}.anonymized` | `order.tickets.${number}.checkInUrl` | `order.tickets.${number}.ticketPdfUrl` | `order.tickets.${number}.channel` | `order.tickets.${number}.walletPassUrl` | `order.archived` | `order.anonymized` | `order.fullName` | `order.invoice.items` | `order.invoice.items.${number}._id` | `order.invoice.items.${number}.quantity` | `order.invoice.items.${number}.name` | `order.invoice.items.${number}.discount.code` | `order.invoice.items.${number}.discount.name` | `order.invoice.items.${number}.discount.couponId` | `order.invoice.items.${number}.tax.type` | `order.invoice.items.${number}.tax.name` | `order.invoice.items.${number}.tax.rate` | `order.invoice.fees` | `order.fullyCheckedIn` | `order.paymentDetails.transaction.transactionId` | `order.paymentDetails.transaction.method` | `order.channel` | `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`, 7>>;
|
|
2946
2938
|
interface PosCheckoutOptions {
|
|
2947
2939
|
/**
|
|
2948
2940
|
* Ticket reservation ID.
|