@wix/events 1.0.146 → 1.0.147

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 +800 -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 +864 -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 +405 -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 +654 -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 +3611 -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 +3779 -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 +800 -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 +864 -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 +405 -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 +654 -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 +3611 -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 +3779 -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,3779 @@
1
+ export declare const __debug: {
2
+ verboseLogging: {
3
+ on: () => boolean;
4
+ off: () => boolean;
5
+ };
6
+ };
7
+ export interface Event {
8
+ /**
9
+ * Event ID.
10
+ * @readonly
11
+ */
12
+ _id?: string;
13
+ /** Event location. */
14
+ location?: Location;
15
+ /** Event date and time settings. */
16
+ dateAndTimeSettings?: DateAndTimeSettings;
17
+ title?: string | null;
18
+ shortDescription?: string | null;
19
+ detailedDescription?: string | null;
20
+ /** Main event image. */
21
+ mainImage?: string;
22
+ /**
23
+ * Unique identifier of the event page. The naming is the same as the event title written in kebab case. For example, if your event title is "Leather Crafting 101", then the slug is "leather-crafting-101".
24
+ * @readonly
25
+ */
26
+ slug?: string;
27
+ /**
28
+ * Date and time when the event was created in `yyyy-mm-ddThh:mm:sssZ` format.
29
+ * @readonly
30
+ */
31
+ _createdDate?: Date;
32
+ /**
33
+ * Date and time when the event was updated in `yyyy-mm-ddThh:mm:sssZ` format.
34
+ * @readonly
35
+ */
36
+ _updatedDate?: Date;
37
+ /** @readonly */
38
+ status?: Status;
39
+ /** RSVP or ticketing registration details. */
40
+ registration?: Registration;
41
+ /** URLs that allow you to add an event to the Google calendar, or to download an [ICS calendar](https://icscalendar.com/) file. */
42
+ calendarUrls?: CalendarUrls;
43
+ /** Event page URL components. */
44
+ eventPageUrl?: string;
45
+ /** Event registration form. */
46
+ form?: Form;
47
+ /** Summary of RSVP or ticket sales. */
48
+ summaries?: Summaries;
49
+ /**
50
+ * Instance ID of the site where the event is hosted.
51
+ * @readonly
52
+ */
53
+ instanceId?: string;
54
+ /** Guest list configuration. */
55
+ guestListSettings?: GuestListSettings;
56
+ /**
57
+ * ID of the user who created the event.
58
+ * @readonly
59
+ */
60
+ userId?: string;
61
+ /** Online conferencing details. */
62
+ onlineConferencing?: OnlineConferencing;
63
+ /** SEO settings. */
64
+ seoSettings?: SeoSettings;
65
+ /** Assigned contacts label key. */
66
+ contactLabel?: string | null;
67
+ /** Event schedule details. */
68
+ agendaSettings?: AgendaSettings;
69
+ /** Visual settings for event. */
70
+ eventDisplaySettings?: EventDisplaySettings;
71
+ }
72
+ export interface Location {
73
+ name?: string | null;
74
+ type?: LocationType;
75
+ /** Exact location address. */
76
+ address?: CommonAddress;
77
+ /** Whether the event location is TBD. */
78
+ locationTbd?: boolean | null;
79
+ }
80
+ export declare enum LocationType {
81
+ /** Default value. This value is unused. */
82
+ UNKNOWN_LOCATION = "UNKNOWN_LOCATION",
83
+ VENUE = "VENUE",
84
+ ONLINE = "ONLINE"
85
+ }
86
+ /** Physical address */
87
+ export interface CommonAddress extends CommonAddressStreetOneOf {
88
+ /** Street address. */
89
+ streetAddress?: CommonStreetAddress;
90
+ /** Primary address information (street and building number). */
91
+ addressLine1?: string | null;
92
+ /** 2-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */
93
+ country?: string | null;
94
+ /** Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */
95
+ subdivision?: string | null;
96
+ /** City name. */
97
+ city?: string | null;
98
+ /** Zip or postal code. */
99
+ postalCode?: string | null;
100
+ /** Secondary address information (suite or apartment number and room number). */
101
+ addressLine2?: string | null;
102
+ }
103
+ /** @oneof */
104
+ export interface CommonAddressStreetOneOf {
105
+ /** Street address. */
106
+ streetAddress?: CommonStreetAddress;
107
+ /** Primary address information (street and building number). */
108
+ addressLine?: string | null;
109
+ }
110
+ export interface CommonStreetAddress {
111
+ /** Street number. */
112
+ number?: string;
113
+ /** Street name. */
114
+ name?: string;
115
+ }
116
+ export interface CommonAddressLocation {
117
+ /** Address latitude coordinates. */
118
+ latitude?: number | null;
119
+ /** Address longitude coordinates. */
120
+ longitude?: number | null;
121
+ }
122
+ export interface CommonSubdivision {
123
+ /** Short subdivision code. */
124
+ code?: string;
125
+ /** Subdivision full name. */
126
+ name?: string;
127
+ }
128
+ export declare enum SubdivisionSubdivisionType {
129
+ UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
130
+ /** State */
131
+ ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
132
+ /** County */
133
+ ADMINISTRATIVE_AREA_LEVEL_2 = "ADMINISTRATIVE_AREA_LEVEL_2",
134
+ /** City/town */
135
+ ADMINISTRATIVE_AREA_LEVEL_3 = "ADMINISTRATIVE_AREA_LEVEL_3",
136
+ /** Neighborhood/quarter */
137
+ ADMINISTRATIVE_AREA_LEVEL_4 = "ADMINISTRATIVE_AREA_LEVEL_4",
138
+ /** Street/block */
139
+ ADMINISTRATIVE_AREA_LEVEL_5 = "ADMINISTRATIVE_AREA_LEVEL_5",
140
+ /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
141
+ COUNTRY = "COUNTRY"
142
+ }
143
+ export interface DateAndTimeSettings {
144
+ /** Whether the event date and time are TBD. */
145
+ dateAndTimeTbd?: boolean | null;
146
+ dateAndTimeTbdMessage?: string | null;
147
+ /** Event start date in `yyyy-mm-ddThh:mm:sssZ` format. */
148
+ startDate?: Date;
149
+ /** Event end date in `yyyy-mm-ddThh:mm:sssZ` format. */
150
+ endDate?: Date;
151
+ /** Event time zone ID in the [TZ database](https://www.iana.org/time-zones) format. */
152
+ timeZoneId?: string | null;
153
+ /** Whether the end date is hidden in the formatted date and time. */
154
+ hideEndDate?: boolean | null;
155
+ /** Whether the time zone is displayed in the formatted schedule. */
156
+ showTimeZone?: boolean | null;
157
+ /** @readonly */
158
+ recurrenceStatus?: RecurrenceStatusStatus;
159
+ /** Event repetitions. */
160
+ recurringEvents?: Recurrences;
161
+ /** Formatted date and time settings. */
162
+ formatted?: Formatted;
163
+ }
164
+ export declare enum RecurrenceStatusStatus {
165
+ /** Default value. This value is unused. */
166
+ UNKNOWN_STATUS = "UNKNOWN_STATUS",
167
+ /** Event happens only once. */
168
+ ONE_TIME = "ONE_TIME",
169
+ /** Event is repeating and has a list of scheduled repetitions. */
170
+ RECURRING = "RECURRING",
171
+ /** An upcoming event from the list of repetitions. */
172
+ RECURRING_UPCOMING = "RECURRING_UPCOMING",
173
+ /** Latest ended event from the list of repetitions. */
174
+ RECURRING_RECENTLY_ENDED = "RECURRING_RECENTLY_ENDED",
175
+ /** Latest cancelled event from the list of repetitions. */
176
+ RECURRING_RECENTLY_CANCELED = "RECURRING_RECENTLY_CANCELED"
177
+ }
178
+ export interface Recurrences {
179
+ individualEventDates?: Occurrence[];
180
+ /**
181
+ * Recurring event category ID.
182
+ * @readonly
183
+ */
184
+ categoryId?: string | null;
185
+ }
186
+ export interface Occurrence {
187
+ /** Event start date in `yyyy-mm-ddThh:mm:sssZ` format. */
188
+ startDate?: Date;
189
+ /** Event end date in `yyyy-mm-ddThh:mm:sssZ` format. */
190
+ endDate?: Date;
191
+ /** Event time zone ID in the [TZ database](https://www.iana.org/time-zones) format. */
192
+ timeZoneId?: string | null;
193
+ /** Whether the time zone is displayed in a formatted schedule. */
194
+ showTimeZone?: boolean;
195
+ }
196
+ export interface Formatted {
197
+ /** @readonly */
198
+ dateAndTime?: string | null;
199
+ /**
200
+ * Formatted start date of the event. Empty for TBD schedules.
201
+ * @readonly
202
+ */
203
+ startDate?: string | null;
204
+ /**
205
+ * Formatted start time of the event. Empty for TBD schedules.
206
+ * @readonly
207
+ */
208
+ startTime?: string | null;
209
+ /**
210
+ * Formatted end date of the event. Empty for TBD schedules or when the end date is hidden.
211
+ * @readonly
212
+ */
213
+ endDate?: string | null;
214
+ /**
215
+ * Formatted end time of the event. Empty for TBD schedules or when the end date is hidden.
216
+ * @readonly
217
+ */
218
+ endTime?: string | null;
219
+ }
220
+ export declare enum Status {
221
+ /** Default value. This value is unused */
222
+ UNKNOWN_EVENT_STATUS = "UNKNOWN_EVENT_STATUS",
223
+ /** Event is public and scheduled to start */
224
+ UPCOMING = "UPCOMING",
225
+ /** Event has started */
226
+ STARTED = "STARTED",
227
+ /** Event has ended */
228
+ ENDED = "ENDED",
229
+ /** Event is canceled */
230
+ CANCELED = "CANCELED",
231
+ /** Event is not public */
232
+ DRAFT = "DRAFT"
233
+ }
234
+ export interface Registration {
235
+ /** @readonly */
236
+ type?: RegistrationTypeType;
237
+ /** @readonly */
238
+ status?: RegistrationStatusStatus;
239
+ /** RSVP registration details. */
240
+ rsvp?: RsvpRegistration;
241
+ /** Ticket registration details. */
242
+ tickets?: TicketsRegistration;
243
+ /** External registration details. */
244
+ external?: ExternalRegistration;
245
+ allowedGuestTypes?: GuestTypeType;
246
+ initialType?: InitialRegistrationTypeType;
247
+ /** Whether the registration is paused. */
248
+ registrationPaused?: boolean;
249
+ /** Whether the registration is disabled. */
250
+ registrationDisabled?: boolean;
251
+ }
252
+ export declare enum RegistrationTypeType {
253
+ /** Default value. This value is unused */
254
+ UNKNOWN_REGISTRATION_TYPE = "UNKNOWN_REGISTRATION_TYPE",
255
+ /** Registration via RSVP */
256
+ RSVP = "RSVP",
257
+ /** Registration via ticket purchase */
258
+ TICKETING = "TICKETING",
259
+ /** External registration */
260
+ EXTERNAL = "EXTERNAL",
261
+ /** Registration not available */
262
+ NONE = "NONE"
263
+ }
264
+ export declare enum RegistrationStatusStatus {
265
+ /** Registration status is not applicable */
266
+ UNKNOWN_REGISTRATION_STATUS = "UNKNOWN_REGISTRATION_STATUS",
267
+ /** Registration to event is closed */
268
+ CLOSED_AUTOMATICALLY = "CLOSED_AUTOMATICALLY",
269
+ /** Registration to event is closed manually */
270
+ CLOSED_MANUALLY = "CLOSED_MANUALLY",
271
+ /** Registration is open via RSVP */
272
+ OPEN_RSVP = "OPEN_RSVP",
273
+ /** Registration to event waitlist is open via RSVP */
274
+ OPEN_RSVP_WAITLIST_ONLY = "OPEN_RSVP_WAITLIST_ONLY",
275
+ /** Registration is open via ticket purchase */
276
+ OPEN_TICKETS = "OPEN_TICKETS",
277
+ /** Registration is open via external URL */
278
+ OPEN_EXTERNAL = "OPEN_EXTERNAL",
279
+ /** Registration will be open via RSVP */
280
+ SCHEDULED_RSVP = "SCHEDULED_RSVP"
281
+ }
282
+ export interface RsvpRegistration {
283
+ responseType?: ResponseType;
284
+ /** How many guests can RSVP to an event. */
285
+ limit?: number | null;
286
+ /** Whether a waitlist is opened when the total guest limit is reached. If `true`, guests can RSVP to an event and are automatically put in the waitlist with the `IN_WAITLIST` status. */
287
+ waitlistEnabled?: boolean;
288
+ /** Registration start date in `yyyy-mm-ddThh:mm:sssZ` format. */
289
+ startDate?: Date;
290
+ /** Registration end date in `yyyy-mm-ddThh:mm:sssZ` format. */
291
+ endDate?: Date;
292
+ }
293
+ export declare enum ResponseType {
294
+ /** Default value. This value is unused. */
295
+ UNKNOWN_RESPONSE_TYPE = "UNKNOWN_RESPONSE_TYPE",
296
+ /** Only a **Yes** answer is available for the registration. */
297
+ YES_ONLY = "YES_ONLY",
298
+ /** *Yes** and **No** answers are available for the registration. */
299
+ YES_AND_NO = "YES_AND_NO"
300
+ }
301
+ export interface TicketsRegistration {
302
+ /** Whether the registration form must be filled out separately for each ticket. */
303
+ guestsAssignedSeparately?: boolean;
304
+ ticketLimitPerOrder?: number;
305
+ /** Ticket price currency. */
306
+ currency?: string | null;
307
+ /**
308
+ * Lowest ticket price.
309
+ * @readonly
310
+ */
311
+ lowestPrice?: Money;
312
+ /**
313
+ * Highest ticket price.
314
+ * @readonly
315
+ */
316
+ highestPrice?: Money;
317
+ /**
318
+ * Whether all tickets are sold for the event.
319
+ * @readonly
320
+ */
321
+ soldOut?: boolean | null;
322
+ /** How tax is applied. */
323
+ taxSettings?: TaxSettings;
324
+ }
325
+ /**
326
+ * Money.
327
+ * Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.
328
+ */
329
+ export interface Money {
330
+ /** Amount of money in decimal form. A period is used as a decimal separator (for example, `3.99`). */
331
+ value?: string;
332
+ /** Currency code in 3-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. */
333
+ currency?: string;
334
+ /**
335
+ * Amount of money in decimal form. A period or comma are used as a decimal separator (for example, `1 000,30`).
336
+ * @readonly
337
+ */
338
+ formattedValue?: string | null;
339
+ }
340
+ export interface TaxSettings {
341
+ type?: TaxType;
342
+ name?: string | null;
343
+ rate?: string | null;
344
+ /** Apply tax to donations. */
345
+ appliedToDonations?: boolean | null;
346
+ }
347
+ export declare enum TaxType {
348
+ /** Default value. This value is unused. */
349
+ UNKNOWN_TAX_TYPE = "UNKNOWN_TAX_TYPE",
350
+ /** Tax is included in the ticket price */
351
+ INCLUDED_IN_PRICE = "INCLUDED_IN_PRICE",
352
+ /** Tax is added to the final total at the checkout */
353
+ ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
354
+ }
355
+ export interface ExternalRegistration {
356
+ /** External event registration URL. */
357
+ url?: string | null;
358
+ }
359
+ export declare enum GuestTypeType {
360
+ /** Default value. This value is unused */
361
+ UNKNOWN_GUEST_TYPE = "UNKNOWN_GUEST_TYPE",
362
+ /** Site visitor or member */
363
+ VISITOR_OR_MEMBER = "VISITOR_OR_MEMBER",
364
+ /** Site member */
365
+ MEMBER = "MEMBER"
366
+ }
367
+ export declare enum InitialRegistrationTypeType {
368
+ /** Default value. This value is unused */
369
+ UNKNOWN_INITIAL_REGISTRATION_TYPE = "UNKNOWN_INITIAL_REGISTRATION_TYPE",
370
+ /** Registration via RSVP */
371
+ RSVP = "RSVP",
372
+ /** Registration via ticket purchase */
373
+ TICKETING = "TICKETING"
374
+ }
375
+ export interface CalendarUrls {
376
+ /**
377
+ * "Add to Google calendar" URL.
378
+ * @readonly
379
+ */
380
+ google?: string;
381
+ /**
382
+ * "Download ICS calendar file" URL.
383
+ * @readonly
384
+ */
385
+ ics?: string;
386
+ }
387
+ /**
388
+ * The form defines which elements are rendered in the Wix UI during the registration process (RSVP or checkout).
389
+ * It also contains customizable messages and labels.
390
+ *
391
+ *
392
+ * A form is an ordered list of controls (blocks), which accept guest information into a field input.
393
+ *
394
+ * Each control contains one or more nested inputs. For example, `Name` control has two inputs:
395
+ * - First Name
396
+ * - Last Name
397
+ *
398
+ * By default, name and email controls are always required and are pinned to the top of the form.
399
+ */
400
+ export interface Form {
401
+ /** Nested fields as an ordered list. */
402
+ controls?: InputControl[];
403
+ /** Set of configured form messages. */
404
+ messages?: FormMessages;
405
+ }
406
+ /**
407
+ * A block of nested fields.
408
+ * Used to aggregate similar inputs like First Name and Last Name.
409
+ */
410
+ export interface InputControl {
411
+ /** Field control type. */
412
+ type?: InputControlType;
413
+ /** Whether control is mandatory (such as name & email). When true, only label can be changed. */
414
+ system?: boolean;
415
+ /** Deprecated: Use `id`. */
416
+ name?: string;
417
+ /** Child inputs. */
418
+ inputs?: Input[];
419
+ /** Deprecated: use `inputs.label`. */
420
+ label?: string;
421
+ /** Field controls are sorted by this value in ascending order. */
422
+ orderIndex?: number;
423
+ /** Unique control ID. */
424
+ _id?: string;
425
+ }
426
+ export declare enum InputControlType {
427
+ /** Single text value field. */
428
+ INPUT = "INPUT",
429
+ /** Single text value field. */
430
+ TEXTAREA = "TEXTAREA",
431
+ /** Single-choice field of predefined values. */
432
+ DROPDOWN = "DROPDOWN",
433
+ /** Single-choice field of predefined values. */
434
+ RADIO = "RADIO",
435
+ /** Multiple-choice field of predefined values. */
436
+ CHECKBOX = "CHECKBOX",
437
+ /** First and last name fields. */
438
+ NAME = "NAME",
439
+ /** Additional guests and respective guest names fields. */
440
+ GUEST_CONTROL = "GUEST_CONTROL",
441
+ /** Single-line address field. */
442
+ ADDRESS_SHORT = "ADDRESS_SHORT",
443
+ /** Full address field. */
444
+ ADDRESS_FULL = "ADDRESS_FULL",
445
+ /** Year, month and day fields. */
446
+ DATE = "DATE"
447
+ }
448
+ /** An input of one or multiple text values */
449
+ export interface Input {
450
+ /** Field name. */
451
+ name?: string;
452
+ /** Deprecated: use `ValueType.TEXT_ARRAY`. */
453
+ array?: boolean;
454
+ /** Main field label */
455
+ label?: string;
456
+ /** Additional labels for multi-valued fields such as address. */
457
+ additionalLabels?: Record<string, string>;
458
+ /** Predefined choice options for fields, such as dropdown. */
459
+ options?: string[];
460
+ /** Whether field is mandatory. */
461
+ mandatory?: boolean;
462
+ /** Maximum number of accepted characters (relevant for text fields). */
463
+ maxLength?: number;
464
+ /**
465
+ * Type which determines field format.
466
+ * Used to validate submitted response.
467
+ */
468
+ type?: ValueType;
469
+ /**
470
+ * A maximum accepted values for array input.
471
+ * Only applicable for inputs of valueType: TEXT_ARRAY.
472
+ */
473
+ maxSize?: number | null;
474
+ /**
475
+ * Preselected option.
476
+ * Currently only applicable for dropdown.
477
+ */
478
+ defaultOptionSelection?: OptionSelection;
479
+ /**
480
+ * Additional labels for multi-valued fields such as address.
481
+ * @readonly
482
+ */
483
+ labels?: Label[];
484
+ }
485
+ export declare enum ValueType {
486
+ TEXT = "TEXT",
487
+ NUMBER = "NUMBER",
488
+ TEXT_ARRAY = "TEXT_ARRAY",
489
+ DATE_TIME = "DATE_TIME",
490
+ ADDRESS = "ADDRESS"
491
+ }
492
+ /**
493
+ * Describes initially selected option when an input has multiple choices.
494
+ * Defaults to first (0th) option if not configured.
495
+ */
496
+ export interface OptionSelection extends OptionSelectionSelectedOptionOneOf {
497
+ /** 0-based index from predefined `input.options` which is selected initially. */
498
+ optionIndex?: number;
499
+ /**
500
+ * Placeholder hint describing expected choices (such as "Please select").
501
+ * Considered an empty choice.
502
+ */
503
+ placeholderText?: string;
504
+ }
505
+ /** @oneof */
506
+ export interface OptionSelectionSelectedOptionOneOf {
507
+ /** 0-based index from predefined `input.options` which is selected initially. */
508
+ optionIndex?: number;
509
+ /**
510
+ * Placeholder hint describing expected choices (such as "Please select").
511
+ * Considered an empty choice.
512
+ */
513
+ placeholderText?: string;
514
+ }
515
+ export interface Label {
516
+ /** Field name. */
517
+ name?: string;
518
+ /** Field label. */
519
+ label?: string;
520
+ }
521
+ /**
522
+ * Defines form messages shown in UI before, during, and after registration flow.
523
+ * It enables configuration of form titles, response labels, "thank you" messages, and call-to-action texts.
524
+ */
525
+ export interface FormMessages {
526
+ /** RSVP form messages. */
527
+ rsvp?: RsvpFormMessages;
528
+ /** Checkout form messages. */
529
+ checkout?: CheckoutFormMessages;
530
+ /** Messages shown when event registration is closed. */
531
+ registrationClosed?: RegistrationClosedMessages;
532
+ /** Messages shown when event tickets are unavailable. */
533
+ ticketsUnavailable?: TicketsUnavailableMessages;
534
+ }
535
+ export interface RsvpFormMessages {
536
+ /** Label text indicating RSVP `YES` response. */
537
+ rsvpYesOption?: string;
538
+ /** Label text indicating RSVP `NO` response. */
539
+ rsvpNoOption?: string;
540
+ /** Messages shown for RSVP = `YES`. */
541
+ positiveMessages?: Positive;
542
+ /** Messages shown for RSVP = `WAITING` (when event is full and waitlist is available). */
543
+ waitlistMessages?: Positive;
544
+ /** Messages shown for RSVP = `NO`. */
545
+ negativeMessages?: Negative;
546
+ /** "Submit form" call-to-action label text. */
547
+ submitActionLabel?: string;
548
+ }
549
+ /** Confirmation messages shown after registration. */
550
+ export interface PositiveResponseConfirmation {
551
+ /** Confirmation message title. */
552
+ title?: string;
553
+ /** Confirmation message text. */
554
+ message?: string;
555
+ /** "Add to calendar" call-to-action label text. */
556
+ addToCalendarActionLabel?: string;
557
+ /** "Share event" call-to-action label text. */
558
+ shareActionLabel?: string;
559
+ }
560
+ /** Confirmation messages shown after registration. */
561
+ export interface NegativeResponseConfirmation {
562
+ /** Confirmation message title. */
563
+ title?: string;
564
+ /** "Share event" call-to-action label text. */
565
+ shareActionLabel?: string;
566
+ }
567
+ /** Set of messages shown during registration when RSVP response is positive. */
568
+ export interface Positive {
569
+ /** Main form title for positive response. */
570
+ title?: string;
571
+ /** Confirmation messages shown after registration. */
572
+ confirmation?: PositiveResponseConfirmation;
573
+ }
574
+ /** A set of messages shown during registration with negative response */
575
+ export interface Negative {
576
+ /** Main form title for negative response. */
577
+ title?: string;
578
+ /** Confirmation messages shown after registration. */
579
+ confirmation?: NegativeResponseConfirmation;
580
+ }
581
+ export interface CheckoutFormMessages {
582
+ /** Main form title for response. */
583
+ title?: string;
584
+ /** Submit form call-to-action label text. */
585
+ submitActionLabel?: string;
586
+ /** Confirmation messages shown after checkout. */
587
+ confirmation?: ResponseConfirmation;
588
+ }
589
+ /** Confirmation messages shown after checkout. */
590
+ export interface ResponseConfirmation {
591
+ /** Confirmation message title. */
592
+ title?: string;
593
+ /** Confirmation message text. */
594
+ message?: string;
595
+ /** "Download tickets" call-to-action label text. */
596
+ downloadTicketsLabel?: string;
597
+ /** "Add to calendar" call-to-action label text. */
598
+ addToCalendarLabel?: string;
599
+ /** "Share event" call-to-action label text. */
600
+ shareEventLabel?: string;
601
+ }
602
+ export interface RegistrationClosedMessages {
603
+ /** Message shown when event registration is closed. */
604
+ message?: string;
605
+ /** "Explore other events" call-to-action label text. */
606
+ exploreEventsActionLabel?: string;
607
+ }
608
+ export interface TicketsUnavailableMessages {
609
+ /** Message shown when event tickets are unavailable. */
610
+ message?: string;
611
+ /** "Explore other events" call-to-action label text. */
612
+ exploreEventsActionLabel?: string;
613
+ }
614
+ export interface Summaries {
615
+ /** RSVP summary of guests. */
616
+ rsvps?: Rsvps;
617
+ /** Summary of revenue and sold tickets. Archived orders are not included. */
618
+ tickets?: Tickets;
619
+ }
620
+ export interface EventsMoney {
621
+ /** *Deprecated:** Use `value` instead. */
622
+ amount?: string;
623
+ /** ISO 4217 format of the currency i.e. `USD`. */
624
+ currency?: string;
625
+ /** 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. */
626
+ value?: string | null;
627
+ }
628
+ export interface Rsvps {
629
+ /**
630
+ * Total number of RSVPs.
631
+ * @readonly
632
+ */
633
+ totalCount?: number;
634
+ /**
635
+ * Number of RSVPs with status `YES`.
636
+ * @readonly
637
+ */
638
+ yesCount?: number;
639
+ /**
640
+ * Number of RSVPs with status `NO`.
641
+ * @readonly
642
+ */
643
+ noCount?: number;
644
+ /**
645
+ * Number of RSVPs in a waitlist.
646
+ * @readonly
647
+ */
648
+ waitlistCount?: number;
649
+ }
650
+ export interface Tickets {
651
+ /**
652
+ * Number of sold tickets.
653
+ * @readonly
654
+ */
655
+ ticketsSold?: number;
656
+ /**
657
+ * Total revenue. Taxes and payment provider fees aren't deducted.
658
+ * @readonly
659
+ */
660
+ revenue?: EventsMoney;
661
+ /**
662
+ * Whether the currency is locked and can’t be changed.
663
+ * @readonly
664
+ */
665
+ currencyLocked?: boolean;
666
+ /**
667
+ * Number of orders placed.
668
+ * @readonly
669
+ */
670
+ totalOrders?: number;
671
+ /**
672
+ * Total balance of confirmed transactions.
673
+ * @readonly
674
+ */
675
+ totalSales?: EventsMoney;
676
+ }
677
+ export interface GuestListSettings {
678
+ /** Whether the guest list is public for all guests. */
679
+ displayedPublicly?: boolean;
680
+ }
681
+ export interface Feed {
682
+ /** Event discussion feed token. */
683
+ token?: string;
684
+ }
685
+ export interface OnlineConferencing {
686
+ /** Whether online conferencing is enabled. Not applicable for events, where date and time are TBD. When enabled, links to join the conference are generated and provided to guests. */
687
+ enabled?: boolean;
688
+ /** Conference host ID. */
689
+ providerId?: string | null;
690
+ type?: ConferenceTypeType;
691
+ /** Online conferencing session information. */
692
+ session?: OnlineConferencingSession;
693
+ }
694
+ export declare enum ConferenceTypeType {
695
+ /** Default value. This value is unused */
696
+ UNKNOWN_CONFERENCE_TYPE = "UNKNOWN_CONFERENCE_TYPE",
697
+ /** Guests can publish and subscribe to video and audio. */
698
+ MEETING = "MEETING",
699
+ /** Guests can only subscribe to video and audio. */
700
+ WEBINAR = "WEBINAR"
701
+ }
702
+ export interface OnlineConferencingSession {
703
+ /**
704
+ * Link for the event host to start the online conference session.
705
+ * @readonly
706
+ */
707
+ hostLink?: string;
708
+ /**
709
+ * Link for guests to join the online conference session.
710
+ * @readonly
711
+ */
712
+ guestLink?: string;
713
+ /**
714
+ * Password required to join the online conferencing session (when relevant).
715
+ * @readonly
716
+ */
717
+ password?: string | null;
718
+ /**
719
+ * Whether the session was created successfully on the event host side.
720
+ * @readonly
721
+ */
722
+ sessionCreated?: boolean | null;
723
+ /**
724
+ * Unique session ID.
725
+ * @readonly
726
+ */
727
+ sessionId?: string | null;
728
+ }
729
+ export interface SeoSettings {
730
+ /** URL slug. */
731
+ slug?: string;
732
+ /** Advanced SEO data. */
733
+ advancedSeoData?: SeoSchema;
734
+ /**
735
+ * Whether the slug is hidden from the SEO Site Map.
736
+ * @readonly
737
+ */
738
+ hidden?: boolean | null;
739
+ }
740
+ /**
741
+ * The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.
742
+ * The search engines use this information for ranking purposes, or to display snippets in the search results.
743
+ * This data will override other sources of tags (for example patterns) and will be included in the <head> section of the HTML document, while not being displayed on the page itself.
744
+ */
745
+ export interface SeoSchema {
746
+ /** SEO tag information. */
747
+ tags?: Tag[];
748
+ /** SEO general settings. */
749
+ settings?: Settings;
750
+ }
751
+ export interface Keyword {
752
+ /** Keyword value. */
753
+ term?: string;
754
+ /** Whether the keyword is the main focus keyword. */
755
+ isMain?: boolean;
756
+ }
757
+ export interface Tag {
758
+ /**
759
+ * SEO tag type.
760
+ *
761
+ *
762
+ * Supported values: `title`, `meta`, `script`, `link`.
763
+ */
764
+ type?: string;
765
+ /**
766
+ * A `{'key':'value'}` pair object where each SEO tag property (`'name'`, `'content'`, `'rel'`, `'href'`) contains a value.
767
+ * For example: `{'name': 'description', 'content': 'the description itself'}`.
768
+ */
769
+ props?: Record<string, any> | null;
770
+ /** SEO tag meta data. For example, `{height: 300, width: 240}`. */
771
+ meta?: Record<string, any> | null;
772
+ /** SEO tag inner content. For example, `<title> inner content </title>`. */
773
+ children?: string;
774
+ /** Whether the tag is a custom tag. */
775
+ custom?: boolean;
776
+ /** Whether the tag is disabled. */
777
+ disabled?: boolean;
778
+ }
779
+ export interface Settings {
780
+ /**
781
+ * Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.
782
+ *
783
+ *
784
+ * Default: `false` (Auto Redirect is enabled.)
785
+ */
786
+ preventAutoRedirect?: boolean;
787
+ /** User-selected keyword terms for a specific page. */
788
+ keywords?: Keyword[];
789
+ }
790
+ export interface AgendaSettings {
791
+ /** Whether the schedule is enabled for the event. */
792
+ enabled?: boolean;
793
+ /**
794
+ * Schedule page URL.
795
+ * @readonly
796
+ */
797
+ pageUrl?: string;
798
+ }
799
+ export interface EventCategories {
800
+ /** Event categories. */
801
+ categories?: EventCategory[];
802
+ }
803
+ export interface EventCategory {
804
+ /**
805
+ * Category ID.
806
+ * @readonly
807
+ */
808
+ _id?: string;
809
+ /** Category name. */
810
+ name?: string;
811
+ /**
812
+ * Category creation timestamp.
813
+ * @readonly
814
+ */
815
+ _createdDate?: Date;
816
+ /**
817
+ * Category is hidden.
818
+ * @readonly
819
+ */
820
+ hidden?: boolean;
821
+ /**
822
+ * Category type.
823
+ * @readonly
824
+ */
825
+ type?: Type;
826
+ }
827
+ export declare enum Type {
828
+ /** Created manually by the user. */
829
+ MANUAL = "MANUAL",
830
+ /** Created automatically when publishing recurring events. */
831
+ RECURRING_EVENT = "RECURRING_EVENT",
832
+ /** Created automatically and used to store component events. */
833
+ COMPONENT = "COMPONENT"
834
+ }
835
+ export interface EventDisplaySettings {
836
+ /** Whether event details button is hidden. Only available for events with no registration. */
837
+ hideEventDetailsButton?: boolean | null;
838
+ }
839
+ export interface V3EventStarted {
840
+ /** Event schedule configuration. */
841
+ timestamp?: Date;
842
+ /** Event ID. */
843
+ eventId?: string;
844
+ }
845
+ export interface V3EventReminder {
846
+ /** Reminder timestamp in ISO UTC format. */
847
+ timestamp?: Date;
848
+ /** Event ID. */
849
+ eventId?: string;
850
+ /** Event location. */
851
+ location?: Location;
852
+ /** Event schedule configuration. */
853
+ dateAndTimeSettings?: DateAndTimeSettings;
854
+ /** Event title. */
855
+ title?: string;
856
+ /** ID of the user who created the event. */
857
+ userId?: string | null;
858
+ /** Time until the event starts (currently, reminder letter is triggered 1 day before event starts). */
859
+ startsIn?: TimeDuration;
860
+ }
861
+ /**
862
+ * A coarse-grained representation of time duration divided into whole constituting components of days, hours, and minutes.
863
+ * For example, 25.5 hours duration is represented as `{ days: 1, hours: 1, minutes: 30 }`.
864
+ */
865
+ export interface TimeDuration {
866
+ /** Number of days */
867
+ days?: number;
868
+ /** Number of hours */
869
+ hours?: number;
870
+ /** Number of minutes */
871
+ minutes?: number;
872
+ }
873
+ export interface V3EventEnded {
874
+ /** Event end timestamp in ISO UTC format. */
875
+ timestamp?: Date;
876
+ /** Event ID. */
877
+ eventId?: string;
878
+ }
879
+ export interface CreateEventRequest {
880
+ /** Event data. */
881
+ event: Event;
882
+ /** Whether to create the event as a draft. */
883
+ draft?: boolean;
884
+ /**
885
+ * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
886
+ * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
887
+ * - `TEXTS`: Returns `detailedDescription`.
888
+ * - `REGISTRATION`: Returns `registration`.
889
+ * - `URLS`: Returns `eventPageUrl`.
890
+ * - `FORM`: Returns `form`.
891
+ * - `DASHBOARD`: Returns `summaries`.
892
+ * - `FEED`: Returns `feed`.
893
+ * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
894
+ * - `SEO_SETTINGS`: Returns `seoSettings`.
895
+ * - `AGENDA`: Returns `agendaSettings`.
896
+ * - `CATEGORIES`: Returns `categories`.
897
+ */
898
+ fields?: RequestedFields[];
899
+ }
900
+ export declare enum RequestedFields {
901
+ UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
902
+ /** Include `description`, `mainImage` and `calendarLinks` in the response. */
903
+ DETAILS = "DETAILS",
904
+ /** Include `about` event rich text in the response. */
905
+ TEXTS = "TEXTS",
906
+ /** Include `registration` in the response. */
907
+ REGISTRATION = "REGISTRATION",
908
+ /** Include `eventPageUrl` in the response. */
909
+ URLS = "URLS",
910
+ /** Include `form` in the response. */
911
+ FORM = "FORM",
912
+ /** Include `dashboard` in the response. */
913
+ DASHBOARD = "DASHBOARD",
914
+ /** Include `feed` in the response. */
915
+ FEED = "FEED",
916
+ /** Include `onlineConferencing` in the response. */
917
+ ONLINE_CONFERENCING_SESSION = "ONLINE_CONFERENCING_SESSION",
918
+ /** Include `seoSettings` in the response. */
919
+ SEO_SETTINGS = "SEO_SETTINGS",
920
+ /** Include `agendaSettings` in the response. */
921
+ AGENDA = "AGENDA",
922
+ /** Include `categories` in the response. */
923
+ CATEGORIES = "CATEGORIES",
924
+ CUSTOMIZABLE_TICKETS = "CUSTOMIZABLE_TICKETS"
925
+ }
926
+ export interface CreateEventResponse {
927
+ /** Created event. */
928
+ event?: Event;
929
+ }
930
+ export interface V3EventPublished {
931
+ /** Event publishing timestamp in ISO UTC format. */
932
+ timestamp?: Date;
933
+ /** Event ID. */
934
+ eventId?: string;
935
+ /** Event status. */
936
+ status?: Status;
937
+ /**
938
+ * Event ID. Indicates the original event from which the current event was derived from.
939
+ * Can be used to track the original event and add missing information.
940
+ */
941
+ derivedFromEventId?: string | null;
942
+ }
943
+ export interface CloneEventRequest {
944
+ /** Event ID. */
945
+ eventId: string;
946
+ /** Field values to be changed when cloning the event. */
947
+ event?: Event;
948
+ /** Whether to clone the event as a draft. */
949
+ draft?: boolean;
950
+ /**
951
+ * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
952
+ * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
953
+ * - `TEXTS`: Returns `detailedDescription`.
954
+ * - `REGISTRATION`: Returns `registration`.
955
+ * - `URLS`: Returns `eventPageUrl`.
956
+ * - `FORM`: Returns `form`.
957
+ * - `DASHBOARD`: Returns `summaries`.
958
+ * - `FEED`: Returns `feed`.
959
+ * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
960
+ * - `SEO_SETTINGS`: Returns `seoSettings`.
961
+ * - `AGENDA`: Returns `agendaSettings`.
962
+ * - `CATEGORIES`: Returns `categories`.
963
+ */
964
+ fields?: RequestedFields[];
965
+ }
966
+ export interface CloneEventResponse {
967
+ /** Cloned event. */
968
+ event?: Event;
969
+ }
970
+ export interface EventCloned {
971
+ /** Event creation timestamp in ISO UTC format. */
972
+ timestamp?: Date;
973
+ /** Event ID. */
974
+ eventId?: string;
975
+ /** Event location. */
976
+ location?: Location;
977
+ /** Event date and time settings. */
978
+ dateAndTimeSettings?: DateAndTimeSettings;
979
+ /** Event title. */
980
+ title?: string;
981
+ /** ID of the user who created the event. */
982
+ userId?: string | null;
983
+ /** Event status. */
984
+ status?: Status;
985
+ /** Instance ID. Indicates the original app instance from which current event was derived from. */
986
+ derivedFromInstanceId?: string | null;
987
+ /** Event ID. Indicates the original event from which current event was derived from. */
988
+ derivedFromEventId?: string | null;
989
+ /**
990
+ * Map of copied ticket definitions from the original event.
991
+ * Key represents ticket definition ID in the original event.
992
+ * Value represents ticket definition ID in the newly event.
993
+ */
994
+ ticketDefinitions?: Record<string, string>;
995
+ }
996
+ export interface UpdateEventRequest {
997
+ /** Field values to be changed. */
998
+ event?: Event;
999
+ /**
1000
+ * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
1001
+ * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
1002
+ * - `TEXTS`: Returns `detailedDescription`.
1003
+ * - `REGISTRATION`: Returns `registration`.
1004
+ * - `URLS`: Returns `eventPageUrl`.
1005
+ * - `FORM`: Returns `form`.
1006
+ * - `DASHBOARD`: Returns `summaries`.
1007
+ * - `FEED`: Returns `feed`.
1008
+ * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
1009
+ * - `SEO_SETTINGS`: Returns `seoSettings`.
1010
+ * - `AGENDA`: Returns `agendaSettings`.
1011
+ * - `CATEGORIES`: Returns `categories`.
1012
+ */
1013
+ fields?: RequestedFields[];
1014
+ }
1015
+ export interface UpdateEventResponse {
1016
+ /** Updated event. */
1017
+ event?: Event;
1018
+ }
1019
+ export interface PublishDraftEventRequest {
1020
+ /** Event ID. */
1021
+ eventId: string;
1022
+ /**
1023
+ * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
1024
+ * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
1025
+ * - `TEXTS`: Returns `detailedDescription`.
1026
+ * - `REGISTRATION`: Returns `registration`.
1027
+ * - `URLS`: Returns `eventPageUrl`.
1028
+ * - `FORM`: Returns `form`.
1029
+ * - `DASHBOARD`: Returns `summaries`.
1030
+ * - `FEED`: Returns `feed`.
1031
+ * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
1032
+ * - `SEO_SETTINGS`: Returns `seoSettings`.
1033
+ * - `AGENDA`: Returns `agendaSettings`.
1034
+ * - `CATEGORIES`: Returns `categories`.
1035
+ */
1036
+ fields?: RequestedFields[];
1037
+ }
1038
+ export interface PublishDraftEventResponse {
1039
+ /** Published event. */
1040
+ event?: Event;
1041
+ }
1042
+ export interface CancelEventRequest {
1043
+ /** Event ID. */
1044
+ eventId: string;
1045
+ /**
1046
+ * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
1047
+ * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
1048
+ * - `TEXTS`: Returns `detailedDescription`.
1049
+ * - `REGISTRATION`: Returns `registration`.
1050
+ * - `URLS`: Returns `eventPageUrl`.
1051
+ * - `FORM`: Returns `form`.
1052
+ * - `DASHBOARD`: Returns `summaries`.
1053
+ * - `FEED`: Returns `feed`.
1054
+ * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
1055
+ * - `SEO_SETTINGS`: Returns `seoSettings`.
1056
+ * - `AGENDA`: Returns `agendaSettings`.
1057
+ * - `CATEGORIES`: Returns `categories`.
1058
+ */
1059
+ fields?: RequestedFields[];
1060
+ }
1061
+ export interface CancelEventResponse {
1062
+ /** Canceled event. */
1063
+ event?: Event;
1064
+ }
1065
+ export interface V3EventCanceled {
1066
+ /** Event cancelation timestamp in ISO UTC format. */
1067
+ timestamp?: Date;
1068
+ /** Event ID. */
1069
+ eventId?: string;
1070
+ /** Event title. */
1071
+ title?: string;
1072
+ /** ID of the user who created the event. */
1073
+ userId?: string | null;
1074
+ }
1075
+ export interface BulkCancelEventsByFilterRequest {
1076
+ /** Filter. See [supported fields and operators](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-events). */
1077
+ filter?: QueryV2;
1078
+ }
1079
+ export interface QueryV2 extends QueryV2PagingMethodOneOf {
1080
+ /** Paging options. Can't be used together with `cursorPaging`. */
1081
+ paging?: Paging;
1082
+ /**
1083
+ * Filter object in the following format:
1084
+ * `"filter" : {
1085
+ * "fieldName1": "value1",
1086
+ * "fieldName2":{"$operator":"value2"}
1087
+ * }`
1088
+ */
1089
+ filter?: Record<string, any> | null;
1090
+ /**
1091
+ * Sort object in the following format:
1092
+ * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
1093
+ */
1094
+ sort?: Sorting[];
1095
+ }
1096
+ /** @oneof */
1097
+ export interface QueryV2PagingMethodOneOf {
1098
+ /** Paging options. Can't be used together with `cursorPaging`. */
1099
+ paging?: Paging;
1100
+ }
1101
+ export interface Sorting {
1102
+ /** Name of the field to sort by. */
1103
+ fieldName?: string;
1104
+ /**
1105
+ * Sort order.
1106
+ * Use `ASC` for ascending order or `DESC` for descending order.
1107
+ *
1108
+ * Default: `ASC`.
1109
+ */
1110
+ order?: SortOrder;
1111
+ }
1112
+ export declare enum SortOrder {
1113
+ ASC = "ASC",
1114
+ DESC = "DESC"
1115
+ }
1116
+ export interface Paging {
1117
+ /** Number of items to return. See [Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging#getting-started_sorting-and-paging_paging) for more information. */
1118
+ limit?: number | null;
1119
+ /** Number of items to skip in the current sort order. */
1120
+ offset?: number | null;
1121
+ }
1122
+ export interface BulkCancelEventsByFilterResponse {
1123
+ }
1124
+ export interface DeleteEventRequest {
1125
+ /** Event ID. */
1126
+ eventId: string;
1127
+ }
1128
+ export interface DeleteEventResponse {
1129
+ /** Deleted event ID. */
1130
+ eventId?: string;
1131
+ }
1132
+ export interface BulkDeleteEventsByFilterRequest {
1133
+ /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
1134
+ filter?: QueryV2;
1135
+ }
1136
+ export interface BulkDeleteEventsByFilterResponse {
1137
+ }
1138
+ export interface QueryEventsRequest {
1139
+ /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
1140
+ query?: QueryV2;
1141
+ /**
1142
+ * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
1143
+ * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
1144
+ * - `TEXTS`: Returns `detailedDescription`.
1145
+ * - `REGISTRATION`: Returns `registration`.
1146
+ * - `URLS`: Returns `eventPageUrl`.
1147
+ * - `FORM`: Returns `form`.
1148
+ * - `DASHBOARD`: Returns `summaries`.
1149
+ * - `FEED`: Returns `feed`.
1150
+ * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
1151
+ * - `SEO_SETTINGS`: Returns `seoSettings`.
1152
+ * - `AGENDA`: Returns `agendaSettings`.
1153
+ * - `CATEGORIES`: Returns `categories`.
1154
+ */
1155
+ fields?: RequestedFields[];
1156
+ /**
1157
+ * Whether draft events should be returned in the response.
1158
+ * This parameter requires the `WIX_EVENTS.MANAGE_EVENTS` permission.
1159
+ */
1160
+ includeDrafts?: boolean;
1161
+ }
1162
+ export interface QueryEventsResponse {
1163
+ /** Metadata for the paginated results. */
1164
+ pagingMetadata?: PagingMetadataV2;
1165
+ /** List of events. */
1166
+ events?: Event[];
1167
+ }
1168
+ export interface PagingMetadataV2 {
1169
+ /** Number of items to return. See [Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging#getting-started_sorting-and-paging_paging) for more information. */
1170
+ count?: number | null;
1171
+ /** Requested offset. */
1172
+ offset?: number | null;
1173
+ /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
1174
+ total?: number | null;
1175
+ /** Flag that indicates the server failed to calculate the `total` field. */
1176
+ tooManyToCount?: boolean | null;
1177
+ /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
1178
+ cursors?: Cursors;
1179
+ }
1180
+ export interface Cursors {
1181
+ /** Cursor pointing to the next page in the list of results. */
1182
+ next?: string | null;
1183
+ /** Cursor pointing to the previous page in the list of results. */
1184
+ prev?: string | null;
1185
+ }
1186
+ export interface CountEventsByStatusRequest {
1187
+ /** Filter object in the following format: <br/> `"filter" : { "fieldName1": "value1" }`. */
1188
+ filter?: Record<string, any> | null;
1189
+ /**
1190
+ * Parameters to count events by.
1191
+ *
1192
+ * - Max: 20 facets
1193
+ */
1194
+ facet?: string[];
1195
+ /**
1196
+ * Whether draft events should be returned in the response.
1197
+ * This parameter requires the `WIX_EVENTS.MANAGE_EVENTS` permission.
1198
+ */
1199
+ includeDrafts?: boolean;
1200
+ }
1201
+ export interface CountEventsByStatusResponse {
1202
+ /** Metadata for the paginated results. */
1203
+ pagingMetadata?: PagingMetadataV2;
1204
+ /** Filter facets. */
1205
+ facets?: Record<string, FacetCounts>;
1206
+ }
1207
+ export interface FacetCounts {
1208
+ /** Facet counts aggregated per value */
1209
+ counts?: Record<string, number>;
1210
+ }
1211
+ export interface ListUserEventsRequest {
1212
+ /** Paging options to limit and skip the number of items. */
1213
+ paging?: Paging;
1214
+ /**
1215
+ * Sort order, defaults to `"created:asc"`.
1216
+ * 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-events).
1217
+ */
1218
+ sort?: Sorting[];
1219
+ /** Event status. */
1220
+ status?: Status[];
1221
+ /**
1222
+ * Wix user filter, by default any.
1223
+ * Allows to filter events by user relation to the event among all wix sites.
1224
+ */
1225
+ userFilter?: UserFilter;
1226
+ /**
1227
+ * Filter facets to include in the response.
1228
+ * See [supported facets](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-events).
1229
+ */
1230
+ facet?: string[];
1231
+ }
1232
+ export interface UserFilter {
1233
+ /** User who is related to event */
1234
+ userId?: string;
1235
+ /** Relation of user to event */
1236
+ relation?: Relation[];
1237
+ }
1238
+ export declare enum Relation {
1239
+ /**
1240
+ * User is attending the event.
1241
+ * User has RSVP with status YES or has ordered tickets.
1242
+ */
1243
+ ATTENDING = "ATTENDING"
1244
+ }
1245
+ export interface ListUserEventsResponse {
1246
+ /** Metadata for the paginated results. */
1247
+ pagingMetadata?: PagingMetadataV2;
1248
+ /** List of events. */
1249
+ events?: Event[];
1250
+ /** Filter facets. */
1251
+ facets?: Record<string, FacetCounts>;
1252
+ }
1253
+ export interface ListEventsByCategoryRequest {
1254
+ /** Category ID. */
1255
+ categoryId?: string;
1256
+ /** Paging options to limit and skip the number of items. */
1257
+ paging?: Paging;
1258
+ /**
1259
+ * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
1260
+ * - `DETAILS`: Returns `shortDescription`, `mainImage`, and `calendarUrls`.
1261
+ * - `TEXTS`: Returns `detailedDescription`.
1262
+ * - `REGISTRATION`: Returns `registration`.
1263
+ * - `URLS`: Returns `eventPageUrl`.
1264
+ * - `FORM`: Returns `form`.
1265
+ * - `DASHBOARD`: Returns `summaries`.
1266
+ * - `FEED`: Returns `feed`.
1267
+ * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
1268
+ * - `SEO_SETTINGS`: Returns `seoSettings`.
1269
+ * - `AGENDA`: Returns `agendaSettings`.
1270
+ * - `CATEGORIES`: Returns `categories`.
1271
+ */
1272
+ fields?: RequestedFields[];
1273
+ }
1274
+ export interface ListEventsByCategoryResponse {
1275
+ /** Metadata for the paginated results. */
1276
+ pagingMetadata?: PagingMetadataV2;
1277
+ /** List of events. */
1278
+ events?: Event[];
1279
+ }
1280
+ export interface GetEventRequest {
1281
+ /** Event ID. */
1282
+ eventId: string | null;
1283
+ /**
1284
+ * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
1285
+ * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
1286
+ * - `TEXTS`: Returns `detailedDescription`.
1287
+ * - `REGISTRATION`: Returns `registration`.
1288
+ * - `URLS`: Returns `eventPageUrl`.
1289
+ * - `FORM`: Returns `form`.
1290
+ * - `DASHBOARD`: Returns `summaries`.
1291
+ * - `FEED`: Returns `feed`.
1292
+ * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
1293
+ * - `SEO_SETTINGS`: Returns `seoSettings`.
1294
+ * - `AGENDA`: Returns `agendaSettings`.
1295
+ * - `CATEGORIES`: Returns `categories`.
1296
+ */
1297
+ fields?: RequestedFields[];
1298
+ }
1299
+ export interface GetEventResponse {
1300
+ /** Event. */
1301
+ event?: Event;
1302
+ }
1303
+ export interface GetEventBySlugRequest {
1304
+ /** URL slug. */
1305
+ slug: string | null;
1306
+ /**
1307
+ * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
1308
+ * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
1309
+ * - `TEXTS`: Returns `detailedDescription`.
1310
+ * - `REGISTRATION`: Returns `registration`.
1311
+ * - `URLS`: Returns `eventPageUrl`.
1312
+ * - `FORM`: Returns `form`.
1313
+ * - `DASHBOARD`: Returns `summaries`.
1314
+ * - `FEED`: Returns `feed`.
1315
+ * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
1316
+ * - `SEO_SETTINGS`: Returns `seoSettings`.
1317
+ * - `AGENDA`: Returns `agendaSettings`.
1318
+ * - `CATEGORIES`: Returns `categories`.
1319
+ */
1320
+ fields?: RequestedFields[];
1321
+ }
1322
+ export interface GetEventBySlugResponse {
1323
+ /** Event. */
1324
+ event?: Event;
1325
+ }
1326
+ export interface FindEventRequest extends FindEventRequestFindByOneOf {
1327
+ /** Event ID. */
1328
+ eventId?: string | null;
1329
+ /** URL slug. */
1330
+ slug?: string | null;
1331
+ /**
1332
+ * Controls which event properties are returned. See [Fieldset](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_event-fieldset).
1333
+ * Some fields require additional computation that affects latency.
1334
+ * Use minimum set of required fieldset for best performance.
1335
+ */
1336
+ fields?: RequestedFields[];
1337
+ }
1338
+ /** @oneof */
1339
+ export interface FindEventRequestFindByOneOf {
1340
+ /** Event ID. */
1341
+ eventId?: string | null;
1342
+ /** URL slug. */
1343
+ slug?: string | null;
1344
+ }
1345
+ export interface FindEventResponse {
1346
+ /** Event. */
1347
+ event?: Event;
1348
+ }
1349
+ export interface EventDeleted {
1350
+ /** Event deleted timestamp in ISO UTC format. */
1351
+ timestamp?: Date;
1352
+ /** Event ID. */
1353
+ eventId?: string;
1354
+ /** Event title. */
1355
+ title?: string;
1356
+ /** Event creator user ID. */
1357
+ userId?: string | null;
1358
+ }
1359
+ export interface Empty {
1360
+ }
1361
+ export interface EventCopied {
1362
+ /** Event created timestamp in ISO UTC format. */
1363
+ timestamp?: Date;
1364
+ /** Event ID. */
1365
+ eventId?: string;
1366
+ /** Event location. */
1367
+ location?: EventsLocation;
1368
+ /** Event schedule configuration. */
1369
+ scheduleConfig?: ScheduleConfig;
1370
+ /** Event title. */
1371
+ title?: string;
1372
+ /** Event creator user ID. */
1373
+ userId?: string | null;
1374
+ /** Event status. */
1375
+ status?: EventStatus;
1376
+ /** Instance ID. Indicates the original app instance which current event was derived from. */
1377
+ derivedFromInstanceId?: string | null;
1378
+ /** Event ID. Indicates the original event which current event was derived from. */
1379
+ derivedFromEventId?: string | null;
1380
+ /**
1381
+ * Map of copied ticket definitions from original event.
1382
+ * Key represents ticket def id in the original event.
1383
+ * Value represents ticket def id in the newly created event.
1384
+ */
1385
+ ticketDefinitions?: Record<string, string>;
1386
+ }
1387
+ export interface EventsLocation {
1388
+ /** Location name. */
1389
+ name?: string | null;
1390
+ /** Location map coordinates. */
1391
+ coordinates?: MapCoordinates;
1392
+ /** Single line address representation. */
1393
+ address?: string | null;
1394
+ /** Location type. */
1395
+ type?: LocationLocationType;
1396
+ /**
1397
+ * Full address derived from formatted single line `address`.
1398
+ * When `full_address` is used to create or update the event, deprecated `address` and `coordinates` are ignored.
1399
+ * If provided `full_address` has empty `formatted_address` or `coordinates`, it will be auto-completed using Atlas service.
1400
+ *
1401
+ * Migration notes:
1402
+ * - `full_address.formatted_address` is equivalent to `address`.
1403
+ * - `full_address.geocode` is equivalent to `coordinates`.
1404
+ */
1405
+ fullAddress?: Address;
1406
+ /**
1407
+ * Defines event location as TBD (To Be Determined).
1408
+ * When event location is not yet defined, `name` is displayed instead of location address.
1409
+ * `coordinates`, `address`, `type` and `full_address` are not required when location is TBD.
1410
+ */
1411
+ tbd?: boolean | null;
1412
+ }
1413
+ export interface MapCoordinates {
1414
+ /** Latitude. */
1415
+ lat?: number;
1416
+ /** Longitude. */
1417
+ lng?: number;
1418
+ }
1419
+ export declare enum LocationLocationType {
1420
+ VENUE = "VENUE",
1421
+ ONLINE = "ONLINE"
1422
+ }
1423
+ /** Physical address */
1424
+ export interface Address extends AddressStreetOneOf {
1425
+ /** a break down of the street to number and street name */
1426
+ streetAddress?: StreetAddress;
1427
+ /** Main address line (usually street and number) as free text */
1428
+ addressLine1?: string | null;
1429
+ /** country code */
1430
+ country?: string | null;
1431
+ /** subdivision (usually state or region) code according to ISO 3166-2 */
1432
+ subdivision?: string | null;
1433
+ /** city name */
1434
+ city?: string | null;
1435
+ /** zip/postal code */
1436
+ postalCode?: string | null;
1437
+ /** Free text providing more detailed address info. Usually contains Apt, Suite, Floor */
1438
+ addressLine2?: string | null;
1439
+ /** A string containing the human-readable address of this location */
1440
+ formatted?: string | null;
1441
+ /** coordinates of the physical address */
1442
+ location?: AddressLocation;
1443
+ }
1444
+ /** @oneof */
1445
+ export interface AddressStreetOneOf {
1446
+ /** a break down of the street to number and street name */
1447
+ streetAddress?: StreetAddress;
1448
+ /** Main address line (usually street and number) as free text */
1449
+ addressLine?: string | null;
1450
+ }
1451
+ export interface StreetAddress {
1452
+ /** street number */
1453
+ number?: string;
1454
+ /** street name */
1455
+ name?: string;
1456
+ }
1457
+ export interface AddressLocation {
1458
+ /** address latitude coordinates */
1459
+ latitude?: number | null;
1460
+ /** address longitude coordinates */
1461
+ longitude?: number | null;
1462
+ }
1463
+ export interface Subdivision {
1464
+ /** subdivision short code */
1465
+ code?: string;
1466
+ /** subdivision full-name */
1467
+ name?: string;
1468
+ }
1469
+ export declare enum SubdivisionType {
1470
+ UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
1471
+ /** State */
1472
+ ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
1473
+ /** County */
1474
+ ADMINISTRATIVE_AREA_LEVEL_2 = "ADMINISTRATIVE_AREA_LEVEL_2",
1475
+ /** City/town */
1476
+ ADMINISTRATIVE_AREA_LEVEL_3 = "ADMINISTRATIVE_AREA_LEVEL_3",
1477
+ /** Neighborhood/quarter */
1478
+ ADMINISTRATIVE_AREA_LEVEL_4 = "ADMINISTRATIVE_AREA_LEVEL_4",
1479
+ /** Street/block */
1480
+ ADMINISTRATIVE_AREA_LEVEL_5 = "ADMINISTRATIVE_AREA_LEVEL_5",
1481
+ /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
1482
+ COUNTRY = "COUNTRY"
1483
+ }
1484
+ export interface ScheduleConfig {
1485
+ /**
1486
+ * Defines event as TBD (To Be Determined) schedule.
1487
+ * When event time is not yet defined, TBD message is displayed instead of event start and end times.
1488
+ * `startDate`, `endDate` and `timeZoneId` are not required when schedule is TBD.
1489
+ */
1490
+ scheduleTbd?: boolean;
1491
+ /** TBD message. */
1492
+ scheduleTbdMessage?: string | null;
1493
+ /** Event start timestamp. */
1494
+ startDate?: Date;
1495
+ /** Event end timestamp. */
1496
+ endDate?: Date;
1497
+ /** Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`. */
1498
+ timeZoneId?: string | null;
1499
+ /** Whether end date is hidden in the formatted schedule. */
1500
+ endDateHidden?: boolean;
1501
+ /** Whether time zone is displayed in formatted schedule. */
1502
+ showTimeZone?: boolean;
1503
+ /** Event recurrences. */
1504
+ recurrences?: EventsRecurrences;
1505
+ }
1506
+ export interface EventsRecurrences {
1507
+ /** Event occurrences. */
1508
+ occurrences?: EventsOccurrence[];
1509
+ /**
1510
+ * Recurring event category ID.
1511
+ * @readonly
1512
+ */
1513
+ categoryId?: string | null;
1514
+ /**
1515
+ * Recurrence status.
1516
+ * @readonly
1517
+ */
1518
+ status?: EventsRecurrenceStatusStatus;
1519
+ }
1520
+ export interface EventsOccurrence {
1521
+ /** Event start timestamp. */
1522
+ startDate?: Date;
1523
+ /** Event end timestamp. */
1524
+ endDate?: Date;
1525
+ /** Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`. */
1526
+ timeZoneId?: string | null;
1527
+ /** Whether time zone is displayed in formatted schedule. */
1528
+ showTimeZone?: boolean;
1529
+ }
1530
+ export declare enum EventsRecurrenceStatusStatus {
1531
+ /** Event occurs only once. */
1532
+ ONE_TIME = "ONE_TIME",
1533
+ /** Event is recurring. */
1534
+ RECURRING = "RECURRING",
1535
+ /** Marks the next upcoming occurrence of the recurring event. */
1536
+ RECURRING_NEXT = "RECURRING_NEXT",
1537
+ /** Marks the most recent ended occurrence of the recurring event. */
1538
+ RECURRING_LAST_ENDED = "RECURRING_LAST_ENDED",
1539
+ /** Marks the most recent canceled occurrence of the recurring event. */
1540
+ RECURRING_LAST_CANCELED = "RECURRING_LAST_CANCELED"
1541
+ }
1542
+ export declare enum EventStatus {
1543
+ /** Event is public and scheduled to start */
1544
+ SCHEDULED = "SCHEDULED",
1545
+ /** Event has started */
1546
+ STARTED = "STARTED",
1547
+ /** Event has ended */
1548
+ ENDED = "ENDED",
1549
+ /** Event was canceled */
1550
+ CANCELED = "CANCELED",
1551
+ /** Event is not public and needs to be published */
1552
+ DRAFT = "DRAFT"
1553
+ }
1554
+ export interface EventPublished {
1555
+ /** Event publish timestamp in ISO UTC format. */
1556
+ timestamp?: Date;
1557
+ /** Event ID. */
1558
+ eventId?: string;
1559
+ /** Event status. */
1560
+ status?: EventStatus;
1561
+ /**
1562
+ * Event ID. Indicates the original event which current event was derived from.
1563
+ * Can be used to track the original event and add missing information.
1564
+ */
1565
+ derivedFromEventId?: string | null;
1566
+ }
1567
+ export interface EventCanceled {
1568
+ /** Event canceled timestamp in ISO UTC format. */
1569
+ timestamp?: Date;
1570
+ /** Event ID. */
1571
+ eventId?: string;
1572
+ /** Event title */
1573
+ title?: string;
1574
+ /** Event creator user ID. */
1575
+ userId?: string | null;
1576
+ }
1577
+ export interface EventStarted {
1578
+ /** Event start timestamp in ISO UTC format. */
1579
+ timestamp?: Date;
1580
+ /** Event ID. */
1581
+ eventId?: string;
1582
+ }
1583
+ export interface EventEnded {
1584
+ /** Event end timestamp in ISO UTC format. */
1585
+ timestamp?: Date;
1586
+ /** Event ID. */
1587
+ eventId?: string;
1588
+ }
1589
+ export interface EventReminder {
1590
+ /** Reminder timestamp in ISO UTC format. */
1591
+ timestamp?: Date;
1592
+ /** Event ID. */
1593
+ eventId?: string;
1594
+ /** Event location. */
1595
+ location?: EventsLocation;
1596
+ /** Event schedule configuration. */
1597
+ scheduleConfig?: ScheduleConfig;
1598
+ /** Event title. */
1599
+ title?: string;
1600
+ /** Event creator user ID. */
1601
+ userId?: string | null;
1602
+ /** Time until the event starts (currently, reminder is triggered 1 day before event starts). */
1603
+ startsIn?: TimeDuration;
1604
+ }
1605
+ export interface CreateEventResponseNonNullableFields {
1606
+ event?: {
1607
+ _id: string;
1608
+ location?: {
1609
+ type: LocationType;
1610
+ };
1611
+ dateAndTimeSettings?: {
1612
+ recurrenceStatus: RecurrenceStatusStatus;
1613
+ recurringEvents?: {
1614
+ individualEventDates: {
1615
+ showTimeZone: boolean;
1616
+ }[];
1617
+ };
1618
+ };
1619
+ mainImage: string;
1620
+ slug: string;
1621
+ status: Status;
1622
+ registration?: {
1623
+ type: RegistrationTypeType;
1624
+ status: RegistrationStatusStatus;
1625
+ rsvp?: {
1626
+ responseType: ResponseType;
1627
+ waitlistEnabled: boolean;
1628
+ };
1629
+ tickets?: {
1630
+ guestsAssignedSeparately: boolean;
1631
+ ticketLimitPerOrder: number;
1632
+ lowestPrice?: {
1633
+ value: string;
1634
+ currency: string;
1635
+ };
1636
+ highestPrice?: {
1637
+ value: string;
1638
+ currency: string;
1639
+ };
1640
+ taxSettings?: {
1641
+ type: TaxType;
1642
+ };
1643
+ };
1644
+ allowedGuestTypes: GuestTypeType;
1645
+ initialType: InitialRegistrationTypeType;
1646
+ registrationPaused: boolean;
1647
+ registrationDisabled: boolean;
1648
+ };
1649
+ calendarUrls?: {
1650
+ google: string;
1651
+ ics: string;
1652
+ };
1653
+ eventPageUrl: string;
1654
+ form?: {
1655
+ controls: {
1656
+ type: InputControlType;
1657
+ system: boolean;
1658
+ name: string;
1659
+ inputs: {
1660
+ name: string;
1661
+ array: boolean;
1662
+ label: string;
1663
+ options: string[];
1664
+ mandatory: boolean;
1665
+ maxLength: number;
1666
+ type: ValueType;
1667
+ defaultOptionSelection?: {
1668
+ optionIndex: number;
1669
+ placeholderText: string;
1670
+ };
1671
+ labels: {
1672
+ name: string;
1673
+ label: string;
1674
+ }[];
1675
+ }[];
1676
+ label: string;
1677
+ orderIndex: number;
1678
+ _id: string;
1679
+ }[];
1680
+ messages?: {
1681
+ rsvp?: {
1682
+ rsvpYesOption: string;
1683
+ rsvpNoOption: string;
1684
+ positiveMessages?: {
1685
+ title: string;
1686
+ confirmation?: {
1687
+ title: string;
1688
+ message: string;
1689
+ addToCalendarActionLabel: string;
1690
+ shareActionLabel: string;
1691
+ };
1692
+ };
1693
+ waitlistMessages?: {
1694
+ title: string;
1695
+ confirmation?: {
1696
+ title: string;
1697
+ message: string;
1698
+ addToCalendarActionLabel: string;
1699
+ shareActionLabel: string;
1700
+ };
1701
+ };
1702
+ negativeMessages?: {
1703
+ title: string;
1704
+ confirmation?: {
1705
+ title: string;
1706
+ shareActionLabel: string;
1707
+ };
1708
+ };
1709
+ submitActionLabel: string;
1710
+ };
1711
+ checkout?: {
1712
+ title: string;
1713
+ submitActionLabel: string;
1714
+ confirmation?: {
1715
+ title: string;
1716
+ message: string;
1717
+ downloadTicketsLabel: string;
1718
+ addToCalendarLabel: string;
1719
+ shareEventLabel: string;
1720
+ };
1721
+ };
1722
+ registrationClosed?: {
1723
+ message: string;
1724
+ exploreEventsActionLabel: string;
1725
+ };
1726
+ ticketsUnavailable?: {
1727
+ message: string;
1728
+ exploreEventsActionLabel: string;
1729
+ };
1730
+ };
1731
+ };
1732
+ summaries?: {
1733
+ rsvps?: {
1734
+ totalCount: number;
1735
+ yesCount: number;
1736
+ noCount: number;
1737
+ waitlistCount: number;
1738
+ };
1739
+ tickets?: {
1740
+ ticketsSold: number;
1741
+ revenue?: {
1742
+ amount: string;
1743
+ currency: string;
1744
+ };
1745
+ currencyLocked: boolean;
1746
+ totalOrders: number;
1747
+ totalSales?: {
1748
+ amount: string;
1749
+ currency: string;
1750
+ };
1751
+ };
1752
+ };
1753
+ instanceId: string;
1754
+ guestListSettings?: {
1755
+ displayedPublicly: boolean;
1756
+ };
1757
+ userId: string;
1758
+ onlineConferencing?: {
1759
+ enabled: boolean;
1760
+ type: ConferenceTypeType;
1761
+ session?: {
1762
+ hostLink: string;
1763
+ guestLink: string;
1764
+ };
1765
+ };
1766
+ seoSettings?: {
1767
+ slug: string;
1768
+ advancedSeoData?: {
1769
+ tags: {
1770
+ type: string;
1771
+ children: string;
1772
+ custom: boolean;
1773
+ disabled: boolean;
1774
+ }[];
1775
+ settings?: {
1776
+ preventAutoRedirect: boolean;
1777
+ keywords: {
1778
+ term: string;
1779
+ isMain: boolean;
1780
+ }[];
1781
+ };
1782
+ };
1783
+ };
1784
+ agendaSettings?: {
1785
+ enabled: boolean;
1786
+ pageUrl: string;
1787
+ };
1788
+ };
1789
+ }
1790
+ export interface CloneEventResponseNonNullableFields {
1791
+ event?: {
1792
+ _id: string;
1793
+ location?: {
1794
+ type: LocationType;
1795
+ };
1796
+ dateAndTimeSettings?: {
1797
+ recurrenceStatus: RecurrenceStatusStatus;
1798
+ recurringEvents?: {
1799
+ individualEventDates: {
1800
+ showTimeZone: boolean;
1801
+ }[];
1802
+ };
1803
+ };
1804
+ mainImage: string;
1805
+ slug: string;
1806
+ status: Status;
1807
+ registration?: {
1808
+ type: RegistrationTypeType;
1809
+ status: RegistrationStatusStatus;
1810
+ rsvp?: {
1811
+ responseType: ResponseType;
1812
+ waitlistEnabled: boolean;
1813
+ };
1814
+ tickets?: {
1815
+ guestsAssignedSeparately: boolean;
1816
+ ticketLimitPerOrder: number;
1817
+ lowestPrice?: {
1818
+ value: string;
1819
+ currency: string;
1820
+ };
1821
+ highestPrice?: {
1822
+ value: string;
1823
+ currency: string;
1824
+ };
1825
+ taxSettings?: {
1826
+ type: TaxType;
1827
+ };
1828
+ };
1829
+ allowedGuestTypes: GuestTypeType;
1830
+ initialType: InitialRegistrationTypeType;
1831
+ registrationPaused: boolean;
1832
+ registrationDisabled: boolean;
1833
+ };
1834
+ calendarUrls?: {
1835
+ google: string;
1836
+ ics: string;
1837
+ };
1838
+ eventPageUrl: string;
1839
+ form?: {
1840
+ controls: {
1841
+ type: InputControlType;
1842
+ system: boolean;
1843
+ name: string;
1844
+ inputs: {
1845
+ name: string;
1846
+ array: boolean;
1847
+ label: string;
1848
+ options: string[];
1849
+ mandatory: boolean;
1850
+ maxLength: number;
1851
+ type: ValueType;
1852
+ defaultOptionSelection?: {
1853
+ optionIndex: number;
1854
+ placeholderText: string;
1855
+ };
1856
+ labels: {
1857
+ name: string;
1858
+ label: string;
1859
+ }[];
1860
+ }[];
1861
+ label: string;
1862
+ orderIndex: number;
1863
+ _id: string;
1864
+ }[];
1865
+ messages?: {
1866
+ rsvp?: {
1867
+ rsvpYesOption: string;
1868
+ rsvpNoOption: string;
1869
+ positiveMessages?: {
1870
+ title: string;
1871
+ confirmation?: {
1872
+ title: string;
1873
+ message: string;
1874
+ addToCalendarActionLabel: string;
1875
+ shareActionLabel: string;
1876
+ };
1877
+ };
1878
+ waitlistMessages?: {
1879
+ title: string;
1880
+ confirmation?: {
1881
+ title: string;
1882
+ message: string;
1883
+ addToCalendarActionLabel: string;
1884
+ shareActionLabel: string;
1885
+ };
1886
+ };
1887
+ negativeMessages?: {
1888
+ title: string;
1889
+ confirmation?: {
1890
+ title: string;
1891
+ shareActionLabel: string;
1892
+ };
1893
+ };
1894
+ submitActionLabel: string;
1895
+ };
1896
+ checkout?: {
1897
+ title: string;
1898
+ submitActionLabel: string;
1899
+ confirmation?: {
1900
+ title: string;
1901
+ message: string;
1902
+ downloadTicketsLabel: string;
1903
+ addToCalendarLabel: string;
1904
+ shareEventLabel: string;
1905
+ };
1906
+ };
1907
+ registrationClosed?: {
1908
+ message: string;
1909
+ exploreEventsActionLabel: string;
1910
+ };
1911
+ ticketsUnavailable?: {
1912
+ message: string;
1913
+ exploreEventsActionLabel: string;
1914
+ };
1915
+ };
1916
+ };
1917
+ summaries?: {
1918
+ rsvps?: {
1919
+ totalCount: number;
1920
+ yesCount: number;
1921
+ noCount: number;
1922
+ waitlistCount: number;
1923
+ };
1924
+ tickets?: {
1925
+ ticketsSold: number;
1926
+ revenue?: {
1927
+ amount: string;
1928
+ currency: string;
1929
+ };
1930
+ currencyLocked: boolean;
1931
+ totalOrders: number;
1932
+ totalSales?: {
1933
+ amount: string;
1934
+ currency: string;
1935
+ };
1936
+ };
1937
+ };
1938
+ instanceId: string;
1939
+ guestListSettings?: {
1940
+ displayedPublicly: boolean;
1941
+ };
1942
+ userId: string;
1943
+ onlineConferencing?: {
1944
+ enabled: boolean;
1945
+ type: ConferenceTypeType;
1946
+ session?: {
1947
+ hostLink: string;
1948
+ guestLink: string;
1949
+ };
1950
+ };
1951
+ seoSettings?: {
1952
+ slug: string;
1953
+ advancedSeoData?: {
1954
+ tags: {
1955
+ type: string;
1956
+ children: string;
1957
+ custom: boolean;
1958
+ disabled: boolean;
1959
+ }[];
1960
+ settings?: {
1961
+ preventAutoRedirect: boolean;
1962
+ keywords: {
1963
+ term: string;
1964
+ isMain: boolean;
1965
+ }[];
1966
+ };
1967
+ };
1968
+ };
1969
+ agendaSettings?: {
1970
+ enabled: boolean;
1971
+ pageUrl: string;
1972
+ };
1973
+ };
1974
+ }
1975
+ export interface UpdateEventResponseNonNullableFields {
1976
+ event?: {
1977
+ _id: string;
1978
+ location?: {
1979
+ type: LocationType;
1980
+ };
1981
+ dateAndTimeSettings?: {
1982
+ recurrenceStatus: RecurrenceStatusStatus;
1983
+ recurringEvents?: {
1984
+ individualEventDates: {
1985
+ showTimeZone: boolean;
1986
+ }[];
1987
+ };
1988
+ };
1989
+ mainImage: string;
1990
+ slug: string;
1991
+ status: Status;
1992
+ registration?: {
1993
+ type: RegistrationTypeType;
1994
+ status: RegistrationStatusStatus;
1995
+ rsvp?: {
1996
+ responseType: ResponseType;
1997
+ waitlistEnabled: boolean;
1998
+ };
1999
+ tickets?: {
2000
+ guestsAssignedSeparately: boolean;
2001
+ ticketLimitPerOrder: number;
2002
+ lowestPrice?: {
2003
+ value: string;
2004
+ currency: string;
2005
+ };
2006
+ highestPrice?: {
2007
+ value: string;
2008
+ currency: string;
2009
+ };
2010
+ taxSettings?: {
2011
+ type: TaxType;
2012
+ };
2013
+ };
2014
+ allowedGuestTypes: GuestTypeType;
2015
+ initialType: InitialRegistrationTypeType;
2016
+ registrationPaused: boolean;
2017
+ registrationDisabled: boolean;
2018
+ };
2019
+ calendarUrls?: {
2020
+ google: string;
2021
+ ics: string;
2022
+ };
2023
+ eventPageUrl: string;
2024
+ form?: {
2025
+ controls: {
2026
+ type: InputControlType;
2027
+ system: boolean;
2028
+ name: string;
2029
+ inputs: {
2030
+ name: string;
2031
+ array: boolean;
2032
+ label: string;
2033
+ options: string[];
2034
+ mandatory: boolean;
2035
+ maxLength: number;
2036
+ type: ValueType;
2037
+ defaultOptionSelection?: {
2038
+ optionIndex: number;
2039
+ placeholderText: string;
2040
+ };
2041
+ labels: {
2042
+ name: string;
2043
+ label: string;
2044
+ }[];
2045
+ }[];
2046
+ label: string;
2047
+ orderIndex: number;
2048
+ _id: string;
2049
+ }[];
2050
+ messages?: {
2051
+ rsvp?: {
2052
+ rsvpYesOption: string;
2053
+ rsvpNoOption: string;
2054
+ positiveMessages?: {
2055
+ title: string;
2056
+ confirmation?: {
2057
+ title: string;
2058
+ message: string;
2059
+ addToCalendarActionLabel: string;
2060
+ shareActionLabel: string;
2061
+ };
2062
+ };
2063
+ waitlistMessages?: {
2064
+ title: string;
2065
+ confirmation?: {
2066
+ title: string;
2067
+ message: string;
2068
+ addToCalendarActionLabel: string;
2069
+ shareActionLabel: string;
2070
+ };
2071
+ };
2072
+ negativeMessages?: {
2073
+ title: string;
2074
+ confirmation?: {
2075
+ title: string;
2076
+ shareActionLabel: string;
2077
+ };
2078
+ };
2079
+ submitActionLabel: string;
2080
+ };
2081
+ checkout?: {
2082
+ title: string;
2083
+ submitActionLabel: string;
2084
+ confirmation?: {
2085
+ title: string;
2086
+ message: string;
2087
+ downloadTicketsLabel: string;
2088
+ addToCalendarLabel: string;
2089
+ shareEventLabel: string;
2090
+ };
2091
+ };
2092
+ registrationClosed?: {
2093
+ message: string;
2094
+ exploreEventsActionLabel: string;
2095
+ };
2096
+ ticketsUnavailable?: {
2097
+ message: string;
2098
+ exploreEventsActionLabel: string;
2099
+ };
2100
+ };
2101
+ };
2102
+ summaries?: {
2103
+ rsvps?: {
2104
+ totalCount: number;
2105
+ yesCount: number;
2106
+ noCount: number;
2107
+ waitlistCount: number;
2108
+ };
2109
+ tickets?: {
2110
+ ticketsSold: number;
2111
+ revenue?: {
2112
+ amount: string;
2113
+ currency: string;
2114
+ };
2115
+ currencyLocked: boolean;
2116
+ totalOrders: number;
2117
+ totalSales?: {
2118
+ amount: string;
2119
+ currency: string;
2120
+ };
2121
+ };
2122
+ };
2123
+ instanceId: string;
2124
+ guestListSettings?: {
2125
+ displayedPublicly: boolean;
2126
+ };
2127
+ userId: string;
2128
+ onlineConferencing?: {
2129
+ enabled: boolean;
2130
+ type: ConferenceTypeType;
2131
+ session?: {
2132
+ hostLink: string;
2133
+ guestLink: string;
2134
+ };
2135
+ };
2136
+ seoSettings?: {
2137
+ slug: string;
2138
+ advancedSeoData?: {
2139
+ tags: {
2140
+ type: string;
2141
+ children: string;
2142
+ custom: boolean;
2143
+ disabled: boolean;
2144
+ }[];
2145
+ settings?: {
2146
+ preventAutoRedirect: boolean;
2147
+ keywords: {
2148
+ term: string;
2149
+ isMain: boolean;
2150
+ }[];
2151
+ };
2152
+ };
2153
+ };
2154
+ agendaSettings?: {
2155
+ enabled: boolean;
2156
+ pageUrl: string;
2157
+ };
2158
+ };
2159
+ }
2160
+ export interface PublishDraftEventResponseNonNullableFields {
2161
+ event?: {
2162
+ _id: string;
2163
+ location?: {
2164
+ type: LocationType;
2165
+ };
2166
+ dateAndTimeSettings?: {
2167
+ recurrenceStatus: RecurrenceStatusStatus;
2168
+ recurringEvents?: {
2169
+ individualEventDates: {
2170
+ showTimeZone: boolean;
2171
+ }[];
2172
+ };
2173
+ };
2174
+ mainImage: string;
2175
+ slug: string;
2176
+ status: Status;
2177
+ registration?: {
2178
+ type: RegistrationTypeType;
2179
+ status: RegistrationStatusStatus;
2180
+ rsvp?: {
2181
+ responseType: ResponseType;
2182
+ waitlistEnabled: boolean;
2183
+ };
2184
+ tickets?: {
2185
+ guestsAssignedSeparately: boolean;
2186
+ ticketLimitPerOrder: number;
2187
+ lowestPrice?: {
2188
+ value: string;
2189
+ currency: string;
2190
+ };
2191
+ highestPrice?: {
2192
+ value: string;
2193
+ currency: string;
2194
+ };
2195
+ taxSettings?: {
2196
+ type: TaxType;
2197
+ };
2198
+ };
2199
+ allowedGuestTypes: GuestTypeType;
2200
+ initialType: InitialRegistrationTypeType;
2201
+ registrationPaused: boolean;
2202
+ registrationDisabled: boolean;
2203
+ };
2204
+ calendarUrls?: {
2205
+ google: string;
2206
+ ics: string;
2207
+ };
2208
+ eventPageUrl: string;
2209
+ form?: {
2210
+ controls: {
2211
+ type: InputControlType;
2212
+ system: boolean;
2213
+ name: string;
2214
+ inputs: {
2215
+ name: string;
2216
+ array: boolean;
2217
+ label: string;
2218
+ options: string[];
2219
+ mandatory: boolean;
2220
+ maxLength: number;
2221
+ type: ValueType;
2222
+ defaultOptionSelection?: {
2223
+ optionIndex: number;
2224
+ placeholderText: string;
2225
+ };
2226
+ labels: {
2227
+ name: string;
2228
+ label: string;
2229
+ }[];
2230
+ }[];
2231
+ label: string;
2232
+ orderIndex: number;
2233
+ _id: string;
2234
+ }[];
2235
+ messages?: {
2236
+ rsvp?: {
2237
+ rsvpYesOption: string;
2238
+ rsvpNoOption: string;
2239
+ positiveMessages?: {
2240
+ title: string;
2241
+ confirmation?: {
2242
+ title: string;
2243
+ message: string;
2244
+ addToCalendarActionLabel: string;
2245
+ shareActionLabel: string;
2246
+ };
2247
+ };
2248
+ waitlistMessages?: {
2249
+ title: string;
2250
+ confirmation?: {
2251
+ title: string;
2252
+ message: string;
2253
+ addToCalendarActionLabel: string;
2254
+ shareActionLabel: string;
2255
+ };
2256
+ };
2257
+ negativeMessages?: {
2258
+ title: string;
2259
+ confirmation?: {
2260
+ title: string;
2261
+ shareActionLabel: string;
2262
+ };
2263
+ };
2264
+ submitActionLabel: string;
2265
+ };
2266
+ checkout?: {
2267
+ title: string;
2268
+ submitActionLabel: string;
2269
+ confirmation?: {
2270
+ title: string;
2271
+ message: string;
2272
+ downloadTicketsLabel: string;
2273
+ addToCalendarLabel: string;
2274
+ shareEventLabel: string;
2275
+ };
2276
+ };
2277
+ registrationClosed?: {
2278
+ message: string;
2279
+ exploreEventsActionLabel: string;
2280
+ };
2281
+ ticketsUnavailable?: {
2282
+ message: string;
2283
+ exploreEventsActionLabel: string;
2284
+ };
2285
+ };
2286
+ };
2287
+ summaries?: {
2288
+ rsvps?: {
2289
+ totalCount: number;
2290
+ yesCount: number;
2291
+ noCount: number;
2292
+ waitlistCount: number;
2293
+ };
2294
+ tickets?: {
2295
+ ticketsSold: number;
2296
+ revenue?: {
2297
+ amount: string;
2298
+ currency: string;
2299
+ };
2300
+ currencyLocked: boolean;
2301
+ totalOrders: number;
2302
+ totalSales?: {
2303
+ amount: string;
2304
+ currency: string;
2305
+ };
2306
+ };
2307
+ };
2308
+ instanceId: string;
2309
+ guestListSettings?: {
2310
+ displayedPublicly: boolean;
2311
+ };
2312
+ userId: string;
2313
+ onlineConferencing?: {
2314
+ enabled: boolean;
2315
+ type: ConferenceTypeType;
2316
+ session?: {
2317
+ hostLink: string;
2318
+ guestLink: string;
2319
+ };
2320
+ };
2321
+ seoSettings?: {
2322
+ slug: string;
2323
+ advancedSeoData?: {
2324
+ tags: {
2325
+ type: string;
2326
+ children: string;
2327
+ custom: boolean;
2328
+ disabled: boolean;
2329
+ }[];
2330
+ settings?: {
2331
+ preventAutoRedirect: boolean;
2332
+ keywords: {
2333
+ term: string;
2334
+ isMain: boolean;
2335
+ }[];
2336
+ };
2337
+ };
2338
+ };
2339
+ agendaSettings?: {
2340
+ enabled: boolean;
2341
+ pageUrl: string;
2342
+ };
2343
+ };
2344
+ }
2345
+ export interface CancelEventResponseNonNullableFields {
2346
+ event?: {
2347
+ _id: string;
2348
+ location?: {
2349
+ type: LocationType;
2350
+ };
2351
+ dateAndTimeSettings?: {
2352
+ recurrenceStatus: RecurrenceStatusStatus;
2353
+ recurringEvents?: {
2354
+ individualEventDates: {
2355
+ showTimeZone: boolean;
2356
+ }[];
2357
+ };
2358
+ };
2359
+ mainImage: string;
2360
+ slug: string;
2361
+ status: Status;
2362
+ registration?: {
2363
+ type: RegistrationTypeType;
2364
+ status: RegistrationStatusStatus;
2365
+ rsvp?: {
2366
+ responseType: ResponseType;
2367
+ waitlistEnabled: boolean;
2368
+ };
2369
+ tickets?: {
2370
+ guestsAssignedSeparately: boolean;
2371
+ ticketLimitPerOrder: number;
2372
+ lowestPrice?: {
2373
+ value: string;
2374
+ currency: string;
2375
+ };
2376
+ highestPrice?: {
2377
+ value: string;
2378
+ currency: string;
2379
+ };
2380
+ taxSettings?: {
2381
+ type: TaxType;
2382
+ };
2383
+ };
2384
+ allowedGuestTypes: GuestTypeType;
2385
+ initialType: InitialRegistrationTypeType;
2386
+ registrationPaused: boolean;
2387
+ registrationDisabled: boolean;
2388
+ };
2389
+ calendarUrls?: {
2390
+ google: string;
2391
+ ics: string;
2392
+ };
2393
+ eventPageUrl: string;
2394
+ form?: {
2395
+ controls: {
2396
+ type: InputControlType;
2397
+ system: boolean;
2398
+ name: string;
2399
+ inputs: {
2400
+ name: string;
2401
+ array: boolean;
2402
+ label: string;
2403
+ options: string[];
2404
+ mandatory: boolean;
2405
+ maxLength: number;
2406
+ type: ValueType;
2407
+ defaultOptionSelection?: {
2408
+ optionIndex: number;
2409
+ placeholderText: string;
2410
+ };
2411
+ labels: {
2412
+ name: string;
2413
+ label: string;
2414
+ }[];
2415
+ }[];
2416
+ label: string;
2417
+ orderIndex: number;
2418
+ _id: string;
2419
+ }[];
2420
+ messages?: {
2421
+ rsvp?: {
2422
+ rsvpYesOption: string;
2423
+ rsvpNoOption: string;
2424
+ positiveMessages?: {
2425
+ title: string;
2426
+ confirmation?: {
2427
+ title: string;
2428
+ message: string;
2429
+ addToCalendarActionLabel: string;
2430
+ shareActionLabel: string;
2431
+ };
2432
+ };
2433
+ waitlistMessages?: {
2434
+ title: string;
2435
+ confirmation?: {
2436
+ title: string;
2437
+ message: string;
2438
+ addToCalendarActionLabel: string;
2439
+ shareActionLabel: string;
2440
+ };
2441
+ };
2442
+ negativeMessages?: {
2443
+ title: string;
2444
+ confirmation?: {
2445
+ title: string;
2446
+ shareActionLabel: string;
2447
+ };
2448
+ };
2449
+ submitActionLabel: string;
2450
+ };
2451
+ checkout?: {
2452
+ title: string;
2453
+ submitActionLabel: string;
2454
+ confirmation?: {
2455
+ title: string;
2456
+ message: string;
2457
+ downloadTicketsLabel: string;
2458
+ addToCalendarLabel: string;
2459
+ shareEventLabel: string;
2460
+ };
2461
+ };
2462
+ registrationClosed?: {
2463
+ message: string;
2464
+ exploreEventsActionLabel: string;
2465
+ };
2466
+ ticketsUnavailable?: {
2467
+ message: string;
2468
+ exploreEventsActionLabel: string;
2469
+ };
2470
+ };
2471
+ };
2472
+ summaries?: {
2473
+ rsvps?: {
2474
+ totalCount: number;
2475
+ yesCount: number;
2476
+ noCount: number;
2477
+ waitlistCount: number;
2478
+ };
2479
+ tickets?: {
2480
+ ticketsSold: number;
2481
+ revenue?: {
2482
+ amount: string;
2483
+ currency: string;
2484
+ };
2485
+ currencyLocked: boolean;
2486
+ totalOrders: number;
2487
+ totalSales?: {
2488
+ amount: string;
2489
+ currency: string;
2490
+ };
2491
+ };
2492
+ };
2493
+ instanceId: string;
2494
+ guestListSettings?: {
2495
+ displayedPublicly: boolean;
2496
+ };
2497
+ userId: string;
2498
+ onlineConferencing?: {
2499
+ enabled: boolean;
2500
+ type: ConferenceTypeType;
2501
+ session?: {
2502
+ hostLink: string;
2503
+ guestLink: string;
2504
+ };
2505
+ };
2506
+ seoSettings?: {
2507
+ slug: string;
2508
+ advancedSeoData?: {
2509
+ tags: {
2510
+ type: string;
2511
+ children: string;
2512
+ custom: boolean;
2513
+ disabled: boolean;
2514
+ }[];
2515
+ settings?: {
2516
+ preventAutoRedirect: boolean;
2517
+ keywords: {
2518
+ term: string;
2519
+ isMain: boolean;
2520
+ }[];
2521
+ };
2522
+ };
2523
+ };
2524
+ agendaSettings?: {
2525
+ enabled: boolean;
2526
+ pageUrl: string;
2527
+ };
2528
+ };
2529
+ }
2530
+ export interface DeleteEventResponseNonNullableFields {
2531
+ eventId: string;
2532
+ }
2533
+ export interface QueryEventsResponseNonNullableFields {
2534
+ events: {
2535
+ _id: string;
2536
+ location?: {
2537
+ type: LocationType;
2538
+ };
2539
+ dateAndTimeSettings?: {
2540
+ recurrenceStatus: RecurrenceStatusStatus;
2541
+ recurringEvents?: {
2542
+ individualEventDates: {
2543
+ showTimeZone: boolean;
2544
+ }[];
2545
+ };
2546
+ };
2547
+ mainImage: string;
2548
+ slug: string;
2549
+ status: Status;
2550
+ registration?: {
2551
+ type: RegistrationTypeType;
2552
+ status: RegistrationStatusStatus;
2553
+ rsvp?: {
2554
+ responseType: ResponseType;
2555
+ waitlistEnabled: boolean;
2556
+ };
2557
+ tickets?: {
2558
+ guestsAssignedSeparately: boolean;
2559
+ ticketLimitPerOrder: number;
2560
+ lowestPrice?: {
2561
+ value: string;
2562
+ currency: string;
2563
+ };
2564
+ highestPrice?: {
2565
+ value: string;
2566
+ currency: string;
2567
+ };
2568
+ taxSettings?: {
2569
+ type: TaxType;
2570
+ };
2571
+ };
2572
+ allowedGuestTypes: GuestTypeType;
2573
+ initialType: InitialRegistrationTypeType;
2574
+ registrationPaused: boolean;
2575
+ registrationDisabled: boolean;
2576
+ };
2577
+ calendarUrls?: {
2578
+ google: string;
2579
+ ics: string;
2580
+ };
2581
+ eventPageUrl: string;
2582
+ form?: {
2583
+ controls: {
2584
+ type: InputControlType;
2585
+ system: boolean;
2586
+ name: string;
2587
+ inputs: {
2588
+ name: string;
2589
+ array: boolean;
2590
+ label: string;
2591
+ options: string[];
2592
+ mandatory: boolean;
2593
+ maxLength: number;
2594
+ type: ValueType;
2595
+ defaultOptionSelection?: {
2596
+ optionIndex: number;
2597
+ placeholderText: string;
2598
+ };
2599
+ labels: {
2600
+ name: string;
2601
+ label: string;
2602
+ }[];
2603
+ }[];
2604
+ label: string;
2605
+ orderIndex: number;
2606
+ _id: string;
2607
+ }[];
2608
+ messages?: {
2609
+ rsvp?: {
2610
+ rsvpYesOption: string;
2611
+ rsvpNoOption: string;
2612
+ positiveMessages?: {
2613
+ title: string;
2614
+ confirmation?: {
2615
+ title: string;
2616
+ message: string;
2617
+ addToCalendarActionLabel: string;
2618
+ shareActionLabel: string;
2619
+ };
2620
+ };
2621
+ waitlistMessages?: {
2622
+ title: string;
2623
+ confirmation?: {
2624
+ title: string;
2625
+ message: string;
2626
+ addToCalendarActionLabel: string;
2627
+ shareActionLabel: string;
2628
+ };
2629
+ };
2630
+ negativeMessages?: {
2631
+ title: string;
2632
+ confirmation?: {
2633
+ title: string;
2634
+ shareActionLabel: string;
2635
+ };
2636
+ };
2637
+ submitActionLabel: string;
2638
+ };
2639
+ checkout?: {
2640
+ title: string;
2641
+ submitActionLabel: string;
2642
+ confirmation?: {
2643
+ title: string;
2644
+ message: string;
2645
+ downloadTicketsLabel: string;
2646
+ addToCalendarLabel: string;
2647
+ shareEventLabel: string;
2648
+ };
2649
+ };
2650
+ registrationClosed?: {
2651
+ message: string;
2652
+ exploreEventsActionLabel: string;
2653
+ };
2654
+ ticketsUnavailable?: {
2655
+ message: string;
2656
+ exploreEventsActionLabel: string;
2657
+ };
2658
+ };
2659
+ };
2660
+ summaries?: {
2661
+ rsvps?: {
2662
+ totalCount: number;
2663
+ yesCount: number;
2664
+ noCount: number;
2665
+ waitlistCount: number;
2666
+ };
2667
+ tickets?: {
2668
+ ticketsSold: number;
2669
+ revenue?: {
2670
+ amount: string;
2671
+ currency: string;
2672
+ };
2673
+ currencyLocked: boolean;
2674
+ totalOrders: number;
2675
+ totalSales?: {
2676
+ amount: string;
2677
+ currency: string;
2678
+ };
2679
+ };
2680
+ };
2681
+ instanceId: string;
2682
+ guestListSettings?: {
2683
+ displayedPublicly: boolean;
2684
+ };
2685
+ userId: string;
2686
+ onlineConferencing?: {
2687
+ enabled: boolean;
2688
+ type: ConferenceTypeType;
2689
+ session?: {
2690
+ hostLink: string;
2691
+ guestLink: string;
2692
+ };
2693
+ };
2694
+ seoSettings?: {
2695
+ slug: string;
2696
+ advancedSeoData?: {
2697
+ tags: {
2698
+ type: string;
2699
+ children: string;
2700
+ custom: boolean;
2701
+ disabled: boolean;
2702
+ }[];
2703
+ settings?: {
2704
+ preventAutoRedirect: boolean;
2705
+ keywords: {
2706
+ term: string;
2707
+ isMain: boolean;
2708
+ }[];
2709
+ };
2710
+ };
2711
+ };
2712
+ agendaSettings?: {
2713
+ enabled: boolean;
2714
+ pageUrl: string;
2715
+ };
2716
+ }[];
2717
+ }
2718
+ export interface GetEventResponseNonNullableFields {
2719
+ event?: {
2720
+ _id: string;
2721
+ location?: {
2722
+ type: LocationType;
2723
+ };
2724
+ dateAndTimeSettings?: {
2725
+ recurrenceStatus: RecurrenceStatusStatus;
2726
+ recurringEvents?: {
2727
+ individualEventDates: {
2728
+ showTimeZone: boolean;
2729
+ }[];
2730
+ };
2731
+ };
2732
+ mainImage: string;
2733
+ slug: string;
2734
+ status: Status;
2735
+ registration?: {
2736
+ type: RegistrationTypeType;
2737
+ status: RegistrationStatusStatus;
2738
+ rsvp?: {
2739
+ responseType: ResponseType;
2740
+ waitlistEnabled: boolean;
2741
+ };
2742
+ tickets?: {
2743
+ guestsAssignedSeparately: boolean;
2744
+ ticketLimitPerOrder: number;
2745
+ lowestPrice?: {
2746
+ value: string;
2747
+ currency: string;
2748
+ };
2749
+ highestPrice?: {
2750
+ value: string;
2751
+ currency: string;
2752
+ };
2753
+ taxSettings?: {
2754
+ type: TaxType;
2755
+ };
2756
+ };
2757
+ allowedGuestTypes: GuestTypeType;
2758
+ initialType: InitialRegistrationTypeType;
2759
+ registrationPaused: boolean;
2760
+ registrationDisabled: boolean;
2761
+ };
2762
+ calendarUrls?: {
2763
+ google: string;
2764
+ ics: string;
2765
+ };
2766
+ eventPageUrl: string;
2767
+ form?: {
2768
+ controls: {
2769
+ type: InputControlType;
2770
+ system: boolean;
2771
+ name: string;
2772
+ inputs: {
2773
+ name: string;
2774
+ array: boolean;
2775
+ label: string;
2776
+ options: string[];
2777
+ mandatory: boolean;
2778
+ maxLength: number;
2779
+ type: ValueType;
2780
+ defaultOptionSelection?: {
2781
+ optionIndex: number;
2782
+ placeholderText: string;
2783
+ };
2784
+ labels: {
2785
+ name: string;
2786
+ label: string;
2787
+ }[];
2788
+ }[];
2789
+ label: string;
2790
+ orderIndex: number;
2791
+ _id: string;
2792
+ }[];
2793
+ messages?: {
2794
+ rsvp?: {
2795
+ rsvpYesOption: string;
2796
+ rsvpNoOption: string;
2797
+ positiveMessages?: {
2798
+ title: string;
2799
+ confirmation?: {
2800
+ title: string;
2801
+ message: string;
2802
+ addToCalendarActionLabel: string;
2803
+ shareActionLabel: string;
2804
+ };
2805
+ };
2806
+ waitlistMessages?: {
2807
+ title: string;
2808
+ confirmation?: {
2809
+ title: string;
2810
+ message: string;
2811
+ addToCalendarActionLabel: string;
2812
+ shareActionLabel: string;
2813
+ };
2814
+ };
2815
+ negativeMessages?: {
2816
+ title: string;
2817
+ confirmation?: {
2818
+ title: string;
2819
+ shareActionLabel: string;
2820
+ };
2821
+ };
2822
+ submitActionLabel: string;
2823
+ };
2824
+ checkout?: {
2825
+ title: string;
2826
+ submitActionLabel: string;
2827
+ confirmation?: {
2828
+ title: string;
2829
+ message: string;
2830
+ downloadTicketsLabel: string;
2831
+ addToCalendarLabel: string;
2832
+ shareEventLabel: string;
2833
+ };
2834
+ };
2835
+ registrationClosed?: {
2836
+ message: string;
2837
+ exploreEventsActionLabel: string;
2838
+ };
2839
+ ticketsUnavailable?: {
2840
+ message: string;
2841
+ exploreEventsActionLabel: string;
2842
+ };
2843
+ };
2844
+ };
2845
+ summaries?: {
2846
+ rsvps?: {
2847
+ totalCount: number;
2848
+ yesCount: number;
2849
+ noCount: number;
2850
+ waitlistCount: number;
2851
+ };
2852
+ tickets?: {
2853
+ ticketsSold: number;
2854
+ revenue?: {
2855
+ amount: string;
2856
+ currency: string;
2857
+ };
2858
+ currencyLocked: boolean;
2859
+ totalOrders: number;
2860
+ totalSales?: {
2861
+ amount: string;
2862
+ currency: string;
2863
+ };
2864
+ };
2865
+ };
2866
+ instanceId: string;
2867
+ guestListSettings?: {
2868
+ displayedPublicly: boolean;
2869
+ };
2870
+ userId: string;
2871
+ onlineConferencing?: {
2872
+ enabled: boolean;
2873
+ type: ConferenceTypeType;
2874
+ session?: {
2875
+ hostLink: string;
2876
+ guestLink: string;
2877
+ };
2878
+ };
2879
+ seoSettings?: {
2880
+ slug: string;
2881
+ advancedSeoData?: {
2882
+ tags: {
2883
+ type: string;
2884
+ children: string;
2885
+ custom: boolean;
2886
+ disabled: boolean;
2887
+ }[];
2888
+ settings?: {
2889
+ preventAutoRedirect: boolean;
2890
+ keywords: {
2891
+ term: string;
2892
+ isMain: boolean;
2893
+ }[];
2894
+ };
2895
+ };
2896
+ };
2897
+ agendaSettings?: {
2898
+ enabled: boolean;
2899
+ pageUrl: string;
2900
+ };
2901
+ };
2902
+ }
2903
+ export interface GetEventBySlugResponseNonNullableFields {
2904
+ event?: {
2905
+ _id: string;
2906
+ location?: {
2907
+ type: LocationType;
2908
+ };
2909
+ dateAndTimeSettings?: {
2910
+ recurrenceStatus: RecurrenceStatusStatus;
2911
+ recurringEvents?: {
2912
+ individualEventDates: {
2913
+ showTimeZone: boolean;
2914
+ }[];
2915
+ };
2916
+ };
2917
+ mainImage: string;
2918
+ slug: string;
2919
+ status: Status;
2920
+ registration?: {
2921
+ type: RegistrationTypeType;
2922
+ status: RegistrationStatusStatus;
2923
+ rsvp?: {
2924
+ responseType: ResponseType;
2925
+ waitlistEnabled: boolean;
2926
+ };
2927
+ tickets?: {
2928
+ guestsAssignedSeparately: boolean;
2929
+ ticketLimitPerOrder: number;
2930
+ lowestPrice?: {
2931
+ value: string;
2932
+ currency: string;
2933
+ };
2934
+ highestPrice?: {
2935
+ value: string;
2936
+ currency: string;
2937
+ };
2938
+ taxSettings?: {
2939
+ type: TaxType;
2940
+ };
2941
+ };
2942
+ allowedGuestTypes: GuestTypeType;
2943
+ initialType: InitialRegistrationTypeType;
2944
+ registrationPaused: boolean;
2945
+ registrationDisabled: boolean;
2946
+ };
2947
+ calendarUrls?: {
2948
+ google: string;
2949
+ ics: string;
2950
+ };
2951
+ eventPageUrl: string;
2952
+ form?: {
2953
+ controls: {
2954
+ type: InputControlType;
2955
+ system: boolean;
2956
+ name: string;
2957
+ inputs: {
2958
+ name: string;
2959
+ array: boolean;
2960
+ label: string;
2961
+ options: string[];
2962
+ mandatory: boolean;
2963
+ maxLength: number;
2964
+ type: ValueType;
2965
+ defaultOptionSelection?: {
2966
+ optionIndex: number;
2967
+ placeholderText: string;
2968
+ };
2969
+ labels: {
2970
+ name: string;
2971
+ label: string;
2972
+ }[];
2973
+ }[];
2974
+ label: string;
2975
+ orderIndex: number;
2976
+ _id: string;
2977
+ }[];
2978
+ messages?: {
2979
+ rsvp?: {
2980
+ rsvpYesOption: string;
2981
+ rsvpNoOption: string;
2982
+ positiveMessages?: {
2983
+ title: string;
2984
+ confirmation?: {
2985
+ title: string;
2986
+ message: string;
2987
+ addToCalendarActionLabel: string;
2988
+ shareActionLabel: string;
2989
+ };
2990
+ };
2991
+ waitlistMessages?: {
2992
+ title: string;
2993
+ confirmation?: {
2994
+ title: string;
2995
+ message: string;
2996
+ addToCalendarActionLabel: string;
2997
+ shareActionLabel: string;
2998
+ };
2999
+ };
3000
+ negativeMessages?: {
3001
+ title: string;
3002
+ confirmation?: {
3003
+ title: string;
3004
+ shareActionLabel: string;
3005
+ };
3006
+ };
3007
+ submitActionLabel: string;
3008
+ };
3009
+ checkout?: {
3010
+ title: string;
3011
+ submitActionLabel: string;
3012
+ confirmation?: {
3013
+ title: string;
3014
+ message: string;
3015
+ downloadTicketsLabel: string;
3016
+ addToCalendarLabel: string;
3017
+ shareEventLabel: string;
3018
+ };
3019
+ };
3020
+ registrationClosed?: {
3021
+ message: string;
3022
+ exploreEventsActionLabel: string;
3023
+ };
3024
+ ticketsUnavailable?: {
3025
+ message: string;
3026
+ exploreEventsActionLabel: string;
3027
+ };
3028
+ };
3029
+ };
3030
+ summaries?: {
3031
+ rsvps?: {
3032
+ totalCount: number;
3033
+ yesCount: number;
3034
+ noCount: number;
3035
+ waitlistCount: number;
3036
+ };
3037
+ tickets?: {
3038
+ ticketsSold: number;
3039
+ revenue?: {
3040
+ amount: string;
3041
+ currency: string;
3042
+ };
3043
+ currencyLocked: boolean;
3044
+ totalOrders: number;
3045
+ totalSales?: {
3046
+ amount: string;
3047
+ currency: string;
3048
+ };
3049
+ };
3050
+ };
3051
+ instanceId: string;
3052
+ guestListSettings?: {
3053
+ displayedPublicly: boolean;
3054
+ };
3055
+ userId: string;
3056
+ onlineConferencing?: {
3057
+ enabled: boolean;
3058
+ type: ConferenceTypeType;
3059
+ session?: {
3060
+ hostLink: string;
3061
+ guestLink: string;
3062
+ };
3063
+ };
3064
+ seoSettings?: {
3065
+ slug: string;
3066
+ advancedSeoData?: {
3067
+ tags: {
3068
+ type: string;
3069
+ children: string;
3070
+ custom: boolean;
3071
+ disabled: boolean;
3072
+ }[];
3073
+ settings?: {
3074
+ preventAutoRedirect: boolean;
3075
+ keywords: {
3076
+ term: string;
3077
+ isMain: boolean;
3078
+ }[];
3079
+ };
3080
+ };
3081
+ };
3082
+ agendaSettings?: {
3083
+ enabled: boolean;
3084
+ pageUrl: string;
3085
+ };
3086
+ };
3087
+ }
3088
+ export interface FindEventResponseNonNullableFields {
3089
+ event?: {
3090
+ _id: string;
3091
+ location?: {
3092
+ type: LocationType;
3093
+ };
3094
+ dateAndTimeSettings?: {
3095
+ recurrenceStatus: RecurrenceStatusStatus;
3096
+ recurringEvents?: {
3097
+ individualEventDates: {
3098
+ showTimeZone: boolean;
3099
+ }[];
3100
+ };
3101
+ };
3102
+ mainImage: string;
3103
+ slug: string;
3104
+ status: Status;
3105
+ registration?: {
3106
+ type: RegistrationTypeType;
3107
+ status: RegistrationStatusStatus;
3108
+ rsvp?: {
3109
+ responseType: ResponseType;
3110
+ waitlistEnabled: boolean;
3111
+ };
3112
+ tickets?: {
3113
+ guestsAssignedSeparately: boolean;
3114
+ ticketLimitPerOrder: number;
3115
+ lowestPrice?: {
3116
+ value: string;
3117
+ currency: string;
3118
+ };
3119
+ highestPrice?: {
3120
+ value: string;
3121
+ currency: string;
3122
+ };
3123
+ taxSettings?: {
3124
+ type: TaxType;
3125
+ };
3126
+ };
3127
+ allowedGuestTypes: GuestTypeType;
3128
+ initialType: InitialRegistrationTypeType;
3129
+ registrationPaused: boolean;
3130
+ registrationDisabled: boolean;
3131
+ };
3132
+ calendarUrls?: {
3133
+ google: string;
3134
+ ics: string;
3135
+ };
3136
+ eventPageUrl: string;
3137
+ form?: {
3138
+ controls: {
3139
+ type: InputControlType;
3140
+ system: boolean;
3141
+ name: string;
3142
+ inputs: {
3143
+ name: string;
3144
+ array: boolean;
3145
+ label: string;
3146
+ options: string[];
3147
+ mandatory: boolean;
3148
+ maxLength: number;
3149
+ type: ValueType;
3150
+ defaultOptionSelection?: {
3151
+ optionIndex: number;
3152
+ placeholderText: string;
3153
+ };
3154
+ labels: {
3155
+ name: string;
3156
+ label: string;
3157
+ }[];
3158
+ }[];
3159
+ label: string;
3160
+ orderIndex: number;
3161
+ _id: string;
3162
+ }[];
3163
+ messages?: {
3164
+ rsvp?: {
3165
+ rsvpYesOption: string;
3166
+ rsvpNoOption: string;
3167
+ positiveMessages?: {
3168
+ title: string;
3169
+ confirmation?: {
3170
+ title: string;
3171
+ message: string;
3172
+ addToCalendarActionLabel: string;
3173
+ shareActionLabel: string;
3174
+ };
3175
+ };
3176
+ waitlistMessages?: {
3177
+ title: string;
3178
+ confirmation?: {
3179
+ title: string;
3180
+ message: string;
3181
+ addToCalendarActionLabel: string;
3182
+ shareActionLabel: string;
3183
+ };
3184
+ };
3185
+ negativeMessages?: {
3186
+ title: string;
3187
+ confirmation?: {
3188
+ title: string;
3189
+ shareActionLabel: string;
3190
+ };
3191
+ };
3192
+ submitActionLabel: string;
3193
+ };
3194
+ checkout?: {
3195
+ title: string;
3196
+ submitActionLabel: string;
3197
+ confirmation?: {
3198
+ title: string;
3199
+ message: string;
3200
+ downloadTicketsLabel: string;
3201
+ addToCalendarLabel: string;
3202
+ shareEventLabel: string;
3203
+ };
3204
+ };
3205
+ registrationClosed?: {
3206
+ message: string;
3207
+ exploreEventsActionLabel: string;
3208
+ };
3209
+ ticketsUnavailable?: {
3210
+ message: string;
3211
+ exploreEventsActionLabel: string;
3212
+ };
3213
+ };
3214
+ };
3215
+ summaries?: {
3216
+ rsvps?: {
3217
+ totalCount: number;
3218
+ yesCount: number;
3219
+ noCount: number;
3220
+ waitlistCount: number;
3221
+ };
3222
+ tickets?: {
3223
+ ticketsSold: number;
3224
+ revenue?: {
3225
+ amount: string;
3226
+ currency: string;
3227
+ };
3228
+ currencyLocked: boolean;
3229
+ totalOrders: number;
3230
+ totalSales?: {
3231
+ amount: string;
3232
+ currency: string;
3233
+ };
3234
+ };
3235
+ };
3236
+ instanceId: string;
3237
+ guestListSettings?: {
3238
+ displayedPublicly: boolean;
3239
+ };
3240
+ userId: string;
3241
+ onlineConferencing?: {
3242
+ enabled: boolean;
3243
+ type: ConferenceTypeType;
3244
+ session?: {
3245
+ hostLink: string;
3246
+ guestLink: string;
3247
+ };
3248
+ };
3249
+ seoSettings?: {
3250
+ slug: string;
3251
+ advancedSeoData?: {
3252
+ tags: {
3253
+ type: string;
3254
+ children: string;
3255
+ custom: boolean;
3256
+ disabled: boolean;
3257
+ }[];
3258
+ settings?: {
3259
+ preventAutoRedirect: boolean;
3260
+ keywords: {
3261
+ term: string;
3262
+ isMain: boolean;
3263
+ }[];
3264
+ };
3265
+ };
3266
+ };
3267
+ agendaSettings?: {
3268
+ enabled: boolean;
3269
+ pageUrl: string;
3270
+ };
3271
+ };
3272
+ }
3273
+ /**
3274
+ * Creates an event. <br> <br>
3275
+ * The event includes a default registration form in the selected language, which consists of input fields for first name, last name, and email. See [Registration Form](https://dev.wix.com/api/rest/wix-events/wix-events/registration-form/about-the-registration-form-api) for more information. <br> <br>
3276
+ * You can create the event as a draft by setting the `draft` value to `true`. Otherwise, the event is published right away. <br> <br>
3277
+ * The event is automatically set up to send daily summary reports of new guests to your business email.
3278
+ * @param event - Event data.
3279
+ * @public
3280
+ * @documentationMaturity preview
3281
+ * @requiredField event
3282
+ * @requiredField event.dateAndTimeSettings
3283
+ * @requiredField event.location
3284
+ * @requiredField event.title
3285
+ * @permissionScope Manage Events - all permissions
3286
+ * @permissionScope Manage Events
3287
+ * @applicableIdentity APP
3288
+ * @returns Created event.
3289
+ */
3290
+ export declare function createEvent(event: Event, options?: CreateEventOptions): Promise<Event & NonNullable<CreateEventResponseNonNullableFields>['event']>;
3291
+ export interface CreateEventOptions {
3292
+ /** Whether to create the event as a draft. */
3293
+ draft?: boolean;
3294
+ /**
3295
+ * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
3296
+ * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
3297
+ * - `TEXTS`: Returns `detailedDescription`.
3298
+ * - `REGISTRATION`: Returns `registration`.
3299
+ * - `URLS`: Returns `eventPageUrl`.
3300
+ * - `FORM`: Returns `form`.
3301
+ * - `DASHBOARD`: Returns `summaries`.
3302
+ * - `FEED`: Returns `feed`.
3303
+ * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
3304
+ * - `SEO_SETTINGS`: Returns `seoSettings`.
3305
+ * - `AGENDA`: Returns `agendaSettings`.
3306
+ * - `CATEGORIES`: Returns `categories`.
3307
+ */
3308
+ fields?: RequestedFields[];
3309
+ }
3310
+ /**
3311
+ * Clones an event, including the registration form, notifications, multilingual translations and ticket configuration from the original event. <br> <br>
3312
+ * The new event's date is automatically set to 14 days from the original event date. <br> <br>
3313
+ * If an event with the same title already exists, the new event's title gets a sequence number. For example, if you clone an event named "Leather Crafting 101", the new event's title is "Leather Crafting 101 (1)". <br> <br>
3314
+ * You can change the required entity field values while cloning an event. See [Partial Updates](https://dev.wix.com/api/rest/wix-events/wix-events/partial-updates) for more information.
3315
+ * @param eventId - Event ID.
3316
+ * @public
3317
+ * @documentationMaturity preview
3318
+ * @requiredField eventId
3319
+ * @permissionScope Manage Events - all permissions
3320
+ * @permissionScope Manage Events
3321
+ * @applicableIdentity APP
3322
+ */
3323
+ export declare function cloneEvent(eventId: string, options?: CloneEventOptions): Promise<CloneEventResponse & CloneEventResponseNonNullableFields>;
3324
+ export interface CloneEventOptions {
3325
+ /** Field values to be changed when cloning the event. */
3326
+ event?: Event;
3327
+ /** Whether to clone the event as a draft. */
3328
+ draft?: boolean;
3329
+ /**
3330
+ * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
3331
+ * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
3332
+ * - `TEXTS`: Returns `detailedDescription`.
3333
+ * - `REGISTRATION`: Returns `registration`.
3334
+ * - `URLS`: Returns `eventPageUrl`.
3335
+ * - `FORM`: Returns `form`.
3336
+ * - `DASHBOARD`: Returns `summaries`.
3337
+ * - `FEED`: Returns `feed`.
3338
+ * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
3339
+ * - `SEO_SETTINGS`: Returns `seoSettings`.
3340
+ * - `AGENDA`: Returns `agendaSettings`.
3341
+ * - `CATEGORIES`: Returns `categories`.
3342
+ */
3343
+ fields?: RequestedFields[];
3344
+ }
3345
+ /**
3346
+ * Updates an event.
3347
+ * @param _id - Event ID.
3348
+ * @public
3349
+ * @documentationMaturity preview
3350
+ * @requiredField _id
3351
+ * @permissionScope Manage Events - all permissions
3352
+ * @permissionScope Manage Events
3353
+ * @applicableIdentity APP
3354
+ * @returns Updated event.
3355
+ */
3356
+ export declare function updateEvent(_id: string, options?: UpdateEventOptions): Promise<Event & NonNullable<UpdateEventResponseNonNullableFields>['event']>;
3357
+ export interface UpdateEventOptions {
3358
+ event: {
3359
+ /**
3360
+ * Event ID.
3361
+ * @readonly
3362
+ */
3363
+ _id?: string;
3364
+ /** Event location. */
3365
+ location?: Location;
3366
+ /** Event date and time settings. */
3367
+ dateAndTimeSettings?: DateAndTimeSettings;
3368
+ title?: string | null;
3369
+ shortDescription?: string | null;
3370
+ detailedDescription?: string | null;
3371
+ /** Main event image. */
3372
+ mainImage?: string;
3373
+ /**
3374
+ * Unique identifier of the event page. The naming is the same as the event title written in kebab case. For example, if your event title is "Leather Crafting 101", then the slug is "leather-crafting-101".
3375
+ * @readonly
3376
+ */
3377
+ slug?: string;
3378
+ /**
3379
+ * Date and time when the event was created in `yyyy-mm-ddThh:mm:sssZ` format.
3380
+ * @readonly
3381
+ */
3382
+ _createdDate?: Date;
3383
+ /**
3384
+ * Date and time when the event was updated in `yyyy-mm-ddThh:mm:sssZ` format.
3385
+ * @readonly
3386
+ */
3387
+ _updatedDate?: Date;
3388
+ /** @readonly */
3389
+ status?: Status;
3390
+ /** RSVP or ticketing registration details. */
3391
+ registration?: Registration;
3392
+ /** URLs that allow you to add an event to the Google calendar, or to download an [ICS calendar](https://icscalendar.com/) file. */
3393
+ calendarUrls?: CalendarUrls;
3394
+ /** Event page URL components. */
3395
+ eventPageUrl?: string;
3396
+ /** Event registration form. */
3397
+ form?: Form;
3398
+ /** Summary of RSVP or ticket sales. */
3399
+ summaries?: Summaries;
3400
+ /**
3401
+ * Instance ID of the site where the event is hosted.
3402
+ * @readonly
3403
+ */
3404
+ instanceId?: string;
3405
+ /** Guest list configuration. */
3406
+ guestListSettings?: GuestListSettings;
3407
+ /**
3408
+ * ID of the user who created the event.
3409
+ * @readonly
3410
+ */
3411
+ userId?: string;
3412
+ /** Online conferencing details. */
3413
+ onlineConferencing?: OnlineConferencing;
3414
+ /** SEO settings. */
3415
+ seoSettings?: SeoSettings;
3416
+ /** Assigned contacts label key. */
3417
+ contactLabel?: string | null;
3418
+ /** Event schedule details. */
3419
+ agendaSettings?: AgendaSettings;
3420
+ /** Visual settings for event. */
3421
+ eventDisplaySettings?: EventDisplaySettings;
3422
+ };
3423
+ /**
3424
+ * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
3425
+ * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
3426
+ * - `TEXTS`: Returns `detailedDescription`.
3427
+ * - `REGISTRATION`: Returns `registration`.
3428
+ * - `URLS`: Returns `eventPageUrl`.
3429
+ * - `FORM`: Returns `form`.
3430
+ * - `DASHBOARD`: Returns `summaries`.
3431
+ * - `FEED`: Returns `feed`.
3432
+ * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
3433
+ * - `SEO_SETTINGS`: Returns `seoSettings`.
3434
+ * - `AGENDA`: Returns `agendaSettings`.
3435
+ * - `CATEGORIES`: Returns `categories`.
3436
+ */
3437
+ fields?: RequestedFields[];
3438
+ }
3439
+ /**
3440
+ * Publishes a draft event to your live site. Once published, the event's status changes from `DRAFT` to `UPCOMING`. <br> <br>
3441
+ * It's impossible to revert the `DRAFT` status after publishing. The only option is to clone the event, then delete the original one.
3442
+ * @param eventId - Event ID.
3443
+ * @public
3444
+ * @documentationMaturity preview
3445
+ * @requiredField eventId
3446
+ * @permissionScope Manage Events - all permissions
3447
+ * @permissionScope Manage Events
3448
+ * @applicableIdentity APP
3449
+ */
3450
+ export declare function publishDraftEvent(eventId: string, options?: PublishDraftEventOptions): Promise<PublishDraftEventResponse & PublishDraftEventResponseNonNullableFields>;
3451
+ export interface PublishDraftEventOptions {
3452
+ /**
3453
+ * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
3454
+ * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
3455
+ * - `TEXTS`: Returns `detailedDescription`.
3456
+ * - `REGISTRATION`: Returns `registration`.
3457
+ * - `URLS`: Returns `eventPageUrl`.
3458
+ * - `FORM`: Returns `form`.
3459
+ * - `DASHBOARD`: Returns `summaries`.
3460
+ * - `FEED`: Returns `feed`.
3461
+ * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
3462
+ * - `SEO_SETTINGS`: Returns `seoSettings`.
3463
+ * - `AGENDA`: Returns `agendaSettings`.
3464
+ * - `CATEGORIES`: Returns `categories`.
3465
+ */
3466
+ fields?: RequestedFields[];
3467
+ }
3468
+ /**
3469
+ * Cancels an event. <br> <br>
3470
+ * After cancellation, registration for an event is closed. To reuse the event, [copy]() and [publish]() it again. <br> <br>
3471
+ * If event cancellation notifications are enabled, canceling an event automatically triggers the sending of cancellation emails and/or push notifications to registered guests.
3472
+ * @param eventId - Event ID.
3473
+ * @public
3474
+ * @documentationMaturity preview
3475
+ * @requiredField eventId
3476
+ * @permissionScope Manage Events - all permissions
3477
+ * @permissionScope Manage Events
3478
+ * @applicableIdentity APP
3479
+ */
3480
+ export declare function cancelEvent(eventId: string, options?: CancelEventOptions): Promise<CancelEventResponse & CancelEventResponseNonNullableFields>;
3481
+ export interface CancelEventOptions {
3482
+ /**
3483
+ * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
3484
+ * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
3485
+ * - `TEXTS`: Returns `detailedDescription`.
3486
+ * - `REGISTRATION`: Returns `registration`.
3487
+ * - `URLS`: Returns `eventPageUrl`.
3488
+ * - `FORM`: Returns `form`.
3489
+ * - `DASHBOARD`: Returns `summaries`.
3490
+ * - `FEED`: Returns `feed`.
3491
+ * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
3492
+ * - `SEO_SETTINGS`: Returns `seoSettings`.
3493
+ * - `AGENDA`: Returns `agendaSettings`.
3494
+ * - `CATEGORIES`: Returns `categories`.
3495
+ */
3496
+ fields?: RequestedFields[];
3497
+ }
3498
+ /**
3499
+ * Cancels multiple events that meet the given criteria. <br> <br>
3500
+ * After cancellation, registration for an event is closed. To reuse the event, [clone]() and [publish]() it again. <br> <br>
3501
+ * If event cancellation notifications are enabled, canceling an event automatically triggers the sending of cancellation emails and/or push notifications to registered guests.
3502
+ * @public
3503
+ * @documentationMaturity preview
3504
+ * @requiredField options.filter.filter
3505
+ * @permissionScope Manage Events - all permissions
3506
+ * @permissionScope Manage Events
3507
+ * @applicableIdentity APP
3508
+ */
3509
+ export declare function bulkCancelEventsByFilter(options?: BulkCancelEventsByFilterOptions): Promise<void>;
3510
+ export interface BulkCancelEventsByFilterOptions {
3511
+ /** Filter. See [supported fields and operators](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-events). */
3512
+ filter?: QueryV2;
3513
+ }
3514
+ /**
3515
+ * Permanently deletes an event. <br> <br>
3516
+ * You can retrieve the deleted event through a GDPR access request.
3517
+ * @param eventId - Event ID.
3518
+ * @public
3519
+ * @documentationMaturity preview
3520
+ * @requiredField eventId
3521
+ * @permissionScope Manage Events - all permissions
3522
+ * @permissionScope Manage Events
3523
+ * @applicableIdentity APP
3524
+ */
3525
+ export declare function deleteEvent(eventId: string): Promise<DeleteEventResponse & DeleteEventResponseNonNullableFields>;
3526
+ /**
3527
+ * Permanently deletes multiple events that meet the given criteria. <br> <br>
3528
+ * You can retrieve the deleted events through a GDPR access request.
3529
+ * @public
3530
+ * @documentationMaturity preview
3531
+ * @requiredField options.filter.filter
3532
+ * @permissionScope Manage Events - all permissions
3533
+ * @permissionScope Manage Events
3534
+ * @applicableIdentity APP
3535
+ */
3536
+ export declare function bulkDeleteEventsByFilter(options?: BulkDeleteEventsByFilterOptions): Promise<void>;
3537
+ export interface BulkDeleteEventsByFilterOptions {
3538
+ /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
3539
+ filter?: QueryV2;
3540
+ }
3541
+ /**
3542
+ * Retrieves a list of events, given the provided paging, filtering, and sorting.
3543
+ * Query Events runs with these defaults, which you can override:
3544
+ * - `createdDate` is sorted in `ASC` order
3545
+ * - `paging.limit` is `100`
3546
+ * - `paging.offset` is `0`
3547
+ * For field support for filters and sorting, see [Events v3: Supported Filters and Sorting](https://dev.wix.com/api/rest/wix-events/events-v3/filter-and-sort).
3548
+ * To learn about working with _Query_ endpoints, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language), [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination), and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
3549
+ * @public
3550
+ * @documentationMaturity preview
3551
+ * @permissionScope Read Events - all read permissions
3552
+ * @permissionScope Manage Bookings Services and Settings
3553
+ * @permissionScope Manage Events - all permissions
3554
+ * @permissionScope Read Events
3555
+ * @permissionScope Manage Guest List
3556
+ * @permissionScope Manage Events
3557
+ * @applicableIdentity APP
3558
+ * @applicableIdentity MEMBER
3559
+ * @applicableIdentity VISITOR
3560
+ */
3561
+ export declare function queryEvents(options?: QueryEventsOptions): EventsQueryBuilder;
3562
+ export interface QueryEventsOptions {
3563
+ /**
3564
+ * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
3565
+ * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
3566
+ * - `TEXTS`: Returns `detailedDescription`.
3567
+ * - `REGISTRATION`: Returns `registration`.
3568
+ * - `URLS`: Returns `eventPageUrl`.
3569
+ * - `FORM`: Returns `form`.
3570
+ * - `DASHBOARD`: Returns `summaries`.
3571
+ * - `FEED`: Returns `feed`.
3572
+ * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
3573
+ * - `SEO_SETTINGS`: Returns `seoSettings`.
3574
+ * - `AGENDA`: Returns `agendaSettings`.
3575
+ * - `CATEGORIES`: Returns `categories`.
3576
+ */
3577
+ fields?: RequestedFields[] | undefined;
3578
+ /**
3579
+ * Whether draft events should be returned in the response.
3580
+ * This parameter requires the `WIX_EVENTS.MANAGE_EVENTS` permission.
3581
+ */
3582
+ includeDrafts?: boolean | undefined;
3583
+ }
3584
+ interface QueryOffsetResult {
3585
+ currentPage: number | undefined;
3586
+ totalPages: number | undefined;
3587
+ totalCount: number | undefined;
3588
+ hasNext: () => boolean;
3589
+ hasPrev: () => boolean;
3590
+ length: number;
3591
+ pageSize: number;
3592
+ }
3593
+ export interface EventsQueryResult extends QueryOffsetResult {
3594
+ items: Event[];
3595
+ query: EventsQueryBuilder;
3596
+ next: () => Promise<EventsQueryResult>;
3597
+ prev: () => Promise<EventsQueryResult>;
3598
+ }
3599
+ export interface EventsQueryBuilder {
3600
+ /** @param propertyName - Property whose value is compared with `value`.
3601
+ * @param value - Value to compare against.
3602
+ * @documentationMaturity preview
3603
+ */
3604
+ eq: (propertyName: '_id' | 'dateAndTimeSettings.startDate' | 'dateAndTimeSettings.endDate' | 'title' | 'slug' | '_createdDate' | '_updatedDate' | 'status' | 'registration.initialType' | 'userId', value: any) => EventsQueryBuilder;
3605
+ /** @param propertyName - Property whose value is compared with `value`.
3606
+ * @param value - Value to compare against.
3607
+ * @documentationMaturity preview
3608
+ */
3609
+ ne: (propertyName: '_id' | 'dateAndTimeSettings.startDate' | 'dateAndTimeSettings.endDate' | 'title' | 'slug' | '_createdDate' | '_updatedDate' | 'status' | 'userId', value: any) => EventsQueryBuilder;
3610
+ /** @param propertyName - Property whose value is compared with `value`.
3611
+ * @param value - Value to compare against.
3612
+ * @documentationMaturity preview
3613
+ */
3614
+ ge: (propertyName: 'dateAndTimeSettings.startDate' | 'dateAndTimeSettings.endDate' | '_createdDate' | '_updatedDate', value: any) => EventsQueryBuilder;
3615
+ /** @param propertyName - Property whose value is compared with `value`.
3616
+ * @param value - Value to compare against.
3617
+ * @documentationMaturity preview
3618
+ */
3619
+ gt: (propertyName: 'dateAndTimeSettings.startDate' | 'dateAndTimeSettings.endDate' | '_createdDate' | '_updatedDate', value: any) => EventsQueryBuilder;
3620
+ /** @param propertyName - Property whose value is compared with `value`.
3621
+ * @param value - Value to compare against.
3622
+ * @documentationMaturity preview
3623
+ */
3624
+ le: (propertyName: 'dateAndTimeSettings.startDate' | 'dateAndTimeSettings.endDate' | '_createdDate' | '_updatedDate', value: any) => EventsQueryBuilder;
3625
+ /** @param propertyName - Property whose value is compared with `value`.
3626
+ * @param value - Value to compare against.
3627
+ * @documentationMaturity preview
3628
+ */
3629
+ lt: (propertyName: 'dateAndTimeSettings.startDate' | 'dateAndTimeSettings.endDate' | '_createdDate' | '_updatedDate', value: any) => EventsQueryBuilder;
3630
+ /** @documentationMaturity preview */
3631
+ in: (propertyName: '_id' | 'dateAndTimeSettings.startDate' | 'dateAndTimeSettings.endDate' | 'title' | 'slug' | '_createdDate' | '_updatedDate' | 'status' | 'userId', value: any) => EventsQueryBuilder;
3632
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
3633
+ * @documentationMaturity preview
3634
+ */
3635
+ ascending: (...propertyNames: Array<'_id' | 'dateAndTimeSettings.startDate' | 'dateAndTimeSettings.endDate' | 'title' | 'slug' | '_createdDate' | '_updatedDate'>) => EventsQueryBuilder;
3636
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
3637
+ * @documentationMaturity preview
3638
+ */
3639
+ descending: (...propertyNames: Array<'_id' | 'dateAndTimeSettings.startDate' | 'dateAndTimeSettings.endDate' | 'title' | 'slug' | '_createdDate' | '_updatedDate'>) => EventsQueryBuilder;
3640
+ /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
3641
+ * @documentationMaturity preview
3642
+ */
3643
+ limit: (limit: number) => EventsQueryBuilder;
3644
+ /** @param skip - Number of items to skip in the query results before returning the results.
3645
+ * @documentationMaturity preview
3646
+ */
3647
+ skip: (skip: number) => EventsQueryBuilder;
3648
+ /** @documentationMaturity preview */
3649
+ find: () => Promise<EventsQueryResult>;
3650
+ }
3651
+ /**
3652
+ * Counts events by status.
3653
+ * To learn about working with _query_ endpoints, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language), [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination), and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
3654
+ * @public
3655
+ * @documentationMaturity preview
3656
+ * @permissionScope Read Events - all read permissions
3657
+ * @permissionScope Manage Bookings Services and Settings
3658
+ * @permissionScope Manage Events - all permissions
3659
+ * @permissionScope Read Events
3660
+ * @permissionScope Manage Guest List
3661
+ * @permissionScope Manage Events
3662
+ * @applicableIdentity APP
3663
+ * @applicableIdentity MEMBER
3664
+ * @applicableIdentity VISITOR
3665
+ */
3666
+ export declare function countEventsByStatus(options?: CountEventsByStatusOptions): Promise<CountEventsByStatusResponse>;
3667
+ export interface CountEventsByStatusOptions {
3668
+ /** Filter object in the following format: <br/> `"filter" : { "fieldName1": "value1" }`. */
3669
+ filter?: Record<string, any> | null;
3670
+ /**
3671
+ * Parameters to count events by.
3672
+ *
3673
+ * - Max: 20 facets
3674
+ */
3675
+ facet?: string[];
3676
+ /**
3677
+ * Whether draft events should be returned in the response.
3678
+ * This parameter requires the `WIX_EVENTS.MANAGE_EVENTS` permission.
3679
+ */
3680
+ includeDrafts?: boolean;
3681
+ }
3682
+ /**
3683
+ * Retrieves an event by ID.
3684
+ * @param eventId - Event ID.
3685
+ * @public
3686
+ * @documentationMaturity preview
3687
+ * @requiredField eventId
3688
+ * @permissionScope Read Events - all read permissions
3689
+ * @permissionScope Manage Bookings Services and Settings
3690
+ * @permissionScope Manage Events - all permissions
3691
+ * @permissionScope Read Events
3692
+ * @permissionScope Manage Guest List
3693
+ * @permissionScope Manage Events
3694
+ * @applicableIdentity APP
3695
+ * @applicableIdentity MEMBER
3696
+ * @applicableIdentity VISITOR
3697
+ * @returns Event.
3698
+ */
3699
+ export declare function getEvent(eventId: string | null, options?: GetEventOptions): Promise<Event & NonNullable<GetEventResponseNonNullableFields>['event']>;
3700
+ export interface GetEventOptions {
3701
+ /**
3702
+ * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
3703
+ * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
3704
+ * - `TEXTS`: Returns `detailedDescription`.
3705
+ * - `REGISTRATION`: Returns `registration`.
3706
+ * - `URLS`: Returns `eventPageUrl`.
3707
+ * - `FORM`: Returns `form`.
3708
+ * - `DASHBOARD`: Returns `summaries`.
3709
+ * - `FEED`: Returns `feed`.
3710
+ * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
3711
+ * - `SEO_SETTINGS`: Returns `seoSettings`.
3712
+ * - `AGENDA`: Returns `agendaSettings`.
3713
+ * - `CATEGORIES`: Returns `categories`.
3714
+ */
3715
+ fields?: RequestedFields[];
3716
+ }
3717
+ /**
3718
+ * Retrieves an event by the slug URL.
3719
+ * @param slug - URL slug.
3720
+ * @public
3721
+ * @documentationMaturity preview
3722
+ * @requiredField slug
3723
+ * @permissionScope Read Events - all read permissions
3724
+ * @permissionScope Manage Bookings Services and Settings
3725
+ * @permissionScope Manage Events - all permissions
3726
+ * @permissionScope Read Events
3727
+ * @permissionScope Manage Guest List
3728
+ * @permissionScope Manage Events
3729
+ * @applicableIdentity APP
3730
+ * @applicableIdentity MEMBER
3731
+ * @applicableIdentity VISITOR
3732
+ */
3733
+ export declare function getEventBySlug(slug: string | null, options?: GetEventBySlugOptions): Promise<GetEventBySlugResponse & GetEventBySlugResponseNonNullableFields>;
3734
+ export interface GetEventBySlugOptions {
3735
+ /**
3736
+ * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
3737
+ * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
3738
+ * - `TEXTS`: Returns `detailedDescription`.
3739
+ * - `REGISTRATION`: Returns `registration`.
3740
+ * - `URLS`: Returns `eventPageUrl`.
3741
+ * - `FORM`: Returns `form`.
3742
+ * - `DASHBOARD`: Returns `summaries`.
3743
+ * - `FEED`: Returns `feed`.
3744
+ * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
3745
+ * - `SEO_SETTINGS`: Returns `seoSettings`.
3746
+ * - `AGENDA`: Returns `agendaSettings`.
3747
+ * - `CATEGORIES`: Returns `categories`.
3748
+ */
3749
+ fields?: RequestedFields[];
3750
+ }
3751
+ /**
3752
+ * Finds an event by ID or URL slug. In contrast to Get Event endpoint which returns not found error,
3753
+ * Find Event returns empty response when an event is not found.
3754
+ * @public
3755
+ * @documentationMaturity preview
3756
+ * @permissionScope Read Events - all read permissions
3757
+ * @permissionScope Manage Bookings Services and Settings
3758
+ * @permissionScope Manage Events - all permissions
3759
+ * @permissionScope Read Events
3760
+ * @permissionScope Manage Guest List
3761
+ * @permissionScope Manage Events
3762
+ * @applicableIdentity APP
3763
+ * @applicableIdentity MEMBER
3764
+ * @applicableIdentity VISITOR
3765
+ */
3766
+ export declare function findEvent(options?: FindEventOptions): Promise<FindEventResponse & FindEventResponseNonNullableFields>;
3767
+ export interface FindEventOptions extends FindEventRequestFindByOneOf {
3768
+ /** Event ID. */
3769
+ eventId?: string | null;
3770
+ /** URL slug. */
3771
+ slug?: string | null;
3772
+ /**
3773
+ * Controls which event properties are returned. See [Fieldset](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_event-fieldset).
3774
+ * Some fields require additional computation that affects latency.
3775
+ * Use minimum set of required fieldset for best performance.
3776
+ */
3777
+ fields?: RequestedFields[];
3778
+ }
3779
+ export {};