@wix/auto_sdk_events_tickets 1.0.1 → 1.0.3
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/src/events-v1-ticket-tickets.types.d.ts +271 -61
- package/build/cjs/src/events-v1-ticket-tickets.types.js.map +1 -1
- package/build/cjs/src/events-v1-ticket-tickets.universal.d.ts +377 -79
- package/build/cjs/src/events-v1-ticket-tickets.universal.js +8 -0
- package/build/cjs/src/events-v1-ticket-tickets.universal.js.map +1 -1
- package/build/es/src/events-v1-ticket-tickets.types.d.ts +271 -61
- package/build/es/src/events-v1-ticket-tickets.types.js.map +1 -1
- package/build/es/src/events-v1-ticket-tickets.universal.d.ts +377 -79
- package/build/es/src/events-v1-ticket-tickets.universal.js +8 -0
- package/build/es/src/events-v1-ticket-tickets.universal.js.map +1 -1
- package/build/internal/cjs/src/events-v1-ticket-tickets.types.d.ts +271 -61
- package/build/internal/cjs/src/events-v1-ticket-tickets.types.js.map +1 -1
- package/build/internal/cjs/src/events-v1-ticket-tickets.universal.d.ts +377 -79
- package/build/internal/cjs/src/events-v1-ticket-tickets.universal.js +8 -0
- package/build/internal/cjs/src/events-v1-ticket-tickets.universal.js.map +1 -1
- package/build/internal/es/src/events-v1-ticket-tickets.types.d.ts +271 -61
- package/build/internal/es/src/events-v1-ticket-tickets.types.js.map +1 -1
- package/build/internal/es/src/events-v1-ticket-tickets.universal.d.ts +377 -79
- package/build/internal/es/src/events-v1-ticket-tickets.universal.js +8 -0
- package/build/internal/es/src/events-v1-ticket-tickets.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -3,7 +3,10 @@ export interface TicketingTicket {
|
|
|
3
3
|
ticketNumber?: string;
|
|
4
4
|
/** Associated order number. */
|
|
5
5
|
orderNumber?: string;
|
|
6
|
-
/**
|
|
6
|
+
/**
|
|
7
|
+
* Ticket definition ID.
|
|
8
|
+
* @format GUID
|
|
9
|
+
*/
|
|
7
10
|
ticketDefinitionId?: string;
|
|
8
11
|
/** Ticket name. */
|
|
9
12
|
name?: string;
|
|
@@ -39,7 +42,10 @@ export interface TicketingTicket {
|
|
|
39
42
|
guestDetails?: GuestDetails;
|
|
40
43
|
/** Whether the ticket is visible in an order. */
|
|
41
44
|
archived?: boolean;
|
|
42
|
-
/**
|
|
45
|
+
/**
|
|
46
|
+
* Ticket owner member ID.
|
|
47
|
+
* @format GUID
|
|
48
|
+
*/
|
|
43
49
|
memberId?: string | null;
|
|
44
50
|
/**
|
|
45
51
|
* Whether ticket was anonymized by GDPR delete.
|
|
@@ -61,6 +67,7 @@ export interface TicketingTicket {
|
|
|
61
67
|
channel?: ChannelType;
|
|
62
68
|
/**
|
|
63
69
|
* An URL to download a ticket in the `.pkpass` format for Apple Wallet.
|
|
70
|
+
* @format WEB_URL
|
|
64
71
|
* @readonly
|
|
65
72
|
*/
|
|
66
73
|
walletPassUrl?: string;
|
|
@@ -73,12 +80,19 @@ export interface TicketingTicket {
|
|
|
73
80
|
export interface Money {
|
|
74
81
|
/**
|
|
75
82
|
* *Deprecated:** Use `value` instead.
|
|
83
|
+
* @format DECIMAL_VALUE
|
|
76
84
|
* @deprecated
|
|
77
85
|
*/
|
|
78
86
|
amount?: string;
|
|
79
|
-
/**
|
|
87
|
+
/**
|
|
88
|
+
* Currency in the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) format. For example, `USD`.
|
|
89
|
+
* @format CURRENCY
|
|
90
|
+
*/
|
|
80
91
|
currency?: string;
|
|
81
|
-
/**
|
|
92
|
+
/**
|
|
93
|
+
* Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, starts with a single (-), to indicate that the amount is negative.
|
|
94
|
+
* @format DECIMAL_VALUE
|
|
95
|
+
*/
|
|
82
96
|
value?: string | null;
|
|
83
97
|
}
|
|
84
98
|
export interface CheckIn {
|
|
@@ -116,29 +130,54 @@ export interface GuestDetails {
|
|
|
116
130
|
firstName?: string | null;
|
|
117
131
|
/** Guest last name. */
|
|
118
132
|
lastName?: string | null;
|
|
119
|
-
/**
|
|
133
|
+
/**
|
|
134
|
+
* Guest email.
|
|
135
|
+
* @format EMAIL
|
|
136
|
+
*/
|
|
120
137
|
email?: string | null;
|
|
121
138
|
/** Full form response. */
|
|
122
139
|
form?: FormResponse;
|
|
123
|
-
/**
|
|
140
|
+
/**
|
|
141
|
+
* Contact ID associated with this guest.
|
|
142
|
+
* @format GUID
|
|
143
|
+
*/
|
|
124
144
|
contactId?: string | null;
|
|
125
|
-
/**
|
|
145
|
+
/**
|
|
146
|
+
* Guest phone number.
|
|
147
|
+
* @format PHONE
|
|
148
|
+
*/
|
|
126
149
|
phone?: string | null;
|
|
127
150
|
}
|
|
128
151
|
export interface FormResponse {
|
|
129
|
-
/**
|
|
152
|
+
/**
|
|
153
|
+
* Form field inputs.
|
|
154
|
+
* @maxSize 200
|
|
155
|
+
*/
|
|
130
156
|
inputValues?: InputValue[];
|
|
131
157
|
}
|
|
132
158
|
export interface InputValue {
|
|
133
|
-
/**
|
|
159
|
+
/**
|
|
160
|
+
* Form field input name.
|
|
161
|
+
* @maxLength 100
|
|
162
|
+
*/
|
|
134
163
|
inputName?: string;
|
|
135
|
-
/**
|
|
164
|
+
/**
|
|
165
|
+
* Form field value.
|
|
166
|
+
* @maxLength 5000
|
|
167
|
+
*/
|
|
136
168
|
value?: string;
|
|
137
|
-
/**
|
|
169
|
+
/**
|
|
170
|
+
* Form field values.
|
|
171
|
+
* @maxSize 100
|
|
172
|
+
* @maxLength 5000
|
|
173
|
+
*/
|
|
138
174
|
values?: string[];
|
|
139
175
|
}
|
|
140
176
|
export interface FormattedAddress {
|
|
141
|
-
/**
|
|
177
|
+
/**
|
|
178
|
+
* One line address representation.
|
|
179
|
+
* @maxLength 200
|
|
180
|
+
*/
|
|
142
181
|
formatted?: string;
|
|
143
182
|
/** Address components (optional). */
|
|
144
183
|
address?: Address;
|
|
@@ -149,7 +188,10 @@ export interface Address extends AddressStreetOneOf {
|
|
|
149
188
|
streetAddress?: StreetAddress;
|
|
150
189
|
/** Main address line, usually street and number as free text. */
|
|
151
190
|
addressLine1?: string | null;
|
|
152
|
-
/**
|
|
191
|
+
/**
|
|
192
|
+
* Country code.
|
|
193
|
+
* @format COUNTRY
|
|
194
|
+
*/
|
|
153
195
|
country?: string | null;
|
|
154
196
|
/** Subdivision shorthand. Usually, a short code (2 or 3 letters) that represents a state, region, prefecture, or province. e.g. NY */
|
|
155
197
|
subdivision?: string | null;
|
|
@@ -202,7 +244,10 @@ export declare enum SubdivisionType {
|
|
|
202
244
|
}
|
|
203
245
|
/** Subdivision Concordance values */
|
|
204
246
|
export interface StandardDetails {
|
|
205
|
-
/**
|
|
247
|
+
/**
|
|
248
|
+
* 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
|
|
249
|
+
* @maxLength 20
|
|
250
|
+
*/
|
|
206
251
|
iso31662?: string | null;
|
|
207
252
|
}
|
|
208
253
|
export declare enum ChannelType {
|
|
@@ -212,7 +257,11 @@ export declare enum ChannelType {
|
|
|
212
257
|
OFFLINE_POS = "OFFLINE_POS"
|
|
213
258
|
}
|
|
214
259
|
export interface TicketDetails {
|
|
215
|
-
/**
|
|
260
|
+
/**
|
|
261
|
+
* Unique seat id in the event venue.
|
|
262
|
+
* @minLength 1
|
|
263
|
+
* @maxLength 36
|
|
264
|
+
*/
|
|
216
265
|
seatId?: string | null;
|
|
217
266
|
/**
|
|
218
267
|
* Optional sector label.
|
|
@@ -239,11 +288,21 @@ export interface TicketDetails {
|
|
|
239
288
|
* @readonly
|
|
240
289
|
*/
|
|
241
290
|
seatLabel?: string | null;
|
|
242
|
-
/**
|
|
291
|
+
/**
|
|
292
|
+
* Number of places in the spot. If not provided - defaults to 1.
|
|
293
|
+
* @min 1
|
|
294
|
+
* @max 50
|
|
295
|
+
*/
|
|
243
296
|
capacity?: number | null;
|
|
244
|
-
/**
|
|
297
|
+
/**
|
|
298
|
+
* Custom pricing of ticket.
|
|
299
|
+
* @format DECIMAL_VALUE
|
|
300
|
+
*/
|
|
245
301
|
priceOverride?: string | null;
|
|
246
|
-
/**
|
|
302
|
+
/**
|
|
303
|
+
* Pricing option id.
|
|
304
|
+
* @format GUID
|
|
305
|
+
*/
|
|
247
306
|
pricingOptionId?: string | null;
|
|
248
307
|
/**
|
|
249
308
|
* Pricing option name.
|
|
@@ -252,19 +311,41 @@ export interface TicketDetails {
|
|
|
252
311
|
pricingOptionName?: string | null;
|
|
253
312
|
}
|
|
254
313
|
export interface ListTicketsRequest {
|
|
255
|
-
/**
|
|
314
|
+
/**
|
|
315
|
+
* Event IDs.
|
|
316
|
+
* @format GUID
|
|
317
|
+
*/
|
|
256
318
|
eventId: string[];
|
|
257
319
|
/** Offset. See [Pagination](/wix-events-v2/pagination). */
|
|
258
320
|
offset?: number;
|
|
259
|
-
/**
|
|
321
|
+
/**
|
|
322
|
+
* Number of items to load per page. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).
|
|
323
|
+
* @max 100
|
|
324
|
+
*/
|
|
260
325
|
limit?: number;
|
|
261
|
-
/**
|
|
326
|
+
/**
|
|
327
|
+
* Order numbers.
|
|
328
|
+
* @minLength 1
|
|
329
|
+
* @maxLength 36
|
|
330
|
+
* @maxSize 20
|
|
331
|
+
*/
|
|
262
332
|
orderNumber?: string[];
|
|
263
|
-
/**
|
|
333
|
+
/**
|
|
334
|
+
* Ticket numbers.
|
|
335
|
+
* @minLength 1
|
|
336
|
+
* @maxLength 36
|
|
337
|
+
* @maxSize 50
|
|
338
|
+
*/
|
|
264
339
|
ticketNumber?: string[];
|
|
265
|
-
/**
|
|
340
|
+
/**
|
|
341
|
+
* Searches in the `orderFullName`, `guestFullName`, and `ticketNumber` fields.
|
|
342
|
+
* @maxLength 200
|
|
343
|
+
*/
|
|
266
344
|
searchPhrase?: string;
|
|
267
|
-
/**
|
|
345
|
+
/**
|
|
346
|
+
* Order statuses.
|
|
347
|
+
* @maxSize 20
|
|
348
|
+
*/
|
|
268
349
|
orderStatus?: OrderStatus[];
|
|
269
350
|
/**
|
|
270
351
|
* Predefined sets of fields to return.
|
|
@@ -273,6 +354,7 @@ export interface ListTicketsRequest {
|
|
|
273
354
|
* - `GUEST_FORM`: Returns `guestDetails.form`.
|
|
274
355
|
*
|
|
275
356
|
* Default: If a fieldset is not included in the request, returns only the `memberId` and `anonymized` fields.
|
|
357
|
+
* @maxSize 20
|
|
276
358
|
*/
|
|
277
359
|
fieldset?: TicketFieldset[];
|
|
278
360
|
/**
|
|
@@ -286,19 +368,43 @@ export interface ListTicketsRequest {
|
|
|
286
368
|
* - `FREE`: Returns free tickets.
|
|
287
369
|
* - `PAID`: Return paid tickets.
|
|
288
370
|
* - `MEMBER`: Return members' tickets.
|
|
371
|
+
* @maxSize 20
|
|
289
372
|
*/
|
|
290
373
|
state?: State[];
|
|
291
|
-
/**
|
|
374
|
+
/**
|
|
375
|
+
* Site member IDs.
|
|
376
|
+
* @format GUID
|
|
377
|
+
* @maxSize 500
|
|
378
|
+
*/
|
|
292
379
|
memberId?: string[];
|
|
293
|
-
/**
|
|
380
|
+
/**
|
|
381
|
+
* Filter facets.
|
|
382
|
+
* @maxLength 100
|
|
383
|
+
* @maxSize 20
|
|
384
|
+
*/
|
|
294
385
|
facet?: string[];
|
|
295
|
-
/**
|
|
386
|
+
/**
|
|
387
|
+
* Sort order. Defaults to "ticket_number:asc".
|
|
388
|
+
* @maxLength 100
|
|
389
|
+
*/
|
|
296
390
|
sort?: string;
|
|
297
|
-
/**
|
|
391
|
+
/**
|
|
392
|
+
* Guest contact IDs.
|
|
393
|
+
* @format GUID
|
|
394
|
+
* @maxSize 100
|
|
395
|
+
*/
|
|
298
396
|
contactId?: string[];
|
|
299
|
-
/**
|
|
397
|
+
/**
|
|
398
|
+
* Ticket definition IDs.
|
|
399
|
+
* @format GUID
|
|
400
|
+
* @maxSize 10
|
|
401
|
+
*/
|
|
300
402
|
ticketDefinitionId?: string[];
|
|
301
|
-
/**
|
|
403
|
+
/**
|
|
404
|
+
* Seat IDs.
|
|
405
|
+
* @maxLength 36
|
|
406
|
+
* @maxSize 50
|
|
407
|
+
*/
|
|
302
408
|
seatId?: string[];
|
|
303
409
|
}
|
|
304
410
|
export declare enum TicketFieldset {
|
|
@@ -334,7 +440,10 @@ export interface ListTicketsResponse {
|
|
|
334
440
|
total?: number;
|
|
335
441
|
/** Offset. */
|
|
336
442
|
offset?: number;
|
|
337
|
-
/**
|
|
443
|
+
/**
|
|
444
|
+
* Limit.
|
|
445
|
+
* @max 100
|
|
446
|
+
*/
|
|
338
447
|
limit?: number;
|
|
339
448
|
/** Tickets. */
|
|
340
449
|
tickets?: TicketingTicket[];
|
|
@@ -360,9 +469,15 @@ export interface Counts {
|
|
|
360
469
|
checkedIn?: number;
|
|
361
470
|
}
|
|
362
471
|
export interface GetTicketRequest {
|
|
363
|
-
/**
|
|
472
|
+
/**
|
|
473
|
+
* Event ID to which the ticket belongs.
|
|
474
|
+
* @format GUID
|
|
475
|
+
*/
|
|
364
476
|
eventId: string;
|
|
365
|
-
/**
|
|
477
|
+
/**
|
|
478
|
+
* A unique ticket number which is assigned automatically when creating a ticket.
|
|
479
|
+
* @maxLength 36
|
|
480
|
+
*/
|
|
366
481
|
ticketNumber: string;
|
|
367
482
|
/**
|
|
368
483
|
* Predefined sets of fields to return.
|
|
@@ -371,6 +486,7 @@ export interface GetTicketRequest {
|
|
|
371
486
|
* - `GUEST_FORM`: Returns `guestDetails.form`.
|
|
372
487
|
*
|
|
373
488
|
* Default: If a fieldset is not included in the request, returns only the `memberId` and `anonymized` fields.
|
|
489
|
+
* @maxSize 20
|
|
374
490
|
*/
|
|
375
491
|
fieldset?: TicketFieldset[];
|
|
376
492
|
}
|
|
@@ -379,9 +495,18 @@ export interface GetTicketResponse {
|
|
|
379
495
|
ticket?: TicketingTicket;
|
|
380
496
|
}
|
|
381
497
|
export interface CheckInTicketRequest {
|
|
382
|
-
/**
|
|
498
|
+
/**
|
|
499
|
+
* Event ID to which the ticket belongs.
|
|
500
|
+
* @format GUID
|
|
501
|
+
*/
|
|
383
502
|
eventId: string;
|
|
384
|
-
/**
|
|
503
|
+
/**
|
|
504
|
+
* Tickets to check-in.
|
|
505
|
+
* @minLength 1
|
|
506
|
+
* @maxLength 36
|
|
507
|
+
* @minSize 1
|
|
508
|
+
* @maxSize 100
|
|
509
|
+
*/
|
|
385
510
|
ticketNumber?: string[];
|
|
386
511
|
}
|
|
387
512
|
export interface CheckInTicketResponse {
|
|
@@ -391,17 +516,29 @@ export interface CheckInTicketResponse {
|
|
|
391
516
|
export interface OrderUpdated {
|
|
392
517
|
/** Order updated timestamp in ISO UTC format. */
|
|
393
518
|
timestamp?: Date | null;
|
|
394
|
-
/**
|
|
519
|
+
/**
|
|
520
|
+
* Site language when Order initiated
|
|
521
|
+
* @format LANGUAGE
|
|
522
|
+
*/
|
|
395
523
|
language?: string | null;
|
|
396
|
-
/**
|
|
524
|
+
/**
|
|
525
|
+
* Locale in which Order was created.
|
|
526
|
+
* @format LANGUAGE_TAG
|
|
527
|
+
*/
|
|
397
528
|
locale?: string | null;
|
|
398
|
-
/**
|
|
529
|
+
/**
|
|
530
|
+
* Event ID to which the ticket belongs.
|
|
531
|
+
* @format GUID
|
|
532
|
+
*/
|
|
399
533
|
eventId?: string;
|
|
400
534
|
/** Unique order number. */
|
|
401
535
|
orderNumber?: string;
|
|
402
536
|
/** Contact ID associated with this order. */
|
|
403
537
|
contactId?: string;
|
|
404
|
-
/**
|
|
538
|
+
/**
|
|
539
|
+
* Member ID associated with this order.
|
|
540
|
+
* @format GUID
|
|
541
|
+
*/
|
|
405
542
|
memberId?: string | null;
|
|
406
543
|
/**
|
|
407
544
|
* Order created timestamp.
|
|
@@ -437,7 +574,10 @@ export interface OrderUpdated {
|
|
|
437
574
|
export interface Ticket {
|
|
438
575
|
/** Unique issued ticket number. */
|
|
439
576
|
ticketNumber?: string;
|
|
440
|
-
/**
|
|
577
|
+
/**
|
|
578
|
+
* Ticket definition ID.
|
|
579
|
+
* @format GUID
|
|
580
|
+
*/
|
|
441
581
|
ticketDefinitionId?: string;
|
|
442
582
|
/** Ticket check-in. */
|
|
443
583
|
checkIn?: CheckIn;
|
|
@@ -451,11 +591,17 @@ export interface Ticket {
|
|
|
451
591
|
lastName?: string | null;
|
|
452
592
|
/** Guest email. */
|
|
453
593
|
email?: string | null;
|
|
454
|
-
/**
|
|
594
|
+
/**
|
|
595
|
+
* Contact ID associated with this ticket.
|
|
596
|
+
* @format GUID
|
|
597
|
+
*/
|
|
455
598
|
contactId?: string | null;
|
|
456
599
|
/** Whether ticket is confirmed */
|
|
457
600
|
confirmed?: boolean;
|
|
458
|
-
/**
|
|
601
|
+
/**
|
|
602
|
+
* Member ID associated with this ticket.
|
|
603
|
+
* @format GUID
|
|
604
|
+
*/
|
|
459
605
|
memberId?: string | null;
|
|
460
606
|
/** Ticket form response (only assigned tickets contain separate forms). */
|
|
461
607
|
form?: FormResponse;
|
|
@@ -465,7 +611,10 @@ export interface Ticket {
|
|
|
465
611
|
anonymized?: boolean;
|
|
466
612
|
/** URL and password to online conference */
|
|
467
613
|
onlineConferencingLogin?: OnlineConferencingLogin;
|
|
468
|
-
/**
|
|
614
|
+
/**
|
|
615
|
+
* Seat ID associated with this ticket.
|
|
616
|
+
* @maxLength 36
|
|
617
|
+
*/
|
|
469
618
|
seatId?: string | null;
|
|
470
619
|
/** Whether ticket is canceled. */
|
|
471
620
|
canceled?: boolean | null;
|
|
@@ -473,6 +622,7 @@ export interface Ticket {
|
|
|
473
622
|
export interface OnlineConferencingLogin {
|
|
474
623
|
/**
|
|
475
624
|
* Link URL to the online conference.
|
|
625
|
+
* @format WEB_URL
|
|
476
626
|
* @readonly
|
|
477
627
|
*/
|
|
478
628
|
link?: string;
|
|
@@ -483,9 +633,18 @@ export interface OnlineConferencingLogin {
|
|
|
483
633
|
password?: string | null;
|
|
484
634
|
}
|
|
485
635
|
export interface DeleteTicketCheckInRequest {
|
|
486
|
-
/**
|
|
636
|
+
/**
|
|
637
|
+
* Event ID to which the ticket belongs.
|
|
638
|
+
* @format GUID
|
|
639
|
+
*/
|
|
487
640
|
eventId: string;
|
|
488
|
-
/**
|
|
641
|
+
/**
|
|
642
|
+
* Ticket numbers which check-ins to delete.
|
|
643
|
+
* @minLength 1
|
|
644
|
+
* @maxLength 36
|
|
645
|
+
* @minSize 1
|
|
646
|
+
* @maxSize 100
|
|
647
|
+
*/
|
|
489
648
|
ticketNumber?: string[];
|
|
490
649
|
}
|
|
491
650
|
export interface DeleteTicketCheckInResponse {
|
|
@@ -493,9 +652,16 @@ export interface DeleteTicketCheckInResponse {
|
|
|
493
652
|
tickets?: TicketingTicket[];
|
|
494
653
|
}
|
|
495
654
|
export interface UpdateTicketRequest {
|
|
496
|
-
/**
|
|
655
|
+
/**
|
|
656
|
+
* Event ID to which the ticket belongs.
|
|
657
|
+
* @format GUID
|
|
658
|
+
*/
|
|
497
659
|
eventId: string;
|
|
498
|
-
/**
|
|
660
|
+
/**
|
|
661
|
+
* A unique ticket number which is assigned automatically when creating a ticket.
|
|
662
|
+
* @minLength 1
|
|
663
|
+
* @maxLength 36
|
|
664
|
+
*/
|
|
499
665
|
ticketNumber: string;
|
|
500
666
|
/**
|
|
501
667
|
* Set of field paths, specifying which parts of this resource to update.
|
|
@@ -517,9 +683,18 @@ export interface UpdateTicketResponse {
|
|
|
517
683
|
ticket?: TicketingTicket;
|
|
518
684
|
}
|
|
519
685
|
export interface BulkUpdateTicketsRequest {
|
|
520
|
-
/**
|
|
686
|
+
/**
|
|
687
|
+
* Event ID to which the ticket belongs.
|
|
688
|
+
* @format GUID
|
|
689
|
+
*/
|
|
521
690
|
eventId: string;
|
|
522
|
-
/**
|
|
691
|
+
/**
|
|
692
|
+
* A unique ticket number which is assigned automatically when creating a ticket.
|
|
693
|
+
* @minLength 1
|
|
694
|
+
* @maxLength 36
|
|
695
|
+
* @minSize 1
|
|
696
|
+
* @maxSize 100
|
|
697
|
+
*/
|
|
523
698
|
ticketNumber?: string[];
|
|
524
699
|
/** Whether tickets are archived. */
|
|
525
700
|
archived?: boolean;
|
|
@@ -529,7 +704,10 @@ export interface BulkUpdateTicketsResponse {
|
|
|
529
704
|
tickets?: TicketingTicket[];
|
|
530
705
|
}
|
|
531
706
|
export interface GetDemoTicketRequest {
|
|
532
|
-
/**
|
|
707
|
+
/**
|
|
708
|
+
* Ticket definition ID.
|
|
709
|
+
* @format GUID
|
|
710
|
+
*/
|
|
533
711
|
definitionId?: string;
|
|
534
712
|
}
|
|
535
713
|
export interface GetDemoTicketResponse {
|
|
@@ -537,9 +715,15 @@ export interface GetDemoTicketResponse {
|
|
|
537
715
|
ticket?: TicketingTicket;
|
|
538
716
|
}
|
|
539
717
|
export interface MessageEnvelope {
|
|
540
|
-
/**
|
|
718
|
+
/**
|
|
719
|
+
* App instance ID.
|
|
720
|
+
* @format GUID
|
|
721
|
+
*/
|
|
541
722
|
instanceId?: string | null;
|
|
542
|
-
/**
|
|
723
|
+
/**
|
|
724
|
+
* Event type.
|
|
725
|
+
* @maxLength 150
|
|
726
|
+
*/
|
|
543
727
|
eventType?: string;
|
|
544
728
|
/** The identification type and identity data. */
|
|
545
729
|
identity?: IdentificationData;
|
|
@@ -547,26 +731,50 @@ export interface MessageEnvelope {
|
|
|
547
731
|
data?: string;
|
|
548
732
|
}
|
|
549
733
|
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
550
|
-
/**
|
|
734
|
+
/**
|
|
735
|
+
* ID of a site visitor that has not logged in to the site.
|
|
736
|
+
* @format GUID
|
|
737
|
+
*/
|
|
551
738
|
anonymousVisitorId?: string;
|
|
552
|
-
/**
|
|
739
|
+
/**
|
|
740
|
+
* ID of a site visitor that has logged in to the site.
|
|
741
|
+
* @format GUID
|
|
742
|
+
*/
|
|
553
743
|
memberId?: string;
|
|
554
|
-
/**
|
|
744
|
+
/**
|
|
745
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
746
|
+
* @format GUID
|
|
747
|
+
*/
|
|
555
748
|
wixUserId?: string;
|
|
556
|
-
/**
|
|
749
|
+
/**
|
|
750
|
+
* ID of an app.
|
|
751
|
+
* @format GUID
|
|
752
|
+
*/
|
|
557
753
|
appId?: string;
|
|
558
754
|
/** @readonly */
|
|
559
755
|
identityType?: WebhookIdentityType;
|
|
560
756
|
}
|
|
561
757
|
/** @oneof */
|
|
562
758
|
export interface IdentificationDataIdOneOf {
|
|
563
|
-
/**
|
|
759
|
+
/**
|
|
760
|
+
* ID of a site visitor that has not logged in to the site.
|
|
761
|
+
* @format GUID
|
|
762
|
+
*/
|
|
564
763
|
anonymousVisitorId?: string;
|
|
565
|
-
/**
|
|
764
|
+
/**
|
|
765
|
+
* ID of a site visitor that has logged in to the site.
|
|
766
|
+
* @format GUID
|
|
767
|
+
*/
|
|
566
768
|
memberId?: string;
|
|
567
|
-
/**
|
|
769
|
+
/**
|
|
770
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
771
|
+
* @format GUID
|
|
772
|
+
*/
|
|
568
773
|
wixUserId?: string;
|
|
569
|
-
/**
|
|
774
|
+
/**
|
|
775
|
+
* ID of an app.
|
|
776
|
+
* @format GUID
|
|
777
|
+
*/
|
|
570
778
|
appId?: string;
|
|
571
779
|
}
|
|
572
780
|
export declare enum WebhookIdentityType {
|
|
@@ -652,9 +860,15 @@ export interface BulkUpdateTicketsResponseNonNullableFields {
|
|
|
652
860
|
tickets: TicketingTicketNonNullableFields[];
|
|
653
861
|
}
|
|
654
862
|
export interface BaseEventMetadata {
|
|
655
|
-
/**
|
|
863
|
+
/**
|
|
864
|
+
* App instance ID.
|
|
865
|
+
* @format GUID
|
|
866
|
+
*/
|
|
656
867
|
instanceId?: string | null;
|
|
657
|
-
/**
|
|
868
|
+
/**
|
|
869
|
+
* Event type.
|
|
870
|
+
* @maxLength 150
|
|
871
|
+
*/
|
|
658
872
|
eventType?: string;
|
|
659
873
|
/** The identification type and identity data. */
|
|
660
874
|
identity?: IdentificationData;
|
|
@@ -667,6 +881,8 @@ export interface TicketOrderUpdatedEnvelope {
|
|
|
667
881
|
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
668
882
|
* @permissionScope Manage Events - all permissions
|
|
669
883
|
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
884
|
+
* @permissionScope Manage Events
|
|
885
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
670
886
|
* @permissionScope Read Basic Events Order Info
|
|
671
887
|
* @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS
|
|
672
888
|
* @permissionScope Manage Orders
|
|
@@ -693,6 +909,8 @@ export declare function onTicketOrderUpdated(handler: (event: TicketOrderUpdated
|
|
|
693
909
|
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
694
910
|
* @permissionScope Manage Events - all permissions
|
|
695
911
|
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
912
|
+
* @permissionScope Manage Events
|
|
913
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
696
914
|
* @permissionScope Manage Guest List
|
|
697
915
|
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
698
916
|
* @permissionScope Read Event Tickets and Guest List
|
|
@@ -707,15 +925,34 @@ export interface ListTicketsOptions {
|
|
|
707
925
|
* Offset. See [Pagination](/wix-events-v2/pagination).
|
|
708
926
|
*/
|
|
709
927
|
offset?: number;
|
|
710
|
-
/**
|
|
928
|
+
/**
|
|
929
|
+
* Number of items to load per page. See [Pagination](/wix-events-v2/pagination).
|
|
930
|
+
* @max 100
|
|
931
|
+
*/
|
|
711
932
|
limit?: number;
|
|
712
|
-
/**
|
|
933
|
+
/**
|
|
934
|
+
* Order numbers.
|
|
935
|
+
* @minLength 1
|
|
936
|
+
* @maxLength 36
|
|
937
|
+
* @maxSize 20
|
|
938
|
+
*/
|
|
713
939
|
orderNumber?: string[];
|
|
714
|
-
/**
|
|
940
|
+
/**
|
|
941
|
+
* Ticket numbers.
|
|
942
|
+
* @minLength 1
|
|
943
|
+
* @maxLength 36
|
|
944
|
+
* @maxSize 50
|
|
945
|
+
*/
|
|
715
946
|
ticketNumber?: string[];
|
|
716
|
-
/**
|
|
947
|
+
/**
|
|
948
|
+
* Textual search filter - search is performed on `"orderFullName"`, `"guestFullName"`, and `"ticketNumber"`.
|
|
949
|
+
* @maxLength 200
|
|
950
|
+
*/
|
|
717
951
|
searchPhrase?: string;
|
|
718
|
-
/**
|
|
952
|
+
/**
|
|
953
|
+
* Order statuses.
|
|
954
|
+
* @maxSize 20
|
|
955
|
+
*/
|
|
719
956
|
orderStatus?: OrderStatus[];
|
|
720
957
|
/**
|
|
721
958
|
* Predefined sets of fields to return.
|
|
@@ -724,6 +961,7 @@ export interface ListTicketsOptions {
|
|
|
724
961
|
* - `GUEST_FORM`: Returns `guestDetails.form`.
|
|
725
962
|
*
|
|
726
963
|
* Default: If a fieldset is not included in the request, returns only the `memberId` and `anonymized` fields.
|
|
964
|
+
* @maxSize 20
|
|
727
965
|
*/
|
|
728
966
|
fieldset?: TicketFieldset[];
|
|
729
967
|
/**
|
|
@@ -737,23 +975,45 @@ export interface ListTicketsOptions {
|
|
|
737
975
|
* - `FREE`: Returns free tickets.
|
|
738
976
|
* - `PAID`: Return paid tickets.
|
|
739
977
|
* - `MEMBER`: Return members' tickets.
|
|
978
|
+
* @maxSize 20
|
|
740
979
|
*/
|
|
741
980
|
state?: State[];
|
|
742
|
-
/**
|
|
981
|
+
/**
|
|
982
|
+
* Site member IDs.
|
|
983
|
+
* @format GUID
|
|
984
|
+
* @maxSize 500
|
|
985
|
+
*/
|
|
743
986
|
memberId?: string[];
|
|
744
|
-
/**
|
|
987
|
+
/**
|
|
988
|
+
* Filter facets.
|
|
989
|
+
* @maxLength 100
|
|
990
|
+
* @maxSize 20
|
|
991
|
+
*/
|
|
745
992
|
facet?: string[];
|
|
746
993
|
/**
|
|
747
994
|
* Sort order.
|
|
748
995
|
*
|
|
749
996
|
* Default: `"ticketNumber"`:`"asc"`.
|
|
997
|
+
* @maxLength 100
|
|
750
998
|
*/
|
|
751
999
|
sort?: string;
|
|
752
|
-
/**
|
|
1000
|
+
/**
|
|
1001
|
+
* Guest contact IDs.
|
|
1002
|
+
* @format GUID
|
|
1003
|
+
* @maxSize 100
|
|
1004
|
+
*/
|
|
753
1005
|
contactId?: string[];
|
|
754
|
-
/**
|
|
1006
|
+
/**
|
|
1007
|
+
* Ticket definition IDs.
|
|
1008
|
+
* @format GUID
|
|
1009
|
+
* @maxSize 10
|
|
1010
|
+
*/
|
|
755
1011
|
ticketDefinitionId?: string[];
|
|
756
|
-
/**
|
|
1012
|
+
/**
|
|
1013
|
+
* Seat IDs.
|
|
1014
|
+
* @maxLength 36
|
|
1015
|
+
* @maxSize 50
|
|
1016
|
+
*/
|
|
757
1017
|
seatId?: string[];
|
|
758
1018
|
}
|
|
759
1019
|
/**
|
|
@@ -769,6 +1029,8 @@ export interface ListTicketsOptions {
|
|
|
769
1029
|
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
770
1030
|
* @permissionScope Manage Events - all permissions
|
|
771
1031
|
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
1032
|
+
* @permissionScope Manage Events
|
|
1033
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
772
1034
|
* @permissionScope Manage Guest List
|
|
773
1035
|
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
774
1036
|
* @permissionScope Read Event Tickets and Guest List
|
|
@@ -779,9 +1041,15 @@ export interface ListTicketsOptions {
|
|
|
779
1041
|
*/
|
|
780
1042
|
export declare function getTicket(identifiers: GetTicketIdentifiers, options?: GetTicketOptions): Promise<TicketingTicket & TicketingTicketNonNullableFields>;
|
|
781
1043
|
export interface GetTicketIdentifiers {
|
|
782
|
-
/**
|
|
1044
|
+
/**
|
|
1045
|
+
* Event ID to which the ticket belongs.
|
|
1046
|
+
* @format GUID
|
|
1047
|
+
*/
|
|
783
1048
|
eventId: string;
|
|
784
|
-
/**
|
|
1049
|
+
/**
|
|
1050
|
+
* A unique ticket number which is assigned automatically when creating a ticket.
|
|
1051
|
+
* @maxLength 36
|
|
1052
|
+
*/
|
|
785
1053
|
ticketNumber: string;
|
|
786
1054
|
}
|
|
787
1055
|
export interface GetTicketOptions {
|
|
@@ -792,6 +1060,7 @@ export interface GetTicketOptions {
|
|
|
792
1060
|
* - `GUEST_FORM`: Returns `guestDetails.form`.
|
|
793
1061
|
*
|
|
794
1062
|
* Default: If a fieldset is not included in the request, returns only the `memberId` and `anonymized` fields.
|
|
1063
|
+
* @maxSize 20
|
|
795
1064
|
*/
|
|
796
1065
|
fieldset?: TicketFieldset[];
|
|
797
1066
|
}
|
|
@@ -806,7 +1075,13 @@ export interface GetTicketOptions {
|
|
|
806
1075
|
*/
|
|
807
1076
|
export declare function checkInTickets(eventId: string, options?: CheckInTicketsOptions): Promise<CheckInTicketResponse & CheckInTicketResponseNonNullableFields>;
|
|
808
1077
|
export interface CheckInTicketsOptions {
|
|
809
|
-
/**
|
|
1078
|
+
/**
|
|
1079
|
+
* Tickets to check-in.
|
|
1080
|
+
* @minLength 1
|
|
1081
|
+
* @maxLength 36
|
|
1082
|
+
* @minSize 1
|
|
1083
|
+
* @maxSize 100
|
|
1084
|
+
*/
|
|
810
1085
|
ticketNumber?: string[];
|
|
811
1086
|
}
|
|
812
1087
|
/**
|
|
@@ -820,7 +1095,13 @@ export interface CheckInTicketsOptions {
|
|
|
820
1095
|
*/
|
|
821
1096
|
export declare function deleteTicketCheckIns(eventId: string, options?: DeleteTicketCheckInsOptions): Promise<DeleteTicketCheckInResponse & DeleteTicketCheckInResponseNonNullableFields>;
|
|
822
1097
|
export interface DeleteTicketCheckInsOptions {
|
|
823
|
-
/**
|
|
1098
|
+
/**
|
|
1099
|
+
* Ticket numbers which check-ins to delete.
|
|
1100
|
+
* @minLength 1
|
|
1101
|
+
* @maxLength 36
|
|
1102
|
+
* @minSize 1
|
|
1103
|
+
* @maxSize 100
|
|
1104
|
+
*/
|
|
824
1105
|
ticketNumber?: string[];
|
|
825
1106
|
}
|
|
826
1107
|
/**
|
|
@@ -834,6 +1115,8 @@ export interface DeleteTicketCheckInsOptions {
|
|
|
834
1115
|
* @permissionId WIX_EVENTS.MANAGE_TICKETS
|
|
835
1116
|
* @permissionScope Manage Events - all permissions
|
|
836
1117
|
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
1118
|
+
* @permissionScope Manage Events
|
|
1119
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
837
1120
|
* @permissionScope Manage Guest List
|
|
838
1121
|
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
839
1122
|
* @applicableIdentity APP
|
|
@@ -841,9 +1124,16 @@ export interface DeleteTicketCheckInsOptions {
|
|
|
841
1124
|
*/
|
|
842
1125
|
export declare function updateTicket(identifiers: UpdateTicketIdentifiers, options?: UpdateTicketOptions): Promise<UpdateTicketResponse & UpdateTicketResponseNonNullableFields>;
|
|
843
1126
|
export interface UpdateTicketIdentifiers {
|
|
844
|
-
/**
|
|
1127
|
+
/**
|
|
1128
|
+
* Event ID to which the ticket belongs.
|
|
1129
|
+
* @format GUID
|
|
1130
|
+
*/
|
|
845
1131
|
eventId: string;
|
|
846
|
-
/**
|
|
1132
|
+
/**
|
|
1133
|
+
* A unique ticket number which is assigned automatically when creating a ticket.
|
|
1134
|
+
* @minLength 1
|
|
1135
|
+
* @maxLength 36
|
|
1136
|
+
*/
|
|
847
1137
|
ticketNumber: string;
|
|
848
1138
|
}
|
|
849
1139
|
export interface UpdateTicketOptions {
|
|
@@ -867,6 +1157,8 @@ export interface UpdateTicketOptions {
|
|
|
867
1157
|
* @permissionId WIX_EVENTS.MANAGE_TICKETS
|
|
868
1158
|
* @permissionScope Manage Events - all permissions
|
|
869
1159
|
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
1160
|
+
* @permissionScope Manage Events
|
|
1161
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
870
1162
|
* @permissionScope Manage Guest List
|
|
871
1163
|
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
872
1164
|
* @applicableIdentity APP
|
|
@@ -874,7 +1166,13 @@ export interface UpdateTicketOptions {
|
|
|
874
1166
|
*/
|
|
875
1167
|
export declare function bulkUpdateTickets(eventId: string, options?: BulkUpdateTicketsOptions): Promise<BulkUpdateTicketsResponse & BulkUpdateTicketsResponseNonNullableFields>;
|
|
876
1168
|
export interface BulkUpdateTicketsOptions {
|
|
877
|
-
/**
|
|
1169
|
+
/**
|
|
1170
|
+
* A unique ticket number which is assigned automatically when creating a ticket.
|
|
1171
|
+
* @minLength 1
|
|
1172
|
+
* @maxLength 36
|
|
1173
|
+
* @minSize 1
|
|
1174
|
+
* @maxSize 100
|
|
1175
|
+
*/
|
|
878
1176
|
ticketNumber?: string[];
|
|
879
1177
|
/** Whether tickets are archived. */
|
|
880
1178
|
archived?: boolean;
|