@wix/events 1.0.146 → 1.0.148

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (257) hide show
  1. package/build/cjs/index.d.ts +7 -1
  2. package/build/cjs/index.js +8 -2
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/index.typings.d.ts +7 -1
  5. package/build/cjs/index.typings.js +8 -2
  6. package/build/cjs/index.typings.js.map +1 -1
  7. package/build/cjs/meta.d.ts +7 -1
  8. package/build/cjs/meta.js +8 -2
  9. package/build/cjs/meta.js.map +1 -1
  10. package/build/cjs/src/events-guests-v1-guest.http.d.ts +23 -0
  11. package/build/cjs/src/events-guests-v1-guest.http.js +116 -0
  12. package/build/cjs/src/events-guests-v1-guest.http.js.map +1 -0
  13. package/build/cjs/src/events-guests-v1-guest.meta.d.ts +13 -0
  14. package/build/cjs/src/events-guests-v1-guest.meta.js +47 -0
  15. package/build/cjs/src/events-guests-v1-guest.meta.js.map +1 -0
  16. package/build/cjs/src/events-guests-v1-guest.public.d.ts +7 -0
  17. package/build/cjs/src/events-guests-v1-guest.public.js +24 -0
  18. package/build/cjs/src/events-guests-v1-guest.public.js.map +1 -0
  19. package/build/cjs/src/events-guests-v1-guest.types.d.ts +867 -0
  20. package/build/cjs/src/events-guests-v1-guest.types.js +105 -0
  21. package/build/cjs/src/events-guests-v1-guest.types.js.map +1 -0
  22. package/build/cjs/src/events-guests-v1-guest.universal.d.ts +931 -0
  23. package/build/cjs/src/events-guests-v1-guest.universal.js +241 -0
  24. package/build/cjs/src/events-guests-v1-guest.universal.js.map +1 -0
  25. package/build/cjs/src/events-v1-order-checkout.http.d.ts +89 -0
  26. package/build/cjs/src/events-v1-order-checkout.http.js +1073 -0
  27. package/build/cjs/src/events-v1-order-checkout.http.js.map +1 -0
  28. package/build/cjs/src/events-v1-order-checkout.meta.d.ts +26 -0
  29. package/build/cjs/src/events-v1-order-checkout.meta.js +180 -0
  30. package/build/cjs/src/events-v1-order-checkout.meta.js.map +1 -0
  31. package/build/cjs/src/events-v1-order-checkout.public.d.ts +15 -0
  32. package/build/cjs/src/events-v1-order-checkout.public.js +69 -0
  33. package/build/cjs/src/events-v1-order-checkout.public.js.map +1 -0
  34. package/build/cjs/src/events-v1-order-checkout.types.d.ts +3626 -0
  35. package/build/cjs/src/events-v1-order-checkout.types.js +145 -0
  36. package/build/cjs/src/events-v1-order-checkout.types.js.map +1 -0
  37. package/build/cjs/src/events-v1-order-checkout.universal.d.ts +3645 -0
  38. package/build/cjs/src/events-v1-order-checkout.universal.js +824 -0
  39. package/build/cjs/src/events-v1-order-checkout.universal.js.map +1 -0
  40. package/build/cjs/src/events-v1-order-orders.http.d.ts +121 -0
  41. package/build/cjs/src/events-v1-order-orders.http.js +1105 -0
  42. package/build/cjs/src/events-v1-order-orders.http.js.map +1 -0
  43. package/build/cjs/src/events-v1-order-orders.meta.d.ts +28 -0
  44. package/build/cjs/src/events-v1-order-orders.meta.js +142 -0
  45. package/build/cjs/src/events-v1-order-orders.meta.js.map +1 -0
  46. package/build/cjs/src/events-v1-order-orders.public.d.ts +220 -0
  47. package/build/cjs/src/events-v1-order-orders.public.js +57 -0
  48. package/build/cjs/src/events-v1-order-orders.public.js.map +1 -0
  49. package/build/cjs/src/events-v1-order-orders.types.d.ts +3626 -0
  50. package/build/cjs/src/events-v1-order-orders.types.js +145 -0
  51. package/build/cjs/src/events-v1-order-orders.types.js.map +1 -0
  52. package/build/cjs/src/events-v1-order-orders.universal.d.ts +3615 -0
  53. package/build/cjs/src/events-v1-order-orders.universal.js +679 -0
  54. package/build/cjs/src/events-v1-order-orders.universal.js.map +1 -0
  55. package/build/cjs/src/events-v1-ticket-definition.http.d.ts +50 -0
  56. package/build/cjs/src/events-v1-ticket-definition.http.js +413 -0
  57. package/build/cjs/src/events-v1-ticket-definition.http.js.map +1 -0
  58. package/build/cjs/src/events-v1-ticket-definition.meta.d.ts +23 -0
  59. package/build/cjs/src/{events-v3-ticket-definition.meta.js → events-v1-ticket-definition.meta.js} +42 -42
  60. package/build/cjs/src/events-v1-ticket-definition.meta.js.map +1 -0
  61. package/build/cjs/src/events-v1-ticket-definition.public.d.ts +61 -0
  62. package/build/cjs/src/events-v1-ticket-definition.public.js +57 -0
  63. package/build/cjs/src/events-v1-ticket-definition.public.js.map +1 -0
  64. package/build/cjs/src/events-v1-ticket-definition.types.d.ts +725 -0
  65. package/build/cjs/src/events-v1-ticket-definition.types.js +63 -0
  66. package/build/cjs/src/events-v1-ticket-definition.types.js.map +1 -0
  67. package/build/cjs/src/events-v1-ticket-definition.universal.d.ts +960 -0
  68. package/build/cjs/src/events-v1-ticket-definition.universal.js +618 -0
  69. package/build/cjs/src/events-v1-ticket-definition.universal.js.map +1 -0
  70. package/build/cjs/src/events-v1-ticket.http.d.ts +44 -0
  71. package/build/cjs/src/events-v1-ticket.http.js +570 -0
  72. package/build/cjs/src/events-v1-ticket.http.js.map +1 -0
  73. package/build/cjs/src/events-v1-ticket.meta.d.ts +28 -0
  74. package/build/cjs/src/events-v1-ticket.meta.js +142 -0
  75. package/build/cjs/src/events-v1-ticket.meta.js.map +1 -0
  76. package/build/cjs/src/events-v1-ticket.public.d.ts +45 -0
  77. package/build/cjs/src/events-v1-ticket.public.js +48 -0
  78. package/build/cjs/src/events-v1-ticket.public.js.map +1 -0
  79. package/build/cjs/src/events-v1-ticket.types.d.ts +791 -0
  80. package/build/cjs/src/events-v1-ticket.types.js +76 -0
  81. package/build/cjs/src/events-v1-ticket.types.js.map +1 -0
  82. package/build/cjs/src/events-v1-ticket.universal.d.ts +892 -0
  83. package/build/cjs/src/events-v1-ticket.universal.js +621 -0
  84. package/build/cjs/src/events-v1-ticket.universal.js.map +1 -0
  85. package/build/cjs/src/events-v2-policy.http.d.ts +80 -0
  86. package/build/cjs/src/events-v2-policy.http.js +308 -0
  87. package/build/cjs/src/events-v2-policy.http.js.map +1 -0
  88. package/build/cjs/src/events-v2-policy.meta.d.ts +24 -0
  89. package/build/cjs/src/events-v2-policy.meta.js +142 -0
  90. package/build/cjs/src/events-v2-policy.meta.js.map +1 -0
  91. package/build/cjs/src/events-v2-policy.public.d.ts +25 -0
  92. package/build/cjs/src/events-v2-policy.public.js +48 -0
  93. package/build/cjs/src/events-v2-policy.public.js.map +1 -0
  94. package/build/cjs/src/events-v2-policy.types.d.ts +472 -0
  95. package/build/cjs/src/events-v2-policy.types.js +56 -0
  96. package/build/cjs/src/events-v2-policy.types.js.map +1 -0
  97. package/build/cjs/src/events-v2-policy.universal.d.ts +721 -0
  98. package/build/cjs/src/events-v2-policy.universal.js +539 -0
  99. package/build/cjs/src/events-v2-policy.universal.js.map +1 -0
  100. package/build/cjs/src/events-v3-event.http.d.ts +69 -0
  101. package/build/cjs/src/events-v3-event.http.js +661 -0
  102. package/build/cjs/src/events-v3-event.http.js.map +1 -0
  103. package/build/cjs/src/events-v3-event.meta.d.ts +39 -0
  104. package/build/cjs/src/events-v3-event.meta.js +275 -0
  105. package/build/cjs/src/events-v3-event.meta.js.map +1 -0
  106. package/build/cjs/src/events-v3-event.public.d.ts +566 -0
  107. package/build/cjs/src/events-v3-event.public.js +106 -0
  108. package/build/cjs/src/events-v3-event.public.js.map +1 -0
  109. package/build/cjs/src/events-v3-event.types.d.ts +3678 -0
  110. package/build/cjs/src/events-v3-event.types.js +261 -0
  111. package/build/cjs/src/events-v3-event.types.js.map +1 -0
  112. package/build/cjs/src/events-v3-event.universal.d.ts +3846 -0
  113. package/build/cjs/src/events-v3-event.universal.js +1165 -0
  114. package/build/cjs/src/events-v3-event.universal.js.map +1 -0
  115. package/build/es/index.d.ts +7 -1
  116. package/build/es/index.js +7 -1
  117. package/build/es/index.js.map +1 -1
  118. package/build/es/index.typings.d.ts +7 -1
  119. package/build/es/index.typings.js +7 -1
  120. package/build/es/index.typings.js.map +1 -1
  121. package/build/es/meta.d.ts +7 -1
  122. package/build/es/meta.js +7 -1
  123. package/build/es/meta.js.map +1 -1
  124. package/build/es/src/events-guests-v1-guest.http.d.ts +23 -0
  125. package/build/es/src/events-guests-v1-guest.http.js +112 -0
  126. package/build/es/src/events-guests-v1-guest.http.js.map +1 -0
  127. package/build/es/src/events-guests-v1-guest.meta.d.ts +13 -0
  128. package/build/es/src/events-guests-v1-guest.meta.js +20 -0
  129. package/build/es/src/events-guests-v1-guest.meta.js.map +1 -0
  130. package/build/es/src/events-guests-v1-guest.public.d.ts +7 -0
  131. package/build/es/src/events-guests-v1-guest.public.js +9 -0
  132. package/build/es/src/events-guests-v1-guest.public.js.map +1 -0
  133. package/build/es/src/events-guests-v1-guest.types.d.ts +867 -0
  134. package/build/es/src/events-guests-v1-guest.types.js +102 -0
  135. package/build/es/src/events-guests-v1-guest.types.js.map +1 -0
  136. package/build/es/src/events-guests-v1-guest.universal.d.ts +931 -0
  137. package/build/es/src/events-guests-v1-guest.universal.js +214 -0
  138. package/build/es/src/events-guests-v1-guest.universal.js.map +1 -0
  139. package/build/es/src/events-v1-order-checkout.http.d.ts +89 -0
  140. package/build/es/src/events-v1-order-checkout.http.js +1056 -0
  141. package/build/es/src/events-v1-order-checkout.http.js.map +1 -0
  142. package/build/es/src/events-v1-order-checkout.meta.d.ts +26 -0
  143. package/build/es/src/events-v1-order-checkout.meta.js +146 -0
  144. package/build/es/src/events-v1-order-checkout.meta.js.map +1 -0
  145. package/build/es/src/events-v1-order-checkout.public.d.ts +15 -0
  146. package/build/es/src/events-v1-order-checkout.public.js +44 -0
  147. package/build/es/src/events-v1-order-checkout.public.js.map +1 -0
  148. package/build/es/src/events-v1-order-checkout.types.d.ts +3626 -0
  149. package/build/es/src/events-v1-order-checkout.types.js +142 -0
  150. package/build/es/src/events-v1-order-checkout.types.js.map +1 -0
  151. package/build/es/src/events-v1-order-checkout.universal.d.ts +3645 -0
  152. package/build/es/src/events-v1-order-checkout.universal.js +790 -0
  153. package/build/es/src/events-v1-order-checkout.universal.js.map +1 -0
  154. package/build/es/src/events-v1-order-orders.http.d.ts +121 -0
  155. package/build/es/src/events-v1-order-orders.http.js +1088 -0
  156. package/build/es/src/events-v1-order-orders.http.js.map +1 -0
  157. package/build/es/src/events-v1-order-orders.meta.d.ts +28 -0
  158. package/build/es/src/events-v1-order-orders.meta.js +110 -0
  159. package/build/es/src/events-v1-order-orders.meta.js.map +1 -0
  160. package/build/es/src/events-v1-order-orders.public.d.ts +220 -0
  161. package/build/es/src/events-v1-order-orders.public.js +34 -0
  162. package/build/es/src/events-v1-order-orders.public.js.map +1 -0
  163. package/build/es/src/events-v1-order-orders.types.d.ts +3626 -0
  164. package/build/es/src/events-v1-order-orders.types.js +142 -0
  165. package/build/es/src/events-v1-order-orders.types.js.map +1 -0
  166. package/build/es/src/events-v1-order-orders.universal.d.ts +3615 -0
  167. package/build/es/src/events-v1-order-orders.universal.js +647 -0
  168. package/build/es/src/events-v1-order-orders.universal.js.map +1 -0
  169. package/build/es/src/events-v1-ticket-definition.http.d.ts +50 -0
  170. package/build/es/src/events-v1-ticket-definition.http.js +403 -0
  171. package/build/es/src/events-v1-ticket-definition.http.js.map +1 -0
  172. package/build/es/src/events-v1-ticket-definition.meta.d.ts +23 -0
  173. package/build/es/src/{events-v3-ticket-definition.meta.js → events-v1-ticket-definition.meta.js} +35 -35
  174. package/build/es/src/events-v1-ticket-definition.meta.js.map +1 -0
  175. package/build/es/src/events-v1-ticket-definition.public.d.ts +61 -0
  176. package/build/es/src/events-v1-ticket-definition.public.js +39 -0
  177. package/build/es/src/events-v1-ticket-definition.public.js.map +1 -0
  178. package/build/es/src/events-v1-ticket-definition.types.d.ts +725 -0
  179. package/build/es/src/events-v1-ticket-definition.types.js +60 -0
  180. package/build/es/src/events-v1-ticket-definition.types.js.map +1 -0
  181. package/build/es/src/events-v1-ticket-definition.universal.d.ts +960 -0
  182. package/build/es/src/events-v1-ticket-definition.universal.js +585 -0
  183. package/build/es/src/events-v1-ticket-definition.universal.js.map +1 -0
  184. package/build/es/src/events-v1-ticket.http.d.ts +44 -0
  185. package/build/es/src/events-v1-ticket.http.js +561 -0
  186. package/build/es/src/events-v1-ticket.http.js.map +1 -0
  187. package/build/es/src/events-v1-ticket.meta.d.ts +28 -0
  188. package/build/es/src/events-v1-ticket.meta.js +110 -0
  189. package/build/es/src/events-v1-ticket.meta.js.map +1 -0
  190. package/build/es/src/events-v1-ticket.public.d.ts +45 -0
  191. package/build/es/src/events-v1-ticket.public.js +34 -0
  192. package/build/es/src/events-v1-ticket.public.js.map +1 -0
  193. package/build/es/src/events-v1-ticket.types.d.ts +791 -0
  194. package/build/es/src/events-v1-ticket.types.js +73 -0
  195. package/build/es/src/events-v1-ticket.types.js.map +1 -0
  196. package/build/es/src/events-v1-ticket.universal.d.ts +892 -0
  197. package/build/es/src/events-v1-ticket.universal.js +589 -0
  198. package/build/es/src/events-v1-ticket.universal.js.map +1 -0
  199. package/build/es/src/events-v2-policy.http.d.ts +80 -0
  200. package/build/es/src/events-v2-policy.http.js +299 -0
  201. package/build/es/src/events-v2-policy.http.js.map +1 -0
  202. package/build/es/src/events-v2-policy.meta.d.ts +24 -0
  203. package/build/es/src/events-v2-policy.meta.js +110 -0
  204. package/build/es/src/events-v2-policy.meta.js.map +1 -0
  205. package/build/es/src/events-v2-policy.public.d.ts +25 -0
  206. package/build/es/src/events-v2-policy.public.js +34 -0
  207. package/build/es/src/events-v2-policy.public.js.map +1 -0
  208. package/build/es/src/events-v2-policy.types.d.ts +472 -0
  209. package/build/es/src/events-v2-policy.types.js +53 -0
  210. package/build/es/src/events-v2-policy.types.js.map +1 -0
  211. package/build/es/src/events-v2-policy.universal.d.ts +721 -0
  212. package/build/es/src/events-v2-policy.universal.js +507 -0
  213. package/build/es/src/events-v2-policy.universal.js.map +1 -0
  214. package/build/es/src/events-v3-event.http.d.ts +69 -0
  215. package/build/es/src/events-v3-event.http.js +645 -0
  216. package/build/es/src/events-v3-event.http.js.map +1 -0
  217. package/build/es/src/events-v3-event.meta.d.ts +39 -0
  218. package/build/es/src/events-v3-event.meta.js +236 -0
  219. package/build/es/src/events-v3-event.meta.js.map +1 -0
  220. package/build/es/src/events-v3-event.public.d.ts +566 -0
  221. package/build/es/src/events-v3-event.public.js +69 -0
  222. package/build/es/src/events-v3-event.public.js.map +1 -0
  223. package/build/es/src/events-v3-event.types.d.ts +3678 -0
  224. package/build/es/src/events-v3-event.types.js +258 -0
  225. package/build/es/src/events-v3-event.types.js.map +1 -0
  226. package/build/es/src/events-v3-event.universal.d.ts +3846 -0
  227. package/build/es/src/events-v3-event.universal.js +1126 -0
  228. package/build/es/src/events-v3-event.universal.js.map +1 -0
  229. package/package.json +2 -2
  230. package/build/cjs/src/events-v3-ticket-definition.http.d.ts +0 -33
  231. package/build/cjs/src/events-v3-ticket-definition.http.js +0 -271
  232. package/build/cjs/src/events-v3-ticket-definition.http.js.map +0 -1
  233. package/build/cjs/src/events-v3-ticket-definition.meta.d.ts +0 -25
  234. package/build/cjs/src/events-v3-ticket-definition.meta.js.map +0 -1
  235. package/build/cjs/src/events-v3-ticket-definition.public.d.ts +0 -98
  236. package/build/cjs/src/events-v3-ticket-definition.public.js +0 -63
  237. package/build/cjs/src/events-v3-ticket-definition.public.js.map +0 -1
  238. package/build/cjs/src/events-v3-ticket-definition.types.d.ts +0 -1265
  239. package/build/cjs/src/events-v3-ticket-definition.types.js +0 -195
  240. package/build/cjs/src/events-v3-ticket-definition.types.js.map +0 -1
  241. package/build/cjs/src/events-v3-ticket-definition.universal.d.ts +0 -1449
  242. package/build/cjs/src/events-v3-ticket-definition.universal.js +0 -698
  243. package/build/cjs/src/events-v3-ticket-definition.universal.js.map +0 -1
  244. package/build/es/src/events-v3-ticket-definition.http.d.ts +0 -33
  245. package/build/es/src/events-v3-ticket-definition.http.js +0 -261
  246. package/build/es/src/events-v3-ticket-definition.http.js.map +0 -1
  247. package/build/es/src/events-v3-ticket-definition.meta.d.ts +0 -25
  248. package/build/es/src/events-v3-ticket-definition.meta.js.map +0 -1
  249. package/build/es/src/events-v3-ticket-definition.public.d.ts +0 -98
  250. package/build/es/src/events-v3-ticket-definition.public.js +0 -39
  251. package/build/es/src/events-v3-ticket-definition.public.js.map +0 -1
  252. package/build/es/src/events-v3-ticket-definition.types.d.ts +0 -1265
  253. package/build/es/src/events-v3-ticket-definition.types.js +0 -192
  254. package/build/es/src/events-v3-ticket-definition.types.js.map +0 -1
  255. package/build/es/src/events-v3-ticket-definition.universal.d.ts +0 -1449
  256. package/build/es/src/events-v3-ticket-definition.universal.js +0 -665
  257. package/build/es/src/events-v3-ticket-definition.universal.js.map +0 -1
@@ -1,1449 +0,0 @@
1
- export declare const __debug: {
2
- verboseLogging: {
3
- on: () => boolean;
4
- off: () => boolean;
5
- };
6
- };
7
- export interface TicketDefinition {
8
- /**
9
- * Ticket definition ID.
10
- * @readonly
11
- */
12
- _id?: string | null;
13
- /** Event ID to which the ticket definition belongs. */
14
- eventId?: string | null;
15
- /**
16
- * Revision number, which increments by 1 each time the ticket definition is updated. To prevent conflicting changes, the existing revision must be used when updating a ticket definition.
17
- * @readonly
18
- */
19
- revision?: string | null;
20
- /**
21
- * Date and time when the ticket definition was created in `yyyy-mm-ddThh:mm:sssZ` format.
22
- * @readonly
23
- */
24
- _createdDate?: Date;
25
- /**
26
- * Date and time of the ticket definition's latest update in `yyyy-mm-ddThh:mm:sssZ` format.
27
- * @readonly
28
- */
29
- _updatedDate?: Date;
30
- name?: string | null;
31
- description?: string | null;
32
- policyText?: string | null;
33
- /** Whether this ticket definition is hidden to customers and cannot be purchased. */
34
- hidden?: boolean;
35
- /**
36
- * Whether the ticket has a limited maximum quantity.
37
- * @readonly
38
- */
39
- limited?: boolean;
40
- /** The maximum number of tickets that can be sold for the event when first defining the event. If a seating map is defined after you created a ticket definition, this property is ignored and `actualLimit` is used instead. */
41
- initialLimit?: number | null;
42
- /**
43
- * The maximum number of tickets that can be sold for the event after adding a seating map to the event. If no seating map is defined, this property is the same as `initialLimit`.
44
- * @readonly
45
- */
46
- actualLimit?: number | null;
47
- /** Ticket pricing method. */
48
- pricingMethod?: PricingMethod;
49
- /** Whether fee is included in the ticket price or customer pays it additionally at checkout. <br> <br> `FEE_INCLUDED`: The fee is deducted from the ticket price for a seller. For example, if you're selling tickets for $10, then a service fee of $0.25 will be deducted from the price and you'll get $9.75 <br> <br> `FEE_ADDED_AT_CHECKOUT`: The fee is shown in addition to the ticket price at checkout and a guest pays the fee. For example, if you sell tickets for $10, a customer will see a service fee of $0.25 and will pay $10.25 in total. */
50
- feeType?: Type;
51
- /** Ticket sale period. */
52
- salePeriod?: SalePeriod;
53
- /**
54
- * Ticket sale status. <br> <br> `SALE_SCHEDULED`: Tickets are not on sale yet. <br> <br> `SALE_STARTED`: Tickets are on sale. <br> <br> `SALE_ENDED`: Tickets are not on sale.
55
- * @readonly
56
- */
57
- saleStatus?: SaleStatusEnumStatus;
58
- /** Ticket sales information. */
59
- salesDetails?: SalesDetails;
60
- /**
61
- * Limit of tickets that can be purchased per checkout.
62
- * Takes the smaller value between event ticket_limit_per_order and actual_limit values.
63
- * @readonly
64
- */
65
- limitPerCheckout?: number | null;
66
- }
67
- export interface PricingMethod extends PricingMethodPriceOneOf {
68
- /** Same ticket price for everyone. */
69
- fixedPrice?: Money;
70
- /** Minimum price guests must pay for a ticket. The price can be updated to a higher amount by a guest during the checkout. */
71
- guestPrice?: Money;
72
- /** Sets of various ticket prices. For example, you can charge different prices for children and adults. */
73
- pricingOptions?: PricingOptions;
74
- /**
75
- * Ticket price type. <br> <br> `STANDARD`: All money goes to a seller. Applies to all ticket pricing methods except for `guestPrice`. <br> <br> `DONATION`: All collected money is a donation. This pricing type is automatically assigned when the `guestPrice` pricing method is selected.
76
- * @readonly
77
- */
78
- pricingType?: PricingTypeEnumType;
79
- /**
80
- * Whether the ticket is free. To create a free ticket, enter `0` in the `pricingMethod.fixedPrice.value` field.
81
- * @readonly
82
- */
83
- free?: boolean;
84
- }
85
- /** @oneof */
86
- export interface PricingMethodPriceOneOf {
87
- /** Same ticket price for everyone. */
88
- fixedPrice?: Money;
89
- /** Minimum price guests must pay for a ticket. The price can be updated to a higher amount by a guest during the checkout. */
90
- guestPrice?: Money;
91
- /** Sets of various ticket prices. For example, you can charge different prices for children and adults. */
92
- pricingOptions?: PricingOptions;
93
- }
94
- /**
95
- * Money.
96
- * Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.
97
- */
98
- export interface Money {
99
- /** 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. */
100
- value?: string;
101
- /** Currency code. Must be a valid [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code (e.g., USD). */
102
- currency?: string;
103
- }
104
- export interface PricingOptions {
105
- /** Ticket price option details. */
106
- optionDetails?: OptionDetails[];
107
- }
108
- export interface OptionDetails {
109
- /** Ticket price option ID. */
110
- optionId?: string | null;
111
- /** Ticket price option name, such as "Child Ticket". */
112
- name?: string | null;
113
- /** Ticket price. */
114
- price?: Money;
115
- }
116
- export declare enum PricingTypeEnumType {
117
- UNKNOWN_PRICING_TYPE = "UNKNOWN_PRICING_TYPE",
118
- STANDARD = "STANDARD",
119
- DONATION = "DONATION"
120
- }
121
- export declare enum Type {
122
- UNKNOWN_FEE_TYPE = "UNKNOWN_FEE_TYPE",
123
- /** Seller absorbs the fee. It is deducted from the ticket price. */
124
- FEE_INCLUDED = "FEE_INCLUDED",
125
- /** Fee is added to the ticket price at checkout. */
126
- FEE_ADDED_AT_CHECKOUT = "FEE_ADDED_AT_CHECKOUT",
127
- /** Service fee is not collected - available only for free tickets and legacy users. */
128
- NO_FEE = "NO_FEE"
129
- }
130
- export interface SalePeriod {
131
- /** Ticket sale start timestamp in `yyyy-mm-ddThh:mm:sssZ` format. */
132
- startDate?: Date;
133
- /** Ticket sale end timestamp in `yyyy-mm-ddThh:mm:sssZ` format. */
134
- endDate?: Date;
135
- /** Whether to display the ticket if it's not available to buy. */
136
- displayNotOnSale?: boolean;
137
- }
138
- export declare enum SaleStatusEnumStatus {
139
- UNKNOWN_SALE_STATUS = "UNKNOWN_SALE_STATUS",
140
- /** Ticket sale is scheduled to start */
141
- SALE_SCHEDULED = "SALE_SCHEDULED",
142
- /** Ticket sale has started */
143
- SALE_STARTED = "SALE_STARTED",
144
- /** Ticket sale has ended */
145
- SALE_ENDED = "SALE_ENDED"
146
- }
147
- export interface SalesDetails {
148
- /**
149
- * Number of tickets that have not been purchased yet. The field is `null` if the ticket quantity is unlimited.
150
- * @readonly
151
- */
152
- unsoldCount?: number | null;
153
- /**
154
- * Number of purchased tickets.
155
- * @readonly
156
- */
157
- soldCount?: number | null;
158
- /**
159
- * Number of reserved tickets.
160
- * @readonly
161
- */
162
- reservedCount?: number | null;
163
- /**
164
- * Whether the tickets are sold out.
165
- * @readonly
166
- */
167
- soldOut?: boolean | null;
168
- }
169
- export interface GetTicketDefinitionSummaryRequest {
170
- /** Ticket definition id. */
171
- ticketDefinitionId?: string | null;
172
- }
173
- export interface GetTicketDefinitionSummaryResponse {
174
- /** Summary. */
175
- summary?: TicketDefinitionSummary;
176
- }
177
- export interface TicketDefinitionSummary {
178
- /**
179
- * Ticket definition ID.
180
- * @readonly
181
- */
182
- definitionId?: string | null;
183
- /**
184
- * Event ID to which the ticket definition summary belongs.
185
- * @readonly
186
- */
187
- eventId?: string | null;
188
- /**
189
- * Date and time of the ticket definition summary latest update in `yyyy-mm-ddThh:mm:sssZ` format.
190
- * @readonly
191
- */
192
- _updatedDate?: Date;
193
- /**
194
- * Reserved count.
195
- * @readonly
196
- */
197
- reservedCount?: number;
198
- /**
199
- * Sold count.
200
- * @readonly
201
- */
202
- soldCount?: number;
203
- /**
204
- * Free.
205
- * @readonly
206
- */
207
- free?: boolean;
208
- }
209
- export interface GetTicketDefinitionReservationRequest {
210
- /** Reservation id. */
211
- reservationId?: string | null;
212
- }
213
- export interface GetTicketDefinitionReservationResponse {
214
- /** Reservation */
215
- reservation?: TicketDefinitionReservation;
216
- }
217
- export interface TicketDefinitionReservation {
218
- /**
219
- * Reservation id.
220
- * @readonly
221
- */
222
- reservationId?: string | null;
223
- /**
224
- * Event ID to which the reservation belongs.
225
- * @readonly
226
- */
227
- eventId?: string | null;
228
- /**
229
- * Date and time of the reservation latest update in `yyyy-mm-ddThh:mm:sssZ` format.
230
- * @readonly
231
- */
232
- _updatedDate?: Date;
233
- }
234
- export interface ListEventTicketingSummaryRequest {
235
- /** Event ID. */
236
- eventId?: string[];
237
- }
238
- export interface ListEventTicketingSummaryResponse {
239
- /** Ticketing summaries. */
240
- summaries?: EventTicketingSummary[];
241
- }
242
- export interface EventTicketingSummary {
243
- /**
244
- * Event ID to which the ticketing summary belongs.
245
- * @readonly
246
- */
247
- eventId?: string | null;
248
- /**
249
- * Date and time of the ticketing summary latest update in `yyyy-mm-ddThh:mm:sssZ` format.
250
- * @readonly
251
- */
252
- _updatedDate?: Date;
253
- /**
254
- * Whether all tickets are sold for this event.
255
- * @readonly
256
- */
257
- soldOut?: boolean | null;
258
- /**
259
- * Price of lowest priced ticket.
260
- * @readonly
261
- */
262
- lowestTicketPrice?: Money;
263
- /**
264
- * Price of highest priced ticket.
265
- * @readonly
266
- */
267
- highestTicketPrice?: Money;
268
- /** Currency used in event transactions. */
269
- currency?: string | null;
270
- /**
271
- * Formatted price of lowest priced ticket.
272
- * @readonly
273
- */
274
- lowestTicketPriceFormatted?: string | null;
275
- /**
276
- * Formatted price of highest priced ticket.
277
- * @readonly
278
- */
279
- highestTicketPriceFormatted?: string | null;
280
- }
281
- export interface DomainEvent extends DomainEventBodyOneOf {
282
- createdEvent?: EntityCreatedEvent;
283
- updatedEvent?: EntityUpdatedEvent;
284
- deletedEvent?: EntityDeletedEvent;
285
- actionEvent?: ActionEvent;
286
- /**
287
- * Unique event ID.
288
- * Allows clients to ignore duplicate webhooks.
289
- */
290
- _id?: string;
291
- /**
292
- * Assumes actions are also always typed to an entity_type
293
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
294
- */
295
- entityFqdn?: string;
296
- /**
297
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
298
- * This is although the created/updated/deleted notion is duplication of the oneof types
299
- * Example: created/updated/deleted/started/completed/email_opened
300
- */
301
- slug?: string;
302
- /** ID of the entity associated with the event. */
303
- entityId?: string;
304
- /** Event timestamp. */
305
- eventTime?: Date;
306
- /**
307
- * Whether the event was triggered as a result of a privacy regulation application
308
- * (for example, GDPR).
309
- */
310
- triggeredByAnonymizeRequest?: boolean | null;
311
- /** If present, indicates the action that triggered the event. */
312
- originatedFrom?: string | null;
313
- /**
314
- * A sequence number defining the order of updates to the underlying entity.
315
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
316
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
317
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
318
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
319
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
320
- */
321
- entityEventSequence?: string | null;
322
- }
323
- /** @oneof */
324
- export interface DomainEventBodyOneOf {
325
- createdEvent?: EntityCreatedEvent;
326
- updatedEvent?: EntityUpdatedEvent;
327
- deletedEvent?: EntityDeletedEvent;
328
- actionEvent?: ActionEvent;
329
- }
330
- export interface EntityCreatedEvent {
331
- entityAsJson?: string;
332
- }
333
- export interface EntityUpdatedEvent {
334
- /**
335
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
336
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
337
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
338
- */
339
- currentEntityAsJson?: string;
340
- }
341
- export interface EntityDeletedEvent {
342
- /** Entity that was deleted */
343
- deletedEntityAsJson?: string | null;
344
- }
345
- export interface ActionEvent {
346
- bodyAsJson?: string;
347
- }
348
- export interface Empty {
349
- }
350
- export interface ReservationCreated {
351
- /** Reservation created timestamp in ISO UTC format. */
352
- timestamp?: Date;
353
- /** Event ID. */
354
- eventId?: string;
355
- /**
356
- * Reservation ID.
357
- * Can be used to retrieve a reservation invoice.
358
- */
359
- reservationId?: string;
360
- /** Reservation expiration timestamp. */
361
- expires?: Date;
362
- /** Reservation status. */
363
- status?: ReservationStatus;
364
- /** Reservation ticket quantities. */
365
- quantities?: TicketQuantity[];
366
- /** Reservation update timestamp. */
367
- _updatedDate?: Date;
368
- /** Reservation counts. */
369
- counts?: ReservationCount[];
370
- }
371
- export declare enum ReservationStatus {
372
- /**
373
- * Reservation is pending confirmation.
374
- * The reservation will expire after the expiration due time.
375
- */
376
- RESERVATION_PENDING = "RESERVATION_PENDING",
377
- /** The reservation was confirmed and will not expire. */
378
- RESERVATION_CONFIRMED = "RESERVATION_CONFIRMED",
379
- /** The reservation was canceled because of non payment. */
380
- RESERVATION_CANCELED = "RESERVATION_CANCELED",
381
- /** The reservation was canceled manually by the buyer. */
382
- RESERVATION_CANCELED_MANUALLY = "RESERVATION_CANCELED_MANUALLY",
383
- /** The reservation has expired. */
384
- RESERVATION_EXPIRED = "RESERVATION_EXPIRED"
385
- }
386
- export interface TicketQuantity {
387
- /** Ticket definition ID. */
388
- ticketDefinitionId?: string | null;
389
- /** Quantity. */
390
- quantity?: number | null;
391
- /** Quantity update timestamp. */
392
- _updatedDate?: Date;
393
- }
394
- export interface ReservationCount {
395
- /** Reservation Count snapshot timestamp. */
396
- timestamp?: Date;
397
- /** Ticket Definition ID. */
398
- ticketDefinitionId?: string;
399
- /** Confirmed reservation count. */
400
- confirmedCount?: number;
401
- /** Pending reservation count. */
402
- pendingCount?: number;
403
- /** True if paid ticket reservation exist. */
404
- paidExists?: boolean;
405
- }
406
- export interface ReservationUpdated {
407
- /** Reservation updated timestamp. */
408
- timestamp?: Date;
409
- /** Event ID. */
410
- eventId?: string;
411
- /**
412
- * Reservation ID.
413
- * Can be used to retrieve a reservation invoice.
414
- */
415
- reservationId?: string;
416
- /** Reservation status. */
417
- status?: ReservationStatus;
418
- /** Reservation expiration timestamp. */
419
- expires?: Date;
420
- /** Reservation ticket quantities. */
421
- quantities?: TicketQuantity[];
422
- /** Reservation update timestamp. */
423
- _updatedDate?: Date;
424
- /** Reservation counts. */
425
- counts?: ReservationCount[];
426
- }
427
- export interface EventDeleted {
428
- /** Event deleted timestamp in ISO UTC format. */
429
- timestamp?: Date;
430
- /** Event ID. */
431
- eventId?: string;
432
- /** Event title. */
433
- title?: string;
434
- /** Event creator user ID. */
435
- userId?: string | null;
436
- }
437
- export interface CreateTicketDefinitionRequest {
438
- /** Ticket definition info. */
439
- ticketDefinition: TicketDefinition;
440
- /** Requested fields. */
441
- fields?: Field[];
442
- }
443
- export declare enum Field {
444
- UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
445
- /** Include `unsoldCount`, `soldCount`, `reservedCount` and `soldOut` in the response. */
446
- SALES_DETAILS = "SALES_DETAILS"
447
- }
448
- export interface CreateTicketDefinitionResponse {
449
- /** Created ticket definition. */
450
- ticketDefinition?: TicketDefinition;
451
- }
452
- export interface UpdateTicketDefinitionRequest {
453
- /** Ticket definition to update. */
454
- ticketDefinition: TicketDefinition;
455
- /** Requested fields. */
456
- fields?: Field[];
457
- }
458
- export interface UpdateTicketDefinitionResponse {
459
- /** The updated ticket definition. */
460
- ticketDefinition?: TicketDefinition;
461
- }
462
- export interface SalePeriodUpdated {
463
- /** Ticket definition sale period after update. */
464
- afterUpdate?: SalePeriod;
465
- }
466
- export interface GetTicketDefinitionRequest {
467
- /** Ticket definition ID. */
468
- ticketDefinitionId: string;
469
- /**
470
- * Predefined sets of fields to return.
471
- * - `SALES_DETAILS`: Returns `salesDetails`.
472
- */
473
- fields?: Field[];
474
- }
475
- export interface GetTicketDefinitionResponse {
476
- /** The requested ticket definition. */
477
- ticketDefinition?: TicketDefinition;
478
- }
479
- export interface DeleteTicketDefinitionRequest {
480
- /** ID of the ticket definition to delete. */
481
- ticketDefinitionId: string;
482
- }
483
- export interface DeleteTicketDefinitionResponse {
484
- }
485
- export interface ReorderTicketDefinitionsRequest extends ReorderTicketDefinitionsRequestReferenceDefinitionOneOf {
486
- /** Move the given `definitionId` before the referenced ticket definition. */
487
- beforeDefinitionId?: string;
488
- /** Move the given `definitionId` after the referenced ticket definition. */
489
- afterDefinitionId?: string;
490
- /** Event ID. */
491
- eventId: string;
492
- /** Ticket definition ID. */
493
- ticketDefinitionId: string;
494
- }
495
- /** @oneof */
496
- export interface ReorderTicketDefinitionsRequestReferenceDefinitionOneOf {
497
- /** Move the given `definitionId` before the referenced ticket definition. */
498
- beforeDefinitionId?: string;
499
- /** Move the given `definitionId` after the referenced ticket definition. */
500
- afterDefinitionId?: string;
501
- }
502
- export interface ReorderTicketDefinitionsResponse {
503
- }
504
- export interface UpdateTicketDefinitionSortIndexRequest {
505
- /** Ticket definition ID */
506
- ticketDefinitionId?: string;
507
- /** The revision of the ticket definition */
508
- revision?: string;
509
- /** the sort index of a ticket definition to set */
510
- sortIndex?: number;
511
- /** Requested fields. */
512
- fields?: Field[];
513
- }
514
- export interface UpdateTicketDefinitionSortIndexResponse {
515
- /** the updated ticket definition */
516
- ticketDefinition?: TicketDefinition;
517
- }
518
- export interface QueryTicketDefinitionsRequest {
519
- /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
520
- query: QueryV2;
521
- /**
522
- * Predefined sets of fields to return.
523
- * - `SALES_DETAILS`: Returns `salesDetails`.
524
- */
525
- fields?: Field[];
526
- }
527
- export interface QueryV2 extends QueryV2PagingMethodOneOf {
528
- /** Paging options to limit and skip the number of items. */
529
- paging?: Paging;
530
- /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort` parameters. */
531
- cursorPaging?: CursorPaging;
532
- /** Filter object in the following format: <br/> `"filter" : { "fieldName1": "value1", "fieldName2":{"$operator":"value2"} }`. <br/> <br/> **Example:** <br/> `"filter" : { "id": "2224a9d1-79e6-4549-a5c5-bf7ce5aac1a5", "revision": {"$ne":"1"} }` */
533
- filter?: Record<string, any> | null;
534
- /** Sort object in the following format: <br/> `[{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]` <br/> <br/> **Example:** <br/> `[{"fieldName":"createdDate","direction":"DESC"}]` <br/> <br/> See [supported fields](https://dev.wix.com/api/rest/wix-events/policy-v2/filter-and-sort) for more information. */
535
- sort?: Sorting[];
536
- }
537
- /** @oneof */
538
- export interface QueryV2PagingMethodOneOf {
539
- /** Paging options to limit and skip the number of items. */
540
- paging?: Paging;
541
- /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort` parameters. */
542
- cursorPaging?: CursorPaging;
543
- }
544
- export interface Sorting {
545
- /** Name of the field to sort by. */
546
- fieldName?: string;
547
- /** Defaults to `ASC` */
548
- order?: SortOrder;
549
- }
550
- export declare enum SortOrder {
551
- ASC = "ASC",
552
- DESC = "DESC"
553
- }
554
- export interface Paging {
555
- /** Number of items to load per page. */
556
- limit?: number | null;
557
- /** Number of items to skip in the current sort order. */
558
- offset?: number | null;
559
- }
560
- export interface CursorPaging {
561
- /** Number of items to load per page. */
562
- limit?: number | null;
563
- /**
564
- * Pointer to the next or previous page in the list of results.
565
- * You can get the relevant cursor token
566
- * from the `pagingMetadata` object in the previous call's response.
567
- * Not relevant for the first request.
568
- */
569
- cursor?: string | null;
570
- }
571
- export interface QueryTicketDefinitionsResponse {
572
- /** List of ticket definitions. */
573
- ticketDefinitions?: TicketDefinition[];
574
- /** Metadata for the paginated results. */
575
- metadata?: PagingMetadataV2;
576
- }
577
- export interface PagingMetadataV2 {
578
- /** Number of items returned in the response. */
579
- count?: number | null;
580
- /** Offset that was requested. */
581
- offset?: number | null;
582
- /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
583
- total?: number | null;
584
- /** Flag that indicates the server failed to calculate the `total` field. */
585
- tooManyToCount?: boolean | null;
586
- /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
587
- cursors?: Cursors;
588
- }
589
- export interface Cursors {
590
- /** Cursor pointing to next page in the list of results. */
591
- next?: string | null;
592
- /** Cursor pointing to previous page in the list of results. */
593
- prev?: string | null;
594
- }
595
- export interface QueryAvailableTicketDefinitionsRequest {
596
- /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
597
- query?: QueryV2;
598
- /** Requested fields. */
599
- fields?: Field[];
600
- }
601
- export interface QueryAvailableTicketDefinitionsResponse {
602
- /** List of ticket definitions. */
603
- ticketDefinitions?: TicketDefinition[];
604
- /** Metadata for the paginated results. */
605
- metadata?: PagingMetadataV2;
606
- }
607
- export interface CountTicketDefinitionsRequest {
608
- /** Filter object in the following format: <br/> `"filter" : { "fieldName1": "value1" }`. */
609
- filter?: Record<string, any> | null;
610
- /**
611
- * Parameters to count ticket definitions by.
612
- *
613
- * - Max: 20 facets.
614
- */
615
- facet?: string[];
616
- }
617
- export interface CountTicketDefinitionsResponse {
618
- /** Metadata for the paginated results. */
619
- metadata?: PagingMetadataV2;
620
- /** Filter facets. */
621
- facets?: Record<string, FacetCounts>;
622
- }
623
- export interface FacetCounts {
624
- /** Facet counts aggregated per value */
625
- counts?: Record<string, number>;
626
- }
627
- export interface BulkDeleteTicketDefinitionsByFilterRequest {
628
- /** Filter object in the following format: <br/> `"filter" : { "fieldName1": "value1" }`. <br/> <br/> **Example:** <br/> `"filter" : { "eventId": "3d3d5c04-ece0-45a8-85f0-11a58edaa192" }` */
629
- filter: Record<string, any> | null;
630
- }
631
- export interface BulkDeleteTicketDefinitionsByFilterResponse {
632
- }
633
- export interface ChangeCurrencyRequest {
634
- /** Event ID. */
635
- eventId?: string;
636
- /** Event currency, in 3-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. */
637
- currency?: string;
638
- }
639
- export interface ChangeCurrencyResponse {
640
- }
641
- export interface BulkCopyTicketDefinitionsByEventIdRequest {
642
- /** Origin instance ID. */
643
- originInstanceId?: string | null;
644
- /** Origin Event ID. */
645
- originEventId?: string;
646
- /** Target Event ID. */
647
- targetEventId?: string;
648
- }
649
- export interface BulkCopyTicketDefinitionsByEventIdResponse {
650
- /** Copied ticket definitions. */
651
- definitions?: CopiedTicketDefinition[];
652
- }
653
- export interface CopiedTicketDefinition {
654
- /** Origin Ticket definition ID. */
655
- originTicketDefinitionId?: string;
656
- /** Ticket definition ID. */
657
- ticketDefinitionId?: string;
658
- }
659
- export interface EventCanceled {
660
- /** Event canceled timestamp in ISO UTC format. */
661
- timestamp?: Date;
662
- /** Event ID. */
663
- eventId?: string;
664
- /** Event title */
665
- title?: string;
666
- /** Event creator user ID. */
667
- userId?: string | null;
668
- }
669
- export interface EventEnded {
670
- /** Event end timestamp in ISO UTC format. */
671
- timestamp?: Date;
672
- /** Event ID. */
673
- eventId?: string;
674
- }
675
- export interface EventCreated {
676
- /** Event created timestamp in ISO UTC format. */
677
- timestamp?: Date;
678
- /** Event ID. */
679
- eventId?: string;
680
- /** Event location. */
681
- location?: Location;
682
- /** Event schedule configuration. */
683
- scheduleConfig?: ScheduleConfig;
684
- /** Event title. */
685
- title?: string;
686
- /** Event creator user ID. */
687
- userId?: string | null;
688
- /** Event status. */
689
- status?: EventStatus;
690
- /** Instance ID. Indicates the original app instance which current event was derived from. */
691
- derivedFromInstanceId?: string | null;
692
- /** Event ID. Indicates the original event which current event was derived from. */
693
- derivedFromEventId?: string | null;
694
- }
695
- export interface Location {
696
- /** Location name. */
697
- name?: string | null;
698
- /** Location map coordinates. */
699
- coordinates?: MapCoordinates;
700
- /** Single line address representation. */
701
- address?: string | null;
702
- /** Location type. */
703
- type?: LocationType;
704
- /**
705
- * Full address derived from formatted single line `address`.
706
- * When `full_address` is used to create or update the event, deprecated `address` and `coordinates` are ignored.
707
- * If provided `full_address` has empty `formatted_address` or `coordinates`, it will be auto-completed using Atlas service.
708
- *
709
- * Migration notes:
710
- * - `full_address.formatted_address` is equivalent to `address`.
711
- * - `full_address.geocode` is equivalent to `coordinates`.
712
- */
713
- fullAddress?: Address;
714
- /**
715
- * Defines event location as TBD (To Be Determined).
716
- * When event location is not yet defined, `name` is displayed instead of location address.
717
- * `coordinates`, `address`, `type` and `full_address` are not required when location is TBD.
718
- */
719
- tbd?: boolean | null;
720
- }
721
- export interface MapCoordinates {
722
- /** Latitude. */
723
- lat?: number;
724
- /** Longitude. */
725
- lng?: number;
726
- }
727
- export declare enum LocationType {
728
- VENUE = "VENUE",
729
- ONLINE = "ONLINE"
730
- }
731
- /** Physical address */
732
- export interface Address extends AddressStreetOneOf {
733
- /** a break down of the street to number and street name */
734
- streetAddress?: StreetAddress;
735
- /** Main address line (usually street and number) as free text */
736
- addressLine1?: string | null;
737
- /** country code */
738
- country?: string | null;
739
- /** subdivision (usually state or region) code according to ISO 3166-2 */
740
- subdivision?: string | null;
741
- /** city name */
742
- city?: string | null;
743
- /** zip/postal code */
744
- postalCode?: string | null;
745
- /** Free text providing more detailed address info. Usually contains Apt, Suite, Floor */
746
- addressLine2?: string | null;
747
- /** A string containing the human-readable address of this location */
748
- formatted?: string | null;
749
- /** coordinates of the physical address */
750
- location?: AddressLocation;
751
- }
752
- /** @oneof */
753
- export interface AddressStreetOneOf {
754
- /** a break down of the street to number and street name */
755
- streetAddress?: StreetAddress;
756
- /** Main address line (usually street and number) as free text */
757
- addressLine?: string | null;
758
- }
759
- export interface StreetAddress {
760
- /** street number */
761
- number?: string;
762
- /** street name */
763
- name?: string;
764
- }
765
- export interface AddressLocation {
766
- /** address latitude coordinates */
767
- latitude?: number | null;
768
- /** address longitude coordinates */
769
- longitude?: number | null;
770
- }
771
- export interface Subdivision {
772
- /** subdivision short code */
773
- code?: string;
774
- /** subdivision full-name */
775
- name?: string;
776
- }
777
- export declare enum SubdivisionType {
778
- UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
779
- /** State */
780
- ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
781
- /** County */
782
- ADMINISTRATIVE_AREA_LEVEL_2 = "ADMINISTRATIVE_AREA_LEVEL_2",
783
- /** City/town */
784
- ADMINISTRATIVE_AREA_LEVEL_3 = "ADMINISTRATIVE_AREA_LEVEL_3",
785
- /** Neighborhood/quarter */
786
- ADMINISTRATIVE_AREA_LEVEL_4 = "ADMINISTRATIVE_AREA_LEVEL_4",
787
- /** Street/block */
788
- ADMINISTRATIVE_AREA_LEVEL_5 = "ADMINISTRATIVE_AREA_LEVEL_5",
789
- /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
790
- COUNTRY = "COUNTRY"
791
- }
792
- export interface ScheduleConfig {
793
- /**
794
- * Defines event as TBD (To Be Determined) schedule.
795
- * When event time is not yet defined, TBD message is displayed instead of event start and end times.
796
- * `startDate`, `endDate` and `timeZoneId` are not required when schedule is TBD.
797
- */
798
- scheduleTbd?: boolean;
799
- /** TBD message. */
800
- scheduleTbdMessage?: string | null;
801
- /** Event start timestamp. */
802
- startDate?: Date;
803
- /** Event end timestamp. */
804
- endDate?: Date;
805
- /** Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`. */
806
- timeZoneId?: string | null;
807
- /** Whether end date is hidden in the formatted schedule. */
808
- endDateHidden?: boolean;
809
- /** Whether time zone is displayed in formatted schedule. */
810
- showTimeZone?: boolean;
811
- /** Event recurrences. */
812
- recurrences?: Recurrences;
813
- }
814
- export interface Recurrences {
815
- /** Event occurrences. */
816
- occurrences?: Occurrence[];
817
- /**
818
- * Recurring event category ID.
819
- * @readonly
820
- */
821
- categoryId?: string | null;
822
- /**
823
- * Recurrence status.
824
- * @readonly
825
- */
826
- status?: Status;
827
- }
828
- export interface Occurrence {
829
- /** Event start timestamp. */
830
- startDate?: Date;
831
- /** Event end timestamp. */
832
- endDate?: Date;
833
- /** Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`. */
834
- timeZoneId?: string | null;
835
- /** Whether time zone is displayed in formatted schedule. */
836
- showTimeZone?: boolean;
837
- }
838
- export declare enum Status {
839
- /** Event occurs only once. */
840
- ONE_TIME = "ONE_TIME",
841
- /** Event is recurring. */
842
- RECURRING = "RECURRING",
843
- /** Marks the next upcoming occurrence of the recurring event. */
844
- RECURRING_NEXT = "RECURRING_NEXT",
845
- /** Marks the most recent ended occurrence of the recurring event. */
846
- RECURRING_LAST_ENDED = "RECURRING_LAST_ENDED",
847
- /** Marks the most recent canceled occurrence of the recurring event. */
848
- RECURRING_LAST_CANCELED = "RECURRING_LAST_CANCELED"
849
- }
850
- export declare enum EventStatus {
851
- /** Event is public and scheduled to start */
852
- SCHEDULED = "SCHEDULED",
853
- /** Event has started */
854
- STARTED = "STARTED",
855
- /** Event has ended */
856
- ENDED = "ENDED",
857
- /** Event was canceled */
858
- CANCELED = "CANCELED",
859
- /** Event is not public and needs to be published */
860
- DRAFT = "DRAFT"
861
- }
862
- export interface EventUpdated {
863
- /** Event update timestamp in ISO UTC format. */
864
- timestamp?: Date;
865
- /** Event ID. */
866
- eventId?: string;
867
- /** Event location. */
868
- location?: Location;
869
- /** Event schedule configuration. */
870
- scheduleConfig?: ScheduleConfig;
871
- /** Event title. */
872
- title?: string;
873
- /** Whether schedule configuration was updated. */
874
- scheduleConfigUpdated?: boolean;
875
- }
876
- export interface SeatingPlanSummaryUpdated {
877
- /** Seating plan id */
878
- seatingPlanId?: string;
879
- /** External seating plan id */
880
- externalSeatingPlanId?: string | null;
881
- }
882
- export interface SeatingPlanCategoriesSummaryUpdated {
883
- /** Seating plan id */
884
- seatingPlanId?: string;
885
- /** External seating plan id */
886
- externalSeatingPlanId?: string | null;
887
- /** Ticket counts by category */
888
- categories?: CategoryDetails[];
889
- }
890
- export interface CategoryDetails {
891
- /**
892
- * Seating plan id
893
- * @readonly
894
- */
895
- seatingPlanId?: string | null;
896
- /**
897
- * External seating plan id
898
- * @readonly
899
- */
900
- externalSeatingPlanId?: string | null;
901
- /**
902
- * External category id
903
- * @readonly
904
- */
905
- externalCategoryId?: string | null;
906
- /**
907
- * Total capacity in the category
908
- * @readonly
909
- */
910
- totalCapacity?: number | null;
911
- /**
912
- * Already reserved capacity
913
- * @readonly
914
- */
915
- reserved?: number | null;
916
- }
917
- export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
918
- siteCreated?: SiteCreated;
919
- siteTransferred?: SiteTransferred;
920
- siteDeleted?: SiteDeleted;
921
- siteUndeleted?: SiteUndeleted;
922
- sitePublished?: SitePublished;
923
- siteUnpublished?: SiteUnpublished;
924
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
925
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
926
- serviceProvisioned?: ServiceProvisioned;
927
- serviceRemoved?: ServiceRemoved;
928
- siteRenamedPayload?: SiteRenamed;
929
- hardDeleted?: SiteHardDeleted;
930
- namespaceChanged?: NamespaceChanged;
931
- studioAssigned?: StudioAssigned;
932
- studioUnassigned?: StudioUnassigned;
933
- metaSiteId?: string;
934
- version?: string;
935
- timestamp?: string;
936
- assets?: Asset[];
937
- }
938
- /** @oneof */
939
- export interface MetaSiteSpecialEventPayloadOneOf {
940
- siteCreated?: SiteCreated;
941
- siteTransferred?: SiteTransferred;
942
- siteDeleted?: SiteDeleted;
943
- siteUndeleted?: SiteUndeleted;
944
- sitePublished?: SitePublished;
945
- siteUnpublished?: SiteUnpublished;
946
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
947
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
948
- serviceProvisioned?: ServiceProvisioned;
949
- serviceRemoved?: ServiceRemoved;
950
- siteRenamedPayload?: SiteRenamed;
951
- hardDeleted?: SiteHardDeleted;
952
- namespaceChanged?: NamespaceChanged;
953
- studioAssigned?: StudioAssigned;
954
- studioUnassigned?: StudioUnassigned;
955
- }
956
- export interface Asset {
957
- appDefId?: string;
958
- instanceId?: string;
959
- state?: State;
960
- }
961
- export declare enum State {
962
- UNKNOWN = "UNKNOWN",
963
- ENABLED = "ENABLED",
964
- DISABLED = "DISABLED",
965
- PENDING = "PENDING",
966
- DEMO = "DEMO"
967
- }
968
- export interface SiteCreated {
969
- originTemplateId?: string;
970
- ownerId?: string;
971
- context?: SiteCreatedContext;
972
- /**
973
- * A meta site id from which this site was created.
974
- *
975
- * In case of a creation from a template it's a template id.
976
- * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
977
- */
978
- originMetaSiteId?: string | null;
979
- siteName?: string;
980
- namespace?: Namespace;
981
- }
982
- export declare enum SiteCreatedContext {
983
- /** A valid option, we don't expose all reasons why site might be created. */
984
- OTHER = "OTHER",
985
- /** A meta site was created from template. */
986
- FROM_TEMPLATE = "FROM_TEMPLATE",
987
- /** A meta site was created by copying of the transfferred meta site. */
988
- DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
989
- /** A copy of existing meta site. */
990
- DUPLICATE = "DUPLICATE",
991
- /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
992
- OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
993
- /** deprecated A meta site was created for Flash editor. */
994
- FLASH = "FLASH"
995
- }
996
- export declare enum Namespace {
997
- UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
998
- /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
999
- WIX = "WIX",
1000
- /** ShoutOut stand alone product. These are siteless (no actual Wix site, no HtmlWeb). MetaSites with this namespace will *not* be shown in a user's site list by default. */
1001
- SHOUT_OUT = "SHOUT_OUT",
1002
- /** MetaSites created by the Albums product, they appear as part of the Albums app. MetaSites with this namespace will *not* be shown in a user's site list by default. */
1003
- ALBUMS = "ALBUMS",
1004
- /** Part of the WixStores migration flow, a user tries to migrate and gets this site to view and if the user likes it then stores removes this namespace and deletes the old site with the old stores. MetaSites with this namespace will *not* be shown in a user's site list by default. */
1005
- WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
1006
- /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
1007
- HOTELS = "HOTELS",
1008
- /** Clubs siteless MetaSites, a club without a wix website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
1009
- CLUBS = "CLUBS",
1010
- /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
1011
- ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
1012
- /** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
1013
- DEV_SITE = "DEV_SITE",
1014
- /** LogoMaker websites offered to the user after logo purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
1015
- LOGOS = "LOGOS",
1016
- /** VideoMaker websites offered to the user after video purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
1017
- VIDEO_MAKER = "VIDEO_MAKER",
1018
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
1019
- PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
1020
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
1021
- DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
1022
- /**
1023
- * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
1024
- *
1025
- * Meta site with this namespace will *not* be shown in a user's site list by default.
1026
- */
1027
- HTML_DRAFT = "HTML_DRAFT",
1028
- /**
1029
- * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
1030
- * Will be accessible from Site List and will not have a website app.
1031
- * Once the user attaches a site, the site will become a regular wixsite.
1032
- */
1033
- SITELESS_BUSINESS = "SITELESS_BUSINESS",
1034
- /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
1035
- CREATOR_ECONOMY = "CREATOR_ECONOMY",
1036
- /** It is to be used in the Business First efforts. */
1037
- DASHBOARD_FIRST = "DASHBOARD_FIRST",
1038
- /** Bookings business flow with no site. */
1039
- ANYWHERE = "ANYWHERE",
1040
- /** Namespace for Headless Backoffice with no editor */
1041
- HEADLESS = "HEADLESS",
1042
- /**
1043
- * Namespace for master site that will exist in parent account that will be referenced by subaccounts
1044
- * The site will be used for account level CSM feature for enterprise
1045
- */
1046
- ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
1047
- /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
1048
- RISE = "RISE",
1049
- /**
1050
- * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
1051
- * There's a blank site behind the scene but it's blank).
1052
- * The Mobile company will be the owner of this namespace.
1053
- */
1054
- BRANDED_FIRST = "BRANDED_FIRST"
1055
- }
1056
- /** Site transferred to another user. */
1057
- export interface SiteTransferred {
1058
- /** A previous owner id (user that transfers meta site). */
1059
- oldOwnerId?: string;
1060
- /** A new owner id (user that accepts meta site). */
1061
- newOwnerId?: string;
1062
- }
1063
- /** Soft deletion of the meta site. Could be restored. */
1064
- export interface SiteDeleted {
1065
- deleteContext?: DeleteContext;
1066
- }
1067
- export interface DeleteContext {
1068
- dateDeleted?: Date;
1069
- deleteStatus?: DeleteStatus;
1070
- deleteOrigin?: string;
1071
- initiatorId?: string | null;
1072
- }
1073
- export declare enum DeleteStatus {
1074
- UNKNOWN = "UNKNOWN",
1075
- TRASH = "TRASH",
1076
- DELETED = "DELETED",
1077
- PENDING_PURGE = "PENDING_PURGE"
1078
- }
1079
- /** Restoration of the meta site. */
1080
- export interface SiteUndeleted {
1081
- }
1082
- /** First publish of a meta site. Or subsequent publish after unpublish. */
1083
- export interface SitePublished {
1084
- }
1085
- export interface SiteUnpublished {
1086
- urls?: string[];
1087
- }
1088
- export interface SiteMarkedAsTemplate {
1089
- }
1090
- export interface SiteMarkedAsWixSite {
1091
- }
1092
- export interface ServiceProvisioned {
1093
- /** Either UUID or EmbeddedServiceType. */
1094
- appDefId?: string;
1095
- /** Not only UUID. Something here could be something weird. */
1096
- instanceId?: string;
1097
- originInstanceId?: string;
1098
- version?: string | null;
1099
- }
1100
- export interface ServiceRemoved {
1101
- appDefId?: string;
1102
- instanceId?: string;
1103
- version?: string | null;
1104
- }
1105
- /** Rename of the site. Meaning, free public url has been changed as well. */
1106
- export interface SiteRenamed {
1107
- newSiteName?: string;
1108
- oldSiteName?: string;
1109
- }
1110
- /**
1111
- * Hard deletion of the meta site.
1112
- *
1113
- * Could not be restored. Therefore it's desirable to cleanup data.
1114
- */
1115
- export interface SiteHardDeleted {
1116
- deleteContext?: DeleteContext;
1117
- }
1118
- export interface NamespaceChanged {
1119
- oldNamespace?: Namespace;
1120
- newNamespace?: Namespace;
1121
- }
1122
- /** Assigned Studio editor */
1123
- export interface StudioAssigned {
1124
- }
1125
- /** Unassigned Studio editor */
1126
- export interface StudioUnassigned {
1127
- }
1128
- export interface GetTicketDefinitionFromTrashBinRequest {
1129
- /** Ticket definition ID. */
1130
- ticketDefinitionId?: string;
1131
- /** Requested fields. Not implemented. */
1132
- fields?: Field[];
1133
- }
1134
- export interface GetTicketDefinitionFromTrashBinResponse {
1135
- /** The requested ticket definition. */
1136
- ticketDefinition?: TicketDefinition;
1137
- }
1138
- export interface CreateTicketDefinitionResponseNonNullableFields {
1139
- ticketDefinition?: {
1140
- hidden: boolean;
1141
- limited: boolean;
1142
- pricingMethod?: {
1143
- fixedPrice?: {
1144
- value: string;
1145
- currency: string;
1146
- };
1147
- guestPrice?: {
1148
- value: string;
1149
- currency: string;
1150
- };
1151
- pricingOptions?: {
1152
- optionDetails: {
1153
- price?: {
1154
- value: string;
1155
- currency: string;
1156
- };
1157
- }[];
1158
- };
1159
- pricingType: PricingTypeEnumType;
1160
- free: boolean;
1161
- };
1162
- feeType: Type;
1163
- salePeriod?: {
1164
- displayNotOnSale: boolean;
1165
- };
1166
- saleStatus: SaleStatusEnumStatus;
1167
- };
1168
- }
1169
- export interface UpdateTicketDefinitionResponseNonNullableFields {
1170
- ticketDefinition?: {
1171
- hidden: boolean;
1172
- limited: boolean;
1173
- pricingMethod?: {
1174
- fixedPrice?: {
1175
- value: string;
1176
- currency: string;
1177
- };
1178
- guestPrice?: {
1179
- value: string;
1180
- currency: string;
1181
- };
1182
- pricingOptions?: {
1183
- optionDetails: {
1184
- price?: {
1185
- value: string;
1186
- currency: string;
1187
- };
1188
- }[];
1189
- };
1190
- pricingType: PricingTypeEnumType;
1191
- free: boolean;
1192
- };
1193
- feeType: Type;
1194
- salePeriod?: {
1195
- displayNotOnSale: boolean;
1196
- };
1197
- saleStatus: SaleStatusEnumStatus;
1198
- };
1199
- }
1200
- export interface GetTicketDefinitionResponseNonNullableFields {
1201
- ticketDefinition?: {
1202
- hidden: boolean;
1203
- limited: boolean;
1204
- pricingMethod?: {
1205
- fixedPrice?: {
1206
- value: string;
1207
- currency: string;
1208
- };
1209
- guestPrice?: {
1210
- value: string;
1211
- currency: string;
1212
- };
1213
- pricingOptions?: {
1214
- optionDetails: {
1215
- price?: {
1216
- value: string;
1217
- currency: string;
1218
- };
1219
- }[];
1220
- };
1221
- pricingType: PricingTypeEnumType;
1222
- free: boolean;
1223
- };
1224
- feeType: Type;
1225
- salePeriod?: {
1226
- displayNotOnSale: boolean;
1227
- };
1228
- saleStatus: SaleStatusEnumStatus;
1229
- };
1230
- }
1231
- export interface QueryTicketDefinitionsResponseNonNullableFields {
1232
- ticketDefinitions: {
1233
- hidden: boolean;
1234
- limited: boolean;
1235
- pricingMethod?: {
1236
- fixedPrice?: {
1237
- value: string;
1238
- currency: string;
1239
- };
1240
- guestPrice?: {
1241
- value: string;
1242
- currency: string;
1243
- };
1244
- pricingOptions?: {
1245
- optionDetails: {
1246
- price?: {
1247
- value: string;
1248
- currency: string;
1249
- };
1250
- }[];
1251
- };
1252
- pricingType: PricingTypeEnumType;
1253
- free: boolean;
1254
- };
1255
- feeType: Type;
1256
- salePeriod?: {
1257
- displayNotOnSale: boolean;
1258
- };
1259
- saleStatus: SaleStatusEnumStatus;
1260
- }[];
1261
- }
1262
- /**
1263
- * Creates a ticket definition. Allowed to create up to 100 definitions per event.
1264
- * @param ticketDefinition - Ticket definition info.
1265
- * @public
1266
- * @documentationMaturity preview
1267
- * @requiredField ticketDefinition
1268
- * @requiredField ticketDefinition.eventId
1269
- * @requiredField ticketDefinition.feeType
1270
- * @requiredField ticketDefinition.name
1271
- * @requiredField ticketDefinition.pricingMethod
1272
- * @permissionScope Manage Events - all permissions
1273
- * @permissionScope Manage Ticket Definitions
1274
- * @applicableIdentity APP
1275
- * @returns Created ticket definition.
1276
- */
1277
- export declare function createTicketDefinition(ticketDefinition: TicketDefinition, options?: CreateTicketDefinitionOptions): Promise<TicketDefinition & NonNullable<CreateTicketDefinitionResponseNonNullableFields>['ticketDefinition']>;
1278
- export interface CreateTicketDefinitionOptions {
1279
- /** Requested fields. */
1280
- fields?: Field[];
1281
- }
1282
- /**
1283
- * Updates a ticket definition.
1284
- * Each time the ticket definition is updated, `revision` increments by 1. The existing `revision` must be included when updating the ticket definition. This ensures you're working with the latest ticket definition and prevents unintended overwrites.
1285
- * @param _id - Ticket definition ID.
1286
- * @public
1287
- * @documentationMaturity preview
1288
- * @requiredField _id
1289
- * @requiredField ticketDefinition
1290
- * @requiredField ticketDefinition.revision
1291
- * @permissionScope Manage Events - all permissions
1292
- * @permissionScope Manage Ticket Definitions
1293
- * @applicableIdentity APP
1294
- * @returns The updated ticket definition.
1295
- */
1296
- export declare function updateTicketDefinition(_id: string | null, ticketDefinition: UpdateTicketDefinition, options?: UpdateTicketDefinitionOptions): Promise<TicketDefinition & NonNullable<UpdateTicketDefinitionResponseNonNullableFields>['ticketDefinition']>;
1297
- export interface UpdateTicketDefinition {
1298
- /**
1299
- * Ticket definition ID.
1300
- * @readonly
1301
- */
1302
- _id?: string | null;
1303
- /** Event ID to which the ticket definition belongs. */
1304
- eventId?: string | null;
1305
- /**
1306
- * Revision number, which increments by 1 each time the ticket definition is updated. To prevent conflicting changes, the existing revision must be used when updating a ticket definition.
1307
- * @readonly
1308
- */
1309
- revision?: string | null;
1310
- /**
1311
- * Date and time when the ticket definition was created in `yyyy-mm-ddThh:mm:sssZ` format.
1312
- * @readonly
1313
- */
1314
- _createdDate?: Date;
1315
- /**
1316
- * Date and time of the ticket definition's latest update in `yyyy-mm-ddThh:mm:sssZ` format.
1317
- * @readonly
1318
- */
1319
- _updatedDate?: Date;
1320
- name?: string | null;
1321
- description?: string | null;
1322
- policyText?: string | null;
1323
- /** Whether this ticket definition is hidden to customers and cannot be purchased. */
1324
- hidden?: boolean;
1325
- /**
1326
- * Whether the ticket has a limited maximum quantity.
1327
- * @readonly
1328
- */
1329
- limited?: boolean;
1330
- /** The maximum number of tickets that can be sold for the event when first defining the event. If a seating map is defined after you created a ticket definition, this property is ignored and `actualLimit` is used instead. */
1331
- initialLimit?: number | null;
1332
- /**
1333
- * The maximum number of tickets that can be sold for the event after adding a seating map to the event. If no seating map is defined, this property is the same as `initialLimit`.
1334
- * @readonly
1335
- */
1336
- actualLimit?: number | null;
1337
- /** Ticket pricing method. */
1338
- pricingMethod?: PricingMethod;
1339
- /** Whether fee is included in the ticket price or customer pays it additionally at checkout. <br> <br> `FEE_INCLUDED`: The fee is deducted from the ticket price for a seller. For example, if you're selling tickets for $10, then a service fee of $0.25 will be deducted from the price and you'll get $9.75 <br> <br> `FEE_ADDED_AT_CHECKOUT`: The fee is shown in addition to the ticket price at checkout and a guest pays the fee. For example, if you sell tickets for $10, a customer will see a service fee of $0.25 and will pay $10.25 in total. */
1340
- feeType?: Type;
1341
- /** Ticket sale period. */
1342
- salePeriod?: SalePeriod;
1343
- /**
1344
- * Ticket sale status. <br> <br> `SALE_SCHEDULED`: Tickets are not on sale yet. <br> <br> `SALE_STARTED`: Tickets are on sale. <br> <br> `SALE_ENDED`: Tickets are not on sale.
1345
- * @readonly
1346
- */
1347
- saleStatus?: SaleStatusEnumStatus;
1348
- /** Ticket sales information. */
1349
- salesDetails?: SalesDetails;
1350
- /**
1351
- * Limit of tickets that can be purchased per checkout.
1352
- * Takes the smaller value between event ticket_limit_per_order and actual_limit values.
1353
- * @readonly
1354
- */
1355
- limitPerCheckout?: number | null;
1356
- }
1357
- export interface UpdateTicketDefinitionOptions {
1358
- /** Requested fields. */
1359
- fields?: Field[];
1360
- }
1361
- /**
1362
- * Retrieves a ticket definition.
1363
- * @param ticketDefinitionId - Ticket definition ID.
1364
- * @public
1365
- * @documentationMaturity preview
1366
- * @requiredField ticketDefinitionId
1367
- * @permissionScope Manage Events - all permissions
1368
- * @permissionScope Manage Orders
1369
- * @permissionScope Manage Ticket Definitions
1370
- * @applicableIdentity APP
1371
- * @returns The requested ticket definition.
1372
- */
1373
- export declare function getTicketDefinition(ticketDefinitionId: string, options?: GetTicketDefinitionOptions): Promise<TicketDefinition & NonNullable<GetTicketDefinitionResponseNonNullableFields>['ticketDefinition']>;
1374
- export interface GetTicketDefinitionOptions {
1375
- /**
1376
- * Predefined sets of fields to return.
1377
- * - `SALES_DETAILS`: Returns `salesDetails`.
1378
- */
1379
- fields?: Field[];
1380
- }
1381
- /**
1382
- * Permanently deletes a ticket definition.
1383
- * @param ticketDefinitionId - ID of the ticket definition to delete.
1384
- * @public
1385
- * @documentationMaturity preview
1386
- * @requiredField ticketDefinitionId
1387
- * @permissionScope Manage Events - all permissions
1388
- * @permissionScope Manage Ticket Definitions
1389
- * @applicableIdentity APP
1390
- */
1391
- export declare function deleteTicketDefinition(ticketDefinitionId: string): Promise<void>;
1392
- /**
1393
- * Changes ticket definitions order in an event dashboard and the list of available tickets in the ticket picker.
1394
- * > **Note:** It is possible to use both `beforeTicketDefinitionId` and `afterTicketDefinitionId` at the same time but only the last one defined will be executed.
1395
- * @param eventId - Event ID.
1396
- * @public
1397
- * @documentationMaturity preview
1398
- * @requiredField eventId
1399
- * @requiredField options.ticketDefinitionId
1400
- * @permissionScope Manage Events - all permissions
1401
- * @permissionScope Manage Ticket Definitions
1402
- * @applicableIdentity APP
1403
- */
1404
- export declare function reorderTicketDefinitions(eventId: string, options?: ReorderTicketDefinitionsOptions): Promise<void>;
1405
- export interface ReorderTicketDefinitionsOptions extends ReorderTicketDefinitionsRequestReferenceDefinitionOneOf {
1406
- /** Ticket definition ID. */
1407
- ticketDefinitionId: string;
1408
- /** Move the given `definitionId` before the referenced ticket definition. */
1409
- beforeDefinitionId?: string;
1410
- /** Move the given `definitionId` after the referenced ticket definition. */
1411
- afterDefinitionId?: string;
1412
- }
1413
- /**
1414
- * Retrieves a list of ticket definitions, given the provided paging, filtering, and sorting.
1415
- * Query Ticket Definitions runs with these defaults, which you can override:
1416
- * - `createdDate` is sorted in `ASC` order
1417
- * - `paging.limit` is `100`
1418
- * - `paging.offset` is `0`
1419
- * For field support for filters and sorting, see [Ticket Definitions: Supported Filters and Sorting](https://dev.wix.com/api/rest/wix-events/ticket-definitions-v3/filter-and-sort).
1420
- * To learn about working with _Query_ endpoints, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language), [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination), and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
1421
- * @param query - Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details.
1422
- * @public
1423
- * @documentationMaturity preview
1424
- * @requiredField query
1425
- * @permissionScope Manage Events - all permissions
1426
- * @permissionScope Manage Orders
1427
- * @permissionScope Manage Ticket Definitions
1428
- * @applicableIdentity APP
1429
- */
1430
- export declare function queryTicketDefinitions(query: QueryV2, options?: QueryTicketDefinitionsOptions): Promise<QueryTicketDefinitionsResponse & QueryTicketDefinitionsResponseNonNullableFields>;
1431
- export interface QueryTicketDefinitionsOptions {
1432
- /**
1433
- * Predefined sets of fields to return.
1434
- * - `SALES_DETAILS`: Returns `salesDetails`.
1435
- */
1436
- fields?: Field[];
1437
- }
1438
- /**
1439
- * Deletes multiple ticket definitions. <br> <br>
1440
- * All ticket definitions that meet the specified `filter` criteria are deleted.
1441
- * @param filter - Filter object in the following format: <br/> `"filter" : { "fieldName1": "value1" }`. <br/> <br/> **Example:** <br/> `"filter" : { "eventId": "3d3d5c04-ece0-45a8-85f0-11a58edaa192" }`
1442
- * @public
1443
- * @documentationMaturity preview
1444
- * @requiredField filter
1445
- * @permissionScope Manage Events - all permissions
1446
- * @permissionScope Manage Ticket Definitions
1447
- * @applicableIdentity APP
1448
- */
1449
- export declare function bulkDeleteTicketDefinitionsByFilter(filter: Record<string, any> | null): Promise<void>;