@wix/auto_sdk_events_orders 1.0.17 → 1.0.19
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/{es/src/events-v1-order-orders.types.d.ts → events-v1-order-orders.universal-C56YAmFe.d.mts} +605 -217
- package/build/{cjs/src/events-v1-order-orders.types.d.ts → events-v1-order-orders.universal-C56YAmFe.d.ts} +605 -217
- package/build/index.d.mts +234 -0
- package/build/index.d.ts +234 -0
- package/build/index.js +2769 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +2706 -0
- package/build/index.mjs.map +1 -0
- package/build/internal/{cjs/src/events-v1-order-orders.types.d.ts → events-v1-order-orders.universal-C56YAmFe.d.mts} +605 -217
- package/build/internal/{es/src/events-v1-order-orders.types.d.ts → events-v1-order-orders.universal-C56YAmFe.d.ts} +605 -217
- package/build/internal/index.d.mts +234 -0
- package/build/internal/index.d.ts +234 -0
- package/build/internal/index.js +2769 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +2706 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/meta.d.mts +1372 -0
- package/build/internal/meta.d.ts +1372 -0
- package/build/internal/meta.js +1907 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +1864 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/meta.d.mts +1372 -0
- package/build/meta.d.ts +1372 -0
- package/build/meta.js +1907 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +1864 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +12 -11
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.js.map +0 -1
- package/build/cjs/src/events-v1-order-orders.context.d.ts +0 -42
- package/build/cjs/src/events-v1-order-orders.context.js +0 -62
- package/build/cjs/src/events-v1-order-orders.context.js.map +0 -1
- package/build/cjs/src/events-v1-order-orders.http.d.ts +0 -97
- package/build/cjs/src/events-v1-order-orders.http.js +0 -1635
- package/build/cjs/src/events-v1-order-orders.http.js.map +0 -1
- package/build/cjs/src/events-v1-order-orders.meta.d.ts +0 -49
- package/build/cjs/src/events-v1-order-orders.meta.js +0 -351
- package/build/cjs/src/events-v1-order-orders.meta.js.map +0 -1
- package/build/cjs/src/events-v1-order-orders.public.d.ts +0 -202
- package/build/cjs/src/events-v1-order-orders.public.js +0 -248
- package/build/cjs/src/events-v1-order-orders.public.js.map +0 -1
- package/build/cjs/src/events-v1-order-orders.types.js +0 -182
- package/build/cjs/src/events-v1-order-orders.types.js.map +0 -1
- package/build/cjs/src/events-v1-order-orders.universal.d.ts +0 -3053
- package/build/cjs/src/events-v1-order-orders.universal.js +0 -1184
- package/build/cjs/src/events-v1-order-orders.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/package.json +0 -3
- package/build/es/src/events-v1-order-orders.context.d.ts +0 -42
- package/build/es/src/events-v1-order-orders.context.js +0 -42
- package/build/es/src/events-v1-order-orders.context.js.map +0 -1
- package/build/es/src/events-v1-order-orders.http.d.ts +0 -97
- package/build/es/src/events-v1-order-orders.http.js +0 -1615
- package/build/es/src/events-v1-order-orders.http.js.map +0 -1
- package/build/es/src/events-v1-order-orders.meta.d.ts +0 -49
- package/build/es/src/events-v1-order-orders.meta.js +0 -308
- package/build/es/src/events-v1-order-orders.meta.js.map +0 -1
- package/build/es/src/events-v1-order-orders.public.d.ts +0 -202
- package/build/es/src/events-v1-order-orders.public.js +0 -211
- package/build/es/src/events-v1-order-orders.public.js.map +0 -1
- package/build/es/src/events-v1-order-orders.types.js +0 -179
- package/build/es/src/events-v1-order-orders.types.js.map +0 -1
- package/build/es/src/events-v1-order-orders.universal.d.ts +0 -3053
- package/build/es/src/events-v1-order-orders.universal.js +0 -1141
- package/build/es/src/events-v1-order-orders.universal.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -1
- package/build/internal/cjs/index.js +0 -18
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.d.ts +0 -1
- package/build/internal/cjs/meta.js +0 -18
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/src/events-v1-order-orders.context.d.ts +0 -42
- package/build/internal/cjs/src/events-v1-order-orders.context.js +0 -62
- package/build/internal/cjs/src/events-v1-order-orders.context.js.map +0 -1
- package/build/internal/cjs/src/events-v1-order-orders.http.d.ts +0 -97
- package/build/internal/cjs/src/events-v1-order-orders.http.js +0 -1635
- package/build/internal/cjs/src/events-v1-order-orders.http.js.map +0 -1
- package/build/internal/cjs/src/events-v1-order-orders.meta.d.ts +0 -49
- package/build/internal/cjs/src/events-v1-order-orders.meta.js +0 -351
- package/build/internal/cjs/src/events-v1-order-orders.meta.js.map +0 -1
- package/build/internal/cjs/src/events-v1-order-orders.public.d.ts +0 -202
- package/build/internal/cjs/src/events-v1-order-orders.public.js +0 -248
- package/build/internal/cjs/src/events-v1-order-orders.public.js.map +0 -1
- package/build/internal/cjs/src/events-v1-order-orders.types.js +0 -182
- package/build/internal/cjs/src/events-v1-order-orders.types.js.map +0 -1
- package/build/internal/cjs/src/events-v1-order-orders.universal.d.ts +0 -3053
- package/build/internal/cjs/src/events-v1-order-orders.universal.js +0 -1184
- package/build/internal/cjs/src/events-v1-order-orders.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/events-v1-order-orders.context.d.ts +0 -42
- package/build/internal/es/src/events-v1-order-orders.context.js +0 -42
- package/build/internal/es/src/events-v1-order-orders.context.js.map +0 -1
- package/build/internal/es/src/events-v1-order-orders.http.d.ts +0 -97
- package/build/internal/es/src/events-v1-order-orders.http.js +0 -1615
- package/build/internal/es/src/events-v1-order-orders.http.js.map +0 -1
- package/build/internal/es/src/events-v1-order-orders.meta.d.ts +0 -49
- package/build/internal/es/src/events-v1-order-orders.meta.js +0 -308
- package/build/internal/es/src/events-v1-order-orders.meta.js.map +0 -1
- package/build/internal/es/src/events-v1-order-orders.public.d.ts +0 -202
- package/build/internal/es/src/events-v1-order-orders.public.js +0 -211
- package/build/internal/es/src/events-v1-order-orders.public.js.map +0 -1
- package/build/internal/es/src/events-v1-order-orders.types.js +0 -179
- package/build/internal/es/src/events-v1-order-orders.types.js.map +0 -1
- package/build/internal/es/src/events-v1-order-orders.universal.d.ts +0 -3053
- package/build/internal/es/src/events-v1-order-orders.universal.js +0 -1141
- package/build/internal/es/src/events-v1-order-orders.universal.js.map +0 -1
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
|
|
1
|
+
interface Order {
|
|
2
2
|
/** Unique order number. */
|
|
3
3
|
orderNumber?: string;
|
|
4
4
|
/**
|
|
@@ -7,8 +7,7 @@ export interface Order {
|
|
|
7
7
|
*/
|
|
8
8
|
reservationId?: string;
|
|
9
9
|
/**
|
|
10
|
-
* Payment snapshot ID.
|
|
11
|
-
* Empty if `status` of the order is `"FREE"`.
|
|
10
|
+
* Payment snapshot ID. Empty for the `FREE` order.
|
|
12
11
|
* @format GUID
|
|
13
12
|
* @readonly
|
|
14
13
|
*/
|
|
@@ -24,7 +23,7 @@ export interface Order {
|
|
|
24
23
|
*/
|
|
25
24
|
contactId?: string;
|
|
26
25
|
/**
|
|
27
|
-
* Buyer member ID, if applicable.
|
|
26
|
+
* Buyer member ID, if applicable.
|
|
28
27
|
* @format GUID
|
|
29
28
|
*/
|
|
30
29
|
memberId?: string;
|
|
@@ -46,11 +45,20 @@ export interface Order {
|
|
|
46
45
|
checkoutForm?: FormResponse;
|
|
47
46
|
/** Whether the order is confirmed. Triggered once the payment gateway processes the payment and funds reach the merchant's account. */
|
|
48
47
|
confirmed?: boolean;
|
|
49
|
-
/**
|
|
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
|
+
*/
|
|
50
58
|
status?: OrderStatusWithLiterals;
|
|
51
59
|
/** Payment method used for purchase, e.g., "payPal", "creditCard", etc. */
|
|
52
60
|
method?: string;
|
|
53
|
-
/**
|
|
61
|
+
/** Quantity of ordered tickets. */
|
|
54
62
|
ticketsQuantity?: number;
|
|
55
63
|
/** Total order price. */
|
|
56
64
|
totalPrice?: Money;
|
|
@@ -80,32 +88,32 @@ export interface Order {
|
|
|
80
88
|
/** Whether marketing consent was given. */
|
|
81
89
|
marketingConsent?: boolean | null;
|
|
82
90
|
}
|
|
83
|
-
|
|
91
|
+
interface FormResponse {
|
|
84
92
|
/**
|
|
85
|
-
* Input
|
|
93
|
+
* Input fields for a checkout form.
|
|
86
94
|
* @maxSize 200
|
|
87
95
|
*/
|
|
88
96
|
inputValues?: InputValue[];
|
|
89
97
|
}
|
|
90
|
-
|
|
98
|
+
interface InputValue {
|
|
91
99
|
/**
|
|
92
100
|
* Input field name.
|
|
93
101
|
* @maxLength 100
|
|
94
102
|
*/
|
|
95
103
|
inputName?: string;
|
|
96
104
|
/**
|
|
97
|
-
*
|
|
105
|
+
* Input field value.
|
|
98
106
|
* @maxLength 5000
|
|
99
107
|
*/
|
|
100
108
|
value?: string;
|
|
101
109
|
/**
|
|
102
|
-
* Multiple input values.
|
|
110
|
+
* Multiple input field values.
|
|
103
111
|
* @maxSize 100
|
|
104
112
|
* @maxLength 5000
|
|
105
113
|
*/
|
|
106
114
|
values?: string[];
|
|
107
115
|
}
|
|
108
|
-
|
|
116
|
+
interface FormattedAddress {
|
|
109
117
|
/**
|
|
110
118
|
* One line address representation.
|
|
111
119
|
* @maxLength 200
|
|
@@ -115,11 +123,11 @@ export interface FormattedAddress {
|
|
|
115
123
|
address?: Address;
|
|
116
124
|
}
|
|
117
125
|
/** Physical address */
|
|
118
|
-
|
|
126
|
+
interface Address extends AddressStreetOneOf {
|
|
119
127
|
/** Street name and number. */
|
|
120
128
|
streetAddress?: StreetAddress;
|
|
121
129
|
/** Main address line, usually street and number as free text. */
|
|
122
|
-
|
|
130
|
+
addressLine1?: string | null;
|
|
123
131
|
/**
|
|
124
132
|
* Country code.
|
|
125
133
|
* @format COUNTRY
|
|
@@ -135,31 +143,31 @@ export interface Address extends AddressStreetOneOf {
|
|
|
135
143
|
addressLine2?: string | null;
|
|
136
144
|
}
|
|
137
145
|
/** @oneof */
|
|
138
|
-
|
|
146
|
+
interface AddressStreetOneOf {
|
|
139
147
|
/** Street name and number. */
|
|
140
148
|
streetAddress?: StreetAddress;
|
|
141
149
|
/** Main address line, usually street and number as free text. */
|
|
142
150
|
addressLine?: string | null;
|
|
143
151
|
}
|
|
144
|
-
|
|
152
|
+
interface StreetAddress {
|
|
145
153
|
/** Street number. */
|
|
146
154
|
number?: string;
|
|
147
155
|
/** Street name. */
|
|
148
156
|
name?: string;
|
|
149
157
|
}
|
|
150
|
-
|
|
158
|
+
interface AddressLocation {
|
|
151
159
|
/** Address latitude. */
|
|
152
160
|
latitude?: number | null;
|
|
153
161
|
/** Address longitude. */
|
|
154
162
|
longitude?: number | null;
|
|
155
163
|
}
|
|
156
|
-
|
|
164
|
+
interface Subdivision {
|
|
157
165
|
/** Short subdivision code. */
|
|
158
166
|
code?: string;
|
|
159
167
|
/** Subdivision full name. */
|
|
160
168
|
name?: string;
|
|
161
169
|
}
|
|
162
|
-
|
|
170
|
+
declare enum SubdivisionType {
|
|
163
171
|
UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
|
|
164
172
|
/** State */
|
|
165
173
|
ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
|
|
@@ -174,17 +182,15 @@ export declare enum SubdivisionType {
|
|
|
174
182
|
/** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
|
|
175
183
|
COUNTRY = "COUNTRY"
|
|
176
184
|
}
|
|
177
|
-
/** @enumType */
|
|
178
|
-
export type SubdivisionTypeWithLiterals = SubdivisionType | 'UNKNOWN_SUBDIVISION_TYPE' | 'ADMINISTRATIVE_AREA_LEVEL_1' | 'ADMINISTRATIVE_AREA_LEVEL_2' | 'ADMINISTRATIVE_AREA_LEVEL_3' | 'ADMINISTRATIVE_AREA_LEVEL_4' | 'ADMINISTRATIVE_AREA_LEVEL_5' | 'COUNTRY';
|
|
179
185
|
/** Subdivision Concordance values */
|
|
180
|
-
|
|
186
|
+
interface StandardDetails {
|
|
181
187
|
/**
|
|
182
188
|
* 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
|
|
183
189
|
* @maxLength 20
|
|
184
190
|
*/
|
|
185
191
|
iso31662?: string | null;
|
|
186
192
|
}
|
|
187
|
-
|
|
193
|
+
declare enum OrderStatus {
|
|
188
194
|
/** Order status is not available for this request fieldset. */
|
|
189
195
|
NA_ORDER_STATUS = "NA_ORDER_STATUS",
|
|
190
196
|
/** Order is confirmed, no payment is required. */
|
|
@@ -209,8 +215,8 @@ export declare enum OrderStatus {
|
|
|
209
215
|
PARTIALLY_PAID = "PARTIALLY_PAID"
|
|
210
216
|
}
|
|
211
217
|
/** @enumType */
|
|
212
|
-
|
|
213
|
-
|
|
218
|
+
type OrderStatusWithLiterals = OrderStatus | 'NA_ORDER_STATUS' | 'FREE' | 'PENDING' | 'PAID' | 'OFFLINE_PENDING' | 'INITIATED' | 'CANCELED' | 'DECLINED' | 'AUTHORIZED' | 'VOIDED' | 'PARTIALLY_PAID';
|
|
219
|
+
interface Money {
|
|
214
220
|
/**
|
|
215
221
|
* *Deprecated:** Use `value` instead.
|
|
216
222
|
* @format DECIMAL_VALUE
|
|
@@ -218,7 +224,7 @@ export interface Money {
|
|
|
218
224
|
*/
|
|
219
225
|
amount?: string;
|
|
220
226
|
/**
|
|
221
|
-
*
|
|
227
|
+
* Currency code. Must be a valid [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code (e.g., USD).
|
|
222
228
|
* @format CURRENCY
|
|
223
229
|
*/
|
|
224
230
|
currency?: string;
|
|
@@ -228,7 +234,7 @@ export interface Money {
|
|
|
228
234
|
*/
|
|
229
235
|
value?: string | null;
|
|
230
236
|
}
|
|
231
|
-
|
|
237
|
+
interface TicketingTicket {
|
|
232
238
|
/** Unique ticket number (issued automatically). */
|
|
233
239
|
ticketNumber?: string;
|
|
234
240
|
/** Associated order number. */
|
|
@@ -288,10 +294,9 @@ export interface TicketingTicket {
|
|
|
288
294
|
anonymized?: boolean;
|
|
289
295
|
/**
|
|
290
296
|
* Ticket check-in URL.
|
|
291
|
-
*
|
|
292
|
-
*
|
|
293
|
-
*
|
|
294
|
-
* Example: `"https://www.wixevents.com/check-in/AAAA-AAAA-BB021,00000000-0000-0000-0000-000000000000"`
|
|
297
|
+
* Shown as a QR code image in PDF.
|
|
298
|
+
* Format: `https://www.wixevents.com/check-in/{ticket number},{event id}`.
|
|
299
|
+
* Example: `https://www.wixevents.com/check-in/AAAA-AAAA-BB021,00000000-0000-0000-0000-000000000000`
|
|
295
300
|
*/
|
|
296
301
|
checkInUrl?: string;
|
|
297
302
|
/** URL for ticket PDF download. */
|
|
@@ -299,7 +304,7 @@ export interface TicketingTicket {
|
|
|
299
304
|
/** Associated order checkout channel type. */
|
|
300
305
|
channel?: ChannelTypeWithLiterals;
|
|
301
306
|
/**
|
|
302
|
-
* URL to download ticket in `.pkpass` format for Apple Wallet
|
|
307
|
+
* URL to download ticket in the `.pkpass` format for Apple Wallet
|
|
303
308
|
* @format WEB_URL
|
|
304
309
|
* @readonly
|
|
305
310
|
*/
|
|
@@ -310,11 +315,11 @@ export interface TicketingTicket {
|
|
|
310
315
|
*/
|
|
311
316
|
canceled?: boolean | null;
|
|
312
317
|
}
|
|
313
|
-
|
|
318
|
+
interface CheckIn {
|
|
314
319
|
/** Time of check-in. */
|
|
315
320
|
created?: Date | null;
|
|
316
321
|
}
|
|
317
|
-
|
|
322
|
+
interface GuestDetails {
|
|
318
323
|
/** Whether ticket belongs to assigned guest. */
|
|
319
324
|
guestAssigned?: boolean;
|
|
320
325
|
/** Guest first name. */
|
|
@@ -339,15 +344,15 @@ export interface GuestDetails {
|
|
|
339
344
|
*/
|
|
340
345
|
phone?: string | null;
|
|
341
346
|
}
|
|
342
|
-
|
|
347
|
+
declare enum ChannelType {
|
|
343
348
|
/** Buyer created the order via an online channel, such as a website or a mobile app. */
|
|
344
349
|
ONLINE = "ONLINE",
|
|
345
350
|
/** Sales person created the order and collected the money. */
|
|
346
351
|
OFFLINE_POS = "OFFLINE_POS"
|
|
347
352
|
}
|
|
348
353
|
/** @enumType */
|
|
349
|
-
|
|
350
|
-
|
|
354
|
+
type ChannelTypeWithLiterals = ChannelType | 'ONLINE' | 'OFFLINE_POS';
|
|
355
|
+
interface TicketDetails {
|
|
351
356
|
/**
|
|
352
357
|
* Unique seat ID in the event venue.
|
|
353
358
|
* @minLength 1
|
|
@@ -403,7 +408,8 @@ export interface TicketDetails {
|
|
|
403
408
|
*/
|
|
404
409
|
pricingOptionName?: string | null;
|
|
405
410
|
}
|
|
406
|
-
|
|
411
|
+
interface Invoice {
|
|
412
|
+
/** Items listed in the invoice. */
|
|
407
413
|
items?: Item[];
|
|
408
414
|
/**
|
|
409
415
|
* Total cart amount.
|
|
@@ -432,15 +438,15 @@ export interface Invoice {
|
|
|
432
438
|
fees?: Fee[];
|
|
433
439
|
/** Total revenue, excluding fees. (Taxes and payment provider fees are not deducted). */
|
|
434
440
|
revenue?: Money;
|
|
435
|
-
/** Invoice preview URL.
|
|
441
|
+
/** Invoice preview URL. This value is only returned when the order is paid. */
|
|
436
442
|
previewUrl?: string | null;
|
|
437
443
|
}
|
|
438
|
-
|
|
444
|
+
interface Item {
|
|
439
445
|
/**
|
|
440
446
|
* Unique line item ID.
|
|
441
447
|
* @format GUID
|
|
442
448
|
*/
|
|
443
|
-
|
|
449
|
+
_id?: string;
|
|
444
450
|
/**
|
|
445
451
|
* Line item quantity.
|
|
446
452
|
* @min 1
|
|
@@ -451,7 +457,7 @@ export interface Item {
|
|
|
451
457
|
name?: string;
|
|
452
458
|
/** Line item price. */
|
|
453
459
|
price?: Money;
|
|
454
|
-
/** Total price for line items.
|
|
460
|
+
/** Total price for line items. It's calculated by multiplying price and item quantity. */
|
|
455
461
|
total?: Money;
|
|
456
462
|
/** Discount applied to the line item. */
|
|
457
463
|
discount?: Discount;
|
|
@@ -463,7 +469,7 @@ export interface Item {
|
|
|
463
469
|
*/
|
|
464
470
|
fees?: Fee[];
|
|
465
471
|
}
|
|
466
|
-
|
|
472
|
+
interface Discount {
|
|
467
473
|
/** Total discount amount. */
|
|
468
474
|
amount?: Money;
|
|
469
475
|
/** Total sum after the discount. */
|
|
@@ -486,7 +492,7 @@ export interface Discount {
|
|
|
486
492
|
/** Discount items. */
|
|
487
493
|
discounts?: DiscountItem[];
|
|
488
494
|
}
|
|
489
|
-
|
|
495
|
+
interface DiscountItem extends DiscountItemDiscountOneOf {
|
|
490
496
|
/** Coupon discount. */
|
|
491
497
|
coupon?: CouponDiscount;
|
|
492
498
|
/** Pricing plan discount. */
|
|
@@ -495,13 +501,13 @@ export interface DiscountItem extends DiscountItemDiscountOneOf {
|
|
|
495
501
|
amount?: Money;
|
|
496
502
|
}
|
|
497
503
|
/** @oneof */
|
|
498
|
-
|
|
504
|
+
interface DiscountItemDiscountOneOf {
|
|
499
505
|
/** Coupon discount. */
|
|
500
506
|
coupon?: CouponDiscount;
|
|
501
507
|
/** Pricing plan discount. */
|
|
502
508
|
paidPlan?: PaidPlanDiscount;
|
|
503
509
|
}
|
|
504
|
-
|
|
510
|
+
interface CouponDiscount {
|
|
505
511
|
/** Discount coupon name. **Deprecated:** Use `invoice.discounts.coupon.name` instead. */
|
|
506
512
|
name?: string;
|
|
507
513
|
/** Discount coupon code. **Deprecated:** Use `invoice.discounts.coupon.code` instead. */
|
|
@@ -509,18 +515,18 @@ export interface CouponDiscount {
|
|
|
509
515
|
/** Discount coupon ID. **Deprecated:** Use `invoice.discounts.coupon.couponId` instead. */
|
|
510
516
|
couponId?: string;
|
|
511
517
|
}
|
|
512
|
-
|
|
518
|
+
interface PaidPlanDiscount extends PaidPlanDiscountDiscountOneOf {
|
|
513
519
|
/** Discount by percentage applied to tickets. */
|
|
514
520
|
percentDiscount?: PercentDiscount;
|
|
515
521
|
/** Name of pricing plan. */
|
|
516
522
|
name?: string;
|
|
517
523
|
}
|
|
518
524
|
/** @oneof */
|
|
519
|
-
|
|
525
|
+
interface PaidPlanDiscountDiscountOneOf {
|
|
520
526
|
/** Discount by percentage applied to tickets. */
|
|
521
527
|
percentDiscount?: PercentDiscount;
|
|
522
528
|
}
|
|
523
|
-
|
|
529
|
+
interface PercentDiscount {
|
|
524
530
|
/**
|
|
525
531
|
* Percent rate.
|
|
526
532
|
* @decimalValue options { gte:0.01, lte:100, maxScale:2 }
|
|
@@ -529,7 +535,7 @@ export interface PercentDiscount {
|
|
|
529
535
|
/** Number of discounted tickets. */
|
|
530
536
|
quantityDiscounted?: number;
|
|
531
537
|
}
|
|
532
|
-
|
|
538
|
+
interface Tax {
|
|
533
539
|
/** Tax type. */
|
|
534
540
|
type?: TaxTypeWithLiterals;
|
|
535
541
|
/**
|
|
@@ -547,7 +553,7 @@ export interface Tax {
|
|
|
547
553
|
/** Total tax amount. */
|
|
548
554
|
amount?: Money;
|
|
549
555
|
}
|
|
550
|
-
|
|
556
|
+
declare enum TaxType {
|
|
551
557
|
/** Tax is included in the ticket price. */
|
|
552
558
|
INCLUDED = "INCLUDED",
|
|
553
559
|
/** Tax is added to the order at the checkout. */
|
|
@@ -556,8 +562,8 @@ export declare enum TaxType {
|
|
|
556
562
|
ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
|
|
557
563
|
}
|
|
558
564
|
/** @enumType */
|
|
559
|
-
|
|
560
|
-
|
|
565
|
+
type TaxTypeWithLiterals = TaxType | 'INCLUDED' | 'ADDED' | 'ADDED_AT_CHECKOUT';
|
|
566
|
+
interface Fee {
|
|
561
567
|
/** Fee identifier. */
|
|
562
568
|
name?: FeeNameWithLiterals;
|
|
563
569
|
/** How fee is calculated. */
|
|
@@ -571,13 +577,13 @@ export interface Fee {
|
|
|
571
577
|
/** Total amount of fee charges. */
|
|
572
578
|
amount?: Money;
|
|
573
579
|
}
|
|
574
|
-
|
|
580
|
+
declare enum FeeName {
|
|
575
581
|
/** Wix ticket service fee charges applied to the line item. */
|
|
576
582
|
WIX_FEE = "WIX_FEE"
|
|
577
583
|
}
|
|
578
584
|
/** @enumType */
|
|
579
|
-
|
|
580
|
-
|
|
585
|
+
type FeeNameWithLiterals = FeeName | 'WIX_FEE';
|
|
586
|
+
declare enum FeeType {
|
|
581
587
|
/** Fee is added to the ticket price at checkout. */
|
|
582
588
|
FEE_ADDED = "FEE_ADDED",
|
|
583
589
|
/** Seller absorbs the fee. It's deducted from the ticket price. */
|
|
@@ -586,12 +592,12 @@ export declare enum FeeType {
|
|
|
586
592
|
FEE_ADDED_AT_CHECKOUT = "FEE_ADDED_AT_CHECKOUT"
|
|
587
593
|
}
|
|
588
594
|
/** @enumType */
|
|
589
|
-
|
|
590
|
-
|
|
595
|
+
type FeeTypeWithLiterals = FeeType | 'FEE_ADDED' | 'FEE_INCLUDED' | 'FEE_ADDED_AT_CHECKOUT';
|
|
596
|
+
interface PaymentDetails {
|
|
591
597
|
/** Wix Payments transaction */
|
|
592
598
|
transaction?: PaymentTransaction;
|
|
593
599
|
}
|
|
594
|
-
|
|
600
|
+
interface PaymentTransaction {
|
|
595
601
|
/**
|
|
596
602
|
* Wix Payments transaction ID.
|
|
597
603
|
* @format GUID
|
|
@@ -604,7 +610,7 @@ export interface PaymentTransaction {
|
|
|
604
610
|
*/
|
|
605
611
|
method?: string;
|
|
606
612
|
}
|
|
607
|
-
|
|
613
|
+
declare enum ScheduledActionEnumAction {
|
|
608
614
|
/** Action not scheduled. */
|
|
609
615
|
UNKNOWN_ACTION = "UNKNOWN_ACTION",
|
|
610
616
|
/** Captured after the delay. */
|
|
@@ -612,9 +618,7 @@ export declare enum ScheduledActionEnumAction {
|
|
|
612
618
|
/** Void after the delay. */
|
|
613
619
|
VOID = "VOID"
|
|
614
620
|
}
|
|
615
|
-
|
|
616
|
-
export type ScheduledActionEnumActionWithLiterals = ScheduledActionEnumAction | 'UNKNOWN_ACTION' | 'CAPTURE' | 'VOID';
|
|
617
|
-
export declare enum Action {
|
|
621
|
+
declare enum Action {
|
|
618
622
|
/** Order can be archived. */
|
|
619
623
|
ARCHIVE = "ARCHIVE",
|
|
620
624
|
/** Order can be unarchived. */
|
|
@@ -626,9 +630,7 @@ export declare enum Action {
|
|
|
626
630
|
/** Order can be voided. */
|
|
627
631
|
VOID = "VOID"
|
|
628
632
|
}
|
|
629
|
-
|
|
630
|
-
export type ActionWithLiterals = Action | 'ARCHIVE' | 'UNARCHIVE' | 'CONFIRM' | 'CAPTURE' | 'VOID';
|
|
631
|
-
export interface GiftCardPaymentDetails {
|
|
633
|
+
interface GiftCardPaymentDetails {
|
|
632
634
|
/**
|
|
633
635
|
* Gift card payment id.
|
|
634
636
|
* @format GUID
|
|
@@ -649,12 +651,12 @@ export interface GiftCardPaymentDetails {
|
|
|
649
651
|
*/
|
|
650
652
|
obfuscatedCode?: string | null;
|
|
651
653
|
}
|
|
652
|
-
|
|
654
|
+
interface BalanceSummary {
|
|
653
655
|
/** Amount left to pay. */
|
|
654
656
|
balance?: Money;
|
|
655
657
|
}
|
|
656
658
|
/** Triggered when an order is deleted. */
|
|
657
|
-
|
|
659
|
+
interface OrderDeleted {
|
|
658
660
|
/** Date and time the order was deleted. */
|
|
659
661
|
timestamp?: Date | null;
|
|
660
662
|
/**
|
|
@@ -690,15 +692,15 @@ export interface OrderDeleted {
|
|
|
690
692
|
/** Tickets generated after payment. */
|
|
691
693
|
tickets?: Ticket[];
|
|
692
694
|
}
|
|
693
|
-
|
|
695
|
+
declare enum OrderType {
|
|
694
696
|
/** Buyer form is used for all tickets. */
|
|
695
697
|
UNASSIGNED_TICKETS = "UNASSIGNED_TICKETS",
|
|
696
698
|
/** Each order ticket has its own form. */
|
|
697
699
|
ASSIGNED_TICKETS = "ASSIGNED_TICKETS"
|
|
698
700
|
}
|
|
699
701
|
/** @enumType */
|
|
700
|
-
|
|
701
|
-
|
|
702
|
+
type OrderTypeWithLiterals = OrderType | 'UNASSIGNED_TICKETS' | 'ASSIGNED_TICKETS';
|
|
703
|
+
interface Ticket {
|
|
702
704
|
/** Unique issued ticket number. */
|
|
703
705
|
ticketNumber?: string;
|
|
704
706
|
/**
|
|
@@ -746,7 +748,7 @@ export interface Ticket {
|
|
|
746
748
|
/** Whether ticket is canceled. */
|
|
747
749
|
canceled?: boolean | null;
|
|
748
750
|
}
|
|
749
|
-
|
|
751
|
+
interface OnlineConferencingLogin {
|
|
750
752
|
/**
|
|
751
753
|
* Link URL to the online conference.
|
|
752
754
|
* @format WEB_URL
|
|
@@ -759,7 +761,7 @@ export interface OnlineConferencingLogin {
|
|
|
759
761
|
*/
|
|
760
762
|
password?: string | null;
|
|
761
763
|
}
|
|
762
|
-
|
|
764
|
+
interface ListOrdersRequest {
|
|
763
765
|
/** Offset. */
|
|
764
766
|
offset?: number;
|
|
765
767
|
/**
|
|
@@ -768,14 +770,30 @@ export interface ListOrdersRequest {
|
|
|
768
770
|
*/
|
|
769
771
|
limit?: number;
|
|
770
772
|
/**
|
|
771
|
-
*
|
|
773
|
+
* Predefined sets of fields to return.
|
|
774
|
+
* - `TICKETS`: Returns `tickets`.
|
|
775
|
+
* - `DETAILS`: Returns `reservationId`, `snapshotId`, `created`, `firstName`, `lastName`, `confirmed`, `status`, `method`, `ticketsQuantity`, `totalPrice`, `ticketsPdf`, `archived`, `fullName`.
|
|
776
|
+
* - `FORM` : Returns `checkoutForm`.
|
|
777
|
+
* - `INVOICE`: Returns `invoice`.
|
|
778
|
+
*
|
|
779
|
+
* Default: If `fieldset` is not included in the request, `orderNumber`, `eventId`, `contactId`, `memberId`, `anonymized`, `fullyCheckedIn` are returned.
|
|
780
|
+
*
|
|
772
781
|
* @maxSize 20
|
|
773
782
|
*/
|
|
774
783
|
fieldset?: OrderFieldsetWithLiterals[];
|
|
775
|
-
/**
|
|
784
|
+
/**
|
|
785
|
+
* Order status. Possible values:
|
|
786
|
+
* - `FREE`: The order is confirmed, no payment is required.
|
|
787
|
+
* - `PENDING`: The order was paid, but the payment gateway suspended the payment.
|
|
788
|
+
* - `PAID`: The order is paid.
|
|
789
|
+
* - `OFFLINE_PENDING`: The order is confirmed but has to be paid in cash and the status is manually updated to `PAID`.
|
|
790
|
+
* - `INITIATED`: The order is awaiting for payment.
|
|
791
|
+
* - `CANCELED`: The order is canceled.
|
|
792
|
+
* - `DECLINED`: The order is payment is declined.
|
|
793
|
+
*/
|
|
776
794
|
status?: OrderStatusWithLiterals[];
|
|
777
795
|
/**
|
|
778
|
-
* Event ID.
|
|
796
|
+
* Event ID to which the order belongs.
|
|
779
797
|
* @format GUID
|
|
780
798
|
* @maxSize 100
|
|
781
799
|
*/
|
|
@@ -793,14 +811,13 @@ export interface ListOrdersRequest {
|
|
|
793
811
|
*/
|
|
794
812
|
memberId?: string[];
|
|
795
813
|
/**
|
|
796
|
-
* Field facets
|
|
797
|
-
* 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).
|
|
814
|
+
* Field facets,
|
|
798
815
|
* @maxLength 100
|
|
799
816
|
* @maxSize 20
|
|
800
817
|
*/
|
|
801
818
|
facet?: string[];
|
|
802
819
|
/**
|
|
803
|
-
*
|
|
820
|
+
* Search filter. You can search `fullName`, `email` and `orderNumber`.
|
|
804
821
|
* @maxLength 200
|
|
805
822
|
*/
|
|
806
823
|
searchPhrase?: string;
|
|
@@ -811,8 +828,8 @@ export interface ListOrdersRequest {
|
|
|
811
828
|
*/
|
|
812
829
|
eventCreatorId?: string[];
|
|
813
830
|
/**
|
|
814
|
-
* Sort order.
|
|
815
|
-
*
|
|
831
|
+
* Sort order.
|
|
832
|
+
* Default: `created:asc`.
|
|
816
833
|
* @maxLength 100
|
|
817
834
|
*/
|
|
818
835
|
sort?: string;
|
|
@@ -825,7 +842,7 @@ export interface ListOrdersRequest {
|
|
|
825
842
|
*/
|
|
826
843
|
contactId?: string[];
|
|
827
844
|
}
|
|
828
|
-
|
|
845
|
+
declare enum OrderFieldset {
|
|
829
846
|
/** Returns `tickets`. */
|
|
830
847
|
TICKETS = "TICKETS",
|
|
831
848
|
/**
|
|
@@ -840,8 +857,8 @@ export declare enum OrderFieldset {
|
|
|
840
857
|
INVOICE = "INVOICE"
|
|
841
858
|
}
|
|
842
859
|
/** @enumType */
|
|
843
|
-
|
|
844
|
-
|
|
860
|
+
type OrderFieldsetWithLiterals = OrderFieldset | 'TICKETS' | 'DETAILS' | 'FORM' | 'INVOICE';
|
|
861
|
+
declare enum OrderTag {
|
|
845
862
|
/** Return only confirmed orders. */
|
|
846
863
|
CONFIRMED = "CONFIRMED",
|
|
847
864
|
/** Return only unconfirmed orders. */
|
|
@@ -858,8 +875,8 @@ export declare enum OrderTag {
|
|
|
858
875
|
NOT_FULLY_CHECKED_IN = "NOT_FULLY_CHECKED_IN"
|
|
859
876
|
}
|
|
860
877
|
/** @enumType */
|
|
861
|
-
|
|
862
|
-
|
|
878
|
+
type OrderTagWithLiterals = OrderTag | 'CONFIRMED' | 'UNCONFIRMED' | 'MEMBER' | 'ARCHIVED' | 'NON_ARCHIVED' | 'FULLY_CHECKED_IN' | 'NOT_FULLY_CHECKED_IN';
|
|
879
|
+
interface ListOrdersResponse {
|
|
863
880
|
/** Total orders matching the given filters. */
|
|
864
881
|
total?: number;
|
|
865
882
|
/** Offset. */
|
|
@@ -876,19 +893,19 @@ export interface ListOrdersResponse {
|
|
|
876
893
|
/** Order data enriched facets. */
|
|
877
894
|
orderFacets?: OrderFacets;
|
|
878
895
|
}
|
|
879
|
-
|
|
896
|
+
interface FacetCounts {
|
|
880
897
|
/** Facet counts aggregated per value. */
|
|
881
898
|
counts?: Record<string, number>;
|
|
882
899
|
}
|
|
883
|
-
|
|
900
|
+
interface OrderFacets {
|
|
884
901
|
/** Filter facets. */
|
|
885
902
|
facets?: Record<string, OrderFacetCounts>;
|
|
886
903
|
}
|
|
887
|
-
|
|
904
|
+
interface OrderFacetCounts {
|
|
888
905
|
/** Facet counts aggregated per value */
|
|
889
906
|
counts?: Record<string, Counts>;
|
|
890
907
|
}
|
|
891
|
-
|
|
908
|
+
interface Counts {
|
|
892
909
|
/** Number or orders */
|
|
893
910
|
count?: number;
|
|
894
911
|
/** Number of tickets within orders */
|
|
@@ -896,7 +913,7 @@ export interface Counts {
|
|
|
896
913
|
/** Number of tickets with check-in */
|
|
897
914
|
ticketsCheckIn?: number;
|
|
898
915
|
}
|
|
899
|
-
|
|
916
|
+
interface GetOrderRequest {
|
|
900
917
|
/**
|
|
901
918
|
* Event ID to which the order belongs.
|
|
902
919
|
* @format GUID
|
|
@@ -908,24 +925,31 @@ export interface GetOrderRequest {
|
|
|
908
925
|
*/
|
|
909
926
|
orderNumber: string;
|
|
910
927
|
/**
|
|
911
|
-
*
|
|
928
|
+
* Predefined sets of fields to return.
|
|
929
|
+
* - `TICKETS`: Returns `tickets`.
|
|
930
|
+
* - `DETAILS`: Returns `reservationId`, `snapshotId`, `created`, `firstName`, `lastName`, `confirmed`, `status`, `method`, `ticketsQuantity`, `totalPrice`, `ticketsPdf`, `archived`, `fullName`.
|
|
931
|
+
* - `FORM` : Returns `checkoutForm`.
|
|
932
|
+
* - `INVOICE`: Returns `invoice`.
|
|
933
|
+
*
|
|
934
|
+
* Default: If `fieldset` is not included in the request, `orderNumber`, `eventId`, `contactId`, `memberId`, `anonymized`, `fullyCheckedIn` are returned.
|
|
935
|
+
*
|
|
912
936
|
* @maxSize 20
|
|
913
937
|
*/
|
|
914
938
|
fieldset?: OrderFieldsetWithLiterals[];
|
|
915
939
|
}
|
|
916
|
-
|
|
940
|
+
interface GetOrderResponse {
|
|
917
941
|
/** Requested order. */
|
|
918
942
|
order?: Order;
|
|
919
943
|
/** "Add to calendar" links. */
|
|
920
944
|
calendarLinks?: CalendarLinks;
|
|
921
945
|
}
|
|
922
|
-
|
|
946
|
+
interface CalendarLinks {
|
|
923
947
|
/** "Add to Google calendar" URL. */
|
|
924
948
|
google?: string;
|
|
925
949
|
/** "Download ICS calendar file" URL. */
|
|
926
950
|
ics?: string;
|
|
927
951
|
}
|
|
928
|
-
|
|
952
|
+
interface UpdateOrderRequest {
|
|
929
953
|
/**
|
|
930
954
|
* Event ID to which the order belongs.
|
|
931
955
|
* @format GUID
|
|
@@ -943,12 +967,12 @@ export interface UpdateOrderRequest {
|
|
|
943
967
|
/** Whether to archive the order. */
|
|
944
968
|
archived?: boolean;
|
|
945
969
|
}
|
|
946
|
-
|
|
970
|
+
interface UpdateOrderResponse {
|
|
947
971
|
/** Updated order. */
|
|
948
972
|
order?: Order;
|
|
949
973
|
}
|
|
950
974
|
/** Triggered when an order is updated. */
|
|
951
|
-
|
|
975
|
+
interface OrderUpdated {
|
|
952
976
|
/** Date and time the order was updated. */
|
|
953
977
|
timestamp?: Date | null;
|
|
954
978
|
/**
|
|
@@ -995,7 +1019,16 @@ export interface OrderUpdated {
|
|
|
995
1019
|
checkoutForm?: FormResponse;
|
|
996
1020
|
/** Whether order is confirmed - occurs once payment gateway processes the payment and funds reach merchant's account. */
|
|
997
1021
|
confirmed?: boolean;
|
|
998
|
-
/**
|
|
1022
|
+
/**
|
|
1023
|
+
* Order status. Possible values:
|
|
1024
|
+
* - `FREE`: The order is confirmed, no payment is required.
|
|
1025
|
+
* - `PENDING`: The order was paid, but the payment gateway suspended the payment.
|
|
1026
|
+
* - `PAID`: The order is paid.
|
|
1027
|
+
* - `OFFLINE_PENDING`: The order is confirmed but has to be paid in cash and the status is manually updated to `PAID`.
|
|
1028
|
+
* - `INITIATED`: The order is awaiting for payment.
|
|
1029
|
+
* - `CANCELED`: The order is canceled.
|
|
1030
|
+
* - `DECLINED`: The order is payment is declined.
|
|
1031
|
+
*/
|
|
999
1032
|
status?: OrderStatusWithLiterals;
|
|
1000
1033
|
/** Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc. */
|
|
1001
1034
|
method?: string | null;
|
|
@@ -1006,7 +1039,7 @@ export interface OrderUpdated {
|
|
|
1006
1039
|
/** Whether event was triggered by GDPR delete request. */
|
|
1007
1040
|
triggeredByAnonymizeRequest?: boolean;
|
|
1008
1041
|
}
|
|
1009
|
-
|
|
1042
|
+
interface BulkUpdateOrdersRequest {
|
|
1010
1043
|
/**
|
|
1011
1044
|
* Event ID to which the order belongs.
|
|
1012
1045
|
* @format GUID
|
|
@@ -1025,11 +1058,11 @@ export interface BulkUpdateOrdersRequest {
|
|
|
1025
1058
|
/** Whether to archive the order. */
|
|
1026
1059
|
archived?: boolean;
|
|
1027
1060
|
}
|
|
1028
|
-
|
|
1061
|
+
interface BulkUpdateOrdersResponse {
|
|
1029
1062
|
/** Updated orders. */
|
|
1030
1063
|
orders?: Order[];
|
|
1031
1064
|
}
|
|
1032
|
-
|
|
1065
|
+
interface ConfirmOrderRequest {
|
|
1033
1066
|
/**
|
|
1034
1067
|
* Event ID to which the order belongs.
|
|
1035
1068
|
* @format GUID
|
|
@@ -1043,22 +1076,22 @@ export interface ConfirmOrderRequest {
|
|
|
1043
1076
|
*/
|
|
1044
1077
|
orderNumber?: string[];
|
|
1045
1078
|
}
|
|
1046
|
-
|
|
1079
|
+
interface ConfirmOrderResponse {
|
|
1047
1080
|
/** Confirmed orders. */
|
|
1048
1081
|
orders?: Order[];
|
|
1049
1082
|
}
|
|
1050
|
-
|
|
1083
|
+
interface GetSummaryRequest {
|
|
1051
1084
|
/**
|
|
1052
1085
|
* Event ID to which the order belongs.
|
|
1053
1086
|
* @format GUID
|
|
1054
1087
|
*/
|
|
1055
1088
|
eventId?: string | null;
|
|
1056
1089
|
}
|
|
1057
|
-
|
|
1090
|
+
interface GetSummaryResponse {
|
|
1058
1091
|
/** Ticket sales grouped by currency. */
|
|
1059
1092
|
sales?: TicketSales[];
|
|
1060
1093
|
}
|
|
1061
|
-
|
|
1094
|
+
interface TicketSales {
|
|
1062
1095
|
/** Total balance of confirmed transactions. */
|
|
1063
1096
|
total?: Money;
|
|
1064
1097
|
/** Total number of confirmed orders. */
|
|
@@ -1068,25 +1101,25 @@ export interface TicketSales {
|
|
|
1068
1101
|
/** Total revenue, excluding fees (taxes and payment provider fees are not deducted). */
|
|
1069
1102
|
revenue?: Money;
|
|
1070
1103
|
}
|
|
1071
|
-
|
|
1104
|
+
interface GetInvoicePreviewRequest {
|
|
1072
1105
|
/**
|
|
1073
|
-
* Event ID.
|
|
1106
|
+
* Event ID to which the invoice belongs.
|
|
1074
1107
|
* @format GUID
|
|
1075
1108
|
*/
|
|
1076
1109
|
eventId?: string;
|
|
1077
1110
|
/** Order number. */
|
|
1078
1111
|
orderNumber?: string;
|
|
1079
1112
|
}
|
|
1080
|
-
|
|
1113
|
+
interface RawHttpResponse {
|
|
1081
1114
|
body?: Uint8Array;
|
|
1082
1115
|
statusCode?: number | null;
|
|
1083
1116
|
headers?: HeadersEntry[];
|
|
1084
1117
|
}
|
|
1085
|
-
|
|
1118
|
+
interface HeadersEntry {
|
|
1086
1119
|
key?: string;
|
|
1087
1120
|
value?: string;
|
|
1088
1121
|
}
|
|
1089
|
-
|
|
1122
|
+
interface GetPaymentInfoRequest {
|
|
1090
1123
|
/**
|
|
1091
1124
|
* Event ID.
|
|
1092
1125
|
* @format GUID
|
|
@@ -1095,7 +1128,7 @@ export interface GetPaymentInfoRequest {
|
|
|
1095
1128
|
/** Order number. */
|
|
1096
1129
|
orderNumber?: string;
|
|
1097
1130
|
}
|
|
1098
|
-
|
|
1131
|
+
interface GetPaymentInfoResponse {
|
|
1099
1132
|
transactions?: PaymentTransactionSummary[];
|
|
1100
1133
|
status?: string | null;
|
|
1101
1134
|
/**
|
|
@@ -1104,7 +1137,7 @@ export interface GetPaymentInfoResponse {
|
|
|
1104
1137
|
*/
|
|
1105
1138
|
transactionId?: string | null;
|
|
1106
1139
|
}
|
|
1107
|
-
|
|
1140
|
+
interface PaymentTransactionSummary {
|
|
1108
1141
|
/**
|
|
1109
1142
|
* Wix Payments transaction ID.
|
|
1110
1143
|
* @format GUID
|
|
@@ -1119,7 +1152,7 @@ export interface PaymentTransactionSummary {
|
|
|
1119
1152
|
/** Transaction events. */
|
|
1120
1153
|
events?: PaymentTransactionEvent[];
|
|
1121
1154
|
}
|
|
1122
|
-
|
|
1155
|
+
interface PaymentTransactionEvent {
|
|
1123
1156
|
/**
|
|
1124
1157
|
* Order snapshot ID.
|
|
1125
1158
|
* @format GUID
|
|
@@ -1145,7 +1178,7 @@ export interface PaymentTransactionEvent {
|
|
|
1145
1178
|
* Crated date
|
|
1146
1179
|
* @readonly
|
|
1147
1180
|
*/
|
|
1148
|
-
|
|
1181
|
+
_createdDate?: Date | null;
|
|
1149
1182
|
/**
|
|
1150
1183
|
* Reason code
|
|
1151
1184
|
* @readonly
|
|
@@ -1157,7 +1190,7 @@ export interface PaymentTransactionEvent {
|
|
|
1157
1190
|
*/
|
|
1158
1191
|
refundedAmount?: Money;
|
|
1159
1192
|
}
|
|
1160
|
-
|
|
1193
|
+
interface CaptureAuthorizedPaymentRequest {
|
|
1161
1194
|
/**
|
|
1162
1195
|
* Event ID.
|
|
1163
1196
|
* @format GUID
|
|
@@ -1170,9 +1203,9 @@ export interface CaptureAuthorizedPaymentRequest {
|
|
|
1170
1203
|
*/
|
|
1171
1204
|
orderNumber: string;
|
|
1172
1205
|
}
|
|
1173
|
-
|
|
1206
|
+
interface CaptureAuthorizedPaymentResponse {
|
|
1174
1207
|
}
|
|
1175
|
-
|
|
1208
|
+
interface VoidAuthorizedPaymentRequest {
|
|
1176
1209
|
/**
|
|
1177
1210
|
* Event ID.
|
|
1178
1211
|
* @format GUID
|
|
@@ -1185,9 +1218,9 @@ export interface VoidAuthorizedPaymentRequest {
|
|
|
1185
1218
|
*/
|
|
1186
1219
|
orderNumber: string;
|
|
1187
1220
|
}
|
|
1188
|
-
|
|
1221
|
+
interface VoidAuthorizedPaymentResponse {
|
|
1189
1222
|
}
|
|
1190
|
-
|
|
1223
|
+
interface FindOrderByReservationIdRequest {
|
|
1191
1224
|
/**
|
|
1192
1225
|
* Event ID
|
|
1193
1226
|
* @format GUID
|
|
@@ -1199,11 +1232,11 @@ export interface FindOrderByReservationIdRequest {
|
|
|
1199
1232
|
*/
|
|
1200
1233
|
reservationId?: string;
|
|
1201
1234
|
}
|
|
1202
|
-
|
|
1235
|
+
interface FindOrderByReservationIdResponse {
|
|
1203
1236
|
/** Order. */
|
|
1204
1237
|
order?: Order;
|
|
1205
1238
|
}
|
|
1206
|
-
|
|
1239
|
+
interface MessageEnvelope {
|
|
1207
1240
|
/**
|
|
1208
1241
|
* App instance ID.
|
|
1209
1242
|
* @format GUID
|
|
@@ -1219,7 +1252,7 @@ export interface MessageEnvelope {
|
|
|
1219
1252
|
/** Stringify payload. */
|
|
1220
1253
|
data?: string;
|
|
1221
1254
|
}
|
|
1222
|
-
|
|
1255
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1223
1256
|
/**
|
|
1224
1257
|
* ID of a site visitor that has not logged in to the site.
|
|
1225
1258
|
* @format GUID
|
|
@@ -1244,7 +1277,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
1244
1277
|
identityType?: WebhookIdentityTypeWithLiterals;
|
|
1245
1278
|
}
|
|
1246
1279
|
/** @oneof */
|
|
1247
|
-
|
|
1280
|
+
interface IdentificationDataIdOneOf {
|
|
1248
1281
|
/**
|
|
1249
1282
|
* ID of a site visitor that has not logged in to the site.
|
|
1250
1283
|
* @format GUID
|
|
@@ -1266,7 +1299,7 @@ export interface IdentificationDataIdOneOf {
|
|
|
1266
1299
|
*/
|
|
1267
1300
|
appId?: string;
|
|
1268
1301
|
}
|
|
1269
|
-
|
|
1302
|
+
declare enum WebhookIdentityType {
|
|
1270
1303
|
UNKNOWN = "UNKNOWN",
|
|
1271
1304
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1272
1305
|
MEMBER = "MEMBER",
|
|
@@ -1274,9 +1307,9 @@ export declare enum WebhookIdentityType {
|
|
|
1274
1307
|
APP = "APP"
|
|
1275
1308
|
}
|
|
1276
1309
|
/** @enumType */
|
|
1277
|
-
|
|
1310
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
1278
1311
|
/** Triggered when an order is confirmed. */
|
|
1279
|
-
|
|
1312
|
+
interface OrderConfirmed {
|
|
1280
1313
|
/** Date and time the order was confirmed. */
|
|
1281
1314
|
timestamp?: Date | null;
|
|
1282
1315
|
/**
|
|
@@ -1318,7 +1351,16 @@ export interface OrderConfirmed {
|
|
|
1318
1351
|
email?: string;
|
|
1319
1352
|
/** Checkout form response. */
|
|
1320
1353
|
checkoutForm?: FormResponse;
|
|
1321
|
-
/**
|
|
1354
|
+
/**
|
|
1355
|
+
* Order status. Possible values:
|
|
1356
|
+
* - `FREE`: The order is confirmed, no payment is required.
|
|
1357
|
+
* - `PENDING`: The order was paid, but the payment gateway suspended the payment.
|
|
1358
|
+
* - `PAID`: The order is paid.
|
|
1359
|
+
* - `OFFLINE_PENDING`: The order is confirmed but has to be paid in cash and the status is manually updated to `PAID`.
|
|
1360
|
+
* - `INITIATED`: The order is awaiting for payment.
|
|
1361
|
+
* - `CANCELED`: The order is canceled.
|
|
1362
|
+
* - `DECLINED`: The order is payment is declined.
|
|
1363
|
+
*/
|
|
1322
1364
|
status?: OrderStatusWithLiterals;
|
|
1323
1365
|
/** Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc. */
|
|
1324
1366
|
method?: string | null;
|
|
@@ -1330,7 +1372,7 @@ export interface OrderConfirmed {
|
|
|
1330
1372
|
reservationId?: string;
|
|
1331
1373
|
}
|
|
1332
1374
|
/** Triggered when an order is paid. */
|
|
1333
|
-
|
|
1375
|
+
interface OrderPaid {
|
|
1334
1376
|
/** Date and time the order was paid. */
|
|
1335
1377
|
timestamp?: Date | null;
|
|
1336
1378
|
/**
|
|
@@ -1402,7 +1444,7 @@ export interface OrderPaid {
|
|
|
1402
1444
|
invoice?: Invoice;
|
|
1403
1445
|
}
|
|
1404
1446
|
/** Triggered when a reservation is created. */
|
|
1405
|
-
|
|
1447
|
+
interface ReservationCreated {
|
|
1406
1448
|
/** Date and time the reservation was created. */
|
|
1407
1449
|
timestamp?: Date | null;
|
|
1408
1450
|
/**
|
|
@@ -1426,14 +1468,14 @@ export interface ReservationCreated {
|
|
|
1426
1468
|
*/
|
|
1427
1469
|
quantities?: TicketQuantity[];
|
|
1428
1470
|
/** Date and time the reservation was updated. */
|
|
1429
|
-
|
|
1471
|
+
_updatedDate?: Date | null;
|
|
1430
1472
|
/**
|
|
1431
1473
|
* Number of reservations.
|
|
1432
1474
|
* @maxSize 50
|
|
1433
1475
|
*/
|
|
1434
1476
|
counts?: ReservationCount[];
|
|
1435
1477
|
}
|
|
1436
|
-
|
|
1478
|
+
declare enum ReservationStatus {
|
|
1437
1479
|
/** The Reservation is pending confirmation. It will expire after a certain amount of time. */
|
|
1438
1480
|
RESERVATION_PENDING = "RESERVATION_PENDING",
|
|
1439
1481
|
/** The reservation is confirmed and will not expire. */
|
|
@@ -1446,8 +1488,8 @@ export declare enum ReservationStatus {
|
|
|
1446
1488
|
RESERVATION_EXPIRED = "RESERVATION_EXPIRED"
|
|
1447
1489
|
}
|
|
1448
1490
|
/** @enumType */
|
|
1449
|
-
|
|
1450
|
-
|
|
1491
|
+
type ReservationStatusWithLiterals = ReservationStatus | 'RESERVATION_PENDING' | 'RESERVATION_CONFIRMED' | 'RESERVATION_CANCELED' | 'RESERVATION_CANCELED_MANUALLY' | 'RESERVATION_EXPIRED';
|
|
1492
|
+
interface TicketQuantity {
|
|
1451
1493
|
/**
|
|
1452
1494
|
* Ticket definition ID.
|
|
1453
1495
|
* @format GUID
|
|
@@ -1456,9 +1498,9 @@ export interface TicketQuantity {
|
|
|
1456
1498
|
/** Quantity. */
|
|
1457
1499
|
quantity?: number | null;
|
|
1458
1500
|
/** Quantity update timestamp. */
|
|
1459
|
-
|
|
1501
|
+
_updatedDate?: Date | null;
|
|
1460
1502
|
}
|
|
1461
|
-
|
|
1503
|
+
interface ReservationCount {
|
|
1462
1504
|
/** Reservation Count snapshot timestamp. */
|
|
1463
1505
|
timestamp?: Date | null;
|
|
1464
1506
|
/**
|
|
@@ -1474,7 +1516,7 @@ export interface ReservationCount {
|
|
|
1474
1516
|
paidExists?: boolean;
|
|
1475
1517
|
}
|
|
1476
1518
|
/** Triggered when a reservation is updated. */
|
|
1477
|
-
|
|
1519
|
+
interface ReservationUpdated {
|
|
1478
1520
|
/** Date and time the reservation was updated. */
|
|
1479
1521
|
timestamp?: Date | null;
|
|
1480
1522
|
/**
|
|
@@ -1498,16 +1540,16 @@ export interface ReservationUpdated {
|
|
|
1498
1540
|
*/
|
|
1499
1541
|
quantities?: TicketQuantity[];
|
|
1500
1542
|
/** Date and time the reservation was updated. */
|
|
1501
|
-
|
|
1543
|
+
_updatedDate?: Date | null;
|
|
1502
1544
|
/**
|
|
1503
1545
|
* Number of reservations.
|
|
1504
1546
|
* @maxSize 50
|
|
1505
1547
|
*/
|
|
1506
1548
|
counts?: ReservationCount[];
|
|
1507
1549
|
}
|
|
1508
|
-
|
|
1550
|
+
interface GetCheckoutOptionsRequest {
|
|
1509
1551
|
}
|
|
1510
|
-
|
|
1552
|
+
interface GetCheckoutOptionsResponse {
|
|
1511
1553
|
/** Whether any payment method is configured and available for payment. */
|
|
1512
1554
|
paymentMethodConfigured?: boolean;
|
|
1513
1555
|
/** Whether coupons are accepted at checkout. */
|
|
@@ -1519,7 +1561,7 @@ export interface GetCheckoutOptionsResponse {
|
|
|
1519
1561
|
/** Whether gift cards are accepted at checkout. */
|
|
1520
1562
|
acceptGiftCards?: boolean;
|
|
1521
1563
|
}
|
|
1522
|
-
|
|
1564
|
+
interface ListAvailableTicketsRequest {
|
|
1523
1565
|
/**
|
|
1524
1566
|
* Event ID to list tickets for. If not provided, available tickets for all events in the site will be returned.
|
|
1525
1567
|
* @format GUID
|
|
@@ -1534,25 +1576,24 @@ export interface ListAvailableTicketsRequest {
|
|
|
1534
1576
|
limit?: number;
|
|
1535
1577
|
/**
|
|
1536
1578
|
* Sort order.
|
|
1537
|
-
*
|
|
1538
1579
|
* Default: `created:asc`.
|
|
1539
1580
|
* @maxLength 100
|
|
1540
1581
|
*/
|
|
1541
1582
|
sort?: string;
|
|
1542
1583
|
state?: StateWithLiterals[];
|
|
1543
1584
|
}
|
|
1544
|
-
|
|
1585
|
+
declare enum State {
|
|
1545
1586
|
INCLUDE_HIDDEN_NOT_ON_SALE = "INCLUDE_HIDDEN_NOT_ON_SALE"
|
|
1546
1587
|
}
|
|
1547
1588
|
/** @enumType */
|
|
1548
|
-
|
|
1549
|
-
|
|
1589
|
+
type StateWithLiterals = State | 'INCLUDE_HIDDEN_NOT_ON_SALE';
|
|
1590
|
+
interface ListAvailableTicketsResponse {
|
|
1550
1591
|
/** Ticket definitions meta data. */
|
|
1551
1592
|
metaData?: ResponseMetaData;
|
|
1552
1593
|
/** Ticket definitions. */
|
|
1553
1594
|
definitions?: TicketDefinition[];
|
|
1554
1595
|
}
|
|
1555
|
-
|
|
1596
|
+
interface ResponseMetaData {
|
|
1556
1597
|
/** Number of items in the response. */
|
|
1557
1598
|
count?: number;
|
|
1558
1599
|
/** Offset of items. */
|
|
@@ -1560,12 +1601,12 @@ export interface ResponseMetaData {
|
|
|
1560
1601
|
/** Total number of matching items. */
|
|
1561
1602
|
total?: number;
|
|
1562
1603
|
}
|
|
1563
|
-
|
|
1604
|
+
interface TicketDefinition {
|
|
1564
1605
|
/**
|
|
1565
1606
|
* Ticket definition ID.
|
|
1566
1607
|
* @format GUID
|
|
1567
1608
|
*/
|
|
1568
|
-
|
|
1609
|
+
_id?: string;
|
|
1569
1610
|
/** Ticket price. */
|
|
1570
1611
|
price?: Money;
|
|
1571
1612
|
/** Whether the ticket is free (read only). */
|
|
@@ -1575,14 +1616,13 @@ export interface TicketDefinition {
|
|
|
1575
1616
|
/** Ticket description. */
|
|
1576
1617
|
description?: string;
|
|
1577
1618
|
/**
|
|
1578
|
-
* Limit of tickets that can be purchased per checkout.
|
|
1579
|
-
* Set to 20 for unlimited ticket definition.
|
|
1619
|
+
* Limit of tickets that can be purchased per checkout. If tickets are unlimited in the definition, the limit per checkout is 20 tickets.
|
|
1580
1620
|
* @max 20
|
|
1581
1621
|
*/
|
|
1582
1622
|
limitPerCheckout?: number;
|
|
1583
1623
|
/** Custom sort index. */
|
|
1584
1624
|
orderIndex?: number;
|
|
1585
|
-
/**
|
|
1625
|
+
/** Event and ticket policies. */
|
|
1586
1626
|
policy?: string;
|
|
1587
1627
|
/** Sensitive dashboard data. */
|
|
1588
1628
|
dashboard?: Dashboard;
|
|
@@ -1608,7 +1648,7 @@ export interface TicketDefinition {
|
|
|
1608
1648
|
/** Ticket pricing. */
|
|
1609
1649
|
pricing?: TicketPricing;
|
|
1610
1650
|
}
|
|
1611
|
-
|
|
1651
|
+
interface Dashboard {
|
|
1612
1652
|
/** Whether ticket is hidden and cannot be sold. */
|
|
1613
1653
|
hidden?: boolean;
|
|
1614
1654
|
/**
|
|
@@ -1618,20 +1658,20 @@ export interface Dashboard {
|
|
|
1618
1658
|
sold?: number;
|
|
1619
1659
|
/** Whether the ticket has limited quantity. */
|
|
1620
1660
|
limited?: boolean;
|
|
1621
|
-
/** Ticket limit. `NULL`
|
|
1661
|
+
/** Ticket limit. `NULL` if the tickets are unlimited. */
|
|
1622
1662
|
quantity?: number | null;
|
|
1623
|
-
/** Number of unsold tickets. `NULL`
|
|
1663
|
+
/** Number of unsold tickets. `NULL` if the tickets are unlimited. */
|
|
1624
1664
|
unsold?: number | null;
|
|
1625
1665
|
/** Number of tickets sold. */
|
|
1626
1666
|
ticketsSold?: number;
|
|
1627
1667
|
/** Number of tickets reserved. */
|
|
1628
1668
|
ticketsReserved?: number;
|
|
1629
1669
|
}
|
|
1630
|
-
|
|
1670
|
+
interface WixFeeConfig {
|
|
1631
1671
|
/** Fee calculation method. */
|
|
1632
1672
|
type?: FeeTypeWithLiterals;
|
|
1633
1673
|
}
|
|
1634
|
-
|
|
1674
|
+
interface TicketSalePeriod {
|
|
1635
1675
|
/** Ticket sale start timestamp. */
|
|
1636
1676
|
startDate?: Date | null;
|
|
1637
1677
|
/** Ticket sale end timestamp. */
|
|
@@ -1639,7 +1679,7 @@ export interface TicketSalePeriod {
|
|
|
1639
1679
|
/** Whether to hide this ticket if it's not on sale */
|
|
1640
1680
|
hideNotOnSale?: boolean;
|
|
1641
1681
|
}
|
|
1642
|
-
|
|
1682
|
+
declare enum TicketSaleStatus {
|
|
1643
1683
|
/** Ticket sale is scheduled to start. */
|
|
1644
1684
|
SALE_SCHEDULED = "SALE_SCHEDULED",
|
|
1645
1685
|
/** Ticket sale has started. */
|
|
@@ -1648,8 +1688,8 @@ export declare enum TicketSaleStatus {
|
|
|
1648
1688
|
SALE_ENDED = "SALE_ENDED"
|
|
1649
1689
|
}
|
|
1650
1690
|
/** @enumType */
|
|
1651
|
-
|
|
1652
|
-
|
|
1691
|
+
type TicketSaleStatusWithLiterals = TicketSaleStatus | 'SALE_SCHEDULED' | 'SALE_STARTED' | 'SALE_ENDED';
|
|
1692
|
+
interface TicketPricing extends TicketPricingPriceOneOf {
|
|
1653
1693
|
/** Ticket price which is read only. */
|
|
1654
1694
|
fixedPrice?: Money;
|
|
1655
1695
|
/** Min price per ticket, customizable. */
|
|
@@ -1663,7 +1703,7 @@ export interface TicketPricing extends TicketPricingPriceOneOf {
|
|
|
1663
1703
|
pricingType?: TypeWithLiterals;
|
|
1664
1704
|
}
|
|
1665
1705
|
/** @oneof */
|
|
1666
|
-
|
|
1706
|
+
interface TicketPricingPriceOneOf {
|
|
1667
1707
|
/** Ticket price which is read only. */
|
|
1668
1708
|
fixedPrice?: Money;
|
|
1669
1709
|
/** Min price per ticket, customizable. */
|
|
@@ -1671,16 +1711,16 @@ export interface TicketPricingPriceOneOf {
|
|
|
1671
1711
|
/** Ticket pricing options. */
|
|
1672
1712
|
pricingOptions?: PricingOptions;
|
|
1673
1713
|
}
|
|
1674
|
-
|
|
1714
|
+
interface PricingOptions {
|
|
1675
1715
|
/** Multiple ticket pricing options. */
|
|
1676
1716
|
options?: PricingOption[];
|
|
1677
1717
|
}
|
|
1678
|
-
|
|
1718
|
+
interface PricingOption {
|
|
1679
1719
|
/**
|
|
1680
1720
|
* Ticket pricing option ID.
|
|
1681
1721
|
* @format GUID
|
|
1682
1722
|
*/
|
|
1683
|
-
|
|
1723
|
+
_id?: string | null;
|
|
1684
1724
|
/**
|
|
1685
1725
|
* Ticket pricing option name.
|
|
1686
1726
|
* @minLength 1
|
|
@@ -1690,13 +1730,13 @@ export interface PricingOption {
|
|
|
1690
1730
|
/** Ticket pricing option price. */
|
|
1691
1731
|
price?: Money;
|
|
1692
1732
|
}
|
|
1693
|
-
|
|
1733
|
+
declare enum Type {
|
|
1694
1734
|
STANDARD = "STANDARD",
|
|
1695
1735
|
DONATION = "DONATION"
|
|
1696
1736
|
}
|
|
1697
1737
|
/** @enumType */
|
|
1698
|
-
|
|
1699
|
-
|
|
1738
|
+
type TypeWithLiterals = Type | 'STANDARD' | 'DONATION';
|
|
1739
|
+
interface QueryAvailableTicketsRequest {
|
|
1700
1740
|
/** Offset. */
|
|
1701
1741
|
offset?: number;
|
|
1702
1742
|
/**
|
|
@@ -1713,27 +1753,26 @@ export interface QueryAvailableTicketsRequest {
|
|
|
1713
1753
|
fieldset?: TicketDefinitionFieldsetWithLiterals[];
|
|
1714
1754
|
/**
|
|
1715
1755
|
* Sort order.
|
|
1716
|
-
*
|
|
1717
|
-
* Default: `"created:asc"`.
|
|
1756
|
+
* Default: `created:asc`.
|
|
1718
1757
|
* @maxLength 100
|
|
1719
1758
|
*/
|
|
1720
1759
|
sort?: string;
|
|
1721
1760
|
}
|
|
1722
|
-
|
|
1761
|
+
declare enum TicketDefinitionFieldset {
|
|
1723
1762
|
/** Include `policy` in the response. */
|
|
1724
1763
|
POLICY = "POLICY",
|
|
1725
1764
|
/** Include `dashboard` in the response. */
|
|
1726
1765
|
DASHBOARD = "DASHBOARD"
|
|
1727
1766
|
}
|
|
1728
1767
|
/** @enumType */
|
|
1729
|
-
|
|
1730
|
-
|
|
1768
|
+
type TicketDefinitionFieldsetWithLiterals = TicketDefinitionFieldset | 'POLICY' | 'DASHBOARD';
|
|
1769
|
+
interface QueryAvailableTicketsResponse {
|
|
1731
1770
|
/** Ticket definitions meta data. */
|
|
1732
1771
|
metaData?: ResponseMetaData;
|
|
1733
1772
|
/** Ticket definitions. */
|
|
1734
1773
|
definitions?: TicketDefinition[];
|
|
1735
1774
|
}
|
|
1736
|
-
|
|
1775
|
+
interface CreateReservationRequest {
|
|
1737
1776
|
/**
|
|
1738
1777
|
* Event ID to which the reservation belongs.
|
|
1739
1778
|
* @format GUID
|
|
@@ -1750,7 +1789,7 @@ export interface CreateReservationRequest {
|
|
|
1750
1789
|
/** Whether to allow reservations for hidden tickets. */
|
|
1751
1790
|
allowHiddenTickets?: boolean;
|
|
1752
1791
|
}
|
|
1753
|
-
|
|
1792
|
+
interface TicketReservationQuantity {
|
|
1754
1793
|
/**
|
|
1755
1794
|
* Ticket definition ID.
|
|
1756
1795
|
* @format GUID
|
|
@@ -1763,7 +1802,7 @@ export interface TicketReservationQuantity {
|
|
|
1763
1802
|
*/
|
|
1764
1803
|
quantity?: number;
|
|
1765
1804
|
/**
|
|
1766
|
-
*
|
|
1805
|
+
* Override the predefined ticket price.
|
|
1767
1806
|
* @maxLength 13
|
|
1768
1807
|
* @format DECIMAL_VALUE
|
|
1769
1808
|
*/
|
|
@@ -1771,12 +1810,12 @@ export interface TicketReservationQuantity {
|
|
|
1771
1810
|
/** Optional ticket details */
|
|
1772
1811
|
ticketDetails?: TicketDetails[];
|
|
1773
1812
|
}
|
|
1774
|
-
|
|
1813
|
+
interface CreateReservationResponse {
|
|
1775
1814
|
/**
|
|
1776
1815
|
* Reservation ID.
|
|
1777
1816
|
* @format GUID
|
|
1778
1817
|
*/
|
|
1779
|
-
|
|
1818
|
+
_id?: string;
|
|
1780
1819
|
/** Date and time the reservation expires. */
|
|
1781
1820
|
expires?: Date | null;
|
|
1782
1821
|
/** Ticket reservations. */
|
|
@@ -1786,18 +1825,19 @@ export interface CreateReservationResponse {
|
|
|
1786
1825
|
/** Reservation status. */
|
|
1787
1826
|
reservationStatus?: ReservationStatusWithLiterals;
|
|
1788
1827
|
}
|
|
1789
|
-
|
|
1828
|
+
interface TicketReservation {
|
|
1790
1829
|
/**
|
|
1791
1830
|
* Amount of reserved tickets.
|
|
1792
1831
|
* @min 1
|
|
1793
1832
|
* @max 20
|
|
1794
1833
|
*/
|
|
1795
1834
|
quantity?: number;
|
|
1835
|
+
/** An object containing ticket information. */
|
|
1796
1836
|
ticket?: TicketDefinition;
|
|
1797
1837
|
/** Optional ticket details. */
|
|
1798
1838
|
ticketDetails?: TicketDetails[];
|
|
1799
1839
|
}
|
|
1800
|
-
|
|
1840
|
+
interface CancelReservationRequest {
|
|
1801
1841
|
/**
|
|
1802
1842
|
* Event ID to which the reservation belongs.
|
|
1803
1843
|
* @format GUID
|
|
@@ -1807,11 +1847,11 @@ export interface CancelReservationRequest {
|
|
|
1807
1847
|
* Reservation ID.
|
|
1808
1848
|
* @format GUID
|
|
1809
1849
|
*/
|
|
1810
|
-
|
|
1850
|
+
_id: string;
|
|
1811
1851
|
}
|
|
1812
|
-
|
|
1852
|
+
interface CancelReservationResponse {
|
|
1813
1853
|
}
|
|
1814
|
-
|
|
1854
|
+
interface GetInvoiceRequest {
|
|
1815
1855
|
/**
|
|
1816
1856
|
* Event ID to which the invoice belongs.
|
|
1817
1857
|
* @format GUID
|
|
@@ -1827,14 +1867,14 @@ export interface GetInvoiceRequest {
|
|
|
1827
1867
|
/** Optional benefit granted by the pricing plan to be applied on the returned invoice. */
|
|
1828
1868
|
paidPlanBenefit?: PaidPlanBenefit;
|
|
1829
1869
|
}
|
|
1830
|
-
|
|
1870
|
+
interface DiscountRequest {
|
|
1831
1871
|
/**
|
|
1832
1872
|
* Discount coupon code.
|
|
1833
1873
|
* @maxLength 20
|
|
1834
1874
|
*/
|
|
1835
1875
|
couponCode?: string;
|
|
1836
1876
|
}
|
|
1837
|
-
|
|
1877
|
+
interface PaidPlanBenefit {
|
|
1838
1878
|
/**
|
|
1839
1879
|
* Pricing plan ID.
|
|
1840
1880
|
* @format GUID
|
|
@@ -1846,41 +1886,49 @@ export interface PaidPlanBenefit {
|
|
|
1846
1886
|
*/
|
|
1847
1887
|
benefitId?: string;
|
|
1848
1888
|
}
|
|
1849
|
-
|
|
1889
|
+
interface GetInvoiceResponse {
|
|
1850
1890
|
/** Invoice with applied discount. */
|
|
1851
1891
|
invoice?: Invoice;
|
|
1852
1892
|
/** Discount errors, if relevant. */
|
|
1853
1893
|
discountErrors?: DiscountErrors;
|
|
1854
|
-
/**
|
|
1894
|
+
/** Reservation expiration time. */
|
|
1855
1895
|
expires?: Date | null;
|
|
1856
|
-
/**
|
|
1896
|
+
/**
|
|
1897
|
+
* Reservation status. Possible values:
|
|
1898
|
+
* - `RESERVATION_PENDING`: The reservation is pending confirmation. It will expire after a certain amount of time.
|
|
1899
|
+
* - `RESERVATION_CONFIRMED`: The reservation is confirmed and will not expire.
|
|
1900
|
+
* - `RESERVATION_CANCELED`: The reservation is canceled because it's not paid.
|
|
1901
|
+
* - `RESERVATION_CANCELED_MANUALLY`: The reservation is canceled manually by the buyer.
|
|
1902
|
+
* - `RESERVATION_EXPIRED`: The reservation has expired.
|
|
1903
|
+
*/
|
|
1857
1904
|
reservationStatus?: ReservationStatusWithLiterals;
|
|
1858
1905
|
/** Whether this reservation is already used in a checkout. */
|
|
1859
1906
|
reservationOccupied?: boolean;
|
|
1860
1907
|
/** Ticket reservations. */
|
|
1861
1908
|
reservations?: TicketReservation[];
|
|
1862
1909
|
}
|
|
1863
|
-
|
|
1864
|
-
/**
|
|
1910
|
+
interface DiscountErrors {
|
|
1911
|
+
/** Object containing error information. */
|
|
1865
1912
|
error?: Error[];
|
|
1866
1913
|
}
|
|
1867
|
-
|
|
1914
|
+
interface Error {
|
|
1915
|
+
/** A code identifying the error type. */
|
|
1868
1916
|
code?: string;
|
|
1869
1917
|
}
|
|
1870
|
-
|
|
1918
|
+
interface GiftCardErrors {
|
|
1871
1919
|
/**
|
|
1872
1920
|
* Error.
|
|
1873
1921
|
* @maxSize 10
|
|
1874
1922
|
*/
|
|
1875
1923
|
error?: GiftCardErrorsError[];
|
|
1876
1924
|
}
|
|
1877
|
-
|
|
1925
|
+
interface GiftCardErrorsError {
|
|
1878
1926
|
/** @maxLength 100 */
|
|
1879
1927
|
code?: string;
|
|
1880
1928
|
}
|
|
1881
|
-
|
|
1929
|
+
interface CheckoutRequest {
|
|
1882
1930
|
/**
|
|
1883
|
-
* Event ID.
|
|
1931
|
+
* Event ID to which the checkout belongs.
|
|
1884
1932
|
* @format GUID
|
|
1885
1933
|
*/
|
|
1886
1934
|
eventId: string;
|
|
@@ -1908,7 +1956,7 @@ export interface CheckoutRequest {
|
|
|
1908
1956
|
/** Whether marketing consent was given */
|
|
1909
1957
|
marketingConsent?: boolean | null;
|
|
1910
1958
|
}
|
|
1911
|
-
|
|
1959
|
+
interface Buyer {
|
|
1912
1960
|
/**
|
|
1913
1961
|
* Buyer first name.
|
|
1914
1962
|
* @minLength 1
|
|
@@ -1929,11 +1977,11 @@ export interface Buyer {
|
|
|
1929
1977
|
*/
|
|
1930
1978
|
email?: string;
|
|
1931
1979
|
}
|
|
1932
|
-
|
|
1980
|
+
interface Guest {
|
|
1933
1981
|
/** Specific guest info. */
|
|
1934
1982
|
form?: FormResponse;
|
|
1935
1983
|
}
|
|
1936
|
-
|
|
1984
|
+
interface CheckoutOptions {
|
|
1937
1985
|
/** Whether to ignore settings to notify contacts. */
|
|
1938
1986
|
silent?: boolean;
|
|
1939
1987
|
/** 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. */
|
|
@@ -1943,10 +1991,13 @@ export interface CheckoutOptions {
|
|
|
1943
1991
|
/** Marks payment as already paid */
|
|
1944
1992
|
markAsPaid?: boolean | null;
|
|
1945
1993
|
}
|
|
1946
|
-
|
|
1994
|
+
interface CheckoutResponse {
|
|
1947
1995
|
/** Created order. */
|
|
1948
1996
|
order?: Order;
|
|
1949
|
-
/**
|
|
1997
|
+
/**
|
|
1998
|
+
* Order expiration time.
|
|
1999
|
+
* **Note:** Only applicable to orders with the `INITIATED` status.
|
|
2000
|
+
*/
|
|
1950
2001
|
expires?: Date | null;
|
|
1951
2002
|
/** Ticket reservations. */
|
|
1952
2003
|
reservations?: TicketReservation[];
|
|
@@ -1954,7 +2005,7 @@ export interface CheckoutResponse {
|
|
|
1954
2005
|
orderPageUrl?: string | null;
|
|
1955
2006
|
}
|
|
1956
2007
|
/** Triggered when an order is initiated. */
|
|
1957
|
-
|
|
2008
|
+
interface OrderInitiated {
|
|
1958
2009
|
/** Date and time the order was initiated. */
|
|
1959
2010
|
timestamp?: Date | null;
|
|
1960
2011
|
/**
|
|
@@ -1999,7 +2050,16 @@ export interface OrderInitiated {
|
|
|
1999
2050
|
email?: string;
|
|
2000
2051
|
/** Checkout form response. */
|
|
2001
2052
|
checkoutForm?: FormResponse;
|
|
2002
|
-
/**
|
|
2053
|
+
/**
|
|
2054
|
+
* Order status. Possible values:
|
|
2055
|
+
* - `FREE`: The order is confirmed, no payment is required.
|
|
2056
|
+
* - `PENDING`: The order was paid, but the payment gateway suspended the payment.
|
|
2057
|
+
* - `PAID`: The order is paid.
|
|
2058
|
+
* - `OFFLINE_PENDING`: The order is confirmed but has to be paid in cash and the status is manually updated to `PAID`.
|
|
2059
|
+
* - `INITIATED`: The order is awaiting for payment.
|
|
2060
|
+
* - `CANCELED`: The order is canceled.
|
|
2061
|
+
* - `DECLINED`: The order is payment is declined.
|
|
2062
|
+
*/
|
|
2003
2063
|
status?: OrderStatusWithLiterals;
|
|
2004
2064
|
/** Invoice. */
|
|
2005
2065
|
invoice?: Invoice;
|
|
@@ -2008,7 +2068,7 @@ export interface OrderInitiated {
|
|
|
2008
2068
|
/** Order was marked as paid. */
|
|
2009
2069
|
markedAsPaid?: boolean | null;
|
|
2010
2070
|
}
|
|
2011
|
-
|
|
2071
|
+
interface UpdateCheckoutRequest {
|
|
2012
2072
|
/**
|
|
2013
2073
|
* Event ID to which the checkout belongs.
|
|
2014
2074
|
* @format GUID
|
|
@@ -2038,13 +2098,13 @@ export interface UpdateCheckoutRequest {
|
|
|
2038
2098
|
/** Benefit granted by the pricing plan. */
|
|
2039
2099
|
paidPlanBenefit?: PaidPlanBenefit;
|
|
2040
2100
|
}
|
|
2041
|
-
|
|
2101
|
+
interface UpdateCheckoutResponse {
|
|
2042
2102
|
/** Updated order. */
|
|
2043
2103
|
order?: Order;
|
|
2044
2104
|
/** Order page URL. */
|
|
2045
2105
|
orderPageUrl?: string | null;
|
|
2046
2106
|
}
|
|
2047
|
-
|
|
2107
|
+
interface OrderPageUrls {
|
|
2048
2108
|
/**
|
|
2049
2109
|
* Success order page URL.
|
|
2050
2110
|
* @format WEB_URL
|
|
@@ -2066,9 +2126,9 @@ export interface OrderPageUrls {
|
|
|
2066
2126
|
*/
|
|
2067
2127
|
error?: string | null;
|
|
2068
2128
|
}
|
|
2069
|
-
|
|
2129
|
+
interface PosCheckoutRequest {
|
|
2070
2130
|
/**
|
|
2071
|
-
* Event ID.
|
|
2131
|
+
* Event ID to which the checkout belongs.
|
|
2072
2132
|
* @format GUID
|
|
2073
2133
|
*/
|
|
2074
2134
|
eventId: string;
|
|
@@ -2084,7 +2144,7 @@ export interface PosCheckoutRequest {
|
|
|
2084
2144
|
*/
|
|
2085
2145
|
paymentDetailsId?: string | null;
|
|
2086
2146
|
}
|
|
2087
|
-
|
|
2147
|
+
interface PosCheckoutResponse {
|
|
2088
2148
|
/** Created order. */
|
|
2089
2149
|
order?: Order;
|
|
2090
2150
|
/** Time when the order expires, applies to orders with status = INITIATED. */
|
|
@@ -2092,7 +2152,7 @@ export interface PosCheckoutResponse {
|
|
|
2092
2152
|
/** Ticket reservations. */
|
|
2093
2153
|
reservations?: TicketReservation[];
|
|
2094
2154
|
}
|
|
2095
|
-
|
|
2155
|
+
interface GetReservationRequest {
|
|
2096
2156
|
/**
|
|
2097
2157
|
* Event ID.
|
|
2098
2158
|
* @format GUID
|
|
@@ -2104,15 +2164,15 @@ export interface GetReservationRequest {
|
|
|
2104
2164
|
*/
|
|
2105
2165
|
reservationId?: string | null;
|
|
2106
2166
|
}
|
|
2107
|
-
|
|
2167
|
+
interface GetReservationResponse {
|
|
2108
2168
|
/** Reservation. */
|
|
2109
2169
|
reservation?: Reservation;
|
|
2110
2170
|
}
|
|
2111
|
-
|
|
2171
|
+
interface Reservation {
|
|
2112
2172
|
/** Date and time the Ticket Reservation was created. */
|
|
2113
|
-
|
|
2173
|
+
_createdDate?: Date | null;
|
|
2114
2174
|
/** Date and time the Ticket Reservation was last updated. */
|
|
2115
|
-
|
|
2175
|
+
_updatedDate?: Date | null;
|
|
2116
2176
|
/** Date and time the pending ticket reservation will expire. */
|
|
2117
2177
|
expirationDate?: Date | null;
|
|
2118
2178
|
/** Reservation status. */
|
|
@@ -2123,7 +2183,7 @@ export interface Reservation {
|
|
|
2123
2183
|
*/
|
|
2124
2184
|
reservations?: TicketReservation[];
|
|
2125
2185
|
}
|
|
2126
|
-
|
|
2186
|
+
interface ConfirmReservationRequest {
|
|
2127
2187
|
/**
|
|
2128
2188
|
* Event ID.
|
|
2129
2189
|
* @format GUID
|
|
@@ -2135,11 +2195,11 @@ export interface ConfirmReservationRequest {
|
|
|
2135
2195
|
*/
|
|
2136
2196
|
reservationId?: string | null;
|
|
2137
2197
|
}
|
|
2138
|
-
|
|
2198
|
+
interface ConfirmReservationResponse {
|
|
2139
2199
|
/** Reservation. */
|
|
2140
2200
|
reservation?: Reservation;
|
|
2141
2201
|
}
|
|
2142
|
-
|
|
2202
|
+
interface ExpireReservationRequest {
|
|
2143
2203
|
/**
|
|
2144
2204
|
* Event ID.
|
|
2145
2205
|
* @format GUID
|
|
@@ -2151,11 +2211,11 @@ export interface ExpireReservationRequest {
|
|
|
2151
2211
|
*/
|
|
2152
2212
|
reservationId?: string | null;
|
|
2153
2213
|
}
|
|
2154
|
-
|
|
2214
|
+
interface ExpireReservationResponse {
|
|
2155
2215
|
/** Reservation. */
|
|
2156
2216
|
reservation?: Reservation;
|
|
2157
2217
|
}
|
|
2158
|
-
|
|
2218
|
+
interface QueryEventsWithPaidReservationsRequest {
|
|
2159
2219
|
/**
|
|
2160
2220
|
* Event Keys.
|
|
2161
2221
|
* @minSize 1
|
|
@@ -2163,7 +2223,7 @@ export interface QueryEventsWithPaidReservationsRequest {
|
|
|
2163
2223
|
*/
|
|
2164
2224
|
eventKeys?: EventKey[];
|
|
2165
2225
|
}
|
|
2166
|
-
|
|
2226
|
+
interface EventKey {
|
|
2167
2227
|
/**
|
|
2168
2228
|
* Instance ID.
|
|
2169
2229
|
* @format GUID
|
|
@@ -2175,7 +2235,7 @@ export interface EventKey {
|
|
|
2175
2235
|
*/
|
|
2176
2236
|
eventId?: string | null;
|
|
2177
2237
|
}
|
|
2178
|
-
|
|
2238
|
+
interface QueryEventsWithPaidReservationsResponse {
|
|
2179
2239
|
/**
|
|
2180
2240
|
* Event IDs.
|
|
2181
2241
|
* @format GUID
|
|
@@ -2183,3 +2243,331 @@ export interface QueryEventsWithPaidReservationsResponse {
|
|
|
2183
2243
|
*/
|
|
2184
2244
|
eventIds?: string[] | null;
|
|
2185
2245
|
}
|
|
2246
|
+
interface BaseEventMetadata {
|
|
2247
|
+
/**
|
|
2248
|
+
* App instance ID.
|
|
2249
|
+
* @format GUID
|
|
2250
|
+
*/
|
|
2251
|
+
instanceId?: string | null;
|
|
2252
|
+
/**
|
|
2253
|
+
* Event type.
|
|
2254
|
+
* @maxLength 150
|
|
2255
|
+
*/
|
|
2256
|
+
eventType?: string;
|
|
2257
|
+
/** The identification type and identity data. */
|
|
2258
|
+
identity?: IdentificationData;
|
|
2259
|
+
}
|
|
2260
|
+
interface OrderDeletedEnvelope {
|
|
2261
|
+
data: OrderDeleted;
|
|
2262
|
+
metadata: BaseEventMetadata;
|
|
2263
|
+
}
|
|
2264
|
+
interface OrderUpdatedEnvelope {
|
|
2265
|
+
data: OrderUpdated;
|
|
2266
|
+
metadata: BaseEventMetadata;
|
|
2267
|
+
}
|
|
2268
|
+
interface OrderConfirmedEnvelope {
|
|
2269
|
+
data: OrderConfirmed;
|
|
2270
|
+
metadata: BaseEventMetadata;
|
|
2271
|
+
}
|
|
2272
|
+
interface OrderInitiatedEnvelope {
|
|
2273
|
+
data: OrderInitiated;
|
|
2274
|
+
metadata: BaseEventMetadata;
|
|
2275
|
+
}
|
|
2276
|
+
interface OrderReservationCreatedEnvelope {
|
|
2277
|
+
data: ReservationCreated;
|
|
2278
|
+
metadata: BaseEventMetadata;
|
|
2279
|
+
}
|
|
2280
|
+
interface OrderReservationUpdatedEnvelope {
|
|
2281
|
+
data: ReservationUpdated;
|
|
2282
|
+
metadata: BaseEventMetadata;
|
|
2283
|
+
}
|
|
2284
|
+
interface ListOrdersOptions {
|
|
2285
|
+
/** Offset. */
|
|
2286
|
+
offset?: number;
|
|
2287
|
+
/**
|
|
2288
|
+
* Limit.
|
|
2289
|
+
* @max 400
|
|
2290
|
+
*/
|
|
2291
|
+
limit?: number;
|
|
2292
|
+
/**
|
|
2293
|
+
* Predefined sets of fields to return.
|
|
2294
|
+
* - `TICKETS`: Returns `tickets`.
|
|
2295
|
+
* - `DETAILS`: Returns `reservationId`, `snapshotId`, `created`, `firstName`, `lastName`, `confirmed`, `status`, `method`, `ticketsQuantity`, `totalPrice`, `ticketsPdf`, `archived`, `fullName`.
|
|
2296
|
+
* - `FORM` : Returns `checkoutForm`.
|
|
2297
|
+
* - `INVOICE`: Returns `invoice`.
|
|
2298
|
+
*
|
|
2299
|
+
* Default: If `fieldset` is not included in the request, `orderNumber`, `eventId`, `contactId`, `memberId`, `anonymized`, `fullyCheckedIn` are returned.
|
|
2300
|
+
* @maxSize 20
|
|
2301
|
+
*/
|
|
2302
|
+
fieldset?: OrderFieldsetWithLiterals[];
|
|
2303
|
+
/**
|
|
2304
|
+
* Order status. Possible values:
|
|
2305
|
+
* - `FREE`: The order is confirmed, no payment is required.
|
|
2306
|
+
* - `PENDING`: The order was paid, but the payment gateway suspended the payment.
|
|
2307
|
+
* - `PAID`: The order is paid.
|
|
2308
|
+
* - `OFFLINE_PENDING`: The order is confirmed but has to be paid in cash and the status is manually updated to `PAID`.
|
|
2309
|
+
* - `INITIATED`: The order is awaiting for payment.
|
|
2310
|
+
* - `CANCELED`: The order is canceled.
|
|
2311
|
+
* - `DECLINED`: The order is payment is declined.
|
|
2312
|
+
*/
|
|
2313
|
+
status?: OrderStatusWithLiterals[];
|
|
2314
|
+
/**
|
|
2315
|
+
* Event ID to which the order belongs.
|
|
2316
|
+
* @format GUID
|
|
2317
|
+
* @maxSize 100
|
|
2318
|
+
*/
|
|
2319
|
+
eventId?: string[];
|
|
2320
|
+
/**
|
|
2321
|
+
* Order number.
|
|
2322
|
+
* @maxLength 36
|
|
2323
|
+
* @maxSize 500
|
|
2324
|
+
*/
|
|
2325
|
+
orderNumber?: string[];
|
|
2326
|
+
/**
|
|
2327
|
+
* Site member ID.
|
|
2328
|
+
* @format GUID
|
|
2329
|
+
* @maxSize 500
|
|
2330
|
+
*/
|
|
2331
|
+
memberId?: string[];
|
|
2332
|
+
/**
|
|
2333
|
+
* Field facets.
|
|
2334
|
+
* @maxLength 100
|
|
2335
|
+
* @maxSize 20
|
|
2336
|
+
*/
|
|
2337
|
+
facet?: string[];
|
|
2338
|
+
/**
|
|
2339
|
+
* Search filter. You can search `fullName`, `email` and `orderNumber`.
|
|
2340
|
+
* @maxLength 200
|
|
2341
|
+
*/
|
|
2342
|
+
searchPhrase?: string;
|
|
2343
|
+
/**
|
|
2344
|
+
* Event creator ID.
|
|
2345
|
+
* @format GUID
|
|
2346
|
+
* @maxSize 50
|
|
2347
|
+
*/
|
|
2348
|
+
eventCreatorId?: string[];
|
|
2349
|
+
/**
|
|
2350
|
+
* Sort order.
|
|
2351
|
+
* Default: `created:asc`.
|
|
2352
|
+
* @maxLength 100
|
|
2353
|
+
*/
|
|
2354
|
+
sort?: string;
|
|
2355
|
+
/** Order tag. */
|
|
2356
|
+
tag?: OrderTagWithLiterals[];
|
|
2357
|
+
/**
|
|
2358
|
+
* Guest contact IDs.
|
|
2359
|
+
* @format GUID
|
|
2360
|
+
* @maxSize 100
|
|
2361
|
+
*/
|
|
2362
|
+
contactId?: string[];
|
|
2363
|
+
}
|
|
2364
|
+
interface GetOrderIdentifiers {
|
|
2365
|
+
/**
|
|
2366
|
+
* Event ID to which the order belongs.
|
|
2367
|
+
* @format GUID
|
|
2368
|
+
*/
|
|
2369
|
+
eventId: string;
|
|
2370
|
+
/**
|
|
2371
|
+
* Unique order number.
|
|
2372
|
+
* @maxLength 36
|
|
2373
|
+
*/
|
|
2374
|
+
orderNumber: string;
|
|
2375
|
+
}
|
|
2376
|
+
interface GetOrderOptions {
|
|
2377
|
+
/**
|
|
2378
|
+
* Predefined sets of fields to return.
|
|
2379
|
+
* - `TICKETS`: Returns `tickets`.
|
|
2380
|
+
* - `DETAILS`: Returns `reservationId`, `snapshotId`, `created`, `firstName`, `lastName`, `confirmed`, `status`, `method`, `ticketsQuantity`, `totalPrice`, `ticketsPdf`, `archived`, `fullName`.
|
|
2381
|
+
* - `FORM` : Returns `checkoutForm`.
|
|
2382
|
+
* - `INVOICE`: Returns `invoice`.
|
|
2383
|
+
*
|
|
2384
|
+
* Default: If `fieldset` is not included in the request, `orderNumber`, `eventId`, `contactId`, `memberId`, `anonymized`, `fullyCheckedIn` are returned.
|
|
2385
|
+
* @maxSize 20
|
|
2386
|
+
*/
|
|
2387
|
+
fieldset?: OrderFieldsetWithLiterals[];
|
|
2388
|
+
}
|
|
2389
|
+
interface UpdateOrderIdentifiers {
|
|
2390
|
+
/**
|
|
2391
|
+
* Event ID to which the order belongs.
|
|
2392
|
+
* @format GUID
|
|
2393
|
+
*/
|
|
2394
|
+
eventId: string;
|
|
2395
|
+
/**
|
|
2396
|
+
* Unique order number.
|
|
2397
|
+
* @maxLength 36
|
|
2398
|
+
*/
|
|
2399
|
+
orderNumber: string;
|
|
2400
|
+
}
|
|
2401
|
+
interface UpdateOrderOptions {
|
|
2402
|
+
/** Set of field paths to update. */
|
|
2403
|
+
fields?: string[];
|
|
2404
|
+
/** Checkout form. */
|
|
2405
|
+
checkoutForm?: FormResponse;
|
|
2406
|
+
/** Whether to archive the order. */
|
|
2407
|
+
archived?: boolean;
|
|
2408
|
+
}
|
|
2409
|
+
interface BulkUpdateOrdersOptions {
|
|
2410
|
+
/**
|
|
2411
|
+
* Unique order number.
|
|
2412
|
+
* @minLength 1
|
|
2413
|
+
* @maxLength 36
|
|
2414
|
+
* @minSize 1
|
|
2415
|
+
* @maxSize 100
|
|
2416
|
+
*/
|
|
2417
|
+
orderNumber?: string[];
|
|
2418
|
+
/** Set of fields to update. */
|
|
2419
|
+
fields?: string[];
|
|
2420
|
+
/** Whether to archive the order. */
|
|
2421
|
+
archived?: boolean;
|
|
2422
|
+
}
|
|
2423
|
+
interface ConfirmOrderOptions {
|
|
2424
|
+
/**
|
|
2425
|
+
* Order numbers.
|
|
2426
|
+
* @minLength 1
|
|
2427
|
+
* @maxLength 36
|
|
2428
|
+
* @maxSize 100
|
|
2429
|
+
*/
|
|
2430
|
+
orderNumber?: string[];
|
|
2431
|
+
}
|
|
2432
|
+
interface GetSummaryOptions {
|
|
2433
|
+
/**
|
|
2434
|
+
* Event ID to which the order belongs.
|
|
2435
|
+
* @format GUID
|
|
2436
|
+
*/
|
|
2437
|
+
eventId?: string | null;
|
|
2438
|
+
}
|
|
2439
|
+
interface CaptureAuthorizedPaymentOptions {
|
|
2440
|
+
/**
|
|
2441
|
+
* Event ID.
|
|
2442
|
+
* @format GUID
|
|
2443
|
+
*/
|
|
2444
|
+
eventId?: string;
|
|
2445
|
+
}
|
|
2446
|
+
interface VoidAuthorizedPaymentOptions {
|
|
2447
|
+
/**
|
|
2448
|
+
* Event ID.
|
|
2449
|
+
* @format GUID
|
|
2450
|
+
*/
|
|
2451
|
+
eventId?: string;
|
|
2452
|
+
}
|
|
2453
|
+
interface ListAvailableTicketsOptions {
|
|
2454
|
+
/**
|
|
2455
|
+
* Event ID to list tickets for. If not provided, available tickets for all events in the site will be returned.
|
|
2456
|
+
* @format GUID
|
|
2457
|
+
*/
|
|
2458
|
+
eventId?: string;
|
|
2459
|
+
/** Offset. */
|
|
2460
|
+
offset?: number;
|
|
2461
|
+
/**
|
|
2462
|
+
* Limit.
|
|
2463
|
+
* @max 100
|
|
2464
|
+
*/
|
|
2465
|
+
limit?: number;
|
|
2466
|
+
/**
|
|
2467
|
+
* Sort order.
|
|
2468
|
+
* Default: `created:asc`.
|
|
2469
|
+
* @maxLength 100
|
|
2470
|
+
*/
|
|
2471
|
+
sort?: string;
|
|
2472
|
+
state?: StateWithLiterals[];
|
|
2473
|
+
}
|
|
2474
|
+
interface QueryAvailableTicketsOptions {
|
|
2475
|
+
/** Offset. */
|
|
2476
|
+
offset?: number;
|
|
2477
|
+
/**
|
|
2478
|
+
* Limit.
|
|
2479
|
+
* @max 1000
|
|
2480
|
+
*/
|
|
2481
|
+
limit?: number;
|
|
2482
|
+
/** Ticket definition. */
|
|
2483
|
+
filter?: Record<string, any> | null;
|
|
2484
|
+
/**
|
|
2485
|
+
* Which fields to return.
|
|
2486
|
+
* @maxSize 20
|
|
2487
|
+
*/
|
|
2488
|
+
fieldset?: TicketDefinitionFieldsetWithLiterals[];
|
|
2489
|
+
/**
|
|
2490
|
+
* Sort order.
|
|
2491
|
+
* Default: `created:asc`.
|
|
2492
|
+
* @maxLength 100
|
|
2493
|
+
*/
|
|
2494
|
+
sort?: string;
|
|
2495
|
+
}
|
|
2496
|
+
interface CreateReservationOptions {
|
|
2497
|
+
/**
|
|
2498
|
+
* Tickets to reserve.
|
|
2499
|
+
* @minSize 1
|
|
2500
|
+
* @maxSize 50
|
|
2501
|
+
*/
|
|
2502
|
+
ticketQuantities?: TicketReservationQuantity[];
|
|
2503
|
+
/** Whether to ignore the available ticket limits upon a reservation. */
|
|
2504
|
+
ignoreLimits?: boolean;
|
|
2505
|
+
/** Whether to allow reservations for hidden tickets. */
|
|
2506
|
+
allowHiddenTickets?: boolean;
|
|
2507
|
+
}
|
|
2508
|
+
interface GetInvoiceOptions {
|
|
2509
|
+
/** Optional discount to be applied on the returned invoice. */
|
|
2510
|
+
withDiscount?: DiscountRequest;
|
|
2511
|
+
/** Optional benefit granted by the pricing plan to be applied on the returned invoice. */
|
|
2512
|
+
paidPlanBenefit?: PaidPlanBenefit;
|
|
2513
|
+
}
|
|
2514
|
+
interface CheckoutOptionsForRequest {
|
|
2515
|
+
/**
|
|
2516
|
+
* Ticket reservation ID.
|
|
2517
|
+
* @format GUID
|
|
2518
|
+
*/
|
|
2519
|
+
reservationId?: string;
|
|
2520
|
+
/** Member ID (if empty - no site member is associated to this order). */
|
|
2521
|
+
memberId?: string;
|
|
2522
|
+
/** Discount to apply on the invoice. */
|
|
2523
|
+
discount?: DiscountRequest;
|
|
2524
|
+
/** Buyer details. */
|
|
2525
|
+
buyer?: Buyer;
|
|
2526
|
+
/**
|
|
2527
|
+
* Guest details.
|
|
2528
|
+
* @minSize 1
|
|
2529
|
+
* @maxSize 50
|
|
2530
|
+
*/
|
|
2531
|
+
guests?: Guest[];
|
|
2532
|
+
/** Benefit granted by the pricing plan. */
|
|
2533
|
+
paidPlanBenefit?: PaidPlanBenefit;
|
|
2534
|
+
/** Options controlling the checkout process. */
|
|
2535
|
+
options?: CheckoutOptions;
|
|
2536
|
+
/** Whether marketing consent was given */
|
|
2537
|
+
marketingConsent?: boolean | null;
|
|
2538
|
+
}
|
|
2539
|
+
interface UpdateCheckoutOptions {
|
|
2540
|
+
/** Buyer details. */
|
|
2541
|
+
buyer?: Buyer;
|
|
2542
|
+
/**
|
|
2543
|
+
* Guest details.
|
|
2544
|
+
* @minSize 1
|
|
2545
|
+
* @maxSize 20
|
|
2546
|
+
*/
|
|
2547
|
+
guests?: Guest[];
|
|
2548
|
+
/**
|
|
2549
|
+
* Member ID.
|
|
2550
|
+
*
|
|
2551
|
+
* If empty, no site member is associated to this order.
|
|
2552
|
+
*/
|
|
2553
|
+
memberId?: string | null;
|
|
2554
|
+
/** Discount to apply on the invoice. */
|
|
2555
|
+
discount?: DiscountRequest;
|
|
2556
|
+
/** Benefit granted by the pricing plan. */
|
|
2557
|
+
paidPlanBenefit?: PaidPlanBenefit;
|
|
2558
|
+
}
|
|
2559
|
+
interface PosCheckoutOptions {
|
|
2560
|
+
/**
|
|
2561
|
+
* Ticket reservation ID.
|
|
2562
|
+
* @format GUID
|
|
2563
|
+
*/
|
|
2564
|
+
reservationId: string;
|
|
2565
|
+
/**
|
|
2566
|
+
* Payment details ID.
|
|
2567
|
+
* Not required if reservation total is 0. In this case the order will be created with status Free and no payment.
|
|
2568
|
+
* @format GUID
|
|
2569
|
+
*/
|
|
2570
|
+
paymentDetailsId?: string | null;
|
|
2571
|
+
}
|
|
2572
|
+
|
|
2573
|
+
export { TicketDefinitionFieldset as $, type OrderReservationCreatedEnvelope as A, type BulkUpdateOrdersOptions as B, type ConfirmOrderOptions as C, type OrderReservationUpdatedEnvelope as D, OrderStatus as E, ChannelType as F, type GetOrderIdentifiers as G, FeeName as H, FeeType as I, ScheduledActionEnumAction as J, Action as K, type ListOrdersOptions as L, OrderType as M, OrderFieldset as N, type Order as O, type PosCheckoutOptions as P, type QueryAvailableTicketsOptions as Q, OrderTag as R, SubdivisionType as S, TaxType as T, type UpdateOrderIdentifiers as U, type VoidAuthorizedPaymentOptions as V, WebhookIdentityType as W, ReservationStatus as X, State as Y, TicketSaleStatus as Z, Type as _, type ListOrdersResponse as a, type OrderPaid as a$, type FormResponse as a0, type InputValue as a1, type FormattedAddress as a2, type Address as a3, type AddressStreetOneOf as a4, type StreetAddress as a5, type AddressLocation as a6, type Subdivision as a7, type StandardDetails as a8, type Money as a9, type Counts as aA, type GetOrderRequest as aB, type GetOrderResponse as aC, type CalendarLinks as aD, type UpdateOrderRequest as aE, type OrderUpdated as aF, type BulkUpdateOrdersRequest as aG, type ConfirmOrderRequest as aH, type GetSummaryRequest as aI, type TicketSales as aJ, type GetInvoicePreviewRequest as aK, type RawHttpResponse as aL, type HeadersEntry as aM, type GetPaymentInfoRequest as aN, type GetPaymentInfoResponse as aO, type PaymentTransactionSummary as aP, type PaymentTransactionEvent as aQ, type CaptureAuthorizedPaymentRequest as aR, type CaptureAuthorizedPaymentResponse as aS, type VoidAuthorizedPaymentRequest as aT, type VoidAuthorizedPaymentResponse as aU, type FindOrderByReservationIdRequest as aV, type FindOrderByReservationIdResponse as aW, type MessageEnvelope as aX, type IdentificationData as aY, type IdentificationDataIdOneOf as aZ, type OrderConfirmed as a_, type TicketingTicket as aa, type CheckIn as ab, type GuestDetails as ac, type TicketDetails as ad, type Invoice as ae, type Item as af, type Discount as ag, type DiscountItem as ah, type DiscountItemDiscountOneOf as ai, type CouponDiscount as aj, type PaidPlanDiscount as ak, type PaidPlanDiscountDiscountOneOf as al, type PercentDiscount as am, type Tax as an, type Fee as ao, type PaymentDetails as ap, type PaymentTransaction as aq, type GiftCardPaymentDetails as ar, type BalanceSummary as as, type OrderDeleted as at, type Ticket as au, type OnlineConferencingLogin as av, type ListOrdersRequest as aw, type FacetCounts as ax, type OrderFacets as ay, type OrderFacetCounts as az, type GetOrderOptions as b, type ReservationCreated as b0, type TicketQuantity as b1, type ReservationCount as b2, type ReservationUpdated as b3, type GetCheckoutOptionsRequest as b4, type ListAvailableTicketsRequest as b5, type ResponseMetaData as b6, type TicketDefinition as b7, type Dashboard as b8, type WixFeeConfig as b9, type GetReservationRequest as bA, type GetReservationResponse as bB, type Reservation as bC, type ConfirmReservationRequest as bD, type ConfirmReservationResponse as bE, type ExpireReservationRequest as bF, type ExpireReservationResponse as bG, type QueryEventsWithPaidReservationsRequest as bH, type EventKey as bI, type QueryEventsWithPaidReservationsResponse as bJ, type BaseEventMetadata as bK, type TicketSalePeriod as ba, type TicketPricing as bb, type TicketPricingPriceOneOf as bc, type PricingOptions as bd, type PricingOption as be, type QueryAvailableTicketsRequest as bf, type CreateReservationRequest as bg, type TicketReservationQuantity as bh, type TicketReservation as bi, type CancelReservationRequest as bj, type CancelReservationResponse as bk, type GetInvoiceRequest as bl, type DiscountRequest as bm, type PaidPlanBenefit as bn, type DiscountErrors as bo, type Error as bp, type GiftCardErrors as bq, type GiftCardErrorsError as br, type CheckoutRequest as bs, type Buyer as bt, type Guest as bu, type CheckoutOptions as bv, type OrderInitiated as bw, type UpdateCheckoutRequest as bx, type OrderPageUrls as by, type PosCheckoutRequest 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, type OrderDeletedEnvelope as w, type OrderUpdatedEnvelope as x, type OrderConfirmedEnvelope as y, type OrderInitiatedEnvelope as z };
|