@wix/auto_sdk_events_orders 1.0.0
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 +1 -0
- package/build/cjs/index.js +18 -0
- package/build/cjs/index.js.map +1 -0
- package/build/cjs/index.typings.d.ts +1 -0
- package/build/cjs/index.typings.js +18 -0
- package/build/cjs/index.typings.js.map +1 -0
- package/build/cjs/meta.d.ts +1 -0
- package/build/cjs/meta.js +18 -0
- package/build/cjs/meta.js.map +1 -0
- package/build/cjs/src/events-v1-order-orders.context.d.ts +42 -0
- package/build/cjs/src/events-v1-order-orders.context.js +62 -0
- package/build/cjs/src/events-v1-order-orders.context.js.map +1 -0
- package/build/cjs/src/events-v1-order-orders.http.d.ts +97 -0
- package/build/cjs/src/events-v1-order-orders.http.js +1635 -0
- package/build/cjs/src/events-v1-order-orders.http.js.map +1 -0
- package/build/cjs/src/events-v1-order-orders.meta.d.ts +49 -0
- package/build/cjs/src/events-v1-order-orders.meta.js +351 -0
- package/build/cjs/src/events-v1-order-orders.meta.js.map +1 -0
- package/build/cjs/src/events-v1-order-orders.public.d.ts +202 -0
- package/build/cjs/src/events-v1-order-orders.public.js +248 -0
- package/build/cjs/src/events-v1-order-orders.public.js.map +1 -0
- package/build/cjs/src/events-v1-order-orders.types.d.ts +1854 -0
- package/build/cjs/src/events-v1-order-orders.types.js +178 -0
- package/build/cjs/src/events-v1-order-orders.types.js.map +1 -0
- package/build/cjs/src/events-v1-order-orders.universal.d.ts +2536 -0
- package/build/cjs/src/events-v1-order-orders.universal.js +1146 -0
- package/build/cjs/src/events-v1-order-orders.universal.js.map +1 -0
- package/build/es/index.d.ts +1 -0
- package/build/es/index.js +2 -0
- package/build/es/index.js.map +1 -0
- package/build/es/index.typings.d.ts +1 -0
- package/build/es/index.typings.js +2 -0
- package/build/es/index.typings.js.map +1 -0
- package/build/es/meta.d.ts +1 -0
- package/build/es/meta.js +2 -0
- package/build/es/meta.js.map +1 -0
- package/build/es/package.json +3 -0
- package/build/es/src/events-v1-order-orders.context.d.ts +42 -0
- package/build/es/src/events-v1-order-orders.context.js +42 -0
- package/build/es/src/events-v1-order-orders.context.js.map +1 -0
- package/build/es/src/events-v1-order-orders.http.d.ts +97 -0
- package/build/es/src/events-v1-order-orders.http.js +1615 -0
- package/build/es/src/events-v1-order-orders.http.js.map +1 -0
- package/build/es/src/events-v1-order-orders.meta.d.ts +49 -0
- package/build/es/src/events-v1-order-orders.meta.js +308 -0
- package/build/es/src/events-v1-order-orders.meta.js.map +1 -0
- package/build/es/src/events-v1-order-orders.public.d.ts +202 -0
- package/build/es/src/events-v1-order-orders.public.js +211 -0
- package/build/es/src/events-v1-order-orders.public.js.map +1 -0
- package/build/es/src/events-v1-order-orders.types.d.ts +1854 -0
- package/build/es/src/events-v1-order-orders.types.js +175 -0
- package/build/es/src/events-v1-order-orders.types.js.map +1 -0
- package/build/es/src/events-v1-order-orders.universal.d.ts +2536 -0
- package/build/es/src/events-v1-order-orders.universal.js +1103 -0
- package/build/es/src/events-v1-order-orders.universal.js.map +1 -0
- package/build/internal/cjs/index.d.ts +1 -0
- package/build/internal/cjs/index.js +18 -0
- package/build/internal/cjs/index.js.map +1 -0
- package/build/internal/cjs/index.typings.d.ts +1 -0
- package/build/internal/cjs/index.typings.js +18 -0
- package/build/internal/cjs/index.typings.js.map +1 -0
- package/build/internal/cjs/meta.d.ts +1 -0
- package/build/internal/cjs/meta.js +18 -0
- package/build/internal/cjs/meta.js.map +1 -0
- package/build/internal/cjs/src/events-v1-order-orders.context.d.ts +42 -0
- package/build/internal/cjs/src/events-v1-order-orders.context.js +62 -0
- package/build/internal/cjs/src/events-v1-order-orders.context.js.map +1 -0
- package/build/internal/cjs/src/events-v1-order-orders.http.d.ts +97 -0
- package/build/internal/cjs/src/events-v1-order-orders.http.js +1635 -0
- package/build/internal/cjs/src/events-v1-order-orders.http.js.map +1 -0
- package/build/internal/cjs/src/events-v1-order-orders.meta.d.ts +49 -0
- package/build/internal/cjs/src/events-v1-order-orders.meta.js +351 -0
- package/build/internal/cjs/src/events-v1-order-orders.meta.js.map +1 -0
- package/build/internal/cjs/src/events-v1-order-orders.public.d.ts +202 -0
- package/build/internal/cjs/src/events-v1-order-orders.public.js +248 -0
- package/build/internal/cjs/src/events-v1-order-orders.public.js.map +1 -0
- package/build/internal/cjs/src/events-v1-order-orders.types.d.ts +1854 -0
- package/build/internal/cjs/src/events-v1-order-orders.types.js +178 -0
- package/build/internal/cjs/src/events-v1-order-orders.types.js.map +1 -0
- package/build/internal/cjs/src/events-v1-order-orders.universal.d.ts +2536 -0
- package/build/internal/cjs/src/events-v1-order-orders.universal.js +1146 -0
- package/build/internal/cjs/src/events-v1-order-orders.universal.js.map +1 -0
- package/build/internal/es/index.d.ts +1 -0
- package/build/internal/es/index.js +2 -0
- package/build/internal/es/index.js.map +1 -0
- package/build/internal/es/index.typings.d.ts +1 -0
- package/build/internal/es/index.typings.js +2 -0
- package/build/internal/es/index.typings.js.map +1 -0
- package/build/internal/es/meta.d.ts +1 -0
- package/build/internal/es/meta.js +2 -0
- package/build/internal/es/meta.js.map +1 -0
- package/build/internal/es/src/events-v1-order-orders.context.d.ts +42 -0
- package/build/internal/es/src/events-v1-order-orders.context.js +42 -0
- package/build/internal/es/src/events-v1-order-orders.context.js.map +1 -0
- package/build/internal/es/src/events-v1-order-orders.http.d.ts +97 -0
- package/build/internal/es/src/events-v1-order-orders.http.js +1615 -0
- package/build/internal/es/src/events-v1-order-orders.http.js.map +1 -0
- package/build/internal/es/src/events-v1-order-orders.meta.d.ts +49 -0
- package/build/internal/es/src/events-v1-order-orders.meta.js +308 -0
- package/build/internal/es/src/events-v1-order-orders.meta.js.map +1 -0
- package/build/internal/es/src/events-v1-order-orders.public.d.ts +202 -0
- package/build/internal/es/src/events-v1-order-orders.public.js +211 -0
- package/build/internal/es/src/events-v1-order-orders.public.js.map +1 -0
- package/build/internal/es/src/events-v1-order-orders.types.d.ts +1854 -0
- package/build/internal/es/src/events-v1-order-orders.types.js +175 -0
- package/build/internal/es/src/events-v1-order-orders.types.js.map +1 -0
- package/build/internal/es/src/events-v1-order-orders.universal.d.ts +2536 -0
- package/build/internal/es/src/events-v1-order-orders.universal.js +1103 -0
- package/build/internal/es/src/events-v1-order-orders.universal.js.map +1 -0
- package/meta/package.json +3 -0
- package/package.json +52 -0
|
@@ -0,0 +1,2536 @@
|
|
|
1
|
+
export interface Order {
|
|
2
|
+
/** Unique order number. */
|
|
3
|
+
orderNumber?: string;
|
|
4
|
+
/** Reservation ID. */
|
|
5
|
+
reservationId?: string;
|
|
6
|
+
/**
|
|
7
|
+
* Payment snapshot ID. Empty for the `FREE` order.
|
|
8
|
+
* @readonly
|
|
9
|
+
*/
|
|
10
|
+
snapshotId?: string;
|
|
11
|
+
/** Event ID to which the order belongs. */
|
|
12
|
+
eventId?: string;
|
|
13
|
+
/** Contact ID of buyer (resolved using email address). */
|
|
14
|
+
contactId?: string;
|
|
15
|
+
/** Buyer member ID, if applicable. */
|
|
16
|
+
memberId?: string;
|
|
17
|
+
/**
|
|
18
|
+
* RSVP created timestamp.
|
|
19
|
+
* @readonly
|
|
20
|
+
*/
|
|
21
|
+
created?: Date | null;
|
|
22
|
+
/** Guest first name. */
|
|
23
|
+
firstName?: string;
|
|
24
|
+
/** Guest last name. */
|
|
25
|
+
lastName?: string;
|
|
26
|
+
/** Guest email. */
|
|
27
|
+
email?: string;
|
|
28
|
+
/** Checkout form response. When each purchased ticket is assigned to a guest, guest forms are returned for each ticket, and buyer info is returned. */
|
|
29
|
+
checkoutForm?: FormResponse;
|
|
30
|
+
/** Whether the order is confirmed (triggered once payment gateway processes the payment and funds reach the merchant's account). */
|
|
31
|
+
confirmed?: boolean;
|
|
32
|
+
/**
|
|
33
|
+
* Order status. Possible values:
|
|
34
|
+
* - `FREE`: The order is confirmed, no payment is required.
|
|
35
|
+
* - `PENDING`: The order was paid, but the payment gateway suspended the payment.
|
|
36
|
+
* - `PAID`: The order is paid.
|
|
37
|
+
* - `OFFLINE_PENDING`: The order is confirmed but has to be paid in cash and the status is manually updated to `PAID`.
|
|
38
|
+
* - `INITIATED`: The order is awaiting for payment.
|
|
39
|
+
* - `CANCELED`: The order is canceled.
|
|
40
|
+
* - `DECLINED`: The order is payment is declined.
|
|
41
|
+
*/
|
|
42
|
+
status?: OrderStatus;
|
|
43
|
+
/** Payment method used for purchase, e.g., "payPal", "creditCard", etc. */
|
|
44
|
+
method?: string;
|
|
45
|
+
/** Quantity of ordered tickets. */
|
|
46
|
+
ticketsQuantity?: number;
|
|
47
|
+
/** Total order price. */
|
|
48
|
+
totalPrice?: Money;
|
|
49
|
+
/** Ticket PDF URL. */
|
|
50
|
+
ticketsPdf?: string;
|
|
51
|
+
/** Tickets (generated after payment). */
|
|
52
|
+
tickets?: TicketingTicket[];
|
|
53
|
+
/** Whether the order is archived. */
|
|
54
|
+
archived?: boolean;
|
|
55
|
+
/** Whether the order is anonymized by GDPR delete. */
|
|
56
|
+
anonymized?: boolean;
|
|
57
|
+
/** Guest full name. */
|
|
58
|
+
fullName?: string;
|
|
59
|
+
/** Order invoice. */
|
|
60
|
+
invoice?: Invoice;
|
|
61
|
+
/** Whether all tickets in order are checked-in. */
|
|
62
|
+
fullyCheckedIn?: boolean;
|
|
63
|
+
/** Internal order payment details */
|
|
64
|
+
paymentDetails?: PaymentDetails;
|
|
65
|
+
/** Checkout channel type */
|
|
66
|
+
channel?: ChannelType;
|
|
67
|
+
/**
|
|
68
|
+
* Order updated timestamp.
|
|
69
|
+
* @readonly
|
|
70
|
+
*/
|
|
71
|
+
updated?: Date | null;
|
|
72
|
+
/** Whether marketing consent was given */
|
|
73
|
+
marketingConsent?: boolean | null;
|
|
74
|
+
}
|
|
75
|
+
export interface FormResponse {
|
|
76
|
+
/** Input fields for a checkout form. */
|
|
77
|
+
inputValues?: InputValue[];
|
|
78
|
+
}
|
|
79
|
+
export interface InputValue {
|
|
80
|
+
/** Input field name. */
|
|
81
|
+
inputName?: string;
|
|
82
|
+
/** Input field value. */
|
|
83
|
+
value?: string;
|
|
84
|
+
/** Multiple input field values. */
|
|
85
|
+
values?: string[];
|
|
86
|
+
}
|
|
87
|
+
export interface FormattedAddress {
|
|
88
|
+
/** One line address representation. */
|
|
89
|
+
formatted?: string;
|
|
90
|
+
/** Address components (optional). */
|
|
91
|
+
address?: Address;
|
|
92
|
+
}
|
|
93
|
+
/** Physical address */
|
|
94
|
+
export interface Address extends AddressStreetOneOf {
|
|
95
|
+
/** Street name and number. */
|
|
96
|
+
streetAddress?: StreetAddress;
|
|
97
|
+
/** Main address line, usually street and number as free text. */
|
|
98
|
+
addressLine1?: string | null;
|
|
99
|
+
/** Country code. */
|
|
100
|
+
country?: string | null;
|
|
101
|
+
/** Subdivision shorthand. Usually, a short code (2 or 3 letters) that represents a state, region, prefecture, or province. e.g. NY */
|
|
102
|
+
subdivision?: string | null;
|
|
103
|
+
/** City name. */
|
|
104
|
+
city?: string | null;
|
|
105
|
+
/** Zip/postal code. */
|
|
106
|
+
postalCode?: string | null;
|
|
107
|
+
/** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */
|
|
108
|
+
addressLine2?: string | null;
|
|
109
|
+
}
|
|
110
|
+
/** @oneof */
|
|
111
|
+
export interface AddressStreetOneOf {
|
|
112
|
+
/** Street name and number. */
|
|
113
|
+
streetAddress?: StreetAddress;
|
|
114
|
+
/** Main address line, usually street and number as free text. */
|
|
115
|
+
addressLine?: string | null;
|
|
116
|
+
}
|
|
117
|
+
export interface StreetAddress {
|
|
118
|
+
/** Street number. */
|
|
119
|
+
number?: string;
|
|
120
|
+
/** Street name. */
|
|
121
|
+
name?: string;
|
|
122
|
+
}
|
|
123
|
+
export interface AddressLocation {
|
|
124
|
+
/** Address latitude. */
|
|
125
|
+
latitude?: number | null;
|
|
126
|
+
/** Address longitude. */
|
|
127
|
+
longitude?: number | null;
|
|
128
|
+
}
|
|
129
|
+
export interface Subdivision {
|
|
130
|
+
/** Short subdivision code. */
|
|
131
|
+
code?: string;
|
|
132
|
+
/** Subdivision full name. */
|
|
133
|
+
name?: string;
|
|
134
|
+
}
|
|
135
|
+
export declare enum SubdivisionType {
|
|
136
|
+
UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
|
|
137
|
+
/** State */
|
|
138
|
+
ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
|
|
139
|
+
/** County */
|
|
140
|
+
ADMINISTRATIVE_AREA_LEVEL_2 = "ADMINISTRATIVE_AREA_LEVEL_2",
|
|
141
|
+
/** City/town */
|
|
142
|
+
ADMINISTRATIVE_AREA_LEVEL_3 = "ADMINISTRATIVE_AREA_LEVEL_3",
|
|
143
|
+
/** Neighborhood/quarter */
|
|
144
|
+
ADMINISTRATIVE_AREA_LEVEL_4 = "ADMINISTRATIVE_AREA_LEVEL_4",
|
|
145
|
+
/** Street/block */
|
|
146
|
+
ADMINISTRATIVE_AREA_LEVEL_5 = "ADMINISTRATIVE_AREA_LEVEL_5",
|
|
147
|
+
/** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
|
|
148
|
+
COUNTRY = "COUNTRY"
|
|
149
|
+
}
|
|
150
|
+
/** Subdivision Concordance values */
|
|
151
|
+
export interface StandardDetails {
|
|
152
|
+
/** subdivision iso-3166-2 code according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). e.g. US-NY, GB-SCT, NO-30 */
|
|
153
|
+
iso31662?: string | null;
|
|
154
|
+
}
|
|
155
|
+
export declare enum OrderStatus {
|
|
156
|
+
/** Order status not available for this request fieldset. */
|
|
157
|
+
NA_ORDER_STATUS = "NA_ORDER_STATUS",
|
|
158
|
+
/** Order is confirmed and payment isn't required. */
|
|
159
|
+
FREE = "FREE",
|
|
160
|
+
/** Order is paid for but the payment gateway has suspended the payment. */
|
|
161
|
+
PENDING = "PENDING",
|
|
162
|
+
/** Order is paid via a payment gateway. */
|
|
163
|
+
PAID = "PAID",
|
|
164
|
+
/** Order is confirmed but must be paid via offline payment. Status needs to be manually updated to `PAID`. */
|
|
165
|
+
OFFLINE_PENDING = "OFFLINE_PENDING",
|
|
166
|
+
/** Order is awaiting payment at the cashier. */
|
|
167
|
+
INITIATED = "INITIATED",
|
|
168
|
+
/** Order is canceled. */
|
|
169
|
+
CANCELED = "CANCELED",
|
|
170
|
+
/** Order payment is declined. */
|
|
171
|
+
DECLINED = "DECLINED",
|
|
172
|
+
/** Order payment is authorized. */
|
|
173
|
+
AUTHORIZED = "AUTHORIZED",
|
|
174
|
+
/** Order payment is voided. */
|
|
175
|
+
VOIDED = "VOIDED",
|
|
176
|
+
/** Order is partially paid with less than the total amount. */
|
|
177
|
+
PARTIALLY_PAID = "PARTIALLY_PAID"
|
|
178
|
+
}
|
|
179
|
+
export interface Money {
|
|
180
|
+
/**
|
|
181
|
+
* *Deprecated:** Use `value` instead.
|
|
182
|
+
* @deprecated
|
|
183
|
+
*/
|
|
184
|
+
amount?: string;
|
|
185
|
+
/** Currency code. Must be a valid [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code (e.g., USD). */
|
|
186
|
+
currency?: string;
|
|
187
|
+
/** Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, starts with a single (-), to indicate that the amount is negative. */
|
|
188
|
+
value?: string | null;
|
|
189
|
+
}
|
|
190
|
+
export interface TicketingTicket {
|
|
191
|
+
/** Unique ticket number (issued automatically). */
|
|
192
|
+
ticketNumber?: string;
|
|
193
|
+
/** Associated order number. */
|
|
194
|
+
orderNumber?: string;
|
|
195
|
+
/** Ticket definition ID. */
|
|
196
|
+
ticketDefinitionId?: string;
|
|
197
|
+
/** Ticket name. */
|
|
198
|
+
name?: string;
|
|
199
|
+
/** Ticket price. */
|
|
200
|
+
price?: Money;
|
|
201
|
+
/**
|
|
202
|
+
* Whether the ticket requires payment.
|
|
203
|
+
* @readonly
|
|
204
|
+
*/
|
|
205
|
+
free?: boolean;
|
|
206
|
+
/** Event and ticket policies. */
|
|
207
|
+
policy?: string;
|
|
208
|
+
/**
|
|
209
|
+
* Deprecated, use `check_in_url`.
|
|
210
|
+
* @deprecated
|
|
211
|
+
*/
|
|
212
|
+
qrCode?: string;
|
|
213
|
+
/** Ticket check-in. */
|
|
214
|
+
checkIn?: CheckIn;
|
|
215
|
+
/** Associated order status. */
|
|
216
|
+
orderStatus?: OrderStatus;
|
|
217
|
+
/** Whether order and ticket are visible in order list. */
|
|
218
|
+
orderArchived?: boolean;
|
|
219
|
+
/** Buyer full name. */
|
|
220
|
+
orderFullName?: string;
|
|
221
|
+
/** Guest full name. */
|
|
222
|
+
guestFullName?: string | null;
|
|
223
|
+
/** Guest personal details. */
|
|
224
|
+
guestDetails?: GuestDetails;
|
|
225
|
+
/** Whether ticket is visible in guest list. */
|
|
226
|
+
archived?: boolean;
|
|
227
|
+
/**
|
|
228
|
+
* Deprecated, use `ticket_pdf_url`.
|
|
229
|
+
* @deprecated
|
|
230
|
+
*/
|
|
231
|
+
ticketPdf?: string;
|
|
232
|
+
/** Ticket owner member ID. */
|
|
233
|
+
memberId?: string | null;
|
|
234
|
+
/**
|
|
235
|
+
* Whether ticket was anonymized by GDPR delete.
|
|
236
|
+
* Anonymized tickets no longer contain personally identifiable information (PII).
|
|
237
|
+
*/
|
|
238
|
+
anonymized?: boolean;
|
|
239
|
+
/**
|
|
240
|
+
* Ticket check-in URL.
|
|
241
|
+
* Shown as a QR code image in PDF.
|
|
242
|
+
* Format: `https://www.wixevents.com/check-in/{ticket number},{event id}`.
|
|
243
|
+
* Example: `https://www.wixevents.com/check-in/AAAA-AAAA-BB021,00000000-0000-0000-0000-000000000000`
|
|
244
|
+
*/
|
|
245
|
+
checkInUrl?: string;
|
|
246
|
+
/** URL for ticket PDF download. */
|
|
247
|
+
ticketPdfUrl?: string;
|
|
248
|
+
/** Associated order checkout channel type */
|
|
249
|
+
channel?: ChannelType;
|
|
250
|
+
/**
|
|
251
|
+
* URL to download ticket in the `.pkpass` format for Apple Wallet
|
|
252
|
+
* @readonly
|
|
253
|
+
*/
|
|
254
|
+
walletPassUrl?: string;
|
|
255
|
+
/**
|
|
256
|
+
* Whether ticket is canceled.
|
|
257
|
+
* @readonly
|
|
258
|
+
*/
|
|
259
|
+
canceled?: boolean | null;
|
|
260
|
+
}
|
|
261
|
+
export interface CheckIn {
|
|
262
|
+
/** Time of check-in */
|
|
263
|
+
created?: Date | null;
|
|
264
|
+
}
|
|
265
|
+
export interface GuestDetails {
|
|
266
|
+
/** Whether ticket belongs to assigned guest. */
|
|
267
|
+
guestAssigned?: boolean;
|
|
268
|
+
/** Guest first name. */
|
|
269
|
+
firstName?: string | null;
|
|
270
|
+
/** Guest last name. */
|
|
271
|
+
lastName?: string | null;
|
|
272
|
+
/** Guest email. */
|
|
273
|
+
email?: string | null;
|
|
274
|
+
/** Full form response. */
|
|
275
|
+
form?: FormResponse;
|
|
276
|
+
/** Contact ID associated with this guest. */
|
|
277
|
+
contactId?: string | null;
|
|
278
|
+
/** Guest phone number. */
|
|
279
|
+
phone?: string | null;
|
|
280
|
+
}
|
|
281
|
+
export declare enum ChannelType {
|
|
282
|
+
/** Buyer created the order via an online channel such as a website or mobile app. */
|
|
283
|
+
ONLINE = "ONLINE",
|
|
284
|
+
/** Sales person created the order and collected the money. */
|
|
285
|
+
OFFLINE_POS = "OFFLINE_POS"
|
|
286
|
+
}
|
|
287
|
+
export interface TicketDetails {
|
|
288
|
+
/** Unique seat id in the event venue. */
|
|
289
|
+
seatId?: string | null;
|
|
290
|
+
/**
|
|
291
|
+
* Optional sector label.
|
|
292
|
+
* @readonly
|
|
293
|
+
*/
|
|
294
|
+
sectionLabel?: string | null;
|
|
295
|
+
/**
|
|
296
|
+
* Area label.
|
|
297
|
+
* @readonly
|
|
298
|
+
*/
|
|
299
|
+
areaLabel?: string | null;
|
|
300
|
+
/**
|
|
301
|
+
* Table label.
|
|
302
|
+
* @readonly
|
|
303
|
+
*/
|
|
304
|
+
tableLabel?: string | null;
|
|
305
|
+
/**
|
|
306
|
+
* Row label.
|
|
307
|
+
* @readonly
|
|
308
|
+
*/
|
|
309
|
+
rowLabel?: string | null;
|
|
310
|
+
/**
|
|
311
|
+
* Seat label in a row or table.
|
|
312
|
+
* @readonly
|
|
313
|
+
*/
|
|
314
|
+
seatLabel?: string | null;
|
|
315
|
+
/** Number of places in the spot. If not provided - defaults to 1. */
|
|
316
|
+
capacity?: number | null;
|
|
317
|
+
/** Custom pricing of ticket. */
|
|
318
|
+
priceOverride?: string | null;
|
|
319
|
+
/** Pricing option id. */
|
|
320
|
+
pricingOptionId?: string | null;
|
|
321
|
+
/**
|
|
322
|
+
* Pricing option name.
|
|
323
|
+
* @readonly
|
|
324
|
+
*/
|
|
325
|
+
pricingOptionName?: string | null;
|
|
326
|
+
}
|
|
327
|
+
export interface Invoice {
|
|
328
|
+
/** Items listed in the invoice. */
|
|
329
|
+
items?: Item[];
|
|
330
|
+
/**
|
|
331
|
+
* Total cart amount.
|
|
332
|
+
* @deprecated
|
|
333
|
+
*/
|
|
334
|
+
total?: Money;
|
|
335
|
+
/** Discount applied to a cart. */
|
|
336
|
+
discount?: Discount;
|
|
337
|
+
/** Tax applied to cart. */
|
|
338
|
+
tax?: Tax;
|
|
339
|
+
/** Total cart amount before discount, tax, and fees. */
|
|
340
|
+
subTotal?: Money;
|
|
341
|
+
/**
|
|
342
|
+
* Total amount of cart after discount, tax, and fees.
|
|
343
|
+
* Grand total is calculated in the following order:
|
|
344
|
+
* 1. Total prices of all items in the cart are calculated.
|
|
345
|
+
* 2. Discount is subtracted from the cart (if applicable).
|
|
346
|
+
* 3. Tax is added (if applicable).
|
|
347
|
+
* 4. Wix ticket service fee is added.
|
|
348
|
+
*/
|
|
349
|
+
grandTotal?: Money;
|
|
350
|
+
/**
|
|
351
|
+
* Fees applied to the cart.
|
|
352
|
+
* @readonly
|
|
353
|
+
*/
|
|
354
|
+
fees?: Fee[];
|
|
355
|
+
/** Total revenue, excluding fees. (Taxes and payment provider fees are not deducted). */
|
|
356
|
+
revenue?: Money;
|
|
357
|
+
/** Invoice preview URL. This value is only returned when the order is paid. */
|
|
358
|
+
previewUrl?: string | null;
|
|
359
|
+
}
|
|
360
|
+
export interface Item {
|
|
361
|
+
/** Unique line item ID. */
|
|
362
|
+
_id?: string;
|
|
363
|
+
/** Line item quantity. */
|
|
364
|
+
quantity?: number;
|
|
365
|
+
/** Line item name. */
|
|
366
|
+
name?: string;
|
|
367
|
+
/** Line item price. */
|
|
368
|
+
price?: Money;
|
|
369
|
+
/** Total price for line items. It's calculated by multiplying price and item quantity. */
|
|
370
|
+
total?: Money;
|
|
371
|
+
/** Discount applied to the line item. */
|
|
372
|
+
discount?: Discount;
|
|
373
|
+
/** Tax applied to the item. */
|
|
374
|
+
tax?: Tax;
|
|
375
|
+
/**
|
|
376
|
+
* Fees applied to the item.
|
|
377
|
+
* @readonly
|
|
378
|
+
*/
|
|
379
|
+
fees?: Fee[];
|
|
380
|
+
}
|
|
381
|
+
export interface Discount {
|
|
382
|
+
/** Total discount amount. */
|
|
383
|
+
amount?: Money;
|
|
384
|
+
/** Total sum after the discount. */
|
|
385
|
+
afterDiscount?: Money;
|
|
386
|
+
/**
|
|
387
|
+
* Discount coupon code.
|
|
388
|
+
* @deprecated
|
|
389
|
+
*/
|
|
390
|
+
code?: string;
|
|
391
|
+
/**
|
|
392
|
+
* Discount coupon name.
|
|
393
|
+
* @deprecated
|
|
394
|
+
*/
|
|
395
|
+
name?: string;
|
|
396
|
+
/**
|
|
397
|
+
* Discount coupon ID.
|
|
398
|
+
* @deprecated
|
|
399
|
+
*/
|
|
400
|
+
couponId?: string;
|
|
401
|
+
/** Discount items. */
|
|
402
|
+
discounts?: DiscountItem[];
|
|
403
|
+
}
|
|
404
|
+
export interface DiscountItem extends DiscountItemDiscountOneOf {
|
|
405
|
+
/** Coupon discount. */
|
|
406
|
+
coupon?: CouponDiscount;
|
|
407
|
+
/** Pricing plan discount. */
|
|
408
|
+
paidPlan?: PaidPlanDiscount;
|
|
409
|
+
/** Total discount amount. */
|
|
410
|
+
amount?: Money;
|
|
411
|
+
}
|
|
412
|
+
/** @oneof */
|
|
413
|
+
export interface DiscountItemDiscountOneOf {
|
|
414
|
+
/** Coupon discount. */
|
|
415
|
+
coupon?: CouponDiscount;
|
|
416
|
+
/** Pricing plan discount. */
|
|
417
|
+
paidPlan?: PaidPlanDiscount;
|
|
418
|
+
}
|
|
419
|
+
export interface CouponDiscount {
|
|
420
|
+
/** Discount coupon name. */
|
|
421
|
+
name?: string;
|
|
422
|
+
/** Discount coupon code. */
|
|
423
|
+
code?: string;
|
|
424
|
+
/** Discount coupon ID. */
|
|
425
|
+
couponId?: string;
|
|
426
|
+
}
|
|
427
|
+
export interface PaidPlanDiscount extends PaidPlanDiscountDiscountOneOf {
|
|
428
|
+
/** Discount by percentage applied to tickets. */
|
|
429
|
+
percentDiscount?: PercentDiscount;
|
|
430
|
+
/** Name of pricing plan. */
|
|
431
|
+
name?: string;
|
|
432
|
+
}
|
|
433
|
+
/** @oneof */
|
|
434
|
+
export interface PaidPlanDiscountDiscountOneOf {
|
|
435
|
+
/** Discount by percentage applied to tickets. */
|
|
436
|
+
percentDiscount?: PercentDiscount;
|
|
437
|
+
}
|
|
438
|
+
export interface PercentDiscount {
|
|
439
|
+
/** Percent rate. */
|
|
440
|
+
rate?: string;
|
|
441
|
+
/** Number of discounted tickets. */
|
|
442
|
+
quantityDiscounted?: number;
|
|
443
|
+
}
|
|
444
|
+
export interface Tax {
|
|
445
|
+
/** Tax type. */
|
|
446
|
+
type?: TaxType;
|
|
447
|
+
/**
|
|
448
|
+
* Tax name.
|
|
449
|
+
* @readonly
|
|
450
|
+
*/
|
|
451
|
+
name?: string;
|
|
452
|
+
/** Tax rate. */
|
|
453
|
+
rate?: string;
|
|
454
|
+
/** Taxable amount. */
|
|
455
|
+
taxable?: Money;
|
|
456
|
+
/** Total tax amount. */
|
|
457
|
+
amount?: Money;
|
|
458
|
+
}
|
|
459
|
+
export declare enum TaxType {
|
|
460
|
+
/** Tax is included in the ticket price. */
|
|
461
|
+
INCLUDED = "INCLUDED",
|
|
462
|
+
/** Tax is added to the order at the checkout. */
|
|
463
|
+
ADDED = "ADDED",
|
|
464
|
+
/** Tax is added to the final total at the checkout. */
|
|
465
|
+
ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
|
|
466
|
+
}
|
|
467
|
+
export interface Fee {
|
|
468
|
+
/** Fee identifier. */
|
|
469
|
+
name?: FeeName;
|
|
470
|
+
/** How fee is calculated. */
|
|
471
|
+
type?: FeeType;
|
|
472
|
+
/**
|
|
473
|
+
* Fee rate.
|
|
474
|
+
* @readonly
|
|
475
|
+
*/
|
|
476
|
+
rate?: string;
|
|
477
|
+
/** Total amount of fee charges. */
|
|
478
|
+
amount?: Money;
|
|
479
|
+
}
|
|
480
|
+
export declare enum FeeName {
|
|
481
|
+
/** Wix ticket service fee charges applied to the line item. */
|
|
482
|
+
WIX_FEE = "WIX_FEE"
|
|
483
|
+
}
|
|
484
|
+
export declare enum FeeType {
|
|
485
|
+
/** Fee is added to the ticket price at checkout. */
|
|
486
|
+
FEE_ADDED = "FEE_ADDED",
|
|
487
|
+
/** Seller absorbs the fee. It is deducted from the ticket price. */
|
|
488
|
+
FEE_INCLUDED = "FEE_INCLUDED",
|
|
489
|
+
/** Fee is added to the ticket price at checkout. */
|
|
490
|
+
FEE_ADDED_AT_CHECKOUT = "FEE_ADDED_AT_CHECKOUT"
|
|
491
|
+
}
|
|
492
|
+
export interface PaymentDetails {
|
|
493
|
+
/** Wix Payments transaction */
|
|
494
|
+
transaction?: PaymentTransaction;
|
|
495
|
+
}
|
|
496
|
+
export interface PaymentTransaction {
|
|
497
|
+
/**
|
|
498
|
+
* Wix Payments transaction id
|
|
499
|
+
* @readonly
|
|
500
|
+
*/
|
|
501
|
+
transactionId?: string;
|
|
502
|
+
/**
|
|
503
|
+
* Transaction Payment method e.g., "payPal", "creditCard", etc.
|
|
504
|
+
* @readonly
|
|
505
|
+
*/
|
|
506
|
+
method?: string;
|
|
507
|
+
}
|
|
508
|
+
export declare enum ScheduledActionEnumAction {
|
|
509
|
+
/** Action not scheduled. */
|
|
510
|
+
UNKNOWN_ACTION = "UNKNOWN_ACTION",
|
|
511
|
+
/** Captured after the delay. */
|
|
512
|
+
CAPTURE = "CAPTURE",
|
|
513
|
+
/** Void after the delay. */
|
|
514
|
+
VOID = "VOID"
|
|
515
|
+
}
|
|
516
|
+
export declare enum Action {
|
|
517
|
+
/** Order can be archived. */
|
|
518
|
+
ARCHIVE = "ARCHIVE",
|
|
519
|
+
/** Order can be unarchived. */
|
|
520
|
+
UNARCHIVE = "UNARCHIVE",
|
|
521
|
+
/** Order can be confirmed. */
|
|
522
|
+
CONFIRM = "CONFIRM",
|
|
523
|
+
/** Order can be captured. */
|
|
524
|
+
CAPTURE = "CAPTURE",
|
|
525
|
+
/** Order can be voided. */
|
|
526
|
+
VOID = "VOID"
|
|
527
|
+
}
|
|
528
|
+
export interface GiftCardPaymentDetails {
|
|
529
|
+
/** Gift card payment id. */
|
|
530
|
+
giftCardPaymentId?: string | null;
|
|
531
|
+
/** ID of the app that created the gift card. */
|
|
532
|
+
appId?: string | null;
|
|
533
|
+
/** Whether the gift card payment is voided. */
|
|
534
|
+
voided?: boolean | null;
|
|
535
|
+
/** Amount */
|
|
536
|
+
amount?: Money;
|
|
537
|
+
/** Obfuscated gift card code. */
|
|
538
|
+
obfuscatedCode?: string | null;
|
|
539
|
+
}
|
|
540
|
+
export interface BalanceSummary {
|
|
541
|
+
/** Amount left to pay. */
|
|
542
|
+
balance?: Money;
|
|
543
|
+
}
|
|
544
|
+
export interface OrderDeleted {
|
|
545
|
+
/** Order deleted timestamp in ISO UTC format. */
|
|
546
|
+
timestamp?: Date | null;
|
|
547
|
+
/** Event ID to which the order belongs. */
|
|
548
|
+
eventId?: string;
|
|
549
|
+
/** Unique order number. */
|
|
550
|
+
orderNumber?: string;
|
|
551
|
+
/** Contact ID associated with this order */
|
|
552
|
+
contactId?: string;
|
|
553
|
+
/** Member ID associated with this order. */
|
|
554
|
+
memberId?: string | null;
|
|
555
|
+
/**
|
|
556
|
+
* Order created timestamp.
|
|
557
|
+
* @readonly
|
|
558
|
+
*/
|
|
559
|
+
created?: Date | null;
|
|
560
|
+
/**
|
|
561
|
+
* Order updated timestamp.
|
|
562
|
+
* @readonly
|
|
563
|
+
*/
|
|
564
|
+
updated?: Date | null;
|
|
565
|
+
/** Whether order was anonymized by GDPR delete. */
|
|
566
|
+
anonymized?: boolean;
|
|
567
|
+
/** Order type. */
|
|
568
|
+
orderType?: OrderType;
|
|
569
|
+
/** Whether event was triggered by GDPR delete request. */
|
|
570
|
+
triggeredByAnonymizeRequest?: boolean;
|
|
571
|
+
/** Tickets generated after payment. */
|
|
572
|
+
tickets?: Ticket[];
|
|
573
|
+
}
|
|
574
|
+
export declare enum OrderType {
|
|
575
|
+
/** Buyer form is used for all tickets. */
|
|
576
|
+
UNASSIGNED_TICKETS = "UNASSIGNED_TICKETS",
|
|
577
|
+
/** Each order ticket has its own form. */
|
|
578
|
+
ASSIGNED_TICKETS = "ASSIGNED_TICKETS"
|
|
579
|
+
}
|
|
580
|
+
export interface Ticket {
|
|
581
|
+
/** Unique issued ticket number. */
|
|
582
|
+
ticketNumber?: string;
|
|
583
|
+
/** Ticket definition ID. */
|
|
584
|
+
ticketDefinitionId?: string;
|
|
585
|
+
/** Ticket check-in. */
|
|
586
|
+
checkIn?: CheckIn;
|
|
587
|
+
/** Ticket price. */
|
|
588
|
+
price?: Money;
|
|
589
|
+
/** Whether ticket is archived. */
|
|
590
|
+
archived?: boolean;
|
|
591
|
+
/** Guest first name. */
|
|
592
|
+
firstName?: string | null;
|
|
593
|
+
/** Guest last name. */
|
|
594
|
+
lastName?: string | null;
|
|
595
|
+
/** Guest email. */
|
|
596
|
+
email?: string | null;
|
|
597
|
+
/** Contact ID associated with this ticket. */
|
|
598
|
+
contactId?: string | null;
|
|
599
|
+
/** Whether ticket is confirmed */
|
|
600
|
+
confirmed?: boolean;
|
|
601
|
+
/** Member ID associated with this ticket. */
|
|
602
|
+
memberId?: string | null;
|
|
603
|
+
/** Ticket form response (only assigned tickets contain separate forms). */
|
|
604
|
+
form?: FormResponse;
|
|
605
|
+
/** Ticket name. */
|
|
606
|
+
ticketName?: string;
|
|
607
|
+
/** Anonymized tickets no longer contain personally identifiable information (PII). */
|
|
608
|
+
anonymized?: boolean;
|
|
609
|
+
/** URL and password to online conference */
|
|
610
|
+
onlineConferencingLogin?: OnlineConferencingLogin;
|
|
611
|
+
/** Seat ID associated with this ticket. */
|
|
612
|
+
seatId?: string | null;
|
|
613
|
+
/** Whether ticket is canceled. */
|
|
614
|
+
canceled?: boolean | null;
|
|
615
|
+
}
|
|
616
|
+
export interface OnlineConferencingLogin {
|
|
617
|
+
/**
|
|
618
|
+
* Link URL to the online conference.
|
|
619
|
+
* @readonly
|
|
620
|
+
*/
|
|
621
|
+
link?: string;
|
|
622
|
+
/**
|
|
623
|
+
* Password for the online conference.
|
|
624
|
+
* @readonly
|
|
625
|
+
*/
|
|
626
|
+
password?: string | null;
|
|
627
|
+
}
|
|
628
|
+
export interface ListOrdersRequest {
|
|
629
|
+
/** Offset. */
|
|
630
|
+
offset?: number;
|
|
631
|
+
/** Limit. */
|
|
632
|
+
limit?: number;
|
|
633
|
+
/**
|
|
634
|
+
* Predefined sets of fields to return.
|
|
635
|
+
* - `TICKETS`: Returns `tickets`.
|
|
636
|
+
* - `DETAILS`: Returns `reservationId`, `snapshotId`, `created`, `firstName`, `lastName`, `confirmed`, `status`, `method`, `ticketsQuantity`, `totalPrice`, `ticketsPdf`, `archived`, `fullName`.
|
|
637
|
+
* - `FORM` : Returns `checkoutForm`.
|
|
638
|
+
* - `INVOICE`: Returns `invoice`.
|
|
639
|
+
*
|
|
640
|
+
* Default: If `fieldset` is not included in the request, `orderNumber`, `eventId`, `contactId`, `memberId`, `anonymized`, `fullyCheckedIn` are returned.
|
|
641
|
+
*
|
|
642
|
+
*/
|
|
643
|
+
fieldset?: OrderFieldset[];
|
|
644
|
+
/**
|
|
645
|
+
* Order status. Possible values:
|
|
646
|
+
* - `FREE`: The order is confirmed, no payment is required.
|
|
647
|
+
* - `PENDING`: The order was paid, but the payment gateway suspended the payment.
|
|
648
|
+
* - `PAID`: The order is paid.
|
|
649
|
+
* - `OFFLINE_PENDING`: The order is confirmed but has to be paid in cash and the status is manually updated to `PAID`.
|
|
650
|
+
* - `INITIATED`: The order is awaiting for payment.
|
|
651
|
+
* - `CANCELED`: The order is canceled.
|
|
652
|
+
* - `DECLINED`: The order is payment is declined.
|
|
653
|
+
*/
|
|
654
|
+
status?: OrderStatus[];
|
|
655
|
+
/** Event ID to which the order belongs. */
|
|
656
|
+
eventId?: string[];
|
|
657
|
+
/** Order number. */
|
|
658
|
+
orderNumber?: string[];
|
|
659
|
+
/** Site member ID. */
|
|
660
|
+
memberId?: string[];
|
|
661
|
+
/** Field facets, */
|
|
662
|
+
facet?: string[];
|
|
663
|
+
/** Search filter. You can search `fullName`, `email` and `orderNumber`. */
|
|
664
|
+
searchPhrase?: string;
|
|
665
|
+
/** Event creator ID. */
|
|
666
|
+
eventCreatorId?: string[];
|
|
667
|
+
/**
|
|
668
|
+
* Sort order.
|
|
669
|
+
* Default: `created:asc`.
|
|
670
|
+
*/
|
|
671
|
+
sort?: string;
|
|
672
|
+
/** Order tag. */
|
|
673
|
+
tag?: OrderTag[];
|
|
674
|
+
/** Guest contact IDs. */
|
|
675
|
+
contactId?: string[];
|
|
676
|
+
}
|
|
677
|
+
export declare enum OrderFieldset {
|
|
678
|
+
/** Include tickets in response. */
|
|
679
|
+
TICKETS = "TICKETS",
|
|
680
|
+
/** Include order details in the response: `status`, `firstName`, `lastName`, `email`, `created`, etc. */
|
|
681
|
+
DETAILS = "DETAILS",
|
|
682
|
+
/** Include `checkoutForm` in the response. */
|
|
683
|
+
FORM = "FORM",
|
|
684
|
+
/** Include `invoice` in the response. */
|
|
685
|
+
INVOICE = "INVOICE"
|
|
686
|
+
}
|
|
687
|
+
export declare enum OrderTag {
|
|
688
|
+
/** Return only confirmed orders. */
|
|
689
|
+
CONFIRMED = "CONFIRMED",
|
|
690
|
+
/** Return only unconfirmed orders. */
|
|
691
|
+
UNCONFIRMED = "UNCONFIRMED",
|
|
692
|
+
/** Return only member orders. */
|
|
693
|
+
MEMBER = "MEMBER",
|
|
694
|
+
/** Return only archived orders. */
|
|
695
|
+
ARCHIVED = "ARCHIVED",
|
|
696
|
+
/** Return only non archived orders. */
|
|
697
|
+
NON_ARCHIVED = "NON_ARCHIVED",
|
|
698
|
+
/** Return only orders with all guests checked-in. */
|
|
699
|
+
FULLY_CHECKED_IN = "FULLY_CHECKED_IN",
|
|
700
|
+
/** Return only orders with no guests checked-in. */
|
|
701
|
+
NOT_FULLY_CHECKED_IN = "NOT_FULLY_CHECKED_IN"
|
|
702
|
+
}
|
|
703
|
+
export interface ListOrdersResponse {
|
|
704
|
+
/** Total orders matching the given filters. */
|
|
705
|
+
total?: number;
|
|
706
|
+
/** Offset. */
|
|
707
|
+
offset?: number;
|
|
708
|
+
/** Limit. */
|
|
709
|
+
limit?: number;
|
|
710
|
+
/** Orders. */
|
|
711
|
+
orders?: Order[];
|
|
712
|
+
/** Filter facets. */
|
|
713
|
+
facets?: Record<string, FacetCounts>;
|
|
714
|
+
/** Order data enriched facets. */
|
|
715
|
+
orderFacets?: OrderFacets;
|
|
716
|
+
}
|
|
717
|
+
export interface FacetCounts {
|
|
718
|
+
/** Facet counts aggregated per value. */
|
|
719
|
+
counts?: Record<string, number>;
|
|
720
|
+
}
|
|
721
|
+
export interface OrderFacets {
|
|
722
|
+
/** Filter facets. */
|
|
723
|
+
facets?: Record<string, OrderFacetCounts>;
|
|
724
|
+
}
|
|
725
|
+
export interface OrderFacetCounts {
|
|
726
|
+
/** Facet counts aggregated per value */
|
|
727
|
+
counts?: Record<string, Counts>;
|
|
728
|
+
}
|
|
729
|
+
export interface Counts {
|
|
730
|
+
/** Number or orders */
|
|
731
|
+
count?: number;
|
|
732
|
+
/** Number of tickets within orders */
|
|
733
|
+
tickets?: number;
|
|
734
|
+
/** Number of tickets with check-in */
|
|
735
|
+
ticketsCheckIn?: number;
|
|
736
|
+
}
|
|
737
|
+
export interface GetOrderRequest {
|
|
738
|
+
/** Event ID to which the order belongs. */
|
|
739
|
+
eventId: string;
|
|
740
|
+
/** Unique order number. */
|
|
741
|
+
orderNumber: string;
|
|
742
|
+
/**
|
|
743
|
+
* Predefined sets of fields to return.
|
|
744
|
+
* - `TICKETS`: Returns `tickets`.
|
|
745
|
+
* - `DETAILS`: Returns `reservationId`, `snapshotId`, `created`, `firstName`, `lastName`, `confirmed`, `status`, `method`, `ticketsQuantity`, `totalPrice`, `ticketsPdf`, `archived`, `fullName`.
|
|
746
|
+
* - `FORM` : Returns `checkoutForm`.
|
|
747
|
+
* - `INVOICE`: Returns `invoice`.
|
|
748
|
+
*
|
|
749
|
+
* Default: If `fieldset` is not included in the request, `orderNumber`, `eventId`, `contactId`, `memberId`, `anonymized`, `fullyCheckedIn` are returned.
|
|
750
|
+
*
|
|
751
|
+
*/
|
|
752
|
+
fieldset?: OrderFieldset[];
|
|
753
|
+
}
|
|
754
|
+
export interface GetOrderResponse {
|
|
755
|
+
/** Requested order. */
|
|
756
|
+
order?: Order;
|
|
757
|
+
/** "Add to calendar" links. */
|
|
758
|
+
calendarLinks?: CalendarLinks;
|
|
759
|
+
}
|
|
760
|
+
export interface CalendarLinks {
|
|
761
|
+
/** "Add to Google calendar" URL. */
|
|
762
|
+
google?: string;
|
|
763
|
+
/** "Download ICS calendar file" URL. */
|
|
764
|
+
ics?: string;
|
|
765
|
+
}
|
|
766
|
+
export interface UpdateOrderRequest {
|
|
767
|
+
/** Event ID to which the order belongs. */
|
|
768
|
+
eventId: string;
|
|
769
|
+
/** Unique order number. */
|
|
770
|
+
orderNumber: string;
|
|
771
|
+
/** Set of field paths to update. */
|
|
772
|
+
fields?: string[];
|
|
773
|
+
/** Checkout form. */
|
|
774
|
+
checkoutForm?: FormResponse;
|
|
775
|
+
/** Whether order is archived. */
|
|
776
|
+
archived?: boolean;
|
|
777
|
+
}
|
|
778
|
+
export interface UpdateOrderResponse {
|
|
779
|
+
/** Updated order. */
|
|
780
|
+
order?: Order;
|
|
781
|
+
}
|
|
782
|
+
export interface OrderUpdated {
|
|
783
|
+
/** Order updated timestamp in ISO UTC format. */
|
|
784
|
+
timestamp?: Date | null;
|
|
785
|
+
/** Site language when Order initiated */
|
|
786
|
+
language?: string | null;
|
|
787
|
+
/** Locale in which Order was created. */
|
|
788
|
+
locale?: string | null;
|
|
789
|
+
/** Event ID to which the order belongs. */
|
|
790
|
+
eventId?: string;
|
|
791
|
+
/** Unique order number. */
|
|
792
|
+
orderNumber?: string;
|
|
793
|
+
/** Contact ID associated with this order. */
|
|
794
|
+
contactId?: string;
|
|
795
|
+
/** Member ID associated with this order. */
|
|
796
|
+
memberId?: string | null;
|
|
797
|
+
/**
|
|
798
|
+
* Order created timestamp.
|
|
799
|
+
* @readonly
|
|
800
|
+
*/
|
|
801
|
+
created?: Date | null;
|
|
802
|
+
/**
|
|
803
|
+
* Order updated timestamp.
|
|
804
|
+
* @readonly
|
|
805
|
+
*/
|
|
806
|
+
updated?: Date | null;
|
|
807
|
+
/** Buyer first name. */
|
|
808
|
+
firstName?: string;
|
|
809
|
+
/** Buyer last name. */
|
|
810
|
+
lastName?: string;
|
|
811
|
+
/** Buyer email. */
|
|
812
|
+
email?: string;
|
|
813
|
+
/** Checkout form response. */
|
|
814
|
+
checkoutForm?: FormResponse;
|
|
815
|
+
/** Whether order is confirmed - occurs once payment gateway processes the payment and funds reach merchant's account. */
|
|
816
|
+
confirmed?: boolean;
|
|
817
|
+
/**
|
|
818
|
+
* Order status. Possible values:
|
|
819
|
+
* - `FREE`: The order is confirmed, no payment is required.
|
|
820
|
+
* - `PENDING`: The order was paid, but the payment gateway suspended the payment.
|
|
821
|
+
* - `PAID`: The order is paid.
|
|
822
|
+
* - `OFFLINE_PENDING`: The order is confirmed but has to be paid in cash and the status is manually updated to `PAID`.
|
|
823
|
+
* - `INITIATED`: The order is awaiting for payment.
|
|
824
|
+
* - `CANCELED`: The order is canceled.
|
|
825
|
+
* - `DECLINED`: The order is payment is declined.
|
|
826
|
+
*/
|
|
827
|
+
status?: OrderStatus;
|
|
828
|
+
/** Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc. */
|
|
829
|
+
method?: string | null;
|
|
830
|
+
/** Tickets generated after payment. */
|
|
831
|
+
tickets?: Ticket[];
|
|
832
|
+
/** Whether order was archived and excluded from results. */
|
|
833
|
+
archived?: boolean;
|
|
834
|
+
/** Whether event was triggered by GDPR delete request. */
|
|
835
|
+
triggeredByAnonymizeRequest?: boolean;
|
|
836
|
+
}
|
|
837
|
+
export interface BulkUpdateOrdersRequest {
|
|
838
|
+
/** Event ID to which the order belongs. */
|
|
839
|
+
eventId: string;
|
|
840
|
+
orderNumber?: string[];
|
|
841
|
+
/** Set of fields to update. */
|
|
842
|
+
fields?: string[];
|
|
843
|
+
/** Whether to archive the order. */
|
|
844
|
+
archived?: boolean;
|
|
845
|
+
}
|
|
846
|
+
export interface BulkUpdateOrdersResponse {
|
|
847
|
+
/** Updated orders. */
|
|
848
|
+
orders?: Order[];
|
|
849
|
+
}
|
|
850
|
+
export interface ConfirmOrderRequest {
|
|
851
|
+
/** Event ID to which the order belongs. */
|
|
852
|
+
eventId: string;
|
|
853
|
+
/** Order numbers. */
|
|
854
|
+
orderNumber?: string[];
|
|
855
|
+
}
|
|
856
|
+
export interface ConfirmOrderResponse {
|
|
857
|
+
/** Confirmed orders. */
|
|
858
|
+
orders?: Order[];
|
|
859
|
+
}
|
|
860
|
+
export interface GetSummaryRequest {
|
|
861
|
+
/** Event ID. */
|
|
862
|
+
eventId?: string | null;
|
|
863
|
+
}
|
|
864
|
+
export interface GetSummaryResponse {
|
|
865
|
+
/** Ticket sales grouped by currency. */
|
|
866
|
+
sales?: TicketSales[];
|
|
867
|
+
}
|
|
868
|
+
export interface TicketSales {
|
|
869
|
+
/** Total balance of confirmed transactions. */
|
|
870
|
+
total?: Money;
|
|
871
|
+
/** Total number of confirmed orders. */
|
|
872
|
+
totalOrders?: number;
|
|
873
|
+
/** Total number of tickets purchased. */
|
|
874
|
+
totalTickets?: number;
|
|
875
|
+
/** Total revenue, excluding fees (taxes and payment provider fees are not deducted). */
|
|
876
|
+
revenue?: Money;
|
|
877
|
+
}
|
|
878
|
+
export interface GetInvoicePreviewRequest {
|
|
879
|
+
/** Event ID to which the invoice belongs. */
|
|
880
|
+
eventId?: string;
|
|
881
|
+
/** Order number. */
|
|
882
|
+
orderNumber?: string;
|
|
883
|
+
}
|
|
884
|
+
export interface RawHttpResponse {
|
|
885
|
+
body?: Uint8Array;
|
|
886
|
+
statusCode?: number | null;
|
|
887
|
+
headers?: HeadersEntry[];
|
|
888
|
+
}
|
|
889
|
+
export interface HeadersEntry {
|
|
890
|
+
key?: string;
|
|
891
|
+
value?: string;
|
|
892
|
+
}
|
|
893
|
+
export interface GetPaymentInfoRequest {
|
|
894
|
+
/** Event ID. */
|
|
895
|
+
eventId?: string;
|
|
896
|
+
/** Order number. */
|
|
897
|
+
orderNumber?: string;
|
|
898
|
+
}
|
|
899
|
+
export interface GetPaymentInfoResponse {
|
|
900
|
+
transactions?: PaymentTransactionSummary[];
|
|
901
|
+
status?: string | null;
|
|
902
|
+
/** @readonly */
|
|
903
|
+
transactionId?: string | null;
|
|
904
|
+
}
|
|
905
|
+
export interface PaymentTransactionSummary {
|
|
906
|
+
/**
|
|
907
|
+
* Wix Payments transaction id
|
|
908
|
+
* @readonly
|
|
909
|
+
*/
|
|
910
|
+
transactionId?: string;
|
|
911
|
+
/**
|
|
912
|
+
* Final transaction status
|
|
913
|
+
* @readonly
|
|
914
|
+
*/
|
|
915
|
+
finalTransactionStatus?: string;
|
|
916
|
+
/** Transaction events */
|
|
917
|
+
events?: PaymentTransactionEvent[];
|
|
918
|
+
}
|
|
919
|
+
export interface PaymentTransactionEvent {
|
|
920
|
+
/**
|
|
921
|
+
* Order snapshot id
|
|
922
|
+
* @readonly
|
|
923
|
+
*/
|
|
924
|
+
snapshotId?: string;
|
|
925
|
+
/**
|
|
926
|
+
* Transaction status
|
|
927
|
+
* @readonly
|
|
928
|
+
*/
|
|
929
|
+
transactionStatus?: string;
|
|
930
|
+
/**
|
|
931
|
+
* Transaction Payment method e.g., "payPal", "creditCard", etc.
|
|
932
|
+
* @readonly
|
|
933
|
+
*/
|
|
934
|
+
paymentMethod?: string;
|
|
935
|
+
/**
|
|
936
|
+
* Transaction payment amount
|
|
937
|
+
* @readonly
|
|
938
|
+
*/
|
|
939
|
+
paymentAmount?: Money;
|
|
940
|
+
/**
|
|
941
|
+
* Crated date
|
|
942
|
+
* @readonly
|
|
943
|
+
*/
|
|
944
|
+
_createdDate?: Date | null;
|
|
945
|
+
/**
|
|
946
|
+
* Reason code
|
|
947
|
+
* @readonly
|
|
948
|
+
*/
|
|
949
|
+
reasonCode?: string | null;
|
|
950
|
+
/**
|
|
951
|
+
* Refunded amount
|
|
952
|
+
* @readonly
|
|
953
|
+
*/
|
|
954
|
+
refundedAmount?: Money;
|
|
955
|
+
}
|
|
956
|
+
export interface CaptureAuthorizedPaymentRequest {
|
|
957
|
+
/** Event ID. */
|
|
958
|
+
eventId?: string;
|
|
959
|
+
/** Order number. */
|
|
960
|
+
orderNumber: string;
|
|
961
|
+
}
|
|
962
|
+
export interface CaptureAuthorizedPaymentResponse {
|
|
963
|
+
}
|
|
964
|
+
export interface VoidAuthorizedPaymentRequest {
|
|
965
|
+
/** Event ID. */
|
|
966
|
+
eventId?: string;
|
|
967
|
+
/** Order number. */
|
|
968
|
+
orderNumber: string;
|
|
969
|
+
}
|
|
970
|
+
export interface VoidAuthorizedPaymentResponse {
|
|
971
|
+
}
|
|
972
|
+
export interface MessageEnvelope {
|
|
973
|
+
/** App instance ID. */
|
|
974
|
+
instanceId?: string | null;
|
|
975
|
+
/** Event type. */
|
|
976
|
+
eventType?: string;
|
|
977
|
+
/** The identification type and identity data. */
|
|
978
|
+
identity?: IdentificationData;
|
|
979
|
+
/** Stringify payload. */
|
|
980
|
+
data?: string;
|
|
981
|
+
}
|
|
982
|
+
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
983
|
+
/** ID of a site visitor that has not logged in to the site. */
|
|
984
|
+
anonymousVisitorId?: string;
|
|
985
|
+
/** ID of a site visitor that has logged in to the site. */
|
|
986
|
+
memberId?: string;
|
|
987
|
+
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
988
|
+
wixUserId?: string;
|
|
989
|
+
/** ID of an app. */
|
|
990
|
+
appId?: string;
|
|
991
|
+
/** @readonly */
|
|
992
|
+
identityType?: WebhookIdentityType;
|
|
993
|
+
}
|
|
994
|
+
/** @oneof */
|
|
995
|
+
export interface IdentificationDataIdOneOf {
|
|
996
|
+
/** ID of a site visitor that has not logged in to the site. */
|
|
997
|
+
anonymousVisitorId?: string;
|
|
998
|
+
/** ID of a site visitor that has logged in to the site. */
|
|
999
|
+
memberId?: string;
|
|
1000
|
+
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
1001
|
+
wixUserId?: string;
|
|
1002
|
+
/** ID of an app. */
|
|
1003
|
+
appId?: string;
|
|
1004
|
+
}
|
|
1005
|
+
export declare enum WebhookIdentityType {
|
|
1006
|
+
UNKNOWN = "UNKNOWN",
|
|
1007
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1008
|
+
MEMBER = "MEMBER",
|
|
1009
|
+
WIX_USER = "WIX_USER",
|
|
1010
|
+
APP = "APP"
|
|
1011
|
+
}
|
|
1012
|
+
export interface OrderConfirmed {
|
|
1013
|
+
/** Order confirmation timestamp in ISO UTC. */
|
|
1014
|
+
timestamp?: Date | null;
|
|
1015
|
+
/** Site language when Order initiated */
|
|
1016
|
+
language?: string | null;
|
|
1017
|
+
/** Notifications silenced for this domain event. */
|
|
1018
|
+
silent?: boolean | null;
|
|
1019
|
+
/** Locale in which Order was created. */
|
|
1020
|
+
locale?: string | null;
|
|
1021
|
+
/** Event ID to which the order belongs. */
|
|
1022
|
+
eventId?: string;
|
|
1023
|
+
/** Unique order number. */
|
|
1024
|
+
orderNumber?: string;
|
|
1025
|
+
/** Contact ID associated with this order. */
|
|
1026
|
+
contactId?: string;
|
|
1027
|
+
/** Member ID associated with this order. */
|
|
1028
|
+
memberId?: string | null;
|
|
1029
|
+
/**
|
|
1030
|
+
* Order created timestamp
|
|
1031
|
+
* @readonly
|
|
1032
|
+
*/
|
|
1033
|
+
created?: Date | null;
|
|
1034
|
+
/** Buyer first name. */
|
|
1035
|
+
firstName?: string;
|
|
1036
|
+
/** Buyer last name. */
|
|
1037
|
+
lastName?: string;
|
|
1038
|
+
/** Buyer email address. */
|
|
1039
|
+
email?: string;
|
|
1040
|
+
/** Checkout form response. */
|
|
1041
|
+
checkoutForm?: FormResponse;
|
|
1042
|
+
/**
|
|
1043
|
+
* Order status. Possible values:
|
|
1044
|
+
* - `FREE`: The order is confirmed, no payment is required.
|
|
1045
|
+
* - `PENDING`: The order was paid, but the payment gateway suspended the payment.
|
|
1046
|
+
* - `PAID`: The order is paid.
|
|
1047
|
+
* - `OFFLINE_PENDING`: The order is confirmed but has to be paid in cash and the status is manually updated to `PAID`.
|
|
1048
|
+
* - `INITIATED`: The order is awaiting for payment.
|
|
1049
|
+
* - `CANCELED`: The order is canceled.
|
|
1050
|
+
* - `DECLINED`: The order is payment is declined.
|
|
1051
|
+
*/
|
|
1052
|
+
status?: OrderStatus;
|
|
1053
|
+
/** Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc. */
|
|
1054
|
+
method?: string | null;
|
|
1055
|
+
/** Tickets (generated after payment). */
|
|
1056
|
+
tickets?: Ticket[];
|
|
1057
|
+
/** Invoice. */
|
|
1058
|
+
invoice?: Invoice;
|
|
1059
|
+
/** Reservation ID associated with this order. */
|
|
1060
|
+
reservationId?: string;
|
|
1061
|
+
}
|
|
1062
|
+
export interface OrderPaid {
|
|
1063
|
+
/** Order paid timestamp in ISO UTC. */
|
|
1064
|
+
timestamp?: Date | null;
|
|
1065
|
+
/** Site language when Order initiated */
|
|
1066
|
+
language?: string | null;
|
|
1067
|
+
/** Notifications silenced for this domain event. */
|
|
1068
|
+
silent?: boolean | null;
|
|
1069
|
+
/** Locale in which Order was created. */
|
|
1070
|
+
locale?: string | null;
|
|
1071
|
+
/** Event ID to which the order belongs. */
|
|
1072
|
+
eventId?: string;
|
|
1073
|
+
/** Unique order number. */
|
|
1074
|
+
orderNumber?: string;
|
|
1075
|
+
/** Reservation ID associated with this order. */
|
|
1076
|
+
reservationId?: string;
|
|
1077
|
+
/** Contact ID associated with this order. */
|
|
1078
|
+
contactId?: string;
|
|
1079
|
+
/** Member ID associated with this order. */
|
|
1080
|
+
memberId?: string | null;
|
|
1081
|
+
/**
|
|
1082
|
+
* Order created timestamp
|
|
1083
|
+
* @readonly
|
|
1084
|
+
*/
|
|
1085
|
+
created?: Date | null;
|
|
1086
|
+
/** Buyer first name. */
|
|
1087
|
+
firstName?: string;
|
|
1088
|
+
/** Buyer last name. */
|
|
1089
|
+
lastName?: string;
|
|
1090
|
+
/** Buyer email address. */
|
|
1091
|
+
email?: string;
|
|
1092
|
+
/** Checkout form response. */
|
|
1093
|
+
checkoutForm?: FormResponse;
|
|
1094
|
+
/** Order status. */
|
|
1095
|
+
status?: OrderStatus;
|
|
1096
|
+
/** Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc. */
|
|
1097
|
+
method?: string | null;
|
|
1098
|
+
/** Tickets (generated after payment). */
|
|
1099
|
+
tickets?: Ticket[];
|
|
1100
|
+
/** Invoice. */
|
|
1101
|
+
invoice?: Invoice;
|
|
1102
|
+
}
|
|
1103
|
+
export interface ReservationCreated {
|
|
1104
|
+
/** Reservation created timestamp in ISO UTC format. */
|
|
1105
|
+
timestamp?: Date | null;
|
|
1106
|
+
/** Event ID to which the reservation belongs. */
|
|
1107
|
+
eventId?: string;
|
|
1108
|
+
/**
|
|
1109
|
+
* Reservation ID.
|
|
1110
|
+
* Can be used to retrieve a reservation invoice.
|
|
1111
|
+
*/
|
|
1112
|
+
reservationId?: string;
|
|
1113
|
+
/** Reservation expiration timestamp. */
|
|
1114
|
+
expires?: Date | null;
|
|
1115
|
+
/** Reservation status. */
|
|
1116
|
+
status?: ReservationStatus;
|
|
1117
|
+
/** Reservation ticket quantities. */
|
|
1118
|
+
quantities?: TicketQuantity[];
|
|
1119
|
+
/** Reservation update timestamp. */
|
|
1120
|
+
_updatedDate?: Date | null;
|
|
1121
|
+
/** Reservation counts. */
|
|
1122
|
+
counts?: ReservationCount[];
|
|
1123
|
+
}
|
|
1124
|
+
export declare enum ReservationStatus {
|
|
1125
|
+
/** The Reservation is pending confirmation and will expire after the expiration due time. */
|
|
1126
|
+
RESERVATION_PENDING = "RESERVATION_PENDING",
|
|
1127
|
+
/** The reservation is confirmed and will not expire. */
|
|
1128
|
+
RESERVATION_CONFIRMED = "RESERVATION_CONFIRMED",
|
|
1129
|
+
/** The reservation is canceled because of non payment. */
|
|
1130
|
+
RESERVATION_CANCELED = "RESERVATION_CANCELED",
|
|
1131
|
+
/** The reservation is canceled manually by the buyer. */
|
|
1132
|
+
RESERVATION_CANCELED_MANUALLY = "RESERVATION_CANCELED_MANUALLY",
|
|
1133
|
+
/** The reservation is expired. */
|
|
1134
|
+
RESERVATION_EXPIRED = "RESERVATION_EXPIRED"
|
|
1135
|
+
}
|
|
1136
|
+
export interface TicketQuantity {
|
|
1137
|
+
/** Ticket definition ID. */
|
|
1138
|
+
ticketDefinitionId?: string | null;
|
|
1139
|
+
/** Quantity. */
|
|
1140
|
+
quantity?: number | null;
|
|
1141
|
+
/** Quantity update timestamp. */
|
|
1142
|
+
_updatedDate?: Date | null;
|
|
1143
|
+
}
|
|
1144
|
+
export interface ReservationCount {
|
|
1145
|
+
/** Reservation Count snapshot timestamp. */
|
|
1146
|
+
timestamp?: Date | null;
|
|
1147
|
+
/** Ticket Definition ID. */
|
|
1148
|
+
ticketDefinitionId?: string;
|
|
1149
|
+
/** Confirmed reservation count. */
|
|
1150
|
+
confirmedCount?: number;
|
|
1151
|
+
/** Pending reservation count. */
|
|
1152
|
+
pendingCount?: number;
|
|
1153
|
+
/** True if paid ticket reservation exist. */
|
|
1154
|
+
paidExists?: boolean;
|
|
1155
|
+
}
|
|
1156
|
+
export interface ReservationUpdated {
|
|
1157
|
+
/** Reservation updated timestamp. */
|
|
1158
|
+
timestamp?: Date | null;
|
|
1159
|
+
/** Event ID to which the reservation belongs. */
|
|
1160
|
+
eventId?: string;
|
|
1161
|
+
/**
|
|
1162
|
+
* Reservation ID.
|
|
1163
|
+
* Can be used to retrieve a reservation invoice.
|
|
1164
|
+
*/
|
|
1165
|
+
reservationId?: string;
|
|
1166
|
+
/** Reservation status. */
|
|
1167
|
+
status?: ReservationStatus;
|
|
1168
|
+
/** Reservation expiration timestamp. */
|
|
1169
|
+
expires?: Date | null;
|
|
1170
|
+
/** Reservation ticket quantities. */
|
|
1171
|
+
quantities?: TicketQuantity[];
|
|
1172
|
+
/** Reservation update timestamp. */
|
|
1173
|
+
_updatedDate?: Date | null;
|
|
1174
|
+
/** Reservation counts. */
|
|
1175
|
+
counts?: ReservationCount[];
|
|
1176
|
+
}
|
|
1177
|
+
export interface GetCheckoutOptionsRequest {
|
|
1178
|
+
}
|
|
1179
|
+
export interface GetCheckoutOptionsResponse {
|
|
1180
|
+
/** Whether any payment method is configured and available for payment. */
|
|
1181
|
+
paymentMethodConfigured?: boolean;
|
|
1182
|
+
/** Whether coupons are accepted at checkout. */
|
|
1183
|
+
acceptCoupons?: boolean;
|
|
1184
|
+
/** Whether premium services are enabled. Enabled for free if site does not sell any paid tickets. Selling tickets for a fee requires a premium feature "events_sell_tickets". */
|
|
1185
|
+
premiumServices?: boolean;
|
|
1186
|
+
/** Whether there are any paid tickets available for sale. */
|
|
1187
|
+
paidTickets?: boolean;
|
|
1188
|
+
/** Whether gift cards are accepted at checkout. */
|
|
1189
|
+
acceptGiftCards?: boolean;
|
|
1190
|
+
}
|
|
1191
|
+
export interface ListAvailableTicketsRequest {
|
|
1192
|
+
/** Event ID. If not provided, available tickets for all events in the site will be returned. */
|
|
1193
|
+
eventId?: string;
|
|
1194
|
+
/** Offset. */
|
|
1195
|
+
offset?: number;
|
|
1196
|
+
/** Limit. */
|
|
1197
|
+
limit?: number;
|
|
1198
|
+
/**
|
|
1199
|
+
* Sort order.
|
|
1200
|
+
* Default: `created:asc`.
|
|
1201
|
+
*/
|
|
1202
|
+
sort?: string;
|
|
1203
|
+
state?: State[];
|
|
1204
|
+
}
|
|
1205
|
+
export declare enum State {
|
|
1206
|
+
INCLUDE_HIDDEN_NOT_ON_SALE = "INCLUDE_HIDDEN_NOT_ON_SALE"
|
|
1207
|
+
}
|
|
1208
|
+
export interface ListAvailableTicketsResponse {
|
|
1209
|
+
/** Ticket definitions meta data. */
|
|
1210
|
+
metaData?: ResponseMetaData;
|
|
1211
|
+
/** Ticket definitions. */
|
|
1212
|
+
definitions?: TicketDefinition[];
|
|
1213
|
+
}
|
|
1214
|
+
export interface ResponseMetaData {
|
|
1215
|
+
/** Number of items in the response. */
|
|
1216
|
+
count?: number;
|
|
1217
|
+
/** Offset of items. */
|
|
1218
|
+
offset?: number;
|
|
1219
|
+
/** Total number of matching items. */
|
|
1220
|
+
total?: number;
|
|
1221
|
+
}
|
|
1222
|
+
export interface TicketDefinition {
|
|
1223
|
+
/** Ticket definition ID. */
|
|
1224
|
+
_id?: string;
|
|
1225
|
+
/** Ticket price. */
|
|
1226
|
+
price?: Money;
|
|
1227
|
+
/** Whether the ticket is free (read only). */
|
|
1228
|
+
free?: boolean;
|
|
1229
|
+
/** Ticket name. */
|
|
1230
|
+
name?: string;
|
|
1231
|
+
/** Ticket description. */
|
|
1232
|
+
description?: string;
|
|
1233
|
+
/** Limit of tickets that can be purchased per checkout. If tickets are unlimited in the definition, the limit per checkout is 20 tickets. */
|
|
1234
|
+
limitPerCheckout?: number;
|
|
1235
|
+
/** Custom sort index. */
|
|
1236
|
+
orderIndex?: number;
|
|
1237
|
+
/** Event and ticket policies. */
|
|
1238
|
+
policy?: string;
|
|
1239
|
+
/** Sensitive dashboard data. */
|
|
1240
|
+
dashboard?: Dashboard;
|
|
1241
|
+
/** Event ID associated with the ticket. */
|
|
1242
|
+
eventId?: string;
|
|
1243
|
+
/**
|
|
1244
|
+
* Configuration of the fixed-rate Wix service fee that is applied at checkout to each ticket sold.
|
|
1245
|
+
* @readonly
|
|
1246
|
+
*/
|
|
1247
|
+
wixFeeConfig?: WixFeeConfig;
|
|
1248
|
+
/** Ticket sale period. */
|
|
1249
|
+
salePeriod?: TicketSalePeriod;
|
|
1250
|
+
/**
|
|
1251
|
+
* Ticket sale status.
|
|
1252
|
+
* @readonly
|
|
1253
|
+
*/
|
|
1254
|
+
saleStatus?: TicketSaleStatus;
|
|
1255
|
+
/** Ticket state. */
|
|
1256
|
+
state?: State[];
|
|
1257
|
+
/** Ticket pricing. */
|
|
1258
|
+
pricing?: TicketPricing;
|
|
1259
|
+
}
|
|
1260
|
+
export interface Dashboard {
|
|
1261
|
+
/** Whether ticket is hidden and cannot be sold. */
|
|
1262
|
+
hidden?: boolean;
|
|
1263
|
+
/**
|
|
1264
|
+
* Number of tickets sold and reserved.
|
|
1265
|
+
* @deprecated
|
|
1266
|
+
*/
|
|
1267
|
+
sold?: number;
|
|
1268
|
+
/** Whether the ticket has limited quantity. */
|
|
1269
|
+
limited?: boolean;
|
|
1270
|
+
/** Ticket limit. `NULL` if the tickets are unlimited. */
|
|
1271
|
+
quantity?: number | null;
|
|
1272
|
+
/** Number of unsold tickets. `NULL` if the tickets are unlimited. */
|
|
1273
|
+
unsold?: number | null;
|
|
1274
|
+
/** Number of tickets sold. */
|
|
1275
|
+
ticketsSold?: number;
|
|
1276
|
+
/** Number of tickets reserved. */
|
|
1277
|
+
ticketsReserved?: number;
|
|
1278
|
+
}
|
|
1279
|
+
export interface WixFeeConfig {
|
|
1280
|
+
/** Fee calculation method. */
|
|
1281
|
+
type?: FeeType;
|
|
1282
|
+
}
|
|
1283
|
+
export interface TicketSalePeriod {
|
|
1284
|
+
/** Ticket sale start timestamp. */
|
|
1285
|
+
startDate?: Date | null;
|
|
1286
|
+
/** Ticket sale end timestamp. */
|
|
1287
|
+
endDate?: Date | null;
|
|
1288
|
+
/** Whether to hide this ticket if it's not on sale */
|
|
1289
|
+
hideNotOnSale?: boolean;
|
|
1290
|
+
}
|
|
1291
|
+
export declare enum TicketSaleStatus {
|
|
1292
|
+
/** Ticket sale is scheduled to start. */
|
|
1293
|
+
SALE_SCHEDULED = "SALE_SCHEDULED",
|
|
1294
|
+
/** Ticket sale has started. */
|
|
1295
|
+
SALE_STARTED = "SALE_STARTED",
|
|
1296
|
+
/** Ticket sale has ended. */
|
|
1297
|
+
SALE_ENDED = "SALE_ENDED"
|
|
1298
|
+
}
|
|
1299
|
+
export interface TicketPricing extends TicketPricingPriceOneOf {
|
|
1300
|
+
/** Ticket price which is read only. */
|
|
1301
|
+
fixedPrice?: Money;
|
|
1302
|
+
/** Min price per ticket, customizable. */
|
|
1303
|
+
minPrice?: Money;
|
|
1304
|
+
/** Ticket pricing options. */
|
|
1305
|
+
pricingOptions?: PricingOptions;
|
|
1306
|
+
/**
|
|
1307
|
+
* Ticket pricing type.
|
|
1308
|
+
* @readonly
|
|
1309
|
+
*/
|
|
1310
|
+
pricingType?: Type;
|
|
1311
|
+
}
|
|
1312
|
+
/** @oneof */
|
|
1313
|
+
export interface TicketPricingPriceOneOf {
|
|
1314
|
+
/** Ticket price which is read only. */
|
|
1315
|
+
fixedPrice?: Money;
|
|
1316
|
+
/** Min price per ticket, customizable. */
|
|
1317
|
+
minPrice?: Money;
|
|
1318
|
+
/** Ticket pricing options. */
|
|
1319
|
+
pricingOptions?: PricingOptions;
|
|
1320
|
+
}
|
|
1321
|
+
export interface PricingOptions {
|
|
1322
|
+
/** Multiple ticket pricing options. */
|
|
1323
|
+
options?: PricingOption[];
|
|
1324
|
+
}
|
|
1325
|
+
export interface PricingOption {
|
|
1326
|
+
/** Ticket pricing option ID. */
|
|
1327
|
+
_id?: string | null;
|
|
1328
|
+
/** Ticket pricing option name. */
|
|
1329
|
+
name?: string | null;
|
|
1330
|
+
/** Ticket pricing option price. */
|
|
1331
|
+
price?: Money;
|
|
1332
|
+
}
|
|
1333
|
+
export declare enum Type {
|
|
1334
|
+
STANDARD = "STANDARD",
|
|
1335
|
+
DONATION = "DONATION"
|
|
1336
|
+
}
|
|
1337
|
+
export interface QueryAvailableTicketsRequest {
|
|
1338
|
+
/** Offset. */
|
|
1339
|
+
offset?: number;
|
|
1340
|
+
/** Limit. */
|
|
1341
|
+
limit?: number;
|
|
1342
|
+
/** Ticket definition. */
|
|
1343
|
+
filter?: Record<string, any> | null;
|
|
1344
|
+
fieldset?: TicketDefinitionFieldset[];
|
|
1345
|
+
/**
|
|
1346
|
+
* Sort order.
|
|
1347
|
+
* Default: `created:asc`.
|
|
1348
|
+
*/
|
|
1349
|
+
sort?: string;
|
|
1350
|
+
}
|
|
1351
|
+
export declare enum TicketDefinitionFieldset {
|
|
1352
|
+
/** Include `policy` in the response. */
|
|
1353
|
+
POLICY = "POLICY",
|
|
1354
|
+
/** Include `dashboard` in the response. */
|
|
1355
|
+
DASHBOARD = "DASHBOARD"
|
|
1356
|
+
}
|
|
1357
|
+
export interface QueryAvailableTicketsResponse {
|
|
1358
|
+
/** Ticket definitions meta data. */
|
|
1359
|
+
metaData?: ResponseMetaData;
|
|
1360
|
+
/** Ticket definitions. */
|
|
1361
|
+
definitions?: TicketDefinition[];
|
|
1362
|
+
}
|
|
1363
|
+
export interface CreateReservationRequest {
|
|
1364
|
+
/** Event ID to which the reservation belongs. */
|
|
1365
|
+
eventId: string;
|
|
1366
|
+
/** Tickets to reserve. */
|
|
1367
|
+
ticketQuantities?: TicketReservationQuantity[];
|
|
1368
|
+
/** Whether to ignore the available ticket limits upon reservation. */
|
|
1369
|
+
ignoreLimits?: boolean;
|
|
1370
|
+
/** Whether to allow reservation for hidden tickets. */
|
|
1371
|
+
allowHiddenTickets?: boolean;
|
|
1372
|
+
}
|
|
1373
|
+
export interface TicketReservationQuantity {
|
|
1374
|
+
/** Ticket definition ID. */
|
|
1375
|
+
ticketDefinitionId?: string;
|
|
1376
|
+
/** Quantity of tickets to reserve. */
|
|
1377
|
+
quantity?: number;
|
|
1378
|
+
/** Override the predefined ticket price. */
|
|
1379
|
+
priceOverride?: string | null;
|
|
1380
|
+
/** Optional ticket details */
|
|
1381
|
+
ticketDetails?: TicketDetails[];
|
|
1382
|
+
}
|
|
1383
|
+
export interface CreateReservationResponse {
|
|
1384
|
+
/** Reservation ID. */
|
|
1385
|
+
_id?: string;
|
|
1386
|
+
/** Reservation expiration timestamp. */
|
|
1387
|
+
expires?: Date | null;
|
|
1388
|
+
/** Ticket reservations. */
|
|
1389
|
+
reservations?: TicketReservation[];
|
|
1390
|
+
/** Reservation invoice. */
|
|
1391
|
+
invoice?: Invoice;
|
|
1392
|
+
/** Reservation status. */
|
|
1393
|
+
reservationStatus?: ReservationStatus;
|
|
1394
|
+
}
|
|
1395
|
+
export interface TicketReservation {
|
|
1396
|
+
/** Quantity of reserved tickets. */
|
|
1397
|
+
quantity?: number;
|
|
1398
|
+
/** An object containing ticket information. */
|
|
1399
|
+
ticket?: TicketDefinition;
|
|
1400
|
+
/** Optional ticket details. */
|
|
1401
|
+
ticketDetails?: TicketDetails[];
|
|
1402
|
+
}
|
|
1403
|
+
export interface CancelReservationRequest {
|
|
1404
|
+
/** Event ID to which the reservation belongs. */
|
|
1405
|
+
eventId: string;
|
|
1406
|
+
/** Reservation ID. */
|
|
1407
|
+
_id: string;
|
|
1408
|
+
}
|
|
1409
|
+
export interface CancelReservationResponse {
|
|
1410
|
+
}
|
|
1411
|
+
export interface GetInvoiceRequest {
|
|
1412
|
+
/** Event ID to which the invoice belongs. */
|
|
1413
|
+
eventId: string;
|
|
1414
|
+
/** Reservation ID. */
|
|
1415
|
+
reservationId: string;
|
|
1416
|
+
/** Optional discount to be applied on the returned invoice. */
|
|
1417
|
+
withDiscount?: DiscountRequest;
|
|
1418
|
+
/** Optional benefit granted by the pricing plan to be applied on the returned invoice. */
|
|
1419
|
+
paidPlanBenefit?: PaidPlanBenefit;
|
|
1420
|
+
}
|
|
1421
|
+
export interface DiscountRequest {
|
|
1422
|
+
/** Discount coupon code. */
|
|
1423
|
+
couponCode?: string;
|
|
1424
|
+
}
|
|
1425
|
+
export interface PaidPlanBenefit {
|
|
1426
|
+
/** Pricing plan ID. */
|
|
1427
|
+
planOrderId?: string;
|
|
1428
|
+
/** Pricing plan benefit ID. */
|
|
1429
|
+
benefitId?: string;
|
|
1430
|
+
}
|
|
1431
|
+
export interface GetInvoiceResponse {
|
|
1432
|
+
/** Invoice with applied discount. */
|
|
1433
|
+
invoice?: Invoice;
|
|
1434
|
+
/** Discount errors, if relevant. */
|
|
1435
|
+
discountErrors?: DiscountErrors;
|
|
1436
|
+
/** Reservation expiration time. */
|
|
1437
|
+
expires?: Date | null;
|
|
1438
|
+
/**
|
|
1439
|
+
* Reservation status. Possible values:
|
|
1440
|
+
* - `RESERVATION_PENDING`: The reservation is pending confirmation. It will expire after a certain amount of time.
|
|
1441
|
+
* - `RESERVATION_CONFIRMED`: The reservation is confirmed and will not expire.
|
|
1442
|
+
* - `RESERVATION_CANCELED`: The reservation is canceled because it's not paid.
|
|
1443
|
+
* - `RESERVATION_CANCELED_MANUALLY`: The reservation is canceled manually by the buyer.
|
|
1444
|
+
* - `RESERVATION_EXPIRED`: The reservation has expired.
|
|
1445
|
+
*/
|
|
1446
|
+
reservationStatus?: ReservationStatus;
|
|
1447
|
+
/** Whether this reservation is already used in checkout. */
|
|
1448
|
+
reservationOccupied?: boolean;
|
|
1449
|
+
/** Ticket reservations. */
|
|
1450
|
+
reservations?: TicketReservation[];
|
|
1451
|
+
}
|
|
1452
|
+
export interface DiscountErrors {
|
|
1453
|
+
/** Object containing error information. */
|
|
1454
|
+
error?: Error[];
|
|
1455
|
+
}
|
|
1456
|
+
export interface Error {
|
|
1457
|
+
/** A code identifying the error type. */
|
|
1458
|
+
code?: string;
|
|
1459
|
+
}
|
|
1460
|
+
export interface GiftCardErrors {
|
|
1461
|
+
/** Error. */
|
|
1462
|
+
error?: GiftCardErrorsError[];
|
|
1463
|
+
}
|
|
1464
|
+
export interface GiftCardErrorsError {
|
|
1465
|
+
code?: string;
|
|
1466
|
+
}
|
|
1467
|
+
export interface CheckoutRequest {
|
|
1468
|
+
/** Event ID to which the checkout belongs. */
|
|
1469
|
+
eventId: string;
|
|
1470
|
+
/** Ticket reservation ID. */
|
|
1471
|
+
reservationId?: string;
|
|
1472
|
+
/** Member ID (if empty - no site member is associated to this order). */
|
|
1473
|
+
memberId?: string;
|
|
1474
|
+
/** Discount to apply on the invoice. */
|
|
1475
|
+
discount?: DiscountRequest;
|
|
1476
|
+
/** Buyer details. */
|
|
1477
|
+
buyer?: Buyer;
|
|
1478
|
+
/** Guest details. */
|
|
1479
|
+
guests?: Guest[];
|
|
1480
|
+
/** Benefit granted by the pricing plan. */
|
|
1481
|
+
paidPlanBenefit?: PaidPlanBenefit;
|
|
1482
|
+
/** Options controlling the checkout process. */
|
|
1483
|
+
options?: CheckoutOptions;
|
|
1484
|
+
/** Whether marketing consent was given */
|
|
1485
|
+
marketingConsent?: boolean | null;
|
|
1486
|
+
}
|
|
1487
|
+
export interface Buyer {
|
|
1488
|
+
/** Buyer first name. */
|
|
1489
|
+
firstName?: string;
|
|
1490
|
+
/** Buyer last name. */
|
|
1491
|
+
lastName?: string;
|
|
1492
|
+
/** Buyer email. */
|
|
1493
|
+
email?: string;
|
|
1494
|
+
}
|
|
1495
|
+
export interface Guest {
|
|
1496
|
+
/** Specific guest info. */
|
|
1497
|
+
form?: FormResponse;
|
|
1498
|
+
}
|
|
1499
|
+
export interface CheckoutOptions {
|
|
1500
|
+
/** Whether to ignore settings to notify contacts or users. */
|
|
1501
|
+
silent?: boolean;
|
|
1502
|
+
/** 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. */
|
|
1503
|
+
payInPerson?: boolean;
|
|
1504
|
+
/** Whether to ignore form validation. */
|
|
1505
|
+
ignoreFormValidation?: boolean;
|
|
1506
|
+
/** Marks payment as already paid */
|
|
1507
|
+
markAsPaid?: boolean | null;
|
|
1508
|
+
}
|
|
1509
|
+
export interface CheckoutResponse {
|
|
1510
|
+
/** Created order. */
|
|
1511
|
+
order?: Order;
|
|
1512
|
+
/**
|
|
1513
|
+
* Order expiration time.
|
|
1514
|
+
* **Note:** Only applicable to orders with the `INITIATED` status.
|
|
1515
|
+
*/
|
|
1516
|
+
expires?: Date | null;
|
|
1517
|
+
/** Ticket reservations. */
|
|
1518
|
+
reservations?: TicketReservation[];
|
|
1519
|
+
/** Order page URL. */
|
|
1520
|
+
orderPageUrl?: string | null;
|
|
1521
|
+
}
|
|
1522
|
+
export interface OrderInitiated {
|
|
1523
|
+
/** Order initiated timestamp in ISO UTC format. */
|
|
1524
|
+
timestamp?: Date | null;
|
|
1525
|
+
/** Site language when Order initiated */
|
|
1526
|
+
language?: string | null;
|
|
1527
|
+
/** Locale in which Order was created. */
|
|
1528
|
+
locale?: string | null;
|
|
1529
|
+
/** Event ID to which the order belongs. */
|
|
1530
|
+
eventId?: string;
|
|
1531
|
+
/** Unique order number. */
|
|
1532
|
+
orderNumber?: string;
|
|
1533
|
+
/** Contact ID associated with this order. */
|
|
1534
|
+
contactId?: string;
|
|
1535
|
+
/** Member ID associated with this order. */
|
|
1536
|
+
memberId?: string | null;
|
|
1537
|
+
/**
|
|
1538
|
+
* Order created timestamp.
|
|
1539
|
+
* @readonly
|
|
1540
|
+
*/
|
|
1541
|
+
created?: Date | null;
|
|
1542
|
+
/**
|
|
1543
|
+
* Order updated timestamp.
|
|
1544
|
+
* @readonly
|
|
1545
|
+
*/
|
|
1546
|
+
updated?: Date | null;
|
|
1547
|
+
/** Guest first name. */
|
|
1548
|
+
firstName?: string;
|
|
1549
|
+
/** Guest last name. */
|
|
1550
|
+
lastName?: string;
|
|
1551
|
+
/** Guest email address. */
|
|
1552
|
+
email?: string;
|
|
1553
|
+
/** Checkout form response. */
|
|
1554
|
+
checkoutForm?: FormResponse;
|
|
1555
|
+
/**
|
|
1556
|
+
* Order status. Possible values:
|
|
1557
|
+
* - `FREE`: The order is confirmed, no payment is required.
|
|
1558
|
+
* - `PENDING`: The order was paid, but the payment gateway suspended the payment.
|
|
1559
|
+
* - `PAID`: The order is paid.
|
|
1560
|
+
* - `OFFLINE_PENDING`: The order is confirmed but has to be paid in cash and the status is manually updated to `PAID`.
|
|
1561
|
+
* - `INITIATED`: The order is awaiting for payment.
|
|
1562
|
+
* - `CANCELED`: The order is canceled.
|
|
1563
|
+
* - `DECLINED`: The order is payment is declined.
|
|
1564
|
+
*/
|
|
1565
|
+
status?: OrderStatus;
|
|
1566
|
+
/** Invoice. */
|
|
1567
|
+
invoice?: Invoice;
|
|
1568
|
+
/** Reservation ID associated with this order. */
|
|
1569
|
+
reservationId?: string;
|
|
1570
|
+
/** Order was marked as paid. */
|
|
1571
|
+
markedAsPaid?: boolean | null;
|
|
1572
|
+
}
|
|
1573
|
+
export interface UpdateCheckoutRequest {
|
|
1574
|
+
/** Event ID to which the checkout belongs. */
|
|
1575
|
+
eventId: string;
|
|
1576
|
+
/** Unique order number. */
|
|
1577
|
+
orderNumber: string;
|
|
1578
|
+
/** Buyer details. */
|
|
1579
|
+
buyer?: Buyer;
|
|
1580
|
+
/** Guest details. */
|
|
1581
|
+
guests?: Guest[];
|
|
1582
|
+
/** Member ID (if empty - no site member is associated to this order). */
|
|
1583
|
+
memberId?: string | null;
|
|
1584
|
+
/** Discount to apply on the invoice. */
|
|
1585
|
+
discount?: DiscountRequest;
|
|
1586
|
+
/** Benefit granted by the pricing plan. */
|
|
1587
|
+
paidPlanBenefit?: PaidPlanBenefit;
|
|
1588
|
+
}
|
|
1589
|
+
export interface UpdateCheckoutResponse {
|
|
1590
|
+
/** Updated order. */
|
|
1591
|
+
order?: Order;
|
|
1592
|
+
/** Order page URL. */
|
|
1593
|
+
orderPageUrl?: string | null;
|
|
1594
|
+
}
|
|
1595
|
+
export interface OrderPageUrls {
|
|
1596
|
+
/** Success order page URL. */
|
|
1597
|
+
success?: string | null;
|
|
1598
|
+
/** Pending order page URL. */
|
|
1599
|
+
pending?: string | null;
|
|
1600
|
+
/** Canceled order page URL. */
|
|
1601
|
+
canceled?: string | null;
|
|
1602
|
+
/** Error order page URL. */
|
|
1603
|
+
error?: string | null;
|
|
1604
|
+
}
|
|
1605
|
+
export interface PosCheckoutRequest {
|
|
1606
|
+
/** Event ID to which the checkout belongs. */
|
|
1607
|
+
eventId: string;
|
|
1608
|
+
/** Ticket reservation ID. */
|
|
1609
|
+
reservationId: string;
|
|
1610
|
+
/**
|
|
1611
|
+
* Payment details ID.
|
|
1612
|
+
* Not required if reservation total is 0. In this case the order will be created with status Free and no payment.
|
|
1613
|
+
*/
|
|
1614
|
+
paymentDetailsId?: string | null;
|
|
1615
|
+
}
|
|
1616
|
+
export interface PosCheckoutResponse {
|
|
1617
|
+
/** Created order. */
|
|
1618
|
+
order?: Order;
|
|
1619
|
+
/** Time when the order expires, applies to orders with status = INITIATED. */
|
|
1620
|
+
expires?: Date | null;
|
|
1621
|
+
/** Ticket reservations. */
|
|
1622
|
+
reservations?: TicketReservation[];
|
|
1623
|
+
}
|
|
1624
|
+
interface StreetAddressNonNullableFields {
|
|
1625
|
+
number: string;
|
|
1626
|
+
name: string;
|
|
1627
|
+
apt: string;
|
|
1628
|
+
}
|
|
1629
|
+
interface SubdivisionNonNullableFields {
|
|
1630
|
+
name: string;
|
|
1631
|
+
}
|
|
1632
|
+
interface AddressNonNullableFields {
|
|
1633
|
+
streetAddress?: StreetAddressNonNullableFields;
|
|
1634
|
+
subdivisions: SubdivisionNonNullableFields[];
|
|
1635
|
+
}
|
|
1636
|
+
interface FormattedAddressNonNullableFields {
|
|
1637
|
+
formatted: string;
|
|
1638
|
+
address?: AddressNonNullableFields;
|
|
1639
|
+
}
|
|
1640
|
+
interface InputValueNonNullableFields {
|
|
1641
|
+
inputName: string;
|
|
1642
|
+
value: string;
|
|
1643
|
+
values: string[];
|
|
1644
|
+
address?: FormattedAddressNonNullableFields;
|
|
1645
|
+
}
|
|
1646
|
+
interface FormResponseNonNullableFields {
|
|
1647
|
+
inputValues: InputValueNonNullableFields[];
|
|
1648
|
+
}
|
|
1649
|
+
interface MoneyNonNullableFields {
|
|
1650
|
+
amount: string;
|
|
1651
|
+
currency: string;
|
|
1652
|
+
}
|
|
1653
|
+
interface GuestDetailsNonNullableFields {
|
|
1654
|
+
guestAssigned: boolean;
|
|
1655
|
+
form?: FormResponseNonNullableFields;
|
|
1656
|
+
}
|
|
1657
|
+
interface TicketingTicketNonNullableFields {
|
|
1658
|
+
ticketNumber: string;
|
|
1659
|
+
orderNumber: string;
|
|
1660
|
+
ticketDefinitionId: string;
|
|
1661
|
+
name: string;
|
|
1662
|
+
price?: MoneyNonNullableFields;
|
|
1663
|
+
free: boolean;
|
|
1664
|
+
policy: string;
|
|
1665
|
+
qrCode: string;
|
|
1666
|
+
orderStatus: OrderStatus;
|
|
1667
|
+
orderArchived: boolean;
|
|
1668
|
+
orderFullName: string;
|
|
1669
|
+
guestDetails?: GuestDetailsNonNullableFields;
|
|
1670
|
+
archived: boolean;
|
|
1671
|
+
ticketPdf: string;
|
|
1672
|
+
anonymized: boolean;
|
|
1673
|
+
checkInUrl: string;
|
|
1674
|
+
ticketPdfUrl: string;
|
|
1675
|
+
channel: ChannelType;
|
|
1676
|
+
walletPassUrl: string;
|
|
1677
|
+
}
|
|
1678
|
+
interface CouponDiscountNonNullableFields {
|
|
1679
|
+
name: string;
|
|
1680
|
+
code: string;
|
|
1681
|
+
couponId: string;
|
|
1682
|
+
}
|
|
1683
|
+
interface PercentDiscountNonNullableFields {
|
|
1684
|
+
rate: string;
|
|
1685
|
+
quantityDiscounted: number;
|
|
1686
|
+
}
|
|
1687
|
+
interface PaidPlanDiscountNonNullableFields {
|
|
1688
|
+
percentDiscount?: PercentDiscountNonNullableFields;
|
|
1689
|
+
name: string;
|
|
1690
|
+
}
|
|
1691
|
+
interface DiscountItemNonNullableFields {
|
|
1692
|
+
coupon?: CouponDiscountNonNullableFields;
|
|
1693
|
+
paidPlan?: PaidPlanDiscountNonNullableFields;
|
|
1694
|
+
amount?: MoneyNonNullableFields;
|
|
1695
|
+
}
|
|
1696
|
+
interface DiscountNonNullableFields {
|
|
1697
|
+
amount?: MoneyNonNullableFields;
|
|
1698
|
+
afterDiscount?: MoneyNonNullableFields;
|
|
1699
|
+
code: string;
|
|
1700
|
+
name: string;
|
|
1701
|
+
couponId: string;
|
|
1702
|
+
discounts: DiscountItemNonNullableFields[];
|
|
1703
|
+
}
|
|
1704
|
+
interface TaxNonNullableFields {
|
|
1705
|
+
type: TaxType;
|
|
1706
|
+
name: string;
|
|
1707
|
+
rate: string;
|
|
1708
|
+
taxable?: MoneyNonNullableFields;
|
|
1709
|
+
amount?: MoneyNonNullableFields;
|
|
1710
|
+
}
|
|
1711
|
+
interface FeeNonNullableFields {
|
|
1712
|
+
name: FeeName;
|
|
1713
|
+
type: FeeType;
|
|
1714
|
+
rate: string;
|
|
1715
|
+
amount?: MoneyNonNullableFields;
|
|
1716
|
+
}
|
|
1717
|
+
interface ItemNonNullableFields {
|
|
1718
|
+
_id: string;
|
|
1719
|
+
quantity: number;
|
|
1720
|
+
name: string;
|
|
1721
|
+
price?: MoneyNonNullableFields;
|
|
1722
|
+
total?: MoneyNonNullableFields;
|
|
1723
|
+
discount?: DiscountNonNullableFields;
|
|
1724
|
+
tax?: TaxNonNullableFields;
|
|
1725
|
+
fees: FeeNonNullableFields[];
|
|
1726
|
+
}
|
|
1727
|
+
interface InvoiceNonNullableFields {
|
|
1728
|
+
items: ItemNonNullableFields[];
|
|
1729
|
+
total?: MoneyNonNullableFields;
|
|
1730
|
+
discount?: DiscountNonNullableFields;
|
|
1731
|
+
tax?: TaxNonNullableFields;
|
|
1732
|
+
subTotal?: MoneyNonNullableFields;
|
|
1733
|
+
grandTotal?: MoneyNonNullableFields;
|
|
1734
|
+
fees: FeeNonNullableFields[];
|
|
1735
|
+
revenue?: MoneyNonNullableFields;
|
|
1736
|
+
}
|
|
1737
|
+
interface PaymentTransactionNonNullableFields {
|
|
1738
|
+
transactionId: string;
|
|
1739
|
+
method: string;
|
|
1740
|
+
scheduledAction: ScheduledActionEnumAction;
|
|
1741
|
+
}
|
|
1742
|
+
interface PaymentDetailsNonNullableFields {
|
|
1743
|
+
transaction?: PaymentTransactionNonNullableFields;
|
|
1744
|
+
}
|
|
1745
|
+
interface GiftCardPaymentDetailsNonNullableFields {
|
|
1746
|
+
amount?: MoneyNonNullableFields;
|
|
1747
|
+
}
|
|
1748
|
+
interface BalanceSummaryNonNullableFields {
|
|
1749
|
+
balance?: MoneyNonNullableFields;
|
|
1750
|
+
}
|
|
1751
|
+
export interface OrderNonNullableFields {
|
|
1752
|
+
orderNumber: string;
|
|
1753
|
+
reservationId: string;
|
|
1754
|
+
snapshotId: string;
|
|
1755
|
+
eventId: string;
|
|
1756
|
+
contactId: string;
|
|
1757
|
+
memberId: string;
|
|
1758
|
+
firstName: string;
|
|
1759
|
+
lastName: string;
|
|
1760
|
+
email: string;
|
|
1761
|
+
checkoutForm?: FormResponseNonNullableFields;
|
|
1762
|
+
confirmed: boolean;
|
|
1763
|
+
status: OrderStatus;
|
|
1764
|
+
method: string;
|
|
1765
|
+
ticketsQuantity: number;
|
|
1766
|
+
totalPrice?: MoneyNonNullableFields;
|
|
1767
|
+
ticketsPdf: string;
|
|
1768
|
+
tickets: TicketingTicketNonNullableFields[];
|
|
1769
|
+
archived: boolean;
|
|
1770
|
+
anonymized: boolean;
|
|
1771
|
+
fullName: string;
|
|
1772
|
+
invoice?: InvoiceNonNullableFields;
|
|
1773
|
+
fullyCheckedIn: boolean;
|
|
1774
|
+
transactionId: string;
|
|
1775
|
+
paymentDetails?: PaymentDetailsNonNullableFields;
|
|
1776
|
+
channel: ChannelType;
|
|
1777
|
+
availableActions: Action[];
|
|
1778
|
+
giftCardPaymentDetails: GiftCardPaymentDetailsNonNullableFields[];
|
|
1779
|
+
balanceSummary?: BalanceSummaryNonNullableFields;
|
|
1780
|
+
}
|
|
1781
|
+
export interface ListOrdersResponseNonNullableFields {
|
|
1782
|
+
total: number;
|
|
1783
|
+
offset: number;
|
|
1784
|
+
limit: number;
|
|
1785
|
+
orders: OrderNonNullableFields[];
|
|
1786
|
+
}
|
|
1787
|
+
interface CalendarLinksNonNullableFields {
|
|
1788
|
+
google: string;
|
|
1789
|
+
ics: string;
|
|
1790
|
+
}
|
|
1791
|
+
export interface GetOrderResponseNonNullableFields {
|
|
1792
|
+
order?: OrderNonNullableFields;
|
|
1793
|
+
calendarLinks?: CalendarLinksNonNullableFields;
|
|
1794
|
+
}
|
|
1795
|
+
export interface UpdateOrderResponseNonNullableFields {
|
|
1796
|
+
order?: OrderNonNullableFields;
|
|
1797
|
+
}
|
|
1798
|
+
export interface BulkUpdateOrdersResponseNonNullableFields {
|
|
1799
|
+
orders: OrderNonNullableFields[];
|
|
1800
|
+
}
|
|
1801
|
+
export interface ConfirmOrderResponseNonNullableFields {
|
|
1802
|
+
orders: OrderNonNullableFields[];
|
|
1803
|
+
}
|
|
1804
|
+
interface TicketSalesNonNullableFields {
|
|
1805
|
+
total?: MoneyNonNullableFields;
|
|
1806
|
+
totalOrders: number;
|
|
1807
|
+
totalTickets: number;
|
|
1808
|
+
revenue?: MoneyNonNullableFields;
|
|
1809
|
+
}
|
|
1810
|
+
export interface GetSummaryResponseNonNullableFields {
|
|
1811
|
+
sales: TicketSalesNonNullableFields[];
|
|
1812
|
+
}
|
|
1813
|
+
export interface GetCheckoutOptionsResponseNonNullableFields {
|
|
1814
|
+
paymentMethodConfigured: boolean;
|
|
1815
|
+
acceptCoupons: boolean;
|
|
1816
|
+
premiumServices: boolean;
|
|
1817
|
+
paidTickets: boolean;
|
|
1818
|
+
acceptGiftCards: boolean;
|
|
1819
|
+
}
|
|
1820
|
+
interface ResponseMetaDataNonNullableFields {
|
|
1821
|
+
count: number;
|
|
1822
|
+
offset: number;
|
|
1823
|
+
total: number;
|
|
1824
|
+
}
|
|
1825
|
+
interface DashboardNonNullableFields {
|
|
1826
|
+
hidden: boolean;
|
|
1827
|
+
sold: number;
|
|
1828
|
+
limited: boolean;
|
|
1829
|
+
ticketsSold: number;
|
|
1830
|
+
ticketsReserved: number;
|
|
1831
|
+
}
|
|
1832
|
+
interface WixFeeConfigNonNullableFields {
|
|
1833
|
+
type: FeeType;
|
|
1834
|
+
}
|
|
1835
|
+
interface TicketSalePeriodNonNullableFields {
|
|
1836
|
+
hideNotOnSale: boolean;
|
|
1837
|
+
}
|
|
1838
|
+
interface PricingOptionNonNullableFields {
|
|
1839
|
+
price?: MoneyNonNullableFields;
|
|
1840
|
+
}
|
|
1841
|
+
interface PricingOptionsNonNullableFields {
|
|
1842
|
+
options: PricingOptionNonNullableFields[];
|
|
1843
|
+
}
|
|
1844
|
+
interface TicketPricingNonNullableFields {
|
|
1845
|
+
fixedPrice?: MoneyNonNullableFields;
|
|
1846
|
+
minPrice?: MoneyNonNullableFields;
|
|
1847
|
+
pricingOptions?: PricingOptionsNonNullableFields;
|
|
1848
|
+
pricingType: Type;
|
|
1849
|
+
}
|
|
1850
|
+
interface TicketDefinitionNonNullableFields {
|
|
1851
|
+
_id: string;
|
|
1852
|
+
price?: MoneyNonNullableFields;
|
|
1853
|
+
free: boolean;
|
|
1854
|
+
name: string;
|
|
1855
|
+
description: string;
|
|
1856
|
+
limitPerCheckout: number;
|
|
1857
|
+
orderIndex: number;
|
|
1858
|
+
policy: string;
|
|
1859
|
+
dashboard?: DashboardNonNullableFields;
|
|
1860
|
+
eventId: string;
|
|
1861
|
+
wixFeeConfig?: WixFeeConfigNonNullableFields;
|
|
1862
|
+
salePeriod?: TicketSalePeriodNonNullableFields;
|
|
1863
|
+
saleStatus: TicketSaleStatus;
|
|
1864
|
+
state: State[];
|
|
1865
|
+
pricing?: TicketPricingNonNullableFields;
|
|
1866
|
+
}
|
|
1867
|
+
export interface ListAvailableTicketsResponseNonNullableFields {
|
|
1868
|
+
metaData?: ResponseMetaDataNonNullableFields;
|
|
1869
|
+
definitions: TicketDefinitionNonNullableFields[];
|
|
1870
|
+
}
|
|
1871
|
+
export interface QueryAvailableTicketsResponseNonNullableFields {
|
|
1872
|
+
metaData?: ResponseMetaDataNonNullableFields;
|
|
1873
|
+
definitions: TicketDefinitionNonNullableFields[];
|
|
1874
|
+
}
|
|
1875
|
+
interface TicketReservationNonNullableFields {
|
|
1876
|
+
quantity: number;
|
|
1877
|
+
ticket?: TicketDefinitionNonNullableFields;
|
|
1878
|
+
}
|
|
1879
|
+
export interface CreateReservationResponseNonNullableFields {
|
|
1880
|
+
_id: string;
|
|
1881
|
+
reservations: TicketReservationNonNullableFields[];
|
|
1882
|
+
invoice?: InvoiceNonNullableFields;
|
|
1883
|
+
reservationStatus: ReservationStatus;
|
|
1884
|
+
}
|
|
1885
|
+
interface ErrorNonNullableFields {
|
|
1886
|
+
code: string;
|
|
1887
|
+
}
|
|
1888
|
+
interface DiscountErrorsNonNullableFields {
|
|
1889
|
+
error: ErrorNonNullableFields[];
|
|
1890
|
+
}
|
|
1891
|
+
interface GiftCardErrorsErrorNonNullableFields {
|
|
1892
|
+
code: string;
|
|
1893
|
+
}
|
|
1894
|
+
interface GiftCardErrorsNonNullableFields {
|
|
1895
|
+
error: GiftCardErrorsErrorNonNullableFields[];
|
|
1896
|
+
}
|
|
1897
|
+
export interface GetInvoiceResponseNonNullableFields {
|
|
1898
|
+
invoice?: InvoiceNonNullableFields;
|
|
1899
|
+
discountErrors?: DiscountErrorsNonNullableFields;
|
|
1900
|
+
reservationStatus: ReservationStatus;
|
|
1901
|
+
reservationOccupied: boolean;
|
|
1902
|
+
reservations: TicketReservationNonNullableFields[];
|
|
1903
|
+
giftCardPaymentDetails: GiftCardPaymentDetailsNonNullableFields[];
|
|
1904
|
+
balanceSummary?: BalanceSummaryNonNullableFields;
|
|
1905
|
+
giftCardErrors?: GiftCardErrorsNonNullableFields;
|
|
1906
|
+
}
|
|
1907
|
+
export interface CheckoutResponseNonNullableFields {
|
|
1908
|
+
order?: OrderNonNullableFields;
|
|
1909
|
+
reservations: TicketReservationNonNullableFields[];
|
|
1910
|
+
}
|
|
1911
|
+
export interface UpdateCheckoutResponseNonNullableFields {
|
|
1912
|
+
order?: OrderNonNullableFields;
|
|
1913
|
+
}
|
|
1914
|
+
export interface PosCheckoutResponseNonNullableFields {
|
|
1915
|
+
order?: OrderNonNullableFields;
|
|
1916
|
+
reservations: TicketReservationNonNullableFields[];
|
|
1917
|
+
}
|
|
1918
|
+
export interface BaseEventMetadata {
|
|
1919
|
+
/** App instance ID. */
|
|
1920
|
+
instanceId?: string | null;
|
|
1921
|
+
/** Event type. */
|
|
1922
|
+
eventType?: string;
|
|
1923
|
+
/** The identification type and identity data. */
|
|
1924
|
+
identity?: IdentificationData;
|
|
1925
|
+
}
|
|
1926
|
+
export interface OrderDeletedEnvelope {
|
|
1927
|
+
data: OrderDeleted;
|
|
1928
|
+
metadata: BaseEventMetadata;
|
|
1929
|
+
}
|
|
1930
|
+
/**
|
|
1931
|
+
* This event is triggered when an order is deleted via GDPR request.
|
|
1932
|
+
* @permissionScope Read Events - all read permissions
|
|
1933
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
1934
|
+
* @permissionScope Manage Events - all permissions
|
|
1935
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
1936
|
+
* @permissionScope Read Basic Events Order Info
|
|
1937
|
+
* @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS
|
|
1938
|
+
* @permissionScope Manage Orders
|
|
1939
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
1940
|
+
* @permissionId WIX_EVENTS.READ_ORDERS
|
|
1941
|
+
* @webhook
|
|
1942
|
+
* @eventType wix.events.ticketing.events.OrderDeleted
|
|
1943
|
+
*/
|
|
1944
|
+
export declare function onOrderDeleted(handler: (event: OrderDeletedEnvelope) => void | Promise<void>): void;
|
|
1945
|
+
export interface OrderUpdatedEnvelope {
|
|
1946
|
+
data: OrderUpdated;
|
|
1947
|
+
metadata: BaseEventMetadata;
|
|
1948
|
+
}
|
|
1949
|
+
/** @permissionScope Read Events - all read permissions
|
|
1950
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
1951
|
+
* @permissionScope Manage Events - all permissions
|
|
1952
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
1953
|
+
* @permissionScope Read Basic Events Order Info
|
|
1954
|
+
* @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS
|
|
1955
|
+
* @permissionScope Manage Orders
|
|
1956
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
1957
|
+
* @permissionId WIX_EVENTS.READ_ORDERS
|
|
1958
|
+
* @webhook
|
|
1959
|
+
* @eventType wix.events.ticketing.events.OrderUpdated
|
|
1960
|
+
*/
|
|
1961
|
+
export declare function onOrderUpdated(handler: (event: OrderUpdatedEnvelope) => void | Promise<void>): void;
|
|
1962
|
+
export interface OrderConfirmedEnvelope {
|
|
1963
|
+
data: OrderConfirmed;
|
|
1964
|
+
metadata: BaseEventMetadata;
|
|
1965
|
+
}
|
|
1966
|
+
/** @permissionScope Read Events - all read permissions
|
|
1967
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
1968
|
+
* @permissionScope Manage Events - all permissions
|
|
1969
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
1970
|
+
* @permissionScope Read Basic Events Order Info
|
|
1971
|
+
* @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS
|
|
1972
|
+
* @permissionScope Manage Orders
|
|
1973
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
1974
|
+
* @permissionId WIX_EVENTS.READ_ORDERS
|
|
1975
|
+
* @webhook
|
|
1976
|
+
* @eventType wix.events.ticketing.events.OrderConfirmed
|
|
1977
|
+
*/
|
|
1978
|
+
export declare function onOrderConfirmed(handler: (event: OrderConfirmedEnvelope) => void | Promise<void>): void;
|
|
1979
|
+
export interface OrderInitiatedEnvelope {
|
|
1980
|
+
data: OrderInitiated;
|
|
1981
|
+
metadata: BaseEventMetadata;
|
|
1982
|
+
}
|
|
1983
|
+
/** @permissionScope Read Events - all read permissions
|
|
1984
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
1985
|
+
* @permissionScope Manage Events - all permissions
|
|
1986
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
1987
|
+
* @permissionScope Read Basic Events Order Info
|
|
1988
|
+
* @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS
|
|
1989
|
+
* @permissionScope Manage Orders
|
|
1990
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
1991
|
+
* @permissionId WIX_EVENTS.READ_ORDERS
|
|
1992
|
+
* @webhook
|
|
1993
|
+
* @eventType wix.events.ticketing.events.OrderInitiated
|
|
1994
|
+
*/
|
|
1995
|
+
export declare function onOrderInitiated(handler: (event: OrderInitiatedEnvelope) => void | Promise<void>): void;
|
|
1996
|
+
export interface OrderReservationCreatedEnvelope {
|
|
1997
|
+
data: ReservationCreated;
|
|
1998
|
+
metadata: BaseEventMetadata;
|
|
1999
|
+
}
|
|
2000
|
+
/** @permissionScope Read Events - all read permissions
|
|
2001
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
2002
|
+
* @permissionScope Manage Events - all permissions
|
|
2003
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
2004
|
+
* @permissionScope Read Basic Events Order Info
|
|
2005
|
+
* @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS
|
|
2006
|
+
* @permissionScope Manage Orders
|
|
2007
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
2008
|
+
* @permissionId WIX_EVENTS.READ_INVOICE
|
|
2009
|
+
* @webhook
|
|
2010
|
+
* @eventType wix.events.ticketing.events.ReservationCreated
|
|
2011
|
+
*/
|
|
2012
|
+
export declare function onOrderReservationCreated(handler: (event: OrderReservationCreatedEnvelope) => void | Promise<void>): void;
|
|
2013
|
+
export interface OrderReservationUpdatedEnvelope {
|
|
2014
|
+
data: ReservationUpdated;
|
|
2015
|
+
metadata: BaseEventMetadata;
|
|
2016
|
+
}
|
|
2017
|
+
/** @permissionScope Read Events - all read permissions
|
|
2018
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
2019
|
+
* @permissionScope Manage Events - all permissions
|
|
2020
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
2021
|
+
* @permissionScope Read Basic Events Order Info
|
|
2022
|
+
* @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS
|
|
2023
|
+
* @permissionScope Manage Orders
|
|
2024
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
2025
|
+
* @permissionId WIX_EVENTS.READ_INVOICE
|
|
2026
|
+
* @webhook
|
|
2027
|
+
* @eventType wix.events.ticketing.events.ReservationUpdated
|
|
2028
|
+
*/
|
|
2029
|
+
export declare function onOrderReservationUpdated(handler: (event: OrderReservationUpdatedEnvelope) => void | Promise<void>): void;
|
|
2030
|
+
/**
|
|
2031
|
+
* Retrieves a list of orders, including ticket data.
|
|
2032
|
+
* @public
|
|
2033
|
+
* @param options - An object representing the available options for retrieving a list of orders.
|
|
2034
|
+
* @permissionId WIX_EVENTS.READ_ORDERS
|
|
2035
|
+
* @permissionScope Read Events - all read permissions
|
|
2036
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
2037
|
+
* @permissionScope Manage Events - all permissions
|
|
2038
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
2039
|
+
* @permissionScope Read Basic Events Order Info
|
|
2040
|
+
* @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS
|
|
2041
|
+
* @permissionScope Manage Orders
|
|
2042
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
2043
|
+
* @applicableIdentity APP
|
|
2044
|
+
* @fqn wix.events.ticketing.OrderManagement.ListOrders
|
|
2045
|
+
*/
|
|
2046
|
+
export declare function listOrders(options?: ListOrdersOptions): Promise<ListOrdersResponse & ListOrdersResponseNonNullableFields>;
|
|
2047
|
+
export interface ListOrdersOptions {
|
|
2048
|
+
/** Offset. */
|
|
2049
|
+
offset?: number;
|
|
2050
|
+
/** Limit. */
|
|
2051
|
+
limit?: number;
|
|
2052
|
+
/**
|
|
2053
|
+
* Predefined sets of fields to return.
|
|
2054
|
+
* - `TICKETS`: Returns `tickets`.
|
|
2055
|
+
* - `DETAILS`: Returns `reservationId`, `snapshotId`, `created`, `firstName`, `lastName`, `confirmed`, `status`, `method`, `ticketsQuantity`, `totalPrice`, `ticketsPdf`, `archived`, `fullName`.
|
|
2056
|
+
* - `FORM` : Returns `checkoutForm`.
|
|
2057
|
+
* - `INVOICE`: Returns `invoice`.
|
|
2058
|
+
*
|
|
2059
|
+
* Default: If `fieldset` is not included in the request, `orderNumber`, `eventId`, `contactId`, `memberId`, `anonymized`, `fullyCheckedIn` are returned.
|
|
2060
|
+
*/
|
|
2061
|
+
fieldset?: OrderFieldset[];
|
|
2062
|
+
/**
|
|
2063
|
+
* Order status. Possible values:
|
|
2064
|
+
* - `FREE`: The order is confirmed, no payment is required.
|
|
2065
|
+
* - `PENDING`: The order was paid, but the payment gateway suspended the payment.
|
|
2066
|
+
* - `PAID`: The order is paid.
|
|
2067
|
+
* - `OFFLINE_PENDING`: The order is confirmed but has to be paid in cash and the status is manually updated to `PAID`.
|
|
2068
|
+
* - `INITIATED`: The order is awaiting for payment.
|
|
2069
|
+
* - `CANCELED`: The order is canceled.
|
|
2070
|
+
* - `DECLINED`: The order is payment is declined.
|
|
2071
|
+
*/
|
|
2072
|
+
status?: OrderStatus[];
|
|
2073
|
+
/** Event ID to which the order belongs. */
|
|
2074
|
+
eventId?: string[];
|
|
2075
|
+
/** Order number. */
|
|
2076
|
+
orderNumber?: string[];
|
|
2077
|
+
/** Site member ID. */
|
|
2078
|
+
memberId?: string[];
|
|
2079
|
+
/** Field facets. */
|
|
2080
|
+
facet?: string[];
|
|
2081
|
+
/** Search filter. You can search `fullName`, `email` and `orderNumber`. */
|
|
2082
|
+
searchPhrase?: string;
|
|
2083
|
+
/** Event creator ID. */
|
|
2084
|
+
eventCreatorId?: string[];
|
|
2085
|
+
/**
|
|
2086
|
+
* Sort order.
|
|
2087
|
+
* Default: `created:asc`.
|
|
2088
|
+
*/
|
|
2089
|
+
sort?: string;
|
|
2090
|
+
/** Order tag. */
|
|
2091
|
+
tag?: OrderTag[];
|
|
2092
|
+
/** Guest contact IDs. */
|
|
2093
|
+
contactId?: string[];
|
|
2094
|
+
}
|
|
2095
|
+
/**
|
|
2096
|
+
* Retrieves an order, including ticket data.
|
|
2097
|
+
* <!--
|
|
2098
|
+
* >The fieldsets in this function are restricted and only run if you elevate permissions using the [wix-auth.elevate()](https://www.wix.com/velo/reference/wix-auth/elevate) function.
|
|
2099
|
+
* -->
|
|
2100
|
+
* @public
|
|
2101
|
+
* @requiredField identifiers
|
|
2102
|
+
* @requiredField identifiers.eventId
|
|
2103
|
+
* @requiredField identifiers.orderNumber
|
|
2104
|
+
* @param options - An object representing the available options for getting an order.
|
|
2105
|
+
* @param identifiers - An object containing identifiers for the order to be retrieved.
|
|
2106
|
+
* @permissionId WIX_EVENTS.READ_ORDERS
|
|
2107
|
+
* @permissionScope Read Events - all read permissions
|
|
2108
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
2109
|
+
* @permissionScope Manage Events - all permissions
|
|
2110
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
2111
|
+
* @permissionScope Read Basic Events Order Info
|
|
2112
|
+
* @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS
|
|
2113
|
+
* @permissionScope Manage Orders
|
|
2114
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
2115
|
+
* @applicableIdentity APP
|
|
2116
|
+
* @returns Requested order.
|
|
2117
|
+
* @fqn wix.events.ticketing.OrderManagement.GetOrder
|
|
2118
|
+
*/
|
|
2119
|
+
export declare function getOrder(identifiers: GetOrderIdentifiers, options?: GetOrderOptions): Promise<Order & OrderNonNullableFields>;
|
|
2120
|
+
export interface GetOrderIdentifiers {
|
|
2121
|
+
/** Event ID to which the order belongs. */
|
|
2122
|
+
eventId: string;
|
|
2123
|
+
/** Unique order number. */
|
|
2124
|
+
orderNumber: string;
|
|
2125
|
+
}
|
|
2126
|
+
export interface GetOrderOptions {
|
|
2127
|
+
/**
|
|
2128
|
+
* Predefined sets of fields to return.
|
|
2129
|
+
* - `TICKETS`: Returns `tickets`.
|
|
2130
|
+
* - `DETAILS`: Returns `reservationId`, `snapshotId`, `created`, `firstName`, `lastName`, `confirmed`, `status`, `method`, `ticketsQuantity`, `totalPrice`, `ticketsPdf`, `archived`, `fullName`.
|
|
2131
|
+
* - `FORM` : Returns `checkoutForm`.
|
|
2132
|
+
* - `INVOICE`: Returns `invoice`.
|
|
2133
|
+
*
|
|
2134
|
+
* Default: If `fieldset` is not included in the request, `orderNumber`, `eventId`, `contactId`, `memberId`, `anonymized`, `fullyCheckedIn` are returned.
|
|
2135
|
+
*/
|
|
2136
|
+
fieldset?: OrderFieldset[];
|
|
2137
|
+
}
|
|
2138
|
+
/**
|
|
2139
|
+
* Updates an order.
|
|
2140
|
+
* @public
|
|
2141
|
+
* @requiredField identifiers
|
|
2142
|
+
* @requiredField identifiers.eventId
|
|
2143
|
+
* @requiredField identifiers.orderNumber
|
|
2144
|
+
* @param options - An object representing the available options for updating an order.
|
|
2145
|
+
* @param identifiers - An object containing identifiers for the order to be updated.
|
|
2146
|
+
* @permissionId WIX_EVENTS.MANAGE_ORDERS
|
|
2147
|
+
* @permissionScope Manage Events - all permissions
|
|
2148
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
2149
|
+
* @permissionScope Manage Orders
|
|
2150
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
2151
|
+
* @applicableIdentity APP
|
|
2152
|
+
* @fqn wix.events.ticketing.OrderManagement.UpdateOrder
|
|
2153
|
+
*/
|
|
2154
|
+
export declare function updateOrder(identifiers: UpdateOrderIdentifiers, options?: UpdateOrderOptions): Promise<UpdateOrderResponse & UpdateOrderResponseNonNullableFields>;
|
|
2155
|
+
export interface UpdateOrderIdentifiers {
|
|
2156
|
+
/** Event ID to which the order belongs. */
|
|
2157
|
+
eventId: string;
|
|
2158
|
+
/** Unique order number. */
|
|
2159
|
+
orderNumber: string;
|
|
2160
|
+
}
|
|
2161
|
+
export interface UpdateOrderOptions {
|
|
2162
|
+
/** Set of field paths to update. */
|
|
2163
|
+
fields?: string[];
|
|
2164
|
+
/** Checkout form. */
|
|
2165
|
+
checkoutForm?: FormResponse;
|
|
2166
|
+
/** Whether order is archived. */
|
|
2167
|
+
archived?: boolean;
|
|
2168
|
+
}
|
|
2169
|
+
/**
|
|
2170
|
+
* Archives multiple orders.
|
|
2171
|
+
* @public
|
|
2172
|
+
* @requiredField eventId
|
|
2173
|
+
* @param options - An object representing the available options for confirming an order.
|
|
2174
|
+
* @param eventId - Event ID to which the order belongs.
|
|
2175
|
+
* @permissionId WIX_EVENTS.MANAGE_ORDERS
|
|
2176
|
+
* @permissionScope Manage Events - all permissions
|
|
2177
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
2178
|
+
* @permissionScope Manage Orders
|
|
2179
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
2180
|
+
* @applicableIdentity APP
|
|
2181
|
+
* @fqn wix.events.ticketing.OrderManagement.BulkUpdateOrders
|
|
2182
|
+
*/
|
|
2183
|
+
export declare function bulkUpdateOrders(eventId: string, options?: BulkUpdateOrdersOptions): Promise<BulkUpdateOrdersResponse & BulkUpdateOrdersResponseNonNullableFields>;
|
|
2184
|
+
export interface BulkUpdateOrdersOptions {
|
|
2185
|
+
/** Unique order number. */
|
|
2186
|
+
orderNumber?: string[];
|
|
2187
|
+
/** Set of fields to update. */
|
|
2188
|
+
fields?: string[];
|
|
2189
|
+
/** Whether to archive the order. */
|
|
2190
|
+
archived?: boolean;
|
|
2191
|
+
}
|
|
2192
|
+
/**
|
|
2193
|
+
* Confirms an order.
|
|
2194
|
+
*
|
|
2195
|
+
*
|
|
2196
|
+
* This function changes order status from `INITIATED`, `PENDING`, `OFFLINE_PENDING` to `PAID`.
|
|
2197
|
+
* Confirming orders with `INITIATED` or `PENDING` status triggers an email with the tickets to the buyer (and to additional guests, if provided).
|
|
2198
|
+
* @public
|
|
2199
|
+
* @requiredField eventId
|
|
2200
|
+
* @param options - An object representing the available options for confirming an order.
|
|
2201
|
+
* @param eventId - Event ID to which the order belongs.
|
|
2202
|
+
* @permissionId WIX_EVENTS.MANAGE_ORDERS
|
|
2203
|
+
* @permissionScope Manage Events - all permissions
|
|
2204
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
2205
|
+
* @permissionScope Manage Orders
|
|
2206
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
2207
|
+
* @applicableIdentity APP
|
|
2208
|
+
* @fqn wix.events.ticketing.OrderManagement.ConfirmOrder
|
|
2209
|
+
*/
|
|
2210
|
+
export declare function confirmOrder(eventId: string, options?: ConfirmOrderOptions): Promise<ConfirmOrderResponse & ConfirmOrderResponseNonNullableFields>;
|
|
2211
|
+
export interface ConfirmOrderOptions {
|
|
2212
|
+
/** Order numbers. */
|
|
2213
|
+
orderNumber?: string[];
|
|
2214
|
+
}
|
|
2215
|
+
/**
|
|
2216
|
+
* Retrieves a summary of total ticket sales.
|
|
2217
|
+
* <!--
|
|
2218
|
+
* > Note: This function is restricted and only runs if you elevate permissions using the [wix-auth.elevate()](https://www.wix.com/velo/reference/wix-auth/elevate) function.
|
|
2219
|
+
* -->
|
|
2220
|
+
* @public
|
|
2221
|
+
* @param options - An object representing the available options for retrieving a summary of total ticket sales.
|
|
2222
|
+
* @permissionId WIX_EVENTS.READ_ORDERS
|
|
2223
|
+
* @permissionScope Read Events - all read permissions
|
|
2224
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
2225
|
+
* @permissionScope Manage Events - all permissions
|
|
2226
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
2227
|
+
* @permissionScope Read Basic Events Order Info
|
|
2228
|
+
* @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS
|
|
2229
|
+
* @permissionScope Manage Orders
|
|
2230
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
2231
|
+
* @applicableIdentity APP
|
|
2232
|
+
* @fqn wix.events.ticketing.OrderManagement.GetSummary
|
|
2233
|
+
*/
|
|
2234
|
+
export declare function getSummary(options?: GetSummaryOptions): Promise<GetSummaryResponse & GetSummaryResponseNonNullableFields>;
|
|
2235
|
+
export interface GetSummaryOptions {
|
|
2236
|
+
/** Event ID. */
|
|
2237
|
+
eventId?: string | null;
|
|
2238
|
+
}
|
|
2239
|
+
/**
|
|
2240
|
+
* Captures authorized payment asynchronously.
|
|
2241
|
+
* Eventually order will become paid.
|
|
2242
|
+
* For orders with non-authorized payments request will fail.
|
|
2243
|
+
* @param orderNumber - Order number.
|
|
2244
|
+
* @public
|
|
2245
|
+
* @requiredField orderNumber
|
|
2246
|
+
* @permissionId WIX_EVENTS.MANAGE_ORDERS
|
|
2247
|
+
* @permissionScope Manage Events - all permissions
|
|
2248
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
2249
|
+
* @permissionScope Manage Orders
|
|
2250
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
2251
|
+
* @applicableIdentity APP
|
|
2252
|
+
* @fqn wix.events.ticketing.OrderManagement.CaptureAuthorizedPayment
|
|
2253
|
+
*/
|
|
2254
|
+
export declare function captureAuthorizedPayment(orderNumber: string, options?: CaptureAuthorizedPaymentOptions): Promise<void>;
|
|
2255
|
+
export interface CaptureAuthorizedPaymentOptions {
|
|
2256
|
+
/** Event ID. */
|
|
2257
|
+
eventId?: string;
|
|
2258
|
+
}
|
|
2259
|
+
/**
|
|
2260
|
+
* Voids authorized payment asynchronously.
|
|
2261
|
+
* Eventually order will become voided.
|
|
2262
|
+
* For orders with non-authorized payments request will fail.
|
|
2263
|
+
* @param orderNumber - Order number.
|
|
2264
|
+
* @public
|
|
2265
|
+
* @requiredField orderNumber
|
|
2266
|
+
* @permissionId WIX_EVENTS.MANAGE_ORDERS
|
|
2267
|
+
* @permissionScope Manage Events - all permissions
|
|
2268
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
2269
|
+
* @permissionScope Manage Orders
|
|
2270
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
2271
|
+
* @applicableIdentity APP
|
|
2272
|
+
* @fqn wix.events.ticketing.OrderManagement.VoidAuthorizedPayment
|
|
2273
|
+
*/
|
|
2274
|
+
export declare function voidAuthorizedPayment(orderNumber: string, options?: VoidAuthorizedPaymentOptions): Promise<void>;
|
|
2275
|
+
export interface VoidAuthorizedPaymentOptions {
|
|
2276
|
+
/** Event ID. */
|
|
2277
|
+
eventId?: string;
|
|
2278
|
+
}
|
|
2279
|
+
/**
|
|
2280
|
+
* Retrieves checkout details.
|
|
2281
|
+
* @public
|
|
2282
|
+
* @permissionId WIX_EVENTS.READ_CHECKOUT
|
|
2283
|
+
* @permissionScope Manage Events - all permissions
|
|
2284
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
2285
|
+
* @permissionScope Manage Orders
|
|
2286
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
2287
|
+
* @applicableIdentity APP
|
|
2288
|
+
* @applicableIdentity VISITOR
|
|
2289
|
+
* @fqn wix.events.ticketing.CheckoutService.GetCheckoutOptions
|
|
2290
|
+
*/
|
|
2291
|
+
export declare function getCheckoutOptions(): Promise<GetCheckoutOptionsResponse & GetCheckoutOptionsResponseNonNullableFields>;
|
|
2292
|
+
/**
|
|
2293
|
+
* Returns tickets available to reserve.
|
|
2294
|
+
* <!--
|
|
2295
|
+
* > Note: This function is restricted and only runs if you elevate permissions using the [wix-auth.elevate()](https://www.wix.com/velo/reference/wix-auth/elevate) function.
|
|
2296
|
+
* -->
|
|
2297
|
+
* @public
|
|
2298
|
+
* @param options - An object representing the available options for retrieving a list of tickets available for reservation.
|
|
2299
|
+
* @permissionId WIX_EVENTS.READ_CHECKOUT
|
|
2300
|
+
* @permissionScope Manage Events - all permissions
|
|
2301
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
2302
|
+
* @permissionScope Manage Orders
|
|
2303
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
2304
|
+
* @applicableIdentity APP
|
|
2305
|
+
* @applicableIdentity VISITOR
|
|
2306
|
+
* @fqn wix.events.ticketing.CheckoutService.ListAvailableTickets
|
|
2307
|
+
*/
|
|
2308
|
+
export declare function listAvailableTickets(options?: ListAvailableTicketsOptions): Promise<ListAvailableTicketsResponse & ListAvailableTicketsResponseNonNullableFields>;
|
|
2309
|
+
export interface ListAvailableTicketsOptions {
|
|
2310
|
+
/** Event ID. If not provided, available tickets for all events in the site will be returned. */
|
|
2311
|
+
eventId?: string;
|
|
2312
|
+
/** Offset. */
|
|
2313
|
+
offset?: number;
|
|
2314
|
+
/** Limit. */
|
|
2315
|
+
limit?: number;
|
|
2316
|
+
/**
|
|
2317
|
+
* Sort order.
|
|
2318
|
+
* Default: `created:asc`.
|
|
2319
|
+
*/
|
|
2320
|
+
sort?: string;
|
|
2321
|
+
state?: State[];
|
|
2322
|
+
}
|
|
2323
|
+
/**
|
|
2324
|
+
* Returns tickets available to reserve.
|
|
2325
|
+
* <!--
|
|
2326
|
+
* > Note: The fieldsets in this function are restricted and only run if you elevate permissions using the [wix-auth.elevate()](https://www.wix.com/velo/reference/wix-auth/elevate) function.
|
|
2327
|
+
* -->
|
|
2328
|
+
* @public
|
|
2329
|
+
* @param options - An object representing the available options for retrieving a list of tickets available for reservation.
|
|
2330
|
+
* @permissionId WIX_EVENTS.READ_CHECKOUT
|
|
2331
|
+
* @permissionScope Manage Events - all permissions
|
|
2332
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
2333
|
+
* @permissionScope Manage Orders
|
|
2334
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
2335
|
+
* @applicableIdentity APP
|
|
2336
|
+
* @applicableIdentity VISITOR
|
|
2337
|
+
* @fqn wix.events.ticketing.CheckoutService.QueryAvailableTickets
|
|
2338
|
+
*/
|
|
2339
|
+
export declare function queryAvailableTickets(options?: QueryAvailableTicketsOptions): Promise<QueryAvailableTicketsResponse & QueryAvailableTicketsResponseNonNullableFields>;
|
|
2340
|
+
export interface QueryAvailableTicketsOptions {
|
|
2341
|
+
/** Offset. */
|
|
2342
|
+
offset?: number;
|
|
2343
|
+
/** Limit. */
|
|
2344
|
+
limit?: number;
|
|
2345
|
+
/** Ticket definition. */
|
|
2346
|
+
filter?: Record<string, any> | null;
|
|
2347
|
+
fieldset?: TicketDefinitionFieldset[];
|
|
2348
|
+
/**
|
|
2349
|
+
* Sort order.
|
|
2350
|
+
* Default: `created:asc`.
|
|
2351
|
+
*/
|
|
2352
|
+
sort?: string;
|
|
2353
|
+
}
|
|
2354
|
+
/**
|
|
2355
|
+
* Reserves tickets for 20 minutes.
|
|
2356
|
+
*
|
|
2357
|
+
*
|
|
2358
|
+
* Reserved tickets are deducted from ticket stock and cannot be bought by another site visitor.
|
|
2359
|
+
* When the reservation expires, the tickets are added back to the stock.
|
|
2360
|
+
* @public
|
|
2361
|
+
* @requiredField eventId
|
|
2362
|
+
* @param options - An object representing the available options for creating a reservation.
|
|
2363
|
+
* @param eventId - Event ID to which the reservation belongs.
|
|
2364
|
+
* @permissionId WIX_EVENTS.CHECKOUT
|
|
2365
|
+
* @permissionScope Manage Events - all permissions
|
|
2366
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
2367
|
+
* @permissionScope Manage Orders
|
|
2368
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
2369
|
+
* @applicableIdentity APP
|
|
2370
|
+
* @applicableIdentity VISITOR
|
|
2371
|
+
* @fqn wix.events.ticketing.CheckoutService.CreateReservation
|
|
2372
|
+
*/
|
|
2373
|
+
export declare function createReservation(eventId: string, options?: CreateReservationOptions): Promise<CreateReservationResponse & CreateReservationResponseNonNullableFields>;
|
|
2374
|
+
export interface CreateReservationOptions {
|
|
2375
|
+
/** Tickets to reserve. */
|
|
2376
|
+
ticketQuantities?: TicketReservationQuantity[];
|
|
2377
|
+
/** Whether to ignore the available ticket limits upon reservation. */
|
|
2378
|
+
ignoreLimits?: boolean;
|
|
2379
|
+
/** Whether to allow reservation for hidden tickets. */
|
|
2380
|
+
allowHiddenTickets?: boolean;
|
|
2381
|
+
}
|
|
2382
|
+
/**
|
|
2383
|
+
* Cancels ticket reservation and returns tickets to stock.
|
|
2384
|
+
* <!--
|
|
2385
|
+
* > Note: This function is restricted and only runs if you elevate permissions using the [wix-auth.elevate()](https://www.wix.com/velo/reference/wix-auth/elevate) function.
|
|
2386
|
+
* -->
|
|
2387
|
+
* @param _id - Reservation ID.
|
|
2388
|
+
* @public
|
|
2389
|
+
* @requiredField _id
|
|
2390
|
+
* @requiredField eventId
|
|
2391
|
+
* @param identifiers - An object containing identifiers for the reservation to be cancelled.
|
|
2392
|
+
* @param eventId - Event ID to which the reservation belongs.
|
|
2393
|
+
* @permissionId WIX_EVENTS.CHECKOUT
|
|
2394
|
+
* @permissionScope Manage Events - all permissions
|
|
2395
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
2396
|
+
* @permissionScope Manage Orders
|
|
2397
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
2398
|
+
* @applicableIdentity APP
|
|
2399
|
+
* @applicableIdentity VISITOR
|
|
2400
|
+
* @fqn wix.events.ticketing.CheckoutService.CancelReservation
|
|
2401
|
+
*/
|
|
2402
|
+
export declare function cancelReservation(_id: string, eventId: string): Promise<void>;
|
|
2403
|
+
/**
|
|
2404
|
+
* Generates a preview of an invoice, including the given coupon or pricing plan.
|
|
2405
|
+
* @param reservationId - Reservation ID.
|
|
2406
|
+
* @public
|
|
2407
|
+
* @requiredField eventId
|
|
2408
|
+
* @requiredField reservationId
|
|
2409
|
+
* @param options - An object representing the available options for generating a preview of a reservation invoice.
|
|
2410
|
+
* @param identifiers - An object containing identifiers for the reservation invoice preview to be generated.
|
|
2411
|
+
* @param eventId - Event ID to which the invoice belongs.
|
|
2412
|
+
* @permissionId WIX_EVENTS.READ_INVOICE
|
|
2413
|
+
* @permissionScope Read Events - all read permissions
|
|
2414
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
2415
|
+
* @permissionScope Manage Events - all permissions
|
|
2416
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
2417
|
+
* @permissionScope Read Basic Events Order Info
|
|
2418
|
+
* @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS
|
|
2419
|
+
* @permissionScope Manage Orders
|
|
2420
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
2421
|
+
* @applicableIdentity APP
|
|
2422
|
+
* @applicableIdentity VISITOR
|
|
2423
|
+
* @fqn wix.events.ticketing.CheckoutService.GetInvoice
|
|
2424
|
+
*/
|
|
2425
|
+
export declare function getInvoice(reservationId: string, eventId: string, options?: GetInvoiceOptions): Promise<GetInvoiceResponse & GetInvoiceResponseNonNullableFields>;
|
|
2426
|
+
export interface GetInvoiceOptions {
|
|
2427
|
+
/** Optional discount to be applied on the returned invoice. */
|
|
2428
|
+
withDiscount?: DiscountRequest;
|
|
2429
|
+
/** Optional benefit granted by the pricing plan to be applied on the returned invoice. */
|
|
2430
|
+
paidPlanBenefit?: PaidPlanBenefit;
|
|
2431
|
+
}
|
|
2432
|
+
/**
|
|
2433
|
+
* Checkouts the reserved tickets.
|
|
2434
|
+
*
|
|
2435
|
+
*
|
|
2436
|
+
* Creates an order and associates it with a site visitor contact.
|
|
2437
|
+
* Guest details are received from the [Registration Form](https://www.wix.com/velo/reference/wix-events-v2/forms/introduction) input fields.
|
|
2438
|
+
*
|
|
2439
|
+
* There is a possibility to use a separate ready-made Wix checkout form where the user will be redirected from your non-Wix site or a custom ticket picker created with Velo.
|
|
2440
|
+
* To build the checkout form path, get your event base URL by using the [`getEvent()`](https://www.wix.com/velo/reference/wix-events-backend/wixevents/getevent) function and add the following path:
|
|
2441
|
+
* `/{{EVENT_PAGE_SLUG}}/{{SLUG}}/ticket-form?reservationId={{YOUR_RESERVATION_ID}}`
|
|
2442
|
+
*
|
|
2443
|
+
* Example: `https://johndoe.wixsite.com/weddings/event-details/doe-wedding/ticket-form?reservationId=2be6d34a-2a1e-459f-897b-b4a66e73f69a`
|
|
2444
|
+
* @public
|
|
2445
|
+
* @requiredField eventId
|
|
2446
|
+
* @requiredField options.guests.form
|
|
2447
|
+
* @param options - An object representing the available options for checking out a reserved ticket.
|
|
2448
|
+
* @param eventId - Event ID to which the checkout belongs.
|
|
2449
|
+
* @permissionId WIX_EVENTS.CHECKOUT
|
|
2450
|
+
* @permissionScope Manage Events - all permissions
|
|
2451
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
2452
|
+
* @permissionScope Manage Orders
|
|
2453
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
2454
|
+
* @applicableIdentity APP
|
|
2455
|
+
* @applicableIdentity VISITOR
|
|
2456
|
+
* @fqn wix.events.ticketing.CheckoutService.Checkout
|
|
2457
|
+
*/
|
|
2458
|
+
export declare function checkout(eventId: string, options?: CheckoutOptionsForRequest): Promise<CheckoutResponse & CheckoutResponseNonNullableFields>;
|
|
2459
|
+
export interface CheckoutOptionsForRequest {
|
|
2460
|
+
/** Ticket reservation ID. */
|
|
2461
|
+
reservationId?: string;
|
|
2462
|
+
/** Member ID (if empty - no site member is associated to this order). */
|
|
2463
|
+
memberId?: string;
|
|
2464
|
+
/** Discount to apply on the invoice. */
|
|
2465
|
+
discount?: DiscountRequest;
|
|
2466
|
+
/** Buyer details. */
|
|
2467
|
+
buyer?: Buyer;
|
|
2468
|
+
/** Guest details. */
|
|
2469
|
+
guests?: Guest[];
|
|
2470
|
+
/** Benefit granted by the pricing plan. */
|
|
2471
|
+
paidPlanBenefit?: PaidPlanBenefit;
|
|
2472
|
+
/** Options controlling the checkout process. */
|
|
2473
|
+
options?: CheckoutOptions;
|
|
2474
|
+
/** Whether marketing consent was given */
|
|
2475
|
+
marketingConsent?: boolean | null;
|
|
2476
|
+
}
|
|
2477
|
+
/**
|
|
2478
|
+
* Updates order and tickets.
|
|
2479
|
+
*
|
|
2480
|
+
*
|
|
2481
|
+
* Only applicable for orders with `INITIATED`, `PENDING`, `OFFLINE_PENDING` statuses.
|
|
2482
|
+
* @param orderNumber - Unique order number.
|
|
2483
|
+
* @public
|
|
2484
|
+
* @requiredField eventId
|
|
2485
|
+
* @requiredField orderNumber
|
|
2486
|
+
* @param options - An object representing the available options for updating an order and tickets.
|
|
2487
|
+
* @param identifiers - An object containing identifiers for the order and tickets to be updated.
|
|
2488
|
+
* @param eventId - Event ID to which the checkout belongs.
|
|
2489
|
+
* @permissionId WIX_EVENTS.CHECKOUT
|
|
2490
|
+
* @permissionScope Manage Events - all permissions
|
|
2491
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
2492
|
+
* @permissionScope Manage Orders
|
|
2493
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
2494
|
+
* @applicableIdentity APP
|
|
2495
|
+
* @applicableIdentity VISITOR
|
|
2496
|
+
* @fqn wix.events.ticketing.CheckoutService.UpdateCheckout
|
|
2497
|
+
*/
|
|
2498
|
+
export declare function updateCheckout(orderNumber: string, eventId: string, options?: UpdateCheckoutOptions): Promise<UpdateCheckoutResponse & UpdateCheckoutResponseNonNullableFields>;
|
|
2499
|
+
export interface UpdateCheckoutOptions {
|
|
2500
|
+
/** Buyer details. */
|
|
2501
|
+
buyer?: Buyer;
|
|
2502
|
+
/** Guest details. */
|
|
2503
|
+
guests?: Guest[];
|
|
2504
|
+
/** Member ID (if empty - no site member is associated to this order). */
|
|
2505
|
+
memberId?: string | null;
|
|
2506
|
+
/** Discount to apply on the invoice. */
|
|
2507
|
+
discount?: DiscountRequest;
|
|
2508
|
+
/** Benefit granted by the pricing plan. */
|
|
2509
|
+
paidPlanBenefit?: PaidPlanBenefit;
|
|
2510
|
+
}
|
|
2511
|
+
/**
|
|
2512
|
+
* Creates order with payment details already initiated via Cashier Pay API.
|
|
2513
|
+
* @public
|
|
2514
|
+
* @documentationMaturity preview
|
|
2515
|
+
* @requiredField eventId
|
|
2516
|
+
* @requiredField options.reservationId
|
|
2517
|
+
* @param eventId - Event ID to which the checkout belongs.
|
|
2518
|
+
* @permissionId WIX_EVENTS.MANAGE_ORDERS
|
|
2519
|
+
* @permissionScope Manage Events - all permissions
|
|
2520
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
2521
|
+
* @permissionScope Manage Orders
|
|
2522
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
2523
|
+
* @applicableIdentity APP
|
|
2524
|
+
* @fqn wix.events.ticketing.CheckoutService.PosCheckout
|
|
2525
|
+
*/
|
|
2526
|
+
export declare function posCheckout(eventId: string, options?: PosCheckoutOptions): Promise<PosCheckoutResponse & PosCheckoutResponseNonNullableFields>;
|
|
2527
|
+
export interface PosCheckoutOptions {
|
|
2528
|
+
/** Ticket reservation ID. */
|
|
2529
|
+
reservationId: string;
|
|
2530
|
+
/**
|
|
2531
|
+
* Payment details ID.
|
|
2532
|
+
* Not required if reservation total is 0. In this case the order will be created with status Free and no payment.
|
|
2533
|
+
*/
|
|
2534
|
+
paymentDetailsId?: string | null;
|
|
2535
|
+
}
|
|
2536
|
+
export {};
|