@wix/auto_sdk_events_orders 1.0.24 → 1.0.25
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 +38 -23
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +44 -54
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +39 -49
- package/build/es/index.d.mts +38 -23
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +44 -54
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +39 -49
- package/build/internal/cjs/index.d.ts +38 -23
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +44 -54
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +39 -49
- package/build/internal/es/index.d.mts +38 -23
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +44 -54
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +39 -49
- package/package.json +2 -2
|
@@ -22,7 +22,7 @@ interface Order {
|
|
|
22
22
|
*/
|
|
23
23
|
eventId?: string;
|
|
24
24
|
/**
|
|
25
|
-
* Contact ID of buyer, resolved using the email address
|
|
25
|
+
* Contact ID of buyer, resolved using the email address specified. See the Contacts API for additional information.
|
|
26
26
|
* @format GUID
|
|
27
27
|
*/
|
|
28
28
|
contactId?: string;
|
|
@@ -32,7 +32,7 @@ interface Order {
|
|
|
32
32
|
*/
|
|
33
33
|
memberId?: string;
|
|
34
34
|
/**
|
|
35
|
-
* Date and time the
|
|
35
|
+
* Date and time the order was created.
|
|
36
36
|
* @readonly
|
|
37
37
|
*/
|
|
38
38
|
created?: Date | null;
|
|
@@ -41,7 +41,7 @@ interface Order {
|
|
|
41
41
|
/** Guest last name. */
|
|
42
42
|
lastName?: string;
|
|
43
43
|
/**
|
|
44
|
-
* Guest email.
|
|
44
|
+
* Guest email address.
|
|
45
45
|
* @format EMAIL
|
|
46
46
|
*/
|
|
47
47
|
email?: string;
|
|
@@ -51,7 +51,7 @@ interface Order {
|
|
|
51
51
|
confirmed?: boolean;
|
|
52
52
|
/** Order status. */
|
|
53
53
|
status?: OrderStatusWithLiterals;
|
|
54
|
-
/** Payment method used for purchase,
|
|
54
|
+
/** Payment method used for purchase, for example, "payPal", "creditCard", etc. */
|
|
55
55
|
method?: string;
|
|
56
56
|
/** Amount of tickets ordered. */
|
|
57
57
|
ticketsQuantity?: number;
|
|
@@ -69,14 +69,14 @@ interface Order {
|
|
|
69
69
|
fullName?: string;
|
|
70
70
|
/** Order invoice. */
|
|
71
71
|
invoice?: Invoice;
|
|
72
|
-
/** Whether all tickets in an order are checked
|
|
72
|
+
/** Whether all tickets in an order are checked in. */
|
|
73
73
|
fullyCheckedIn?: boolean;
|
|
74
|
-
/** Internal order payment details */
|
|
74
|
+
/** Internal order payment details. */
|
|
75
75
|
paymentDetails?: PaymentDetails;
|
|
76
76
|
/** Checkout channel type. */
|
|
77
77
|
channel?: ChannelTypeWithLiterals;
|
|
78
78
|
/**
|
|
79
|
-
* Date and time the order was updated.
|
|
79
|
+
* Date and time the order was last updated.
|
|
80
80
|
* @readonly
|
|
81
81
|
*/
|
|
82
82
|
updated?: Date | null;
|
|
@@ -85,31 +85,31 @@ interface Order {
|
|
|
85
85
|
}
|
|
86
86
|
interface FormResponse {
|
|
87
87
|
/**
|
|
88
|
-
*
|
|
88
|
+
* Form field inputs.
|
|
89
89
|
* @maxSize 200
|
|
90
90
|
*/
|
|
91
91
|
inputValues?: InputValue[];
|
|
92
92
|
}
|
|
93
93
|
interface InputValue {
|
|
94
94
|
/**
|
|
95
|
-
*
|
|
95
|
+
* Form field input name.
|
|
96
96
|
* @maxLength 100
|
|
97
97
|
*/
|
|
98
98
|
inputName?: string;
|
|
99
99
|
/**
|
|
100
|
-
*
|
|
100
|
+
* Form field value.
|
|
101
101
|
* @maxLength 5000
|
|
102
102
|
*/
|
|
103
103
|
value?: string;
|
|
104
104
|
/**
|
|
105
|
-
*
|
|
105
|
+
* Form field values.
|
|
106
106
|
* @maxSize 100
|
|
107
107
|
* @maxLength 5000
|
|
108
108
|
*/
|
|
109
109
|
values?: string[];
|
|
110
110
|
}
|
|
111
111
|
declare enum OrderStatus {
|
|
112
|
-
/** Order status
|
|
112
|
+
/** Order status isn't available for this request fieldset. */
|
|
113
113
|
NA_ORDER_STATUS = "NA_ORDER_STATUS",
|
|
114
114
|
/** Order is confirmed, no payment is required. */
|
|
115
115
|
FREE = "FREE",
|
|
@@ -117,9 +117,9 @@ declare enum OrderStatus {
|
|
|
117
117
|
PENDING = "PENDING",
|
|
118
118
|
/** Order is paid. */
|
|
119
119
|
PAID = "PAID",
|
|
120
|
-
/** Order is confirmed but
|
|
120
|
+
/** Order is confirmed but must be paid via offline payment. Status needs to be manually updated to `"PAID"`. */
|
|
121
121
|
OFFLINE_PENDING = "OFFLINE_PENDING",
|
|
122
|
-
/** Order is
|
|
122
|
+
/** Order is waiting for payment at the cashier. */
|
|
123
123
|
INITIATED = "INITIATED",
|
|
124
124
|
/** Order is canceled. */
|
|
125
125
|
CANCELED = "CANCELED",
|
|
@@ -142,7 +142,7 @@ interface Money {
|
|
|
142
142
|
*/
|
|
143
143
|
amount?: string;
|
|
144
144
|
/**
|
|
145
|
-
*
|
|
145
|
+
* 3-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. For example, `USD`.
|
|
146
146
|
* @format CURRENCY
|
|
147
147
|
*/
|
|
148
148
|
currency?: string;
|
|
@@ -153,7 +153,7 @@ interface Money {
|
|
|
153
153
|
value?: string | null;
|
|
154
154
|
}
|
|
155
155
|
interface TicketingTicket {
|
|
156
|
-
/** Unique ticket number
|
|
156
|
+
/** Unique ticket number which is assigned automatically when creating a ticket. */
|
|
157
157
|
ticketNumber?: string;
|
|
158
158
|
/** Associated order number. */
|
|
159
159
|
orderNumber?: string;
|
|
@@ -171,20 +171,15 @@ interface TicketingTicket {
|
|
|
171
171
|
* @readonly
|
|
172
172
|
*/
|
|
173
173
|
free?: boolean;
|
|
174
|
-
/**
|
|
174
|
+
/** Ticket and event policies. */
|
|
175
175
|
policy?: string;
|
|
176
|
-
/**
|
|
177
|
-
* *Deprecated:** Use `tickets.checkInUrl` instead.
|
|
178
|
-
* @deprecated
|
|
179
|
-
*/
|
|
180
|
-
qrCode?: string;
|
|
181
176
|
/** Ticket check-in. */
|
|
182
177
|
checkIn?: CheckIn;
|
|
183
178
|
/** Associated order status. */
|
|
184
179
|
orderStatus?: OrderStatusWithLiterals;
|
|
185
180
|
/**
|
|
186
181
|
* Whether the order and ticket are archived.
|
|
187
|
-
* If set to `true`, they
|
|
182
|
+
* If set to `true`, they aren't visible in the order list.
|
|
188
183
|
*/
|
|
189
184
|
orderArchived?: boolean;
|
|
190
185
|
/** Buyer full name. */
|
|
@@ -193,13 +188,8 @@ interface TicketingTicket {
|
|
|
193
188
|
guestFullName?: string | null;
|
|
194
189
|
/** Guest personal details. */
|
|
195
190
|
guestDetails?: GuestDetails;
|
|
196
|
-
/** Whether ticket is visible in
|
|
191
|
+
/** Whether the ticket is visible in an order. */
|
|
197
192
|
archived?: boolean;
|
|
198
|
-
/**
|
|
199
|
-
* *Deprecated:** Use `tickets.ticketPdfUrl` instead.
|
|
200
|
-
* @deprecated
|
|
201
|
-
*/
|
|
202
|
-
ticketPdf?: string;
|
|
203
193
|
/**
|
|
204
194
|
* Ticket owner member ID.
|
|
205
195
|
* @format GUID
|
|
@@ -223,7 +213,7 @@ interface TicketingTicket {
|
|
|
223
213
|
/** Associated order checkout channel type. */
|
|
224
214
|
channel?: ChannelTypeWithLiterals;
|
|
225
215
|
/**
|
|
226
|
-
* URL to download ticket in `.pkpass` format for Apple Wallet.
|
|
216
|
+
* URL to download a ticket in `.pkpass` format for Apple Wallet.
|
|
227
217
|
* @format WEB_URL
|
|
228
218
|
* @readonly
|
|
229
219
|
*/
|
|
@@ -235,7 +225,7 @@ interface TicketingTicket {
|
|
|
235
225
|
canceled?: boolean | null;
|
|
236
226
|
}
|
|
237
227
|
interface CheckIn {
|
|
238
|
-
/** Time of check-in. */
|
|
228
|
+
/** Time of a ticket's check-in. */
|
|
239
229
|
created?: Date | null;
|
|
240
230
|
}
|
|
241
231
|
interface GuestDetails {
|
|
@@ -264,7 +254,7 @@ interface GuestDetails {
|
|
|
264
254
|
phone?: string | null;
|
|
265
255
|
}
|
|
266
256
|
declare enum ChannelType {
|
|
267
|
-
/** Buyer created the order via an online channel, such as a website or
|
|
257
|
+
/** Buyer created the order via an online channel, such as a website or mobile app. */
|
|
268
258
|
ONLINE = "ONLINE",
|
|
269
259
|
/** Sales person created the order and collected the money. */
|
|
270
260
|
OFFLINE_POS = "OFFLINE_POS"
|
|
@@ -344,8 +334,8 @@ interface Invoice {
|
|
|
344
334
|
* Total amount of a cart after discount, tax, and fees.
|
|
345
335
|
* Grand total is calculated in the following order:
|
|
346
336
|
* 1. Total prices of all items in the cart are calculated.
|
|
347
|
-
* 2. Discount is subtracted from the cart
|
|
348
|
-
* 3. Tax is added
|
|
337
|
+
* 2. Discount is subtracted from the cart, if applicable.
|
|
338
|
+
* 3. Tax is added, if applicable.
|
|
349
339
|
* 4. Wix ticket service fee is added.
|
|
350
340
|
*/
|
|
351
341
|
grandTotal?: Money;
|
|
@@ -354,7 +344,7 @@ interface Invoice {
|
|
|
354
344
|
* @readonly
|
|
355
345
|
*/
|
|
356
346
|
fees?: Fee[];
|
|
357
|
-
/** Total revenue, excluding fees.
|
|
347
|
+
/** Total revenue, excluding fees. Taxes and payment provider fees aren't deducted. */
|
|
358
348
|
revenue?: Money;
|
|
359
349
|
/** Invoice preview URL. Only returned if the order is paid. */
|
|
360
350
|
previewUrl?: string | null;
|
|
@@ -512,7 +502,7 @@ declare enum FeeType {
|
|
|
512
502
|
/** @enumType */
|
|
513
503
|
type FeeTypeWithLiterals = FeeType | 'FEE_ADDED' | 'FEE_INCLUDED' | 'FEE_ADDED_AT_CHECKOUT';
|
|
514
504
|
interface PaymentDetails {
|
|
515
|
-
/** Wix Payments transaction */
|
|
505
|
+
/** Wix Payments transaction. */
|
|
516
506
|
transaction?: PaymentTransaction;
|
|
517
507
|
}
|
|
518
508
|
interface PaymentTransaction {
|
|
@@ -523,7 +513,7 @@ interface PaymentTransaction {
|
|
|
523
513
|
*/
|
|
524
514
|
transactionId?: string;
|
|
525
515
|
/**
|
|
526
|
-
* Transaction
|
|
516
|
+
* Transaction payment method, for example, "payPal", "creditCard", etc.
|
|
527
517
|
* @readonly
|
|
528
518
|
*/
|
|
529
519
|
method?: string;
|
|
@@ -809,9 +799,9 @@ interface VoidAuthorizedPaymentRequest {
|
|
|
809
799
|
interface VoidAuthorizedPaymentResponse {
|
|
810
800
|
}
|
|
811
801
|
declare enum ReservationStatus {
|
|
812
|
-
/** The
|
|
802
|
+
/** The reservation is pending confirmation. It will expire after a certain amount of time. */
|
|
813
803
|
RESERVATION_PENDING = "RESERVATION_PENDING",
|
|
814
|
-
/** The reservation is confirmed and
|
|
804
|
+
/** The reservation is confirmed and won't expire. */
|
|
815
805
|
RESERVATION_CONFIRMED = "RESERVATION_CONFIRMED",
|
|
816
806
|
/** The reservation is canceled because it's not paid. */
|
|
817
807
|
RESERVATION_CANCELED = "RESERVATION_CANCELED",
|
|
@@ -829,7 +819,7 @@ interface GetCheckoutOptionsResponse {
|
|
|
829
819
|
paymentMethodConfigured?: boolean;
|
|
830
820
|
/** Whether coupons are accepted at checkout. */
|
|
831
821
|
acceptCoupons?: boolean;
|
|
832
|
-
/** Whether premium services are enabled. Enabled for free if site
|
|
822
|
+
/** Whether premium services are enabled. Enabled for free if site doesn't sell any paid tickets. Selling tickets for a fee requires a premium feature `"events_sell_tickets"`. */
|
|
833
823
|
premiumServices?: boolean;
|
|
834
824
|
/** Whether there are any paid tickets available for sale. */
|
|
835
825
|
paidTickets?: boolean;
|
|
@@ -838,7 +828,7 @@ interface GetCheckoutOptionsResponse {
|
|
|
838
828
|
}
|
|
839
829
|
interface ListAvailableTicketsRequest {
|
|
840
830
|
/**
|
|
841
|
-
* Event ID to list tickets for. If not
|
|
831
|
+
* Event ID to list tickets for. If not specified, available tickets for all events on a site will be returned.
|
|
842
832
|
* @format GUID
|
|
843
833
|
*/
|
|
844
834
|
eventId?: string;
|
|
@@ -953,7 +943,7 @@ interface TicketSalePeriod {
|
|
|
953
943
|
startDate?: Date | null;
|
|
954
944
|
/** Ticket sale end timestamp. */
|
|
955
945
|
endDate?: Date | null;
|
|
956
|
-
/** Whether to hide this ticket if it'
|
|
946
|
+
/** Whether to hide this ticket if it isn't on sale. */
|
|
957
947
|
hideNotOnSale?: boolean;
|
|
958
948
|
}
|
|
959
949
|
declare enum TicketSaleStatus {
|
|
@@ -1085,7 +1075,7 @@ interface TicketReservationQuantity {
|
|
|
1085
1075
|
* @format DECIMAL_VALUE
|
|
1086
1076
|
*/
|
|
1087
1077
|
priceOverride?: string | null;
|
|
1088
|
-
/** Optional ticket details */
|
|
1078
|
+
/** Optional ticket details. */
|
|
1089
1079
|
ticketDetails?: TicketDetails[];
|
|
1090
1080
|
}
|
|
1091
1081
|
interface CreateReservationResponse {
|
|
@@ -1195,7 +1185,7 @@ interface CheckoutRequest {
|
|
|
1195
1185
|
* @format GUID
|
|
1196
1186
|
*/
|
|
1197
1187
|
reservationId?: string;
|
|
1198
|
-
/** Member ID
|
|
1188
|
+
/** Member ID. If empty, no site member is associated with this order. */
|
|
1199
1189
|
memberId?: string;
|
|
1200
1190
|
/** Discount to apply on the invoice. */
|
|
1201
1191
|
discount?: DiscountRequest;
|
|
@@ -1211,7 +1201,7 @@ interface CheckoutRequest {
|
|
|
1211
1201
|
paidPlanBenefit?: PaidPlanBenefit;
|
|
1212
1202
|
/** Options controlling the checkout process. */
|
|
1213
1203
|
options?: CheckoutOptions;
|
|
1214
|
-
/** Whether marketing consent was given */
|
|
1204
|
+
/** Whether marketing consent was given. */
|
|
1215
1205
|
marketingConsent?: boolean | null;
|
|
1216
1206
|
}
|
|
1217
1207
|
interface Buyer {
|
|
@@ -1242,7 +1232,7 @@ interface Guest {
|
|
|
1242
1232
|
interface CheckoutOptions {
|
|
1243
1233
|
/** Whether to ignore settings to notify contacts. */
|
|
1244
1234
|
silent?: boolean;
|
|
1245
|
-
/** Whether the payment is to be done in person between the buyer and the merchant. When true, the completed order is created with status OFFLINE_PENDING and inPerson payment method. */
|
|
1235
|
+
/** Whether the payment is to be done in person between the buyer and the merchant. When true, the completed order is created with status `OFFLINE_PENDING` and `inPerson` payment method. */
|
|
1246
1236
|
payInPerson?: boolean;
|
|
1247
1237
|
/** Whether to ignore form validation. */
|
|
1248
1238
|
ignoreFormValidation?: boolean;
|
|
@@ -1281,7 +1271,7 @@ interface UpdateCheckoutRequest {
|
|
|
1281
1271
|
/**
|
|
1282
1272
|
* Member ID.
|
|
1283
1273
|
*
|
|
1284
|
-
* If empty, no site member is associated
|
|
1274
|
+
* If empty, no site member is associated with this order.
|
|
1285
1275
|
*/
|
|
1286
1276
|
memberId?: string | null;
|
|
1287
1277
|
/** Discount to apply on the invoice. */
|
|
@@ -1308,7 +1298,7 @@ interface PosCheckoutRequest {
|
|
|
1308
1298
|
reservationId: string;
|
|
1309
1299
|
/**
|
|
1310
1300
|
* Payment details ID.
|
|
1311
|
-
* Not required if reservation total is 0. In this case the order will be created with status
|
|
1301
|
+
* Not required if reservation total is 0. In this case the order will be created with status `FREE` and no payment.
|
|
1312
1302
|
* @format GUID
|
|
1313
1303
|
*/
|
|
1314
1304
|
paymentDetailsId?: string | null;
|
|
@@ -1316,7 +1306,7 @@ interface PosCheckoutRequest {
|
|
|
1316
1306
|
interface PosCheckoutResponse {
|
|
1317
1307
|
/** Created order. */
|
|
1318
1308
|
order?: Order;
|
|
1319
|
-
/** Time when the order expires, applies to orders with status
|
|
1309
|
+
/** Time when the order expires, applies to orders with status is `INITIATED`. */
|
|
1320
1310
|
expires?: Date | null;
|
|
1321
1311
|
/** Ticket reservations. */
|
|
1322
1312
|
reservations?: TicketReservation[];
|
|
@@ -1,14 +1,17 @@
|
|
|
1
|
-
import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
|
|
1
|
+
import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
|
|
2
2
|
import { ListOrdersOptions, ListOrdersResponse, GetOrderIdentifiers, GetOrderOptions, Order, UpdateOrderIdentifiers, UpdateOrderOptions, UpdateOrderResponse, UpdateOrderApplicationErrors, BulkUpdateOrdersOptions, BulkUpdateOrdersResponse, BulkUpdateOrdersApplicationErrors, ConfirmOrderOptions, ConfirmOrderResponse, ConfirmOrderApplicationErrors, GetSummaryOptions, GetSummaryResponse, CaptureAuthorizedPaymentOptions, CaptureAuthorizedPaymentApplicationErrors, VoidAuthorizedPaymentOptions, VoidAuthorizedPaymentApplicationErrors, GetCheckoutOptionsResponse, ListAvailableTicketsOptions, ListAvailableTicketsResponse, QueryAvailableTicketsOptions, QueryAvailableTicketsResponse, CreateReservationOptions, CreateReservationResponse, GetInvoiceOptions, GetInvoiceResponse, CheckoutOptionsForRequest, CheckoutResponse, UpdateCheckoutOptions, UpdateCheckoutResponse, PosCheckoutOptions, PosCheckoutResponse, OrderDeletedEnvelope, OrderUpdatedEnvelope, OrderConfirmedEnvelope, OrderInitiatedEnvelope, OrderReservationCreatedEnvelope, OrderReservationUpdatedEnvelope } from './index.typings.mjs';
|
|
3
3
|
export { Action, Address, AddressLocation, AddressStreetOneOf, BalanceSummary, BaseEventMetadata, BulkUpdateOrdersRequest, Buyer, CalendarLinks, CancelReservationRequest, CancelReservationResponse, CaptureAuthorizedPaymentRequest, CaptureAuthorizedPaymentResponse, ChannelType, CheckIn, CheckoutOptions, CheckoutRequest, ConfirmOrderRequest, ConfirmReservationRequest, ConfirmReservationResponse, Counts, CouponDiscount, CreateReservationRequest, Dashboard, Discount, DiscountErrors, DiscountItem, DiscountItemDiscountOneOf, DiscountRequest, Error, EventKey, ExpireReservationRequest, ExpireReservationResponse, FacetCounts, Fee, FeeName, FeeType, FindOrderByReservationIdRequest, FindOrderByReservationIdResponse, FormResponse, FormattedAddress, GetCheckoutOptionsRequest, GetInvoicePreviewRequest, GetInvoiceRequest, GetOrderRequest, GetOrderResponse, GetPaymentInfoRequest, GetPaymentInfoResponse, GetReservationRequest, GetReservationResponse, GetSummaryRequest, GiftCardErrors, GiftCardErrorsError, GiftCardPaymentDetails, Guest, GuestDetails, HeadersEntry, IdentificationData, IdentificationDataIdOneOf, InputValue, Invoice, Item, ListAvailableTicketsRequest, ListOrdersRequest, MessageEnvelope, Money, OnlineConferencingLogin, OrderConfirmed, OrderDeleted, OrderFacetCounts, OrderFacets, OrderFieldset, OrderInitiated, OrderPageUrls, OrderPaid, OrderStatus, OrderTag, OrderType, OrderUpdated, PaidPlanBenefit, PaidPlanDiscount, PaidPlanDiscountDiscountOneOf, PaymentDetails, PaymentTransaction, PaymentTransactionEvent, PaymentTransactionSummary, PercentDiscount, PosCheckoutRequest, PricingOption, PricingOptions, QueryAvailableTicketsRequest, QueryEventsWithPaidReservationsRequest, QueryEventsWithPaidReservationsResponse, RawHttpResponse, Reservation, ReservationCount, ReservationCreated, ReservationStatus, ReservationUpdated, ResponseMetaData, ScheduledActionEnumAction, StandardDetails, State, StreetAddress, Subdivision, SubdivisionType, Tax, TaxType, Ticket, TicketDefinition, TicketDefinitionFieldset, TicketDetails, TicketPricing, TicketPricingPriceOneOf, TicketQuantity, TicketReservation, TicketReservationQuantity, TicketSalePeriod, TicketSaleStatus, TicketSales, TicketingTicket, Type, UpdateCheckoutRequest, UpdateOrderRequest, VoidAuthorizedPaymentRequest, VoidAuthorizedPaymentResponse, WebhookIdentityType, WixFeeConfig } from './index.typings.mjs';
|
|
4
4
|
|
|
5
|
+
type OrderNonNullablePaths = `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}.price.amount` | `tickets.${number}.price.currency` | `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}.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` | `fullyCheckedIn` | `paymentDetails.transaction.transactionId` | `paymentDetails.transaction.method` | `channel`;
|
|
5
6
|
declare function listOrders$1(httpClient: HttpClient): ListOrdersSignature;
|
|
6
7
|
interface ListOrdersSignature {
|
|
7
8
|
/**
|
|
8
9
|
* Retrieves a list of orders, including ticket data.
|
|
9
10
|
* @param - An object representing the available options for retrieving a list of orders.
|
|
10
11
|
*/
|
|
11
|
-
(options?: ListOrdersOptions
|
|
12
|
+
(options?: ListOrdersOptions): Promise<NonNullablePaths<ListOrdersResponse, `total` | `offset` | `limit` | {
|
|
13
|
+
[P in OrderNonNullablePaths]: `orders.${number}.${P}`;
|
|
14
|
+
}[OrderNonNullablePaths]>>;
|
|
12
15
|
}
|
|
13
16
|
declare function getOrder$1(httpClient: HttpClient): GetOrderSignature;
|
|
14
17
|
interface GetOrderSignature {
|
|
@@ -21,7 +24,7 @@ interface GetOrderSignature {
|
|
|
21
24
|
* @param - An object containing identifiers for the order to be retrieved.
|
|
22
25
|
* @returns Requested order.
|
|
23
26
|
*/
|
|
24
|
-
(identifiers: GetOrderIdentifiers, options?: GetOrderOptions
|
|
27
|
+
(identifiers: NonNullablePaths<GetOrderIdentifiers, `eventId` | `orderNumber`>, options?: GetOrderOptions): Promise<NonNullablePaths<Order, OrderNonNullablePaths>>;
|
|
25
28
|
}
|
|
26
29
|
declare function updateOrder$1(httpClient: HttpClient): UpdateOrderSignature;
|
|
27
30
|
interface UpdateOrderSignature {
|
|
@@ -30,8 +33,10 @@ interface UpdateOrderSignature {
|
|
|
30
33
|
* @param - An object representing the available options for updating an order.
|
|
31
34
|
* @param - An object containing identifiers for the order to be updated.
|
|
32
35
|
*/
|
|
33
|
-
(identifiers: UpdateOrderIdentifiers, options?: UpdateOrderOptions
|
|
34
|
-
|
|
36
|
+
(identifiers: NonNullablePaths<UpdateOrderIdentifiers, `eventId` | `orderNumber`>, options?: UpdateOrderOptions): Promise<NonNullablePaths<UpdateOrderResponse, {
|
|
37
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
38
|
+
}[OrderNonNullablePaths]> & {
|
|
39
|
+
__applicationErrorsType?: UpdateOrderApplicationErrors;
|
|
35
40
|
}>;
|
|
36
41
|
}
|
|
37
42
|
declare function bulkUpdateOrders$1(httpClient: HttpClient): BulkUpdateOrdersSignature;
|
|
@@ -41,8 +46,10 @@ interface BulkUpdateOrdersSignature {
|
|
|
41
46
|
* @param - An object representing the available options for confirming an order.
|
|
42
47
|
* @param - Event ID to which the order belongs.
|
|
43
48
|
*/
|
|
44
|
-
(eventId: string, options?: BulkUpdateOrdersOptions
|
|
45
|
-
|
|
49
|
+
(eventId: string, options?: BulkUpdateOrdersOptions): Promise<NonNullablePaths<BulkUpdateOrdersResponse, {
|
|
50
|
+
[P in OrderNonNullablePaths]: `orders.${number}.${P}`;
|
|
51
|
+
}[OrderNonNullablePaths]> & {
|
|
52
|
+
__applicationErrorsType?: BulkUpdateOrdersApplicationErrors;
|
|
46
53
|
}>;
|
|
47
54
|
}
|
|
48
55
|
declare function confirmOrder$1(httpClient: HttpClient): ConfirmOrderSignature;
|
|
@@ -56,8 +63,10 @@ interface ConfirmOrderSignature {
|
|
|
56
63
|
* @param - An object representing the available options for confirming an order.
|
|
57
64
|
* @param - Event ID to which the order belongs.
|
|
58
65
|
*/
|
|
59
|
-
(eventId: string, options?: ConfirmOrderOptions
|
|
60
|
-
|
|
66
|
+
(eventId: string, options?: ConfirmOrderOptions): Promise<NonNullablePaths<ConfirmOrderResponse, {
|
|
67
|
+
[P in OrderNonNullablePaths]: `orders.${number}.${P}`;
|
|
68
|
+
}[OrderNonNullablePaths]> & {
|
|
69
|
+
__applicationErrorsType?: ConfirmOrderApplicationErrors;
|
|
61
70
|
}>;
|
|
62
71
|
}
|
|
63
72
|
declare function getSummary$1(httpClient: HttpClient): GetSummarySignature;
|
|
@@ -69,7 +78,7 @@ interface GetSummarySignature {
|
|
|
69
78
|
* -->
|
|
70
79
|
* @param - An object representing the available options for retrieving a summary of total ticket sales.
|
|
71
80
|
*/
|
|
72
|
-
(options?: GetSummaryOptions
|
|
81
|
+
(options?: GetSummaryOptions): Promise<NonNullablePaths<GetSummaryResponse, `sales` | `sales.${number}.total.amount` | `sales.${number}.total.currency` | `sales.${number}.totalOrders` | `sales.${number}.totalTickets`>>;
|
|
73
82
|
}
|
|
74
83
|
declare function captureAuthorizedPayment$1(httpClient: HttpClient): CaptureAuthorizedPaymentSignature;
|
|
75
84
|
interface CaptureAuthorizedPaymentSignature {
|
|
@@ -79,8 +88,8 @@ interface CaptureAuthorizedPaymentSignature {
|
|
|
79
88
|
* For orders with non-authorized payments request will fail.
|
|
80
89
|
* @param - Order number.
|
|
81
90
|
*/
|
|
82
|
-
(orderNumber: string, options?: CaptureAuthorizedPaymentOptions
|
|
83
|
-
__applicationErrorsType?: CaptureAuthorizedPaymentApplicationErrors
|
|
91
|
+
(orderNumber: string, options?: CaptureAuthorizedPaymentOptions): Promise<void & {
|
|
92
|
+
__applicationErrorsType?: CaptureAuthorizedPaymentApplicationErrors;
|
|
84
93
|
}>;
|
|
85
94
|
}
|
|
86
95
|
declare function voidAuthorizedPayment$1(httpClient: HttpClient): VoidAuthorizedPaymentSignature;
|
|
@@ -91,8 +100,8 @@ interface VoidAuthorizedPaymentSignature {
|
|
|
91
100
|
* For orders with non-authorized payments request will fail.
|
|
92
101
|
* @param - Order number.
|
|
93
102
|
*/
|
|
94
|
-
(orderNumber: string, options?: VoidAuthorizedPaymentOptions
|
|
95
|
-
__applicationErrorsType?: VoidAuthorizedPaymentApplicationErrors
|
|
103
|
+
(orderNumber: string, options?: VoidAuthorizedPaymentOptions): Promise<void & {
|
|
104
|
+
__applicationErrorsType?: VoidAuthorizedPaymentApplicationErrors;
|
|
96
105
|
}>;
|
|
97
106
|
}
|
|
98
107
|
declare function getCheckoutOptions$1(httpClient: HttpClient): GetCheckoutOptionsSignature;
|
|
@@ -100,7 +109,7 @@ interface GetCheckoutOptionsSignature {
|
|
|
100
109
|
/**
|
|
101
110
|
* Retrieves checkout details.
|
|
102
111
|
*/
|
|
103
|
-
(): Promise<GetCheckoutOptionsResponse
|
|
112
|
+
(): Promise<NonNullablePaths<GetCheckoutOptionsResponse, `paymentMethodConfigured` | `acceptCoupons` | `premiumServices` | `paidTickets` | `acceptGiftCards`>>;
|
|
104
113
|
}
|
|
105
114
|
declare function listAvailableTickets$1(httpClient: HttpClient): ListAvailableTicketsSignature;
|
|
106
115
|
interface ListAvailableTicketsSignature {
|
|
@@ -111,7 +120,7 @@ interface ListAvailableTicketsSignature {
|
|
|
111
120
|
* -->
|
|
112
121
|
* @param - An object representing the available options for retrieving a list of tickets available for reservation.
|
|
113
122
|
*/
|
|
114
|
-
(options?: ListAvailableTicketsOptions
|
|
123
|
+
(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`>>;
|
|
115
124
|
}
|
|
116
125
|
declare function queryAvailableTickets$1(httpClient: HttpClient): QueryAvailableTicketsSignature;
|
|
117
126
|
interface QueryAvailableTicketsSignature {
|
|
@@ -122,7 +131,7 @@ interface QueryAvailableTicketsSignature {
|
|
|
122
131
|
* -->
|
|
123
132
|
* @param - An object representing the available options for retrieving a list of tickets available for reservation.
|
|
124
133
|
*/
|
|
125
|
-
(options?: QueryAvailableTicketsOptions
|
|
134
|
+
(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`>>;
|
|
126
135
|
}
|
|
127
136
|
declare function createReservation$1(httpClient: HttpClient): CreateReservationSignature;
|
|
128
137
|
interface CreateReservationSignature {
|
|
@@ -135,7 +144,7 @@ interface CreateReservationSignature {
|
|
|
135
144
|
* @param - An object representing the available options for creating a reservation.
|
|
136
145
|
* @param - Event ID to which the reservation belongs.
|
|
137
146
|
*/
|
|
138
|
-
(eventId: string, options?: CreateReservationOptions
|
|
147
|
+
(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
148
|
}
|
|
140
149
|
declare function cancelReservation$1(httpClient: HttpClient): CancelReservationSignature;
|
|
141
150
|
interface CancelReservationSignature {
|
|
@@ -159,7 +168,7 @@ interface GetInvoiceSignature {
|
|
|
159
168
|
* @param - An object containing identifiers for the reservation invoice preview to be generated.
|
|
160
169
|
* @param - Event ID to which the invoice belongs.
|
|
161
170
|
*/
|
|
162
|
-
(reservationId: string, eventId: string, options?: GetInvoiceOptions
|
|
171
|
+
(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`>>;
|
|
163
172
|
}
|
|
164
173
|
declare function checkout$1(httpClient: HttpClient): CheckoutSignature;
|
|
165
174
|
interface CheckoutSignature {
|
|
@@ -178,7 +187,9 @@ interface CheckoutSignature {
|
|
|
178
187
|
* @param - An object representing the available options for checking out a reserved ticket.
|
|
179
188
|
* @param - Event ID to which the checkout belongs.
|
|
180
189
|
*/
|
|
181
|
-
(eventId: string, options?: CheckoutOptionsForRequest
|
|
190
|
+
(eventId: string, options?: NonNullablePaths<CheckoutOptionsForRequest, `guests.${number}.form`>): Promise<NonNullablePaths<CheckoutResponse, {
|
|
191
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
192
|
+
}[OrderNonNullablePaths] | `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`>>;
|
|
182
193
|
}
|
|
183
194
|
declare function updateCheckout$1(httpClient: HttpClient): UpdateCheckoutSignature;
|
|
184
195
|
interface UpdateCheckoutSignature {
|
|
@@ -192,7 +203,9 @@ interface UpdateCheckoutSignature {
|
|
|
192
203
|
* @param - An object containing identifiers for the order and tickets to be updated.
|
|
193
204
|
* @param - Event ID to which the checkout belongs.
|
|
194
205
|
*/
|
|
195
|
-
(orderNumber: string, eventId: string, options?: UpdateCheckoutOptions
|
|
206
|
+
(orderNumber: string, eventId: string, options?: UpdateCheckoutOptions): Promise<NonNullablePaths<UpdateCheckoutResponse, {
|
|
207
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
208
|
+
}[OrderNonNullablePaths]>>;
|
|
196
209
|
}
|
|
197
210
|
declare function posCheckout$1(httpClient: HttpClient): PosCheckoutSignature;
|
|
198
211
|
interface PosCheckoutSignature {
|
|
@@ -200,7 +213,9 @@ interface PosCheckoutSignature {
|
|
|
200
213
|
* Creates order with payment details already initiated via Cashier Pay API.
|
|
201
214
|
* @param - Event ID to which the checkout belongs.
|
|
202
215
|
*/
|
|
203
|
-
(eventId: string, options?: PosCheckoutOptions
|
|
216
|
+
(eventId: string, options?: NonNullablePaths<PosCheckoutOptions, `reservationId`>): Promise<NonNullablePaths<PosCheckoutResponse, {
|
|
217
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
218
|
+
}[OrderNonNullablePaths] | `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`>>;
|
|
204
219
|
}
|
|
205
220
|
declare const onOrderDeleted$1: EventDefinition<OrderDeletedEnvelope, "wix.events.ticketing.events.OrderDeleted">;
|
|
206
221
|
declare const onOrderUpdated$1: EventDefinition<OrderUpdatedEnvelope, "wix.events.ticketing.events.OrderUpdated">;
|
|
@@ -227,7 +242,7 @@ declare const checkout: MaybeContext<BuildRESTFunction<typeof checkout$1> & type
|
|
|
227
242
|
declare const updateCheckout: MaybeContext<BuildRESTFunction<typeof updateCheckout$1> & typeof updateCheckout$1>;
|
|
228
243
|
declare const posCheckout: MaybeContext<BuildRESTFunction<typeof posCheckout$1> & typeof posCheckout$1>;
|
|
229
244
|
/**
|
|
230
|
-
* This event is triggered when an order is deleted via GDPR request.
|
|
245
|
+
* This event is triggered when an order is deleted via a GDPR request.
|
|
231
246
|
*/
|
|
232
247
|
declare const onOrderDeleted: BuildEventDefinition<typeof onOrderDeleted$1>;
|
|
233
248
|
/** */
|