@wix/auto_sdk_events_orders 1.0.71 → 1.0.73

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.
@@ -87,6 +87,11 @@ interface Order {
87
87
  * @readonly
88
88
  */
89
89
  updated?: Date | null;
90
+ /**
91
+ * Gift card payments, including voided payments.
92
+ * @maxSize 10
93
+ */
94
+ giftCardPaymentDetails?: GiftCardPaymentDetails[];
90
95
  /** Whether marketing consent was given. */
91
96
  marketingConsent?: boolean | null;
92
97
  }
@@ -651,30 +656,15 @@ declare enum Action {
651
656
  /** @enumType */
652
657
  type ActionWithLiterals = Action | 'ARCHIVE' | 'UNARCHIVE' | 'CONFIRM' | 'CAPTURE' | 'VOID';
653
658
  interface GiftCardPaymentDetails {
654
- /**
655
- * Gift card payment ID.
656
- * @format GUID
657
- */
658
- giftCardPaymentId?: string | null;
659
- /**
660
- * ID of the app that created the gift card.
661
- * @format GUID
662
- */
663
- appId?: string | null;
664
- /** Whether the gift card payment is voided. */
659
+ /** Whether the payment was reversed and no longer contributes to the order. */
665
660
  voided?: boolean | null;
666
- /** Amount */
661
+ /** Gift card payment amount, or projected amount for invoice previews. */
667
662
  amount?: Money;
668
663
  /**
669
- * Obfuscated gift card code.
664
+ * Masked gift card code for display.
670
665
  * @maxLength 30
671
666
  */
672
667
  obfuscatedCode?: string | null;
673
- /**
674
- * Gift card code.
675
- * @maxLength 30
676
- */
677
- code?: string | null;
678
668
  }
679
669
  interface BalanceSummary {
680
670
  /** Amount left to pay. */
@@ -1930,6 +1920,11 @@ interface GetInvoiceRequest {
1930
1920
  withDiscount?: DiscountRequest;
1931
1921
  /** Optional benefit granted by the pricing plan to be applied on the returned invoice. */
1932
1922
  paidPlanBenefit?: PaidPlanBenefit;
1923
+ /**
1924
+ * Gift card code to preview without redeeming it.
1925
+ * @maxLength 30
1926
+ */
1927
+ giftCardCode?: string | null;
1933
1928
  }
1934
1929
  interface DiscountRequest {
1935
1930
  /**
@@ -1970,6 +1965,13 @@ interface GetInvoiceResponse {
1970
1965
  reservationOccupied?: boolean;
1971
1966
  /** Ticket reservations. */
1972
1967
  reservations?: TicketReservation[];
1968
+ /**
1969
+ * Projected gift card payments.
1970
+ * @maxSize 10
1971
+ */
1972
+ giftCardPaymentDetails?: GiftCardPaymentDetails[];
1973
+ /** Gift card errors, if relevant. */
1974
+ giftCardErrors?: GiftCardErrors;
1973
1975
  }
1974
1976
  interface DiscountErrors {
1975
1977
  /** Object containing error information. */
@@ -1987,7 +1989,11 @@ interface GiftCardErrors {
1987
1989
  error?: GiftCardErrorsError[];
1988
1990
  }
1989
1991
  interface GiftCardErrorsError {
1990
- /** @maxLength 100 */
1992
+ /**
1993
+ * Error code, such as EVENTS_GIFT_CARD_NOT_FOUND, EVENTS_GIFT_CARD_EXPIRED,
1994
+ * EVENTS_GIFT_CARD_DISABLED, or EVENTS_GIFT_CARD_INSUFFICIENT_FUNDS.
1995
+ * @maxLength 100
1996
+ */
1991
1997
  code?: string;
1992
1998
  }
1993
1999
  interface CheckoutRequest {
@@ -2017,6 +2023,11 @@ interface CheckoutRequest {
2017
2023
  paidPlanBenefit?: PaidPlanBenefit;
2018
2024
  /** Options controlling the checkout process. */
2019
2025
  options?: CheckoutOptions;
2026
+ /**
2027
+ * Gift card code to redeem toward the order.
2028
+ * @maxLength 30
2029
+ */
2030
+ giftCardCode?: string | null;
2020
2031
  /** Whether marketing consent was given. */
2021
2032
  marketingConsent?: boolean | null;
2022
2033
  }
@@ -2163,6 +2174,12 @@ interface UpdateCheckoutRequest {
2163
2174
  discount?: DiscountRequest;
2164
2175
  /** Benefit granted by the pricing plan. */
2165
2176
  paidPlanBenefit?: PaidPlanBenefit;
2177
+ /**
2178
+ * Gift card code to apply. Resend it on each update to keep the card applied.
2179
+ * Omitting it reverses the payment when the update recalculates the invoice.
2180
+ * @maxLength 30
2181
+ */
2182
+ giftCardCode?: string | null;
2166
2183
  }
2167
2184
  interface UpdateCheckoutResponse {
2168
2185
  /** Updated order. */
@@ -2497,7 +2514,7 @@ declare function onOrderReservationUpdated(handler: (event: OrderReservationUpda
2497
2514
  * @applicableIdentity APP
2498
2515
  * @fqn wix.events.ticketing.OrderManagement.ListOrders
2499
2516
  */
2500
- 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>>;
2517
+ 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`, 4>>;
2501
2518
  interface ListOrdersOptions {
2502
2519
  /** Offset. */
2503
2520
  offset?: number;
@@ -2594,7 +2611,7 @@ interface ListOrdersOptions {
2594
2611
  * @returns Requested order.
2595
2612
  * @fqn wix.events.ticketing.OrderManagement.GetOrder
2596
2613
  */
2597
- 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>>;
2614
+ declare function getOrder(identifiers: NonNullablePaths<GetOrderIdentifiers, `eventId` | `orderNumber`, 0>, 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` | `giftCardPaymentDetails`, 4>>;
2598
2615
  interface GetOrderIdentifiers {
2599
2616
  /**
2600
2617
  * Event ID to which the order belongs.
@@ -2632,7 +2649,7 @@ interface GetOrderOptions {
2632
2649
  * @applicableIdentity APP
2633
2650
  * @fqn wix.events.ticketing.OrderManagement.UpdateOrder
2634
2651
  */
2635
- 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> & {
2652
+ declare function updateOrder(identifiers: NonNullablePaths<UpdateOrderIdentifiers, `eventId` | `orderNumber`, 0>, 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` | `order.giftCardPaymentDetails`, 5> & {
2636
2653
  __applicationErrorsType?: UpdateOrderApplicationErrors;
2637
2654
  }>;
2638
2655
  interface UpdateOrderIdentifiers {
@@ -2665,7 +2682,7 @@ interface UpdateOrderOptions {
2665
2682
  * @applicableIdentity APP
2666
2683
  * @fqn wix.events.ticketing.OrderManagement.BulkUpdateOrders
2667
2684
  */
2668
- 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> & {
2685
+ 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`, 4> & {
2669
2686
  __applicationErrorsType?: BulkUpdateOrdersApplicationErrors;
2670
2687
  }>;
2671
2688
  interface BulkUpdateOrdersOptions {
@@ -2696,7 +2713,7 @@ interface BulkUpdateOrdersOptions {
2696
2713
  * @applicableIdentity APP
2697
2714
  * @fqn wix.events.ticketing.OrderManagement.ConfirmOrder
2698
2715
  */
2699
- 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> & {
2716
+ 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`, 4> & {
2700
2717
  __applicationErrorsType?: ConfirmOrderApplicationErrors;
2701
2718
  }>;
2702
2719
  interface ConfirmOrderOptions {
@@ -2719,7 +2736,7 @@ interface ConfirmOrderOptions {
2719
2736
  * @applicableIdentity APP
2720
2737
  * @fqn wix.events.ticketing.OrderManagement.GetSummary
2721
2738
  */
2722
- declare function getSummary(options?: GetSummaryOptions): Promise<NonNullablePaths<GetSummaryResponse, `sales` | `sales.${number}.total.amount` | `sales.${number}.total.currency` | `sales.${number}.totalOrders` | `sales.${number}.totalTickets`, 5>>;
2739
+ declare function getSummary(options?: GetSummaryOptions): Promise<NonNullablePaths<GetSummaryResponse, `sales` | `sales.${number}.total.amount` | `sales.${number}.total.currency` | `sales.${number}.totalOrders` | `sales.${number}.totalTickets`, 3>>;
2723
2740
  interface GetSummaryOptions {
2724
2741
  /**
2725
2742
  * Event ID to which the order belongs.
@@ -2776,7 +2793,7 @@ interface VoidAuthorizedPaymentOptions {
2776
2793
  * @applicableIdentity APP
2777
2794
  * @fqn wix.events.ticketing.CheckoutService.GetCheckoutOptions
2778
2795
  */
2779
- declare function getCheckoutOptions(): Promise<NonNullablePaths<GetCheckoutOptionsResponse, `paymentMethodConfigured` | `acceptCoupons` | `premiumServices` | `paidTickets` | `acceptGiftCards`, 2>>;
2796
+ declare function getCheckoutOptions(): Promise<NonNullablePaths<GetCheckoutOptionsResponse, `paymentMethodConfigured` | `acceptCoupons` | `premiumServices` | `paidTickets` | `acceptGiftCards`, 0>>;
2780
2797
  /**
2781
2798
  * Returns tickets available to reserve.
2782
2799
  * <!--
@@ -2788,7 +2805,7 @@ declare function getCheckoutOptions(): Promise<NonNullablePaths<GetCheckoutOptio
2788
2805
  * @applicableIdentity APP
2789
2806
  * @fqn wix.events.ticketing.CheckoutService.ListAvailableTickets
2790
2807
  */
2791
- 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>>;
2808
+ 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`, 3>>;
2792
2809
  interface ListAvailableTicketsOptions {
2793
2810
  /**
2794
2811
  * Event ID to list tickets for. If not specified, available tickets for all events on a site will be returned.
@@ -2823,7 +2840,7 @@ interface ListAvailableTicketsOptions {
2823
2840
  * @applicableIdentity APP
2824
2841
  * @fqn wix.events.ticketing.CheckoutService.QueryAvailableTickets
2825
2842
  */
2826
- 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>>;
2843
+ 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`, 3>>;
2827
2844
  interface QueryAvailableTicketsOptions {
2828
2845
  /** Offset. */
2829
2846
  offset?: number;
@@ -2865,7 +2882,7 @@ interface QueryAvailableTicketsOptions {
2865
2882
  * @replacedBy wix.events.ticketreservations.v1.TicketReservationManagement.CreateTicketReservation
2866
2883
  * @targetRemovalDate 2026-03-31
2867
2884
  */
2868
- 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>>;
2885
+ 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`, 4>>;
2869
2886
  interface CreateReservationOptions {
2870
2887
  /**
2871
2888
  * Tickets to reserve.
@@ -2910,12 +2927,17 @@ declare function cancelReservation(_id: string, eventId: string): Promise<void>;
2910
2927
  * @applicableIdentity APP
2911
2928
  * @fqn wix.events.ticketing.CheckoutService.GetInvoice
2912
2929
  */
2913
- 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>>;
2930
+ 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` | `giftCardPaymentDetails` | `giftCardPaymentDetails.${number}.amount.amount` | `giftCardPaymentDetails.${number}.amount.currency` | `giftCardErrors.error` | `giftCardErrors.error.${number}.code`, 4>>;
2914
2931
  interface GetInvoiceOptions {
2915
2932
  /** Optional discount to be applied on the returned invoice. */
2916
2933
  withDiscount?: DiscountRequest;
2917
2934
  /** Optional benefit granted by the pricing plan to be applied on the returned invoice. */
2918
2935
  paidPlanBenefit?: PaidPlanBenefit;
2936
+ /**
2937
+ * Gift card code to preview without redeeming it.
2938
+ * @maxLength 30
2939
+ */
2940
+ giftCardCode?: string | null;
2919
2941
  }
2920
2942
  /**
2921
2943
  * Checkouts the reserved tickets.
@@ -2938,7 +2960,7 @@ interface GetInvoiceOptions {
2938
2960
  * @applicableIdentity APP
2939
2961
  * @fqn wix.events.ticketing.CheckoutService.Checkout
2940
2962
  */
2941
- 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>>;
2963
+ declare function checkout(eventId: string, options?: NonNullablePaths<CheckoutOptionsForRequest, `guests.${number}.form`, 2>): 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` | `order.giftCardPaymentDetails` | `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`, 5>>;
2942
2964
  interface CheckoutOptionsForRequest {
2943
2965
  /**
2944
2966
  * Ticket reservation ID.
@@ -2961,6 +2983,11 @@ interface CheckoutOptionsForRequest {
2961
2983
  paidPlanBenefit?: PaidPlanBenefit;
2962
2984
  /** Options controlling the checkout process. */
2963
2985
  options?: CheckoutOptions;
2986
+ /**
2987
+ * Gift card code to redeem toward the order.
2988
+ * @maxLength 30
2989
+ */
2990
+ giftCardCode?: string | null;
2964
2991
  /** Whether marketing consent was given. */
2965
2992
  marketingConsent?: boolean | null;
2966
2993
  }
@@ -2980,7 +3007,7 @@ interface CheckoutOptionsForRequest {
2980
3007
  * @applicableIdentity APP
2981
3008
  * @fqn wix.events.ticketing.CheckoutService.UpdateCheckout
2982
3009
  */
2983
- 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>>;
3010
+ 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` | `order.giftCardPaymentDetails`, 5>>;
2984
3011
  interface UpdateCheckoutOptions {
2985
3012
  /** Buyer details. */
2986
3013
  buyer?: Buyer;
@@ -3000,6 +3027,12 @@ interface UpdateCheckoutOptions {
3000
3027
  discount?: DiscountRequest;
3001
3028
  /** Benefit granted by the pricing plan. */
3002
3029
  paidPlanBenefit?: PaidPlanBenefit;
3030
+ /**
3031
+ * Gift card code to apply. Resend it on each update to keep the card applied.
3032
+ * Omitting it reverses the payment when the update recalculates the invoice.
3033
+ * @maxLength 30
3034
+ */
3035
+ giftCardCode?: string | null;
3003
3036
  }
3004
3037
  /**
3005
3038
  * Creates order with payment details already initiated via Cashier Pay API.
@@ -3012,7 +3045,7 @@ interface UpdateCheckoutOptions {
3012
3045
  * @applicableIdentity APP
3013
3046
  * @fqn wix.events.ticketing.CheckoutService.PosCheckout
3014
3047
  */
3015
- 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>>;
3048
+ declare function posCheckout(eventId: string, options?: NonNullablePaths<PosCheckoutOptions, `reservationId`, 0>): 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` | `order.giftCardPaymentDetails` | `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`, 5>>;
3016
3049
  interface PosCheckoutOptions {
3017
3050
  /**
3018
3051
  * Ticket reservation ID.
@@ -2222,7 +2222,8 @@ async function getInvoice2(reservationId, eventId, options) {
2222
2222
  reservationId,
2223
2223
  eventId,
2224
2224
  withDiscount: options?.withDiscount,
2225
- paidPlanBenefit: options?.paidPlanBenefit
2225
+ paidPlanBenefit: options?.paidPlanBenefit,
2226
+ giftCardCode: options?.giftCardCode
2226
2227
  });
2227
2228
  const reqOpts = getInvoice(payload);
2228
2229
  sideEffects?.onSiteCall?.();
@@ -2239,7 +2240,8 @@ async function getInvoice2(reservationId, eventId, options) {
2239
2240
  reservationId: "$[0]",
2240
2241
  eventId: "$[1]",
2241
2242
  withDiscount: "$[2].withDiscount",
2242
- paidPlanBenefit: "$[2].paidPlanBenefit"
2243
+ paidPlanBenefit: "$[2].paidPlanBenefit",
2244
+ giftCardCode: "$[2].giftCardCode"
2243
2245
  },
2244
2246
  singleArgumentUnchanged: false
2245
2247
  },
@@ -2261,6 +2263,7 @@ async function checkout2(eventId, options) {
2261
2263
  guests: options?.guests,
2262
2264
  paidPlanBenefit: options?.paidPlanBenefit,
2263
2265
  options: options?.options,
2266
+ giftCardCode: options?.giftCardCode,
2264
2267
  marketingConsent: options?.marketingConsent
2265
2268
  }),
2266
2269
  [
@@ -2302,6 +2305,7 @@ async function checkout2(eventId, options) {
2302
2305
  guests: "$[1].guests",
2303
2306
  paidPlanBenefit: "$[1].paidPlanBenefit",
2304
2307
  options: "$[1].options",
2308
+ giftCardCode: "$[1].giftCardCode",
2305
2309
  marketingConsent: "$[1].marketingConsent"
2306
2310
  },
2307
2311
  singleArgumentUnchanged: false
@@ -2322,7 +2326,8 @@ async function updateCheckout2(orderNumber, eventId, options) {
2322
2326
  guests: options?.guests,
2323
2327
  memberId: options?.memberId,
2324
2328
  discount: options?.discount,
2325
- paidPlanBenefit: options?.paidPlanBenefit
2329
+ paidPlanBenefit: options?.paidPlanBenefit,
2330
+ giftCardCode: options?.giftCardCode
2326
2331
  }),
2327
2332
  [
2328
2333
  {
@@ -2361,7 +2366,8 @@ async function updateCheckout2(orderNumber, eventId, options) {
2361
2366
  guests: "$[2].guests",
2362
2367
  memberId: "$[2].memberId",
2363
2368
  discount: "$[2].discount",
2364
- paidPlanBenefit: "$[2].paidPlanBenefit"
2369
+ paidPlanBenefit: "$[2].paidPlanBenefit",
2370
+ giftCardCode: "$[2].giftCardCode"
2365
2371
  },
2366
2372
  singleArgumentUnchanged: false
2367
2373
  },