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