@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;
|
|
@@ -51,7 +54,10 @@ export interface TicketingTicket {
|
|
|
51
54
|
* @deprecated
|
|
52
55
|
*/
|
|
53
56
|
ticketPdf?: string;
|
|
54
|
-
/**
|
|
57
|
+
/**
|
|
58
|
+
* Ticket owner member ID.
|
|
59
|
+
* @format GUID
|
|
60
|
+
*/
|
|
55
61
|
memberId?: string | null;
|
|
56
62
|
/**
|
|
57
63
|
* Whether ticket was anonymized by GDPR delete.
|
|
@@ -73,6 +79,7 @@ export interface TicketingTicket {
|
|
|
73
79
|
channel?: ChannelType;
|
|
74
80
|
/**
|
|
75
81
|
* An URL to download a ticket in the `.pkpass` format for Apple Wallet.
|
|
82
|
+
* @format WEB_URL
|
|
76
83
|
* @readonly
|
|
77
84
|
*/
|
|
78
85
|
walletPassUrl?: string;
|
|
@@ -85,12 +92,19 @@ export interface TicketingTicket {
|
|
|
85
92
|
export interface Money {
|
|
86
93
|
/**
|
|
87
94
|
* *Deprecated:** Use `value` instead.
|
|
95
|
+
* @format DECIMAL_VALUE
|
|
88
96
|
* @deprecated
|
|
89
97
|
*/
|
|
90
98
|
amount?: string;
|
|
91
|
-
/**
|
|
99
|
+
/**
|
|
100
|
+
* Currency in the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) format. For example, `USD`.
|
|
101
|
+
* @format CURRENCY
|
|
102
|
+
*/
|
|
92
103
|
currency?: string;
|
|
93
|
-
/**
|
|
104
|
+
/**
|
|
105
|
+
* 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.
|
|
106
|
+
* @format DECIMAL_VALUE
|
|
107
|
+
*/
|
|
94
108
|
value?: string | null;
|
|
95
109
|
}
|
|
96
110
|
export interface CheckIn {
|
|
@@ -128,29 +142,54 @@ export interface GuestDetails {
|
|
|
128
142
|
firstName?: string | null;
|
|
129
143
|
/** Guest last name. */
|
|
130
144
|
lastName?: string | null;
|
|
131
|
-
/**
|
|
145
|
+
/**
|
|
146
|
+
* Guest email.
|
|
147
|
+
* @format EMAIL
|
|
148
|
+
*/
|
|
132
149
|
email?: string | null;
|
|
133
150
|
/** Full form response. */
|
|
134
151
|
form?: FormResponse;
|
|
135
|
-
/**
|
|
152
|
+
/**
|
|
153
|
+
* Contact ID associated with this guest.
|
|
154
|
+
* @format GUID
|
|
155
|
+
*/
|
|
136
156
|
contactId?: string | null;
|
|
137
|
-
/**
|
|
157
|
+
/**
|
|
158
|
+
* Guest phone number.
|
|
159
|
+
* @format PHONE
|
|
160
|
+
*/
|
|
138
161
|
phone?: string | null;
|
|
139
162
|
}
|
|
140
163
|
export interface FormResponse {
|
|
141
|
-
/**
|
|
164
|
+
/**
|
|
165
|
+
* Form field inputs.
|
|
166
|
+
* @maxSize 200
|
|
167
|
+
*/
|
|
142
168
|
inputValues?: InputValue[];
|
|
143
169
|
}
|
|
144
170
|
export interface InputValue {
|
|
145
|
-
/**
|
|
171
|
+
/**
|
|
172
|
+
* Form field input name.
|
|
173
|
+
* @maxLength 100
|
|
174
|
+
*/
|
|
146
175
|
inputName?: string;
|
|
147
|
-
/**
|
|
176
|
+
/**
|
|
177
|
+
* Form field value.
|
|
178
|
+
* @maxLength 5000
|
|
179
|
+
*/
|
|
148
180
|
value?: string;
|
|
149
|
-
/**
|
|
181
|
+
/**
|
|
182
|
+
* Form field values.
|
|
183
|
+
* @maxSize 100
|
|
184
|
+
* @maxLength 5000
|
|
185
|
+
*/
|
|
150
186
|
values?: string[];
|
|
151
187
|
}
|
|
152
188
|
export interface FormattedAddress {
|
|
153
|
-
/**
|
|
189
|
+
/**
|
|
190
|
+
* One line address representation.
|
|
191
|
+
* @maxLength 200
|
|
192
|
+
*/
|
|
154
193
|
formatted?: string;
|
|
155
194
|
/** Address components (optional). */
|
|
156
195
|
address?: Address;
|
|
@@ -161,7 +200,10 @@ export interface Address extends AddressStreetOneOf {
|
|
|
161
200
|
streetAddress?: StreetAddress;
|
|
162
201
|
/** Main address line, usually street and number as free text. */
|
|
163
202
|
addressLine1?: string | null;
|
|
164
|
-
/**
|
|
203
|
+
/**
|
|
204
|
+
* Country code.
|
|
205
|
+
* @format COUNTRY
|
|
206
|
+
*/
|
|
165
207
|
country?: string | null;
|
|
166
208
|
/** Subdivision shorthand. Usually, a short code (2 or 3 letters) that represents a state, region, prefecture, or province. e.g. NY */
|
|
167
209
|
subdivision?: string | null;
|
|
@@ -214,7 +256,10 @@ export declare enum SubdivisionType {
|
|
|
214
256
|
}
|
|
215
257
|
/** Subdivision Concordance values */
|
|
216
258
|
export interface StandardDetails {
|
|
217
|
-
/**
|
|
259
|
+
/**
|
|
260
|
+
* 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
|
|
261
|
+
* @maxLength 20
|
|
262
|
+
*/
|
|
218
263
|
iso31662?: string | null;
|
|
219
264
|
}
|
|
220
265
|
export declare enum ChannelType {
|
|
@@ -224,7 +269,11 @@ export declare enum ChannelType {
|
|
|
224
269
|
OFFLINE_POS = "OFFLINE_POS"
|
|
225
270
|
}
|
|
226
271
|
export interface TicketDetails {
|
|
227
|
-
/**
|
|
272
|
+
/**
|
|
273
|
+
* Unique seat id in the event venue.
|
|
274
|
+
* @minLength 1
|
|
275
|
+
* @maxLength 36
|
|
276
|
+
*/
|
|
228
277
|
seatId?: string | null;
|
|
229
278
|
/**
|
|
230
279
|
* Optional sector label.
|
|
@@ -251,11 +300,21 @@ export interface TicketDetails {
|
|
|
251
300
|
* @readonly
|
|
252
301
|
*/
|
|
253
302
|
seatLabel?: string | null;
|
|
254
|
-
/**
|
|
303
|
+
/**
|
|
304
|
+
* Number of places in the spot. If not provided - defaults to 1.
|
|
305
|
+
* @min 1
|
|
306
|
+
* @max 50
|
|
307
|
+
*/
|
|
255
308
|
capacity?: number | null;
|
|
256
|
-
/**
|
|
309
|
+
/**
|
|
310
|
+
* Custom pricing of ticket.
|
|
311
|
+
* @format DECIMAL_VALUE
|
|
312
|
+
*/
|
|
257
313
|
priceOverride?: string | null;
|
|
258
|
-
/**
|
|
314
|
+
/**
|
|
315
|
+
* Pricing option id.
|
|
316
|
+
* @format GUID
|
|
317
|
+
*/
|
|
259
318
|
pricingOptionId?: string | null;
|
|
260
319
|
/**
|
|
261
320
|
* Pricing option name.
|
|
@@ -264,19 +323,41 @@ export interface TicketDetails {
|
|
|
264
323
|
pricingOptionName?: string | null;
|
|
265
324
|
}
|
|
266
325
|
export interface ListTicketsRequest {
|
|
267
|
-
/**
|
|
326
|
+
/**
|
|
327
|
+
* Event IDs.
|
|
328
|
+
* @format GUID
|
|
329
|
+
*/
|
|
268
330
|
eventId: string[];
|
|
269
331
|
/** Offset. See [Pagination](/wix-events-v2/pagination). */
|
|
270
332
|
offset?: number;
|
|
271
|
-
/**
|
|
333
|
+
/**
|
|
334
|
+
* Number of items to load per page. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).
|
|
335
|
+
* @max 100
|
|
336
|
+
*/
|
|
272
337
|
limit?: number;
|
|
273
|
-
/**
|
|
338
|
+
/**
|
|
339
|
+
* Order numbers.
|
|
340
|
+
* @minLength 1
|
|
341
|
+
* @maxLength 36
|
|
342
|
+
* @maxSize 20
|
|
343
|
+
*/
|
|
274
344
|
orderNumber?: string[];
|
|
275
|
-
/**
|
|
345
|
+
/**
|
|
346
|
+
* Ticket numbers.
|
|
347
|
+
* @minLength 1
|
|
348
|
+
* @maxLength 36
|
|
349
|
+
* @maxSize 50
|
|
350
|
+
*/
|
|
276
351
|
ticketNumber?: string[];
|
|
277
|
-
/**
|
|
352
|
+
/**
|
|
353
|
+
* Searches in the `orderFullName`, `guestFullName`, and `ticketNumber` fields.
|
|
354
|
+
* @maxLength 200
|
|
355
|
+
*/
|
|
278
356
|
searchPhrase?: string;
|
|
279
|
-
/**
|
|
357
|
+
/**
|
|
358
|
+
* Order statuses.
|
|
359
|
+
* @maxSize 20
|
|
360
|
+
*/
|
|
280
361
|
orderStatus?: OrderStatus[];
|
|
281
362
|
/**
|
|
282
363
|
* Predefined sets of fields to return.
|
|
@@ -285,6 +366,7 @@ export interface ListTicketsRequest {
|
|
|
285
366
|
* - `GUEST_FORM`: Returns `guestDetails.form`.
|
|
286
367
|
*
|
|
287
368
|
* Default: If a fieldset is not included in the request, returns only the `memberId` and `anonymized` fields.
|
|
369
|
+
* @maxSize 20
|
|
288
370
|
*/
|
|
289
371
|
fieldset?: TicketFieldset[];
|
|
290
372
|
/**
|
|
@@ -298,19 +380,43 @@ export interface ListTicketsRequest {
|
|
|
298
380
|
* - `FREE`: Returns free tickets.
|
|
299
381
|
* - `PAID`: Return paid tickets.
|
|
300
382
|
* - `MEMBER`: Return members' tickets.
|
|
383
|
+
* @maxSize 20
|
|
301
384
|
*/
|
|
302
385
|
state?: State[];
|
|
303
|
-
/**
|
|
386
|
+
/**
|
|
387
|
+
* Site member IDs.
|
|
388
|
+
* @format GUID
|
|
389
|
+
* @maxSize 500
|
|
390
|
+
*/
|
|
304
391
|
memberId?: string[];
|
|
305
|
-
/**
|
|
392
|
+
/**
|
|
393
|
+
* Filter facets.
|
|
394
|
+
* @maxLength 100
|
|
395
|
+
* @maxSize 20
|
|
396
|
+
*/
|
|
306
397
|
facet?: string[];
|
|
307
|
-
/**
|
|
398
|
+
/**
|
|
399
|
+
* Sort order. Defaults to "ticket_number:asc".
|
|
400
|
+
* @maxLength 100
|
|
401
|
+
*/
|
|
308
402
|
sort?: string;
|
|
309
|
-
/**
|
|
403
|
+
/**
|
|
404
|
+
* Guest contact IDs.
|
|
405
|
+
* @format GUID
|
|
406
|
+
* @maxSize 100
|
|
407
|
+
*/
|
|
310
408
|
contactId?: string[];
|
|
311
|
-
/**
|
|
409
|
+
/**
|
|
410
|
+
* Ticket definition IDs.
|
|
411
|
+
* @format GUID
|
|
412
|
+
* @maxSize 10
|
|
413
|
+
*/
|
|
312
414
|
ticketDefinitionId?: string[];
|
|
313
|
-
/**
|
|
415
|
+
/**
|
|
416
|
+
* Seat IDs.
|
|
417
|
+
* @maxLength 36
|
|
418
|
+
* @maxSize 50
|
|
419
|
+
*/
|
|
314
420
|
seatId?: string[];
|
|
315
421
|
}
|
|
316
422
|
export declare enum TicketFieldset {
|
|
@@ -346,7 +452,10 @@ export interface ListTicketsResponse {
|
|
|
346
452
|
total?: number;
|
|
347
453
|
/** Offset. */
|
|
348
454
|
offset?: number;
|
|
349
|
-
/**
|
|
455
|
+
/**
|
|
456
|
+
* Limit.
|
|
457
|
+
* @max 100
|
|
458
|
+
*/
|
|
350
459
|
limit?: number;
|
|
351
460
|
/** Tickets. */
|
|
352
461
|
tickets?: TicketingTicket[];
|
|
@@ -372,9 +481,15 @@ export interface Counts {
|
|
|
372
481
|
checkedIn?: number;
|
|
373
482
|
}
|
|
374
483
|
export interface GetTicketRequest {
|
|
375
|
-
/**
|
|
484
|
+
/**
|
|
485
|
+
* Event ID to which the ticket belongs.
|
|
486
|
+
* @format GUID
|
|
487
|
+
*/
|
|
376
488
|
eventId: string;
|
|
377
|
-
/**
|
|
489
|
+
/**
|
|
490
|
+
* A unique ticket number which is assigned automatically when creating a ticket.
|
|
491
|
+
* @maxLength 36
|
|
492
|
+
*/
|
|
378
493
|
ticketNumber: string;
|
|
379
494
|
/**
|
|
380
495
|
* Predefined sets of fields to return.
|
|
@@ -383,6 +498,7 @@ export interface GetTicketRequest {
|
|
|
383
498
|
* - `GUEST_FORM`: Returns `guestDetails.form`.
|
|
384
499
|
*
|
|
385
500
|
* Default: If a fieldset is not included in the request, returns only the `memberId` and `anonymized` fields.
|
|
501
|
+
* @maxSize 20
|
|
386
502
|
*/
|
|
387
503
|
fieldset?: TicketFieldset[];
|
|
388
504
|
}
|
|
@@ -391,9 +507,18 @@ export interface GetTicketResponse {
|
|
|
391
507
|
ticket?: TicketingTicket;
|
|
392
508
|
}
|
|
393
509
|
export interface CheckInTicketRequest {
|
|
394
|
-
/**
|
|
510
|
+
/**
|
|
511
|
+
* Event ID to which the ticket belongs.
|
|
512
|
+
* @format GUID
|
|
513
|
+
*/
|
|
395
514
|
eventId: string;
|
|
396
|
-
/**
|
|
515
|
+
/**
|
|
516
|
+
* Tickets to check-in.
|
|
517
|
+
* @minLength 1
|
|
518
|
+
* @maxLength 36
|
|
519
|
+
* @minSize 1
|
|
520
|
+
* @maxSize 100
|
|
521
|
+
*/
|
|
397
522
|
ticketNumber?: string[];
|
|
398
523
|
}
|
|
399
524
|
export interface CheckInTicketResponse {
|
|
@@ -403,17 +528,29 @@ export interface CheckInTicketResponse {
|
|
|
403
528
|
export interface OrderUpdated {
|
|
404
529
|
/** Order updated timestamp in ISO UTC format. */
|
|
405
530
|
timestamp?: Date | null;
|
|
406
|
-
/**
|
|
531
|
+
/**
|
|
532
|
+
* Site language when Order initiated
|
|
533
|
+
* @format LANGUAGE
|
|
534
|
+
*/
|
|
407
535
|
language?: string | null;
|
|
408
|
-
/**
|
|
536
|
+
/**
|
|
537
|
+
* Locale in which Order was created.
|
|
538
|
+
* @format LANGUAGE_TAG
|
|
539
|
+
*/
|
|
409
540
|
locale?: string | null;
|
|
410
|
-
/**
|
|
541
|
+
/**
|
|
542
|
+
* Event ID to which the ticket belongs.
|
|
543
|
+
* @format GUID
|
|
544
|
+
*/
|
|
411
545
|
eventId?: string;
|
|
412
546
|
/** Unique order number. */
|
|
413
547
|
orderNumber?: string;
|
|
414
548
|
/** Contact ID associated with this order. */
|
|
415
549
|
contactId?: string;
|
|
416
|
-
/**
|
|
550
|
+
/**
|
|
551
|
+
* Member ID associated with this order.
|
|
552
|
+
* @format GUID
|
|
553
|
+
*/
|
|
417
554
|
memberId?: string | null;
|
|
418
555
|
/**
|
|
419
556
|
* Order created timestamp.
|
|
@@ -449,7 +586,10 @@ export interface OrderUpdated {
|
|
|
449
586
|
export interface Ticket {
|
|
450
587
|
/** Unique issued ticket number. */
|
|
451
588
|
ticketNumber?: string;
|
|
452
|
-
/**
|
|
589
|
+
/**
|
|
590
|
+
* Ticket definition ID.
|
|
591
|
+
* @format GUID
|
|
592
|
+
*/
|
|
453
593
|
ticketDefinitionId?: string;
|
|
454
594
|
/** Ticket check-in. */
|
|
455
595
|
checkIn?: CheckIn;
|
|
@@ -463,11 +603,17 @@ export interface Ticket {
|
|
|
463
603
|
lastName?: string | null;
|
|
464
604
|
/** Guest email. */
|
|
465
605
|
email?: string | null;
|
|
466
|
-
/**
|
|
606
|
+
/**
|
|
607
|
+
* Contact ID associated with this ticket.
|
|
608
|
+
* @format GUID
|
|
609
|
+
*/
|
|
467
610
|
contactId?: string | null;
|
|
468
611
|
/** Whether ticket is confirmed */
|
|
469
612
|
confirmed?: boolean;
|
|
470
|
-
/**
|
|
613
|
+
/**
|
|
614
|
+
* Member ID associated with this ticket.
|
|
615
|
+
* @format GUID
|
|
616
|
+
*/
|
|
471
617
|
memberId?: string | null;
|
|
472
618
|
/** Ticket form response (only assigned tickets contain separate forms). */
|
|
473
619
|
form?: FormResponse;
|
|
@@ -477,7 +623,10 @@ export interface Ticket {
|
|
|
477
623
|
anonymized?: boolean;
|
|
478
624
|
/** URL and password to online conference */
|
|
479
625
|
onlineConferencingLogin?: OnlineConferencingLogin;
|
|
480
|
-
/**
|
|
626
|
+
/**
|
|
627
|
+
* Seat ID associated with this ticket.
|
|
628
|
+
* @maxLength 36
|
|
629
|
+
*/
|
|
481
630
|
seatId?: string | null;
|
|
482
631
|
/** Whether ticket is canceled. */
|
|
483
632
|
canceled?: boolean | null;
|
|
@@ -485,6 +634,7 @@ export interface Ticket {
|
|
|
485
634
|
export interface OnlineConferencingLogin {
|
|
486
635
|
/**
|
|
487
636
|
* Link URL to the online conference.
|
|
637
|
+
* @format WEB_URL
|
|
488
638
|
* @readonly
|
|
489
639
|
*/
|
|
490
640
|
link?: string;
|
|
@@ -495,9 +645,18 @@ export interface OnlineConferencingLogin {
|
|
|
495
645
|
password?: string | null;
|
|
496
646
|
}
|
|
497
647
|
export interface DeleteTicketCheckInRequest {
|
|
498
|
-
/**
|
|
648
|
+
/**
|
|
649
|
+
* Event ID to which the ticket belongs.
|
|
650
|
+
* @format GUID
|
|
651
|
+
*/
|
|
499
652
|
eventId: string;
|
|
500
|
-
/**
|
|
653
|
+
/**
|
|
654
|
+
* Ticket numbers which check-ins to delete.
|
|
655
|
+
* @minLength 1
|
|
656
|
+
* @maxLength 36
|
|
657
|
+
* @minSize 1
|
|
658
|
+
* @maxSize 100
|
|
659
|
+
*/
|
|
501
660
|
ticketNumber?: string[];
|
|
502
661
|
}
|
|
503
662
|
export interface DeleteTicketCheckInResponse {
|
|
@@ -505,9 +664,16 @@ export interface DeleteTicketCheckInResponse {
|
|
|
505
664
|
tickets?: TicketingTicket[];
|
|
506
665
|
}
|
|
507
666
|
export interface UpdateTicketRequest {
|
|
508
|
-
/**
|
|
667
|
+
/**
|
|
668
|
+
* Event ID to which the ticket belongs.
|
|
669
|
+
* @format GUID
|
|
670
|
+
*/
|
|
509
671
|
eventId: string;
|
|
510
|
-
/**
|
|
672
|
+
/**
|
|
673
|
+
* A unique ticket number which is assigned automatically when creating a ticket.
|
|
674
|
+
* @minLength 1
|
|
675
|
+
* @maxLength 36
|
|
676
|
+
*/
|
|
511
677
|
ticketNumber: string;
|
|
512
678
|
/**
|
|
513
679
|
* Set of field paths, specifying which parts of this resource to update.
|
|
@@ -529,9 +695,18 @@ export interface UpdateTicketResponse {
|
|
|
529
695
|
ticket?: TicketingTicket;
|
|
530
696
|
}
|
|
531
697
|
export interface BulkUpdateTicketsRequest {
|
|
532
|
-
/**
|
|
698
|
+
/**
|
|
699
|
+
* Event ID to which the ticket belongs.
|
|
700
|
+
* @format GUID
|
|
701
|
+
*/
|
|
533
702
|
eventId: string;
|
|
534
|
-
/**
|
|
703
|
+
/**
|
|
704
|
+
* A unique ticket number which is assigned automatically when creating a ticket.
|
|
705
|
+
* @minLength 1
|
|
706
|
+
* @maxLength 36
|
|
707
|
+
* @minSize 1
|
|
708
|
+
* @maxSize 100
|
|
709
|
+
*/
|
|
535
710
|
ticketNumber?: string[];
|
|
536
711
|
/** Whether tickets are archived. */
|
|
537
712
|
archived?: boolean;
|
|
@@ -541,7 +716,10 @@ export interface BulkUpdateTicketsResponse {
|
|
|
541
716
|
tickets?: TicketingTicket[];
|
|
542
717
|
}
|
|
543
718
|
export interface GetDemoTicketRequest {
|
|
544
|
-
/**
|
|
719
|
+
/**
|
|
720
|
+
* Ticket definition ID.
|
|
721
|
+
* @format GUID
|
|
722
|
+
*/
|
|
545
723
|
definitionId?: string;
|
|
546
724
|
}
|
|
547
725
|
export interface GetDemoTicketResponse {
|
|
@@ -549,9 +727,15 @@ export interface GetDemoTicketResponse {
|
|
|
549
727
|
ticket?: TicketingTicket;
|
|
550
728
|
}
|
|
551
729
|
export interface MessageEnvelope {
|
|
552
|
-
/**
|
|
730
|
+
/**
|
|
731
|
+
* App instance ID.
|
|
732
|
+
* @format GUID
|
|
733
|
+
*/
|
|
553
734
|
instanceId?: string | null;
|
|
554
|
-
/**
|
|
735
|
+
/**
|
|
736
|
+
* Event type.
|
|
737
|
+
* @maxLength 150
|
|
738
|
+
*/
|
|
555
739
|
eventType?: string;
|
|
556
740
|
/** The identification type and identity data. */
|
|
557
741
|
identity?: IdentificationData;
|
|
@@ -559,26 +743,50 @@ export interface MessageEnvelope {
|
|
|
559
743
|
data?: string;
|
|
560
744
|
}
|
|
561
745
|
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
562
|
-
/**
|
|
746
|
+
/**
|
|
747
|
+
* ID of a site visitor that has not logged in to the site.
|
|
748
|
+
* @format GUID
|
|
749
|
+
*/
|
|
563
750
|
anonymousVisitorId?: string;
|
|
564
|
-
/**
|
|
751
|
+
/**
|
|
752
|
+
* ID of a site visitor that has logged in to the site.
|
|
753
|
+
* @format GUID
|
|
754
|
+
*/
|
|
565
755
|
memberId?: string;
|
|
566
|
-
/**
|
|
756
|
+
/**
|
|
757
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
758
|
+
* @format GUID
|
|
759
|
+
*/
|
|
567
760
|
wixUserId?: string;
|
|
568
|
-
/**
|
|
761
|
+
/**
|
|
762
|
+
* ID of an app.
|
|
763
|
+
* @format GUID
|
|
764
|
+
*/
|
|
569
765
|
appId?: string;
|
|
570
766
|
/** @readonly */
|
|
571
767
|
identityType?: WebhookIdentityType;
|
|
572
768
|
}
|
|
573
769
|
/** @oneof */
|
|
574
770
|
export interface IdentificationDataIdOneOf {
|
|
575
|
-
/**
|
|
771
|
+
/**
|
|
772
|
+
* ID of a site visitor that has not logged in to the site.
|
|
773
|
+
* @format GUID
|
|
774
|
+
*/
|
|
576
775
|
anonymousVisitorId?: string;
|
|
577
|
-
/**
|
|
776
|
+
/**
|
|
777
|
+
* ID of a site visitor that has logged in to the site.
|
|
778
|
+
* @format GUID
|
|
779
|
+
*/
|
|
578
780
|
memberId?: string;
|
|
579
|
-
/**
|
|
781
|
+
/**
|
|
782
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
783
|
+
* @format GUID
|
|
784
|
+
*/
|
|
580
785
|
wixUserId?: string;
|
|
581
|
-
/**
|
|
786
|
+
/**
|
|
787
|
+
* ID of an app.
|
|
788
|
+
* @format GUID
|
|
789
|
+
*/
|
|
582
790
|
appId?: string;
|
|
583
791
|
}
|
|
584
792
|
export declare enum WebhookIdentityType {
|
|
@@ -664,9 +872,15 @@ export interface BulkUpdateTicketsResponseNonNullableFields {
|
|
|
664
872
|
tickets: TicketingTicketNonNullableFields[];
|
|
665
873
|
}
|
|
666
874
|
export interface BaseEventMetadata {
|
|
667
|
-
/**
|
|
875
|
+
/**
|
|
876
|
+
* App instance ID.
|
|
877
|
+
* @format GUID
|
|
878
|
+
*/
|
|
668
879
|
instanceId?: string | null;
|
|
669
|
-
/**
|
|
880
|
+
/**
|
|
881
|
+
* Event type.
|
|
882
|
+
* @maxLength 150
|
|
883
|
+
*/
|
|
670
884
|
eventType?: string;
|
|
671
885
|
/** The identification type and identity data. */
|
|
672
886
|
identity?: IdentificationData;
|
|
@@ -679,6 +893,8 @@ export interface TicketOrderUpdatedEnvelope {
|
|
|
679
893
|
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
680
894
|
* @permissionScope Manage Events - all permissions
|
|
681
895
|
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
896
|
+
* @permissionScope Manage Events
|
|
897
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
682
898
|
* @permissionScope Read Basic Events Order Info
|
|
683
899
|
* @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS
|
|
684
900
|
* @permissionScope Manage Orders
|
|
@@ -705,6 +921,8 @@ export declare function onTicketOrderUpdated(handler: (event: TicketOrderUpdated
|
|
|
705
921
|
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
706
922
|
* @permissionScope Manage Events - all permissions
|
|
707
923
|
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
924
|
+
* @permissionScope Manage Events
|
|
925
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
708
926
|
* @permissionScope Manage Guest List
|
|
709
927
|
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
710
928
|
* @permissionScope Read Event Tickets and Guest List
|
|
@@ -719,15 +937,34 @@ export interface ListTicketsOptions {
|
|
|
719
937
|
* Offset. See [Pagination](/wix-events-v2/pagination).
|
|
720
938
|
*/
|
|
721
939
|
offset?: number;
|
|
722
|
-
/**
|
|
940
|
+
/**
|
|
941
|
+
* Number of items to load per page. See [Pagination](/wix-events-v2/pagination).
|
|
942
|
+
* @max 100
|
|
943
|
+
*/
|
|
723
944
|
limit?: number;
|
|
724
|
-
/**
|
|
945
|
+
/**
|
|
946
|
+
* Order numbers.
|
|
947
|
+
* @minLength 1
|
|
948
|
+
* @maxLength 36
|
|
949
|
+
* @maxSize 20
|
|
950
|
+
*/
|
|
725
951
|
orderNumber?: string[];
|
|
726
|
-
/**
|
|
952
|
+
/**
|
|
953
|
+
* Ticket numbers.
|
|
954
|
+
* @minLength 1
|
|
955
|
+
* @maxLength 36
|
|
956
|
+
* @maxSize 50
|
|
957
|
+
*/
|
|
727
958
|
ticketNumber?: string[];
|
|
728
|
-
/**
|
|
959
|
+
/**
|
|
960
|
+
* Textual search filter - search is performed on `"orderFullName"`, `"guestFullName"`, and `"ticketNumber"`.
|
|
961
|
+
* @maxLength 200
|
|
962
|
+
*/
|
|
729
963
|
searchPhrase?: string;
|
|
730
|
-
/**
|
|
964
|
+
/**
|
|
965
|
+
* Order statuses.
|
|
966
|
+
* @maxSize 20
|
|
967
|
+
*/
|
|
731
968
|
orderStatus?: OrderStatus[];
|
|
732
969
|
/**
|
|
733
970
|
* Predefined sets of fields to return.
|
|
@@ -736,6 +973,7 @@ export interface ListTicketsOptions {
|
|
|
736
973
|
* - `GUEST_FORM`: Returns `guestDetails.form`.
|
|
737
974
|
*
|
|
738
975
|
* Default: If a fieldset is not included in the request, returns only the `memberId` and `anonymized` fields.
|
|
976
|
+
* @maxSize 20
|
|
739
977
|
*/
|
|
740
978
|
fieldset?: TicketFieldset[];
|
|
741
979
|
/**
|
|
@@ -749,23 +987,45 @@ export interface ListTicketsOptions {
|
|
|
749
987
|
* - `FREE`: Returns free tickets.
|
|
750
988
|
* - `PAID`: Return paid tickets.
|
|
751
989
|
* - `MEMBER`: Return members' tickets.
|
|
990
|
+
* @maxSize 20
|
|
752
991
|
*/
|
|
753
992
|
state?: State[];
|
|
754
|
-
/**
|
|
993
|
+
/**
|
|
994
|
+
* Site member IDs.
|
|
995
|
+
* @format GUID
|
|
996
|
+
* @maxSize 500
|
|
997
|
+
*/
|
|
755
998
|
memberId?: string[];
|
|
756
|
-
/**
|
|
999
|
+
/**
|
|
1000
|
+
* Filter facets.
|
|
1001
|
+
* @maxLength 100
|
|
1002
|
+
* @maxSize 20
|
|
1003
|
+
*/
|
|
757
1004
|
facet?: string[];
|
|
758
1005
|
/**
|
|
759
1006
|
* Sort order.
|
|
760
1007
|
*
|
|
761
1008
|
* Default: `"ticketNumber"`:`"asc"`.
|
|
1009
|
+
* @maxLength 100
|
|
762
1010
|
*/
|
|
763
1011
|
sort?: string;
|
|
764
|
-
/**
|
|
1012
|
+
/**
|
|
1013
|
+
* Guest contact IDs.
|
|
1014
|
+
* @format GUID
|
|
1015
|
+
* @maxSize 100
|
|
1016
|
+
*/
|
|
765
1017
|
contactId?: string[];
|
|
766
|
-
/**
|
|
1018
|
+
/**
|
|
1019
|
+
* Ticket definition IDs.
|
|
1020
|
+
* @format GUID
|
|
1021
|
+
* @maxSize 10
|
|
1022
|
+
*/
|
|
767
1023
|
ticketDefinitionId?: string[];
|
|
768
|
-
/**
|
|
1024
|
+
/**
|
|
1025
|
+
* Seat IDs.
|
|
1026
|
+
* @maxLength 36
|
|
1027
|
+
* @maxSize 50
|
|
1028
|
+
*/
|
|
769
1029
|
seatId?: string[];
|
|
770
1030
|
}
|
|
771
1031
|
/**
|
|
@@ -781,6 +1041,8 @@ export interface ListTicketsOptions {
|
|
|
781
1041
|
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
782
1042
|
* @permissionScope Manage Events - all permissions
|
|
783
1043
|
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
1044
|
+
* @permissionScope Manage Events
|
|
1045
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
784
1046
|
* @permissionScope Manage Guest List
|
|
785
1047
|
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
786
1048
|
* @permissionScope Read Event Tickets and Guest List
|
|
@@ -791,9 +1053,15 @@ export interface ListTicketsOptions {
|
|
|
791
1053
|
*/
|
|
792
1054
|
export declare function getTicket(identifiers: GetTicketIdentifiers, options?: GetTicketOptions): Promise<TicketingTicket & TicketingTicketNonNullableFields>;
|
|
793
1055
|
export interface GetTicketIdentifiers {
|
|
794
|
-
/**
|
|
1056
|
+
/**
|
|
1057
|
+
* Event ID to which the ticket belongs.
|
|
1058
|
+
* @format GUID
|
|
1059
|
+
*/
|
|
795
1060
|
eventId: string;
|
|
796
|
-
/**
|
|
1061
|
+
/**
|
|
1062
|
+
* A unique ticket number which is assigned automatically when creating a ticket.
|
|
1063
|
+
* @maxLength 36
|
|
1064
|
+
*/
|
|
797
1065
|
ticketNumber: string;
|
|
798
1066
|
}
|
|
799
1067
|
export interface GetTicketOptions {
|
|
@@ -804,6 +1072,7 @@ export interface GetTicketOptions {
|
|
|
804
1072
|
* - `GUEST_FORM`: Returns `guestDetails.form`.
|
|
805
1073
|
*
|
|
806
1074
|
* Default: If a fieldset is not included in the request, returns only the `memberId` and `anonymized` fields.
|
|
1075
|
+
* @maxSize 20
|
|
807
1076
|
*/
|
|
808
1077
|
fieldset?: TicketFieldset[];
|
|
809
1078
|
}
|
|
@@ -818,7 +1087,13 @@ export interface GetTicketOptions {
|
|
|
818
1087
|
*/
|
|
819
1088
|
export declare function checkInTickets(eventId: string, options?: CheckInTicketsOptions): Promise<CheckInTicketResponse & CheckInTicketResponseNonNullableFields>;
|
|
820
1089
|
export interface CheckInTicketsOptions {
|
|
821
|
-
/**
|
|
1090
|
+
/**
|
|
1091
|
+
* Tickets to check-in.
|
|
1092
|
+
* @minLength 1
|
|
1093
|
+
* @maxLength 36
|
|
1094
|
+
* @minSize 1
|
|
1095
|
+
* @maxSize 100
|
|
1096
|
+
*/
|
|
822
1097
|
ticketNumber?: string[];
|
|
823
1098
|
}
|
|
824
1099
|
/**
|
|
@@ -832,7 +1107,13 @@ export interface CheckInTicketsOptions {
|
|
|
832
1107
|
*/
|
|
833
1108
|
export declare function deleteTicketCheckIns(eventId: string, options?: DeleteTicketCheckInsOptions): Promise<DeleteTicketCheckInResponse & DeleteTicketCheckInResponseNonNullableFields>;
|
|
834
1109
|
export interface DeleteTicketCheckInsOptions {
|
|
835
|
-
/**
|
|
1110
|
+
/**
|
|
1111
|
+
* Ticket numbers which check-ins to delete.
|
|
1112
|
+
* @minLength 1
|
|
1113
|
+
* @maxLength 36
|
|
1114
|
+
* @minSize 1
|
|
1115
|
+
* @maxSize 100
|
|
1116
|
+
*/
|
|
836
1117
|
ticketNumber?: string[];
|
|
837
1118
|
}
|
|
838
1119
|
/**
|
|
@@ -846,6 +1127,8 @@ export interface DeleteTicketCheckInsOptions {
|
|
|
846
1127
|
* @permissionId WIX_EVENTS.MANAGE_TICKETS
|
|
847
1128
|
* @permissionScope Manage Events - all permissions
|
|
848
1129
|
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
1130
|
+
* @permissionScope Manage Events
|
|
1131
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
849
1132
|
* @permissionScope Manage Guest List
|
|
850
1133
|
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
851
1134
|
* @applicableIdentity APP
|
|
@@ -853,9 +1136,16 @@ export interface DeleteTicketCheckInsOptions {
|
|
|
853
1136
|
*/
|
|
854
1137
|
export declare function updateTicket(identifiers: UpdateTicketIdentifiers, options?: UpdateTicketOptions): Promise<UpdateTicketResponse & UpdateTicketResponseNonNullableFields>;
|
|
855
1138
|
export interface UpdateTicketIdentifiers {
|
|
856
|
-
/**
|
|
1139
|
+
/**
|
|
1140
|
+
* Event ID to which the ticket belongs.
|
|
1141
|
+
* @format GUID
|
|
1142
|
+
*/
|
|
857
1143
|
eventId: string;
|
|
858
|
-
/**
|
|
1144
|
+
/**
|
|
1145
|
+
* A unique ticket number which is assigned automatically when creating a ticket.
|
|
1146
|
+
* @minLength 1
|
|
1147
|
+
* @maxLength 36
|
|
1148
|
+
*/
|
|
859
1149
|
ticketNumber: string;
|
|
860
1150
|
}
|
|
861
1151
|
export interface UpdateTicketOptions {
|
|
@@ -879,6 +1169,8 @@ export interface UpdateTicketOptions {
|
|
|
879
1169
|
* @permissionId WIX_EVENTS.MANAGE_TICKETS
|
|
880
1170
|
* @permissionScope Manage Events - all permissions
|
|
881
1171
|
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
1172
|
+
* @permissionScope Manage Events
|
|
1173
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
882
1174
|
* @permissionScope Manage Guest List
|
|
883
1175
|
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
884
1176
|
* @applicableIdentity APP
|
|
@@ -886,7 +1178,13 @@ export interface UpdateTicketOptions {
|
|
|
886
1178
|
*/
|
|
887
1179
|
export declare function bulkUpdateTickets(eventId: string, options?: BulkUpdateTicketsOptions): Promise<BulkUpdateTicketsResponse & BulkUpdateTicketsResponseNonNullableFields>;
|
|
888
1180
|
export interface BulkUpdateTicketsOptions {
|
|
889
|
-
/**
|
|
1181
|
+
/**
|
|
1182
|
+
* A unique ticket number which is assigned automatically when creating a ticket.
|
|
1183
|
+
* @minLength 1
|
|
1184
|
+
* @maxLength 36
|
|
1185
|
+
* @minSize 1
|
|
1186
|
+
* @maxSize 100
|
|
1187
|
+
*/
|
|
890
1188
|
ticketNumber?: string[];
|
|
891
1189
|
/** Whether tickets are archived. */
|
|
892
1190
|
archived?: boolean;
|