@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,3645 @@
1
+ export declare const __debug: {
2
+ verboseLogging: {
3
+ on: () => boolean;
4
+ off: () => boolean;
5
+ };
6
+ };
7
+ export interface Order {
8
+ /** Unique order number. */
9
+ orderNumber?: string;
10
+ /** Reservation ID. */
11
+ reservationId?: string;
12
+ /**
13
+ * Payment snapshot ID.
14
+ * Empty for FREE order.
15
+ * @readonly
16
+ */
17
+ snapshotId?: string;
18
+ /** Event ID. */
19
+ eventId?: string;
20
+ /** Contact ID of buyer (resolved using email address). */
21
+ contactId?: string;
22
+ /** Member ID of buyer (if relevant). */
23
+ memberId?: string;
24
+ /**
25
+ * RSVP created timestamp.
26
+ * @readonly
27
+ */
28
+ created?: Date;
29
+ /** Guest first name. */
30
+ firstName?: string;
31
+ /** Guest last name. */
32
+ lastName?: string;
33
+ /** Guest email. */
34
+ email?: string;
35
+ /** Checkout form response. When each purchased ticket is assigned to a guest, guest forms are returned for each ticket, and buyer info is returned. */
36
+ checkoutForm?: FormResponse;
37
+ /** Whether the order is confirmed (triggered once payment gateway processes the payment and funds reach the merchant's account). */
38
+ confirmed?: boolean;
39
+ /** Order status. */
40
+ status?: OrderStatus;
41
+ /** Payment method used for purchase, e.g., "payPal", "creditCard", etc. */
42
+ method?: string;
43
+ /** Tickets ordered. */
44
+ ticketsQuantity?: number;
45
+ /** Total order price. */
46
+ totalPrice?: Money;
47
+ /** URL to ticket PDF. */
48
+ ticketsPdf?: string;
49
+ /** Tickets (generated after payment). */
50
+ tickets?: TicketingTicket[];
51
+ /** Whether the order is archived. */
52
+ archived?: boolean;
53
+ /** Whether the order is anonymized by GDPR delete. */
54
+ anonymized?: boolean;
55
+ /** Guest full name. */
56
+ fullName?: string;
57
+ /** Order invoice. */
58
+ invoice?: Invoice;
59
+ /** Whether all tickets in order are checked-in. */
60
+ fullyCheckedIn?: boolean;
61
+ /** Internal order payment details */
62
+ paymentDetails?: PaymentDetails;
63
+ /** Checkout channel type */
64
+ channel?: ChannelType;
65
+ }
66
+ export interface FormResponse {
67
+ inputValues?: InputValue[];
68
+ }
69
+ export interface InputValue {
70
+ inputName?: string;
71
+ value?: string;
72
+ values?: string[];
73
+ }
74
+ export interface FormattedAddress {
75
+ /** One line address representation. */
76
+ formatted?: string;
77
+ /** Address components (optional). */
78
+ address?: Address;
79
+ }
80
+ /** Physical address */
81
+ export interface Address extends AddressStreetOneOf {
82
+ /** Street name and number. */
83
+ streetAddress?: StreetAddress;
84
+ /** Main address line, usually street and number as free text. */
85
+ addressLine1?: string | null;
86
+ /** Country code. */
87
+ country?: string | null;
88
+ /** Subdivision. Usually a state, region, prefecture, or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */
89
+ subdivision?: string | null;
90
+ /** City name. */
91
+ city?: string | null;
92
+ /** Zip/postal code. */
93
+ postalCode?: string | null;
94
+ /** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */
95
+ addressLine2?: string | null;
96
+ }
97
+ /** @oneof */
98
+ export interface AddressStreetOneOf {
99
+ /** Street name and number. */
100
+ streetAddress?: StreetAddress;
101
+ /** Main address line, usually street and number as free text. */
102
+ addressLine?: string | null;
103
+ }
104
+ export interface StreetAddress {
105
+ /** Street number. */
106
+ number?: string;
107
+ /** Street name. */
108
+ name?: string;
109
+ }
110
+ export interface AddressLocation {
111
+ /** Address latitude. */
112
+ latitude?: number | null;
113
+ /** Address longitude. */
114
+ longitude?: number | null;
115
+ }
116
+ export interface Subdivision {
117
+ /** Short subdivision code. */
118
+ code?: string;
119
+ /** Subdivision full name. */
120
+ name?: string;
121
+ }
122
+ export declare enum SubdivisionType {
123
+ UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
124
+ /** State */
125
+ ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
126
+ /** County */
127
+ ADMINISTRATIVE_AREA_LEVEL_2 = "ADMINISTRATIVE_AREA_LEVEL_2",
128
+ /** City/town */
129
+ ADMINISTRATIVE_AREA_LEVEL_3 = "ADMINISTRATIVE_AREA_LEVEL_3",
130
+ /** Neighborhood/quarter */
131
+ ADMINISTRATIVE_AREA_LEVEL_4 = "ADMINISTRATIVE_AREA_LEVEL_4",
132
+ /** Street/block */
133
+ ADMINISTRATIVE_AREA_LEVEL_5 = "ADMINISTRATIVE_AREA_LEVEL_5",
134
+ /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
135
+ COUNTRY = "COUNTRY"
136
+ }
137
+ export declare enum OrderStatus {
138
+ /** Order status not available for this request fieldset */
139
+ NA_ORDER_STATUS = "NA_ORDER_STATUS",
140
+ /** Order is confirmed, no payment required */
141
+ FREE = "FREE",
142
+ /** Order was paid but payment gateway suspended the payment. Eventually changes to PAID */
143
+ PENDING = "PENDING",
144
+ /** Order paid via payment gateway */
145
+ PAID = "PAID",
146
+ /** Order confirmed but has to be paid via offline payment and status manually updated to PAID */
147
+ OFFLINE_PENDING = "OFFLINE_PENDING",
148
+ /** Order is awaiting for payment in Cashier */
149
+ INITIATED = "INITIATED",
150
+ /** Order was canceled */
151
+ CANCELED = "CANCELED",
152
+ /** Order payment was declined */
153
+ DECLINED = "DECLINED"
154
+ }
155
+ export interface Money {
156
+ /** *Deprecated:** Use `value` instead. */
157
+ amount?: string;
158
+ /** ISO 4217 format of the currency i.e. `USD`. */
159
+ currency?: string;
160
+ /** 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. */
161
+ value?: string | null;
162
+ }
163
+ export interface TicketingTicket {
164
+ /** Unique ticket number (issued automatically). */
165
+ ticketNumber?: string;
166
+ /** Associated order number. */
167
+ orderNumber?: string;
168
+ /** Ticket definition ID. */
169
+ ticketDefinitionId?: string;
170
+ /** Ticket name. */
171
+ name?: string;
172
+ /** Ticket price. */
173
+ price?: Money;
174
+ /**
175
+ * Whether ticket requires payment.
176
+ * @readonly
177
+ */
178
+ free?: boolean;
179
+ /** Ticket policy (as displayed in PDF). */
180
+ policy?: string;
181
+ /** Deprecated, use `check_in_url`. */
182
+ qrCode?: string;
183
+ /** Ticket check-in. */
184
+ checkIn?: CheckIn;
185
+ /** Associated order status. */
186
+ orderStatus?: OrderStatus;
187
+ /** Whether order and ticket are visible in order list. */
188
+ orderArchived?: boolean;
189
+ /** Buyer full name. */
190
+ orderFullName?: string;
191
+ /** Guest full name. */
192
+ guestFullName?: string | null;
193
+ /** Guest personal details. */
194
+ guestDetails?: GuestDetails;
195
+ /** Whether ticket is visible in guest list. */
196
+ archived?: boolean;
197
+ /** Deprecated, use `ticket_pdf_url`. */
198
+ ticketPdf?: string;
199
+ /** Ticket owner member ID. */
200
+ memberId?: string | null;
201
+ /**
202
+ * Whether ticket was anonymized by GDPR delete.
203
+ * Anonymized tickets no longer contain personally identifiable information (PII).
204
+ */
205
+ anonymized?: boolean;
206
+ /**
207
+ * Ticket check-in URL.
208
+ * Shown as QR code image in PDF.
209
+ * Format: `https://www.wixevents.com/check-in/{ticket number},{event id}`
210
+ * Example: `https://www.wixevents.com/check-in/AAAA-AAAA-BB021,00000000-0000-0000-0000-000000000000`
211
+ */
212
+ checkInUrl?: string;
213
+ /** URL for ticket PDF download. */
214
+ ticketPdfUrl?: string;
215
+ /** Associated order checkout channel type */
216
+ channel?: ChannelType;
217
+ /**
218
+ * URL to download ticket in .pkpass format for Apple Wallet
219
+ * @readonly
220
+ */
221
+ walletPassUrl?: string;
222
+ }
223
+ export interface CheckIn {
224
+ /** Time of check-in */
225
+ created?: Date;
226
+ }
227
+ export interface GuestDetails {
228
+ /** Whether ticket belongs to assigned guest. */
229
+ guestAssigned?: boolean;
230
+ /** Guest first name. */
231
+ firstName?: string | null;
232
+ /** Guest last name. */
233
+ lastName?: string | null;
234
+ /** Guest email. */
235
+ email?: string | null;
236
+ /** Full form response. */
237
+ form?: FormResponse;
238
+ /** Contact ID associated with this guest. */
239
+ contactId?: string | null;
240
+ }
241
+ export declare enum ChannelType {
242
+ /** Buyer created order via one of the online channels (website, mobile app, etc.) */
243
+ ONLINE = "ONLINE",
244
+ /** Order created and money collected by the sales person */
245
+ OFFLINE_POS = "OFFLINE_POS"
246
+ }
247
+ export interface TicketDetails {
248
+ /** Unique seat id in the event venue. */
249
+ seatId?: string | null;
250
+ /**
251
+ * Optional sector label.
252
+ * @readonly
253
+ */
254
+ sectionLabel?: string | null;
255
+ /**
256
+ * Area label.
257
+ * @readonly
258
+ */
259
+ areaLabel?: string | null;
260
+ /**
261
+ * Table label.
262
+ * @readonly
263
+ */
264
+ tableLabel?: string | null;
265
+ /**
266
+ * Row label.
267
+ * @readonly
268
+ */
269
+ rowLabel?: string | null;
270
+ /**
271
+ * Seat label in a row or table.
272
+ * @readonly
273
+ */
274
+ seatLabel?: string | null;
275
+ /** Number of places in the spot. If not provided - defaults to 1. */
276
+ capacity?: number | null;
277
+ /** Custom pricing of ticket. */
278
+ priceOverride?: string | null;
279
+ /** Pricing option id. */
280
+ pricingOptionId?: string | null;
281
+ /**
282
+ * Pricing option name.
283
+ * @readonly
284
+ */
285
+ pricingOptionName?: string | null;
286
+ }
287
+ export interface Invoice {
288
+ /** Items listed in the invoice. */
289
+ items?: Item[];
290
+ /** Total cart amount. */
291
+ total?: Money;
292
+ /** Discount applied to cart. */
293
+ discount?: Discount;
294
+ /** Tax applied to cart. */
295
+ tax?: Tax;
296
+ /** Total cart amount before discount, tax, and fees. */
297
+ subTotal?: Money;
298
+ /**
299
+ * Total amount of cart after discount, tax, and fees.
300
+ * Grand total is calculated in the following order:
301
+ * 1. Total prices of all items in the cart are calculated.
302
+ * 2. Discount is subtracted from the cart (if applicable).
303
+ * 3. Tax is added (if applicable).
304
+ * 4. Wix service fee is added.
305
+ */
306
+ grandTotal?: Money;
307
+ /**
308
+ * Fees applied to the cart.
309
+ * @readonly
310
+ */
311
+ fees?: Fee[];
312
+ /** Total revenue, excluding fees. (Taxes and payment provider fees are not deducted). */
313
+ revenue?: Money;
314
+ /** URL to invoice preview. Returned only if order is paid. */
315
+ previewUrl?: string | null;
316
+ }
317
+ export interface Item {
318
+ /** Unique line item ID. */
319
+ _id?: string;
320
+ /** Line item quantity. */
321
+ quantity?: number;
322
+ /** Line item mame. */
323
+ name?: string;
324
+ /** Line item price. */
325
+ price?: Money;
326
+ /** Total price for line items. Always equal to price * quantity. */
327
+ total?: Money;
328
+ /** Discount applied to the line item. */
329
+ discount?: Discount;
330
+ /** Tax applied to the item. */
331
+ tax?: Tax;
332
+ /**
333
+ * Fees applied to the item.
334
+ * @readonly
335
+ */
336
+ fees?: Fee[];
337
+ }
338
+ export interface Discount {
339
+ /** Total discount amount. */
340
+ amount?: Money;
341
+ /** Total charge after applied discount. */
342
+ afterDiscount?: Money;
343
+ /** Discount coupon code. */
344
+ code?: string;
345
+ /** Discount coupon name. */
346
+ name?: string;
347
+ /** Discount coupon ID. */
348
+ couponId?: string;
349
+ /** Discount items. */
350
+ discounts?: DiscountItem[];
351
+ }
352
+ export interface DiscountItem extends DiscountItemDiscountOneOf {
353
+ /** Coupon discount. */
354
+ coupon?: CouponDiscount;
355
+ /** Pricing plan discount. */
356
+ paidPlan?: PaidPlanDiscount;
357
+ /** Total discount amount. */
358
+ amount?: Money;
359
+ }
360
+ /** @oneof */
361
+ export interface DiscountItemDiscountOneOf {
362
+ /** Coupon discount. */
363
+ coupon?: CouponDiscount;
364
+ /** Pricing plan discount. */
365
+ paidPlan?: PaidPlanDiscount;
366
+ }
367
+ export interface CouponDiscount {
368
+ /** Discount coupon name. */
369
+ name?: string;
370
+ /** Discount coupon code. */
371
+ code?: string;
372
+ /** Discount coupon ID. */
373
+ couponId?: string;
374
+ }
375
+ export interface PaidPlanDiscount extends PaidPlanDiscountDiscountOneOf {
376
+ /** Discount by percentage applied to tickets. */
377
+ percentDiscount?: PercentDiscount;
378
+ /** Name of pricing plan. */
379
+ name?: string;
380
+ }
381
+ /** @oneof */
382
+ export interface PaidPlanDiscountDiscountOneOf {
383
+ /** Discount by percentage applied to tickets. */
384
+ percentDiscount?: PercentDiscount;
385
+ }
386
+ export interface PercentDiscount {
387
+ /** Percent rate. */
388
+ rate?: string;
389
+ /** Number of discounted tickets. */
390
+ quantityDiscounted?: number;
391
+ }
392
+ export interface Tax {
393
+ /** Tax type. */
394
+ type?: TaxType;
395
+ /**
396
+ * Tax name.
397
+ * @readonly
398
+ */
399
+ name?: string;
400
+ /** Tax rate. */
401
+ rate?: string;
402
+ /** Taxable amount. */
403
+ taxable?: Money;
404
+ /** Total tax amount. */
405
+ amount?: Money;
406
+ }
407
+ export declare enum TaxType {
408
+ /** Tax is included in the ticket price */
409
+ INCLUDED = "INCLUDED",
410
+ /** Tax is added to the order at the checkout */
411
+ ADDED = "ADDED",
412
+ /** Tax is added to the final total at the checkout */
413
+ ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
414
+ }
415
+ export interface Fee {
416
+ /** Fee identifier. */
417
+ name?: FeeName;
418
+ /** How fee is calculated. */
419
+ type?: FeeType;
420
+ /**
421
+ * Fee rate.
422
+ * @readonly
423
+ */
424
+ rate?: string;
425
+ /** Total amount of fee charges. */
426
+ amount?: Money;
427
+ }
428
+ export declare enum FeeName {
429
+ /** Wix service fee charges applied to the line item. */
430
+ WIX_FEE = "WIX_FEE"
431
+ }
432
+ export declare enum FeeType {
433
+ /** Fee is added to the ticket price at checkout */
434
+ FEE_ADDED = "FEE_ADDED",
435
+ /** Seller absorbs the fee. It is deducted from the ticket price */
436
+ FEE_INCLUDED = "FEE_INCLUDED",
437
+ /** Fee is added to the ticket price at checkout */
438
+ FEE_ADDED_AT_CHECKOUT = "FEE_ADDED_AT_CHECKOUT"
439
+ }
440
+ export interface PaymentDetails {
441
+ /** Wix Payments transaction */
442
+ transaction?: PaymentTransaction;
443
+ }
444
+ export interface PaymentTransaction {
445
+ /**
446
+ * Wix Payments transaction id
447
+ * @readonly
448
+ */
449
+ transactionId?: string;
450
+ /**
451
+ * Transaction Payment method e.g., "payPal", "creditCard", etc.
452
+ * @readonly
453
+ */
454
+ method?: string;
455
+ }
456
+ export interface OrderDeleted {
457
+ /** Order deleted timestamp in ISO UTC format. */
458
+ timestamp?: Date;
459
+ /** Event ID. */
460
+ eventId?: string;
461
+ /** Unique order number. */
462
+ orderNumber?: string;
463
+ /** Contact ID associated with this order */
464
+ contactId?: string;
465
+ /** Member ID associated with this order. */
466
+ memberId?: string | null;
467
+ /**
468
+ * Order created timestamp.
469
+ * @readonly
470
+ */
471
+ created?: Date;
472
+ /**
473
+ * Order updated timestamp.
474
+ * @readonly
475
+ */
476
+ updated?: Date;
477
+ /** Whether order was anonymized by GDPR delete. */
478
+ anonymized?: boolean;
479
+ /** Order type. */
480
+ orderType?: OrderType;
481
+ /** Whether event was triggered by GDPR delete request. */
482
+ triggeredByAnonymizeRequest?: boolean;
483
+ /** Tickets generated after payment. */
484
+ tickets?: Ticket[];
485
+ }
486
+ export declare enum OrderType {
487
+ /** Buyer form is used for all tickets */
488
+ UNASSIGNED_TICKETS = "UNASSIGNED_TICKETS",
489
+ /** Each order ticket has its own form */
490
+ ASSIGNED_TICKETS = "ASSIGNED_TICKETS"
491
+ }
492
+ export interface Ticket {
493
+ /** Unique issued ticket number. */
494
+ ticketNumber?: string;
495
+ /** Ticket definition ID. */
496
+ ticketDefinitionId?: string;
497
+ /** Ticket check-in. */
498
+ checkIn?: CheckIn;
499
+ /** Ticket price. */
500
+ price?: Money;
501
+ /** Whether ticket is archived. */
502
+ archived?: boolean;
503
+ /** Guest first name. */
504
+ firstName?: string | null;
505
+ /** Guest last name. */
506
+ lastName?: string | null;
507
+ /** Guest email. */
508
+ email?: string | null;
509
+ /** Contact ID associated with this ticket. */
510
+ contactId?: string | null;
511
+ /** Whether ticket is confirmed */
512
+ confirmed?: boolean;
513
+ /** Member ID associated with this ticket. */
514
+ memberId?: string | null;
515
+ /** Ticket form response (only assigned tickets contain separate forms). */
516
+ form?: FormResponse;
517
+ /** Ticket name. */
518
+ ticketName?: string;
519
+ /** Anonymized tickets no longer contain personally identifiable information (PII). */
520
+ anonymized?: boolean;
521
+ /** URL and password to online conference */
522
+ onlineConferencingLogin?: OnlineConferencingLogin;
523
+ }
524
+ export interface OnlineConferencingLogin {
525
+ /**
526
+ * Link URL to the online conference.
527
+ * @readonly
528
+ */
529
+ link?: string;
530
+ /**
531
+ * Password for the online conference.
532
+ * @readonly
533
+ */
534
+ password?: string | null;
535
+ }
536
+ export interface ListOrdersRequest {
537
+ /** Offset. */
538
+ offset?: number;
539
+ /** Limit. */
540
+ limit?: number;
541
+ /**
542
+ * Predefined sets of fields to return.
543
+ * - `TICKETS`: Returns `tickets`.
544
+ * - `DETAILS`: Returns `reservationId`, `snapshotId`, `created`, `firstName`, `lastName`, `confirmed`, `status`, `method`, `ticketsQuantity`, `totalPrice`, `ticketsPdf`, `archived`, `fullName`.
545
+ * - `FORM` : Returns `checkoutForm`.
546
+ * - `INVOICE`: Returns `invoice`.
547
+ *
548
+ * Default: If `fieldset` is omitted from the request, `orderNumber`, `eventId`, `contactId`, `memberId`, `anonymized`, `fullyCheckedIn`.
549
+ *
550
+ */
551
+ fieldset?: OrderFieldset[];
552
+ /** Status. */
553
+ status?: OrderStatus[];
554
+ /** Event ID. */
555
+ eventId?: string[];
556
+ /** Order number. */
557
+ orderNumber?: string[];
558
+ /** Site member ID. */
559
+ memberId?: string[];
560
+ /** Field facets, */
561
+ facet?: string[];
562
+ /** Textual search filter - search is performed on `"full_name"`, `"email"` and `"order_number"`. */
563
+ searchPhrase?: string;
564
+ /** Event creator ID. */
565
+ eventCreatorId?: string[];
566
+ /**
567
+ * Sort order. Defaults to "created:asc".
568
+ * See [supported fields](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-orders).
569
+ */
570
+ sort?: string;
571
+ /** Order tag. */
572
+ tag?: OrderTag[];
573
+ }
574
+ export declare enum OrderFieldset {
575
+ /** Include tickets in response */
576
+ TICKETS = "TICKETS",
577
+ /** Include order details: status, first_name, last_name, email, created, etc. */
578
+ DETAILS = "DETAILS",
579
+ /** Include checkout_form */
580
+ FORM = "FORM",
581
+ /** Include invoice */
582
+ INVOICE = "INVOICE"
583
+ }
584
+ export declare enum OrderTag {
585
+ /** Return only confirmed orders */
586
+ CONFIRMED = "CONFIRMED",
587
+ /** Return only unconfirmed orders */
588
+ UNCONFIRMED = "UNCONFIRMED",
589
+ /** Return only member orders */
590
+ MEMBER = "MEMBER",
591
+ /** Return only archived orders */
592
+ ARCHIVED = "ARCHIVED",
593
+ /** Return only non archived orders */
594
+ NON_ARCHIVED = "NON_ARCHIVED",
595
+ /** Return only orders with all guests checked-in */
596
+ FULLY_CHECKED_IN = "FULLY_CHECKED_IN",
597
+ /** Return only orders with no guests checked-in */
598
+ NOT_FULLY_CHECKED_IN = "NOT_FULLY_CHECKED_IN"
599
+ }
600
+ export interface ListOrdersResponse {
601
+ /** Total orders matching the given filters. */
602
+ total?: number;
603
+ /** Offset. */
604
+ offset?: number;
605
+ /** Limit. */
606
+ limit?: number;
607
+ /** Orders. */
608
+ orders?: Order[];
609
+ /** Filter facets. */
610
+ facets?: Record<string, FacetCounts>;
611
+ /** Order data enriched facets. */
612
+ orderFacets?: OrderFacets;
613
+ }
614
+ export interface FacetCounts {
615
+ /** Facet counts aggregated per value */
616
+ counts?: Record<string, number>;
617
+ }
618
+ export interface OrderFacets {
619
+ /** Filter facets. */
620
+ facets?: Record<string, OrderFacetCounts>;
621
+ }
622
+ export interface OrderFacetCounts {
623
+ /** Facet counts aggregated per value */
624
+ counts?: Record<string, Counts>;
625
+ }
626
+ export interface Counts {
627
+ /** Number or orders */
628
+ count?: number;
629
+ /** Number of tickets within orders */
630
+ tickets?: number;
631
+ /** Number of tickets with check-in */
632
+ ticketsCheckIn?: number;
633
+ }
634
+ export interface GetOrderRequest {
635
+ /** Event ID. */
636
+ eventId: string;
637
+ /** Unique order number. */
638
+ orderNumber: string;
639
+ /**
640
+ * Predefined sets of fields to return.
641
+ * - `TICKETS`: Returns `tickets`.
642
+ * - `DETAILS`: Returns `reservationId`, `snapshotId`, `created`, `firstName`, `lastName`, `confirmed`, `status`, `method`, `ticketsQuantity`, `totalPrice`, `ticketsPdf`, `archived`, `fullName`.
643
+ * - `FORM` : Returns `checkoutForm`.
644
+ * - `INVOICE`: Returns `invoice`.
645
+ *
646
+ * Default: If `fieldset` is omitted from the request, `orderNumber`, `eventId`, `contactId`, `memberId`, `anonymized`, `fullyCheckedIn`.
647
+ */
648
+ fieldset?: OrderFieldset[];
649
+ }
650
+ export interface GetOrderResponse {
651
+ /** Requested order. */
652
+ order?: Order;
653
+ /** "Add to calendar" links. */
654
+ calendarLinks?: CalendarLinks;
655
+ }
656
+ export interface CalendarLinks {
657
+ /** "Add to Google calendar" URL. */
658
+ google?: string;
659
+ /** "Download ICS calendar file" URL. */
660
+ ics?: string;
661
+ }
662
+ export interface UpdateOrderRequest {
663
+ /** Event ID. */
664
+ eventId: string;
665
+ /** Unique order number. */
666
+ orderNumber: string;
667
+ /** Checkout form. */
668
+ checkoutForm?: FormResponse;
669
+ /** Whether order is archived. */
670
+ archived?: boolean;
671
+ }
672
+ export interface UpdateOrderResponse {
673
+ /** Updated order. */
674
+ order?: Order;
675
+ }
676
+ export interface OrderUpdated {
677
+ /** Order updated timestamp in ISO UTC format. */
678
+ timestamp?: Date;
679
+ /** Site language when Order initiated */
680
+ language?: string | null;
681
+ /** Locale in which Order was created. */
682
+ locale?: string | null;
683
+ /** Event ID. */
684
+ eventId?: string;
685
+ /** Unique order number. */
686
+ orderNumber?: string;
687
+ /** Contact ID associated with this order. */
688
+ contactId?: string;
689
+ /** Member ID associated with this order. */
690
+ memberId?: string | null;
691
+ /**
692
+ * Order created timestamp.
693
+ * @readonly
694
+ */
695
+ created?: Date;
696
+ /**
697
+ * Order updated timestamp.
698
+ * @readonly
699
+ */
700
+ updated?: Date;
701
+ /** Buyer first name. */
702
+ firstName?: string;
703
+ /** Buyer last name. */
704
+ lastName?: string;
705
+ /** Buyer email. */
706
+ email?: string;
707
+ /** Checkout form response. */
708
+ checkoutForm?: FormResponse;
709
+ /** Whether order is confirmed - occurs once payment gateway processes the payment and funds reach merchant's account. */
710
+ confirmed?: boolean;
711
+ /** Order status. */
712
+ status?: OrderStatus;
713
+ /** Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc. */
714
+ method?: string | null;
715
+ /** Tickets generated after payment. */
716
+ tickets?: Ticket[];
717
+ /** Whether order was archived and excluded from results. */
718
+ archived?: boolean;
719
+ /** Whether event was triggered by GDPR delete request. */
720
+ triggeredByAnonymizeRequest?: boolean;
721
+ }
722
+ export interface BulkUpdateOrdersRequest {
723
+ /** Event ID. */
724
+ eventId: string;
725
+ orderNumber?: string[];
726
+ /** Whether to archive the order. */
727
+ archived?: boolean;
728
+ }
729
+ export interface BulkUpdateOrdersResponse {
730
+ /** Updated orders. */
731
+ orders?: Order[];
732
+ }
733
+ export interface ConfirmOrderRequest {
734
+ /** Event ID. */
735
+ eventId: string;
736
+ /** Order numbers. */
737
+ orderNumber?: string[];
738
+ }
739
+ export interface ConfirmOrderResponse {
740
+ /** Confirmed orders. */
741
+ orders?: Order[];
742
+ }
743
+ export interface GetSummaryRequest {
744
+ /** Event ID. */
745
+ eventId?: string | null;
746
+ }
747
+ export interface GetSummaryResponse {
748
+ /** Ticket sales grouped by currency. */
749
+ sales?: TicketSales[];
750
+ }
751
+ export interface TicketSales {
752
+ /** Total balance of confirmed transactions. */
753
+ total?: Money;
754
+ /** Total number of confirmed orders. */
755
+ totalOrders?: number;
756
+ /** Total number of tickets purchased. */
757
+ totalTickets?: number;
758
+ /** Total revenue, excluding fees (taxes and payment provider fees are not deducted). */
759
+ revenue?: Money;
760
+ }
761
+ export interface GetInvoicePreviewRequest {
762
+ /** Event ID. */
763
+ eventId?: string;
764
+ /** Order number. */
765
+ orderNumber?: string;
766
+ }
767
+ export interface RawHttpResponse {
768
+ body?: Uint8Array;
769
+ statusCode?: number | null;
770
+ headers?: HeadersEntry[];
771
+ }
772
+ export interface HeadersEntry {
773
+ key?: string;
774
+ value?: string;
775
+ }
776
+ export interface GetPaymentInfoRequest {
777
+ /** Event ID. */
778
+ eventId?: string;
779
+ /** Order number. */
780
+ orderNumber?: string;
781
+ }
782
+ export interface GetPaymentInfoResponse {
783
+ transactions?: PaymentTransactionSummary[];
784
+ status?: string | null;
785
+ /** @readonly */
786
+ transactionId?: string | null;
787
+ }
788
+ export interface PaymentTransactionSummary {
789
+ /**
790
+ * Wix Payments transaction id
791
+ * @readonly
792
+ */
793
+ transactionId?: string;
794
+ /**
795
+ * Final transaction status
796
+ * @readonly
797
+ */
798
+ finalTransactionStatus?: string;
799
+ /** Transaction events */
800
+ events?: PaymentTransactionEvent[];
801
+ }
802
+ export interface PaymentTransactionEvent {
803
+ /**
804
+ * Order snapshot id
805
+ * @readonly
806
+ */
807
+ snapshotId?: string;
808
+ /**
809
+ * Transaction status
810
+ * @readonly
811
+ */
812
+ transactionStatus?: string;
813
+ /**
814
+ * Transaction Payment method e.g., "payPal", "creditCard", etc.
815
+ * @readonly
816
+ */
817
+ paymentMethod?: string;
818
+ /**
819
+ * Transaction payment amount
820
+ * @readonly
821
+ */
822
+ paymentAmount?: Money;
823
+ /**
824
+ * Crated date
825
+ * @readonly
826
+ */
827
+ _createdDate?: Date;
828
+ /**
829
+ * Reason code
830
+ * @readonly
831
+ */
832
+ reasonCode?: string | null;
833
+ /**
834
+ * Refunded amount
835
+ * @readonly
836
+ */
837
+ refundedAmount?: Money;
838
+ }
839
+ export interface OrderConfirmed {
840
+ /** Order confirmation timestamp in ISO UTC. */
841
+ timestamp?: Date;
842
+ /** Site language when Order initiated */
843
+ language?: string | null;
844
+ /** Notifications silenced for this domain event. */
845
+ silent?: boolean | null;
846
+ /** Locale in which Order was created. */
847
+ locale?: string | null;
848
+ /** Event ID. */
849
+ eventId?: string;
850
+ /** Unique order number. */
851
+ orderNumber?: string;
852
+ /** Contact ID associated with this order. */
853
+ contactId?: string;
854
+ /** Member ID associated with this order. */
855
+ memberId?: string | null;
856
+ /**
857
+ * Order created timestamp
858
+ * @readonly
859
+ */
860
+ created?: Date;
861
+ /** Buyer first name. */
862
+ firstName?: string;
863
+ /** Buyer last name. */
864
+ lastName?: string;
865
+ /** Buyer email address. */
866
+ email?: string;
867
+ /** Checkout form response. */
868
+ checkoutForm?: FormResponse;
869
+ /** Order status. */
870
+ status?: OrderStatus;
871
+ /** Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc. */
872
+ method?: string | null;
873
+ /** Tickets (generated after payment). */
874
+ tickets?: Ticket[];
875
+ /** Invoice. */
876
+ invoice?: Invoice;
877
+ /** Reservation ID associated with this order. */
878
+ reservationId?: string;
879
+ }
880
+ export interface OrderPaid {
881
+ /** Order paid timestamp in ISO UTC. */
882
+ timestamp?: Date;
883
+ /** Event ID. */
884
+ eventId?: string;
885
+ /** Unique order number. */
886
+ orderNumber?: string;
887
+ /** Reservation ID associated with this order. */
888
+ reservationId?: string;
889
+ }
890
+ export interface ReservationCreated {
891
+ /** Reservation created timestamp in ISO UTC format. */
892
+ timestamp?: Date;
893
+ /** Event ID. */
894
+ eventId?: string;
895
+ /**
896
+ * Reservation ID.
897
+ * Can be used to retrieve a reservation invoice.
898
+ */
899
+ reservationId?: string;
900
+ /** Reservation expiration timestamp. */
901
+ expires?: Date;
902
+ /** Reservation status. */
903
+ status?: ReservationStatus;
904
+ /** Reservation ticket quantities. */
905
+ quantities?: TicketQuantity[];
906
+ /** Reservation update timestamp. */
907
+ _updatedDate?: Date;
908
+ /** Reservation counts. */
909
+ counts?: ReservationCount[];
910
+ }
911
+ export declare enum ReservationStatus {
912
+ /**
913
+ * Reservation is pending confirmation.
914
+ * The reservation will expire after the expiration due time.
915
+ */
916
+ RESERVATION_PENDING = "RESERVATION_PENDING",
917
+ /** The reservation was confirmed and will not expire. */
918
+ RESERVATION_CONFIRMED = "RESERVATION_CONFIRMED",
919
+ /** The reservation was canceled because of non payment. */
920
+ RESERVATION_CANCELED = "RESERVATION_CANCELED",
921
+ /** The reservation was canceled manually by the buyer. */
922
+ RESERVATION_CANCELED_MANUALLY = "RESERVATION_CANCELED_MANUALLY",
923
+ /** The reservation has expired. */
924
+ RESERVATION_EXPIRED = "RESERVATION_EXPIRED"
925
+ }
926
+ export interface TicketQuantity {
927
+ /** Ticket definition ID. */
928
+ ticketDefinitionId?: string | null;
929
+ /** Quantity. */
930
+ quantity?: number | null;
931
+ /** Quantity update timestamp. */
932
+ _updatedDate?: Date;
933
+ }
934
+ export interface ReservationCount {
935
+ /** Reservation Count snapshot timestamp. */
936
+ timestamp?: Date;
937
+ /** Ticket Definition ID. */
938
+ ticketDefinitionId?: string;
939
+ /** Confirmed reservation count. */
940
+ confirmedCount?: number;
941
+ /** Pending reservation count. */
942
+ pendingCount?: number;
943
+ /** True if paid ticket reservation exist. */
944
+ paidExists?: boolean;
945
+ }
946
+ export interface ReservationUpdated {
947
+ /** Reservation updated timestamp. */
948
+ timestamp?: Date;
949
+ /** Event ID. */
950
+ eventId?: string;
951
+ /**
952
+ * Reservation ID.
953
+ * Can be used to retrieve a reservation invoice.
954
+ */
955
+ reservationId?: string;
956
+ /** Reservation status. */
957
+ status?: ReservationStatus;
958
+ /** Reservation expiration timestamp. */
959
+ expires?: Date;
960
+ /** Reservation ticket quantities. */
961
+ quantities?: TicketQuantity[];
962
+ /** Reservation update timestamp. */
963
+ _updatedDate?: Date;
964
+ /** Reservation counts. */
965
+ counts?: ReservationCount[];
966
+ }
967
+ export interface GetCheckoutOptionsRequest {
968
+ }
969
+ export interface GetCheckoutOptionsResponse {
970
+ /** Whether any payment method is configured and available for payment. */
971
+ paymentMethodConfigured?: boolean;
972
+ /** Whether coupons are accepted at checkout. */
973
+ acceptCoupons?: boolean;
974
+ /** Whether premium services are enabled. Enabled for free if site does not sell any paid tickets. Selling tickets for a fee requires a premium feature "events_sell_tickets". */
975
+ premiumServices?: boolean;
976
+ /** Whether there are any paid tickets available for sale. */
977
+ paidTickets?: boolean;
978
+ }
979
+ export interface ListAvailableTicketsRequest {
980
+ /** Event ID. If not provided, available tickets for all events in the site will be returned. */
981
+ eventId?: string;
982
+ /** Offset. */
983
+ offset?: number;
984
+ /** Limit. */
985
+ limit?: number;
986
+ /**
987
+ * Sort order, defaults to "created:asc".
988
+ * See [supported fields](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-available-tickets).
989
+ */
990
+ sort?: string;
991
+ state?: State[];
992
+ }
993
+ export declare enum State {
994
+ INCLUDE_HIDDEN_NOT_ON_SALE = "INCLUDE_HIDDEN_NOT_ON_SALE"
995
+ }
996
+ export interface ListAvailableTicketsResponse {
997
+ /** Ticket definitions meta data. */
998
+ metaData?: ResponseMetaData;
999
+ /** Ticket definitions. */
1000
+ definitions?: TicketDefinition[];
1001
+ }
1002
+ export interface ResponseMetaData {
1003
+ /** Number of items in the response. */
1004
+ count?: number;
1005
+ /** Offset of items. */
1006
+ offset?: number;
1007
+ /** Total number of matching items. */
1008
+ total?: number;
1009
+ }
1010
+ export interface TicketDefinition {
1011
+ /** Ticket definition ID. */
1012
+ _id?: string;
1013
+ /** Ticket price. */
1014
+ price?: Money;
1015
+ /** Whether the ticket is free (read only). */
1016
+ free?: boolean;
1017
+ /** Ticket name. */
1018
+ name?: string;
1019
+ /** Ticket description. */
1020
+ description?: string;
1021
+ /**
1022
+ * Limit of tickets that can be purchased per checkout.
1023
+ * Set to 20 for unlimited ticket definition.
1024
+ */
1025
+ limitPerCheckout?: number;
1026
+ /** Custom sort index. */
1027
+ orderIndex?: number;
1028
+ /** Policy information plain text block, as printed on the ticket. */
1029
+ policy?: string;
1030
+ /** Sensitive dashboard data. */
1031
+ dashboard?: Dashboard;
1032
+ /** Event ID associated with the ticket. */
1033
+ eventId?: string;
1034
+ /**
1035
+ * Configuration of the fixed-rate Wix service fee that is applied at checkout to each ticket sold.
1036
+ * @readonly
1037
+ */
1038
+ wixFeeConfig?: WixFeeConfig;
1039
+ /** Ticket sale period. */
1040
+ salePeriod?: TicketSalePeriod;
1041
+ /**
1042
+ * Ticket sale status.
1043
+ * @readonly
1044
+ */
1045
+ saleStatus?: TicketSaleStatus;
1046
+ /** Ticket state. */
1047
+ state?: State[];
1048
+ /** Ticket pricing. */
1049
+ pricing?: TicketPricing;
1050
+ }
1051
+ export interface Dashboard {
1052
+ /** Whether ticket is hidden and cannot be sold. */
1053
+ hidden?: boolean;
1054
+ /** Number of tickets sold and reserved. */
1055
+ sold?: number;
1056
+ /** Whether the ticket has limited quantity. */
1057
+ limited?: boolean;
1058
+ /** Ticket limit. `NULL` for unlimited ticket definitions. */
1059
+ quantity?: number | null;
1060
+ /** Number of unsold tickets. `NULL` for unlimited ticket definitions. */
1061
+ unsold?: number | null;
1062
+ /** Number of tickets sold. */
1063
+ ticketsSold?: number;
1064
+ /** Number of tickets reserved. */
1065
+ ticketsReserved?: number;
1066
+ }
1067
+ export interface WixFeeConfig {
1068
+ /** Fee calculation method. */
1069
+ type?: FeeType;
1070
+ }
1071
+ export interface TicketSalePeriod {
1072
+ /** Ticket sale start timestamp. */
1073
+ startDate?: Date;
1074
+ /** Ticket sale end timestamp. */
1075
+ endDate?: Date;
1076
+ /** Whether to hide this ticket if it's not on sale */
1077
+ hideNotOnSale?: boolean;
1078
+ }
1079
+ export declare enum TicketSaleStatus {
1080
+ /** Ticket sale is scheduled to start */
1081
+ SALE_SCHEDULED = "SALE_SCHEDULED",
1082
+ /** Ticket sale has started */
1083
+ SALE_STARTED = "SALE_STARTED",
1084
+ /** Ticket sale has ended */
1085
+ SALE_ENDED = "SALE_ENDED"
1086
+ }
1087
+ export interface TicketPricing extends TicketPricingPriceOneOf {
1088
+ /** Ticket price which is read only. */
1089
+ fixedPrice?: Money;
1090
+ /** Min price per ticket, customizable. */
1091
+ minPrice?: Money;
1092
+ /** Ticket pricing options. */
1093
+ pricingOptions?: PricingOptions;
1094
+ /**
1095
+ * Ticket pricing type.
1096
+ * @readonly
1097
+ */
1098
+ pricingType?: Type;
1099
+ }
1100
+ /** @oneof */
1101
+ export interface TicketPricingPriceOneOf {
1102
+ /** Ticket price which is read only. */
1103
+ fixedPrice?: Money;
1104
+ /** Min price per ticket, customizable. */
1105
+ minPrice?: Money;
1106
+ /** Ticket pricing options. */
1107
+ pricingOptions?: PricingOptions;
1108
+ }
1109
+ export interface PricingOptions {
1110
+ /** Multiple ticket pricing options. */
1111
+ options?: PricingOption[];
1112
+ }
1113
+ export interface PricingOption {
1114
+ /** Ticket pricing option ID. */
1115
+ _id?: string | null;
1116
+ /** Ticket pricing option name. */
1117
+ name?: string | null;
1118
+ /** Ticket pricing option price. */
1119
+ price?: Money;
1120
+ }
1121
+ export declare enum Type {
1122
+ STANDARD = "STANDARD",
1123
+ DONATION = "DONATION"
1124
+ }
1125
+ export interface QueryAvailableTicketsRequest {
1126
+ /** Offset. */
1127
+ offset?: number;
1128
+ /** Limit. */
1129
+ limit?: number;
1130
+ /** Ticket definition. */
1131
+ filter?: Record<string, any> | null;
1132
+ fieldset?: TicketDefinitionFieldset[];
1133
+ /** Sort order, defaults to "created:asc". */
1134
+ sort?: string;
1135
+ }
1136
+ export declare enum TicketDefinitionFieldset {
1137
+ /** Include policy in the response. */
1138
+ POLICY = "POLICY",
1139
+ /** Include dashboard in the response. */
1140
+ DASHBOARD = "DASHBOARD"
1141
+ }
1142
+ export interface QueryAvailableTicketsResponse {
1143
+ /** Ticket definitions meta data. */
1144
+ metaData?: ResponseMetaData;
1145
+ /** Ticket definitions. */
1146
+ definitions?: TicketDefinition[];
1147
+ }
1148
+ export interface CreateReservationRequest {
1149
+ /** Event ID. */
1150
+ eventId: string;
1151
+ /** Tickets to reserve. */
1152
+ ticketQuantities?: TicketReservationQuantity[];
1153
+ /** Whether to ignore the available ticket limits upon reservation. */
1154
+ ignoreLimits?: boolean;
1155
+ /** Whether to allow reservation for hidden tickets. */
1156
+ allowHiddenTickets?: boolean;
1157
+ }
1158
+ export interface TicketReservationQuantity {
1159
+ /** Ticket definition ID. */
1160
+ ticketDefinitionId?: string;
1161
+ /** Quantity of tickets to reserve. */
1162
+ quantity?: number;
1163
+ /** Ticket price to charge - overriding the ticket price. */
1164
+ priceOverride?: string | null;
1165
+ /** Optional ticket details */
1166
+ ticketDetails?: TicketDetails[];
1167
+ }
1168
+ export interface CreateReservationResponse {
1169
+ /** Reservation ID. */
1170
+ _id?: string;
1171
+ /** Reservation expiration timestamp. */
1172
+ expires?: Date;
1173
+ /** Ticket reservations. */
1174
+ reservations?: TicketReservation[];
1175
+ /** Reservation invoice. */
1176
+ invoice?: Invoice;
1177
+ }
1178
+ export interface TicketReservation {
1179
+ /** Quantity of reserved tickets. */
1180
+ quantity?: number;
1181
+ /** An object containing ticket information. */
1182
+ ticket?: TicketDefinition;
1183
+ /** Optional ticket details. */
1184
+ ticketDetails?: TicketDetails[];
1185
+ }
1186
+ export interface CancelReservationRequest {
1187
+ /** Event ID. */
1188
+ eventId: string;
1189
+ /** Reservation ID. */
1190
+ _id: string;
1191
+ }
1192
+ export interface CancelReservationResponse {
1193
+ }
1194
+ export interface GetInvoiceRequest {
1195
+ /** Event ID. */
1196
+ eventId: string;
1197
+ /** Reservation ID. */
1198
+ reservationId: string;
1199
+ /** Optional discount to be applied on the returned invoice. */
1200
+ withDiscount?: DiscountRequest;
1201
+ /** Optional benefit granted by the pricing plan to be applied on the returned invoice. */
1202
+ paidPlanBenefit?: PaidPlanBenefit;
1203
+ }
1204
+ export interface DiscountRequest {
1205
+ /** Discount coupon code. */
1206
+ couponCode?: string;
1207
+ }
1208
+ export interface PaidPlanBenefit {
1209
+ /** Pricing plan ID. */
1210
+ planOrderId?: string;
1211
+ /** Pricing plan benefit ID. */
1212
+ benefitId?: string;
1213
+ }
1214
+ export interface GetInvoiceResponse {
1215
+ /** Invoice with applied discount. */
1216
+ invoice?: Invoice;
1217
+ /** Discount errors, if relevant. */
1218
+ discountErrors?: DiscountErrors;
1219
+ /** Time when the reservation expires. */
1220
+ expires?: Date;
1221
+ /** Reservation status. */
1222
+ reservationStatus?: ReservationStatus;
1223
+ /** Whether this reservation is already used in checkout. */
1224
+ reservationOccupied?: boolean;
1225
+ /** Ticket reservations. */
1226
+ reservations?: TicketReservation[];
1227
+ }
1228
+ export interface DiscountErrors {
1229
+ /** Object containing error information. */
1230
+ error?: Error[];
1231
+ }
1232
+ export interface Error {
1233
+ /** A code identifying the error type. */
1234
+ code?: string;
1235
+ }
1236
+ export interface CheckoutRequest {
1237
+ /** Event ID. */
1238
+ eventId: string;
1239
+ /** Ticket reservation ID. */
1240
+ reservationId?: string;
1241
+ /** Member ID (if empty - no site member is associated to this order). */
1242
+ memberId?: string;
1243
+ /** Discount to apply on the invoice. */
1244
+ discount?: DiscountRequest;
1245
+ /** Buyer details. */
1246
+ buyer?: Buyer;
1247
+ /** Guest details. */
1248
+ guests?: Guest[];
1249
+ /** Benefit granted by the pricing plan. */
1250
+ paidPlanBenefit?: PaidPlanBenefit;
1251
+ /** Options controlling the checkout process. */
1252
+ options?: CheckoutOptions;
1253
+ }
1254
+ export interface Buyer {
1255
+ /** Buyer first name. */
1256
+ firstName?: string;
1257
+ /** Buyer last name. */
1258
+ lastName?: string;
1259
+ /** Buyer email. */
1260
+ email?: string;
1261
+ }
1262
+ export interface Guest {
1263
+ /** Specific guest info. */
1264
+ form?: FormResponse;
1265
+ }
1266
+ export interface CheckoutOptions {
1267
+ /** Whether to ignore settings to notify contacts or users. */
1268
+ silent?: boolean;
1269
+ /** Whether the payment is to be done in person between the buyer and the merchant. When true, the completed order is created with status OFFLINE_PENDING and inPerson payment method. */
1270
+ payInPerson?: boolean;
1271
+ /** Whether to ignore form validation. */
1272
+ ignoreFormValidation?: boolean;
1273
+ /** Marks payment as already paid */
1274
+ markAsPaid?: boolean | null;
1275
+ }
1276
+ export interface CheckoutResponse {
1277
+ /** Created order. */
1278
+ order?: Order;
1279
+ /** Time when the order expires, applies to orders with status = INITIATED. */
1280
+ expires?: Date;
1281
+ /** Ticket reservations. */
1282
+ reservations?: TicketReservation[];
1283
+ /** Order page url. */
1284
+ orderPageUrl?: string | null;
1285
+ }
1286
+ export interface OrderInitiated {
1287
+ /** Order initiated timestamp in ISO UTC format. */
1288
+ timestamp?: Date;
1289
+ /** Site language when Order initiated */
1290
+ language?: string | null;
1291
+ /** Locale in which Order was created. */
1292
+ locale?: string | null;
1293
+ /** Event ID. */
1294
+ eventId?: string;
1295
+ /** Unique order number. */
1296
+ orderNumber?: string;
1297
+ /** Contact ID associated with this order. */
1298
+ contactId?: string;
1299
+ /** Member ID associated with this order. */
1300
+ memberId?: string | null;
1301
+ /**
1302
+ * Order created timestamp.
1303
+ * @readonly
1304
+ */
1305
+ created?: Date;
1306
+ /**
1307
+ * Order updated timestamp.
1308
+ * @readonly
1309
+ */
1310
+ updated?: Date;
1311
+ /** Guest first name. */
1312
+ firstName?: string;
1313
+ /** Guest last name. */
1314
+ lastName?: string;
1315
+ /** Guest email address. */
1316
+ email?: string;
1317
+ /** Checkout form response. */
1318
+ checkoutForm?: FormResponse;
1319
+ /** Order status. */
1320
+ status?: OrderStatus;
1321
+ /** Invoice. */
1322
+ invoice?: Invoice;
1323
+ /** Reservation ID associated with this order. */
1324
+ reservationId?: string;
1325
+ /** Order was marked as paid. */
1326
+ markedAsPaid?: boolean | null;
1327
+ }
1328
+ export interface UpdateCheckoutRequest {
1329
+ /** Event ID. */
1330
+ eventId: string;
1331
+ /** Unique order number. */
1332
+ orderNumber: string;
1333
+ /** Buyer details. */
1334
+ buyer?: Buyer;
1335
+ /** Guest details. */
1336
+ guests?: Guest[];
1337
+ /** Member ID (if empty - no site member is associated to this order). */
1338
+ memberId?: string | null;
1339
+ /** Discount to apply on the invoice. */
1340
+ discount?: DiscountRequest;
1341
+ /** Benefit granted by the pricing plan. */
1342
+ paidPlanBenefit?: PaidPlanBenefit;
1343
+ }
1344
+ export interface UpdateCheckoutResponse {
1345
+ /** Updated order. */
1346
+ order?: Order;
1347
+ /** Order page url. */
1348
+ orderPageUrl?: string | null;
1349
+ }
1350
+ export interface PosCheckoutRequest {
1351
+ /** Event ID. */
1352
+ eventId?: string;
1353
+ /** Ticket reservation ID. */
1354
+ reservationId?: string;
1355
+ /**
1356
+ * Payment details ID.
1357
+ * Not required if reservation total is 0. In this case the order will be created with status Free and no payment.
1358
+ */
1359
+ paymentDetailsId?: string | null;
1360
+ }
1361
+ export interface PosCheckoutResponse {
1362
+ /** Created order. */
1363
+ order?: Order;
1364
+ /** Time when the order expires, applies to orders with status = INITIATED. */
1365
+ expires?: Date;
1366
+ /** Ticket reservations. */
1367
+ reservations?: TicketReservation[];
1368
+ }
1369
+ export interface ListOrdersResponseNonNullableFields {
1370
+ total: number;
1371
+ offset: number;
1372
+ limit: number;
1373
+ orders: {
1374
+ orderNumber: string;
1375
+ reservationId: string;
1376
+ snapshotId: string;
1377
+ eventId: string;
1378
+ contactId: string;
1379
+ memberId: string;
1380
+ firstName: string;
1381
+ lastName: string;
1382
+ email: string;
1383
+ checkoutForm?: {
1384
+ inputValues: {
1385
+ inputName: string;
1386
+ value: string;
1387
+ values: string[];
1388
+ }[];
1389
+ };
1390
+ confirmed: boolean;
1391
+ status: OrderStatus;
1392
+ method: string;
1393
+ ticketsQuantity: number;
1394
+ totalPrice?: {
1395
+ amount: string;
1396
+ currency: string;
1397
+ };
1398
+ ticketsPdf: string;
1399
+ tickets: {
1400
+ ticketNumber: string;
1401
+ orderNumber: string;
1402
+ ticketDefinitionId: string;
1403
+ name: string;
1404
+ price?: {
1405
+ amount: string;
1406
+ currency: string;
1407
+ };
1408
+ free: boolean;
1409
+ policy: string;
1410
+ qrCode: string;
1411
+ orderStatus: OrderStatus;
1412
+ orderArchived: boolean;
1413
+ orderFullName: string;
1414
+ guestDetails?: {
1415
+ guestAssigned: boolean;
1416
+ form?: {
1417
+ inputValues: {
1418
+ inputName: string;
1419
+ value: string;
1420
+ values: string[];
1421
+ }[];
1422
+ };
1423
+ };
1424
+ archived: boolean;
1425
+ ticketPdf: string;
1426
+ anonymized: boolean;
1427
+ checkInUrl: string;
1428
+ ticketPdfUrl: string;
1429
+ channel: ChannelType;
1430
+ walletPassUrl: string;
1431
+ }[];
1432
+ archived: boolean;
1433
+ anonymized: boolean;
1434
+ fullName: string;
1435
+ invoice?: {
1436
+ items: {
1437
+ _id: string;
1438
+ quantity: number;
1439
+ name: string;
1440
+ price?: {
1441
+ amount: string;
1442
+ currency: string;
1443
+ };
1444
+ total?: {
1445
+ amount: string;
1446
+ currency: string;
1447
+ };
1448
+ discount?: {
1449
+ amount?: {
1450
+ amount: string;
1451
+ currency: string;
1452
+ };
1453
+ afterDiscount?: {
1454
+ amount: string;
1455
+ currency: string;
1456
+ };
1457
+ code: string;
1458
+ name: string;
1459
+ couponId: string;
1460
+ discounts: {
1461
+ coupon?: {
1462
+ name: string;
1463
+ code: string;
1464
+ couponId: string;
1465
+ };
1466
+ paidPlan?: {
1467
+ percentDiscount?: {
1468
+ rate: string;
1469
+ quantityDiscounted: number;
1470
+ };
1471
+ name: string;
1472
+ };
1473
+ amount?: {
1474
+ amount: string;
1475
+ currency: string;
1476
+ };
1477
+ }[];
1478
+ };
1479
+ tax?: {
1480
+ type: TaxType;
1481
+ name: string;
1482
+ rate: string;
1483
+ taxable?: {
1484
+ amount: string;
1485
+ currency: string;
1486
+ };
1487
+ amount?: {
1488
+ amount: string;
1489
+ currency: string;
1490
+ };
1491
+ };
1492
+ fees: {
1493
+ name: FeeName;
1494
+ type: FeeType;
1495
+ rate: string;
1496
+ amount?: {
1497
+ amount: string;
1498
+ currency: string;
1499
+ };
1500
+ }[];
1501
+ }[];
1502
+ total?: {
1503
+ amount: string;
1504
+ currency: string;
1505
+ };
1506
+ discount?: {
1507
+ amount?: {
1508
+ amount: string;
1509
+ currency: string;
1510
+ };
1511
+ afterDiscount?: {
1512
+ amount: string;
1513
+ currency: string;
1514
+ };
1515
+ code: string;
1516
+ name: string;
1517
+ couponId: string;
1518
+ discounts: {
1519
+ coupon?: {
1520
+ name: string;
1521
+ code: string;
1522
+ couponId: string;
1523
+ };
1524
+ paidPlan?: {
1525
+ percentDiscount?: {
1526
+ rate: string;
1527
+ quantityDiscounted: number;
1528
+ };
1529
+ name: string;
1530
+ };
1531
+ amount?: {
1532
+ amount: string;
1533
+ currency: string;
1534
+ };
1535
+ }[];
1536
+ };
1537
+ tax?: {
1538
+ type: TaxType;
1539
+ name: string;
1540
+ rate: string;
1541
+ taxable?: {
1542
+ amount: string;
1543
+ currency: string;
1544
+ };
1545
+ amount?: {
1546
+ amount: string;
1547
+ currency: string;
1548
+ };
1549
+ };
1550
+ subTotal?: {
1551
+ amount: string;
1552
+ currency: string;
1553
+ };
1554
+ grandTotal?: {
1555
+ amount: string;
1556
+ currency: string;
1557
+ };
1558
+ fees: {
1559
+ name: FeeName;
1560
+ type: FeeType;
1561
+ rate: string;
1562
+ amount?: {
1563
+ amount: string;
1564
+ currency: string;
1565
+ };
1566
+ }[];
1567
+ revenue?: {
1568
+ amount: string;
1569
+ currency: string;
1570
+ };
1571
+ };
1572
+ fullyCheckedIn: boolean;
1573
+ paymentDetails?: {
1574
+ transaction?: {
1575
+ transactionId: string;
1576
+ method: string;
1577
+ };
1578
+ };
1579
+ channel: ChannelType;
1580
+ }[];
1581
+ orderFacets?: {
1582
+ facets?: {
1583
+ counts?: {
1584
+ count: number;
1585
+ tickets: number;
1586
+ ticketsCheckIn: number;
1587
+ };
1588
+ };
1589
+ };
1590
+ }
1591
+ export interface GetOrderResponseNonNullableFields {
1592
+ order?: {
1593
+ orderNumber: string;
1594
+ reservationId: string;
1595
+ snapshotId: string;
1596
+ eventId: string;
1597
+ contactId: string;
1598
+ memberId: string;
1599
+ firstName: string;
1600
+ lastName: string;
1601
+ email: string;
1602
+ checkoutForm?: {
1603
+ inputValues: {
1604
+ inputName: string;
1605
+ value: string;
1606
+ values: string[];
1607
+ }[];
1608
+ };
1609
+ confirmed: boolean;
1610
+ status: OrderStatus;
1611
+ method: string;
1612
+ ticketsQuantity: number;
1613
+ totalPrice?: {
1614
+ amount: string;
1615
+ currency: string;
1616
+ };
1617
+ ticketsPdf: string;
1618
+ tickets: {
1619
+ ticketNumber: string;
1620
+ orderNumber: string;
1621
+ ticketDefinitionId: string;
1622
+ name: string;
1623
+ price?: {
1624
+ amount: string;
1625
+ currency: string;
1626
+ };
1627
+ free: boolean;
1628
+ policy: string;
1629
+ qrCode: string;
1630
+ orderStatus: OrderStatus;
1631
+ orderArchived: boolean;
1632
+ orderFullName: string;
1633
+ guestDetails?: {
1634
+ guestAssigned: boolean;
1635
+ form?: {
1636
+ inputValues: {
1637
+ inputName: string;
1638
+ value: string;
1639
+ values: string[];
1640
+ }[];
1641
+ };
1642
+ };
1643
+ archived: boolean;
1644
+ ticketPdf: string;
1645
+ anonymized: boolean;
1646
+ checkInUrl: string;
1647
+ ticketPdfUrl: string;
1648
+ channel: ChannelType;
1649
+ walletPassUrl: string;
1650
+ }[];
1651
+ archived: boolean;
1652
+ anonymized: boolean;
1653
+ fullName: string;
1654
+ invoice?: {
1655
+ items: {
1656
+ _id: string;
1657
+ quantity: number;
1658
+ name: string;
1659
+ price?: {
1660
+ amount: string;
1661
+ currency: string;
1662
+ };
1663
+ total?: {
1664
+ amount: string;
1665
+ currency: string;
1666
+ };
1667
+ discount?: {
1668
+ amount?: {
1669
+ amount: string;
1670
+ currency: string;
1671
+ };
1672
+ afterDiscount?: {
1673
+ amount: string;
1674
+ currency: string;
1675
+ };
1676
+ code: string;
1677
+ name: string;
1678
+ couponId: string;
1679
+ discounts: {
1680
+ coupon?: {
1681
+ name: string;
1682
+ code: string;
1683
+ couponId: string;
1684
+ };
1685
+ paidPlan?: {
1686
+ percentDiscount?: {
1687
+ rate: string;
1688
+ quantityDiscounted: number;
1689
+ };
1690
+ name: string;
1691
+ };
1692
+ amount?: {
1693
+ amount: string;
1694
+ currency: string;
1695
+ };
1696
+ }[];
1697
+ };
1698
+ tax?: {
1699
+ type: TaxType;
1700
+ name: string;
1701
+ rate: string;
1702
+ taxable?: {
1703
+ amount: string;
1704
+ currency: string;
1705
+ };
1706
+ amount?: {
1707
+ amount: string;
1708
+ currency: string;
1709
+ };
1710
+ };
1711
+ fees: {
1712
+ name: FeeName;
1713
+ type: FeeType;
1714
+ rate: string;
1715
+ amount?: {
1716
+ amount: string;
1717
+ currency: string;
1718
+ };
1719
+ }[];
1720
+ }[];
1721
+ total?: {
1722
+ amount: string;
1723
+ currency: string;
1724
+ };
1725
+ discount?: {
1726
+ amount?: {
1727
+ amount: string;
1728
+ currency: string;
1729
+ };
1730
+ afterDiscount?: {
1731
+ amount: string;
1732
+ currency: string;
1733
+ };
1734
+ code: string;
1735
+ name: string;
1736
+ couponId: string;
1737
+ discounts: {
1738
+ coupon?: {
1739
+ name: string;
1740
+ code: string;
1741
+ couponId: string;
1742
+ };
1743
+ paidPlan?: {
1744
+ percentDiscount?: {
1745
+ rate: string;
1746
+ quantityDiscounted: number;
1747
+ };
1748
+ name: string;
1749
+ };
1750
+ amount?: {
1751
+ amount: string;
1752
+ currency: string;
1753
+ };
1754
+ }[];
1755
+ };
1756
+ tax?: {
1757
+ type: TaxType;
1758
+ name: string;
1759
+ rate: string;
1760
+ taxable?: {
1761
+ amount: string;
1762
+ currency: string;
1763
+ };
1764
+ amount?: {
1765
+ amount: string;
1766
+ currency: string;
1767
+ };
1768
+ };
1769
+ subTotal?: {
1770
+ amount: string;
1771
+ currency: string;
1772
+ };
1773
+ grandTotal?: {
1774
+ amount: string;
1775
+ currency: string;
1776
+ };
1777
+ fees: {
1778
+ name: FeeName;
1779
+ type: FeeType;
1780
+ rate: string;
1781
+ amount?: {
1782
+ amount: string;
1783
+ currency: string;
1784
+ };
1785
+ }[];
1786
+ revenue?: {
1787
+ amount: string;
1788
+ currency: string;
1789
+ };
1790
+ };
1791
+ fullyCheckedIn: boolean;
1792
+ paymentDetails?: {
1793
+ transaction?: {
1794
+ transactionId: string;
1795
+ method: string;
1796
+ };
1797
+ };
1798
+ channel: ChannelType;
1799
+ };
1800
+ calendarLinks?: {
1801
+ google: string;
1802
+ ics: string;
1803
+ };
1804
+ }
1805
+ export interface UpdateOrderResponseNonNullableFields {
1806
+ order?: {
1807
+ orderNumber: string;
1808
+ reservationId: string;
1809
+ snapshotId: string;
1810
+ eventId: string;
1811
+ contactId: string;
1812
+ memberId: string;
1813
+ firstName: string;
1814
+ lastName: string;
1815
+ email: string;
1816
+ checkoutForm?: {
1817
+ inputValues: {
1818
+ inputName: string;
1819
+ value: string;
1820
+ values: string[];
1821
+ }[];
1822
+ };
1823
+ confirmed: boolean;
1824
+ status: OrderStatus;
1825
+ method: string;
1826
+ ticketsQuantity: number;
1827
+ totalPrice?: {
1828
+ amount: string;
1829
+ currency: string;
1830
+ };
1831
+ ticketsPdf: string;
1832
+ tickets: {
1833
+ ticketNumber: string;
1834
+ orderNumber: string;
1835
+ ticketDefinitionId: string;
1836
+ name: string;
1837
+ price?: {
1838
+ amount: string;
1839
+ currency: string;
1840
+ };
1841
+ free: boolean;
1842
+ policy: string;
1843
+ qrCode: string;
1844
+ orderStatus: OrderStatus;
1845
+ orderArchived: boolean;
1846
+ orderFullName: string;
1847
+ guestDetails?: {
1848
+ guestAssigned: boolean;
1849
+ form?: {
1850
+ inputValues: {
1851
+ inputName: string;
1852
+ value: string;
1853
+ values: string[];
1854
+ }[];
1855
+ };
1856
+ };
1857
+ archived: boolean;
1858
+ ticketPdf: string;
1859
+ anonymized: boolean;
1860
+ checkInUrl: string;
1861
+ ticketPdfUrl: string;
1862
+ channel: ChannelType;
1863
+ walletPassUrl: string;
1864
+ }[];
1865
+ archived: boolean;
1866
+ anonymized: boolean;
1867
+ fullName: string;
1868
+ invoice?: {
1869
+ items: {
1870
+ _id: string;
1871
+ quantity: number;
1872
+ name: string;
1873
+ price?: {
1874
+ amount: string;
1875
+ currency: string;
1876
+ };
1877
+ total?: {
1878
+ amount: string;
1879
+ currency: string;
1880
+ };
1881
+ discount?: {
1882
+ amount?: {
1883
+ amount: string;
1884
+ currency: string;
1885
+ };
1886
+ afterDiscount?: {
1887
+ amount: string;
1888
+ currency: string;
1889
+ };
1890
+ code: string;
1891
+ name: string;
1892
+ couponId: string;
1893
+ discounts: {
1894
+ coupon?: {
1895
+ name: string;
1896
+ code: string;
1897
+ couponId: string;
1898
+ };
1899
+ paidPlan?: {
1900
+ percentDiscount?: {
1901
+ rate: string;
1902
+ quantityDiscounted: number;
1903
+ };
1904
+ name: string;
1905
+ };
1906
+ amount?: {
1907
+ amount: string;
1908
+ currency: string;
1909
+ };
1910
+ }[];
1911
+ };
1912
+ tax?: {
1913
+ type: TaxType;
1914
+ name: string;
1915
+ rate: string;
1916
+ taxable?: {
1917
+ amount: string;
1918
+ currency: string;
1919
+ };
1920
+ amount?: {
1921
+ amount: string;
1922
+ currency: string;
1923
+ };
1924
+ };
1925
+ fees: {
1926
+ name: FeeName;
1927
+ type: FeeType;
1928
+ rate: string;
1929
+ amount?: {
1930
+ amount: string;
1931
+ currency: string;
1932
+ };
1933
+ }[];
1934
+ }[];
1935
+ total?: {
1936
+ amount: string;
1937
+ currency: string;
1938
+ };
1939
+ discount?: {
1940
+ amount?: {
1941
+ amount: string;
1942
+ currency: string;
1943
+ };
1944
+ afterDiscount?: {
1945
+ amount: string;
1946
+ currency: string;
1947
+ };
1948
+ code: string;
1949
+ name: string;
1950
+ couponId: string;
1951
+ discounts: {
1952
+ coupon?: {
1953
+ name: string;
1954
+ code: string;
1955
+ couponId: string;
1956
+ };
1957
+ paidPlan?: {
1958
+ percentDiscount?: {
1959
+ rate: string;
1960
+ quantityDiscounted: number;
1961
+ };
1962
+ name: string;
1963
+ };
1964
+ amount?: {
1965
+ amount: string;
1966
+ currency: string;
1967
+ };
1968
+ }[];
1969
+ };
1970
+ tax?: {
1971
+ type: TaxType;
1972
+ name: string;
1973
+ rate: string;
1974
+ taxable?: {
1975
+ amount: string;
1976
+ currency: string;
1977
+ };
1978
+ amount?: {
1979
+ amount: string;
1980
+ currency: string;
1981
+ };
1982
+ };
1983
+ subTotal?: {
1984
+ amount: string;
1985
+ currency: string;
1986
+ };
1987
+ grandTotal?: {
1988
+ amount: string;
1989
+ currency: string;
1990
+ };
1991
+ fees: {
1992
+ name: FeeName;
1993
+ type: FeeType;
1994
+ rate: string;
1995
+ amount?: {
1996
+ amount: string;
1997
+ currency: string;
1998
+ };
1999
+ }[];
2000
+ revenue?: {
2001
+ amount: string;
2002
+ currency: string;
2003
+ };
2004
+ };
2005
+ fullyCheckedIn: boolean;
2006
+ paymentDetails?: {
2007
+ transaction?: {
2008
+ transactionId: string;
2009
+ method: string;
2010
+ };
2011
+ };
2012
+ channel: ChannelType;
2013
+ };
2014
+ }
2015
+ export interface BulkUpdateOrdersResponseNonNullableFields {
2016
+ orders: {
2017
+ orderNumber: string;
2018
+ reservationId: string;
2019
+ snapshotId: string;
2020
+ eventId: string;
2021
+ contactId: string;
2022
+ memberId: string;
2023
+ firstName: string;
2024
+ lastName: string;
2025
+ email: string;
2026
+ checkoutForm?: {
2027
+ inputValues: {
2028
+ inputName: string;
2029
+ value: string;
2030
+ values: string[];
2031
+ }[];
2032
+ };
2033
+ confirmed: boolean;
2034
+ status: OrderStatus;
2035
+ method: string;
2036
+ ticketsQuantity: number;
2037
+ totalPrice?: {
2038
+ amount: string;
2039
+ currency: string;
2040
+ };
2041
+ ticketsPdf: string;
2042
+ tickets: {
2043
+ ticketNumber: string;
2044
+ orderNumber: string;
2045
+ ticketDefinitionId: string;
2046
+ name: string;
2047
+ price?: {
2048
+ amount: string;
2049
+ currency: string;
2050
+ };
2051
+ free: boolean;
2052
+ policy: string;
2053
+ qrCode: string;
2054
+ orderStatus: OrderStatus;
2055
+ orderArchived: boolean;
2056
+ orderFullName: string;
2057
+ guestDetails?: {
2058
+ guestAssigned: boolean;
2059
+ form?: {
2060
+ inputValues: {
2061
+ inputName: string;
2062
+ value: string;
2063
+ values: string[];
2064
+ }[];
2065
+ };
2066
+ };
2067
+ archived: boolean;
2068
+ ticketPdf: string;
2069
+ anonymized: boolean;
2070
+ checkInUrl: string;
2071
+ ticketPdfUrl: string;
2072
+ channel: ChannelType;
2073
+ walletPassUrl: string;
2074
+ }[];
2075
+ archived: boolean;
2076
+ anonymized: boolean;
2077
+ fullName: string;
2078
+ invoice?: {
2079
+ items: {
2080
+ _id: string;
2081
+ quantity: number;
2082
+ name: string;
2083
+ price?: {
2084
+ amount: string;
2085
+ currency: string;
2086
+ };
2087
+ total?: {
2088
+ amount: string;
2089
+ currency: string;
2090
+ };
2091
+ discount?: {
2092
+ amount?: {
2093
+ amount: string;
2094
+ currency: string;
2095
+ };
2096
+ afterDiscount?: {
2097
+ amount: string;
2098
+ currency: string;
2099
+ };
2100
+ code: string;
2101
+ name: string;
2102
+ couponId: string;
2103
+ discounts: {
2104
+ coupon?: {
2105
+ name: string;
2106
+ code: string;
2107
+ couponId: string;
2108
+ };
2109
+ paidPlan?: {
2110
+ percentDiscount?: {
2111
+ rate: string;
2112
+ quantityDiscounted: number;
2113
+ };
2114
+ name: string;
2115
+ };
2116
+ amount?: {
2117
+ amount: string;
2118
+ currency: string;
2119
+ };
2120
+ }[];
2121
+ };
2122
+ tax?: {
2123
+ type: TaxType;
2124
+ name: string;
2125
+ rate: string;
2126
+ taxable?: {
2127
+ amount: string;
2128
+ currency: string;
2129
+ };
2130
+ amount?: {
2131
+ amount: string;
2132
+ currency: string;
2133
+ };
2134
+ };
2135
+ fees: {
2136
+ name: FeeName;
2137
+ type: FeeType;
2138
+ rate: string;
2139
+ amount?: {
2140
+ amount: string;
2141
+ currency: string;
2142
+ };
2143
+ }[];
2144
+ }[];
2145
+ total?: {
2146
+ amount: string;
2147
+ currency: string;
2148
+ };
2149
+ discount?: {
2150
+ amount?: {
2151
+ amount: string;
2152
+ currency: string;
2153
+ };
2154
+ afterDiscount?: {
2155
+ amount: string;
2156
+ currency: string;
2157
+ };
2158
+ code: string;
2159
+ name: string;
2160
+ couponId: string;
2161
+ discounts: {
2162
+ coupon?: {
2163
+ name: string;
2164
+ code: string;
2165
+ couponId: string;
2166
+ };
2167
+ paidPlan?: {
2168
+ percentDiscount?: {
2169
+ rate: string;
2170
+ quantityDiscounted: number;
2171
+ };
2172
+ name: string;
2173
+ };
2174
+ amount?: {
2175
+ amount: string;
2176
+ currency: string;
2177
+ };
2178
+ }[];
2179
+ };
2180
+ tax?: {
2181
+ type: TaxType;
2182
+ name: string;
2183
+ rate: string;
2184
+ taxable?: {
2185
+ amount: string;
2186
+ currency: string;
2187
+ };
2188
+ amount?: {
2189
+ amount: string;
2190
+ currency: string;
2191
+ };
2192
+ };
2193
+ subTotal?: {
2194
+ amount: string;
2195
+ currency: string;
2196
+ };
2197
+ grandTotal?: {
2198
+ amount: string;
2199
+ currency: string;
2200
+ };
2201
+ fees: {
2202
+ name: FeeName;
2203
+ type: FeeType;
2204
+ rate: string;
2205
+ amount?: {
2206
+ amount: string;
2207
+ currency: string;
2208
+ };
2209
+ }[];
2210
+ revenue?: {
2211
+ amount: string;
2212
+ currency: string;
2213
+ };
2214
+ };
2215
+ fullyCheckedIn: boolean;
2216
+ paymentDetails?: {
2217
+ transaction?: {
2218
+ transactionId: string;
2219
+ method: string;
2220
+ };
2221
+ };
2222
+ channel: ChannelType;
2223
+ }[];
2224
+ }
2225
+ export interface ConfirmOrderResponseNonNullableFields {
2226
+ orders: {
2227
+ orderNumber: string;
2228
+ reservationId: string;
2229
+ snapshotId: string;
2230
+ eventId: string;
2231
+ contactId: string;
2232
+ memberId: string;
2233
+ firstName: string;
2234
+ lastName: string;
2235
+ email: string;
2236
+ checkoutForm?: {
2237
+ inputValues: {
2238
+ inputName: string;
2239
+ value: string;
2240
+ values: string[];
2241
+ }[];
2242
+ };
2243
+ confirmed: boolean;
2244
+ status: OrderStatus;
2245
+ method: string;
2246
+ ticketsQuantity: number;
2247
+ totalPrice?: {
2248
+ amount: string;
2249
+ currency: string;
2250
+ };
2251
+ ticketsPdf: string;
2252
+ tickets: {
2253
+ ticketNumber: string;
2254
+ orderNumber: string;
2255
+ ticketDefinitionId: string;
2256
+ name: string;
2257
+ price?: {
2258
+ amount: string;
2259
+ currency: string;
2260
+ };
2261
+ free: boolean;
2262
+ policy: string;
2263
+ qrCode: string;
2264
+ orderStatus: OrderStatus;
2265
+ orderArchived: boolean;
2266
+ orderFullName: string;
2267
+ guestDetails?: {
2268
+ guestAssigned: boolean;
2269
+ form?: {
2270
+ inputValues: {
2271
+ inputName: string;
2272
+ value: string;
2273
+ values: string[];
2274
+ }[];
2275
+ };
2276
+ };
2277
+ archived: boolean;
2278
+ ticketPdf: string;
2279
+ anonymized: boolean;
2280
+ checkInUrl: string;
2281
+ ticketPdfUrl: string;
2282
+ channel: ChannelType;
2283
+ walletPassUrl: string;
2284
+ }[];
2285
+ archived: boolean;
2286
+ anonymized: boolean;
2287
+ fullName: string;
2288
+ invoice?: {
2289
+ items: {
2290
+ _id: string;
2291
+ quantity: number;
2292
+ name: string;
2293
+ price?: {
2294
+ amount: string;
2295
+ currency: string;
2296
+ };
2297
+ total?: {
2298
+ amount: string;
2299
+ currency: string;
2300
+ };
2301
+ discount?: {
2302
+ amount?: {
2303
+ amount: string;
2304
+ currency: string;
2305
+ };
2306
+ afterDiscount?: {
2307
+ amount: string;
2308
+ currency: string;
2309
+ };
2310
+ code: string;
2311
+ name: string;
2312
+ couponId: string;
2313
+ discounts: {
2314
+ coupon?: {
2315
+ name: string;
2316
+ code: string;
2317
+ couponId: string;
2318
+ };
2319
+ paidPlan?: {
2320
+ percentDiscount?: {
2321
+ rate: string;
2322
+ quantityDiscounted: number;
2323
+ };
2324
+ name: string;
2325
+ };
2326
+ amount?: {
2327
+ amount: string;
2328
+ currency: string;
2329
+ };
2330
+ }[];
2331
+ };
2332
+ tax?: {
2333
+ type: TaxType;
2334
+ name: string;
2335
+ rate: string;
2336
+ taxable?: {
2337
+ amount: string;
2338
+ currency: string;
2339
+ };
2340
+ amount?: {
2341
+ amount: string;
2342
+ currency: string;
2343
+ };
2344
+ };
2345
+ fees: {
2346
+ name: FeeName;
2347
+ type: FeeType;
2348
+ rate: string;
2349
+ amount?: {
2350
+ amount: string;
2351
+ currency: string;
2352
+ };
2353
+ }[];
2354
+ }[];
2355
+ total?: {
2356
+ amount: string;
2357
+ currency: string;
2358
+ };
2359
+ discount?: {
2360
+ amount?: {
2361
+ amount: string;
2362
+ currency: string;
2363
+ };
2364
+ afterDiscount?: {
2365
+ amount: string;
2366
+ currency: string;
2367
+ };
2368
+ code: string;
2369
+ name: string;
2370
+ couponId: string;
2371
+ discounts: {
2372
+ coupon?: {
2373
+ name: string;
2374
+ code: string;
2375
+ couponId: string;
2376
+ };
2377
+ paidPlan?: {
2378
+ percentDiscount?: {
2379
+ rate: string;
2380
+ quantityDiscounted: number;
2381
+ };
2382
+ name: string;
2383
+ };
2384
+ amount?: {
2385
+ amount: string;
2386
+ currency: string;
2387
+ };
2388
+ }[];
2389
+ };
2390
+ tax?: {
2391
+ type: TaxType;
2392
+ name: string;
2393
+ rate: string;
2394
+ taxable?: {
2395
+ amount: string;
2396
+ currency: string;
2397
+ };
2398
+ amount?: {
2399
+ amount: string;
2400
+ currency: string;
2401
+ };
2402
+ };
2403
+ subTotal?: {
2404
+ amount: string;
2405
+ currency: string;
2406
+ };
2407
+ grandTotal?: {
2408
+ amount: string;
2409
+ currency: string;
2410
+ };
2411
+ fees: {
2412
+ name: FeeName;
2413
+ type: FeeType;
2414
+ rate: string;
2415
+ amount?: {
2416
+ amount: string;
2417
+ currency: string;
2418
+ };
2419
+ }[];
2420
+ revenue?: {
2421
+ amount: string;
2422
+ currency: string;
2423
+ };
2424
+ };
2425
+ fullyCheckedIn: boolean;
2426
+ paymentDetails?: {
2427
+ transaction?: {
2428
+ transactionId: string;
2429
+ method: string;
2430
+ };
2431
+ };
2432
+ channel: ChannelType;
2433
+ }[];
2434
+ }
2435
+ export interface GetSummaryResponseNonNullableFields {
2436
+ sales: {
2437
+ total?: {
2438
+ amount: string;
2439
+ currency: string;
2440
+ };
2441
+ totalOrders: number;
2442
+ totalTickets: number;
2443
+ revenue?: {
2444
+ amount: string;
2445
+ currency: string;
2446
+ };
2447
+ }[];
2448
+ }
2449
+ export interface GetCheckoutOptionsResponseNonNullableFields {
2450
+ paymentMethodConfigured: boolean;
2451
+ acceptCoupons: boolean;
2452
+ premiumServices: boolean;
2453
+ paidTickets: boolean;
2454
+ }
2455
+ export interface ListAvailableTicketsResponseNonNullableFields {
2456
+ metaData?: {
2457
+ count: number;
2458
+ offset: number;
2459
+ total: number;
2460
+ };
2461
+ definitions: {
2462
+ _id: string;
2463
+ price?: {
2464
+ amount: string;
2465
+ currency: string;
2466
+ };
2467
+ free: boolean;
2468
+ name: string;
2469
+ description: string;
2470
+ limitPerCheckout: number;
2471
+ orderIndex: number;
2472
+ policy: string;
2473
+ dashboard?: {
2474
+ hidden: boolean;
2475
+ sold: number;
2476
+ limited: boolean;
2477
+ ticketsSold: number;
2478
+ ticketsReserved: number;
2479
+ };
2480
+ eventId: string;
2481
+ wixFeeConfig?: {
2482
+ type: FeeType;
2483
+ };
2484
+ salePeriod?: {
2485
+ hideNotOnSale: boolean;
2486
+ };
2487
+ saleStatus: TicketSaleStatus;
2488
+ state: State[];
2489
+ pricing?: {
2490
+ fixedPrice?: {
2491
+ amount: string;
2492
+ currency: string;
2493
+ };
2494
+ minPrice?: {
2495
+ amount: string;
2496
+ currency: string;
2497
+ };
2498
+ pricingOptions?: {
2499
+ options: {
2500
+ price?: {
2501
+ amount: string;
2502
+ currency: string;
2503
+ };
2504
+ }[];
2505
+ };
2506
+ pricingType: Type;
2507
+ };
2508
+ }[];
2509
+ }
2510
+ export interface QueryAvailableTicketsResponseNonNullableFields {
2511
+ metaData?: {
2512
+ count: number;
2513
+ offset: number;
2514
+ total: number;
2515
+ };
2516
+ definitions: {
2517
+ _id: string;
2518
+ price?: {
2519
+ amount: string;
2520
+ currency: string;
2521
+ };
2522
+ free: boolean;
2523
+ name: string;
2524
+ description: string;
2525
+ limitPerCheckout: number;
2526
+ orderIndex: number;
2527
+ policy: string;
2528
+ dashboard?: {
2529
+ hidden: boolean;
2530
+ sold: number;
2531
+ limited: boolean;
2532
+ ticketsSold: number;
2533
+ ticketsReserved: number;
2534
+ };
2535
+ eventId: string;
2536
+ wixFeeConfig?: {
2537
+ type: FeeType;
2538
+ };
2539
+ salePeriod?: {
2540
+ hideNotOnSale: boolean;
2541
+ };
2542
+ saleStatus: TicketSaleStatus;
2543
+ state: State[];
2544
+ pricing?: {
2545
+ fixedPrice?: {
2546
+ amount: string;
2547
+ currency: string;
2548
+ };
2549
+ minPrice?: {
2550
+ amount: string;
2551
+ currency: string;
2552
+ };
2553
+ pricingOptions?: {
2554
+ options: {
2555
+ price?: {
2556
+ amount: string;
2557
+ currency: string;
2558
+ };
2559
+ }[];
2560
+ };
2561
+ pricingType: Type;
2562
+ };
2563
+ }[];
2564
+ }
2565
+ export interface CreateReservationResponseNonNullableFields {
2566
+ _id: string;
2567
+ reservations: {
2568
+ quantity: number;
2569
+ ticket?: {
2570
+ _id: string;
2571
+ price?: {
2572
+ amount: string;
2573
+ currency: string;
2574
+ };
2575
+ free: boolean;
2576
+ name: string;
2577
+ description: string;
2578
+ limitPerCheckout: number;
2579
+ orderIndex: number;
2580
+ policy: string;
2581
+ dashboard?: {
2582
+ hidden: boolean;
2583
+ sold: number;
2584
+ limited: boolean;
2585
+ ticketsSold: number;
2586
+ ticketsReserved: number;
2587
+ };
2588
+ eventId: string;
2589
+ wixFeeConfig?: {
2590
+ type: FeeType;
2591
+ };
2592
+ salePeriod?: {
2593
+ hideNotOnSale: boolean;
2594
+ };
2595
+ saleStatus: TicketSaleStatus;
2596
+ state: State[];
2597
+ pricing?: {
2598
+ fixedPrice?: {
2599
+ amount: string;
2600
+ currency: string;
2601
+ };
2602
+ minPrice?: {
2603
+ amount: string;
2604
+ currency: string;
2605
+ };
2606
+ pricingOptions?: {
2607
+ options: {
2608
+ price?: {
2609
+ amount: string;
2610
+ currency: string;
2611
+ };
2612
+ }[];
2613
+ };
2614
+ pricingType: Type;
2615
+ };
2616
+ };
2617
+ ticketDetails: TicketDetails[];
2618
+ }[];
2619
+ invoice?: {
2620
+ items: {
2621
+ _id: string;
2622
+ quantity: number;
2623
+ name: string;
2624
+ price?: {
2625
+ amount: string;
2626
+ currency: string;
2627
+ };
2628
+ total?: {
2629
+ amount: string;
2630
+ currency: string;
2631
+ };
2632
+ discount?: {
2633
+ amount?: {
2634
+ amount: string;
2635
+ currency: string;
2636
+ };
2637
+ afterDiscount?: {
2638
+ amount: string;
2639
+ currency: string;
2640
+ };
2641
+ code: string;
2642
+ name: string;
2643
+ couponId: string;
2644
+ discounts: {
2645
+ coupon?: {
2646
+ name: string;
2647
+ code: string;
2648
+ couponId: string;
2649
+ };
2650
+ paidPlan?: {
2651
+ percentDiscount?: {
2652
+ rate: string;
2653
+ quantityDiscounted: number;
2654
+ };
2655
+ name: string;
2656
+ };
2657
+ amount?: {
2658
+ amount: string;
2659
+ currency: string;
2660
+ };
2661
+ }[];
2662
+ };
2663
+ tax?: {
2664
+ type: TaxType;
2665
+ name: string;
2666
+ rate: string;
2667
+ taxable?: {
2668
+ amount: string;
2669
+ currency: string;
2670
+ };
2671
+ amount?: {
2672
+ amount: string;
2673
+ currency: string;
2674
+ };
2675
+ };
2676
+ fees: {
2677
+ name: FeeName;
2678
+ type: FeeType;
2679
+ rate: string;
2680
+ amount?: {
2681
+ amount: string;
2682
+ currency: string;
2683
+ };
2684
+ }[];
2685
+ }[];
2686
+ total?: {
2687
+ amount: string;
2688
+ currency: string;
2689
+ };
2690
+ discount?: {
2691
+ amount?: {
2692
+ amount: string;
2693
+ currency: string;
2694
+ };
2695
+ afterDiscount?: {
2696
+ amount: string;
2697
+ currency: string;
2698
+ };
2699
+ code: string;
2700
+ name: string;
2701
+ couponId: string;
2702
+ discounts: {
2703
+ coupon?: {
2704
+ name: string;
2705
+ code: string;
2706
+ couponId: string;
2707
+ };
2708
+ paidPlan?: {
2709
+ percentDiscount?: {
2710
+ rate: string;
2711
+ quantityDiscounted: number;
2712
+ };
2713
+ name: string;
2714
+ };
2715
+ amount?: {
2716
+ amount: string;
2717
+ currency: string;
2718
+ };
2719
+ }[];
2720
+ };
2721
+ tax?: {
2722
+ type: TaxType;
2723
+ name: string;
2724
+ rate: string;
2725
+ taxable?: {
2726
+ amount: string;
2727
+ currency: string;
2728
+ };
2729
+ amount?: {
2730
+ amount: string;
2731
+ currency: string;
2732
+ };
2733
+ };
2734
+ subTotal?: {
2735
+ amount: string;
2736
+ currency: string;
2737
+ };
2738
+ grandTotal?: {
2739
+ amount: string;
2740
+ currency: string;
2741
+ };
2742
+ fees: {
2743
+ name: FeeName;
2744
+ type: FeeType;
2745
+ rate: string;
2746
+ amount?: {
2747
+ amount: string;
2748
+ currency: string;
2749
+ };
2750
+ }[];
2751
+ revenue?: {
2752
+ amount: string;
2753
+ currency: string;
2754
+ };
2755
+ };
2756
+ }
2757
+ export interface GetInvoiceResponseNonNullableFields {
2758
+ invoice?: {
2759
+ items: {
2760
+ _id: string;
2761
+ quantity: number;
2762
+ name: string;
2763
+ price?: {
2764
+ amount: string;
2765
+ currency: string;
2766
+ };
2767
+ total?: {
2768
+ amount: string;
2769
+ currency: string;
2770
+ };
2771
+ discount?: {
2772
+ amount?: {
2773
+ amount: string;
2774
+ currency: string;
2775
+ };
2776
+ afterDiscount?: {
2777
+ amount: string;
2778
+ currency: string;
2779
+ };
2780
+ code: string;
2781
+ name: string;
2782
+ couponId: string;
2783
+ discounts: {
2784
+ coupon?: {
2785
+ name: string;
2786
+ code: string;
2787
+ couponId: string;
2788
+ };
2789
+ paidPlan?: {
2790
+ percentDiscount?: {
2791
+ rate: string;
2792
+ quantityDiscounted: number;
2793
+ };
2794
+ name: string;
2795
+ };
2796
+ amount?: {
2797
+ amount: string;
2798
+ currency: string;
2799
+ };
2800
+ }[];
2801
+ };
2802
+ tax?: {
2803
+ type: TaxType;
2804
+ name: string;
2805
+ rate: string;
2806
+ taxable?: {
2807
+ amount: string;
2808
+ currency: string;
2809
+ };
2810
+ amount?: {
2811
+ amount: string;
2812
+ currency: string;
2813
+ };
2814
+ };
2815
+ fees: {
2816
+ name: FeeName;
2817
+ type: FeeType;
2818
+ rate: string;
2819
+ amount?: {
2820
+ amount: string;
2821
+ currency: string;
2822
+ };
2823
+ }[];
2824
+ }[];
2825
+ total?: {
2826
+ amount: string;
2827
+ currency: string;
2828
+ };
2829
+ discount?: {
2830
+ amount?: {
2831
+ amount: string;
2832
+ currency: string;
2833
+ };
2834
+ afterDiscount?: {
2835
+ amount: string;
2836
+ currency: string;
2837
+ };
2838
+ code: string;
2839
+ name: string;
2840
+ couponId: string;
2841
+ discounts: {
2842
+ coupon?: {
2843
+ name: string;
2844
+ code: string;
2845
+ couponId: string;
2846
+ };
2847
+ paidPlan?: {
2848
+ percentDiscount?: {
2849
+ rate: string;
2850
+ quantityDiscounted: number;
2851
+ };
2852
+ name: string;
2853
+ };
2854
+ amount?: {
2855
+ amount: string;
2856
+ currency: string;
2857
+ };
2858
+ }[];
2859
+ };
2860
+ tax?: {
2861
+ type: TaxType;
2862
+ name: string;
2863
+ rate: string;
2864
+ taxable?: {
2865
+ amount: string;
2866
+ currency: string;
2867
+ };
2868
+ amount?: {
2869
+ amount: string;
2870
+ currency: string;
2871
+ };
2872
+ };
2873
+ subTotal?: {
2874
+ amount: string;
2875
+ currency: string;
2876
+ };
2877
+ grandTotal?: {
2878
+ amount: string;
2879
+ currency: string;
2880
+ };
2881
+ fees: {
2882
+ name: FeeName;
2883
+ type: FeeType;
2884
+ rate: string;
2885
+ amount?: {
2886
+ amount: string;
2887
+ currency: string;
2888
+ };
2889
+ }[];
2890
+ revenue?: {
2891
+ amount: string;
2892
+ currency: string;
2893
+ };
2894
+ };
2895
+ discountErrors?: {
2896
+ error: {
2897
+ code: string;
2898
+ }[];
2899
+ };
2900
+ reservationStatus: ReservationStatus;
2901
+ reservationOccupied: boolean;
2902
+ reservations: {
2903
+ quantity: number;
2904
+ ticket?: {
2905
+ _id: string;
2906
+ price?: {
2907
+ amount: string;
2908
+ currency: string;
2909
+ };
2910
+ free: boolean;
2911
+ name: string;
2912
+ description: string;
2913
+ limitPerCheckout: number;
2914
+ orderIndex: number;
2915
+ policy: string;
2916
+ dashboard?: {
2917
+ hidden: boolean;
2918
+ sold: number;
2919
+ limited: boolean;
2920
+ ticketsSold: number;
2921
+ ticketsReserved: number;
2922
+ };
2923
+ eventId: string;
2924
+ wixFeeConfig?: {
2925
+ type: FeeType;
2926
+ };
2927
+ salePeriod?: {
2928
+ hideNotOnSale: boolean;
2929
+ };
2930
+ saleStatus: TicketSaleStatus;
2931
+ state: State[];
2932
+ pricing?: {
2933
+ fixedPrice?: {
2934
+ amount: string;
2935
+ currency: string;
2936
+ };
2937
+ minPrice?: {
2938
+ amount: string;
2939
+ currency: string;
2940
+ };
2941
+ pricingOptions?: {
2942
+ options: {
2943
+ price?: {
2944
+ amount: string;
2945
+ currency: string;
2946
+ };
2947
+ }[];
2948
+ };
2949
+ pricingType: Type;
2950
+ };
2951
+ };
2952
+ ticketDetails: TicketDetails[];
2953
+ }[];
2954
+ }
2955
+ export interface CheckoutResponseNonNullableFields {
2956
+ order?: {
2957
+ orderNumber: string;
2958
+ reservationId: string;
2959
+ snapshotId: string;
2960
+ eventId: string;
2961
+ contactId: string;
2962
+ memberId: string;
2963
+ firstName: string;
2964
+ lastName: string;
2965
+ email: string;
2966
+ checkoutForm?: {
2967
+ inputValues: {
2968
+ inputName: string;
2969
+ value: string;
2970
+ values: string[];
2971
+ }[];
2972
+ };
2973
+ confirmed: boolean;
2974
+ status: OrderStatus;
2975
+ method: string;
2976
+ ticketsQuantity: number;
2977
+ totalPrice?: {
2978
+ amount: string;
2979
+ currency: string;
2980
+ };
2981
+ ticketsPdf: string;
2982
+ tickets: {
2983
+ ticketNumber: string;
2984
+ orderNumber: string;
2985
+ ticketDefinitionId: string;
2986
+ name: string;
2987
+ price?: {
2988
+ amount: string;
2989
+ currency: string;
2990
+ };
2991
+ free: boolean;
2992
+ policy: string;
2993
+ qrCode: string;
2994
+ orderStatus: OrderStatus;
2995
+ orderArchived: boolean;
2996
+ orderFullName: string;
2997
+ guestDetails?: {
2998
+ guestAssigned: boolean;
2999
+ form?: {
3000
+ inputValues: {
3001
+ inputName: string;
3002
+ value: string;
3003
+ values: string[];
3004
+ }[];
3005
+ };
3006
+ };
3007
+ archived: boolean;
3008
+ ticketPdf: string;
3009
+ anonymized: boolean;
3010
+ checkInUrl: string;
3011
+ ticketPdfUrl: string;
3012
+ channel: ChannelType;
3013
+ walletPassUrl: string;
3014
+ }[];
3015
+ archived: boolean;
3016
+ anonymized: boolean;
3017
+ fullName: string;
3018
+ invoice?: {
3019
+ items: {
3020
+ _id: string;
3021
+ quantity: number;
3022
+ name: string;
3023
+ price?: {
3024
+ amount: string;
3025
+ currency: string;
3026
+ };
3027
+ total?: {
3028
+ amount: string;
3029
+ currency: string;
3030
+ };
3031
+ discount?: {
3032
+ amount?: {
3033
+ amount: string;
3034
+ currency: string;
3035
+ };
3036
+ afterDiscount?: {
3037
+ amount: string;
3038
+ currency: string;
3039
+ };
3040
+ code: string;
3041
+ name: string;
3042
+ couponId: string;
3043
+ discounts: {
3044
+ coupon?: {
3045
+ name: string;
3046
+ code: string;
3047
+ couponId: string;
3048
+ };
3049
+ paidPlan?: {
3050
+ percentDiscount?: {
3051
+ rate: string;
3052
+ quantityDiscounted: number;
3053
+ };
3054
+ name: string;
3055
+ };
3056
+ amount?: {
3057
+ amount: string;
3058
+ currency: string;
3059
+ };
3060
+ }[];
3061
+ };
3062
+ tax?: {
3063
+ type: TaxType;
3064
+ name: string;
3065
+ rate: string;
3066
+ taxable?: {
3067
+ amount: string;
3068
+ currency: string;
3069
+ };
3070
+ amount?: {
3071
+ amount: string;
3072
+ currency: string;
3073
+ };
3074
+ };
3075
+ fees: {
3076
+ name: FeeName;
3077
+ type: FeeType;
3078
+ rate: string;
3079
+ amount?: {
3080
+ amount: string;
3081
+ currency: string;
3082
+ };
3083
+ }[];
3084
+ }[];
3085
+ total?: {
3086
+ amount: string;
3087
+ currency: string;
3088
+ };
3089
+ discount?: {
3090
+ amount?: {
3091
+ amount: string;
3092
+ currency: string;
3093
+ };
3094
+ afterDiscount?: {
3095
+ amount: string;
3096
+ currency: string;
3097
+ };
3098
+ code: string;
3099
+ name: string;
3100
+ couponId: string;
3101
+ discounts: {
3102
+ coupon?: {
3103
+ name: string;
3104
+ code: string;
3105
+ couponId: string;
3106
+ };
3107
+ paidPlan?: {
3108
+ percentDiscount?: {
3109
+ rate: string;
3110
+ quantityDiscounted: number;
3111
+ };
3112
+ name: string;
3113
+ };
3114
+ amount?: {
3115
+ amount: string;
3116
+ currency: string;
3117
+ };
3118
+ }[];
3119
+ };
3120
+ tax?: {
3121
+ type: TaxType;
3122
+ name: string;
3123
+ rate: string;
3124
+ taxable?: {
3125
+ amount: string;
3126
+ currency: string;
3127
+ };
3128
+ amount?: {
3129
+ amount: string;
3130
+ currency: string;
3131
+ };
3132
+ };
3133
+ subTotal?: {
3134
+ amount: string;
3135
+ currency: string;
3136
+ };
3137
+ grandTotal?: {
3138
+ amount: string;
3139
+ currency: string;
3140
+ };
3141
+ fees: {
3142
+ name: FeeName;
3143
+ type: FeeType;
3144
+ rate: string;
3145
+ amount?: {
3146
+ amount: string;
3147
+ currency: string;
3148
+ };
3149
+ }[];
3150
+ revenue?: {
3151
+ amount: string;
3152
+ currency: string;
3153
+ };
3154
+ };
3155
+ fullyCheckedIn: boolean;
3156
+ paymentDetails?: {
3157
+ transaction?: {
3158
+ transactionId: string;
3159
+ method: string;
3160
+ };
3161
+ };
3162
+ channel: ChannelType;
3163
+ };
3164
+ reservations: {
3165
+ quantity: number;
3166
+ ticket?: {
3167
+ _id: string;
3168
+ price?: {
3169
+ amount: string;
3170
+ currency: string;
3171
+ };
3172
+ free: boolean;
3173
+ name: string;
3174
+ description: string;
3175
+ limitPerCheckout: number;
3176
+ orderIndex: number;
3177
+ policy: string;
3178
+ dashboard?: {
3179
+ hidden: boolean;
3180
+ sold: number;
3181
+ limited: boolean;
3182
+ ticketsSold: number;
3183
+ ticketsReserved: number;
3184
+ };
3185
+ eventId: string;
3186
+ wixFeeConfig?: {
3187
+ type: FeeType;
3188
+ };
3189
+ salePeriod?: {
3190
+ hideNotOnSale: boolean;
3191
+ };
3192
+ saleStatus: TicketSaleStatus;
3193
+ state: State[];
3194
+ pricing?: {
3195
+ fixedPrice?: {
3196
+ amount: string;
3197
+ currency: string;
3198
+ };
3199
+ minPrice?: {
3200
+ amount: string;
3201
+ currency: string;
3202
+ };
3203
+ pricingOptions?: {
3204
+ options: {
3205
+ price?: {
3206
+ amount: string;
3207
+ currency: string;
3208
+ };
3209
+ }[];
3210
+ };
3211
+ pricingType: Type;
3212
+ };
3213
+ };
3214
+ ticketDetails: TicketDetails[];
3215
+ }[];
3216
+ }
3217
+ export interface UpdateCheckoutResponseNonNullableFields {
3218
+ order?: {
3219
+ orderNumber: string;
3220
+ reservationId: string;
3221
+ snapshotId: string;
3222
+ eventId: string;
3223
+ contactId: string;
3224
+ memberId: string;
3225
+ firstName: string;
3226
+ lastName: string;
3227
+ email: string;
3228
+ checkoutForm?: {
3229
+ inputValues: {
3230
+ inputName: string;
3231
+ value: string;
3232
+ values: string[];
3233
+ }[];
3234
+ };
3235
+ confirmed: boolean;
3236
+ status: OrderStatus;
3237
+ method: string;
3238
+ ticketsQuantity: number;
3239
+ totalPrice?: {
3240
+ amount: string;
3241
+ currency: string;
3242
+ };
3243
+ ticketsPdf: string;
3244
+ tickets: {
3245
+ ticketNumber: string;
3246
+ orderNumber: string;
3247
+ ticketDefinitionId: string;
3248
+ name: string;
3249
+ price?: {
3250
+ amount: string;
3251
+ currency: string;
3252
+ };
3253
+ free: boolean;
3254
+ policy: string;
3255
+ qrCode: string;
3256
+ orderStatus: OrderStatus;
3257
+ orderArchived: boolean;
3258
+ orderFullName: string;
3259
+ guestDetails?: {
3260
+ guestAssigned: boolean;
3261
+ form?: {
3262
+ inputValues: {
3263
+ inputName: string;
3264
+ value: string;
3265
+ values: string[];
3266
+ }[];
3267
+ };
3268
+ };
3269
+ archived: boolean;
3270
+ ticketPdf: string;
3271
+ anonymized: boolean;
3272
+ checkInUrl: string;
3273
+ ticketPdfUrl: string;
3274
+ channel: ChannelType;
3275
+ walletPassUrl: string;
3276
+ }[];
3277
+ archived: boolean;
3278
+ anonymized: boolean;
3279
+ fullName: string;
3280
+ invoice?: {
3281
+ items: {
3282
+ _id: string;
3283
+ quantity: number;
3284
+ name: string;
3285
+ price?: {
3286
+ amount: string;
3287
+ currency: string;
3288
+ };
3289
+ total?: {
3290
+ amount: string;
3291
+ currency: string;
3292
+ };
3293
+ discount?: {
3294
+ amount?: {
3295
+ amount: string;
3296
+ currency: string;
3297
+ };
3298
+ afterDiscount?: {
3299
+ amount: string;
3300
+ currency: string;
3301
+ };
3302
+ code: string;
3303
+ name: string;
3304
+ couponId: string;
3305
+ discounts: {
3306
+ coupon?: {
3307
+ name: string;
3308
+ code: string;
3309
+ couponId: string;
3310
+ };
3311
+ paidPlan?: {
3312
+ percentDiscount?: {
3313
+ rate: string;
3314
+ quantityDiscounted: number;
3315
+ };
3316
+ name: string;
3317
+ };
3318
+ amount?: {
3319
+ amount: string;
3320
+ currency: string;
3321
+ };
3322
+ }[];
3323
+ };
3324
+ tax?: {
3325
+ type: TaxType;
3326
+ name: string;
3327
+ rate: string;
3328
+ taxable?: {
3329
+ amount: string;
3330
+ currency: string;
3331
+ };
3332
+ amount?: {
3333
+ amount: string;
3334
+ currency: string;
3335
+ };
3336
+ };
3337
+ fees: {
3338
+ name: FeeName;
3339
+ type: FeeType;
3340
+ rate: string;
3341
+ amount?: {
3342
+ amount: string;
3343
+ currency: string;
3344
+ };
3345
+ }[];
3346
+ }[];
3347
+ total?: {
3348
+ amount: string;
3349
+ currency: string;
3350
+ };
3351
+ discount?: {
3352
+ amount?: {
3353
+ amount: string;
3354
+ currency: string;
3355
+ };
3356
+ afterDiscount?: {
3357
+ amount: string;
3358
+ currency: string;
3359
+ };
3360
+ code: string;
3361
+ name: string;
3362
+ couponId: string;
3363
+ discounts: {
3364
+ coupon?: {
3365
+ name: string;
3366
+ code: string;
3367
+ couponId: string;
3368
+ };
3369
+ paidPlan?: {
3370
+ percentDiscount?: {
3371
+ rate: string;
3372
+ quantityDiscounted: number;
3373
+ };
3374
+ name: string;
3375
+ };
3376
+ amount?: {
3377
+ amount: string;
3378
+ currency: string;
3379
+ };
3380
+ }[];
3381
+ };
3382
+ tax?: {
3383
+ type: TaxType;
3384
+ name: string;
3385
+ rate: string;
3386
+ taxable?: {
3387
+ amount: string;
3388
+ currency: string;
3389
+ };
3390
+ amount?: {
3391
+ amount: string;
3392
+ currency: string;
3393
+ };
3394
+ };
3395
+ subTotal?: {
3396
+ amount: string;
3397
+ currency: string;
3398
+ };
3399
+ grandTotal?: {
3400
+ amount: string;
3401
+ currency: string;
3402
+ };
3403
+ fees: {
3404
+ name: FeeName;
3405
+ type: FeeType;
3406
+ rate: string;
3407
+ amount?: {
3408
+ amount: string;
3409
+ currency: string;
3410
+ };
3411
+ }[];
3412
+ revenue?: {
3413
+ amount: string;
3414
+ currency: string;
3415
+ };
3416
+ };
3417
+ fullyCheckedIn: boolean;
3418
+ paymentDetails?: {
3419
+ transaction?: {
3420
+ transactionId: string;
3421
+ method: string;
3422
+ };
3423
+ };
3424
+ channel: ChannelType;
3425
+ };
3426
+ }
3427
+ /**
3428
+ * Returns checkout meta data used in checkout UX.
3429
+ * <!--
3430
+ * > 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.
3431
+ * -->
3432
+ * @public
3433
+ * @documentationMaturity preview
3434
+ * @permissionScope Manage Events - all permissions
3435
+ * @permissionScope Manage Orders
3436
+ * @applicableIdentity APP
3437
+ * @applicableIdentity MEMBER
3438
+ * @applicableIdentity VISITOR
3439
+ */
3440
+ export declare function getCheckoutOptions(): Promise<GetCheckoutOptionsResponse & GetCheckoutOptionsResponseNonNullableFields>;
3441
+ /**
3442
+ * Returns tickets available to reserve.
3443
+ * <!--
3444
+ * > 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.
3445
+ * -->
3446
+ * @public
3447
+ * @documentationMaturity preview
3448
+ * @param options - An object representing the available options for retrieving a list of tickets available for reservation.
3449
+ * @permissionScope Manage Events - all permissions
3450
+ * @permissionScope Manage Orders
3451
+ * @applicableIdentity APP
3452
+ * @applicableIdentity MEMBER
3453
+ * @applicableIdentity VISITOR
3454
+ */
3455
+ export declare function listAvailableTickets(options?: ListAvailableTicketsOptions): Promise<ListAvailableTicketsResponse & ListAvailableTicketsResponseNonNullableFields>;
3456
+ export interface ListAvailableTicketsOptions {
3457
+ /** Event ID. If not provided, available tickets for all events in the site will be returned. */
3458
+ eventId?: string;
3459
+ /** Offset. */
3460
+ offset?: number;
3461
+ /** Limit. */
3462
+ limit?: number;
3463
+ /** Sort order, defaults to "created:asc". */
3464
+ sort?: string;
3465
+ state?: State[];
3466
+ }
3467
+ /**
3468
+ * Returns tickets available to reserve.
3469
+ * <!--
3470
+ * > 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.
3471
+ * -->
3472
+ * @public
3473
+ * @documentationMaturity preview
3474
+ * @param options - An object representing the available options for retrieving a list of tickets available for reservation.
3475
+ * @permissionScope Manage Events - all permissions
3476
+ * @permissionScope Manage Orders
3477
+ * @applicableIdentity APP
3478
+ * @applicableIdentity MEMBER
3479
+ * @applicableIdentity VISITOR
3480
+ */
3481
+ export declare function queryAvailableTickets(options?: QueryAvailableTicketsOptions): Promise<QueryAvailableTicketsResponse & QueryAvailableTicketsResponseNonNullableFields>;
3482
+ export interface QueryAvailableTicketsOptions {
3483
+ /** Offset. */
3484
+ offset?: number;
3485
+ /** Limit. */
3486
+ limit?: number;
3487
+ /** Ticket definition. */
3488
+ filter?: Record<string, any> | null;
3489
+ fieldset?: TicketDefinitionFieldset[];
3490
+ /** Sort order, defaults to "created:asc". */
3491
+ sort?: string;
3492
+ }
3493
+ /**
3494
+ * Reserves tickets for 20 minutes.
3495
+ * Reserved tickets are deducted from tickets stock and cannot be bought by another party.
3496
+ * When the reservation expires, the tickets are added back in the stock.
3497
+ * <!--
3498
+ * > 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.
3499
+ * -->
3500
+ * @param eventId - Event ID.
3501
+ * @public
3502
+ * @documentationMaturity preview
3503
+ * @requiredField eventId
3504
+ * @param options - An object representing the available options for creating a reservation.
3505
+ * @permissionScope Manage Events - all permissions
3506
+ * @permissionScope Manage Orders
3507
+ * @applicableIdentity APP
3508
+ * @applicableIdentity MEMBER
3509
+ * @applicableIdentity VISITOR
3510
+ */
3511
+ export declare function createReservation(eventId: string, options?: CreateReservationOptions): Promise<CreateReservationResponse & CreateReservationResponseNonNullableFields>;
3512
+ export interface CreateReservationOptions {
3513
+ /** Tickets to reserve. */
3514
+ ticketQuantities?: TicketReservationQuantity[];
3515
+ /** Whether to ignore the available ticket limits upon reservation. */
3516
+ ignoreLimits?: boolean;
3517
+ /** Whether to allow reservation for hidden tickets. */
3518
+ allowHiddenTickets?: boolean;
3519
+ }
3520
+ /**
3521
+ * Cancels ticket reservation and returns tickets to stock.
3522
+ * <!--
3523
+ * > 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.
3524
+ * -->
3525
+ * @param _id - Reservation ID.
3526
+ * @param eventId - Event ID.
3527
+ * @public
3528
+ * @documentationMaturity preview
3529
+ * @requiredField _id
3530
+ * @requiredField eventId
3531
+ * @param identifiers - An object containing identifiers for the reservation to be cancelled.
3532
+ * @permissionScope Manage Events - all permissions
3533
+ * @permissionScope Manage Orders
3534
+ * @applicableIdentity APP
3535
+ * @applicableIdentity MEMBER
3536
+ * @applicableIdentity VISITOR
3537
+ */
3538
+ export declare function cancelReservation(_id: string, eventId: string): Promise<void>;
3539
+ /**
3540
+ * Generates a preview of a reservation invoice, including the given coupon or pricing plan.
3541
+ * <!--
3542
+ * > 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.
3543
+ * -->
3544
+ * @param reservationId - Reservation ID.
3545
+ * @param eventId - Event ID.
3546
+ * @public
3547
+ * @documentationMaturity preview
3548
+ * @requiredField eventId
3549
+ * @requiredField reservationId
3550
+ * @param options - An object representing the available options for generating a preview of a reservation invoice.
3551
+ * @param identifiers - An object containing identifiers for the reservation invoice preview to be generated.
3552
+ * @permissionScope Read Events - all read permissions
3553
+ * @permissionScope Manage Events - all permissions
3554
+ * @permissionScope Read Basic Events Order Info
3555
+ * @permissionScope Manage Orders
3556
+ * @applicableIdentity APP
3557
+ * @applicableIdentity MEMBER
3558
+ * @applicableIdentity VISITOR
3559
+ */
3560
+ export declare function getInvoice(reservationId: string, eventId: string, options?: GetInvoiceOptions): Promise<GetInvoiceResponse & GetInvoiceResponseNonNullableFields>;
3561
+ export interface GetInvoiceOptions {
3562
+ /** Optional discount to be applied on the returned invoice. */
3563
+ withDiscount?: DiscountRequest;
3564
+ /** Optional benefit granted by the pricing plan to be applied on the returned invoice. */
3565
+ paidPlanBenefit?: PaidPlanBenefit;
3566
+ }
3567
+ /**
3568
+ * Checkout of reserved tickets.
3569
+ *
3570
+ *
3571
+ * Creates order and associates it with a site contact.
3572
+ * Guest details must be sent according to the Registration Form input fields.
3573
+ * (To change an existing "INITIATED, "PENDING", or "OFFLINE_PENDING" order, call the [Update Checkout](https://dev.wix.com/api/rest/wix-events/wix-events/checkout/update-checkout) endpoint).
3574
+ *
3575
+ * There is a possibility to use a separate ready-made Wix checkout form where the user will be redirected from your non-Wix site or a custom ticket picker created with Velo.
3576
+ * To construct the checkout form path, get your event base URL by using the [`getEvent()`](https://www.wix.com/velo/reference/wix-events-backend/wixevents/getevent) function and add the following path:
3577
+ * `/{{EVENT_PAGE_SLUG}}/{{SLUG}}/ticket-form?reservationId={{YOUR_RESERVATION_ID}}`
3578
+ *
3579
+ * Example: `https://johndoe.wixsite.com/weddings/event-details/doe-wedding/ticket-form?reservationId=2be6d34a-2a1e-459f-897b-b4a66e73f69a`
3580
+ *
3581
+ * <!--
3582
+ * > 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.
3583
+ * -->
3584
+ * @param eventId - Event ID.
3585
+ * @public
3586
+ * @documentationMaturity preview
3587
+ * @requiredField eventId
3588
+ * @requiredField options.guests.form
3589
+ * @param options - An object representing the available options for checking out a reserved ticket.
3590
+ * @permissionScope Manage Events - all permissions
3591
+ * @permissionScope Manage Orders
3592
+ * @applicableIdentity APP
3593
+ * @applicableIdentity MEMBER
3594
+ * @applicableIdentity VISITOR
3595
+ */
3596
+ export declare function checkout(eventId: string, options?: CheckoutOptionsForRequest): Promise<CheckoutResponse & CheckoutResponseNonNullableFields>;
3597
+ export interface CheckoutOptionsForRequest {
3598
+ /** Ticket reservation ID. */
3599
+ reservationId?: string;
3600
+ /** Member ID (if empty - no site member is associated to this order). */
3601
+ memberId?: string;
3602
+ /** Discount to apply on the invoice. */
3603
+ discount?: DiscountRequest;
3604
+ /** Buyer details. */
3605
+ buyer?: Buyer;
3606
+ /** Guest details. */
3607
+ guests?: Guest[];
3608
+ /** Benefit granted by the pricing plan. */
3609
+ paidPlanBenefit?: PaidPlanBenefit;
3610
+ /** Options controlling the checkout process. */
3611
+ options?: CheckoutOptions;
3612
+ }
3613
+ /**
3614
+ * Updates order and tickets (supported only for unconfirmed orders).
3615
+ * Guest details must be sent according to Registration Form input fields.
3616
+ * <!--
3617
+ * > 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.
3618
+ * -->
3619
+ * @param orderNumber - Unique order number.
3620
+ * @param eventId - Event ID.
3621
+ * @public
3622
+ * @documentationMaturity preview
3623
+ * @requiredField eventId
3624
+ * @requiredField orderNumber
3625
+ * @param options - An object representing the available options for updating an order and tickets.
3626
+ * @param identifiers - An object containing identifiers for the order and tickets to be updated.
3627
+ * @permissionScope Manage Events - all permissions
3628
+ * @permissionScope Manage Orders
3629
+ * @applicableIdentity APP
3630
+ * @applicableIdentity MEMBER
3631
+ * @applicableIdentity VISITOR
3632
+ */
3633
+ export declare function updateCheckout(orderNumber: string, eventId: string, options?: UpdateCheckoutOptions): Promise<UpdateCheckoutResponse & UpdateCheckoutResponseNonNullableFields>;
3634
+ export interface UpdateCheckoutOptions {
3635
+ /** Buyer details. */
3636
+ buyer?: Buyer;
3637
+ /** Guest details. */
3638
+ guests?: Guest[];
3639
+ /** Member ID (if empty - no site member is associated to this order). */
3640
+ memberId?: string | null;
3641
+ /** Discount to apply on the invoice. */
3642
+ discount?: DiscountRequest;
3643
+ /** Benefit granted by the pricing plan. */
3644
+ paidPlanBenefit?: PaidPlanBenefit;
3645
+ }