@wix/events 1.0.146 → 1.0.148

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