@wix/auto_sdk_events_orders 1.0.72 → 1.0.73

package/build/internal/es/index.typings.d.mts

@@ -115,8 +115,7 @@ interface Order {
      */
     availableActions?: ActionWithLiterals[];
     /**
-     * Gift card payments.
-     * @internal
+     * Gift card payments, including voided payments.
      * @maxSize 10
      */
     giftCardPaymentDetails?: GiftCardPaymentDetails[];
@@ -861,28 +860,25 @@ type ActionWithLiterals = Action | 'ARCHIVE' | 'UNARCHIVE' | 'CONFIRM' | 'CAPTUR
 interface GiftCardPaymentDetails {
     /**
      * Gift card payment ID.
+     * @internal
      * @format GUID
      */
     giftCardPaymentId?: string | null;
     /**
      * ID of the app that created the gift card.
+     * @internal
      * @format GUID
      */
     appId?: string | null;
-    /** Whether the gift card payment is voided. */
+    /** Whether the payment was reversed and no longer contributes to the order. */
     voided?: boolean | null;
-    /** Amount */
+    /** Gift card payment amount, or projected amount for invoice previews. */
     amount?: Money;
     /**
-     * Obfuscated gift card code.
+     * Masked gift card code for display.
      * @maxLength 30
      */
     obfuscatedCode?: string | null;
-    /**
-     * Gift card code.
-     * @maxLength 30
-     */
-    code?: string | null;
 }
 interface BalanceSummary {
     /** Amount left to pay. */
@@ -2251,8 +2247,7 @@ interface GetInvoiceRequest {
     /** Optional benefit granted by the pricing plan to be applied on the returned invoice. */
     paidPlanBenefit?: PaidPlanBenefit;
     /**
-     * Gift card code.
-     * @internal
+     * Gift card code to preview without redeeming it.
      * @maxLength 30
      */
     giftCardCode?: string | null;
@@ -2297,8 +2292,7 @@ interface GetInvoiceResponse {
     /** Ticket reservations. */
     reservations?: TicketReservation[];
     /**
-     * Gift card payments.
-     * @internal
+     * Projected gift card payments.
      * @maxSize 10
      */
     giftCardPaymentDetails?: GiftCardPaymentDetails[];
@@ -2307,10 +2301,7 @@ interface GetInvoiceResponse {
      * @internal
      */
     balanceSummary?: BalanceSummary;
-    /**
-     * Gift card errors, if relevant.
-     * @internal
-     */
+    /** Gift card errors, if relevant. */
     giftCardErrors?: GiftCardErrors;
 }
 interface DiscountErrors {
@@ -2329,7 +2320,11 @@ interface GiftCardErrors {
     error?: GiftCardErrorsError[];
 }
 interface GiftCardErrorsError {
-    /** @maxLength 100 */
+    /**
+     * Error code, such as EVENTS_GIFT_CARD_NOT_FOUND, EVENTS_GIFT_CARD_EXPIRED,
+     * EVENTS_GIFT_CARD_DISABLED, or EVENTS_GIFT_CARD_INSUFFICIENT_FUNDS.
+     * @maxLength 100
+     */
     code?: string;
 }
 interface CheckoutRequest {
@@ -2377,8 +2372,7 @@ interface CheckoutRequest {
      */
     overrideRequestTime?: Date | null;
     /**
-     * Gift card code.
-     * @internal
+     * Gift card code to redeem toward the order.
      * @maxLength 30
      */
     giftCardCode?: string | null;
@@ -2558,8 +2552,8 @@ interface UpdateCheckoutRequest {
      */
     paymentMethod?: string | null;
     /**
-     * Gift card code.
-     * @internal
+     * Gift card code to apply. Resend it on each update to keep the card applied.
+     * Omitting it reverses the payment when the update recalculates the invoice.
      * @maxLength 30
      */
     giftCardCode?: string | null;
@@ -3009,7 +3003,7 @@ interface ListOrdersOptions {
  * @returns Requested order.
  * @fqn wix.events.ticketing.OrderManagement.GetOrder
  */
-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`, 4>>;
+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>>;
 interface GetOrderIdentifiers {
     /**
      * Event ID to which the order belongs.
@@ -3047,7 +3041,7 @@ interface GetOrderOptions {
  * @applicableIdentity APP
  * @fqn wix.events.ticketing.OrderManagement.UpdateOrder
  */
-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`, 5> & {
+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> & {
     __applicationErrorsType?: UpdateOrderApplicationErrors;
 }>;
 interface UpdateOrderIdentifiers {
@@ -3325,12 +3319,17 @@ declare function cancelReservation(_id: string, eventId: string): Promise<void>;
  * @applicableIdentity APP
  * @fqn wix.events.ticketing.CheckoutService.GetInvoice
  */
-declare function getInvoice(reservationId: string, eventId: string, options?: GetInvoiceOptions): Promise<NonNullablePaths<GetInvoiceResponse, `invoice.items` | `invoice.items.${number}._id` | `invoice.items.${number}.quantity` | `invoice.items.${number}.name` | `invoice.items.${number}.price.amount` | `invoice.items.${number}.price.currency` | `invoice.items.${number}.discount.code` | `invoice.items.${number}.discount.name` | `invoice.items.${number}.discount.couponId` | `invoice.items.${number}.tax.type` | `invoice.items.${number}.tax.name` | `invoice.items.${number}.tax.rate` | `invoice.fees` | `discountErrors.error` | `discountErrors.error.${number}.code` | `reservationStatus` | `reservationOccupied` | `reservations` | `reservations.${number}.quantity` | `reservations.${number}.ticket._id` | `reservations.${number}.ticket.price.amount` | `reservations.${number}.ticket.price.currency` | `reservations.${number}.ticket.free` | `reservations.${number}.ticket.name` | `reservations.${number}.ticket.description` | `reservations.${number}.ticket.limitPerCheckout` | `reservations.${number}.ticket.orderIndex` | `reservations.${number}.ticket.policy` | `reservations.${number}.ticket.dashboard.hidden` | `reservations.${number}.ticket.dashboard.sold` | `reservations.${number}.ticket.dashboard.limited` | `reservations.${number}.ticket.dashboard.ticketsSold` | `reservations.${number}.ticket.dashboard.ticketsReserved` | `reservations.${number}.ticket.eventId` | `reservations.${number}.ticket.wixFeeConfig.type` | `reservations.${number}.ticket.salePeriod.hideNotOnSale` | `reservations.${number}.ticket.saleStatus` | `reservations.${number}.ticket.pricing.pricingType`, 4>>;
+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>>;
 interface GetInvoiceOptions {
     /** Optional discount to be applied on the returned invoice. */
     withDiscount?: DiscountRequest;
     /** Optional benefit granted by the pricing plan to be applied on the returned invoice. */
     paidPlanBenefit?: PaidPlanBenefit;
+    /**
+     * Gift card code to preview without redeeming it.
+     * @maxLength 30
+     */
+    giftCardCode?: string | null;
 }
 /**
  * Checkouts the reserved tickets.
@@ -3353,7 +3352,7 @@ interface GetInvoiceOptions {
  * @applicableIdentity APP
  * @fqn wix.events.ticketing.CheckoutService.Checkout
  */
-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` | `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>>;
+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>>;
 interface CheckoutOptionsForRequest {
     /**
      * Ticket reservation ID.
@@ -3376,6 +3375,11 @@ interface CheckoutOptionsForRequest {
     paidPlanBenefit?: PaidPlanBenefit;
     /** Options controlling the checkout process. */
     options?: CheckoutOptions;
+    /**
+     * Gift card code to redeem toward the order.
+     * @maxLength 30
+     */
+    giftCardCode?: string | null;
     /** Whether marketing consent was given. */
     marketingConsent?: boolean | null;
 }
@@ -3395,7 +3399,7 @@ interface CheckoutOptionsForRequest {
  * @applicableIdentity APP
  * @fqn wix.events.ticketing.CheckoutService.UpdateCheckout
  */
-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`, 5>>;
+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>>;
 interface UpdateCheckoutOptions {
     /** Buyer details. */
     buyer?: Buyer;
@@ -3415,6 +3419,12 @@ interface UpdateCheckoutOptions {
     discount?: DiscountRequest;
     /** Benefit granted by the pricing plan. */
     paidPlanBenefit?: PaidPlanBenefit;
+    /**
+     * Gift card code to apply. Resend it on each update to keep the card applied.
+     * Omitting it reverses the payment when the update recalculates the invoice.
+     * @maxLength 30
+     */
+    giftCardCode?: string | null;
 }
 /**
  * Creates order with payment details already initiated via Cashier Pay API.
@@ -3427,7 +3437,7 @@ interface UpdateCheckoutOptions {
  * @applicableIdentity APP
  * @fqn wix.events.ticketing.CheckoutService.PosCheckout
  */
-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` | `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>>;
+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>>;
 interface PosCheckoutOptions {
     /**
      * Ticket reservation ID.

package/build/internal/es/meta.d.mts

@@ -108,8 +108,7 @@ interface Order {
      */
     availableActions?: ActionWithLiterals[];
     /**
-     * Gift card payments.
-     * @internal
+     * Gift card payments, including voided payments.
      * @maxSize 10
      */
     giftCardPaymentDetails?: GiftCardPaymentDetails[];
@@ -860,28 +859,25 @@ type ActionWithLiterals = Action | 'ARCHIVE' | 'UNARCHIVE' | 'CONFIRM' | 'CAPTUR
 interface GiftCardPaymentDetails {
     /**
      * Gift card payment ID.
+     * @internal
      * @format GUID
      */
     giftCardPaymentId?: string | null;
     /**
      * ID of the app that created the gift card.
+     * @internal
      * @format GUID
      */
     appId?: string | null;
-    /** Whether the gift card payment is voided. */
+    /** Whether the payment was reversed and no longer contributes to the order. */
     voided?: boolean | null;
-    /** Amount */
+    /** Gift card payment amount, or projected amount for invoice previews. */
     amount?: Money;
     /**
-     * Obfuscated gift card code.
+     * Masked gift card code for display.
      * @maxLength 30
      */
     obfuscatedCode?: string | null;
-    /**
-     * Gift card code.
-     * @maxLength 30
-     */
-    code?: string | null;
 }
 interface BalanceSummary {
     /** Amount left to pay. */
@@ -2210,8 +2206,7 @@ interface GetInvoiceRequest {
     /** Optional benefit granted by the pricing plan to be applied on the returned invoice. */
     paidPlanBenefit?: PaidPlanBenefit;
     /**
-     * Gift card code.
-     * @internal
+     * Gift card code to preview without redeeming it.
      * @maxLength 30
      */
     giftCardCode?: string | null;
@@ -2249,8 +2244,7 @@ interface GetInvoiceResponse {
     /** Ticket reservations. */
     reservations?: TicketReservation[];
     /**
-     * Gift card payments.
-     * @internal
+     * Projected gift card payments.
      * @maxSize 10
      */
     giftCardPaymentDetails?: GiftCardPaymentDetails[];
@@ -2259,10 +2253,7 @@ interface GetInvoiceResponse {
      * @internal
      */
     balanceSummary?: BalanceSummary;
-    /**
-     * Gift card errors, if relevant.
-     * @internal
-     */
+    /** Gift card errors, if relevant. */
     giftCardErrors?: GiftCardErrors;
 }
 interface DiscountErrors {
@@ -2280,7 +2271,11 @@ interface GiftCardErrors {
     error?: GiftCardErrorsError[];
 }
 interface GiftCardErrorsError {
-    /** @maxLength 100 */
+    /**
+     * Error code, such as EVENTS_GIFT_CARD_NOT_FOUND, EVENTS_GIFT_CARD_EXPIRED,
+     * EVENTS_GIFT_CARD_DISABLED, or EVENTS_GIFT_CARD_INSUFFICIENT_FUNDS.
+     * @maxLength 100
+     */
     code?: string;
 }
 interface CheckoutRequest {
@@ -2328,8 +2323,7 @@ interface CheckoutRequest {
      */
     overrideRequestTime?: Date | null;
     /**
-     * Gift card code.
-     * @internal
+     * Gift card code to redeem toward the order.
      * @maxLength 30
      */
     giftCardCode?: string | null;
@@ -2497,8 +2491,8 @@ interface UpdateCheckoutRequest {
      */
     paymentMethod?: string | null;
     /**
-     * Gift card code.
-     * @internal
+     * Gift card code to apply. Resend it on each update to keep the card applied.
+     * Omitting it reverses the payment when the update recalculates the invoice.
      * @maxLength 30
      */
     giftCardCode?: string | null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/auto_sdk_events_orders",
-  "version": "1.0.72",
+  "version": "1.0.73",
   "license": "MIT",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
@@ -50,5 +50,5 @@
       "fqdn": "wix.events.v1.order"
     }
   },
-  "falconPackageHash": "30bd223d9f9ce72547acae6d56d1b0a8db6aea5b95434f4d35f8cd9b"
+  "falconPackageHash": "3c821d260a100e080b69d7ebaae26e21ff83d4724356ec5bd3d329b0"
 }