@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
|
@@ -108,8 +108,7 @@ interface Order {
|
|
|
108
108
|
*/
|
|
109
109
|
availableActions?: ActionWithLiterals[];
|
|
110
110
|
/**
|
|
111
|
-
* Gift card payments.
|
|
112
|
-
* @internal
|
|
111
|
+
* Gift card payments, including voided payments.
|
|
113
112
|
* @maxSize 10
|
|
114
113
|
*/
|
|
115
114
|
giftCardPaymentDetails?: GiftCardPaymentDetails[];
|
|
@@ -860,28 +859,25 @@ type ActionWithLiterals = Action | 'ARCHIVE' | 'UNARCHIVE' | 'CONFIRM' | 'CAPTUR
|
|
|
860
859
|
interface GiftCardPaymentDetails {
|
|
861
860
|
/**
|
|
862
861
|
* Gift card payment ID.
|
|
862
|
+
* @internal
|
|
863
863
|
* @format GUID
|
|
864
864
|
*/
|
|
865
865
|
giftCardPaymentId?: string | null;
|
|
866
866
|
/**
|
|
867
867
|
* ID of the app that created the gift card.
|
|
868
|
+
* @internal
|
|
868
869
|
* @format GUID
|
|
869
870
|
*/
|
|
870
871
|
appId?: string | null;
|
|
871
|
-
/** Whether the
|
|
872
|
+
/** Whether the payment was reversed and no longer contributes to the order. */
|
|
872
873
|
voided?: boolean | null;
|
|
873
|
-
/**
|
|
874
|
+
/** Gift card payment amount, or projected amount for invoice previews. */
|
|
874
875
|
amount?: Money;
|
|
875
876
|
/**
|
|
876
|
-
*
|
|
877
|
+
* Masked gift card code for display.
|
|
877
878
|
* @maxLength 30
|
|
878
879
|
*/
|
|
879
880
|
obfuscatedCode?: string | null;
|
|
880
|
-
/**
|
|
881
|
-
* Gift card code.
|
|
882
|
-
* @maxLength 30
|
|
883
|
-
*/
|
|
884
|
-
code?: string | null;
|
|
885
881
|
}
|
|
886
882
|
interface BalanceSummary {
|
|
887
883
|
/** Amount left to pay. */
|
|
@@ -2210,8 +2206,7 @@ interface GetInvoiceRequest {
|
|
|
2210
2206
|
/** Optional benefit granted by the pricing plan to be applied on the returned invoice. */
|
|
2211
2207
|
paidPlanBenefit?: PaidPlanBenefit;
|
|
2212
2208
|
/**
|
|
2213
|
-
* Gift card code.
|
|
2214
|
-
* @internal
|
|
2209
|
+
* Gift card code to preview without redeeming it.
|
|
2215
2210
|
* @maxLength 30
|
|
2216
2211
|
*/
|
|
2217
2212
|
giftCardCode?: string | null;
|
|
@@ -2249,8 +2244,7 @@ interface GetInvoiceResponse {
|
|
|
2249
2244
|
/** Ticket reservations. */
|
|
2250
2245
|
reservations?: TicketReservation[];
|
|
2251
2246
|
/**
|
|
2252
|
-
*
|
|
2253
|
-
* @internal
|
|
2247
|
+
* Projected gift card payments.
|
|
2254
2248
|
* @maxSize 10
|
|
2255
2249
|
*/
|
|
2256
2250
|
giftCardPaymentDetails?: GiftCardPaymentDetails[];
|
|
@@ -2259,10 +2253,7 @@ interface GetInvoiceResponse {
|
|
|
2259
2253
|
* @internal
|
|
2260
2254
|
*/
|
|
2261
2255
|
balanceSummary?: BalanceSummary;
|
|
2262
|
-
/**
|
|
2263
|
-
* Gift card errors, if relevant.
|
|
2264
|
-
* @internal
|
|
2265
|
-
*/
|
|
2256
|
+
/** Gift card errors, if relevant. */
|
|
2266
2257
|
giftCardErrors?: GiftCardErrors;
|
|
2267
2258
|
}
|
|
2268
2259
|
interface DiscountErrors {
|
|
@@ -2280,7 +2271,11 @@ interface GiftCardErrors {
|
|
|
2280
2271
|
error?: GiftCardErrorsError[];
|
|
2281
2272
|
}
|
|
2282
2273
|
interface GiftCardErrorsError {
|
|
2283
|
-
/**
|
|
2274
|
+
/**
|
|
2275
|
+
* Error code, such as EVENTS_GIFT_CARD_NOT_FOUND, EVENTS_GIFT_CARD_EXPIRED,
|
|
2276
|
+
* EVENTS_GIFT_CARD_DISABLED, or EVENTS_GIFT_CARD_INSUFFICIENT_FUNDS.
|
|
2277
|
+
* @maxLength 100
|
|
2278
|
+
*/
|
|
2284
2279
|
code?: string;
|
|
2285
2280
|
}
|
|
2286
2281
|
interface CheckoutRequest {
|
|
@@ -2328,8 +2323,7 @@ interface CheckoutRequest {
|
|
|
2328
2323
|
*/
|
|
2329
2324
|
overrideRequestTime?: Date | null;
|
|
2330
2325
|
/**
|
|
2331
|
-
* Gift card code.
|
|
2332
|
-
* @internal
|
|
2326
|
+
* Gift card code to redeem toward the order.
|
|
2333
2327
|
* @maxLength 30
|
|
2334
2328
|
*/
|
|
2335
2329
|
giftCardCode?: string | null;
|
|
@@ -2497,8 +2491,8 @@ interface UpdateCheckoutRequest {
|
|
|
2497
2491
|
*/
|
|
2498
2492
|
paymentMethod?: string | null;
|
|
2499
2493
|
/**
|
|
2500
|
-
* Gift card code.
|
|
2501
|
-
*
|
|
2494
|
+
* Gift card code to apply. Resend it on each update to keep the card applied.
|
|
2495
|
+
* Omitting it reverses the payment when the update recalculates the invoice.
|
|
2502
2496
|
* @maxLength 30
|
|
2503
2497
|
*/
|
|
2504
2498
|
giftCardCode?: string | null;
|
|
@@ -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">;
|