@wix/auto_sdk_events_orders 1.0.9 → 1.0.11
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/{events-v1-order-orders.universal-CceUcOMM.d.mts → cjs/src/events-v1-order-orders.types.d.ts} +217 -604
- 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 +2905 -0
- package/build/cjs/src/events-v1-order-orders.universal.js +1180 -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/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/{events-v1-order-orders.universal-CceUcOMM.d.ts → es/src/events-v1-order-orders.types.d.ts} +217 -604
- 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 +2905 -0
- package/build/es/src/events-v1-order-orders.universal.js +1137 -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/{events-v1-order-orders.universal-CceUcOMM.d.ts → cjs/src/events-v1-order-orders.types.d.ts} +217 -604
- 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 +2905 -0
- package/build/internal/cjs/src/events-v1-order-orders.universal.js +1180 -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/{events-v1-order-orders.universal-CceUcOMM.d.mts → es/src/events-v1-order-orders.types.d.ts} +217 -604
- 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 +2905 -0
- package/build/internal/es/src/events-v1-order-orders.universal.js +1137 -0
- package/build/internal/es/src/events-v1-order-orders.universal.js.map +1 -0
- package/package.json +11 -12
- package/build/index.d.mts +0 -229
- package/build/index.d.ts +0 -229
- package/build/index.js +0 -2769
- package/build/index.js.map +0 -1
- package/build/index.mjs +0 -2706
- package/build/index.mjs.map +0 -1
- package/build/internal/index.d.mts +0 -229
- package/build/internal/index.d.ts +0 -229
- package/build/internal/index.js +0 -2769
- package/build/internal/index.js.map +0 -1
- package/build/internal/index.mjs +0 -2706
- package/build/internal/index.mjs.map +0 -1
- package/build/internal/meta.d.mts +0 -1331
- package/build/internal/meta.d.ts +0 -1331
- package/build/internal/meta.js +0 -1907
- package/build/internal/meta.js.map +0 -1
- package/build/internal/meta.mjs +0 -1864
- package/build/internal/meta.mjs.map +0 -1
- package/build/meta.d.mts +0 -1331
- package/build/meta.d.ts +0 -1331
- package/build/meta.js +0 -1907
- package/build/meta.js.map +0 -1
- package/build/meta.mjs +0 -1864
- package/build/meta.mjs.map +0 -1
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
interface Order {
|
|
1
|
+
export interface Order {
|
|
2
2
|
/** Unique order number. */
|
|
3
3
|
orderNumber?: string;
|
|
4
4
|
/**
|
|
@@ -7,13 +7,14 @@ interface Order {
|
|
|
7
7
|
*/
|
|
8
8
|
reservationId?: string;
|
|
9
9
|
/**
|
|
10
|
-
* Payment snapshot ID.
|
|
10
|
+
* Payment snapshot ID.
|
|
11
|
+
* Empty for FREE order.
|
|
11
12
|
* @format GUID
|
|
12
13
|
* @readonly
|
|
13
14
|
*/
|
|
14
15
|
snapshotId?: string;
|
|
15
16
|
/**
|
|
16
|
-
* Event ID
|
|
17
|
+
* Event ID.
|
|
17
18
|
* @format GUID
|
|
18
19
|
*/
|
|
19
20
|
eventId?: string;
|
|
@@ -23,7 +24,7 @@ interface Order {
|
|
|
23
24
|
*/
|
|
24
25
|
contactId?: string;
|
|
25
26
|
/**
|
|
26
|
-
*
|
|
27
|
+
* Member ID of buyer (if relevant).
|
|
27
28
|
* @format GUID
|
|
28
29
|
*/
|
|
29
30
|
memberId?: string;
|
|
@@ -45,24 +46,15 @@ interface Order {
|
|
|
45
46
|
checkoutForm?: FormResponse;
|
|
46
47
|
/** Whether the order is confirmed (triggered once payment gateway processes the payment and funds reach the merchant's account). */
|
|
47
48
|
confirmed?: boolean;
|
|
48
|
-
/**
|
|
49
|
-
* Order status. Possible values:
|
|
50
|
-
* - `FREE`: The order is confirmed, no payment is required.
|
|
51
|
-
* - `PENDING`: The order was paid, but the payment gateway suspended the payment.
|
|
52
|
-
* - `PAID`: The order is paid.
|
|
53
|
-
* - `OFFLINE_PENDING`: The order is confirmed but has to be paid in cash and the status is manually updated to `PAID`.
|
|
54
|
-
* - `INITIATED`: The order is awaiting for payment.
|
|
55
|
-
* - `CANCELED`: The order is canceled.
|
|
56
|
-
* - `DECLINED`: The order is payment is declined.
|
|
57
|
-
*/
|
|
49
|
+
/** Order status. */
|
|
58
50
|
status?: OrderStatus;
|
|
59
51
|
/** Payment method used for purchase, e.g., "payPal", "creditCard", etc. */
|
|
60
52
|
method?: string;
|
|
61
|
-
/**
|
|
53
|
+
/** Tickets ordered. */
|
|
62
54
|
ticketsQuantity?: number;
|
|
63
55
|
/** Total order price. */
|
|
64
56
|
totalPrice?: Money;
|
|
65
|
-
/**
|
|
57
|
+
/** URL to ticket PDF. */
|
|
66
58
|
ticketsPdf?: string;
|
|
67
59
|
/** Tickets (generated after payment). */
|
|
68
60
|
tickets?: TicketingTicket[];
|
|
@@ -88,32 +80,32 @@ interface Order {
|
|
|
88
80
|
/** Whether marketing consent was given */
|
|
89
81
|
marketingConsent?: boolean | null;
|
|
90
82
|
}
|
|
91
|
-
interface FormResponse {
|
|
83
|
+
export interface FormResponse {
|
|
92
84
|
/**
|
|
93
|
-
* Input
|
|
85
|
+
* Input values entered when filling the form.
|
|
94
86
|
* @maxSize 200
|
|
95
87
|
*/
|
|
96
88
|
inputValues?: InputValue[];
|
|
97
89
|
}
|
|
98
|
-
interface InputValue {
|
|
90
|
+
export interface InputValue {
|
|
99
91
|
/**
|
|
100
92
|
* Input field name.
|
|
101
93
|
* @maxLength 100
|
|
102
94
|
*/
|
|
103
95
|
inputName?: string;
|
|
104
96
|
/**
|
|
105
|
-
*
|
|
97
|
+
* Text entered into the input field.
|
|
106
98
|
* @maxLength 5000
|
|
107
99
|
*/
|
|
108
100
|
value?: string;
|
|
109
101
|
/**
|
|
110
|
-
* Multiple
|
|
102
|
+
* Multiple selection values. For example, the array is filled if several checkboxes are ticked.
|
|
111
103
|
* @maxSize 100
|
|
112
104
|
* @maxLength 5000
|
|
113
105
|
*/
|
|
114
106
|
values?: string[];
|
|
115
107
|
}
|
|
116
|
-
interface FormattedAddress {
|
|
108
|
+
export interface FormattedAddress {
|
|
117
109
|
/**
|
|
118
110
|
* One line address representation.
|
|
119
111
|
* @maxLength 200
|
|
@@ -123,11 +115,11 @@ interface FormattedAddress {
|
|
|
123
115
|
address?: Address;
|
|
124
116
|
}
|
|
125
117
|
/** Physical address */
|
|
126
|
-
interface Address extends AddressStreetOneOf {
|
|
118
|
+
export interface Address extends AddressStreetOneOf {
|
|
127
119
|
/** Street name and number. */
|
|
128
120
|
streetAddress?: StreetAddress;
|
|
129
121
|
/** Main address line, usually street and number as free text. */
|
|
130
|
-
|
|
122
|
+
addressLine?: string | null;
|
|
131
123
|
/**
|
|
132
124
|
* Country code.
|
|
133
125
|
* @format COUNTRY
|
|
@@ -143,31 +135,31 @@ interface Address extends AddressStreetOneOf {
|
|
|
143
135
|
addressLine2?: string | null;
|
|
144
136
|
}
|
|
145
137
|
/** @oneof */
|
|
146
|
-
interface AddressStreetOneOf {
|
|
138
|
+
export interface AddressStreetOneOf {
|
|
147
139
|
/** Street name and number. */
|
|
148
140
|
streetAddress?: StreetAddress;
|
|
149
141
|
/** Main address line, usually street and number as free text. */
|
|
150
142
|
addressLine?: string | null;
|
|
151
143
|
}
|
|
152
|
-
interface StreetAddress {
|
|
144
|
+
export interface StreetAddress {
|
|
153
145
|
/** Street number. */
|
|
154
146
|
number?: string;
|
|
155
147
|
/** Street name. */
|
|
156
148
|
name?: string;
|
|
157
149
|
}
|
|
158
|
-
interface AddressLocation {
|
|
150
|
+
export interface AddressLocation {
|
|
159
151
|
/** Address latitude. */
|
|
160
152
|
latitude?: number | null;
|
|
161
153
|
/** Address longitude. */
|
|
162
154
|
longitude?: number | null;
|
|
163
155
|
}
|
|
164
|
-
interface Subdivision {
|
|
156
|
+
export interface Subdivision {
|
|
165
157
|
/** Short subdivision code. */
|
|
166
158
|
code?: string;
|
|
167
159
|
/** Subdivision full name. */
|
|
168
160
|
name?: string;
|
|
169
161
|
}
|
|
170
|
-
declare enum SubdivisionType {
|
|
162
|
+
export declare enum SubdivisionType {
|
|
171
163
|
UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
|
|
172
164
|
/** State */
|
|
173
165
|
ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
|
|
@@ -183,14 +175,14 @@ declare enum SubdivisionType {
|
|
|
183
175
|
COUNTRY = "COUNTRY"
|
|
184
176
|
}
|
|
185
177
|
/** Subdivision Concordance values */
|
|
186
|
-
interface StandardDetails {
|
|
178
|
+
export interface StandardDetails {
|
|
187
179
|
/**
|
|
188
180
|
* 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
|
|
189
181
|
* @maxLength 20
|
|
190
182
|
*/
|
|
191
183
|
iso31662?: string | null;
|
|
192
184
|
}
|
|
193
|
-
declare enum OrderStatus {
|
|
185
|
+
export declare enum OrderStatus {
|
|
194
186
|
/** Order status not available for this request fieldset. */
|
|
195
187
|
NA_ORDER_STATUS = "NA_ORDER_STATUS",
|
|
196
188
|
/** Order is confirmed and payment isn't required. */
|
|
@@ -214,7 +206,7 @@ declare enum OrderStatus {
|
|
|
214
206
|
/** Order is partially paid with less than the total amount. */
|
|
215
207
|
PARTIALLY_PAID = "PARTIALLY_PAID"
|
|
216
208
|
}
|
|
217
|
-
interface Money {
|
|
209
|
+
export interface Money {
|
|
218
210
|
/**
|
|
219
211
|
* *Deprecated:** Use `value` instead.
|
|
220
212
|
* @format DECIMAL_VALUE
|
|
@@ -222,7 +214,7 @@ interface Money {
|
|
|
222
214
|
*/
|
|
223
215
|
amount?: string;
|
|
224
216
|
/**
|
|
225
|
-
*
|
|
217
|
+
* ISO 4217 format of the currency e.g., `USD`.
|
|
226
218
|
* @format CURRENCY
|
|
227
219
|
*/
|
|
228
220
|
currency?: string;
|
|
@@ -232,7 +224,7 @@ interface Money {
|
|
|
232
224
|
*/
|
|
233
225
|
value?: string | null;
|
|
234
226
|
}
|
|
235
|
-
interface TicketingTicket {
|
|
227
|
+
export interface TicketingTicket {
|
|
236
228
|
/** Unique ticket number (issued automatically). */
|
|
237
229
|
ticketNumber?: string;
|
|
238
230
|
/** Associated order number. */
|
|
@@ -247,11 +239,11 @@ interface TicketingTicket {
|
|
|
247
239
|
/** Ticket price. */
|
|
248
240
|
price?: Money;
|
|
249
241
|
/**
|
|
250
|
-
* Whether
|
|
242
|
+
* Whether ticket requires payment.
|
|
251
243
|
* @readonly
|
|
252
244
|
*/
|
|
253
245
|
free?: boolean;
|
|
254
|
-
/**
|
|
246
|
+
/** Ticket policy (as displayed in PDF). */
|
|
255
247
|
policy?: string;
|
|
256
248
|
/**
|
|
257
249
|
* Deprecated, use `check_in_url`.
|
|
@@ -289,8 +281,8 @@ interface TicketingTicket {
|
|
|
289
281
|
anonymized?: boolean;
|
|
290
282
|
/**
|
|
291
283
|
* Ticket check-in URL.
|
|
292
|
-
* Shown as
|
|
293
|
-
* Format: `https://www.wixevents.com/check-in/{ticket number},{event id}
|
|
284
|
+
* Shown as QR code image in PDF.
|
|
285
|
+
* Format: `https://www.wixevents.com/check-in/{ticket number},{event id}`
|
|
294
286
|
* Example: `https://www.wixevents.com/check-in/AAAA-AAAA-BB021,00000000-0000-0000-0000-000000000000`
|
|
295
287
|
*/
|
|
296
288
|
checkInUrl?: string;
|
|
@@ -299,7 +291,7 @@ interface TicketingTicket {
|
|
|
299
291
|
/** Associated order checkout channel type */
|
|
300
292
|
channel?: ChannelType;
|
|
301
293
|
/**
|
|
302
|
-
* URL to download ticket in
|
|
294
|
+
* URL to download ticket in .pkpass format for Apple Wallet
|
|
303
295
|
* @format WEB_URL
|
|
304
296
|
* @readonly
|
|
305
297
|
*/
|
|
@@ -310,11 +302,11 @@ interface TicketingTicket {
|
|
|
310
302
|
*/
|
|
311
303
|
canceled?: boolean | null;
|
|
312
304
|
}
|
|
313
|
-
interface CheckIn {
|
|
305
|
+
export interface CheckIn {
|
|
314
306
|
/** Time of check-in */
|
|
315
307
|
created?: Date | null;
|
|
316
308
|
}
|
|
317
|
-
interface GuestDetails {
|
|
309
|
+
export interface GuestDetails {
|
|
318
310
|
/** Whether ticket belongs to assigned guest. */
|
|
319
311
|
guestAssigned?: boolean;
|
|
320
312
|
/** Guest first name. */
|
|
@@ -339,13 +331,13 @@ interface GuestDetails {
|
|
|
339
331
|
*/
|
|
340
332
|
phone?: string | null;
|
|
341
333
|
}
|
|
342
|
-
declare enum ChannelType {
|
|
334
|
+
export declare enum ChannelType {
|
|
343
335
|
/** Buyer created the order via an online channel such as a website or mobile app. */
|
|
344
336
|
ONLINE = "ONLINE",
|
|
345
337
|
/** Sales person created the order and collected the money. */
|
|
346
338
|
OFFLINE_POS = "OFFLINE_POS"
|
|
347
339
|
}
|
|
348
|
-
interface TicketDetails {
|
|
340
|
+
export interface TicketDetails {
|
|
349
341
|
/**
|
|
350
342
|
* Unique seat id in the event venue.
|
|
351
343
|
* @minLength 1
|
|
@@ -399,15 +391,14 @@ interface TicketDetails {
|
|
|
399
391
|
*/
|
|
400
392
|
pricingOptionName?: string | null;
|
|
401
393
|
}
|
|
402
|
-
interface Invoice {
|
|
403
|
-
/** Items listed in the invoice. */
|
|
394
|
+
export interface Invoice {
|
|
404
395
|
items?: Item[];
|
|
405
396
|
/**
|
|
406
397
|
* Total cart amount.
|
|
407
398
|
* @deprecated
|
|
408
399
|
*/
|
|
409
400
|
total?: Money;
|
|
410
|
-
/** Discount applied to
|
|
401
|
+
/** Discount applied to cart. */
|
|
411
402
|
discount?: Discount;
|
|
412
403
|
/** Tax applied to cart. */
|
|
413
404
|
tax?: Tax;
|
|
@@ -429,15 +420,15 @@ interface Invoice {
|
|
|
429
420
|
fees?: Fee[];
|
|
430
421
|
/** Total revenue, excluding fees. (Taxes and payment provider fees are not deducted). */
|
|
431
422
|
revenue?: Money;
|
|
432
|
-
/**
|
|
423
|
+
/** URL to invoice preview. Returned only if order is paid. */
|
|
433
424
|
previewUrl?: string | null;
|
|
434
425
|
}
|
|
435
|
-
interface Item {
|
|
426
|
+
export interface Item {
|
|
436
427
|
/**
|
|
437
428
|
* Unique line item ID.
|
|
438
429
|
* @format GUID
|
|
439
430
|
*/
|
|
440
|
-
|
|
431
|
+
id?: string;
|
|
441
432
|
/**
|
|
442
433
|
* Line item quantity.
|
|
443
434
|
* @min 1
|
|
@@ -448,7 +439,7 @@ interface Item {
|
|
|
448
439
|
name?: string;
|
|
449
440
|
/** Line item price. */
|
|
450
441
|
price?: Money;
|
|
451
|
-
/** Total price for line items.
|
|
442
|
+
/** Total price for line items. Always equal to price * quantity. */
|
|
452
443
|
total?: Money;
|
|
453
444
|
/** Discount applied to the line item. */
|
|
454
445
|
discount?: Discount;
|
|
@@ -460,10 +451,10 @@ interface Item {
|
|
|
460
451
|
*/
|
|
461
452
|
fees?: Fee[];
|
|
462
453
|
}
|
|
463
|
-
interface Discount {
|
|
454
|
+
export interface Discount {
|
|
464
455
|
/** Total discount amount. */
|
|
465
456
|
amount?: Money;
|
|
466
|
-
/** Total
|
|
457
|
+
/** Total charge after applied discount. */
|
|
467
458
|
afterDiscount?: Money;
|
|
468
459
|
/**
|
|
469
460
|
* Discount coupon code.
|
|
@@ -483,7 +474,7 @@ interface Discount {
|
|
|
483
474
|
/** Discount items. */
|
|
484
475
|
discounts?: DiscountItem[];
|
|
485
476
|
}
|
|
486
|
-
interface DiscountItem extends DiscountItemDiscountOneOf {
|
|
477
|
+
export interface DiscountItem extends DiscountItemDiscountOneOf {
|
|
487
478
|
/** Coupon discount. */
|
|
488
479
|
coupon?: CouponDiscount;
|
|
489
480
|
/** Pricing plan discount. */
|
|
@@ -492,13 +483,13 @@ interface DiscountItem extends DiscountItemDiscountOneOf {
|
|
|
492
483
|
amount?: Money;
|
|
493
484
|
}
|
|
494
485
|
/** @oneof */
|
|
495
|
-
interface DiscountItemDiscountOneOf {
|
|
486
|
+
export interface DiscountItemDiscountOneOf {
|
|
496
487
|
/** Coupon discount. */
|
|
497
488
|
coupon?: CouponDiscount;
|
|
498
489
|
/** Pricing plan discount. */
|
|
499
490
|
paidPlan?: PaidPlanDiscount;
|
|
500
491
|
}
|
|
501
|
-
interface CouponDiscount {
|
|
492
|
+
export interface CouponDiscount {
|
|
502
493
|
/** Discount coupon name. */
|
|
503
494
|
name?: string;
|
|
504
495
|
/** Discount coupon code. */
|
|
@@ -506,18 +497,18 @@ interface CouponDiscount {
|
|
|
506
497
|
/** Discount coupon ID. */
|
|
507
498
|
couponId?: string;
|
|
508
499
|
}
|
|
509
|
-
interface PaidPlanDiscount extends PaidPlanDiscountDiscountOneOf {
|
|
500
|
+
export interface PaidPlanDiscount extends PaidPlanDiscountDiscountOneOf {
|
|
510
501
|
/** Discount by percentage applied to tickets. */
|
|
511
502
|
percentDiscount?: PercentDiscount;
|
|
512
503
|
/** Name of pricing plan. */
|
|
513
504
|
name?: string;
|
|
514
505
|
}
|
|
515
506
|
/** @oneof */
|
|
516
|
-
interface PaidPlanDiscountDiscountOneOf {
|
|
507
|
+
export interface PaidPlanDiscountDiscountOneOf {
|
|
517
508
|
/** Discount by percentage applied to tickets. */
|
|
518
509
|
percentDiscount?: PercentDiscount;
|
|
519
510
|
}
|
|
520
|
-
interface PercentDiscount {
|
|
511
|
+
export interface PercentDiscount {
|
|
521
512
|
/**
|
|
522
513
|
* Percent rate.
|
|
523
514
|
* @decimalValue options { gte:0.01, lte:100, maxScale:2 }
|
|
@@ -526,7 +517,7 @@ interface PercentDiscount {
|
|
|
526
517
|
/** Number of discounted tickets. */
|
|
527
518
|
quantityDiscounted?: number;
|
|
528
519
|
}
|
|
529
|
-
interface Tax {
|
|
520
|
+
export interface Tax {
|
|
530
521
|
/** Tax type. */
|
|
531
522
|
type?: TaxType;
|
|
532
523
|
/**
|
|
@@ -544,7 +535,7 @@ interface Tax {
|
|
|
544
535
|
/** Total tax amount. */
|
|
545
536
|
amount?: Money;
|
|
546
537
|
}
|
|
547
|
-
declare enum TaxType {
|
|
538
|
+
export declare enum TaxType {
|
|
548
539
|
/** Tax is included in the ticket price. */
|
|
549
540
|
INCLUDED = "INCLUDED",
|
|
550
541
|
/** Tax is added to the order at the checkout. */
|
|
@@ -552,7 +543,7 @@ declare enum TaxType {
|
|
|
552
543
|
/** Tax is added to the final total at the checkout. */
|
|
553
544
|
ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
|
|
554
545
|
}
|
|
555
|
-
interface Fee {
|
|
546
|
+
export interface Fee {
|
|
556
547
|
/** Fee identifier. */
|
|
557
548
|
name?: FeeName;
|
|
558
549
|
/** How fee is calculated. */
|
|
@@ -566,11 +557,11 @@ interface Fee {
|
|
|
566
557
|
/** Total amount of fee charges. */
|
|
567
558
|
amount?: Money;
|
|
568
559
|
}
|
|
569
|
-
declare enum FeeName {
|
|
560
|
+
export declare enum FeeName {
|
|
570
561
|
/** Wix ticket service fee charges applied to the line item. */
|
|
571
562
|
WIX_FEE = "WIX_FEE"
|
|
572
563
|
}
|
|
573
|
-
declare enum FeeType {
|
|
564
|
+
export declare enum FeeType {
|
|
574
565
|
/** Fee is added to the ticket price at checkout. */
|
|
575
566
|
FEE_ADDED = "FEE_ADDED",
|
|
576
567
|
/** Seller absorbs the fee. It is deducted from the ticket price. */
|
|
@@ -578,11 +569,11 @@ declare enum FeeType {
|
|
|
578
569
|
/** Fee is added to the ticket price at checkout. */
|
|
579
570
|
FEE_ADDED_AT_CHECKOUT = "FEE_ADDED_AT_CHECKOUT"
|
|
580
571
|
}
|
|
581
|
-
interface PaymentDetails {
|
|
572
|
+
export interface PaymentDetails {
|
|
582
573
|
/** Wix Payments transaction */
|
|
583
574
|
transaction?: PaymentTransaction;
|
|
584
575
|
}
|
|
585
|
-
interface PaymentTransaction {
|
|
576
|
+
export interface PaymentTransaction {
|
|
586
577
|
/**
|
|
587
578
|
* Wix Payments transaction id
|
|
588
579
|
* @format GUID
|
|
@@ -595,7 +586,7 @@ interface PaymentTransaction {
|
|
|
595
586
|
*/
|
|
596
587
|
method?: string;
|
|
597
588
|
}
|
|
598
|
-
declare enum ScheduledActionEnumAction {
|
|
589
|
+
export declare enum ScheduledActionEnumAction {
|
|
599
590
|
/** Action not scheduled. */
|
|
600
591
|
UNKNOWN_ACTION = "UNKNOWN_ACTION",
|
|
601
592
|
/** Captured after the delay. */
|
|
@@ -603,7 +594,7 @@ declare enum ScheduledActionEnumAction {
|
|
|
603
594
|
/** Void after the delay. */
|
|
604
595
|
VOID = "VOID"
|
|
605
596
|
}
|
|
606
|
-
declare enum Action {
|
|
597
|
+
export declare enum Action {
|
|
607
598
|
/** Order can be archived. */
|
|
608
599
|
ARCHIVE = "ARCHIVE",
|
|
609
600
|
/** Order can be unarchived. */
|
|
@@ -615,7 +606,7 @@ declare enum Action {
|
|
|
615
606
|
/** Order can be voided. */
|
|
616
607
|
VOID = "VOID"
|
|
617
608
|
}
|
|
618
|
-
interface GiftCardPaymentDetails {
|
|
609
|
+
export interface GiftCardPaymentDetails {
|
|
619
610
|
/**
|
|
620
611
|
* Gift card payment id.
|
|
621
612
|
* @format GUID
|
|
@@ -636,15 +627,15 @@ interface GiftCardPaymentDetails {
|
|
|
636
627
|
*/
|
|
637
628
|
obfuscatedCode?: string | null;
|
|
638
629
|
}
|
|
639
|
-
interface BalanceSummary {
|
|
630
|
+
export interface BalanceSummary {
|
|
640
631
|
/** Amount left to pay. */
|
|
641
632
|
balance?: Money;
|
|
642
633
|
}
|
|
643
|
-
interface OrderDeleted {
|
|
634
|
+
export interface OrderDeleted {
|
|
644
635
|
/** Order deleted timestamp in ISO UTC format. */
|
|
645
636
|
timestamp?: Date | null;
|
|
646
637
|
/**
|
|
647
|
-
* Event ID
|
|
638
|
+
* Event ID.
|
|
648
639
|
* @format GUID
|
|
649
640
|
*/
|
|
650
641
|
eventId?: string;
|
|
@@ -676,13 +667,13 @@ interface OrderDeleted {
|
|
|
676
667
|
/** Tickets generated after payment. */
|
|
677
668
|
tickets?: Ticket[];
|
|
678
669
|
}
|
|
679
|
-
declare enum OrderType {
|
|
670
|
+
export declare enum OrderType {
|
|
680
671
|
/** Buyer form is used for all tickets. */
|
|
681
672
|
UNASSIGNED_TICKETS = "UNASSIGNED_TICKETS",
|
|
682
673
|
/** Each order ticket has its own form. */
|
|
683
674
|
ASSIGNED_TICKETS = "ASSIGNED_TICKETS"
|
|
684
675
|
}
|
|
685
|
-
interface Ticket {
|
|
676
|
+
export interface Ticket {
|
|
686
677
|
/** Unique issued ticket number. */
|
|
687
678
|
ticketNumber?: string;
|
|
688
679
|
/**
|
|
@@ -730,7 +721,7 @@ interface Ticket {
|
|
|
730
721
|
/** Whether ticket is canceled. */
|
|
731
722
|
canceled?: boolean | null;
|
|
732
723
|
}
|
|
733
|
-
interface OnlineConferencingLogin {
|
|
724
|
+
export interface OnlineConferencingLogin {
|
|
734
725
|
/**
|
|
735
726
|
* Link URL to the online conference.
|
|
736
727
|
* @format WEB_URL
|
|
@@ -743,7 +734,7 @@ interface OnlineConferencingLogin {
|
|
|
743
734
|
*/
|
|
744
735
|
password?: string | null;
|
|
745
736
|
}
|
|
746
|
-
interface ListOrdersRequest {
|
|
737
|
+
export interface ListOrdersRequest {
|
|
747
738
|
/** Offset. */
|
|
748
739
|
offset?: number;
|
|
749
740
|
/**
|
|
@@ -752,30 +743,14 @@ interface ListOrdersRequest {
|
|
|
752
743
|
*/
|
|
753
744
|
limit?: number;
|
|
754
745
|
/**
|
|
755
|
-
*
|
|
756
|
-
* - `TICKETS`: Returns `tickets`.
|
|
757
|
-
* - `DETAILS`: Returns `reservationId`, `snapshotId`, `created`, `firstName`, `lastName`, `confirmed`, `status`, `method`, `ticketsQuantity`, `totalPrice`, `ticketsPdf`, `archived`, `fullName`.
|
|
758
|
-
* - `FORM` : Returns `checkoutForm`.
|
|
759
|
-
* - `INVOICE`: Returns `invoice`.
|
|
760
|
-
*
|
|
761
|
-
* Default: If `fieldset` is not included in the request, `orderNumber`, `eventId`, `contactId`, `memberId`, `anonymized`, `fullyCheckedIn` are returned.
|
|
762
|
-
*
|
|
746
|
+
* Controls which data is returned. See [Fieldset](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_order-fieldset).
|
|
763
747
|
* @maxSize 20
|
|
764
748
|
*/
|
|
765
749
|
fieldset?: OrderFieldset[];
|
|
766
|
-
/**
|
|
767
|
-
* Order status. Possible values:
|
|
768
|
-
* - `FREE`: The order is confirmed, no payment is required.
|
|
769
|
-
* - `PENDING`: The order was paid, but the payment gateway suspended the payment.
|
|
770
|
-
* - `PAID`: The order is paid.
|
|
771
|
-
* - `OFFLINE_PENDING`: The order is confirmed but has to be paid in cash and the status is manually updated to `PAID`.
|
|
772
|
-
* - `INITIATED`: The order is awaiting for payment.
|
|
773
|
-
* - `CANCELED`: The order is canceled.
|
|
774
|
-
* - `DECLINED`: The order is payment is declined.
|
|
775
|
-
*/
|
|
750
|
+
/** Status. */
|
|
776
751
|
status?: OrderStatus[];
|
|
777
752
|
/**
|
|
778
|
-
* Event ID
|
|
753
|
+
* Event ID.
|
|
779
754
|
* @format GUID
|
|
780
755
|
* @maxSize 100
|
|
781
756
|
*/
|
|
@@ -793,13 +768,14 @@ interface ListOrdersRequest {
|
|
|
793
768
|
*/
|
|
794
769
|
memberId?: string[];
|
|
795
770
|
/**
|
|
796
|
-
* Field facets
|
|
771
|
+
* Field facets.
|
|
772
|
+
* See [supported facets](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-orders).
|
|
797
773
|
* @maxLength 100
|
|
798
774
|
* @maxSize 20
|
|
799
775
|
*/
|
|
800
776
|
facet?: string[];
|
|
801
777
|
/**
|
|
802
|
-
*
|
|
778
|
+
* Textual search filter - search is performed on "full_name", "email" and "order_number".
|
|
803
779
|
* @maxLength 200
|
|
804
780
|
*/
|
|
805
781
|
searchPhrase?: string;
|
|
@@ -810,8 +786,8 @@ interface ListOrdersRequest {
|
|
|
810
786
|
*/
|
|
811
787
|
eventCreatorId?: string[];
|
|
812
788
|
/**
|
|
813
|
-
* Sort order.
|
|
814
|
-
*
|
|
789
|
+
* Sort order. Defaults to "created:asc".
|
|
790
|
+
* See [supported fields](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-orders).
|
|
815
791
|
* @maxLength 100
|
|
816
792
|
*/
|
|
817
793
|
sort?: string;
|
|
@@ -824,7 +800,7 @@ interface ListOrdersRequest {
|
|
|
824
800
|
*/
|
|
825
801
|
contactId?: string[];
|
|
826
802
|
}
|
|
827
|
-
declare enum OrderFieldset {
|
|
803
|
+
export declare enum OrderFieldset {
|
|
828
804
|
/** Include tickets in response. */
|
|
829
805
|
TICKETS = "TICKETS",
|
|
830
806
|
/** Include order details in the response: `status`, `firstName`, `lastName`, `email`, `created`, etc. */
|
|
@@ -834,7 +810,7 @@ declare enum OrderFieldset {
|
|
|
834
810
|
/** Include `invoice` in the response. */
|
|
835
811
|
INVOICE = "INVOICE"
|
|
836
812
|
}
|
|
837
|
-
declare enum OrderTag {
|
|
813
|
+
export declare enum OrderTag {
|
|
838
814
|
/** Return only confirmed orders. */
|
|
839
815
|
CONFIRMED = "CONFIRMED",
|
|
840
816
|
/** Return only unconfirmed orders. */
|
|
@@ -850,7 +826,7 @@ declare enum OrderTag {
|
|
|
850
826
|
/** Return only orders with no guests checked-in. */
|
|
851
827
|
NOT_FULLY_CHECKED_IN = "NOT_FULLY_CHECKED_IN"
|
|
852
828
|
}
|
|
853
|
-
interface ListOrdersResponse {
|
|
829
|
+
export interface ListOrdersResponse {
|
|
854
830
|
/** Total orders matching the given filters. */
|
|
855
831
|
total?: number;
|
|
856
832
|
/** Offset. */
|
|
@@ -867,19 +843,19 @@ interface ListOrdersResponse {
|
|
|
867
843
|
/** Order data enriched facets. */
|
|
868
844
|
orderFacets?: OrderFacets;
|
|
869
845
|
}
|
|
870
|
-
interface FacetCounts {
|
|
846
|
+
export interface FacetCounts {
|
|
871
847
|
/** Facet counts aggregated per value. */
|
|
872
848
|
counts?: Record<string, number>;
|
|
873
849
|
}
|
|
874
|
-
interface OrderFacets {
|
|
850
|
+
export interface OrderFacets {
|
|
875
851
|
/** Filter facets. */
|
|
876
852
|
facets?: Record<string, OrderFacetCounts>;
|
|
877
853
|
}
|
|
878
|
-
interface OrderFacetCounts {
|
|
854
|
+
export interface OrderFacetCounts {
|
|
879
855
|
/** Facet counts aggregated per value */
|
|
880
856
|
counts?: Record<string, Counts>;
|
|
881
857
|
}
|
|
882
|
-
interface Counts {
|
|
858
|
+
export interface Counts {
|
|
883
859
|
/** Number or orders */
|
|
884
860
|
count?: number;
|
|
885
861
|
/** Number of tickets within orders */
|
|
@@ -887,9 +863,9 @@ interface Counts {
|
|
|
887
863
|
/** Number of tickets with check-in */
|
|
888
864
|
ticketsCheckIn?: number;
|
|
889
865
|
}
|
|
890
|
-
interface GetOrderRequest {
|
|
866
|
+
export interface GetOrderRequest {
|
|
891
867
|
/**
|
|
892
|
-
* Event ID
|
|
868
|
+
* Event ID.
|
|
893
869
|
* @format GUID
|
|
894
870
|
*/
|
|
895
871
|
eventId: string;
|
|
@@ -899,33 +875,26 @@ interface GetOrderRequest {
|
|
|
899
875
|
*/
|
|
900
876
|
orderNumber: string;
|
|
901
877
|
/**
|
|
902
|
-
*
|
|
903
|
-
* - `TICKETS`: Returns `tickets`.
|
|
904
|
-
* - `DETAILS`: Returns `reservationId`, `snapshotId`, `created`, `firstName`, `lastName`, `confirmed`, `status`, `method`, `ticketsQuantity`, `totalPrice`, `ticketsPdf`, `archived`, `fullName`.
|
|
905
|
-
* - `FORM` : Returns `checkoutForm`.
|
|
906
|
-
* - `INVOICE`: Returns `invoice`.
|
|
907
|
-
*
|
|
908
|
-
* Default: If `fieldset` is not included in the request, `orderNumber`, `eventId`, `contactId`, `memberId`, `anonymized`, `fullyCheckedIn` are returned.
|
|
909
|
-
*
|
|
878
|
+
* Controls which data is returned. See [Fieldset](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_order-fieldset).
|
|
910
879
|
* @maxSize 20
|
|
911
880
|
*/
|
|
912
881
|
fieldset?: OrderFieldset[];
|
|
913
882
|
}
|
|
914
|
-
interface GetOrderResponse {
|
|
883
|
+
export interface GetOrderResponse {
|
|
915
884
|
/** Requested order. */
|
|
916
885
|
order?: Order;
|
|
917
886
|
/** "Add to calendar" links. */
|
|
918
887
|
calendarLinks?: CalendarLinks;
|
|
919
888
|
}
|
|
920
|
-
interface CalendarLinks {
|
|
889
|
+
export interface CalendarLinks {
|
|
921
890
|
/** "Add to Google calendar" URL. */
|
|
922
891
|
google?: string;
|
|
923
892
|
/** "Download ICS calendar file" URL. */
|
|
924
893
|
ics?: string;
|
|
925
894
|
}
|
|
926
|
-
interface UpdateOrderRequest {
|
|
895
|
+
export interface UpdateOrderRequest {
|
|
927
896
|
/**
|
|
928
|
-
* Event ID
|
|
897
|
+
* Event ID.
|
|
929
898
|
* @format GUID
|
|
930
899
|
*/
|
|
931
900
|
eventId: string;
|
|
@@ -941,11 +910,11 @@ interface UpdateOrderRequest {
|
|
|
941
910
|
/** Whether order is archived. */
|
|
942
911
|
archived?: boolean;
|
|
943
912
|
}
|
|
944
|
-
interface UpdateOrderResponse {
|
|
913
|
+
export interface UpdateOrderResponse {
|
|
945
914
|
/** Updated order. */
|
|
946
915
|
order?: Order;
|
|
947
916
|
}
|
|
948
|
-
interface OrderUpdated {
|
|
917
|
+
export interface OrderUpdated {
|
|
949
918
|
/** Order updated timestamp in ISO UTC format. */
|
|
950
919
|
timestamp?: Date | null;
|
|
951
920
|
/**
|
|
@@ -959,7 +928,7 @@ interface OrderUpdated {
|
|
|
959
928
|
*/
|
|
960
929
|
locale?: string | null;
|
|
961
930
|
/**
|
|
962
|
-
* Event ID
|
|
931
|
+
* Event ID.
|
|
963
932
|
* @format GUID
|
|
964
933
|
*/
|
|
965
934
|
eventId?: string;
|
|
@@ -992,16 +961,7 @@ interface OrderUpdated {
|
|
|
992
961
|
checkoutForm?: FormResponse;
|
|
993
962
|
/** Whether order is confirmed - occurs once payment gateway processes the payment and funds reach merchant's account. */
|
|
994
963
|
confirmed?: boolean;
|
|
995
|
-
/**
|
|
996
|
-
* Order status. Possible values:
|
|
997
|
-
* - `FREE`: The order is confirmed, no payment is required.
|
|
998
|
-
* - `PENDING`: The order was paid, but the payment gateway suspended the payment.
|
|
999
|
-
* - `PAID`: The order is paid.
|
|
1000
|
-
* - `OFFLINE_PENDING`: The order is confirmed but has to be paid in cash and the status is manually updated to `PAID`.
|
|
1001
|
-
* - `INITIATED`: The order is awaiting for payment.
|
|
1002
|
-
* - `CANCELED`: The order is canceled.
|
|
1003
|
-
* - `DECLINED`: The order is payment is declined.
|
|
1004
|
-
*/
|
|
964
|
+
/** Order status. */
|
|
1005
965
|
status?: OrderStatus;
|
|
1006
966
|
/** Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc. */
|
|
1007
967
|
method?: string | null;
|
|
@@ -1012,9 +972,9 @@ interface OrderUpdated {
|
|
|
1012
972
|
/** Whether event was triggered by GDPR delete request. */
|
|
1013
973
|
triggeredByAnonymizeRequest?: boolean;
|
|
1014
974
|
}
|
|
1015
|
-
interface BulkUpdateOrdersRequest {
|
|
975
|
+
export interface BulkUpdateOrdersRequest {
|
|
1016
976
|
/**
|
|
1017
|
-
* Event ID
|
|
977
|
+
* Event ID.
|
|
1018
978
|
* @format GUID
|
|
1019
979
|
*/
|
|
1020
980
|
eventId: string;
|
|
@@ -1030,13 +990,13 @@ interface BulkUpdateOrdersRequest {
|
|
|
1030
990
|
/** Whether to archive the order. */
|
|
1031
991
|
archived?: boolean;
|
|
1032
992
|
}
|
|
1033
|
-
interface BulkUpdateOrdersResponse {
|
|
993
|
+
export interface BulkUpdateOrdersResponse {
|
|
1034
994
|
/** Updated orders. */
|
|
1035
995
|
orders?: Order[];
|
|
1036
996
|
}
|
|
1037
|
-
interface ConfirmOrderRequest {
|
|
997
|
+
export interface ConfirmOrderRequest {
|
|
1038
998
|
/**
|
|
1039
|
-
* Event ID
|
|
999
|
+
* Event ID.
|
|
1040
1000
|
* @format GUID
|
|
1041
1001
|
*/
|
|
1042
1002
|
eventId: string;
|
|
@@ -1048,22 +1008,22 @@ interface ConfirmOrderRequest {
|
|
|
1048
1008
|
*/
|
|
1049
1009
|
orderNumber?: string[];
|
|
1050
1010
|
}
|
|
1051
|
-
interface ConfirmOrderResponse {
|
|
1011
|
+
export interface ConfirmOrderResponse {
|
|
1052
1012
|
/** Confirmed orders. */
|
|
1053
1013
|
orders?: Order[];
|
|
1054
1014
|
}
|
|
1055
|
-
interface GetSummaryRequest {
|
|
1015
|
+
export interface GetSummaryRequest {
|
|
1056
1016
|
/**
|
|
1057
1017
|
* Event ID.
|
|
1058
1018
|
* @format GUID
|
|
1059
1019
|
*/
|
|
1060
1020
|
eventId?: string | null;
|
|
1061
1021
|
}
|
|
1062
|
-
interface GetSummaryResponse {
|
|
1022
|
+
export interface GetSummaryResponse {
|
|
1063
1023
|
/** Ticket sales grouped by currency. */
|
|
1064
1024
|
sales?: TicketSales[];
|
|
1065
1025
|
}
|
|
1066
|
-
interface TicketSales {
|
|
1026
|
+
export interface TicketSales {
|
|
1067
1027
|
/** Total balance of confirmed transactions. */
|
|
1068
1028
|
total?: Money;
|
|
1069
1029
|
/** Total number of confirmed orders. */
|
|
@@ -1073,25 +1033,25 @@ interface TicketSales {
|
|
|
1073
1033
|
/** Total revenue, excluding fees (taxes and payment provider fees are not deducted). */
|
|
1074
1034
|
revenue?: Money;
|
|
1075
1035
|
}
|
|
1076
|
-
interface GetInvoicePreviewRequest {
|
|
1036
|
+
export interface GetInvoicePreviewRequest {
|
|
1077
1037
|
/**
|
|
1078
|
-
* Event ID
|
|
1038
|
+
* Event ID.
|
|
1079
1039
|
* @format GUID
|
|
1080
1040
|
*/
|
|
1081
1041
|
eventId?: string;
|
|
1082
1042
|
/** Order number. */
|
|
1083
1043
|
orderNumber?: string;
|
|
1084
1044
|
}
|
|
1085
|
-
interface RawHttpResponse {
|
|
1045
|
+
export interface RawHttpResponse {
|
|
1086
1046
|
body?: Uint8Array;
|
|
1087
1047
|
statusCode?: number | null;
|
|
1088
1048
|
headers?: HeadersEntry[];
|
|
1089
1049
|
}
|
|
1090
|
-
interface HeadersEntry {
|
|
1050
|
+
export interface HeadersEntry {
|
|
1091
1051
|
key?: string;
|
|
1092
1052
|
value?: string;
|
|
1093
1053
|
}
|
|
1094
|
-
interface GetPaymentInfoRequest {
|
|
1054
|
+
export interface GetPaymentInfoRequest {
|
|
1095
1055
|
/**
|
|
1096
1056
|
* Event ID.
|
|
1097
1057
|
* @format GUID
|
|
@@ -1100,7 +1060,7 @@ interface GetPaymentInfoRequest {
|
|
|
1100
1060
|
/** Order number. */
|
|
1101
1061
|
orderNumber?: string;
|
|
1102
1062
|
}
|
|
1103
|
-
interface GetPaymentInfoResponse {
|
|
1063
|
+
export interface GetPaymentInfoResponse {
|
|
1104
1064
|
transactions?: PaymentTransactionSummary[];
|
|
1105
1065
|
status?: string | null;
|
|
1106
1066
|
/**
|
|
@@ -1109,7 +1069,7 @@ interface GetPaymentInfoResponse {
|
|
|
1109
1069
|
*/
|
|
1110
1070
|
transactionId?: string | null;
|
|
1111
1071
|
}
|
|
1112
|
-
interface PaymentTransactionSummary {
|
|
1072
|
+
export interface PaymentTransactionSummary {
|
|
1113
1073
|
/**
|
|
1114
1074
|
* Wix Payments transaction id
|
|
1115
1075
|
* @format GUID
|
|
@@ -1124,7 +1084,7 @@ interface PaymentTransactionSummary {
|
|
|
1124
1084
|
/** Transaction events */
|
|
1125
1085
|
events?: PaymentTransactionEvent[];
|
|
1126
1086
|
}
|
|
1127
|
-
interface PaymentTransactionEvent {
|
|
1087
|
+
export interface PaymentTransactionEvent {
|
|
1128
1088
|
/**
|
|
1129
1089
|
* Order snapshot id
|
|
1130
1090
|
* @format GUID
|
|
@@ -1150,7 +1110,7 @@ interface PaymentTransactionEvent {
|
|
|
1150
1110
|
* Crated date
|
|
1151
1111
|
* @readonly
|
|
1152
1112
|
*/
|
|
1153
|
-
|
|
1113
|
+
createdDate?: Date | null;
|
|
1154
1114
|
/**
|
|
1155
1115
|
* Reason code
|
|
1156
1116
|
* @readonly
|
|
@@ -1162,7 +1122,7 @@ interface PaymentTransactionEvent {
|
|
|
1162
1122
|
*/
|
|
1163
1123
|
refundedAmount?: Money;
|
|
1164
1124
|
}
|
|
1165
|
-
interface CaptureAuthorizedPaymentRequest {
|
|
1125
|
+
export interface CaptureAuthorizedPaymentRequest {
|
|
1166
1126
|
/**
|
|
1167
1127
|
* Event ID.
|
|
1168
1128
|
* @format GUID
|
|
@@ -1175,9 +1135,9 @@ interface CaptureAuthorizedPaymentRequest {
|
|
|
1175
1135
|
*/
|
|
1176
1136
|
orderNumber: string;
|
|
1177
1137
|
}
|
|
1178
|
-
interface CaptureAuthorizedPaymentResponse {
|
|
1138
|
+
export interface CaptureAuthorizedPaymentResponse {
|
|
1179
1139
|
}
|
|
1180
|
-
interface VoidAuthorizedPaymentRequest {
|
|
1140
|
+
export interface VoidAuthorizedPaymentRequest {
|
|
1181
1141
|
/**
|
|
1182
1142
|
* Event ID.
|
|
1183
1143
|
* @format GUID
|
|
@@ -1190,9 +1150,9 @@ interface VoidAuthorizedPaymentRequest {
|
|
|
1190
1150
|
*/
|
|
1191
1151
|
orderNumber: string;
|
|
1192
1152
|
}
|
|
1193
|
-
interface VoidAuthorizedPaymentResponse {
|
|
1153
|
+
export interface VoidAuthorizedPaymentResponse {
|
|
1194
1154
|
}
|
|
1195
|
-
interface MessageEnvelope {
|
|
1155
|
+
export interface MessageEnvelope {
|
|
1196
1156
|
/**
|
|
1197
1157
|
* App instance ID.
|
|
1198
1158
|
* @format GUID
|
|
@@ -1208,7 +1168,7 @@ interface MessageEnvelope {
|
|
|
1208
1168
|
/** Stringify payload. */
|
|
1209
1169
|
data?: string;
|
|
1210
1170
|
}
|
|
1211
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1171
|
+
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1212
1172
|
/**
|
|
1213
1173
|
* ID of a site visitor that has not logged in to the site.
|
|
1214
1174
|
* @format GUID
|
|
@@ -1233,7 +1193,7 @@ interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
1233
1193
|
identityType?: WebhookIdentityType;
|
|
1234
1194
|
}
|
|
1235
1195
|
/** @oneof */
|
|
1236
|
-
interface IdentificationDataIdOneOf {
|
|
1196
|
+
export interface IdentificationDataIdOneOf {
|
|
1237
1197
|
/**
|
|
1238
1198
|
* ID of a site visitor that has not logged in to the site.
|
|
1239
1199
|
* @format GUID
|
|
@@ -1255,14 +1215,14 @@ interface IdentificationDataIdOneOf {
|
|
|
1255
1215
|
*/
|
|
1256
1216
|
appId?: string;
|
|
1257
1217
|
}
|
|
1258
|
-
declare enum WebhookIdentityType {
|
|
1218
|
+
export declare enum WebhookIdentityType {
|
|
1259
1219
|
UNKNOWN = "UNKNOWN",
|
|
1260
1220
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1261
1221
|
MEMBER = "MEMBER",
|
|
1262
1222
|
WIX_USER = "WIX_USER",
|
|
1263
1223
|
APP = "APP"
|
|
1264
1224
|
}
|
|
1265
|
-
interface OrderConfirmed {
|
|
1225
|
+
export interface OrderConfirmed {
|
|
1266
1226
|
/** Order confirmation timestamp in ISO UTC. */
|
|
1267
1227
|
timestamp?: Date | null;
|
|
1268
1228
|
/**
|
|
@@ -1278,7 +1238,7 @@ interface OrderConfirmed {
|
|
|
1278
1238
|
*/
|
|
1279
1239
|
locale?: string | null;
|
|
1280
1240
|
/**
|
|
1281
|
-
* Event ID
|
|
1241
|
+
* Event ID.
|
|
1282
1242
|
* @format GUID
|
|
1283
1243
|
*/
|
|
1284
1244
|
eventId?: string;
|
|
@@ -1304,16 +1264,7 @@ interface OrderConfirmed {
|
|
|
1304
1264
|
email?: string;
|
|
1305
1265
|
/** Checkout form response. */
|
|
1306
1266
|
checkoutForm?: FormResponse;
|
|
1307
|
-
/**
|
|
1308
|
-
* Order status. Possible values:
|
|
1309
|
-
* - `FREE`: The order is confirmed, no payment is required.
|
|
1310
|
-
* - `PENDING`: The order was paid, but the payment gateway suspended the payment.
|
|
1311
|
-
* - `PAID`: The order is paid.
|
|
1312
|
-
* - `OFFLINE_PENDING`: The order is confirmed but has to be paid in cash and the status is manually updated to `PAID`.
|
|
1313
|
-
* - `INITIATED`: The order is awaiting for payment.
|
|
1314
|
-
* - `CANCELED`: The order is canceled.
|
|
1315
|
-
* - `DECLINED`: The order is payment is declined.
|
|
1316
|
-
*/
|
|
1267
|
+
/** Order status. */
|
|
1317
1268
|
status?: OrderStatus;
|
|
1318
1269
|
/** Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc. */
|
|
1319
1270
|
method?: string | null;
|
|
@@ -1324,7 +1275,7 @@ interface OrderConfirmed {
|
|
|
1324
1275
|
/** Reservation ID associated with this order. */
|
|
1325
1276
|
reservationId?: string;
|
|
1326
1277
|
}
|
|
1327
|
-
interface OrderPaid {
|
|
1278
|
+
export interface OrderPaid {
|
|
1328
1279
|
/** Order paid timestamp in ISO UTC. */
|
|
1329
1280
|
timestamp?: Date | null;
|
|
1330
1281
|
/**
|
|
@@ -1340,7 +1291,7 @@ interface OrderPaid {
|
|
|
1340
1291
|
*/
|
|
1341
1292
|
locale?: string | null;
|
|
1342
1293
|
/**
|
|
1343
|
-
* Event ID
|
|
1294
|
+
* Event ID.
|
|
1344
1295
|
* @format GUID
|
|
1345
1296
|
*/
|
|
1346
1297
|
eventId?: string;
|
|
@@ -1395,11 +1346,11 @@ interface OrderPaid {
|
|
|
1395
1346
|
/** Invoice. */
|
|
1396
1347
|
invoice?: Invoice;
|
|
1397
1348
|
}
|
|
1398
|
-
interface ReservationCreated {
|
|
1349
|
+
export interface ReservationCreated {
|
|
1399
1350
|
/** Reservation created timestamp in ISO UTC format. */
|
|
1400
1351
|
timestamp?: Date | null;
|
|
1401
1352
|
/**
|
|
1402
|
-
* Event ID
|
|
1353
|
+
* Event ID.
|
|
1403
1354
|
* @format GUID
|
|
1404
1355
|
*/
|
|
1405
1356
|
eventId?: string;
|
|
@@ -1419,14 +1370,14 @@ interface ReservationCreated {
|
|
|
1419
1370
|
*/
|
|
1420
1371
|
quantities?: TicketQuantity[];
|
|
1421
1372
|
/** Reservation update timestamp. */
|
|
1422
|
-
|
|
1373
|
+
updatedDate?: Date | null;
|
|
1423
1374
|
/**
|
|
1424
1375
|
* Reservation counts.
|
|
1425
1376
|
* @maxSize 50
|
|
1426
1377
|
*/
|
|
1427
1378
|
counts?: ReservationCount[];
|
|
1428
1379
|
}
|
|
1429
|
-
declare enum ReservationStatus {
|
|
1380
|
+
export declare enum ReservationStatus {
|
|
1430
1381
|
/** The Reservation is pending confirmation and will expire after the expiration due time. */
|
|
1431
1382
|
RESERVATION_PENDING = "RESERVATION_PENDING",
|
|
1432
1383
|
/** The reservation is confirmed and will not expire. */
|
|
@@ -1438,7 +1389,7 @@ declare enum ReservationStatus {
|
|
|
1438
1389
|
/** The reservation is expired. */
|
|
1439
1390
|
RESERVATION_EXPIRED = "RESERVATION_EXPIRED"
|
|
1440
1391
|
}
|
|
1441
|
-
interface TicketQuantity {
|
|
1392
|
+
export interface TicketQuantity {
|
|
1442
1393
|
/**
|
|
1443
1394
|
* Ticket definition ID.
|
|
1444
1395
|
* @format GUID
|
|
@@ -1447,9 +1398,9 @@ interface TicketQuantity {
|
|
|
1447
1398
|
/** Quantity. */
|
|
1448
1399
|
quantity?: number | null;
|
|
1449
1400
|
/** Quantity update timestamp. */
|
|
1450
|
-
|
|
1401
|
+
updatedDate?: Date | null;
|
|
1451
1402
|
}
|
|
1452
|
-
interface ReservationCount {
|
|
1403
|
+
export interface ReservationCount {
|
|
1453
1404
|
/** Reservation Count snapshot timestamp. */
|
|
1454
1405
|
timestamp?: Date | null;
|
|
1455
1406
|
/**
|
|
@@ -1464,11 +1415,11 @@ interface ReservationCount {
|
|
|
1464
1415
|
/** True if paid ticket reservation exist. */
|
|
1465
1416
|
paidExists?: boolean;
|
|
1466
1417
|
}
|
|
1467
|
-
interface ReservationUpdated {
|
|
1418
|
+
export interface ReservationUpdated {
|
|
1468
1419
|
/** Reservation updated timestamp. */
|
|
1469
1420
|
timestamp?: Date | null;
|
|
1470
1421
|
/**
|
|
1471
|
-
* Event ID
|
|
1422
|
+
* Event ID.
|
|
1472
1423
|
* @format GUID
|
|
1473
1424
|
*/
|
|
1474
1425
|
eventId?: string;
|
|
@@ -1488,16 +1439,16 @@ interface ReservationUpdated {
|
|
|
1488
1439
|
*/
|
|
1489
1440
|
quantities?: TicketQuantity[];
|
|
1490
1441
|
/** Reservation update timestamp. */
|
|
1491
|
-
|
|
1442
|
+
updatedDate?: Date | null;
|
|
1492
1443
|
/**
|
|
1493
1444
|
* Reservation counts.
|
|
1494
1445
|
* @maxSize 50
|
|
1495
1446
|
*/
|
|
1496
1447
|
counts?: ReservationCount[];
|
|
1497
1448
|
}
|
|
1498
|
-
interface GetCheckoutOptionsRequest {
|
|
1449
|
+
export interface GetCheckoutOptionsRequest {
|
|
1499
1450
|
}
|
|
1500
|
-
interface GetCheckoutOptionsResponse {
|
|
1451
|
+
export interface GetCheckoutOptionsResponse {
|
|
1501
1452
|
/** Whether any payment method is configured and available for payment. */
|
|
1502
1453
|
paymentMethodConfigured?: boolean;
|
|
1503
1454
|
/** Whether coupons are accepted at checkout. */
|
|
@@ -1509,7 +1460,7 @@ interface GetCheckoutOptionsResponse {
|
|
|
1509
1460
|
/** Whether gift cards are accepted at checkout. */
|
|
1510
1461
|
acceptGiftCards?: boolean;
|
|
1511
1462
|
}
|
|
1512
|
-
interface ListAvailableTicketsRequest {
|
|
1463
|
+
export interface ListAvailableTicketsRequest {
|
|
1513
1464
|
/**
|
|
1514
1465
|
* Event ID. If not provided, available tickets for all events in the site will be returned.
|
|
1515
1466
|
* @format GUID
|
|
@@ -1523,23 +1474,23 @@ interface ListAvailableTicketsRequest {
|
|
|
1523
1474
|
*/
|
|
1524
1475
|
limit?: number;
|
|
1525
1476
|
/**
|
|
1526
|
-
* Sort order.
|
|
1527
|
-
*
|
|
1477
|
+
* Sort order, defaults to "created:asc".
|
|
1478
|
+
* See [supported fields](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-available-tickets).
|
|
1528
1479
|
* @maxLength 100
|
|
1529
1480
|
*/
|
|
1530
1481
|
sort?: string;
|
|
1531
1482
|
state?: State[];
|
|
1532
1483
|
}
|
|
1533
|
-
declare enum State {
|
|
1484
|
+
export declare enum State {
|
|
1534
1485
|
INCLUDE_HIDDEN_NOT_ON_SALE = "INCLUDE_HIDDEN_NOT_ON_SALE"
|
|
1535
1486
|
}
|
|
1536
|
-
interface ListAvailableTicketsResponse {
|
|
1487
|
+
export interface ListAvailableTicketsResponse {
|
|
1537
1488
|
/** Ticket definitions meta data. */
|
|
1538
1489
|
metaData?: ResponseMetaData;
|
|
1539
1490
|
/** Ticket definitions. */
|
|
1540
1491
|
definitions?: TicketDefinition[];
|
|
1541
1492
|
}
|
|
1542
|
-
interface ResponseMetaData {
|
|
1493
|
+
export interface ResponseMetaData {
|
|
1543
1494
|
/** Number of items in the response. */
|
|
1544
1495
|
count?: number;
|
|
1545
1496
|
/** Offset of items. */
|
|
@@ -1547,12 +1498,12 @@ interface ResponseMetaData {
|
|
|
1547
1498
|
/** Total number of matching items. */
|
|
1548
1499
|
total?: number;
|
|
1549
1500
|
}
|
|
1550
|
-
interface TicketDefinition {
|
|
1501
|
+
export interface TicketDefinition {
|
|
1551
1502
|
/**
|
|
1552
1503
|
* Ticket definition ID.
|
|
1553
1504
|
* @format GUID
|
|
1554
1505
|
*/
|
|
1555
|
-
|
|
1506
|
+
id?: string;
|
|
1556
1507
|
/** Ticket price. */
|
|
1557
1508
|
price?: Money;
|
|
1558
1509
|
/** Whether the ticket is free (read only). */
|
|
@@ -1562,13 +1513,14 @@ interface TicketDefinition {
|
|
|
1562
1513
|
/** Ticket description. */
|
|
1563
1514
|
description?: string;
|
|
1564
1515
|
/**
|
|
1565
|
-
* Limit of tickets that can be purchased per checkout.
|
|
1516
|
+
* Limit of tickets that can be purchased per checkout.
|
|
1517
|
+
* Set to 20 for unlimited ticket definition.
|
|
1566
1518
|
* @max 20
|
|
1567
1519
|
*/
|
|
1568
1520
|
limitPerCheckout?: number;
|
|
1569
1521
|
/** Custom sort index. */
|
|
1570
1522
|
orderIndex?: number;
|
|
1571
|
-
/**
|
|
1523
|
+
/** Policy information plain text block, as printed on the ticket. */
|
|
1572
1524
|
policy?: string;
|
|
1573
1525
|
/** Sensitive dashboard data. */
|
|
1574
1526
|
dashboard?: Dashboard;
|
|
@@ -1594,7 +1546,7 @@ interface TicketDefinition {
|
|
|
1594
1546
|
/** Ticket pricing. */
|
|
1595
1547
|
pricing?: TicketPricing;
|
|
1596
1548
|
}
|
|
1597
|
-
interface Dashboard {
|
|
1549
|
+
export interface Dashboard {
|
|
1598
1550
|
/** Whether ticket is hidden and cannot be sold. */
|
|
1599
1551
|
hidden?: boolean;
|
|
1600
1552
|
/**
|
|
@@ -1604,20 +1556,20 @@ interface Dashboard {
|
|
|
1604
1556
|
sold?: number;
|
|
1605
1557
|
/** Whether the ticket has limited quantity. */
|
|
1606
1558
|
limited?: boolean;
|
|
1607
|
-
/** Ticket limit. `NULL`
|
|
1559
|
+
/** Ticket limit. `NULL` for unlimited ticket definitions. */
|
|
1608
1560
|
quantity?: number | null;
|
|
1609
|
-
/** Number of unsold tickets. `NULL`
|
|
1561
|
+
/** Number of unsold tickets. `NULL` for unlimited ticket definitions. */
|
|
1610
1562
|
unsold?: number | null;
|
|
1611
1563
|
/** Number of tickets sold. */
|
|
1612
1564
|
ticketsSold?: number;
|
|
1613
1565
|
/** Number of tickets reserved. */
|
|
1614
1566
|
ticketsReserved?: number;
|
|
1615
1567
|
}
|
|
1616
|
-
interface WixFeeConfig {
|
|
1568
|
+
export interface WixFeeConfig {
|
|
1617
1569
|
/** Fee calculation method. */
|
|
1618
1570
|
type?: FeeType;
|
|
1619
1571
|
}
|
|
1620
|
-
interface TicketSalePeriod {
|
|
1572
|
+
export interface TicketSalePeriod {
|
|
1621
1573
|
/** Ticket sale start timestamp. */
|
|
1622
1574
|
startDate?: Date | null;
|
|
1623
1575
|
/** Ticket sale end timestamp. */
|
|
@@ -1625,7 +1577,7 @@ interface TicketSalePeriod {
|
|
|
1625
1577
|
/** Whether to hide this ticket if it's not on sale */
|
|
1626
1578
|
hideNotOnSale?: boolean;
|
|
1627
1579
|
}
|
|
1628
|
-
declare enum TicketSaleStatus {
|
|
1580
|
+
export declare enum TicketSaleStatus {
|
|
1629
1581
|
/** Ticket sale is scheduled to start. */
|
|
1630
1582
|
SALE_SCHEDULED = "SALE_SCHEDULED",
|
|
1631
1583
|
/** Ticket sale has started. */
|
|
@@ -1633,7 +1585,7 @@ declare enum TicketSaleStatus {
|
|
|
1633
1585
|
/** Ticket sale has ended. */
|
|
1634
1586
|
SALE_ENDED = "SALE_ENDED"
|
|
1635
1587
|
}
|
|
1636
|
-
interface TicketPricing extends TicketPricingPriceOneOf {
|
|
1588
|
+
export interface TicketPricing extends TicketPricingPriceOneOf {
|
|
1637
1589
|
/** Ticket price which is read only. */
|
|
1638
1590
|
fixedPrice?: Money;
|
|
1639
1591
|
/** Min price per ticket, customizable. */
|
|
@@ -1647,7 +1599,7 @@ interface TicketPricing extends TicketPricingPriceOneOf {
|
|
|
1647
1599
|
pricingType?: Type;
|
|
1648
1600
|
}
|
|
1649
1601
|
/** @oneof */
|
|
1650
|
-
interface TicketPricingPriceOneOf {
|
|
1602
|
+
export interface TicketPricingPriceOneOf {
|
|
1651
1603
|
/** Ticket price which is read only. */
|
|
1652
1604
|
fixedPrice?: Money;
|
|
1653
1605
|
/** Min price per ticket, customizable. */
|
|
@@ -1655,16 +1607,16 @@ interface TicketPricingPriceOneOf {
|
|
|
1655
1607
|
/** Ticket pricing options. */
|
|
1656
1608
|
pricingOptions?: PricingOptions;
|
|
1657
1609
|
}
|
|
1658
|
-
interface PricingOptions {
|
|
1610
|
+
export interface PricingOptions {
|
|
1659
1611
|
/** Multiple ticket pricing options. */
|
|
1660
1612
|
options?: PricingOption[];
|
|
1661
1613
|
}
|
|
1662
|
-
interface PricingOption {
|
|
1614
|
+
export interface PricingOption {
|
|
1663
1615
|
/**
|
|
1664
1616
|
* Ticket pricing option ID.
|
|
1665
1617
|
* @format GUID
|
|
1666
1618
|
*/
|
|
1667
|
-
|
|
1619
|
+
id?: string | null;
|
|
1668
1620
|
/**
|
|
1669
1621
|
* Ticket pricing option name.
|
|
1670
1622
|
* @minLength 1
|
|
@@ -1674,11 +1626,11 @@ interface PricingOption {
|
|
|
1674
1626
|
/** Ticket pricing option price. */
|
|
1675
1627
|
price?: Money;
|
|
1676
1628
|
}
|
|
1677
|
-
declare enum Type {
|
|
1629
|
+
export declare enum Type {
|
|
1678
1630
|
STANDARD = "STANDARD",
|
|
1679
1631
|
DONATION = "DONATION"
|
|
1680
1632
|
}
|
|
1681
|
-
interface QueryAvailableTicketsRequest {
|
|
1633
|
+
export interface QueryAvailableTicketsRequest {
|
|
1682
1634
|
/** Offset. */
|
|
1683
1635
|
offset?: number;
|
|
1684
1636
|
/**
|
|
@@ -1686,32 +1638,35 @@ interface QueryAvailableTicketsRequest {
|
|
|
1686
1638
|
* @max 1000
|
|
1687
1639
|
*/
|
|
1688
1640
|
limit?: number;
|
|
1689
|
-
/**
|
|
1641
|
+
/**
|
|
1642
|
+
* Ticket definition.
|
|
1643
|
+
* See [supported fields and operators](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-available-tickets).
|
|
1644
|
+
*/
|
|
1690
1645
|
filter?: Record<string, any> | null;
|
|
1691
1646
|
/** @maxSize 20 */
|
|
1692
1647
|
fieldset?: TicketDefinitionFieldset[];
|
|
1693
1648
|
/**
|
|
1694
|
-
* Sort order.
|
|
1695
|
-
*
|
|
1649
|
+
* Sort order, defaults to "created:asc".
|
|
1650
|
+
* See [supported fields](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-available-tickets).
|
|
1696
1651
|
* @maxLength 100
|
|
1697
1652
|
*/
|
|
1698
1653
|
sort?: string;
|
|
1699
1654
|
}
|
|
1700
|
-
declare enum TicketDefinitionFieldset {
|
|
1655
|
+
export declare enum TicketDefinitionFieldset {
|
|
1701
1656
|
/** Include `policy` in the response. */
|
|
1702
1657
|
POLICY = "POLICY",
|
|
1703
1658
|
/** Include `dashboard` in the response. */
|
|
1704
1659
|
DASHBOARD = "DASHBOARD"
|
|
1705
1660
|
}
|
|
1706
|
-
interface QueryAvailableTicketsResponse {
|
|
1661
|
+
export interface QueryAvailableTicketsResponse {
|
|
1707
1662
|
/** Ticket definitions meta data. */
|
|
1708
1663
|
metaData?: ResponseMetaData;
|
|
1709
1664
|
/** Ticket definitions. */
|
|
1710
1665
|
definitions?: TicketDefinition[];
|
|
1711
1666
|
}
|
|
1712
|
-
interface CreateReservationRequest {
|
|
1667
|
+
export interface CreateReservationRequest {
|
|
1713
1668
|
/**
|
|
1714
|
-
* Event ID
|
|
1669
|
+
* Event ID.
|
|
1715
1670
|
* @format GUID
|
|
1716
1671
|
*/
|
|
1717
1672
|
eventId: string;
|
|
@@ -1726,7 +1681,7 @@ interface CreateReservationRequest {
|
|
|
1726
1681
|
/** Whether to allow reservation for hidden tickets. */
|
|
1727
1682
|
allowHiddenTickets?: boolean;
|
|
1728
1683
|
}
|
|
1729
|
-
interface TicketReservationQuantity {
|
|
1684
|
+
export interface TicketReservationQuantity {
|
|
1730
1685
|
/**
|
|
1731
1686
|
* Ticket definition ID.
|
|
1732
1687
|
* @format GUID
|
|
@@ -1739,7 +1694,7 @@ interface TicketReservationQuantity {
|
|
|
1739
1694
|
*/
|
|
1740
1695
|
quantity?: number;
|
|
1741
1696
|
/**
|
|
1742
|
-
*
|
|
1697
|
+
* Ticket price to charge - overriding the ticket price.
|
|
1743
1698
|
* @maxLength 13
|
|
1744
1699
|
* @format DECIMAL_VALUE
|
|
1745
1700
|
*/
|
|
@@ -1747,12 +1702,12 @@ interface TicketReservationQuantity {
|
|
|
1747
1702
|
/** Optional ticket details */
|
|
1748
1703
|
ticketDetails?: TicketDetails[];
|
|
1749
1704
|
}
|
|
1750
|
-
interface CreateReservationResponse {
|
|
1705
|
+
export interface CreateReservationResponse {
|
|
1751
1706
|
/**
|
|
1752
1707
|
* Reservation ID.
|
|
1753
1708
|
* @format GUID
|
|
1754
1709
|
*/
|
|
1755
|
-
|
|
1710
|
+
id?: string;
|
|
1756
1711
|
/** Reservation expiration timestamp. */
|
|
1757
1712
|
expires?: Date | null;
|
|
1758
1713
|
/** Ticket reservations. */
|
|
@@ -1762,21 +1717,20 @@ interface CreateReservationResponse {
|
|
|
1762
1717
|
/** Reservation status. */
|
|
1763
1718
|
reservationStatus?: ReservationStatus;
|
|
1764
1719
|
}
|
|
1765
|
-
interface TicketReservation {
|
|
1720
|
+
export interface TicketReservation {
|
|
1766
1721
|
/**
|
|
1767
1722
|
* Quantity of reserved tickets.
|
|
1768
1723
|
* @min 1
|
|
1769
1724
|
* @max 20
|
|
1770
1725
|
*/
|
|
1771
1726
|
quantity?: number;
|
|
1772
|
-
/** An object containing ticket information. */
|
|
1773
1727
|
ticket?: TicketDefinition;
|
|
1774
1728
|
/** Optional ticket details. */
|
|
1775
1729
|
ticketDetails?: TicketDetails[];
|
|
1776
1730
|
}
|
|
1777
|
-
interface CancelReservationRequest {
|
|
1731
|
+
export interface CancelReservationRequest {
|
|
1778
1732
|
/**
|
|
1779
|
-
* Event ID
|
|
1733
|
+
* Event ID.
|
|
1780
1734
|
* @format GUID
|
|
1781
1735
|
*/
|
|
1782
1736
|
eventId: string;
|
|
@@ -1784,13 +1738,13 @@ interface CancelReservationRequest {
|
|
|
1784
1738
|
* Reservation ID.
|
|
1785
1739
|
* @format GUID
|
|
1786
1740
|
*/
|
|
1787
|
-
|
|
1741
|
+
id: string;
|
|
1788
1742
|
}
|
|
1789
|
-
interface CancelReservationResponse {
|
|
1743
|
+
export interface CancelReservationResponse {
|
|
1790
1744
|
}
|
|
1791
|
-
interface GetInvoiceRequest {
|
|
1745
|
+
export interface GetInvoiceRequest {
|
|
1792
1746
|
/**
|
|
1793
|
-
* Event ID
|
|
1747
|
+
* Event ID.
|
|
1794
1748
|
* @format GUID
|
|
1795
1749
|
*/
|
|
1796
1750
|
eventId: string;
|
|
@@ -1804,14 +1758,14 @@ interface GetInvoiceRequest {
|
|
|
1804
1758
|
/** Optional benefit granted by the pricing plan to be applied on the returned invoice. */
|
|
1805
1759
|
paidPlanBenefit?: PaidPlanBenefit;
|
|
1806
1760
|
}
|
|
1807
|
-
interface DiscountRequest {
|
|
1761
|
+
export interface DiscountRequest {
|
|
1808
1762
|
/**
|
|
1809
1763
|
* Discount coupon code.
|
|
1810
1764
|
* @maxLength 20
|
|
1811
1765
|
*/
|
|
1812
1766
|
couponCode?: string;
|
|
1813
1767
|
}
|
|
1814
|
-
interface PaidPlanBenefit {
|
|
1768
|
+
export interface PaidPlanBenefit {
|
|
1815
1769
|
/**
|
|
1816
1770
|
* Pricing plan ID.
|
|
1817
1771
|
* @format GUID
|
|
@@ -1823,49 +1777,41 @@ interface PaidPlanBenefit {
|
|
|
1823
1777
|
*/
|
|
1824
1778
|
benefitId?: string;
|
|
1825
1779
|
}
|
|
1826
|
-
interface GetInvoiceResponse {
|
|
1780
|
+
export interface GetInvoiceResponse {
|
|
1827
1781
|
/** Invoice with applied discount. */
|
|
1828
1782
|
invoice?: Invoice;
|
|
1829
1783
|
/** Discount errors, if relevant. */
|
|
1830
1784
|
discountErrors?: DiscountErrors;
|
|
1831
|
-
/**
|
|
1785
|
+
/** Time when the reservation expires. */
|
|
1832
1786
|
expires?: Date | null;
|
|
1833
|
-
/**
|
|
1834
|
-
* Reservation status. Possible values:
|
|
1835
|
-
* - `RESERVATION_PENDING`: The reservation is pending confirmation. It will expire after a certain amount of time.
|
|
1836
|
-
* - `RESERVATION_CONFIRMED`: The reservation is confirmed and will not expire.
|
|
1837
|
-
* - `RESERVATION_CANCELED`: The reservation is canceled because it's not paid.
|
|
1838
|
-
* - `RESERVATION_CANCELED_MANUALLY`: The reservation is canceled manually by the buyer.
|
|
1839
|
-
* - `RESERVATION_EXPIRED`: The reservation has expired.
|
|
1840
|
-
*/
|
|
1787
|
+
/** Reservation status. */
|
|
1841
1788
|
reservationStatus?: ReservationStatus;
|
|
1842
1789
|
/** Whether this reservation is already used in checkout. */
|
|
1843
1790
|
reservationOccupied?: boolean;
|
|
1844
1791
|
/** Ticket reservations. */
|
|
1845
1792
|
reservations?: TicketReservation[];
|
|
1846
1793
|
}
|
|
1847
|
-
interface DiscountErrors {
|
|
1848
|
-
/**
|
|
1794
|
+
export interface DiscountErrors {
|
|
1795
|
+
/** Error. */
|
|
1849
1796
|
error?: Error[];
|
|
1850
1797
|
}
|
|
1851
|
-
interface Error {
|
|
1852
|
-
/** A code identifying the error type. */
|
|
1798
|
+
export interface Error {
|
|
1853
1799
|
code?: string;
|
|
1854
1800
|
}
|
|
1855
|
-
interface GiftCardErrors {
|
|
1801
|
+
export interface GiftCardErrors {
|
|
1856
1802
|
/**
|
|
1857
1803
|
* Error.
|
|
1858
1804
|
* @maxSize 10
|
|
1859
1805
|
*/
|
|
1860
1806
|
error?: GiftCardErrorsError[];
|
|
1861
1807
|
}
|
|
1862
|
-
interface GiftCardErrorsError {
|
|
1808
|
+
export interface GiftCardErrorsError {
|
|
1863
1809
|
/** @maxLength 100 */
|
|
1864
1810
|
code?: string;
|
|
1865
1811
|
}
|
|
1866
|
-
interface CheckoutRequest {
|
|
1812
|
+
export interface CheckoutRequest {
|
|
1867
1813
|
/**
|
|
1868
|
-
* Event ID
|
|
1814
|
+
* Event ID.
|
|
1869
1815
|
* @format GUID
|
|
1870
1816
|
*/
|
|
1871
1817
|
eventId: string;
|
|
@@ -1893,7 +1839,7 @@ interface CheckoutRequest {
|
|
|
1893
1839
|
/** Whether marketing consent was given */
|
|
1894
1840
|
marketingConsent?: boolean | null;
|
|
1895
1841
|
}
|
|
1896
|
-
interface Buyer {
|
|
1842
|
+
export interface Buyer {
|
|
1897
1843
|
/**
|
|
1898
1844
|
* Buyer first name.
|
|
1899
1845
|
* @minLength 1
|
|
@@ -1914,11 +1860,11 @@ interface Buyer {
|
|
|
1914
1860
|
*/
|
|
1915
1861
|
email?: string;
|
|
1916
1862
|
}
|
|
1917
|
-
interface Guest {
|
|
1863
|
+
export interface Guest {
|
|
1918
1864
|
/** Specific guest info. */
|
|
1919
1865
|
form?: FormResponse;
|
|
1920
1866
|
}
|
|
1921
|
-
interface CheckoutOptions {
|
|
1867
|
+
export interface CheckoutOptions {
|
|
1922
1868
|
/** Whether to ignore settings to notify contacts or users. */
|
|
1923
1869
|
silent?: boolean;
|
|
1924
1870
|
/** 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. */
|
|
@@ -1928,20 +1874,17 @@ interface CheckoutOptions {
|
|
|
1928
1874
|
/** Marks payment as already paid */
|
|
1929
1875
|
markAsPaid?: boolean | null;
|
|
1930
1876
|
}
|
|
1931
|
-
interface CheckoutResponse {
|
|
1877
|
+
export interface CheckoutResponse {
|
|
1932
1878
|
/** Created order. */
|
|
1933
1879
|
order?: Order;
|
|
1934
|
-
/**
|
|
1935
|
-
* Order expiration time.
|
|
1936
|
-
* **Note:** Only applicable to orders with the `INITIATED` status.
|
|
1937
|
-
*/
|
|
1880
|
+
/** Time when the order expires, applies to orders with status = INITIATED. */
|
|
1938
1881
|
expires?: Date | null;
|
|
1939
1882
|
/** Ticket reservations. */
|
|
1940
1883
|
reservations?: TicketReservation[];
|
|
1941
|
-
/** Order page
|
|
1884
|
+
/** Order page url. */
|
|
1942
1885
|
orderPageUrl?: string | null;
|
|
1943
1886
|
}
|
|
1944
|
-
interface OrderInitiated {
|
|
1887
|
+
export interface OrderInitiated {
|
|
1945
1888
|
/** Order initiated timestamp in ISO UTC format. */
|
|
1946
1889
|
timestamp?: Date | null;
|
|
1947
1890
|
/**
|
|
@@ -1955,7 +1898,7 @@ interface OrderInitiated {
|
|
|
1955
1898
|
*/
|
|
1956
1899
|
locale?: string | null;
|
|
1957
1900
|
/**
|
|
1958
|
-
* Event ID
|
|
1901
|
+
* Event ID.
|
|
1959
1902
|
* @format GUID
|
|
1960
1903
|
*/
|
|
1961
1904
|
eventId?: string;
|
|
@@ -1986,16 +1929,7 @@ interface OrderInitiated {
|
|
|
1986
1929
|
email?: string;
|
|
1987
1930
|
/** Checkout form response. */
|
|
1988
1931
|
checkoutForm?: FormResponse;
|
|
1989
|
-
/**
|
|
1990
|
-
* Order status. Possible values:
|
|
1991
|
-
* - `FREE`: The order is confirmed, no payment is required.
|
|
1992
|
-
* - `PENDING`: The order was paid, but the payment gateway suspended the payment.
|
|
1993
|
-
* - `PAID`: The order is paid.
|
|
1994
|
-
* - `OFFLINE_PENDING`: The order is confirmed but has to be paid in cash and the status is manually updated to `PAID`.
|
|
1995
|
-
* - `INITIATED`: The order is awaiting for payment.
|
|
1996
|
-
* - `CANCELED`: The order is canceled.
|
|
1997
|
-
* - `DECLINED`: The order is payment is declined.
|
|
1998
|
-
*/
|
|
1932
|
+
/** Order status. */
|
|
1999
1933
|
status?: OrderStatus;
|
|
2000
1934
|
/** Invoice. */
|
|
2001
1935
|
invoice?: Invoice;
|
|
@@ -2004,9 +1938,9 @@ interface OrderInitiated {
|
|
|
2004
1938
|
/** Order was marked as paid. */
|
|
2005
1939
|
markedAsPaid?: boolean | null;
|
|
2006
1940
|
}
|
|
2007
|
-
interface UpdateCheckoutRequest {
|
|
1941
|
+
export interface UpdateCheckoutRequest {
|
|
2008
1942
|
/**
|
|
2009
|
-
* Event ID
|
|
1943
|
+
* Event ID.
|
|
2010
1944
|
* @format GUID
|
|
2011
1945
|
*/
|
|
2012
1946
|
eventId: string;
|
|
@@ -2030,37 +1964,37 @@ interface UpdateCheckoutRequest {
|
|
|
2030
1964
|
/** Benefit granted by the pricing plan. */
|
|
2031
1965
|
paidPlanBenefit?: PaidPlanBenefit;
|
|
2032
1966
|
}
|
|
2033
|
-
interface UpdateCheckoutResponse {
|
|
1967
|
+
export interface UpdateCheckoutResponse {
|
|
2034
1968
|
/** Updated order. */
|
|
2035
1969
|
order?: Order;
|
|
2036
|
-
/** Order page
|
|
1970
|
+
/** Order page url. */
|
|
2037
1971
|
orderPageUrl?: string | null;
|
|
2038
1972
|
}
|
|
2039
|
-
interface OrderPageUrls {
|
|
1973
|
+
export interface OrderPageUrls {
|
|
2040
1974
|
/**
|
|
2041
|
-
* Success order page
|
|
1975
|
+
* Success order page url.
|
|
2042
1976
|
* @format WEB_URL
|
|
2043
1977
|
*/
|
|
2044
1978
|
success?: string | null;
|
|
2045
1979
|
/**
|
|
2046
|
-
* Pending order page
|
|
1980
|
+
* Pending order page url.
|
|
2047
1981
|
* @format WEB_URL
|
|
2048
1982
|
*/
|
|
2049
1983
|
pending?: string | null;
|
|
2050
1984
|
/**
|
|
2051
|
-
* Canceled order page
|
|
1985
|
+
* Canceled order page url.
|
|
2052
1986
|
* @format WEB_URL
|
|
2053
1987
|
*/
|
|
2054
1988
|
canceled?: string | null;
|
|
2055
1989
|
/**
|
|
2056
|
-
* Error order page
|
|
1990
|
+
* Error order page url.
|
|
2057
1991
|
* @format WEB_URL
|
|
2058
1992
|
*/
|
|
2059
1993
|
error?: string | null;
|
|
2060
1994
|
}
|
|
2061
|
-
interface PosCheckoutRequest {
|
|
1995
|
+
export interface PosCheckoutRequest {
|
|
2062
1996
|
/**
|
|
2063
|
-
* Event ID
|
|
1997
|
+
* Event ID.
|
|
2064
1998
|
* @format GUID
|
|
2065
1999
|
*/
|
|
2066
2000
|
eventId: string;
|
|
@@ -2076,7 +2010,7 @@ interface PosCheckoutRequest {
|
|
|
2076
2010
|
*/
|
|
2077
2011
|
paymentDetailsId?: string | null;
|
|
2078
2012
|
}
|
|
2079
|
-
interface PosCheckoutResponse {
|
|
2013
|
+
export interface PosCheckoutResponse {
|
|
2080
2014
|
/** Created order. */
|
|
2081
2015
|
order?: Order;
|
|
2082
2016
|
/** Time when the order expires, applies to orders with status = INITIATED. */
|
|
@@ -2084,7 +2018,7 @@ interface PosCheckoutResponse {
|
|
|
2084
2018
|
/** Ticket reservations. */
|
|
2085
2019
|
reservations?: TicketReservation[];
|
|
2086
2020
|
}
|
|
2087
|
-
interface GetReservationRequest {
|
|
2021
|
+
export interface GetReservationRequest {
|
|
2088
2022
|
/**
|
|
2089
2023
|
* Event ID.
|
|
2090
2024
|
* @format GUID
|
|
@@ -2096,11 +2030,11 @@ interface GetReservationRequest {
|
|
|
2096
2030
|
*/
|
|
2097
2031
|
reservationId?: string | null;
|
|
2098
2032
|
}
|
|
2099
|
-
interface GetReservationResponse {
|
|
2033
|
+
export interface GetReservationResponse {
|
|
2100
2034
|
/** Date and time the Ticket Reservation was created. */
|
|
2101
|
-
|
|
2035
|
+
createdDate?: Date | null;
|
|
2102
2036
|
/** Date and time the Ticket Reservation was last updated. */
|
|
2103
|
-
|
|
2037
|
+
updatedDate?: Date | null;
|
|
2104
2038
|
/** Date and time the Pending TicketReservation will expire. */
|
|
2105
2039
|
expirationDate?: Date | null;
|
|
2106
2040
|
/** Reservation status. */
|
|
@@ -2108,324 +2042,3 @@ interface GetReservationResponse {
|
|
|
2108
2042
|
/** Ticket reservations. */
|
|
2109
2043
|
reservations?: TicketReservation[];
|
|
2110
2044
|
}
|
|
2111
|
-
interface BaseEventMetadata {
|
|
2112
|
-
/**
|
|
2113
|
-
* App instance ID.
|
|
2114
|
-
* @format GUID
|
|
2115
|
-
*/
|
|
2116
|
-
instanceId?: string | null;
|
|
2117
|
-
/**
|
|
2118
|
-
* Event type.
|
|
2119
|
-
* @maxLength 150
|
|
2120
|
-
*/
|
|
2121
|
-
eventType?: string;
|
|
2122
|
-
/** The identification type and identity data. */
|
|
2123
|
-
identity?: IdentificationData;
|
|
2124
|
-
}
|
|
2125
|
-
interface OrderDeletedEnvelope {
|
|
2126
|
-
data: OrderDeleted;
|
|
2127
|
-
metadata: BaseEventMetadata;
|
|
2128
|
-
}
|
|
2129
|
-
interface OrderUpdatedEnvelope {
|
|
2130
|
-
data: OrderUpdated;
|
|
2131
|
-
metadata: BaseEventMetadata;
|
|
2132
|
-
}
|
|
2133
|
-
interface OrderConfirmedEnvelope {
|
|
2134
|
-
data: OrderConfirmed;
|
|
2135
|
-
metadata: BaseEventMetadata;
|
|
2136
|
-
}
|
|
2137
|
-
interface OrderInitiatedEnvelope {
|
|
2138
|
-
data: OrderInitiated;
|
|
2139
|
-
metadata: BaseEventMetadata;
|
|
2140
|
-
}
|
|
2141
|
-
interface OrderReservationCreatedEnvelope {
|
|
2142
|
-
data: ReservationCreated;
|
|
2143
|
-
metadata: BaseEventMetadata;
|
|
2144
|
-
}
|
|
2145
|
-
interface OrderReservationUpdatedEnvelope {
|
|
2146
|
-
data: ReservationUpdated;
|
|
2147
|
-
metadata: BaseEventMetadata;
|
|
2148
|
-
}
|
|
2149
|
-
interface ListOrdersOptions {
|
|
2150
|
-
/** Offset. */
|
|
2151
|
-
offset?: number;
|
|
2152
|
-
/**
|
|
2153
|
-
* Limit.
|
|
2154
|
-
* @max 400
|
|
2155
|
-
*/
|
|
2156
|
-
limit?: number;
|
|
2157
|
-
/**
|
|
2158
|
-
* Predefined sets of fields to return.
|
|
2159
|
-
* - `TICKETS`: Returns `tickets`.
|
|
2160
|
-
* - `DETAILS`: Returns `reservationId`, `snapshotId`, `created`, `firstName`, `lastName`, `confirmed`, `status`, `method`, `ticketsQuantity`, `totalPrice`, `ticketsPdf`, `archived`, `fullName`.
|
|
2161
|
-
* - `FORM` : Returns `checkoutForm`.
|
|
2162
|
-
* - `INVOICE`: Returns `invoice`.
|
|
2163
|
-
*
|
|
2164
|
-
* Default: If `fieldset` is not included in the request, `orderNumber`, `eventId`, `contactId`, `memberId`, `anonymized`, `fullyCheckedIn` are returned.
|
|
2165
|
-
* @maxSize 20
|
|
2166
|
-
*/
|
|
2167
|
-
fieldset?: OrderFieldset[];
|
|
2168
|
-
/**
|
|
2169
|
-
* Order status. Possible values:
|
|
2170
|
-
* - `FREE`: The order is confirmed, no payment is required.
|
|
2171
|
-
* - `PENDING`: The order was paid, but the payment gateway suspended the payment.
|
|
2172
|
-
* - `PAID`: The order is paid.
|
|
2173
|
-
* - `OFFLINE_PENDING`: The order is confirmed but has to be paid in cash and the status is manually updated to `PAID`.
|
|
2174
|
-
* - `INITIATED`: The order is awaiting for payment.
|
|
2175
|
-
* - `CANCELED`: The order is canceled.
|
|
2176
|
-
* - `DECLINED`: The order is payment is declined.
|
|
2177
|
-
*/
|
|
2178
|
-
status?: OrderStatus[];
|
|
2179
|
-
/**
|
|
2180
|
-
* Event ID to which the order belongs.
|
|
2181
|
-
* @format GUID
|
|
2182
|
-
* @maxSize 100
|
|
2183
|
-
*/
|
|
2184
|
-
eventId?: string[];
|
|
2185
|
-
/**
|
|
2186
|
-
* Order number.
|
|
2187
|
-
* @maxLength 36
|
|
2188
|
-
* @maxSize 500
|
|
2189
|
-
*/
|
|
2190
|
-
orderNumber?: string[];
|
|
2191
|
-
/**
|
|
2192
|
-
* Site member ID.
|
|
2193
|
-
* @format GUID
|
|
2194
|
-
* @maxSize 500
|
|
2195
|
-
*/
|
|
2196
|
-
memberId?: string[];
|
|
2197
|
-
/**
|
|
2198
|
-
* Field facets.
|
|
2199
|
-
* @maxLength 100
|
|
2200
|
-
* @maxSize 20
|
|
2201
|
-
*/
|
|
2202
|
-
facet?: string[];
|
|
2203
|
-
/**
|
|
2204
|
-
* Search filter. You can search `fullName`, `email` and `orderNumber`.
|
|
2205
|
-
* @maxLength 200
|
|
2206
|
-
*/
|
|
2207
|
-
searchPhrase?: string;
|
|
2208
|
-
/**
|
|
2209
|
-
* Event creator ID.
|
|
2210
|
-
* @format GUID
|
|
2211
|
-
* @maxSize 50
|
|
2212
|
-
*/
|
|
2213
|
-
eventCreatorId?: string[];
|
|
2214
|
-
/**
|
|
2215
|
-
* Sort order.
|
|
2216
|
-
* Default: `created:asc`.
|
|
2217
|
-
* @maxLength 100
|
|
2218
|
-
*/
|
|
2219
|
-
sort?: string;
|
|
2220
|
-
/** Order tag. */
|
|
2221
|
-
tag?: OrderTag[];
|
|
2222
|
-
/**
|
|
2223
|
-
* Guest contact IDs.
|
|
2224
|
-
* @format GUID
|
|
2225
|
-
* @maxSize 100
|
|
2226
|
-
*/
|
|
2227
|
-
contactId?: string[];
|
|
2228
|
-
}
|
|
2229
|
-
interface GetOrderIdentifiers {
|
|
2230
|
-
/**
|
|
2231
|
-
* Event ID to which the order belongs.
|
|
2232
|
-
* @format GUID
|
|
2233
|
-
*/
|
|
2234
|
-
eventId: string;
|
|
2235
|
-
/**
|
|
2236
|
-
* Unique order number.
|
|
2237
|
-
* @maxLength 36
|
|
2238
|
-
*/
|
|
2239
|
-
orderNumber: string;
|
|
2240
|
-
}
|
|
2241
|
-
interface GetOrderOptions {
|
|
2242
|
-
/**
|
|
2243
|
-
* Predefined sets of fields to return.
|
|
2244
|
-
* - `TICKETS`: Returns `tickets`.
|
|
2245
|
-
* - `DETAILS`: Returns `reservationId`, `snapshotId`, `created`, `firstName`, `lastName`, `confirmed`, `status`, `method`, `ticketsQuantity`, `totalPrice`, `ticketsPdf`, `archived`, `fullName`.
|
|
2246
|
-
* - `FORM` : Returns `checkoutForm`.
|
|
2247
|
-
* - `INVOICE`: Returns `invoice`.
|
|
2248
|
-
*
|
|
2249
|
-
* Default: If `fieldset` is not included in the request, `orderNumber`, `eventId`, `contactId`, `memberId`, `anonymized`, `fullyCheckedIn` are returned.
|
|
2250
|
-
* @maxSize 20
|
|
2251
|
-
*/
|
|
2252
|
-
fieldset?: OrderFieldset[];
|
|
2253
|
-
}
|
|
2254
|
-
interface UpdateOrderIdentifiers {
|
|
2255
|
-
/**
|
|
2256
|
-
* Event ID to which the order belongs.
|
|
2257
|
-
* @format GUID
|
|
2258
|
-
*/
|
|
2259
|
-
eventId: string;
|
|
2260
|
-
/**
|
|
2261
|
-
* Unique order number.
|
|
2262
|
-
* @maxLength 36
|
|
2263
|
-
*/
|
|
2264
|
-
orderNumber: string;
|
|
2265
|
-
}
|
|
2266
|
-
interface UpdateOrderOptions {
|
|
2267
|
-
/** Set of field paths to update. */
|
|
2268
|
-
fields?: string[];
|
|
2269
|
-
/** Checkout form. */
|
|
2270
|
-
checkoutForm?: FormResponse;
|
|
2271
|
-
/** Whether order is archived. */
|
|
2272
|
-
archived?: boolean;
|
|
2273
|
-
}
|
|
2274
|
-
interface BulkUpdateOrdersOptions {
|
|
2275
|
-
/**
|
|
2276
|
-
* Unique order number.
|
|
2277
|
-
* @minLength 1
|
|
2278
|
-
* @maxLength 36
|
|
2279
|
-
* @minSize 1
|
|
2280
|
-
* @maxSize 100
|
|
2281
|
-
*/
|
|
2282
|
-
orderNumber?: string[];
|
|
2283
|
-
/** Set of fields to update. */
|
|
2284
|
-
fields?: string[];
|
|
2285
|
-
/** Whether to archive the order. */
|
|
2286
|
-
archived?: boolean;
|
|
2287
|
-
}
|
|
2288
|
-
interface ConfirmOrderOptions {
|
|
2289
|
-
/**
|
|
2290
|
-
* Order numbers.
|
|
2291
|
-
* @minLength 1
|
|
2292
|
-
* @maxLength 36
|
|
2293
|
-
* @maxSize 100
|
|
2294
|
-
*/
|
|
2295
|
-
orderNumber?: string[];
|
|
2296
|
-
}
|
|
2297
|
-
interface GetSummaryOptions {
|
|
2298
|
-
/**
|
|
2299
|
-
* Event ID.
|
|
2300
|
-
* @format GUID
|
|
2301
|
-
*/
|
|
2302
|
-
eventId?: string | null;
|
|
2303
|
-
}
|
|
2304
|
-
interface CaptureAuthorizedPaymentOptions {
|
|
2305
|
-
/**
|
|
2306
|
-
* Event ID.
|
|
2307
|
-
* @format GUID
|
|
2308
|
-
*/
|
|
2309
|
-
eventId?: string;
|
|
2310
|
-
}
|
|
2311
|
-
interface VoidAuthorizedPaymentOptions {
|
|
2312
|
-
/**
|
|
2313
|
-
* Event ID.
|
|
2314
|
-
* @format GUID
|
|
2315
|
-
*/
|
|
2316
|
-
eventId?: string;
|
|
2317
|
-
}
|
|
2318
|
-
interface ListAvailableTicketsOptions {
|
|
2319
|
-
/**
|
|
2320
|
-
* Event ID. If not provided, available tickets for all events in the site will be returned.
|
|
2321
|
-
* @format GUID
|
|
2322
|
-
*/
|
|
2323
|
-
eventId?: string;
|
|
2324
|
-
/** Offset. */
|
|
2325
|
-
offset?: number;
|
|
2326
|
-
/**
|
|
2327
|
-
* Limit.
|
|
2328
|
-
* @max 100
|
|
2329
|
-
*/
|
|
2330
|
-
limit?: number;
|
|
2331
|
-
/**
|
|
2332
|
-
* Sort order.
|
|
2333
|
-
* Default: `created:asc`.
|
|
2334
|
-
* @maxLength 100
|
|
2335
|
-
*/
|
|
2336
|
-
sort?: string;
|
|
2337
|
-
state?: State[];
|
|
2338
|
-
}
|
|
2339
|
-
interface QueryAvailableTicketsOptions {
|
|
2340
|
-
/** Offset. */
|
|
2341
|
-
offset?: number;
|
|
2342
|
-
/**
|
|
2343
|
-
* Limit.
|
|
2344
|
-
* @max 1000
|
|
2345
|
-
*/
|
|
2346
|
-
limit?: number;
|
|
2347
|
-
/** Ticket definition. */
|
|
2348
|
-
filter?: Record<string, any> | null;
|
|
2349
|
-
/** @maxSize 20 */
|
|
2350
|
-
fieldset?: TicketDefinitionFieldset[];
|
|
2351
|
-
/**
|
|
2352
|
-
* Sort order.
|
|
2353
|
-
* Default: `created:asc`.
|
|
2354
|
-
* @maxLength 100
|
|
2355
|
-
*/
|
|
2356
|
-
sort?: string;
|
|
2357
|
-
}
|
|
2358
|
-
interface CreateReservationOptions {
|
|
2359
|
-
/**
|
|
2360
|
-
* Tickets to reserve.
|
|
2361
|
-
* @minSize 1
|
|
2362
|
-
* @maxSize 50
|
|
2363
|
-
*/
|
|
2364
|
-
ticketQuantities?: TicketReservationQuantity[];
|
|
2365
|
-
/** Whether to ignore the available ticket limits upon reservation. */
|
|
2366
|
-
ignoreLimits?: boolean;
|
|
2367
|
-
/** Whether to allow reservation for hidden tickets. */
|
|
2368
|
-
allowHiddenTickets?: boolean;
|
|
2369
|
-
}
|
|
2370
|
-
interface GetInvoiceOptions {
|
|
2371
|
-
/** Optional discount to be applied on the returned invoice. */
|
|
2372
|
-
withDiscount?: DiscountRequest;
|
|
2373
|
-
/** Optional benefit granted by the pricing plan to be applied on the returned invoice. */
|
|
2374
|
-
paidPlanBenefit?: PaidPlanBenefit;
|
|
2375
|
-
}
|
|
2376
|
-
interface CheckoutOptionsForRequest {
|
|
2377
|
-
/**
|
|
2378
|
-
* Ticket reservation ID.
|
|
2379
|
-
* @format GUID
|
|
2380
|
-
*/
|
|
2381
|
-
reservationId?: string;
|
|
2382
|
-
/** Member ID (if empty - no site member is associated to this order). */
|
|
2383
|
-
memberId?: string;
|
|
2384
|
-
/** Discount to apply on the invoice. */
|
|
2385
|
-
discount?: DiscountRequest;
|
|
2386
|
-
/** Buyer details. */
|
|
2387
|
-
buyer?: Buyer;
|
|
2388
|
-
/**
|
|
2389
|
-
* Guest details.
|
|
2390
|
-
* @minSize 1
|
|
2391
|
-
* @maxSize 50
|
|
2392
|
-
*/
|
|
2393
|
-
guests?: Guest[];
|
|
2394
|
-
/** Benefit granted by the pricing plan. */
|
|
2395
|
-
paidPlanBenefit?: PaidPlanBenefit;
|
|
2396
|
-
/** Options controlling the checkout process. */
|
|
2397
|
-
options?: CheckoutOptions;
|
|
2398
|
-
/** Whether marketing consent was given */
|
|
2399
|
-
marketingConsent?: boolean | null;
|
|
2400
|
-
}
|
|
2401
|
-
interface UpdateCheckoutOptions {
|
|
2402
|
-
/** Buyer details. */
|
|
2403
|
-
buyer?: Buyer;
|
|
2404
|
-
/**
|
|
2405
|
-
* Guest details.
|
|
2406
|
-
* @minSize 1
|
|
2407
|
-
* @maxSize 20
|
|
2408
|
-
*/
|
|
2409
|
-
guests?: Guest[];
|
|
2410
|
-
/** Member ID (if empty - no site member is associated to this order). */
|
|
2411
|
-
memberId?: string | null;
|
|
2412
|
-
/** Discount to apply on the invoice. */
|
|
2413
|
-
discount?: DiscountRequest;
|
|
2414
|
-
/** Benefit granted by the pricing plan. */
|
|
2415
|
-
paidPlanBenefit?: PaidPlanBenefit;
|
|
2416
|
-
}
|
|
2417
|
-
interface PosCheckoutOptions {
|
|
2418
|
-
/**
|
|
2419
|
-
* Ticket reservation ID.
|
|
2420
|
-
* @format GUID
|
|
2421
|
-
*/
|
|
2422
|
-
reservationId: string;
|
|
2423
|
-
/**
|
|
2424
|
-
* Payment details ID.
|
|
2425
|
-
* Not required if reservation total is 0. In this case the order will be created with status Free and no payment.
|
|
2426
|
-
* @format GUID
|
|
2427
|
-
*/
|
|
2428
|
-
paymentDetailsId?: string | null;
|
|
2429
|
-
}
|
|
2430
|
-
|
|
2431
|
-
export { type StreetAddress as $, Action as A, type BulkUpdateOrdersOptions as B, type ConfirmOrderOptions as C, OrderType as D, OrderFieldset as E, FeeName as F, type GetOrderIdentifiers as G, OrderTag as H, State as I, TicketSaleStatus as J, Type as K, type ListOrdersOptions as L, TicketDefinitionFieldset as M, type FormResponse as N, type Order as O, type PosCheckoutOptions as P, type QueryAvailableTicketsOptions as Q, ReservationStatus as R, SubdivisionType as S, TaxType as T, type UpdateOrderIdentifiers as U, type VoidAuthorizedPaymentOptions as V, WebhookIdentityType as W, type InputValue as X, type FormattedAddress as Y, type Address as Z, type AddressStreetOneOf as _, type ListOrdersResponse as a, type TicketDefinition as a$, type AddressLocation as a0, type Subdivision as a1, type StandardDetails as a2, type Money as a3, type TicketingTicket as a4, type CheckIn as a5, type GuestDetails as a6, type TicketDetails as a7, type Invoice as a8, type Item as a9, type BulkUpdateOrdersRequest as aA, type ConfirmOrderRequest as aB, type GetSummaryRequest as aC, type TicketSales as aD, type GetInvoicePreviewRequest as aE, type RawHttpResponse as aF, type HeadersEntry as aG, type GetPaymentInfoRequest as aH, type GetPaymentInfoResponse as aI, type PaymentTransactionSummary as aJ, type PaymentTransactionEvent as aK, type CaptureAuthorizedPaymentRequest as aL, type CaptureAuthorizedPaymentResponse as aM, type VoidAuthorizedPaymentRequest as aN, type VoidAuthorizedPaymentResponse as aO, type MessageEnvelope as aP, type IdentificationData as aQ, type IdentificationDataIdOneOf as aR, type OrderConfirmed as aS, type OrderPaid as aT, type ReservationCreated as aU, type TicketQuantity as aV, type ReservationCount as aW, type ReservationUpdated as aX, type GetCheckoutOptionsRequest as aY, type ListAvailableTicketsRequest as aZ, type ResponseMetaData as a_, type Discount as aa, type DiscountItem as ab, type DiscountItemDiscountOneOf as ac, type CouponDiscount as ad, type PaidPlanDiscount as ae, type PaidPlanDiscountDiscountOneOf as af, type PercentDiscount as ag, type Tax as ah, type Fee as ai, type PaymentDetails as aj, type PaymentTransaction as ak, type GiftCardPaymentDetails as al, type BalanceSummary as am, type OrderDeleted as an, type Ticket as ao, type OnlineConferencingLogin as ap, type ListOrdersRequest as aq, type FacetCounts as ar, type OrderFacets as as, type OrderFacetCounts as at, type Counts as au, type GetOrderRequest as av, type GetOrderResponse as aw, type CalendarLinks as ax, type UpdateOrderRequest as ay, type OrderUpdated as az, type GetOrderOptions as b, type Dashboard as b0, type WixFeeConfig as b1, type TicketSalePeriod as b2, type TicketPricing as b3, type TicketPricingPriceOneOf as b4, type PricingOptions as b5, type PricingOption as b6, type QueryAvailableTicketsRequest as b7, type CreateReservationRequest as b8, type TicketReservationQuantity as b9, type OrderReservationUpdatedEnvelope as bA, type TicketReservation as ba, type CancelReservationRequest as bb, type CancelReservationResponse as bc, type GetInvoiceRequest as bd, type DiscountRequest as be, type PaidPlanBenefit as bf, type DiscountErrors as bg, type Error as bh, type GiftCardErrors as bi, type GiftCardErrorsError as bj, type CheckoutRequest as bk, type Buyer as bl, type Guest as bm, type CheckoutOptions as bn, type OrderInitiated as bo, type UpdateCheckoutRequest as bp, type OrderPageUrls as bq, type PosCheckoutRequest as br, type GetReservationRequest as bs, type GetReservationResponse as bt, type BaseEventMetadata as bu, type OrderDeletedEnvelope as bv, type OrderUpdatedEnvelope as bw, type OrderConfirmedEnvelope as bx, type OrderInitiatedEnvelope as by, type OrderReservationCreatedEnvelope as bz, type UpdateOrderOptions as c, type UpdateOrderResponse as d, type BulkUpdateOrdersResponse as e, type ConfirmOrderResponse as f, type GetSummaryOptions as g, type GetSummaryResponse as h, type CaptureAuthorizedPaymentOptions as i, type GetCheckoutOptionsResponse as j, type ListAvailableTicketsOptions as k, type ListAvailableTicketsResponse as l, type QueryAvailableTicketsResponse as m, type CreateReservationOptions as n, type CreateReservationResponse as o, type GetInvoiceOptions as p, type GetInvoiceResponse as q, type CheckoutOptionsForRequest as r, type CheckoutResponse as s, type UpdateCheckoutOptions as t, type UpdateCheckoutResponse as u, type PosCheckoutResponse as v, OrderStatus as w, ChannelType as x, FeeType as y, ScheduledActionEnumAction as z };
|