@wix/events 1.0.174 → 1.0.176

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