@wix/events 1.0.173 → 1.0.175

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