@wix/auto_sdk_events_tickets 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (111) hide show
  1. package/build/cjs/index.d.ts +1 -0
  2. package/build/cjs/index.js +18 -0
  3. package/build/cjs/index.js.map +1 -0
  4. package/build/cjs/index.typings.d.ts +1 -0
  5. package/build/cjs/index.typings.js +18 -0
  6. package/build/cjs/index.typings.js.map +1 -0
  7. package/build/cjs/meta.d.ts +1 -0
  8. package/build/cjs/meta.js +18 -0
  9. package/build/cjs/meta.js.map +1 -0
  10. package/build/cjs/src/events-v1-ticket-tickets.context.d.ts +14 -0
  11. package/build/cjs/src/events-v1-ticket-tickets.context.js +23 -0
  12. package/build/cjs/src/events-v1-ticket-tickets.context.js.map +1 -0
  13. package/build/cjs/src/events-v1-ticket-tickets.http.d.ts +19 -0
  14. package/build/cjs/src/events-v1-ticket-tickets.http.js +797 -0
  15. package/build/cjs/src/events-v1-ticket-tickets.http.js.map +1 -0
  16. package/build/cjs/src/events-v1-ticket-tickets.meta.d.ts +28 -0
  17. package/build/cjs/src/events-v1-ticket-tickets.meta.js +142 -0
  18. package/build/cjs/src/events-v1-ticket-tickets.meta.js.map +1 -0
  19. package/build/cjs/src/events-v1-ticket-tickets.public.d.ts +66 -0
  20. package/build/cjs/src/events-v1-ticket-tickets.public.js +82 -0
  21. package/build/cjs/src/events-v1-ticket-tickets.public.js.map +1 -0
  22. package/build/cjs/src/events-v1-ticket-tickets.types.d.ts +641 -0
  23. package/build/cjs/src/events-v1-ticket-tickets.types.js +90 -0
  24. package/build/cjs/src/events-v1-ticket-tickets.types.js.map +1 -0
  25. package/build/cjs/src/events-v1-ticket-tickets.universal.d.ts +880 -0
  26. package/build/cjs/src/events-v1-ticket-tickets.universal.js +464 -0
  27. package/build/cjs/src/events-v1-ticket-tickets.universal.js.map +1 -0
  28. package/build/es/index.d.ts +1 -0
  29. package/build/es/index.js +2 -0
  30. package/build/es/index.js.map +1 -0
  31. package/build/es/index.typings.d.ts +1 -0
  32. package/build/es/index.typings.js +2 -0
  33. package/build/es/index.typings.js.map +1 -0
  34. package/build/es/meta.d.ts +1 -0
  35. package/build/es/meta.js +2 -0
  36. package/build/es/meta.js.map +1 -0
  37. package/build/es/package.json +3 -0
  38. package/build/es/src/events-v1-ticket-tickets.context.d.ts +14 -0
  39. package/build/es/src/events-v1-ticket-tickets.context.js +14 -0
  40. package/build/es/src/events-v1-ticket-tickets.context.js.map +1 -0
  41. package/build/es/src/events-v1-ticket-tickets.http.d.ts +19 -0
  42. package/build/es/src/events-v1-ticket-tickets.http.js +788 -0
  43. package/build/es/src/events-v1-ticket-tickets.http.js.map +1 -0
  44. package/build/es/src/events-v1-ticket-tickets.meta.d.ts +28 -0
  45. package/build/es/src/events-v1-ticket-tickets.meta.js +110 -0
  46. package/build/es/src/events-v1-ticket-tickets.meta.js.map +1 -0
  47. package/build/es/src/events-v1-ticket-tickets.public.d.ts +66 -0
  48. package/build/es/src/events-v1-ticket-tickets.public.js +67 -0
  49. package/build/es/src/events-v1-ticket-tickets.public.js.map +1 -0
  50. package/build/es/src/events-v1-ticket-tickets.types.d.ts +641 -0
  51. package/build/es/src/events-v1-ticket-tickets.types.js +87 -0
  52. package/build/es/src/events-v1-ticket-tickets.types.js.map +1 -0
  53. package/build/es/src/events-v1-ticket-tickets.universal.d.ts +880 -0
  54. package/build/es/src/events-v1-ticket-tickets.universal.js +432 -0
  55. package/build/es/src/events-v1-ticket-tickets.universal.js.map +1 -0
  56. package/build/internal/cjs/index.d.ts +1 -0
  57. package/build/internal/cjs/index.js +18 -0
  58. package/build/internal/cjs/index.js.map +1 -0
  59. package/build/internal/cjs/index.typings.d.ts +1 -0
  60. package/build/internal/cjs/index.typings.js +18 -0
  61. package/build/internal/cjs/index.typings.js.map +1 -0
  62. package/build/internal/cjs/meta.d.ts +1 -0
  63. package/build/internal/cjs/meta.js +18 -0
  64. package/build/internal/cjs/meta.js.map +1 -0
  65. package/build/internal/cjs/src/events-v1-ticket-tickets.context.d.ts +14 -0
  66. package/build/internal/cjs/src/events-v1-ticket-tickets.context.js +23 -0
  67. package/build/internal/cjs/src/events-v1-ticket-tickets.context.js.map +1 -0
  68. package/build/internal/cjs/src/events-v1-ticket-tickets.http.d.ts +19 -0
  69. package/build/internal/cjs/src/events-v1-ticket-tickets.http.js +797 -0
  70. package/build/internal/cjs/src/events-v1-ticket-tickets.http.js.map +1 -0
  71. package/build/internal/cjs/src/events-v1-ticket-tickets.meta.d.ts +28 -0
  72. package/build/internal/cjs/src/events-v1-ticket-tickets.meta.js +142 -0
  73. package/build/internal/cjs/src/events-v1-ticket-tickets.meta.js.map +1 -0
  74. package/build/internal/cjs/src/events-v1-ticket-tickets.public.d.ts +66 -0
  75. package/build/internal/cjs/src/events-v1-ticket-tickets.public.js +82 -0
  76. package/build/internal/cjs/src/events-v1-ticket-tickets.public.js.map +1 -0
  77. package/build/internal/cjs/src/events-v1-ticket-tickets.types.d.ts +641 -0
  78. package/build/internal/cjs/src/events-v1-ticket-tickets.types.js +90 -0
  79. package/build/internal/cjs/src/events-v1-ticket-tickets.types.js.map +1 -0
  80. package/build/internal/cjs/src/events-v1-ticket-tickets.universal.d.ts +892 -0
  81. package/build/internal/cjs/src/events-v1-ticket-tickets.universal.js +464 -0
  82. package/build/internal/cjs/src/events-v1-ticket-tickets.universal.js.map +1 -0
  83. package/build/internal/es/index.d.ts +1 -0
  84. package/build/internal/es/index.js +2 -0
  85. package/build/internal/es/index.js.map +1 -0
  86. package/build/internal/es/index.typings.d.ts +1 -0
  87. package/build/internal/es/index.typings.js +2 -0
  88. package/build/internal/es/index.typings.js.map +1 -0
  89. package/build/internal/es/meta.d.ts +1 -0
  90. package/build/internal/es/meta.js +2 -0
  91. package/build/internal/es/meta.js.map +1 -0
  92. package/build/internal/es/src/events-v1-ticket-tickets.context.d.ts +14 -0
  93. package/build/internal/es/src/events-v1-ticket-tickets.context.js +14 -0
  94. package/build/internal/es/src/events-v1-ticket-tickets.context.js.map +1 -0
  95. package/build/internal/es/src/events-v1-ticket-tickets.http.d.ts +19 -0
  96. package/build/internal/es/src/events-v1-ticket-tickets.http.js +788 -0
  97. package/build/internal/es/src/events-v1-ticket-tickets.http.js.map +1 -0
  98. package/build/internal/es/src/events-v1-ticket-tickets.meta.d.ts +28 -0
  99. package/build/internal/es/src/events-v1-ticket-tickets.meta.js +110 -0
  100. package/build/internal/es/src/events-v1-ticket-tickets.meta.js.map +1 -0
  101. package/build/internal/es/src/events-v1-ticket-tickets.public.d.ts +66 -0
  102. package/build/internal/es/src/events-v1-ticket-tickets.public.js +67 -0
  103. package/build/internal/es/src/events-v1-ticket-tickets.public.js.map +1 -0
  104. package/build/internal/es/src/events-v1-ticket-tickets.types.d.ts +641 -0
  105. package/build/internal/es/src/events-v1-ticket-tickets.types.js +87 -0
  106. package/build/internal/es/src/events-v1-ticket-tickets.types.js.map +1 -0
  107. package/build/internal/es/src/events-v1-ticket-tickets.universal.d.ts +892 -0
  108. package/build/internal/es/src/events-v1-ticket-tickets.universal.js +432 -0
  109. package/build/internal/es/src/events-v1-ticket-tickets.universal.js.map +1 -0
  110. package/meta/package.json +3 -0
  111. package/package.json +52 -0
@@ -0,0 +1,880 @@
1
+ export interface TicketingTicket {
2
+ /** A unique ticket number which is assigned automatically when creating a ticket. */
3
+ ticketNumber?: string;
4
+ /** Associated order number. */
5
+ orderNumber?: string;
6
+ /** Ticket definition ID. */
7
+ ticketDefinitionId?: string;
8
+ /** Ticket name. */
9
+ name?: string;
10
+ /** Ticket price. */
11
+ price?: Money;
12
+ /**
13
+ * Whether ticket requires payment.
14
+ * @readonly
15
+ */
16
+ free?: boolean;
17
+ /** Ticket and event policies. */
18
+ policy?: string;
19
+ /** Ticket check-in. */
20
+ checkIn?: CheckIn;
21
+ /**
22
+ * Associated order status. Possible values:
23
+ * - `FREE`: The order is confirmed, no payment is required.
24
+ * - `PENDING`: The order was paid, but the payment gateway suspended the payment.
25
+ * - `PAID`: The order is paid.
26
+ * - `OFFLINE_PENDING`: The order is confirmed but has to be paid in cash and the status is manually updated to `PAID`.
27
+ * - `INITIATED`: The order is awaiting for payment.
28
+ * - `CANCELED`: The order is canceled.
29
+ * - `DECLINED`: The order is declined.
30
+ */
31
+ orderStatus?: OrderStatus;
32
+ /** Whether order and ticket are visible in order list. */
33
+ orderArchived?: boolean;
34
+ /** Buyer full name. */
35
+ orderFullName?: string;
36
+ /** Guest full name. */
37
+ guestFullName?: string | null;
38
+ /** Guest personal details. */
39
+ guestDetails?: GuestDetails;
40
+ /** Whether the ticket is visible in an order. */
41
+ archived?: boolean;
42
+ /** Ticket owner member ID. */
43
+ memberId?: string | null;
44
+ /**
45
+ * Whether ticket was anonymized by GDPR delete.
46
+ * Anonymized tickets no longer contain personally identifiable information (PII).
47
+ */
48
+ anonymized?: boolean;
49
+ /**
50
+ * Ticket check-in URL.
51
+ * Shown as QR code image in PDF.
52
+ *
53
+ * Format: `https://www.wixevents.com/check-in/{ticket number},{event id}`
54
+ *
55
+ * Example: `https://www.wixevents.com/check-in/AAAA-AAAA-BB021,00000000-0000-0000-0000-000000000000`
56
+ */
57
+ checkInUrl?: string;
58
+ /** URL for ticket PDF download. */
59
+ ticketPdfUrl?: string;
60
+ /** Associated order checkout channel type. */
61
+ channel?: ChannelType;
62
+ /**
63
+ * An URL to download a ticket in the `.pkpass` format for Apple Wallet.
64
+ * @readonly
65
+ */
66
+ walletPassUrl?: string;
67
+ /**
68
+ * Whether ticket is canceled.
69
+ * @readonly
70
+ */
71
+ canceled?: boolean | null;
72
+ }
73
+ export interface Money {
74
+ /**
75
+ * *Deprecated:** Use `value` instead.
76
+ * @deprecated
77
+ */
78
+ amount?: string;
79
+ /** Currency in the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) format. For example, `USD`. */
80
+ currency?: string;
81
+ /** 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. */
82
+ value?: string | null;
83
+ }
84
+ export interface CheckIn {
85
+ /** Time of a ticket check-in. */
86
+ created?: Date | null;
87
+ }
88
+ export declare enum OrderStatus {
89
+ /** Order status not available for this request fieldset. */
90
+ NA_ORDER_STATUS = "NA_ORDER_STATUS",
91
+ /** Order is confirmed and payment isn't required. */
92
+ FREE = "FREE",
93
+ /** Order is paid for but the payment gateway has suspended the payment. */
94
+ PENDING = "PENDING",
95
+ /** Order is paid via a payment gateway. */
96
+ PAID = "PAID",
97
+ /** Order is confirmed but must be paid via offline payment. Status needs to be manually updated to `PAID`. */
98
+ OFFLINE_PENDING = "OFFLINE_PENDING",
99
+ /** Order is awaiting payment at the cashier. */
100
+ INITIATED = "INITIATED",
101
+ /** Order is canceled. */
102
+ CANCELED = "CANCELED",
103
+ /** Order payment is declined. */
104
+ DECLINED = "DECLINED",
105
+ /** Order payment is authorized. */
106
+ AUTHORIZED = "AUTHORIZED",
107
+ /** Order payment is voided. */
108
+ VOIDED = "VOIDED",
109
+ /** Order is partially paid with less than the total amount. */
110
+ PARTIALLY_PAID = "PARTIALLY_PAID"
111
+ }
112
+ export interface GuestDetails {
113
+ /** Whether ticket belongs to assigned guest. */
114
+ guestAssigned?: boolean;
115
+ /** Guest first name. */
116
+ firstName?: string | null;
117
+ /** Guest last name. */
118
+ lastName?: string | null;
119
+ /** Guest email. */
120
+ email?: string | null;
121
+ /** Full form response. */
122
+ form?: FormResponse;
123
+ /** Contact ID associated with this guest. */
124
+ contactId?: string | null;
125
+ /** Guest phone number. */
126
+ phone?: string | null;
127
+ }
128
+ export interface FormResponse {
129
+ /** Form field inputs. */
130
+ inputValues?: InputValue[];
131
+ }
132
+ export interface InputValue {
133
+ /** Form field input name. */
134
+ inputName?: string;
135
+ /** Form field value. */
136
+ value?: string;
137
+ /** Form field values. */
138
+ values?: string[];
139
+ }
140
+ export interface FormattedAddress {
141
+ /** One line address representation. */
142
+ formatted?: string;
143
+ /** Address components (optional). */
144
+ address?: Address;
145
+ }
146
+ /** Physical address */
147
+ export interface Address extends AddressStreetOneOf {
148
+ /** Street name and number. */
149
+ streetAddress?: StreetAddress;
150
+ /** Main address line, usually street and number as free text. */
151
+ addressLine1?: string | null;
152
+ /** Country code. */
153
+ country?: string | null;
154
+ /** Subdivision shorthand. Usually, a short code (2 or 3 letters) that represents a state, region, prefecture, or province. e.g. NY */
155
+ subdivision?: string | null;
156
+ /** City name. */
157
+ city?: string | null;
158
+ /** Zip/postal code. */
159
+ postalCode?: string | null;
160
+ /** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */
161
+ addressLine2?: string | null;
162
+ }
163
+ /** @oneof */
164
+ export interface AddressStreetOneOf {
165
+ /** Street name and number. */
166
+ streetAddress?: StreetAddress;
167
+ /** Main address line, usually street and number as free text. */
168
+ addressLine?: string | null;
169
+ }
170
+ export interface StreetAddress {
171
+ /** Street number. */
172
+ number?: string;
173
+ /** Street name. */
174
+ name?: string;
175
+ }
176
+ export interface AddressLocation {
177
+ /** Address latitude. */
178
+ latitude?: number | null;
179
+ /** Address longitude. */
180
+ longitude?: number | null;
181
+ }
182
+ export interface Subdivision {
183
+ /** Short subdivision code. */
184
+ code?: string;
185
+ /** Subdivision full name. */
186
+ name?: string;
187
+ }
188
+ export declare enum SubdivisionType {
189
+ UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
190
+ /** State */
191
+ ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
192
+ /** County */
193
+ ADMINISTRATIVE_AREA_LEVEL_2 = "ADMINISTRATIVE_AREA_LEVEL_2",
194
+ /** City/town */
195
+ ADMINISTRATIVE_AREA_LEVEL_3 = "ADMINISTRATIVE_AREA_LEVEL_3",
196
+ /** Neighborhood/quarter */
197
+ ADMINISTRATIVE_AREA_LEVEL_4 = "ADMINISTRATIVE_AREA_LEVEL_4",
198
+ /** Street/block */
199
+ ADMINISTRATIVE_AREA_LEVEL_5 = "ADMINISTRATIVE_AREA_LEVEL_5",
200
+ /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
201
+ COUNTRY = "COUNTRY"
202
+ }
203
+ /** Subdivision Concordance values */
204
+ export interface StandardDetails {
205
+ /** 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 */
206
+ iso31662?: string | null;
207
+ }
208
+ export declare enum ChannelType {
209
+ /** Buyer created the order via an online channel such as a website or mobile app. */
210
+ ONLINE = "ONLINE",
211
+ /** Sales person created the order and collected the money. */
212
+ OFFLINE_POS = "OFFLINE_POS"
213
+ }
214
+ export interface TicketDetails {
215
+ /** Unique seat id in the event venue. */
216
+ seatId?: string | null;
217
+ /**
218
+ * Optional sector label.
219
+ * @readonly
220
+ */
221
+ sectionLabel?: string | null;
222
+ /**
223
+ * Area label.
224
+ * @readonly
225
+ */
226
+ areaLabel?: string | null;
227
+ /**
228
+ * Table label.
229
+ * @readonly
230
+ */
231
+ tableLabel?: string | null;
232
+ /**
233
+ * Row label.
234
+ * @readonly
235
+ */
236
+ rowLabel?: string | null;
237
+ /**
238
+ * Seat label in a row or table.
239
+ * @readonly
240
+ */
241
+ seatLabel?: string | null;
242
+ /** Number of places in the spot. If not provided - defaults to 1. */
243
+ capacity?: number | null;
244
+ /** Custom pricing of ticket. */
245
+ priceOverride?: string | null;
246
+ /** Pricing option id. */
247
+ pricingOptionId?: string | null;
248
+ /**
249
+ * Pricing option name.
250
+ * @readonly
251
+ */
252
+ pricingOptionName?: string | null;
253
+ }
254
+ export interface ListTicketsRequest {
255
+ /** Event IDs. */
256
+ eventId: string[];
257
+ /** Offset. See [Pagination](/wix-events-v2/pagination). */
258
+ offset?: number;
259
+ /** Number of items to load per page. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */
260
+ limit?: number;
261
+ /** Order numbers. */
262
+ orderNumber?: string[];
263
+ /** Ticket numbers. */
264
+ ticketNumber?: string[];
265
+ /** Searches in the `orderFullName`, `guestFullName`, and `ticketNumber` fields. */
266
+ searchPhrase?: string;
267
+ /** Order statuses. */
268
+ orderStatus?: OrderStatus[];
269
+ /**
270
+ * Predefined sets of fields to return.
271
+ * - `TICKET_DETAILS`: Returns `ticketNumber`, `orderNumber`, `ticketDefinitionId`, `name`, `price`, `free`, `policy`, `qrCode`, `checkIn`, `orderStatus`, `orderArchived`, `archived`, `orderFullName`, `ticketPdf`, `checkInUrl` and `ticketPdfUrl`.
272
+ * - `GUEST_DETAILS`: Returns `guestDetails`.
273
+ * - `GUEST_FORM`: Returns `guestDetails.form`.
274
+ *
275
+ * Default: If a fieldset is not included in the request, returns only the `memberId` and `anonymized` fields.
276
+ */
277
+ fieldset?: TicketFieldset[];
278
+ /**
279
+ * Ticket states. Possible values:
280
+ * - `ORDER_ARCHIVED`: Returns tickets of the archived orders.
281
+ * - `ORDER_ACTIVE`: Returns tickets of the non-archived orders.
282
+ * - `TICKET_ARCHIVED`: Returns archived tickets.
283
+ * - `TICKET_ACTIVE`: Returns non-archived tickets.
284
+ * - `CHECKED_IN`: Returns checked-in tickets.
285
+ * - `NON_CHECKED_IN`: Returns tickets that are not checked in.
286
+ * - `FREE`: Returns free tickets.
287
+ * - `PAID`: Return paid tickets.
288
+ * - `MEMBER`: Return members' tickets.
289
+ */
290
+ state?: State[];
291
+ /** Site member IDs. */
292
+ memberId?: string[];
293
+ /** Filter facets. */
294
+ facet?: string[];
295
+ /** Sort order. Defaults to "ticket_number:asc". */
296
+ sort?: string;
297
+ /** Guest contact IDs. */
298
+ contactId?: string[];
299
+ /** Ticket definition IDs. */
300
+ ticketDefinitionId?: string[];
301
+ /** Seat IDs. */
302
+ seatId?: string[];
303
+ }
304
+ export declare enum TicketFieldset {
305
+ /** Include guest details in the ticket response. */
306
+ GUEST_DETAILS = "GUEST_DETAILS",
307
+ /** Include ticket details in the ticket response. */
308
+ TICKET_DETAILS = "TICKET_DETAILS",
309
+ /** Include individual guest form in the ticket response. */
310
+ GUEST_FORM = "GUEST_FORM"
311
+ }
312
+ export declare enum State {
313
+ /** Returns only archived orders' tickets. */
314
+ ORDER_ARCHIVED = "ORDER_ARCHIVED",
315
+ /** Returns only non-archived orders' tickets. */
316
+ ORDER_ACTIVE = "ORDER_ACTIVE",
317
+ /** Returns only archived tickets. */
318
+ TICKET_ARCHIVED = "TICKET_ARCHIVED",
319
+ /** Returns only non-archived tickets. */
320
+ TICKET_ACTIVE = "TICKET_ACTIVE",
321
+ /** Returns only checked-in tickets. */
322
+ CHECKED_IN = "CHECKED_IN",
323
+ /** Returns only non-checked-in tickets. */
324
+ NON_CHECKED_IN = "NON_CHECKED_IN",
325
+ /** Returns only free tickets. */
326
+ FREE = "FREE",
327
+ /** Returns only paid tickets. */
328
+ PAID = "PAID",
329
+ /** Returns only member tickets. */
330
+ MEMBER = "MEMBER"
331
+ }
332
+ export interface ListTicketsResponse {
333
+ /** Total tickets matching the given filters. */
334
+ total?: number;
335
+ /** Offset. */
336
+ offset?: number;
337
+ /** Limit. */
338
+ limit?: number;
339
+ /** Tickets. */
340
+ tickets?: TicketingTicket[];
341
+ /** Facets. */
342
+ facets?: Record<string, FacetCounts>;
343
+ }
344
+ export interface FacetCounts {
345
+ /** Facet counts aggregated per value. */
346
+ counts?: Record<string, number>;
347
+ }
348
+ export interface TicketFacets {
349
+ /** Filter facets. */
350
+ facets?: Record<string, TicketFacetCounts>;
351
+ }
352
+ export interface TicketFacetCounts {
353
+ /** Facet totals, aggregated per filter. */
354
+ counts?: Record<string, Counts>;
355
+ }
356
+ export interface Counts {
357
+ /** Number of tickets. */
358
+ count?: number;
359
+ /** Number of checked in tickets. */
360
+ checkedIn?: number;
361
+ }
362
+ export interface GetTicketRequest {
363
+ /** Event ID to which the ticket belongs. */
364
+ eventId: string;
365
+ /** A unique ticket number which is assigned automatically when creating a ticket. */
366
+ ticketNumber: string;
367
+ /**
368
+ * Predefined sets of fields to return.
369
+ * - `TICKET_DETAILS`: Returns `ticketNumber`, `orderNumber`, `ticketDefinitionId`, `name`, `price`, `free`, `policy`, `qrCode`, `checkIn`, `orderStatus`, `orderArchived`, `archived`, `orderFullName`, `ticketPdf`, `checkInUrl` and `ticketPdfUrl`.
370
+ * - `GUEST_DETAILS`: Returns `guestDetails`.
371
+ * - `GUEST_FORM`: Returns `guestDetails.form`.
372
+ *
373
+ * Default: If a fieldset is not included in the request, returns only the `memberId` and `anonymized` fields.
374
+ */
375
+ fieldset?: TicketFieldset[];
376
+ }
377
+ export interface GetTicketResponse {
378
+ /** Ticket. */
379
+ ticket?: TicketingTicket;
380
+ }
381
+ export interface CheckInTicketRequest {
382
+ /** Event ID to which the ticket belongs. */
383
+ eventId: string;
384
+ /** Tickets to check-in. */
385
+ ticketNumber?: string[];
386
+ }
387
+ export interface CheckInTicketResponse {
388
+ /** Updated tickets. */
389
+ tickets?: TicketingTicket[];
390
+ }
391
+ export interface OrderUpdated {
392
+ /** Order updated timestamp in ISO UTC format. */
393
+ timestamp?: Date | null;
394
+ /** Site language when Order initiated */
395
+ language?: string | null;
396
+ /** Locale in which Order was created. */
397
+ locale?: string | null;
398
+ /** Event ID to which the ticket belongs. */
399
+ eventId?: string;
400
+ /** Unique order number. */
401
+ orderNumber?: string;
402
+ /** Contact ID associated with this order. */
403
+ contactId?: string;
404
+ /** Member ID associated with this order. */
405
+ memberId?: string | null;
406
+ /**
407
+ * Order created timestamp.
408
+ * @readonly
409
+ */
410
+ created?: Date | null;
411
+ /**
412
+ * Order updated timestamp.
413
+ * @readonly
414
+ */
415
+ updated?: Date | null;
416
+ /** Buyer first name. */
417
+ firstName?: string;
418
+ /** Buyer last name. */
419
+ lastName?: string;
420
+ /** Buyer email. */
421
+ email?: string;
422
+ /** Checkout form response. */
423
+ checkoutForm?: FormResponse;
424
+ /** Whether order is confirmed - occurs once payment gateway processes the payment and funds reach merchant's account. */
425
+ confirmed?: boolean;
426
+ /** Order status. */
427
+ status?: OrderStatus;
428
+ /** Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc. */
429
+ method?: string | null;
430
+ /** Tickets generated after payment. */
431
+ tickets?: Ticket[];
432
+ /** Whether order was archived and excluded from results. */
433
+ archived?: boolean;
434
+ /** Whether event was triggered by GDPR delete request. */
435
+ triggeredByAnonymizeRequest?: boolean;
436
+ }
437
+ export interface Ticket {
438
+ /** Unique issued ticket number. */
439
+ ticketNumber?: string;
440
+ /** Ticket definition ID. */
441
+ ticketDefinitionId?: string;
442
+ /** Ticket check-in. */
443
+ checkIn?: CheckIn;
444
+ /** Ticket price. */
445
+ price?: Money;
446
+ /** Whether ticket is archived. */
447
+ archived?: boolean;
448
+ /** Guest first name. */
449
+ firstName?: string | null;
450
+ /** Guest last name. */
451
+ lastName?: string | null;
452
+ /** Guest email. */
453
+ email?: string | null;
454
+ /** Contact ID associated with this ticket. */
455
+ contactId?: string | null;
456
+ /** Whether ticket is confirmed */
457
+ confirmed?: boolean;
458
+ /** Member ID associated with this ticket. */
459
+ memberId?: string | null;
460
+ /** Ticket form response (only assigned tickets contain separate forms). */
461
+ form?: FormResponse;
462
+ /** Ticket name. */
463
+ ticketName?: string;
464
+ /** Anonymized tickets no longer contain personally identifiable information (PII). */
465
+ anonymized?: boolean;
466
+ /** URL and password to online conference */
467
+ onlineConferencingLogin?: OnlineConferencingLogin;
468
+ /** Seat ID associated with this ticket. */
469
+ seatId?: string | null;
470
+ /** Whether ticket is canceled. */
471
+ canceled?: boolean | null;
472
+ }
473
+ export interface OnlineConferencingLogin {
474
+ /**
475
+ * Link URL to the online conference.
476
+ * @readonly
477
+ */
478
+ link?: string;
479
+ /**
480
+ * Password for the online conference.
481
+ * @readonly
482
+ */
483
+ password?: string | null;
484
+ }
485
+ export interface DeleteTicketCheckInRequest {
486
+ /** Event ID to which the ticket belongs. */
487
+ eventId: string;
488
+ /** Ticket numbers which check-ins to delete. */
489
+ ticketNumber?: string[];
490
+ }
491
+ export interface DeleteTicketCheckInResponse {
492
+ /** Updated tickets. */
493
+ tickets?: TicketingTicket[];
494
+ }
495
+ export interface UpdateTicketRequest {
496
+ /** Event ID to which the ticket belongs. */
497
+ eventId: string;
498
+ /** A unique ticket number which is assigned automatically when creating a ticket. */
499
+ ticketNumber: string;
500
+ /**
501
+ * Set of field paths, specifying which parts of this resource to update.
502
+ * When `fields` is empty, the request is interpreted as a full update.
503
+ * Behavior follows [google.protobuf.FieldMask](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask) semantics.
504
+ */
505
+ fields?: string[];
506
+ /** Whether to archive the tickets. */
507
+ archived?: boolean;
508
+ /** Assigned guest details. */
509
+ guestDetails?: GuestDetailsUpdate;
510
+ }
511
+ export interface GuestDetailsUpdate {
512
+ /** Form of a guest assigned to a ticket. */
513
+ form?: FormResponse;
514
+ }
515
+ export interface UpdateTicketResponse {
516
+ /** Updated ticket. */
517
+ ticket?: TicketingTicket;
518
+ }
519
+ export interface BulkUpdateTicketsRequest {
520
+ /** Event ID to which the ticket belongs. */
521
+ eventId: string;
522
+ /** A unique ticket number which is assigned automatically when creating a ticket. */
523
+ ticketNumber?: string[];
524
+ /** Whether tickets are archived. */
525
+ archived?: boolean;
526
+ }
527
+ export interface BulkUpdateTicketsResponse {
528
+ /** Updated tickets. */
529
+ tickets?: TicketingTicket[];
530
+ }
531
+ export interface GetDemoTicketRequest {
532
+ /** Ticket definition ID. */
533
+ definitionId?: string;
534
+ }
535
+ export interface GetDemoTicketResponse {
536
+ /** Ticket. */
537
+ ticket?: TicketingTicket;
538
+ }
539
+ export interface MessageEnvelope {
540
+ /** App instance ID. */
541
+ instanceId?: string | null;
542
+ /** Event type. */
543
+ eventType?: string;
544
+ /** The identification type and identity data. */
545
+ identity?: IdentificationData;
546
+ /** Stringify payload. */
547
+ data?: string;
548
+ }
549
+ export interface IdentificationData extends IdentificationDataIdOneOf {
550
+ /** ID of a site visitor that has not logged in to the site. */
551
+ anonymousVisitorId?: string;
552
+ /** ID of a site visitor that has logged in to the site. */
553
+ memberId?: string;
554
+ /** ID of a Wix user (site owner, contributor, etc.). */
555
+ wixUserId?: string;
556
+ /** ID of an app. */
557
+ appId?: string;
558
+ /** @readonly */
559
+ identityType?: WebhookIdentityType;
560
+ }
561
+ /** @oneof */
562
+ export interface IdentificationDataIdOneOf {
563
+ /** ID of a site visitor that has not logged in to the site. */
564
+ anonymousVisitorId?: string;
565
+ /** ID of a site visitor that has logged in to the site. */
566
+ memberId?: string;
567
+ /** ID of a Wix user (site owner, contributor, etc.). */
568
+ wixUserId?: string;
569
+ /** ID of an app. */
570
+ appId?: string;
571
+ }
572
+ export declare enum WebhookIdentityType {
573
+ UNKNOWN = "UNKNOWN",
574
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
575
+ MEMBER = "MEMBER",
576
+ WIX_USER = "WIX_USER",
577
+ APP = "APP"
578
+ }
579
+ interface MoneyNonNullableFields {
580
+ amount: string;
581
+ currency: string;
582
+ }
583
+ interface StreetAddressNonNullableFields {
584
+ number: string;
585
+ name: string;
586
+ apt: string;
587
+ }
588
+ interface SubdivisionNonNullableFields {
589
+ name: string;
590
+ }
591
+ interface AddressNonNullableFields {
592
+ streetAddress?: StreetAddressNonNullableFields;
593
+ subdivisions: SubdivisionNonNullableFields[];
594
+ }
595
+ interface FormattedAddressNonNullableFields {
596
+ formatted: string;
597
+ address?: AddressNonNullableFields;
598
+ }
599
+ interface InputValueNonNullableFields {
600
+ inputName: string;
601
+ value: string;
602
+ values: string[];
603
+ address?: FormattedAddressNonNullableFields;
604
+ }
605
+ interface FormResponseNonNullableFields {
606
+ inputValues: InputValueNonNullableFields[];
607
+ }
608
+ interface GuestDetailsNonNullableFields {
609
+ guestAssigned: boolean;
610
+ form?: FormResponseNonNullableFields;
611
+ }
612
+ export interface TicketingTicketNonNullableFields {
613
+ ticketNumber: string;
614
+ orderNumber: string;
615
+ ticketDefinitionId: string;
616
+ name: string;
617
+ price?: MoneyNonNullableFields;
618
+ free: boolean;
619
+ policy: string;
620
+ qrCode: string;
621
+ orderStatus: OrderStatus;
622
+ orderArchived: boolean;
623
+ orderFullName: string;
624
+ guestDetails?: GuestDetailsNonNullableFields;
625
+ archived: boolean;
626
+ ticketPdf: string;
627
+ anonymized: boolean;
628
+ checkInUrl: string;
629
+ ticketPdfUrl: string;
630
+ channel: ChannelType;
631
+ walletPassUrl: string;
632
+ }
633
+ export interface ListTicketsResponseNonNullableFields {
634
+ total: number;
635
+ offset: number;
636
+ limit: number;
637
+ tickets: TicketingTicketNonNullableFields[];
638
+ }
639
+ export interface GetTicketResponseNonNullableFields {
640
+ ticket?: TicketingTicketNonNullableFields;
641
+ }
642
+ export interface CheckInTicketResponseNonNullableFields {
643
+ tickets: TicketingTicketNonNullableFields[];
644
+ }
645
+ export interface DeleteTicketCheckInResponseNonNullableFields {
646
+ tickets: TicketingTicketNonNullableFields[];
647
+ }
648
+ export interface UpdateTicketResponseNonNullableFields {
649
+ ticket?: TicketingTicketNonNullableFields;
650
+ }
651
+ export interface BulkUpdateTicketsResponseNonNullableFields {
652
+ tickets: TicketingTicketNonNullableFields[];
653
+ }
654
+ export interface BaseEventMetadata {
655
+ /** App instance ID. */
656
+ instanceId?: string | null;
657
+ /** Event type. */
658
+ eventType?: string;
659
+ /** The identification type and identity data. */
660
+ identity?: IdentificationData;
661
+ }
662
+ export interface TicketOrderUpdatedEnvelope {
663
+ data: OrderUpdated;
664
+ metadata: BaseEventMetadata;
665
+ }
666
+ /** @permissionScope Read Events - all read permissions
667
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
668
+ * @permissionScope Manage Events - all permissions
669
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
670
+ * @permissionScope Read Basic Events Order Info
671
+ * @permissionScopeId SCOPE.DC-EVENTS.READ-BASIC-ORDERS
672
+ * @permissionScope Manage Orders
673
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
674
+ * @permissionId WIX_EVENTS.READ_ORDERS
675
+ * @webhook
676
+ * @eventType wix.events.ticketing.events.OrderUpdated
677
+ */
678
+ export declare function onTicketOrderUpdated(handler: (event: TicketOrderUpdatedEnvelope) => void | Promise<void>): void;
679
+ /**
680
+ * Retrieves a list of up to 100 tickets.
681
+ *
682
+ * <!--
683
+ * >**Note:** This function is restricted and only runs if you elevate permissions using the [wix-auth.elevate()](https://www.wix.com/velo/reference/wix-auth/elevate) function.
684
+ * -->
685
+ * @param eventId - Event IDs.
686
+ * @public
687
+ * @requiredField eventId
688
+ * @param options - Options for defining the returned list of tickets.
689
+ * @permissionId WIX_EVENTS.READ_TICKETS
690
+ * @permissionScope Read Events - all read permissions
691
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
692
+ * @permissionScope Manage Events - all permissions
693
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
694
+ * @permissionScope Manage Guest List
695
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
696
+ * @permissionScope Read Event Tickets and Guest List
697
+ * @permissionScopeId SCOPE.DC-EVENTS.READ-GUEST-LIST
698
+ * @applicableIdentity APP
699
+ * @fqn wix.events.ticketing.TicketManagement.ListTickets
700
+ */
701
+ export declare function listTickets(eventId: string[], options?: ListTicketsOptions): Promise<ListTicketsResponse & ListTicketsResponseNonNullableFields>;
702
+ export interface ListTicketsOptions {
703
+ /**
704
+ *
705
+ * Offset. See [Pagination](/wix-events-v2/pagination).
706
+ */
707
+ offset?: number;
708
+ /** Number of items to load per page. See [Pagination](/wix-events-v2/pagination). */
709
+ limit?: number;
710
+ /** Order numbers. */
711
+ orderNumber?: string[];
712
+ /** Ticket numbers. */
713
+ ticketNumber?: string[];
714
+ /** Textual search filter - search is performed on `"orderFullName"`, `"guestFullName"`, and `"ticketNumber"`. */
715
+ searchPhrase?: string;
716
+ /** Order statuses. */
717
+ orderStatus?: OrderStatus[];
718
+ /**
719
+ * Predefined sets of fields to return.
720
+ * - `TICKET_DETAILS`: Returns `ticketNumber`, `orderNumber`, `ticketDefinitionId`, `name`, `price`, `free`, `policy`, `qrCode`, `checkIn`, `orderStatus`, `orderArchived`, `archived`, `orderFullName`, `ticketPdf`, `checkInUrl` and `ticketPdfUrl`.
721
+ * - `GUEST_DETAILS`: Returns `guestDetails`.
722
+ * - `GUEST_FORM`: Returns `guestDetails.form`.
723
+ *
724
+ * Default: If a fieldset is not included in the request, returns only the `memberId` and `anonymized` fields.
725
+ */
726
+ fieldset?: TicketFieldset[];
727
+ /**
728
+ * Ticket states. Possible values:
729
+ * - `ORDER_ARCHIVED`: Returns tickets of the archived orders.
730
+ * - `ORDER_ACTIVE`: Returns tickets of the non-archived orders.
731
+ * - `TICKET_ARCHIVED`: Returns archived tickets.
732
+ * - `TICKET_ACTIVE`: Returns non-archived tickets.
733
+ * - `CHECKED_IN`: Returns checked-in tickets.
734
+ * - `NON_CHECKED_IN`: Returns tickets that are not checked in.
735
+ * - `FREE`: Returns free tickets.
736
+ * - `PAID`: Return paid tickets.
737
+ * - `MEMBER`: Return members' tickets.
738
+ */
739
+ state?: State[];
740
+ /** Site member IDs. */
741
+ memberId?: string[];
742
+ /** Filter facets. */
743
+ facet?: string[];
744
+ /**
745
+ * Sort order.
746
+ *
747
+ * Default: `"ticketNumber"`:`"asc"`.
748
+ */
749
+ sort?: string;
750
+ /** Guest contact IDs. */
751
+ contactId?: string[];
752
+ /** Ticket definition IDs. */
753
+ ticketDefinitionId?: string[];
754
+ /** Seat IDs. */
755
+ seatId?: string[];
756
+ }
757
+ /**
758
+ * Retrieves a ticket by the unique ticket number.
759
+ * @public
760
+ * @requiredField identifiers
761
+ * @requiredField identifiers.eventId
762
+ * @requiredField identifiers.ticketNumber
763
+ * @param identifiers - Details for the ticket to retrieve.
764
+ * @param options - Options for the returned ticket data.
765
+ * @permissionId WIX_EVENTS.READ_TICKET_DETAILS
766
+ * @permissionScope Read Events - all read permissions
767
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
768
+ * @permissionScope Manage Events - all permissions
769
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
770
+ * @permissionScope Manage Guest List
771
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
772
+ * @permissionScope Read Event Tickets and Guest List
773
+ * @permissionScopeId SCOPE.DC-EVENTS.READ-GUEST-LIST
774
+ * @applicableIdentity APP
775
+ * @returns Ticket.
776
+ * @fqn wix.events.ticketing.TicketManagement.GetTicket
777
+ */
778
+ export declare function getTicket(identifiers: GetTicketIdentifiers, options?: GetTicketOptions): Promise<TicketingTicket & TicketingTicketNonNullableFields>;
779
+ export interface GetTicketIdentifiers {
780
+ /** Event ID to which the ticket belongs. */
781
+ eventId: string;
782
+ /** A unique ticket number which is assigned automatically when creating a ticket. */
783
+ ticketNumber: string;
784
+ }
785
+ export interface GetTicketOptions {
786
+ /**
787
+ * Predefined sets of fields to return.
788
+ * - `TICKET_DETAILS`: Returns `ticketNumber`, `orderNumber`, `ticketDefinitionId`, `name`, `price`, `free`, `policy`, `qrCode`, `checkIn`, `orderStatus`, `orderArchived`, `archived`, `orderFullName`, `ticketPdf`, `checkInUrl` and `ticketPdfUrl`.
789
+ * - `GUEST_DETAILS`: Returns `guestDetails`.
790
+ * - `GUEST_FORM`: Returns `guestDetails.form`.
791
+ *
792
+ * Default: If a fieldset is not included in the request, returns only the `memberId` and `anonymized` fields.
793
+ */
794
+ fieldset?: TicketFieldset[];
795
+ }
796
+ /**
797
+ * Checks in 1 or more tickets.
798
+ * @public
799
+ * @requiredField eventId
800
+ * @param eventId - Event ID to which the ticket belongs.
801
+ * @param options - Options for tickets to check-in.
802
+ * @permissionId WIX_EVENTS.CHECK-IN
803
+ * @fqn wix.events.ticketing.TicketManagement.CheckInTicket
804
+ */
805
+ export declare function checkInTickets(eventId: string, options?: CheckInTicketsOptions): Promise<CheckInTicketResponse & CheckInTicketResponseNonNullableFields>;
806
+ export interface CheckInTicketsOptions {
807
+ /** Tickets to check-in. */
808
+ ticketNumber?: string[];
809
+ }
810
+ /**
811
+ * Deletes check-ins for 1 or more tickets.
812
+ * @public
813
+ * @requiredField eventId
814
+ * @param eventId - Event ID to which the ticket belongs.
815
+ * @param options - Options for tickets to delete.
816
+ * @permissionId WIX_EVENTS.CHECK-IN
817
+ * @fqn wix.events.ticketing.TicketManagement.DeleteTicketCheckIn
818
+ */
819
+ export declare function deleteTicketCheckIns(eventId: string, options?: DeleteTicketCheckInsOptions): Promise<DeleteTicketCheckInResponse & DeleteTicketCheckInResponseNonNullableFields>;
820
+ export interface DeleteTicketCheckInsOptions {
821
+ /** Ticket numbers which check-ins to delete. */
822
+ ticketNumber?: string[];
823
+ }
824
+ /**
825
+ * Updates a ticket.
826
+ * @public
827
+ * @requiredField identifiers
828
+ * @requiredField identifiers.eventId
829
+ * @requiredField identifiers.ticketNumber
830
+ * @param identifiers - Details for the ticket to update.
831
+ * @param options - Ticket details to update.
832
+ * @permissionId WIX_EVENTS.MANAGE_TICKETS
833
+ * @permissionScope Manage Events - all permissions
834
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
835
+ * @permissionScope Manage Guest List
836
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
837
+ * @applicableIdentity APP
838
+ * @fqn wix.events.ticketing.TicketManagement.UpdateTicket
839
+ */
840
+ export declare function updateTicket(identifiers: UpdateTicketIdentifiers, options?: UpdateTicketOptions): Promise<UpdateTicketResponse & UpdateTicketResponseNonNullableFields>;
841
+ export interface UpdateTicketIdentifiers {
842
+ /** Event ID to which the ticket belongs. */
843
+ eventId: string;
844
+ /** A unique ticket number which is assigned automatically when creating a ticket. */
845
+ ticketNumber: string;
846
+ }
847
+ export interface UpdateTicketOptions {
848
+ /**
849
+ * Set of field paths, specifying which parts of this resource to update.
850
+ * When `fields` is empty, the request is interpreted as a full update.
851
+ * Behavior follows [google.protobuf.FieldMask](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask) semantics.
852
+ */
853
+ fields?: string[];
854
+ /** Whether to archive the ticket. */
855
+ archived?: boolean;
856
+ /** Assigned guest details. */
857
+ guestDetails?: GuestDetailsUpdate;
858
+ }
859
+ /**
860
+ * Archives multiple tickets.
861
+ * @public
862
+ * @requiredField eventId
863
+ * @param options - Options for updating the tickets.
864
+ * @param eventId - Event ID to which the ticket belongs.
865
+ * @permissionId WIX_EVENTS.MANAGE_TICKETS
866
+ * @permissionScope Manage Events - all permissions
867
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
868
+ * @permissionScope Manage Guest List
869
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
870
+ * @applicableIdentity APP
871
+ * @fqn wix.events.ticketing.TicketManagement.BulkUpdateTickets
872
+ */
873
+ export declare function bulkUpdateTickets(eventId: string, options?: BulkUpdateTicketsOptions): Promise<BulkUpdateTicketsResponse & BulkUpdateTicketsResponseNonNullableFields>;
874
+ export interface BulkUpdateTicketsOptions {
875
+ /** A unique ticket number which is assigned automatically when creating a ticket. */
876
+ ticketNumber?: string[];
877
+ /** Whether tickets are archived. */
878
+ archived?: boolean;
879
+ }
880
+ export {};