@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.
- package/build/cjs/index.d.ts +14 -14
- package/build/cjs/index.js +10 -4
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +66 -33
- 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 +14 -14
- package/build/es/index.mjs +10 -4
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +66 -33
- 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 +14 -14
- package/build/internal/cjs/index.typings.d.ts +47 -37
- package/build/internal/cjs/meta.d.ts +17 -23
- package/build/internal/es/index.d.mts +14 -14
- package/build/internal/es/index.typings.d.mts +47 -37
- package/build/internal/es/meta.d.mts +17 -23
- package/package.json +2 -2
|
@@ -8,7 +8,7 @@ interface ListOrdersSignature {
|
|
|
8
8
|
* Retrieves a list of orders, including ticket data.
|
|
9
9
|
* @param - An object representing the available options for retrieving a list of orders.
|
|
10
10
|
*/
|
|
11
|
-
(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`,
|
|
11
|
+
(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>>;
|
|
12
12
|
}
|
|
13
13
|
declare function getOrder$1(httpClient: HttpClient): GetOrderSignature;
|
|
14
14
|
interface GetOrderSignature {
|
|
@@ -21,7 +21,7 @@ interface GetOrderSignature {
|
|
|
21
21
|
* @param - An object containing identifiers for the order to be retrieved.
|
|
22
22
|
* @returns Requested order.
|
|
23
23
|
*/
|
|
24
|
-
(identifiers: NonNullablePaths<GetOrderIdentifiers, `eventId` | `orderNumber`,
|
|
24
|
+
(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>>;
|
|
25
25
|
}
|
|
26
26
|
declare function updateOrder$1(httpClient: HttpClient): UpdateOrderSignature;
|
|
27
27
|
interface UpdateOrderSignature {
|
|
@@ -30,7 +30,7 @@ interface UpdateOrderSignature {
|
|
|
30
30
|
* @param - An object representing the available options for updating an order.
|
|
31
31
|
* @param - An object containing identifiers for the order to be updated.
|
|
32
32
|
*/
|
|
33
|
-
(identifiers: NonNullablePaths<UpdateOrderIdentifiers, `eventId` | `orderNumber`,
|
|
33
|
+
(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> & {
|
|
34
34
|
__applicationErrorsType?: UpdateOrderApplicationErrors;
|
|
35
35
|
}>;
|
|
36
36
|
}
|
|
@@ -41,7 +41,7 @@ interface BulkUpdateOrdersSignature {
|
|
|
41
41
|
* @param - An object representing the available options for confirming an order.
|
|
42
42
|
* @param - Event ID to which the order belongs.
|
|
43
43
|
*/
|
|
44
|
-
(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`,
|
|
44
|
+
(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> & {
|
|
45
45
|
__applicationErrorsType?: BulkUpdateOrdersApplicationErrors;
|
|
46
46
|
}>;
|
|
47
47
|
}
|
|
@@ -56,7 +56,7 @@ interface ConfirmOrderSignature {
|
|
|
56
56
|
* @param - An object representing the available options for confirming an order.
|
|
57
57
|
* @param - Event ID to which the order belongs.
|
|
58
58
|
*/
|
|
59
|
-
(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`,
|
|
59
|
+
(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> & {
|
|
60
60
|
__applicationErrorsType?: ConfirmOrderApplicationErrors;
|
|
61
61
|
}>;
|
|
62
62
|
}
|
|
@@ -69,7 +69,7 @@ interface GetSummarySignature {
|
|
|
69
69
|
* -->
|
|
70
70
|
* @param - An object representing the available options for retrieving a summary of total ticket sales.
|
|
71
71
|
*/
|
|
72
|
-
(options?: GetSummaryOptions): Promise<NonNullablePaths<GetSummaryResponse, `sales` | `sales.${number}.total.amount` | `sales.${number}.total.currency` | `sales.${number}.totalOrders` | `sales.${number}.totalTickets`,
|
|
72
|
+
(options?: GetSummaryOptions): Promise<NonNullablePaths<GetSummaryResponse, `sales` | `sales.${number}.total.amount` | `sales.${number}.total.currency` | `sales.${number}.totalOrders` | `sales.${number}.totalTickets`, 3>>;
|
|
73
73
|
}
|
|
74
74
|
declare function captureAuthorizedPayment$1(httpClient: HttpClient): CaptureAuthorizedPaymentSignature;
|
|
75
75
|
interface CaptureAuthorizedPaymentSignature {
|
|
@@ -100,7 +100,7 @@ interface GetCheckoutOptionsSignature {
|
|
|
100
100
|
/**
|
|
101
101
|
* Retrieves checkout details.
|
|
102
102
|
*/
|
|
103
|
-
(): Promise<NonNullablePaths<GetCheckoutOptionsResponse, `paymentMethodConfigured` | `acceptCoupons` | `premiumServices` | `paidTickets` | `acceptGiftCards`,
|
|
103
|
+
(): Promise<NonNullablePaths<GetCheckoutOptionsResponse, `paymentMethodConfigured` | `acceptCoupons` | `premiumServices` | `paidTickets` | `acceptGiftCards`, 0>>;
|
|
104
104
|
}
|
|
105
105
|
declare function listAvailableTickets$1(httpClient: HttpClient): ListAvailableTicketsSignature;
|
|
106
106
|
interface ListAvailableTicketsSignature {
|
|
@@ -111,7 +111,7 @@ interface ListAvailableTicketsSignature {
|
|
|
111
111
|
* -->
|
|
112
112
|
* @param - An object representing the available options for retrieving a list of tickets available for reservation.
|
|
113
113
|
*/
|
|
114
|
-
(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`,
|
|
114
|
+
(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>>;
|
|
115
115
|
}
|
|
116
116
|
declare function queryAvailableTickets$1(httpClient: HttpClient): QueryAvailableTicketsSignature;
|
|
117
117
|
interface QueryAvailableTicketsSignature {
|
|
@@ -122,7 +122,7 @@ interface QueryAvailableTicketsSignature {
|
|
|
122
122
|
* -->
|
|
123
123
|
* @param - An object representing the available options for retrieving a list of tickets available for reservation.
|
|
124
124
|
*/
|
|
125
|
-
(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`,
|
|
125
|
+
(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>>;
|
|
126
126
|
}
|
|
127
127
|
declare function createReservation$1(httpClient: HttpClient): CreateReservationSignature;
|
|
128
128
|
interface CreateReservationSignature {
|
|
@@ -136,7 +136,7 @@ interface CreateReservationSignature {
|
|
|
136
136
|
* @param - Event ID to which the reservation belongs.
|
|
137
137
|
* @deprecated
|
|
138
138
|
*/
|
|
139
|
-
(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`,
|
|
139
|
+
(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>>;
|
|
140
140
|
}
|
|
141
141
|
declare function cancelReservation$1(httpClient: HttpClient): CancelReservationSignature;
|
|
142
142
|
interface CancelReservationSignature {
|
|
@@ -161,7 +161,7 @@ interface GetInvoiceSignature {
|
|
|
161
161
|
* @param - An object containing identifiers for the reservation invoice preview to be generated.
|
|
162
162
|
* @param - Event ID to which the invoice belongs.
|
|
163
163
|
*/
|
|
164
|
-
(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`,
|
|
164
|
+
(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>>;
|
|
165
165
|
}
|
|
166
166
|
declare function checkout$1(httpClient: HttpClient): CheckoutSignature;
|
|
167
167
|
interface CheckoutSignature {
|
|
@@ -180,7 +180,7 @@ interface CheckoutSignature {
|
|
|
180
180
|
* @param - An object representing the available options for checking out a reserved ticket.
|
|
181
181
|
* @param - Event ID to which the checkout belongs.
|
|
182
182
|
*/
|
|
183
|
-
(eventId: string, options?: NonNullablePaths<CheckoutOptionsForRequest, `guests.${number}.form`,
|
|
183
|
+
(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>>;
|
|
184
184
|
}
|
|
185
185
|
declare function updateCheckout$1(httpClient: HttpClient): UpdateCheckoutSignature;
|
|
186
186
|
interface UpdateCheckoutSignature {
|
|
@@ -194,7 +194,7 @@ interface UpdateCheckoutSignature {
|
|
|
194
194
|
* @param - An object containing identifiers for the order and tickets to be updated.
|
|
195
195
|
* @param - Event ID to which the checkout belongs.
|
|
196
196
|
*/
|
|
197
|
-
(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`,
|
|
197
|
+
(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>>;
|
|
198
198
|
}
|
|
199
199
|
declare function posCheckout$1(httpClient: HttpClient): PosCheckoutSignature;
|
|
200
200
|
interface PosCheckoutSignature {
|
|
@@ -202,7 +202,7 @@ interface PosCheckoutSignature {
|
|
|
202
202
|
* Creates order with payment details already initiated via Cashier Pay API.
|
|
203
203
|
* @param - Event ID to which the checkout belongs.
|
|
204
204
|
*/
|
|
205
|
-
(eventId: string, options?: NonNullablePaths<PosCheckoutOptions, `reservationId`,
|
|
205
|
+
(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>>;
|
|
206
206
|
}
|
|
207
207
|
declare const onOrderDeleted$1: EventDefinition<OrderDeletedEnvelope, "wix.events.ticketing.events.OrderDeleted">;
|
|
208
208
|
declare const onOrderUpdated$1: EventDefinition<OrderUpdatedEnvelope, "wix.events.ticketing.events.OrderUpdated">;
|
|
@@ -115,8 +115,7 @@ interface Order {
|
|
|
115
115
|
*/
|
|
116
116
|
availableActions?: ActionWithLiterals[];
|
|
117
117
|
/**
|
|
118
|
-
* Gift card payments.
|
|
119
|
-
* @internal
|
|
118
|
+
* Gift card payments, including voided payments.
|
|
120
119
|
* @maxSize 10
|
|
121
120
|
*/
|
|
122
121
|
giftCardPaymentDetails?: GiftCardPaymentDetails[];
|
|
@@ -861,28 +860,25 @@ type ActionWithLiterals = Action | 'ARCHIVE' | 'UNARCHIVE' | 'CONFIRM' | 'CAPTUR
|
|
|
861
860
|
interface GiftCardPaymentDetails {
|
|
862
861
|
/**
|
|
863
862
|
* Gift card payment ID.
|
|
863
|
+
* @internal
|
|
864
864
|
* @format GUID
|
|
865
865
|
*/
|
|
866
866
|
giftCardPaymentId?: string | null;
|
|
867
867
|
/**
|
|
868
868
|
* ID of the app that created the gift card.
|
|
869
|
+
* @internal
|
|
869
870
|
* @format GUID
|
|
870
871
|
*/
|
|
871
872
|
appId?: string | null;
|
|
872
|
-
/** Whether the
|
|
873
|
+
/** Whether the payment was reversed and no longer contributes to the order. */
|
|
873
874
|
voided?: boolean | null;
|
|
874
|
-
/**
|
|
875
|
+
/** Gift card payment amount, or projected amount for invoice previews. */
|
|
875
876
|
amount?: Money;
|
|
876
877
|
/**
|
|
877
|
-
*
|
|
878
|
+
* Masked gift card code for display.
|
|
878
879
|
* @maxLength 30
|
|
879
880
|
*/
|
|
880
881
|
obfuscatedCode?: string | null;
|
|
881
|
-
/**
|
|
882
|
-
* Gift card code.
|
|
883
|
-
* @maxLength 30
|
|
884
|
-
*/
|
|
885
|
-
code?: string | null;
|
|
886
882
|
}
|
|
887
883
|
interface BalanceSummary {
|
|
888
884
|
/** Amount left to pay. */
|
|
@@ -2251,8 +2247,7 @@ interface GetInvoiceRequest {
|
|
|
2251
2247
|
/** Optional benefit granted by the pricing plan to be applied on the returned invoice. */
|
|
2252
2248
|
paidPlanBenefit?: PaidPlanBenefit;
|
|
2253
2249
|
/**
|
|
2254
|
-
* Gift card code.
|
|
2255
|
-
* @internal
|
|
2250
|
+
* Gift card code to preview without redeeming it.
|
|
2256
2251
|
* @maxLength 30
|
|
2257
2252
|
*/
|
|
2258
2253
|
giftCardCode?: string | null;
|
|
@@ -2297,8 +2292,7 @@ interface GetInvoiceResponse {
|
|
|
2297
2292
|
/** Ticket reservations. */
|
|
2298
2293
|
reservations?: TicketReservation[];
|
|
2299
2294
|
/**
|
|
2300
|
-
*
|
|
2301
|
-
* @internal
|
|
2295
|
+
* Projected gift card payments.
|
|
2302
2296
|
* @maxSize 10
|
|
2303
2297
|
*/
|
|
2304
2298
|
giftCardPaymentDetails?: GiftCardPaymentDetails[];
|
|
@@ -2307,10 +2301,7 @@ interface GetInvoiceResponse {
|
|
|
2307
2301
|
* @internal
|
|
2308
2302
|
*/
|
|
2309
2303
|
balanceSummary?: BalanceSummary;
|
|
2310
|
-
/**
|
|
2311
|
-
* Gift card errors, if relevant.
|
|
2312
|
-
* @internal
|
|
2313
|
-
*/
|
|
2304
|
+
/** Gift card errors, if relevant. */
|
|
2314
2305
|
giftCardErrors?: GiftCardErrors;
|
|
2315
2306
|
}
|
|
2316
2307
|
interface DiscountErrors {
|
|
@@ -2329,7 +2320,11 @@ interface GiftCardErrors {
|
|
|
2329
2320
|
error?: GiftCardErrorsError[];
|
|
2330
2321
|
}
|
|
2331
2322
|
interface GiftCardErrorsError {
|
|
2332
|
-
/**
|
|
2323
|
+
/**
|
|
2324
|
+
* Error code, such as EVENTS_GIFT_CARD_NOT_FOUND, EVENTS_GIFT_CARD_EXPIRED,
|
|
2325
|
+
* EVENTS_GIFT_CARD_DISABLED, or EVENTS_GIFT_CARD_INSUFFICIENT_FUNDS.
|
|
2326
|
+
* @maxLength 100
|
|
2327
|
+
*/
|
|
2333
2328
|
code?: string;
|
|
2334
2329
|
}
|
|
2335
2330
|
interface CheckoutRequest {
|
|
@@ -2377,8 +2372,7 @@ interface CheckoutRequest {
|
|
|
2377
2372
|
*/
|
|
2378
2373
|
overrideRequestTime?: Date | null;
|
|
2379
2374
|
/**
|
|
2380
|
-
* Gift card code.
|
|
2381
|
-
* @internal
|
|
2375
|
+
* Gift card code to redeem toward the order.
|
|
2382
2376
|
* @maxLength 30
|
|
2383
2377
|
*/
|
|
2384
2378
|
giftCardCode?: string | null;
|
|
@@ -2558,8 +2552,8 @@ interface UpdateCheckoutRequest {
|
|
|
2558
2552
|
*/
|
|
2559
2553
|
paymentMethod?: string | null;
|
|
2560
2554
|
/**
|
|
2561
|
-
* Gift card code.
|
|
2562
|
-
*
|
|
2555
|
+
* Gift card code to apply. Resend it on each update to keep the card applied.
|
|
2556
|
+
* Omitting it reverses the payment when the update recalculates the invoice.
|
|
2563
2557
|
* @maxLength 30
|
|
2564
2558
|
*/
|
|
2565
2559
|
giftCardCode?: string | null;
|
|
@@ -2912,7 +2906,7 @@ declare function onOrderReservationUpdated(handler: (event: OrderReservationUpda
|
|
|
2912
2906
|
* @applicableIdentity APP
|
|
2913
2907
|
* @fqn wix.events.ticketing.OrderManagement.ListOrders
|
|
2914
2908
|
*/
|
|
2915
|
-
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`,
|
|
2909
|
+
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>>;
|
|
2916
2910
|
interface ListOrdersOptions {
|
|
2917
2911
|
/** Offset. */
|
|
2918
2912
|
offset?: number;
|
|
@@ -3009,7 +3003,7 @@ interface ListOrdersOptions {
|
|
|
3009
3003
|
* @returns Requested order.
|
|
3010
3004
|
* @fqn wix.events.ticketing.OrderManagement.GetOrder
|
|
3011
3005
|
*/
|
|
3012
|
-
declare function getOrder(identifiers: NonNullablePaths<GetOrderIdentifiers, `eventId` | `orderNumber`,
|
|
3006
|
+
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>>;
|
|
3013
3007
|
interface GetOrderIdentifiers {
|
|
3014
3008
|
/**
|
|
3015
3009
|
* Event ID to which the order belongs.
|
|
@@ -3047,7 +3041,7 @@ interface GetOrderOptions {
|
|
|
3047
3041
|
* @applicableIdentity APP
|
|
3048
3042
|
* @fqn wix.events.ticketing.OrderManagement.UpdateOrder
|
|
3049
3043
|
*/
|
|
3050
|
-
declare function updateOrder(identifiers: NonNullablePaths<UpdateOrderIdentifiers, `eventId` | `orderNumber`,
|
|
3044
|
+
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> & {
|
|
3051
3045
|
__applicationErrorsType?: UpdateOrderApplicationErrors;
|
|
3052
3046
|
}>;
|
|
3053
3047
|
interface UpdateOrderIdentifiers {
|
|
@@ -3080,7 +3074,7 @@ interface UpdateOrderOptions {
|
|
|
3080
3074
|
* @applicableIdentity APP
|
|
3081
3075
|
* @fqn wix.events.ticketing.OrderManagement.BulkUpdateOrders
|
|
3082
3076
|
*/
|
|
3083
|
-
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`,
|
|
3077
|
+
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> & {
|
|
3084
3078
|
__applicationErrorsType?: BulkUpdateOrdersApplicationErrors;
|
|
3085
3079
|
}>;
|
|
3086
3080
|
interface BulkUpdateOrdersOptions {
|
|
@@ -3111,7 +3105,7 @@ interface BulkUpdateOrdersOptions {
|
|
|
3111
3105
|
* @applicableIdentity APP
|
|
3112
3106
|
* @fqn wix.events.ticketing.OrderManagement.ConfirmOrder
|
|
3113
3107
|
*/
|
|
3114
|
-
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`,
|
|
3108
|
+
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> & {
|
|
3115
3109
|
__applicationErrorsType?: ConfirmOrderApplicationErrors;
|
|
3116
3110
|
}>;
|
|
3117
3111
|
interface ConfirmOrderOptions {
|
|
@@ -3134,7 +3128,7 @@ interface ConfirmOrderOptions {
|
|
|
3134
3128
|
* @applicableIdentity APP
|
|
3135
3129
|
* @fqn wix.events.ticketing.OrderManagement.GetSummary
|
|
3136
3130
|
*/
|
|
3137
|
-
declare function getSummary(options?: GetSummaryOptions): Promise<NonNullablePaths<GetSummaryResponse, `sales` | `sales.${number}.total.amount` | `sales.${number}.total.currency` | `sales.${number}.totalOrders` | `sales.${number}.totalTickets`,
|
|
3131
|
+
declare function getSummary(options?: GetSummaryOptions): Promise<NonNullablePaths<GetSummaryResponse, `sales` | `sales.${number}.total.amount` | `sales.${number}.total.currency` | `sales.${number}.totalOrders` | `sales.${number}.totalTickets`, 3>>;
|
|
3138
3132
|
interface GetSummaryOptions {
|
|
3139
3133
|
/**
|
|
3140
3134
|
* Event ID to which the order belongs.
|
|
@@ -3191,7 +3185,7 @@ interface VoidAuthorizedPaymentOptions {
|
|
|
3191
3185
|
* @applicableIdentity APP
|
|
3192
3186
|
* @fqn wix.events.ticketing.CheckoutService.GetCheckoutOptions
|
|
3193
3187
|
*/
|
|
3194
|
-
declare function getCheckoutOptions(): Promise<NonNullablePaths<GetCheckoutOptionsResponse, `paymentMethodConfigured` | `acceptCoupons` | `premiumServices` | `paidTickets` | `acceptGiftCards`,
|
|
3188
|
+
declare function getCheckoutOptions(): Promise<NonNullablePaths<GetCheckoutOptionsResponse, `paymentMethodConfigured` | `acceptCoupons` | `premiumServices` | `paidTickets` | `acceptGiftCards`, 0>>;
|
|
3195
3189
|
/**
|
|
3196
3190
|
* Returns tickets available to reserve.
|
|
3197
3191
|
* <!--
|
|
@@ -3203,7 +3197,7 @@ declare function getCheckoutOptions(): Promise<NonNullablePaths<GetCheckoutOptio
|
|
|
3203
3197
|
* @applicableIdentity APP
|
|
3204
3198
|
* @fqn wix.events.ticketing.CheckoutService.ListAvailableTickets
|
|
3205
3199
|
*/
|
|
3206
|
-
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`,
|
|
3200
|
+
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>>;
|
|
3207
3201
|
interface ListAvailableTicketsOptions {
|
|
3208
3202
|
/**
|
|
3209
3203
|
* Event ID to list tickets for. If not specified, available tickets for all events on a site will be returned.
|
|
@@ -3238,7 +3232,7 @@ interface ListAvailableTicketsOptions {
|
|
|
3238
3232
|
* @applicableIdentity APP
|
|
3239
3233
|
* @fqn wix.events.ticketing.CheckoutService.QueryAvailableTickets
|
|
3240
3234
|
*/
|
|
3241
|
-
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`,
|
|
3235
|
+
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>>;
|
|
3242
3236
|
interface QueryAvailableTicketsOptions {
|
|
3243
3237
|
/** Offset. */
|
|
3244
3238
|
offset?: number;
|
|
@@ -3280,7 +3274,7 @@ interface QueryAvailableTicketsOptions {
|
|
|
3280
3274
|
* @replacedBy wix.events.ticketreservations.v1.TicketReservationManagement.CreateTicketReservation
|
|
3281
3275
|
* @targetRemovalDate 2026-03-31
|
|
3282
3276
|
*/
|
|
3283
|
-
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`,
|
|
3277
|
+
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>>;
|
|
3284
3278
|
interface CreateReservationOptions {
|
|
3285
3279
|
/**
|
|
3286
3280
|
* Tickets to reserve.
|
|
@@ -3325,12 +3319,17 @@ declare function cancelReservation(_id: string, eventId: string): Promise<void>;
|
|
|
3325
3319
|
* @applicableIdentity APP
|
|
3326
3320
|
* @fqn wix.events.ticketing.CheckoutService.GetInvoice
|
|
3327
3321
|
*/
|
|
3328
|
-
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`,
|
|
3322
|
+
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>>;
|
|
3329
3323
|
interface GetInvoiceOptions {
|
|
3330
3324
|
/** Optional discount to be applied on the returned invoice. */
|
|
3331
3325
|
withDiscount?: DiscountRequest;
|
|
3332
3326
|
/** Optional benefit granted by the pricing plan to be applied on the returned invoice. */
|
|
3333
3327
|
paidPlanBenefit?: PaidPlanBenefit;
|
|
3328
|
+
/**
|
|
3329
|
+
* Gift card code to preview without redeeming it.
|
|
3330
|
+
* @maxLength 30
|
|
3331
|
+
*/
|
|
3332
|
+
giftCardCode?: string | null;
|
|
3334
3333
|
}
|
|
3335
3334
|
/**
|
|
3336
3335
|
* Checkouts the reserved tickets.
|
|
@@ -3353,7 +3352,7 @@ interface GetInvoiceOptions {
|
|
|
3353
3352
|
* @applicableIdentity APP
|
|
3354
3353
|
* @fqn wix.events.ticketing.CheckoutService.Checkout
|
|
3355
3354
|
*/
|
|
3356
|
-
declare function checkout(eventId: string, options?: NonNullablePaths<CheckoutOptionsForRequest, `guests.${number}.form`,
|
|
3355
|
+
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>>;
|
|
3357
3356
|
interface CheckoutOptionsForRequest {
|
|
3358
3357
|
/**
|
|
3359
3358
|
* Ticket reservation ID.
|
|
@@ -3376,6 +3375,11 @@ interface CheckoutOptionsForRequest {
|
|
|
3376
3375
|
paidPlanBenefit?: PaidPlanBenefit;
|
|
3377
3376
|
/** Options controlling the checkout process. */
|
|
3378
3377
|
options?: CheckoutOptions;
|
|
3378
|
+
/**
|
|
3379
|
+
* Gift card code to redeem toward the order.
|
|
3380
|
+
* @maxLength 30
|
|
3381
|
+
*/
|
|
3382
|
+
giftCardCode?: string | null;
|
|
3379
3383
|
/** Whether marketing consent was given. */
|
|
3380
3384
|
marketingConsent?: boolean | null;
|
|
3381
3385
|
}
|
|
@@ -3395,7 +3399,7 @@ interface CheckoutOptionsForRequest {
|
|
|
3395
3399
|
* @applicableIdentity APP
|
|
3396
3400
|
* @fqn wix.events.ticketing.CheckoutService.UpdateCheckout
|
|
3397
3401
|
*/
|
|
3398
|
-
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`,
|
|
3402
|
+
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>>;
|
|
3399
3403
|
interface UpdateCheckoutOptions {
|
|
3400
3404
|
/** Buyer details. */
|
|
3401
3405
|
buyer?: Buyer;
|
|
@@ -3415,6 +3419,12 @@ interface UpdateCheckoutOptions {
|
|
|
3415
3419
|
discount?: DiscountRequest;
|
|
3416
3420
|
/** Benefit granted by the pricing plan. */
|
|
3417
3421
|
paidPlanBenefit?: PaidPlanBenefit;
|
|
3422
|
+
/**
|
|
3423
|
+
* Gift card code to apply. Resend it on each update to keep the card applied.
|
|
3424
|
+
* Omitting it reverses the payment when the update recalculates the invoice.
|
|
3425
|
+
* @maxLength 30
|
|
3426
|
+
*/
|
|
3427
|
+
giftCardCode?: string | null;
|
|
3418
3428
|
}
|
|
3419
3429
|
/**
|
|
3420
3430
|
* Creates order with payment details already initiated via Cashier Pay API.
|
|
@@ -3427,7 +3437,7 @@ interface UpdateCheckoutOptions {
|
|
|
3427
3437
|
* @applicableIdentity APP
|
|
3428
3438
|
* @fqn wix.events.ticketing.CheckoutService.PosCheckout
|
|
3429
3439
|
*/
|
|
3430
|
-
declare function posCheckout(eventId: string, options?: NonNullablePaths<PosCheckoutOptions, `reservationId`,
|
|
3440
|
+
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>>;
|
|
3431
3441
|
interface PosCheckoutOptions {
|
|
3432
3442
|
/**
|
|
3433
3443
|
* Ticket reservation ID.
|