@wix/auto_sdk_events_orders 1.0.72 → 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.
- package/build/cjs/index.d.ts +6 -6
- package/build/cjs/index.js +10 -4
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +58 -25
- package/build/cjs/index.typings.js +10 -4
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +36 -19
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +6 -6
- package/build/es/index.mjs +10 -4
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +58 -25
- package/build/es/index.typings.mjs +10 -4
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +36 -19
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +6 -6
- package/build/internal/cjs/index.typings.d.ts +39 -29
- package/build/internal/cjs/meta.d.ts +17 -23
- package/build/internal/es/index.d.mts +6 -6
- package/build/internal/es/index.typings.d.mts +39 -29
- package/build/internal/es/meta.d.mts +17 -23
- package/package.json +2 -2
|
@@ -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
|
-
/**
|
|
661
|
+
/** Gift card payment amount, or projected amount for invoice previews. */
|
|
667
662
|
amount?: Money;
|
|
668
663
|
/**
|
|
669
|
-
*
|
|
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
|
-
/**
|
|
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. */
|
|
@@ -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`, 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>>;
|
|
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`, 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> & {
|
|
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 {
|
|
@@ -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`, 4>>;
|
|
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`, 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>>;
|
|
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`, 5>>;
|
|
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`, 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>>;
|
|
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.
|
|
@@ -2278,7 +2278,8 @@ async function getInvoice2(reservationId, eventId, options) {
|
|
|
2278
2278
|
reservationId,
|
|
2279
2279
|
eventId,
|
|
2280
2280
|
withDiscount: options?.withDiscount,
|
|
2281
|
-
paidPlanBenefit: options?.paidPlanBenefit
|
|
2281
|
+
paidPlanBenefit: options?.paidPlanBenefit,
|
|
2282
|
+
giftCardCode: options?.giftCardCode
|
|
2282
2283
|
});
|
|
2283
2284
|
const reqOpts = getInvoice(payload);
|
|
2284
2285
|
sideEffects?.onSiteCall?.();
|
|
@@ -2295,7 +2296,8 @@ async function getInvoice2(reservationId, eventId, options) {
|
|
|
2295
2296
|
reservationId: "$[0]",
|
|
2296
2297
|
eventId: "$[1]",
|
|
2297
2298
|
withDiscount: "$[2].withDiscount",
|
|
2298
|
-
paidPlanBenefit: "$[2].paidPlanBenefit"
|
|
2299
|
+
paidPlanBenefit: "$[2].paidPlanBenefit",
|
|
2300
|
+
giftCardCode: "$[2].giftCardCode"
|
|
2299
2301
|
},
|
|
2300
2302
|
singleArgumentUnchanged: false
|
|
2301
2303
|
},
|
|
@@ -2317,6 +2319,7 @@ async function checkout2(eventId, options) {
|
|
|
2317
2319
|
guests: options?.guests,
|
|
2318
2320
|
paidPlanBenefit: options?.paidPlanBenefit,
|
|
2319
2321
|
options: options?.options,
|
|
2322
|
+
giftCardCode: options?.giftCardCode,
|
|
2320
2323
|
marketingConsent: options?.marketingConsent
|
|
2321
2324
|
}),
|
|
2322
2325
|
[
|
|
@@ -2358,6 +2361,7 @@ async function checkout2(eventId, options) {
|
|
|
2358
2361
|
guests: "$[1].guests",
|
|
2359
2362
|
paidPlanBenefit: "$[1].paidPlanBenefit",
|
|
2360
2363
|
options: "$[1].options",
|
|
2364
|
+
giftCardCode: "$[1].giftCardCode",
|
|
2361
2365
|
marketingConsent: "$[1].marketingConsent"
|
|
2362
2366
|
},
|
|
2363
2367
|
singleArgumentUnchanged: false
|
|
@@ -2378,7 +2382,8 @@ async function updateCheckout2(orderNumber, eventId, options) {
|
|
|
2378
2382
|
guests: options?.guests,
|
|
2379
2383
|
memberId: options?.memberId,
|
|
2380
2384
|
discount: options?.discount,
|
|
2381
|
-
paidPlanBenefit: options?.paidPlanBenefit
|
|
2385
|
+
paidPlanBenefit: options?.paidPlanBenefit,
|
|
2386
|
+
giftCardCode: options?.giftCardCode
|
|
2382
2387
|
}),
|
|
2383
2388
|
[
|
|
2384
2389
|
{
|
|
@@ -2417,7 +2422,8 @@ async function updateCheckout2(orderNumber, eventId, options) {
|
|
|
2417
2422
|
guests: "$[2].guests",
|
|
2418
2423
|
memberId: "$[2].memberId",
|
|
2419
2424
|
discount: "$[2].discount",
|
|
2420
|
-
paidPlanBenefit: "$[2].paidPlanBenefit"
|
|
2425
|
+
paidPlanBenefit: "$[2].paidPlanBenefit",
|
|
2426
|
+
giftCardCode: "$[2].giftCardCode"
|
|
2421
2427
|
},
|
|
2422
2428
|
singleArgumentUnchanged: false
|
|
2423
2429
|
},
|