@wix/auto_sdk_events_ticket-definitions 1.0.6 → 1.0.7

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 (130) hide show
  1. package/build/events-v1-ticket-definition-ticket-definitions.universal-DjrTBlvE.d.mts +894 -0
  2. package/build/events-v1-ticket-definition-ticket-definitions.universal-DjrTBlvE.d.ts +894 -0
  3. package/build/{cjs/src/events-v1-ticket-definition-ticket-definitions.public.d.ts → index.d.mts} +35 -22
  4. package/build/{internal/cjs/src/events-v1-ticket-definition-ticket-definitions.public.d.ts → index.d.ts} +35 -22
  5. package/build/index.js +1092 -0
  6. package/build/index.js.map +1 -0
  7. package/build/index.mjs +1049 -0
  8. package/build/index.mjs.map +1 -0
  9. package/build/internal/events-v1-ticket-definition-ticket-definitions.universal-I_qGL_cH.d.mts +901 -0
  10. package/build/internal/events-v1-ticket-definition-ticket-definitions.universal-I_qGL_cH.d.ts +901 -0
  11. package/build/internal/{es/src/events-v1-ticket-definition-ticket-definitions.public.d.ts → index.d.mts} +35 -22
  12. package/build/{es/src/events-v1-ticket-definition-ticket-definitions.public.d.ts → internal/index.d.ts} +35 -22
  13. package/build/internal/index.js +1092 -0
  14. package/build/internal/index.js.map +1 -0
  15. package/build/internal/index.mjs +1049 -0
  16. package/build/internal/index.mjs.map +1 -0
  17. package/build/{es/src/events-v1-ticket-definition-ticket-definitions.types.d.ts → internal/meta.d.mts} +72 -288
  18. package/build/internal/{cjs/src/events-v1-ticket-definition-ticket-definitions.types.d.ts → meta.d.ts} +72 -288
  19. package/build/internal/meta.js +760 -0
  20. package/build/internal/meta.js.map +1 -0
  21. package/build/internal/meta.mjs +726 -0
  22. package/build/internal/meta.mjs.map +1 -0
  23. package/build/{internal/es/src/events-v1-ticket-definition-ticket-definitions.types.d.ts → meta.d.mts} +72 -288
  24. package/build/{cjs/src/events-v1-ticket-definition-ticket-definitions.types.d.ts → meta.d.ts} +72 -288
  25. package/build/meta.js +760 -0
  26. package/build/meta.js.map +1 -0
  27. package/build/meta.mjs +726 -0
  28. package/build/meta.mjs.map +1 -0
  29. package/package.json +13 -12
  30. package/build/cjs/index.d.ts +0 -1
  31. package/build/cjs/index.js +0 -18
  32. package/build/cjs/index.js.map +0 -1
  33. package/build/cjs/index.typings.d.ts +0 -1
  34. package/build/cjs/index.typings.js +0 -18
  35. package/build/cjs/index.typings.js.map +0 -1
  36. package/build/cjs/meta.d.ts +0 -1
  37. package/build/cjs/meta.js +0 -18
  38. package/build/cjs/meta.js.map +0 -1
  39. package/build/cjs/src/events-v1-ticket-definition-ticket-definitions.context.d.ts +0 -22
  40. package/build/cjs/src/events-v1-ticket-definition-ticket-definitions.context.js +0 -34
  41. package/build/cjs/src/events-v1-ticket-definition-ticket-definitions.context.js.map +0 -1
  42. package/build/cjs/src/events-v1-ticket-definition-ticket-definitions.http.d.ts +0 -132
  43. package/build/cjs/src/events-v1-ticket-definition-ticket-definitions.http.js +0 -703
  44. package/build/cjs/src/events-v1-ticket-definition-ticket-definitions.http.js.map +0 -1
  45. package/build/cjs/src/events-v1-ticket-definition-ticket-definitions.meta.d.ts +0 -24
  46. package/build/cjs/src/events-v1-ticket-definition-ticket-definitions.meta.js +0 -180
  47. package/build/cjs/src/events-v1-ticket-definition-ticket-definitions.meta.js.map +0 -1
  48. package/build/cjs/src/events-v1-ticket-definition-ticket-definitions.public.js +0 -86
  49. package/build/cjs/src/events-v1-ticket-definition-ticket-definitions.public.js.map +0 -1
  50. package/build/cjs/src/events-v1-ticket-definition-ticket-definitions.types.js +0 -71
  51. package/build/cjs/src/events-v1-ticket-definition-ticket-definitions.types.js.map +0 -1
  52. package/build/cjs/src/events-v1-ticket-definition-ticket-definitions.universal.d.ts +0 -1261
  53. package/build/cjs/src/events-v1-ticket-definition-ticket-definitions.universal.js +0 -609
  54. package/build/cjs/src/events-v1-ticket-definition-ticket-definitions.universal.js.map +0 -1
  55. package/build/es/index.d.ts +0 -1
  56. package/build/es/index.js +0 -2
  57. package/build/es/index.js.map +0 -1
  58. package/build/es/index.typings.d.ts +0 -1
  59. package/build/es/index.typings.js +0 -2
  60. package/build/es/index.typings.js.map +0 -1
  61. package/build/es/meta.d.ts +0 -1
  62. package/build/es/meta.js +0 -2
  63. package/build/es/meta.js.map +0 -1
  64. package/build/es/package.json +0 -3
  65. package/build/es/src/events-v1-ticket-definition-ticket-definitions.context.d.ts +0 -22
  66. package/build/es/src/events-v1-ticket-definition-ticket-definitions.context.js +0 -22
  67. package/build/es/src/events-v1-ticket-definition-ticket-definitions.context.js.map +0 -1
  68. package/build/es/src/events-v1-ticket-definition-ticket-definitions.http.d.ts +0 -132
  69. package/build/es/src/events-v1-ticket-definition-ticket-definitions.http.js +0 -692
  70. package/build/es/src/events-v1-ticket-definition-ticket-definitions.http.js.map +0 -1
  71. package/build/es/src/events-v1-ticket-definition-ticket-definitions.meta.d.ts +0 -24
  72. package/build/es/src/events-v1-ticket-definition-ticket-definitions.meta.js +0 -146
  73. package/build/es/src/events-v1-ticket-definition-ticket-definitions.meta.js.map +0 -1
  74. package/build/es/src/events-v1-ticket-definition-ticket-definitions.public.js +0 -66
  75. package/build/es/src/events-v1-ticket-definition-ticket-definitions.public.js.map +0 -1
  76. package/build/es/src/events-v1-ticket-definition-ticket-definitions.types.js +0 -68
  77. package/build/es/src/events-v1-ticket-definition-ticket-definitions.types.js.map +0 -1
  78. package/build/es/src/events-v1-ticket-definition-ticket-definitions.universal.d.ts +0 -1261
  79. package/build/es/src/events-v1-ticket-definition-ticket-definitions.universal.js +0 -575
  80. package/build/es/src/events-v1-ticket-definition-ticket-definitions.universal.js.map +0 -1
  81. package/build/internal/cjs/index.d.ts +0 -1
  82. package/build/internal/cjs/index.js +0 -18
  83. package/build/internal/cjs/index.js.map +0 -1
  84. package/build/internal/cjs/index.typings.d.ts +0 -1
  85. package/build/internal/cjs/index.typings.js +0 -18
  86. package/build/internal/cjs/index.typings.js.map +0 -1
  87. package/build/internal/cjs/meta.d.ts +0 -1
  88. package/build/internal/cjs/meta.js +0 -18
  89. package/build/internal/cjs/meta.js.map +0 -1
  90. package/build/internal/cjs/src/events-v1-ticket-definition-ticket-definitions.context.d.ts +0 -22
  91. package/build/internal/cjs/src/events-v1-ticket-definition-ticket-definitions.context.js +0 -34
  92. package/build/internal/cjs/src/events-v1-ticket-definition-ticket-definitions.context.js.map +0 -1
  93. package/build/internal/cjs/src/events-v1-ticket-definition-ticket-definitions.http.d.ts +0 -132
  94. package/build/internal/cjs/src/events-v1-ticket-definition-ticket-definitions.http.js +0 -703
  95. package/build/internal/cjs/src/events-v1-ticket-definition-ticket-definitions.http.js.map +0 -1
  96. package/build/internal/cjs/src/events-v1-ticket-definition-ticket-definitions.meta.d.ts +0 -24
  97. package/build/internal/cjs/src/events-v1-ticket-definition-ticket-definitions.meta.js +0 -180
  98. package/build/internal/cjs/src/events-v1-ticket-definition-ticket-definitions.meta.js.map +0 -1
  99. package/build/internal/cjs/src/events-v1-ticket-definition-ticket-definitions.public.js +0 -86
  100. package/build/internal/cjs/src/events-v1-ticket-definition-ticket-definitions.public.js.map +0 -1
  101. package/build/internal/cjs/src/events-v1-ticket-definition-ticket-definitions.types.js +0 -71
  102. package/build/internal/cjs/src/events-v1-ticket-definition-ticket-definitions.types.js.map +0 -1
  103. package/build/internal/cjs/src/events-v1-ticket-definition-ticket-definitions.universal.d.ts +0 -1268
  104. package/build/internal/cjs/src/events-v1-ticket-definition-ticket-definitions.universal.js +0 -609
  105. package/build/internal/cjs/src/events-v1-ticket-definition-ticket-definitions.universal.js.map +0 -1
  106. package/build/internal/es/index.d.ts +0 -1
  107. package/build/internal/es/index.js +0 -2
  108. package/build/internal/es/index.js.map +0 -1
  109. package/build/internal/es/index.typings.d.ts +0 -1
  110. package/build/internal/es/index.typings.js +0 -2
  111. package/build/internal/es/index.typings.js.map +0 -1
  112. package/build/internal/es/meta.d.ts +0 -1
  113. package/build/internal/es/meta.js +0 -2
  114. package/build/internal/es/meta.js.map +0 -1
  115. package/build/internal/es/src/events-v1-ticket-definition-ticket-definitions.context.d.ts +0 -22
  116. package/build/internal/es/src/events-v1-ticket-definition-ticket-definitions.context.js +0 -22
  117. package/build/internal/es/src/events-v1-ticket-definition-ticket-definitions.context.js.map +0 -1
  118. package/build/internal/es/src/events-v1-ticket-definition-ticket-definitions.http.d.ts +0 -132
  119. package/build/internal/es/src/events-v1-ticket-definition-ticket-definitions.http.js +0 -692
  120. package/build/internal/es/src/events-v1-ticket-definition-ticket-definitions.http.js.map +0 -1
  121. package/build/internal/es/src/events-v1-ticket-definition-ticket-definitions.meta.d.ts +0 -24
  122. package/build/internal/es/src/events-v1-ticket-definition-ticket-definitions.meta.js +0 -146
  123. package/build/internal/es/src/events-v1-ticket-definition-ticket-definitions.meta.js.map +0 -1
  124. package/build/internal/es/src/events-v1-ticket-definition-ticket-definitions.public.js +0 -66
  125. package/build/internal/es/src/events-v1-ticket-definition-ticket-definitions.public.js.map +0 -1
  126. package/build/internal/es/src/events-v1-ticket-definition-ticket-definitions.types.js +0 -68
  127. package/build/internal/es/src/events-v1-ticket-definition-ticket-definitions.types.js.map +0 -1
  128. package/build/internal/es/src/events-v1-ticket-definition-ticket-definitions.universal.d.ts +0 -1268
  129. package/build/internal/es/src/events-v1-ticket-definition-ticket-definitions.universal.js +0 -575
  130. package/build/internal/es/src/events-v1-ticket-definition-ticket-definitions.universal.js.map +0 -1
@@ -1,1261 +0,0 @@
1
- export interface TicketDefinition {
2
- /**
3
- * Ticket definition ID.
4
- * @format GUID
5
- */
6
- _id?: string;
7
- /** Ticket price. */
8
- price?: Money;
9
- /** Whether the ticket is free (read only). */
10
- free?: boolean;
11
- /** Ticket name. */
12
- name?: string;
13
- /** Ticket description. */
14
- description?: string;
15
- /**
16
- * Limit of tickets that can be purchased per checkout.
17
- * Set to 20 for unlimited ticket definition.
18
- * @max 20
19
- */
20
- limitPerCheckout?: number;
21
- /** Custom sort index. */
22
- orderIndex?: number;
23
- /** Policy information plain text block, as printed on the ticket. */
24
- policy?: string;
25
- /** Sensitive dashboard data. */
26
- dashboard?: Dashboard;
27
- /**
28
- * Event ID associated with the ticket.
29
- * @format GUID
30
- */
31
- eventId?: string;
32
- /**
33
- * Configuration of the fixed-rate Wix ticket service fee that is applied at checkout to each ticket sold.
34
- * @readonly
35
- */
36
- wixFeeConfig?: WixFeeConfig;
37
- /** Ticket sale period. */
38
- salePeriod?: TicketSalePeriod;
39
- /**
40
- * Ticket sale status.
41
- * @readonly
42
- */
43
- saleStatus?: TicketSaleStatus;
44
- /** Ticket state. */
45
- state?: TicketDefinitionStateEnumState[];
46
- /** Ticket pricing. */
47
- pricing?: TicketPricing;
48
- }
49
- export interface Money {
50
- /**
51
- * Three-letter currency code in
52
- * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
53
- * @format CURRENCY
54
- */
55
- currency?: string;
56
- /**
57
- * Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, starts with a single (-), to indicate that the amount is negative.
58
- * @format DECIMAL_VALUE
59
- */
60
- value?: string | null;
61
- }
62
- export interface Dashboard {
63
- /** Whether ticket is hidden and cannot be sold. */
64
- hidden?: boolean;
65
- /**
66
- * Number of tickets sold and reserved.
67
- * @deprecated
68
- */
69
- sold?: number;
70
- /** Whether the ticket has limited quantity. */
71
- limited?: boolean;
72
- /** Ticket limit. `NULL` for unlimited ticket definitions. */
73
- quantity?: number | null;
74
- /** Number of unsold tickets. `NULL` for unlimited ticket definitions. */
75
- unsold?: number | null;
76
- /** Number of tickets sold. */
77
- ticketsSold?: number;
78
- /** Number of tickets reserved. */
79
- ticketsReserved?: number;
80
- }
81
- export interface WixFeeConfig {
82
- /**
83
- * Fee calculation method.
84
- *
85
- * Supported values: `"FEE_ADDED"`, `"FEE_INCLUDED"`, `"FEE_ADDED_AT_CHECKOUT"`
86
- *
87
- * Default: `"FEE_ADDED_AT_CHECKOUT"`
88
- */
89
- type?: FeeType;
90
- }
91
- export declare enum FeeType {
92
- /** Fee is added to the ticket price at checkout. */
93
- FEE_ADDED = "FEE_ADDED",
94
- /** Seller absorbs the fee. It is deducted from the ticket price. */
95
- FEE_INCLUDED = "FEE_INCLUDED",
96
- /** Fee is added to the ticket price at checkout. */
97
- FEE_ADDED_AT_CHECKOUT = "FEE_ADDED_AT_CHECKOUT"
98
- }
99
- export interface TicketSalePeriod {
100
- /** Ticket sale start timestamp. */
101
- startDate?: Date | null;
102
- /** Ticket sale end timestamp. */
103
- endDate?: Date | null;
104
- /** Whether to hide this ticket if it's not on sale */
105
- hideNotOnSale?: boolean;
106
- }
107
- export declare enum TicketSaleStatus {
108
- /** Ticket sale is scheduled to start. */
109
- SALE_SCHEDULED = "SALE_SCHEDULED",
110
- /** Ticket sale has started. */
111
- SALE_STARTED = "SALE_STARTED",
112
- /** Ticket sale has ended. */
113
- SALE_ENDED = "SALE_ENDED"
114
- }
115
- export declare enum TicketDefinitionStateEnumState {
116
- INCLUDE_HIDDEN_NOT_ON_SALE = "INCLUDE_HIDDEN_NOT_ON_SALE"
117
- }
118
- export interface TicketPricing extends TicketPricingPriceOneOf {
119
- /** Ticket price which is read only. */
120
- fixedPrice?: Money;
121
- /** Min price per ticket, customizable. */
122
- minPrice?: Money;
123
- /** Ticket pricing options. */
124
- pricingOptions?: PricingOptions;
125
- /**
126
- * Ticket pricing type.
127
- * @readonly
128
- */
129
- pricingType?: Type;
130
- }
131
- /** @oneof */
132
- export interface TicketPricingPriceOneOf {
133
- /** Ticket price which is read only. */
134
- fixedPrice?: Money;
135
- /** Min price per ticket, customizable. */
136
- minPrice?: Money;
137
- /** Ticket pricing options. */
138
- pricingOptions?: PricingOptions;
139
- }
140
- export interface PricingOptions {
141
- /** Multiple ticket pricing options. */
142
- options?: PricingOption[];
143
- }
144
- export interface PricingOption {
145
- /**
146
- * Ticket pricing option ID.
147
- * @format GUID
148
- */
149
- _id?: string | null;
150
- /**
151
- * Ticket pricing option name.
152
- * @minLength 1
153
- * @maxLength 200
154
- */
155
- name?: string | null;
156
- /** Ticket pricing option price. */
157
- price?: Money;
158
- }
159
- export declare enum Type {
160
- STANDARD = "STANDARD",
161
- DONATION = "DONATION"
162
- }
163
- export interface QueryTicketDefinitionsRequest {
164
- /** Offset. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */
165
- offset?: number;
166
- /**
167
- * Limit. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).
168
- * @max 100
169
- */
170
- limit?: number;
171
- /**
172
- * Set of fields to return in the response. See [fieldsets](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_ticket-definition-fieldset).
173
- * @maxSize 20
174
- */
175
- fieldset?: TicketDefinitionFieldset[];
176
- /** Filter. See [supported fields and operators](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_query-ticket-definitions). */
177
- filter?: Record<string, any> | null;
178
- /**
179
- * Sort order. Defaults to: "created:asc".
180
- * See [supported fields](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_query-ticket-definitions).
181
- * @maxLength 100
182
- */
183
- sort?: string;
184
- /**
185
- * Filter facets to include in the response.
186
- * See [supported facets](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_query-ticket-definitions).
187
- * @maxLength 20
188
- * @maxSize 10
189
- */
190
- facet?: string[];
191
- }
192
- export declare enum TicketDefinitionFieldset {
193
- /** Include `policy` in the response. */
194
- POLICY = "POLICY",
195
- /** Include `dashboard` in the response. */
196
- DASHBOARD = "DASHBOARD"
197
- }
198
- export interface QueryTicketDefinitionsResponse {
199
- /** Total ticket definitions matching the given filters. */
200
- total?: number;
201
- /** Offset. */
202
- offset?: number;
203
- /**
204
- * Limit.
205
- * @max 100
206
- */
207
- limit?: number;
208
- /** Ticket definitions. */
209
- definitions?: TicketDefinition[];
210
- /** Filter facets. */
211
- facets?: Record<string, FacetCounts>;
212
- }
213
- export interface FacetCounts {
214
- /** Facet counts aggregated per value. */
215
- counts?: Record<string, number>;
216
- }
217
- export interface QueryTicketDefinitionsV2Request {
218
- /** Query request object. */
219
- query?: QueryV2;
220
- }
221
- export interface QueryV2 extends QueryV2PagingMethodOneOf {
222
- /** Paging options to limit and skip the number of items. */
223
- paging?: Paging;
224
- /** 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`. */
225
- cursorPaging?: CursorPaging;
226
- /**
227
- * Filter object.
228
- *
229
- * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
230
- */
231
- filter?: Record<string, any> | null;
232
- /**
233
- * Sort object.
234
- *
235
- * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
236
- */
237
- sort?: Sorting[];
238
- /** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
239
- fields?: string[];
240
- /** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
241
- fieldsets?: string[];
242
- }
243
- /** @oneof */
244
- export interface QueryV2PagingMethodOneOf {
245
- /** Paging options to limit and skip the number of items. */
246
- paging?: Paging;
247
- /** 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`. */
248
- cursorPaging?: CursorPaging;
249
- }
250
- export interface Sorting {
251
- /**
252
- * Name of the field to sort by.
253
- * @maxLength 512
254
- */
255
- fieldName?: string;
256
- /** Sort order. */
257
- order?: SortOrder;
258
- }
259
- export declare enum SortOrder {
260
- ASC = "ASC",
261
- DESC = "DESC"
262
- }
263
- export interface Paging {
264
- /** Number of items to load. */
265
- limit?: number | null;
266
- /** Number of items to skip in the current sort order. */
267
- offset?: number | null;
268
- }
269
- export interface CursorPaging {
270
- /**
271
- * Maximum number of items to return in the results.
272
- * @max 100
273
- */
274
- limit?: number | null;
275
- /**
276
- * Pointer to the next or previous page in the list of results.
277
- *
278
- * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
279
- * Not relevant for the first request.
280
- * @maxLength 16000
281
- */
282
- cursor?: string | null;
283
- }
284
- export interface QueryTicketDefinitionsV2Response {
285
- /** Ticket definitions. */
286
- definitions?: TicketDefinition[];
287
- /** Paging metadata definitions. */
288
- metadata?: PagingMetadataV2;
289
- }
290
- export interface PagingMetadataV2 {
291
- /** Number of items returned in the response. */
292
- count?: number | null;
293
- /** Offset that was requested. */
294
- offset?: number | null;
295
- /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
296
- total?: number | null;
297
- /** Flag that indicates the server failed to calculate the `total` field. */
298
- tooManyToCount?: boolean | null;
299
- /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
300
- cursors?: Cursors;
301
- }
302
- export interface Cursors {
303
- /**
304
- * Cursor string pointing to the next page in the list of results.
305
- * @maxLength 16000
306
- */
307
- next?: string | null;
308
- /**
309
- * Cursor pointing to the previous page in the list of results.
310
- * @maxLength 16000
311
- */
312
- prev?: string | null;
313
- }
314
- export interface ListTicketDefinitionsRequest {
315
- /**
316
- * Event ID.
317
- * @format GUID
318
- * @maxSize 100
319
- */
320
- eventId?: string[];
321
- /** Offset. */
322
- offset?: number;
323
- /**
324
- * Paging limit.
325
- * @max 100
326
- */
327
- limit?: number;
328
- /**
329
- * Predefined sets of fields to return.
330
- * - `DASHBOARD`: Returns `dashboard`.
331
- * - `POLICY`: Returns `policy`.
332
- *
333
- * Default: If `fieldset` is omitted from the request, `id`, `price`, `free`, `name`, `limitPerCheckout`, `orderIndex`, `eventId`.
334
- *
335
- * @maxSize 20
336
- */
337
- fieldset?: TicketDefinitionFieldset[];
338
- /**
339
- * Event creator ID.
340
- * @format GUID
341
- * @maxSize 1
342
- */
343
- eventCreatorId?: string[];
344
- /**
345
- * Filter by ticket definition state.
346
- *
347
- * Supported values: `"VISIBLE"`, `"HIDDEN"`, `"FREE"`, `"PAID"`
348
- * @maxSize 20
349
- */
350
- state?: State[];
351
- /**
352
- * Sort order.
353
- *
354
- * Default: `"created"`:`"asc"`
355
- * @maxLength 100
356
- */
357
- sort?: string;
358
- /**
359
- * Ticket sale status.
360
- *
361
- * Supported values: `"SALE_SCHEDULED"`, `"SALE_STARTED"`, `"SALE_ENDED"`
362
- * @maxSize 5
363
- */
364
- saleStatus?: TicketSaleStatus[];
365
- /**
366
- * Filter facets.
367
- * @maxLength 20
368
- * @maxSize 10
369
- */
370
- facet?: string[];
371
- }
372
- export declare enum State {
373
- /** The ticket is available for purchase. */
374
- VISIBLE = "VISIBLE",
375
- /** The ticket is unavailable for purchase. */
376
- HIDDEN = "HIDDEN",
377
- /** The ticket price is 0. */
378
- FREE = "FREE",
379
- /** The ticket price is greater than 0. */
380
- PAID = "PAID"
381
- }
382
- export declare enum GroupBy {
383
- /** No grouping. */
384
- NONE = "NONE",
385
- /** Groups by event created date with descending sorting. */
386
- EVENT_CREATED_DESC = "EVENT_CREATED_DESC",
387
- /** Groups by event created date with ascending sorting. */
388
- EVENT_CREATED_ASC = "EVENT_CREATED_ASC"
389
- }
390
- export interface ListTicketDefinitionsResponse {
391
- /** Meta data. */
392
- metaData?: ResponseMetaData;
393
- /** Retrieved ticket definitions. */
394
- definitions?: TicketDefinition[];
395
- /** Filter facets. */
396
- facets?: Record<string, FacetCounts>;
397
- }
398
- export interface ResponseMetaData {
399
- /** Number of items in the response. */
400
- count?: number;
401
- /** Offset of items. */
402
- offset?: number;
403
- /** Total number of matching items. */
404
- total?: number;
405
- }
406
- export interface GetTicketDefinitionRequest {
407
- /**
408
- * Ticket definition ID.
409
- * @format GUID
410
- */
411
- definitionId: string;
412
- /**
413
- * Predefined sets of fields to return.
414
- * - `DASHBOARD`: Returns `dashboard`.
415
- * - `POLICY`: Returns `policy`.
416
- *
417
- * Default: If `fieldset` is omitted from the request, `id`, `price`, `free`, `name`, `limitPerCheckout`, `orderIndex`, `eventId`.
418
- * @maxSize 20
419
- */
420
- fieldset?: TicketDefinitionFieldset[];
421
- }
422
- export interface GetTicketDefinitionResponse {
423
- /** Retrieved ticket definition. */
424
- definition?: TicketDefinition;
425
- }
426
- export interface CreateTicketDefinitionRequest {
427
- /**
428
- * Event ID.
429
- * @format GUID
430
- */
431
- eventId: string;
432
- /** Ticket definition data. */
433
- definition: TicketDefinitionData;
434
- }
435
- export interface TicketDefinitionData {
436
- /**
437
- * Ticket name.
438
- * @maxLength 30
439
- */
440
- name?: string | null;
441
- /** Ticket price. */
442
- price?: Money;
443
- /**
444
- * Ticket description.
445
- * @maxLength 500
446
- */
447
- description?: string | null;
448
- /** Whether this ticket type is limited in quantity. */
449
- limited?: boolean;
450
- /**
451
- * Limit for this ticket type.
452
- *
453
- * `NULL` for unlimited.
454
- */
455
- quantity?: number | null;
456
- /** Custom sort index for manual tickets ordering implementation. */
457
- orderIndex?: number;
458
- /**
459
- * Policy information in plain text (as listed on the ticket).
460
- * @maxLength 1000
461
- */
462
- policy?: string | null;
463
- /** Whether this ticket type is hidden to customers and cannot be purchased. */
464
- hidden?: boolean;
465
- /** Configuration of the fixed-rate Wix ticket service fee that is applied to each ticket sold. */
466
- wixFeeConfig?: WixFeeConfig;
467
- /** Ticket sale period. */
468
- salePeriod?: TicketSalePeriod;
469
- /** Ticket pricing. */
470
- pricing?: TicketPricing;
471
- }
472
- export interface CreateTicketDefinitionResponse {
473
- /** Created ticket definition. */
474
- definition?: TicketDefinition;
475
- }
476
- export interface TicketDefinitionCreated {
477
- /** Ticket Definition created timestamp in ISO UTC format. */
478
- timestamp?: Date | null;
479
- /**
480
- * Ticket Definition ID.
481
- * @format GUID
482
- */
483
- ticketDefinitionId?: string;
484
- /**
485
- * Event ID.
486
- * @format GUID
487
- */
488
- eventId?: string;
489
- /** Originated from. */
490
- originatedFrom?: OriginatedFrom;
491
- }
492
- export interface OriginatedFrom {
493
- /**
494
- * Instance ID. Indicates the original app instance which current entity originated from.
495
- * @format GUID
496
- */
497
- instanceId?: string;
498
- /**
499
- * Event ID. Indicates the original event which current entity originated from.
500
- * @format GUID
501
- */
502
- eventId?: string;
503
- /**
504
- * Event ID. Indicates the original entity which current entity originated from.
505
- * @format GUID
506
- */
507
- entityId?: string;
508
- }
509
- export interface UpdateTicketDefinitionRequest {
510
- /**
511
- * Event ID.
512
- * @format GUID
513
- */
514
- eventId: string;
515
- /**
516
- * Ticket definition ID.
517
- * @format GUID
518
- */
519
- definitionId: string;
520
- /** Ticket definition data. */
521
- definition?: TicketDefinitionData;
522
- /** Set of field paths, specifying which parts of ticket definition to update. */
523
- fields?: string[];
524
- }
525
- export interface UpdateTicketDefinitionResponse {
526
- /** Updated ticket definition. */
527
- definition?: TicketDefinition;
528
- }
529
- export interface TicketDefinitionUpdated {
530
- /** Ticket definition updated timestamp in ISO UTC format. */
531
- timestamp?: Date | null;
532
- /**
533
- * Ticket definition ID.
534
- * @format GUID
535
- */
536
- ticketDefinitionId?: string;
537
- /**
538
- * Event ID.
539
- * @format GUID
540
- */
541
- eventId?: string;
542
- }
543
- export interface DeleteTicketDefinitionRequest extends DeleteTicketDefinitionRequestDeleteOneOf {
544
- /** Ticket definitions to delete. */
545
- byId?: ById;
546
- /** Whether to delete all event tickets. */
547
- all?: boolean;
548
- /**
549
- * Event ID.
550
- * @format GUID
551
- */
552
- eventId: string;
553
- }
554
- /** @oneof */
555
- export interface DeleteTicketDefinitionRequestDeleteOneOf {
556
- /** Ticket definitions to delete. */
557
- byId?: ById;
558
- /** Whether to delete all event tickets. */
559
- all?: boolean;
560
- }
561
- export interface ById {
562
- /**
563
- * Ticket definition IDs.
564
- * @format GUID
565
- * @minSize 1
566
- * @maxSize 100
567
- */
568
- definitionId?: string[];
569
- }
570
- export interface DeleteTicketDefinitionResponse {
571
- }
572
- export interface TicketDefinitionDeleted {
573
- /** Ticket definition deleted timestamp in ISO UTC format. */
574
- timestamp?: Date | null;
575
- /**
576
- * Ticket definition ID.
577
- * @format GUID
578
- */
579
- ticketDefinitionId?: string;
580
- /**
581
- * Event ID.
582
- * @format GUID
583
- */
584
- eventId?: string;
585
- }
586
- export interface ChangeCurrencyRequest {
587
- /**
588
- * Event ID.
589
- * @format GUID
590
- */
591
- eventId?: string;
592
- /**
593
- * Event currency, in 3-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
594
- * @minLength 3
595
- * @maxLength 3
596
- */
597
- currency: string;
598
- }
599
- export interface ChangeCurrencyResponse {
600
- }
601
- export interface BulkCopyTicketDefinitionsByEventIdRequest {
602
- /** Origin instance ID. */
603
- originInstanceId?: string | null;
604
- /**
605
- * Origin Event ID.
606
- * @format GUID
607
- */
608
- originEventId?: string;
609
- /**
610
- * Target Event ID.
611
- * @format GUID
612
- */
613
- targetEventId?: string;
614
- }
615
- export interface BulkCopyTicketDefinitionsByEventIdResponse {
616
- /** Copied ticket definitions. */
617
- definitions?: CopiedTicketDefinition[];
618
- }
619
- export interface CopiedTicketDefinition {
620
- /** Origin Ticket definition ID. */
621
- originTicketDefinitionId?: string;
622
- /** Ticket definition ID. */
623
- ticketDefinitionId?: string;
624
- }
625
- export interface PaidTicketDefinitionExistsRequest {
626
- }
627
- export interface PaidTicketDefinitionExistsResponse {
628
- /** Paid exists. */
629
- paidExists?: boolean;
630
- }
631
- export interface MessageEnvelope {
632
- /**
633
- * App instance ID.
634
- * @format GUID
635
- */
636
- instanceId?: string | null;
637
- /**
638
- * Event type.
639
- * @maxLength 150
640
- */
641
- eventType?: string;
642
- /** The identification type and identity data. */
643
- identity?: IdentificationData;
644
- /** Stringify payload. */
645
- data?: string;
646
- }
647
- export interface IdentificationData extends IdentificationDataIdOneOf {
648
- /**
649
- * ID of a site visitor that has not logged in to the site.
650
- * @format GUID
651
- */
652
- anonymousVisitorId?: string;
653
- /**
654
- * ID of a site visitor that has logged in to the site.
655
- * @format GUID
656
- */
657
- memberId?: string;
658
- /**
659
- * ID of a Wix user (site owner, contributor, etc.).
660
- * @format GUID
661
- */
662
- wixUserId?: string;
663
- /**
664
- * ID of an app.
665
- * @format GUID
666
- */
667
- appId?: string;
668
- /** @readonly */
669
- identityType?: WebhookIdentityType;
670
- }
671
- /** @oneof */
672
- export interface IdentificationDataIdOneOf {
673
- /**
674
- * ID of a site visitor that has not logged in to the site.
675
- * @format GUID
676
- */
677
- anonymousVisitorId?: string;
678
- /**
679
- * ID of a site visitor that has logged in to the site.
680
- * @format GUID
681
- */
682
- memberId?: string;
683
- /**
684
- * ID of a Wix user (site owner, contributor, etc.).
685
- * @format GUID
686
- */
687
- wixUserId?: string;
688
- /**
689
- * ID of an app.
690
- * @format GUID
691
- */
692
- appId?: string;
693
- }
694
- export declare enum WebhookIdentityType {
695
- UNKNOWN = "UNKNOWN",
696
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
697
- MEMBER = "MEMBER",
698
- WIX_USER = "WIX_USER",
699
- APP = "APP"
700
- }
701
- interface MoneyNonNullableFields {
702
- amount: string;
703
- currency: string;
704
- }
705
- interface DashboardNonNullableFields {
706
- hidden: boolean;
707
- sold: number;
708
- limited: boolean;
709
- ticketsSold: number;
710
- ticketsReserved: number;
711
- }
712
- interface WixFeeConfigNonNullableFields {
713
- type: FeeType;
714
- }
715
- interface TicketSalePeriodNonNullableFields {
716
- hideNotOnSale: boolean;
717
- }
718
- interface PricingOptionNonNullableFields {
719
- price?: MoneyNonNullableFields;
720
- }
721
- interface PricingOptionsNonNullableFields {
722
- options: PricingOptionNonNullableFields[];
723
- }
724
- interface TicketPricingNonNullableFields {
725
- fixedPrice?: MoneyNonNullableFields;
726
- minPrice?: MoneyNonNullableFields;
727
- pricingOptions?: PricingOptionsNonNullableFields;
728
- pricingType: Type;
729
- }
730
- export interface TicketDefinitionNonNullableFields {
731
- _id: string;
732
- price?: MoneyNonNullableFields;
733
- free: boolean;
734
- name: string;
735
- description: string;
736
- limitPerCheckout: number;
737
- orderIndex: number;
738
- policy: string;
739
- dashboard?: DashboardNonNullableFields;
740
- eventId: string;
741
- wixFeeConfig?: WixFeeConfigNonNullableFields;
742
- salePeriod?: TicketSalePeriodNonNullableFields;
743
- saleStatus: TicketSaleStatus;
744
- state: TicketDefinitionStateEnumState[];
745
- pricing?: TicketPricingNonNullableFields;
746
- }
747
- export interface QueryTicketDefinitionsResponseNonNullableFields {
748
- total: number;
749
- offset: number;
750
- limit: number;
751
- definitions: TicketDefinitionNonNullableFields[];
752
- }
753
- export interface QueryTicketDefinitionsV2ResponseNonNullableFields {
754
- definitions: TicketDefinitionNonNullableFields[];
755
- }
756
- interface ResponseMetaDataNonNullableFields {
757
- count: number;
758
- offset: number;
759
- total: number;
760
- }
761
- export interface ListTicketDefinitionsResponseNonNullableFields {
762
- metaData?: ResponseMetaDataNonNullableFields;
763
- definitions: TicketDefinitionNonNullableFields[];
764
- }
765
- export interface GetTicketDefinitionResponseNonNullableFields {
766
- definition?: TicketDefinitionNonNullableFields;
767
- }
768
- export interface CreateTicketDefinitionResponseNonNullableFields {
769
- definition?: TicketDefinitionNonNullableFields;
770
- }
771
- export interface UpdateTicketDefinitionResponseNonNullableFields {
772
- definition?: TicketDefinitionNonNullableFields;
773
- }
774
- export interface BaseEventMetadata {
775
- /**
776
- * App instance ID.
777
- * @format GUID
778
- */
779
- instanceId?: string | null;
780
- /**
781
- * Event type.
782
- * @maxLength 150
783
- */
784
- eventType?: string;
785
- /** The identification type and identity data. */
786
- identity?: IdentificationData;
787
- }
788
- export interface TicketDefinitionCreatedEnvelope {
789
- data: TicketDefinitionCreated;
790
- metadata: BaseEventMetadata;
791
- }
792
- /** @permissionScope Manage Events - all permissions
793
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
794
- * @permissionScope Manage Events
795
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
796
- * @permissionScope Manage Orders
797
- * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
798
- * @permissionScope Manage Ticket Definitions
799
- * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
800
- * @permissionId WIX_EVENTS.READ_TICKET_DEFINITIONS
801
- * @webhook
802
- * @eventType wix.events.ticketing.events.TicketDefinitionCreated
803
- * @serviceIdentifier wix.events.ticketing.TicketDefinitionManagement
804
- * @slug ticket_definition_created
805
- */
806
- export declare function onTicketDefinitionCreated(handler: (event: TicketDefinitionCreatedEnvelope) => void | Promise<void>): void;
807
- export interface TicketDefinitionDeletedEnvelope {
808
- data: TicketDefinitionDeleted;
809
- metadata: BaseEventMetadata;
810
- }
811
- /** @permissionScope Manage Events - all permissions
812
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
813
- * @permissionScope Manage Events
814
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
815
- * @permissionScope Manage Orders
816
- * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
817
- * @permissionScope Manage Ticket Definitions
818
- * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
819
- * @permissionId WIX_EVENTS.READ_TICKET_DEFINITIONS
820
- * @webhook
821
- * @eventType wix.events.ticketing.events.TicketDefinitionDeleted
822
- * @serviceIdentifier wix.events.ticketing.TicketDefinitionManagement
823
- * @slug ticket_definition_deleted
824
- */
825
- export declare function onTicketDefinitionDeleted(handler: (event: TicketDefinitionDeletedEnvelope) => void | Promise<void>): void;
826
- export interface TicketDefinitionUpdatedEnvelope {
827
- data: TicketDefinitionUpdated;
828
- metadata: BaseEventMetadata;
829
- }
830
- /** @permissionScope Manage Events - all permissions
831
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
832
- * @permissionScope Manage Events
833
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
834
- * @permissionScope Manage Orders
835
- * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
836
- * @permissionScope Manage Ticket Definitions
837
- * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
838
- * @permissionId WIX_EVENTS.READ_TICKET_DEFINITIONS
839
- * @webhook
840
- * @eventType wix.events.ticketing.events.TicketDefinitionUpdated
841
- * @serviceIdentifier wix.events.ticketing.TicketDefinitionManagement
842
- * @slug ticket_definition_updated
843
- */
844
- export declare function onTicketDefinitionUpdated(handler: (event: TicketDefinitionUpdatedEnvelope) => void | Promise<void>): void;
845
- /**
846
- * **Deprecated.** This function will continue to work until November 8, 2024, but a newer version is available. Use [`queryTicketDefinitions()`](/ticket-definitions-v2/query-ticket-definitions) function instead.
847
- * >**Migration Instructions**.
848
- * > If this function is already in your code, it will continue to work. To stay compatible with future changes, migrate to [`queryTicketDefinition()`](/ticket-definitions-v2/query-ticket-definitions).
849
- * > To migrate to the new function:
850
- * > 1. Add the new import statement:
851
- * > ```js
852
- * > import { ticketDefinitionsV2 } from 'wix-events.v2';
853
- * > ```
854
- * > 2. Look for any code that uses `ticketDefinitions.queryTicketDefinition()`, and replace it with `ticketDefinitionsV2.queryTicketDefinition()`. Update your code to work with the new `createTicketDefinition()` response properties.
855
- * > 3. Test your changes to make sure your code behaves as expected.
856
- *
857
- * Retrieves a list of up to 100 ticket definitions.
858
- * @public
859
- * @permissionId WIX_EVENTS.READ_TICKET_DEFINITIONS
860
- * @permissionScope Manage Events - all permissions
861
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
862
- * @permissionScope Manage Events
863
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
864
- * @permissionScope Manage Orders
865
- * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
866
- * @permissionScope Manage Ticket Definitions
867
- * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
868
- * @applicableIdentity APP
869
- * @fqn wix.events.ticketing.TicketDefinitionManagement.QueryTicketDefinitions
870
- * @deprecated
871
- * @targetRemovalDate 2024-12-01
872
- */
873
- export declare function queryTicketDefinitions(options?: QueryTicketDefinitionsOptions): Promise<QueryTicketDefinitionsResponse & QueryTicketDefinitionsResponseNonNullableFields>;
874
- export interface QueryTicketDefinitionsOptions {
875
- /** Offset. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */
876
- offset?: number;
877
- /**
878
- * Limit. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).
879
- * @max 100
880
- */
881
- limit?: number;
882
- /**
883
- * Set of fields to return in the response. See [fieldsets](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_ticket-definition-fieldset).
884
- * @maxSize 20
885
- */
886
- fieldset?: TicketDefinitionFieldset[];
887
- /** Filter. See [supported fields and operators](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_query-ticket-definitions). */
888
- filter?: Record<string, any> | null;
889
- /**
890
- * Sort order. Defaults to: "created:asc".
891
- * See [supported fields](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_query-ticket-definitions).
892
- * @maxLength 100
893
- */
894
- sort?: string;
895
- /**
896
- * Filter facets to include in the response.
897
- * See [supported facets](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_query-ticket-definitions).
898
- * @maxLength 20
899
- * @maxSize 10
900
- */
901
- facet?: string[];
902
- }
903
- /**
904
- * **Deprecated.** This function will continue to work until October 29, 2024, but a newer version is available at [`queryTicketDefinitions()`](/ticket-definitions-v2/query-ticket-definitions).
905
- * >**Migration Instructions**.
906
- * > If this function is already in your code, it will continue to work. To stay compatible with future changes, migrate to [`queryTicketDefinitions()`](/ticket-definitions-v2/query-ticket-definitions).
907
- * > To migrate to the new function:
908
- * > 1. Add the new import statement:
909
- * > ```js
910
- * > import { ticketDefinitionsV2 } from 'wix-events.v2';
911
- * > ```
912
- * > 2. Look for any code that uses `ticketDefinitions.queryTicketDefinitions()`, and replace it with `ticketDefinitionsV2.queryTicketDefinitions()`. Update your code to work with the new `queryTicketDefinition()` response properties.
913
- * > 3. Test your changes to make sure your code behaves as expected.
914
- *
915
- * Retrieves a list of up to 1,000 ticket definitions, given the provided paging and filtering.
916
- * @public
917
- * @documentationMaturity preview
918
- * @permissionScope Manage Events - all permissions
919
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
920
- * @permissionScope Manage Events
921
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
922
- * @permissionScope Manage Orders
923
- * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
924
- * @permissionScope Manage Ticket Definitions
925
- * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
926
- * @permissionId WIX_EVENTS.READ_TICKET_DEFINITIONS
927
- * @applicableIdentity APP
928
- * @fqn wix.events.ticketing.TicketDefinitionManagement.QueryTicketDefinitionsV2
929
- * @deprecated
930
- * @targetRemovalDate 2024-12-01
931
- */
932
- export declare function queryTicketDefinitionsV2(options?: QueryTicketDefinitionsV2Options): DefinitionsQueryBuilder;
933
- export interface QueryTicketDefinitionsV2Options {
934
- }
935
- interface QueryCursorResult {
936
- cursors: Cursors;
937
- hasNext: () => boolean;
938
- hasPrev: () => boolean;
939
- length: number;
940
- pageSize: number;
941
- }
942
- export interface DefinitionsQueryResult extends QueryCursorResult {
943
- items: TicketDefinition[];
944
- query: DefinitionsQueryBuilder;
945
- next: () => Promise<DefinitionsQueryResult>;
946
- prev: () => Promise<DefinitionsQueryResult>;
947
- }
948
- export interface DefinitionsQueryBuilder {
949
- /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
950
- * @documentationMaturity preview
951
- */
952
- limit: (limit: number) => DefinitionsQueryBuilder;
953
- /** @param cursor - A pointer to specific record
954
- * @documentationMaturity preview
955
- */
956
- skipTo: (cursor: string) => DefinitionsQueryBuilder;
957
- /** @documentationMaturity preview */
958
- find: () => Promise<DefinitionsQueryResult>;
959
- }
960
- /**
961
- * **Deprecated.** This function will continue to work until November 8, 2024, but a substitute is available. Use the [`queryTicketDefinitions()`](/ticket-definitions-v2/query-ticket-definitions) function instead.
962
- * >**Migration Instructions**.
963
- * > If this function is already in your code, it will continue to work. To stay compatible with future changes, migrate to [`queryTicketDefinitions()`](/ticket-definitions-v2/query-ticket-definitions).
964
- * > To migrate to the new function:
965
- * > 1. Add the new import statement:
966
- * > ```js
967
- * > import { ticketDefinitionsV2 } from 'wix-events.v2';
968
- * > ```
969
- * > 2. Look for any code that uses `ticketDefinitions.queryTicketDefinitions()`, and replace it with `ticketDefinitionsV2.queryTicketDefinitions()`. Update your code to work with the new `queryTicketDefinition()` response properties.
970
- * > 3. Test your changes to make sure your code behaves as expected.
971
- *
972
- * Retrieves a list of up to 100 ticket definitions, with basic filter support.
973
- * @public
974
- * @param options - Details for the tickets to retrieve.
975
- * @permissionId WIX_EVENTS.READ_TICKET_DEFINITIONS
976
- * @permissionScope Manage Events - all permissions
977
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
978
- * @permissionScope Manage Events
979
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
980
- * @permissionScope Manage Orders
981
- * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
982
- * @permissionScope Manage Ticket Definitions
983
- * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
984
- * @applicableIdentity APP
985
- * @fqn wix.events.ticketing.TicketDefinitionManagement.ListTicketDefinitions
986
- * @deprecated
987
- * @targetRemovalDate 2024-12-01
988
- */
989
- export declare function listTicketDefinitions(options?: ListTicketDefinitionsOptions): Promise<ListTicketDefinitionsResponse & ListTicketDefinitionsResponseNonNullableFields>;
990
- export interface ListTicketDefinitionsOptions {
991
- /**
992
- * Event ID.
993
- * @format GUID
994
- * @maxSize 100
995
- */
996
- eventId?: string[];
997
- /** Offset. */
998
- offset?: number;
999
- /**
1000
- * Paging limit.
1001
- * @max 100
1002
- */
1003
- limit?: number;
1004
- /**
1005
- * Predefined sets of fields to return.
1006
- * - `DASHBOARD`: Returns `dashboard`.
1007
- * - `POLICY`: Returns `policy`.
1008
- *
1009
- * Default: If `fieldset` is omitted from the request, `id`, `price`, `free`, `name`, `limitPerCheckout`, `orderIndex`, `eventId`.
1010
- * @maxSize 20
1011
- */
1012
- fieldset?: TicketDefinitionFieldset[];
1013
- /**
1014
- * Event creator ID.
1015
- * @format GUID
1016
- * @maxSize 1
1017
- */
1018
- eventCreatorId?: string[];
1019
- /**
1020
- * Filter by ticket definition state.
1021
- *
1022
- * Supported values: `"VISIBLE"`, `"HIDDEN"`, `"FREE"`, `"PAID"`
1023
- * @maxSize 20
1024
- */
1025
- state?: State[];
1026
- /**
1027
- * Sort order.
1028
- *
1029
- * Default: `"created"`:`"asc"`.
1030
- *
1031
- * See [Ticket Definitions Sort](/wix-events-v2/ticketdefinitions/ticket-definitions-sort) for more information.
1032
- *
1033
- *
1034
- *
1035
- *
1036
- * @maxLength 100
1037
- */
1038
- sort?: string;
1039
- /**
1040
- * Ticket sale status.
1041
- *
1042
- * Supported values: `"SALE_SCHEDULED"`, `"SALE_STARTED"`, `"SALE_ENDED"`
1043
- * @maxSize 5
1044
- */
1045
- saleStatus?: TicketSaleStatus[];
1046
- /**
1047
- * Filter facets.
1048
- * @maxLength 20
1049
- * @maxSize 10
1050
- */
1051
- facet?: string[];
1052
- }
1053
- /**
1054
- * **Deprecated.** This function will continue to work until November 8, 2024, but a newer version is available. Use the [`getTicketDefinition()`](/ticket-definitions-v2/get-ticket-definition) function instead.
1055
- * >**Migration Instructions**.
1056
- * > If this function is already in your code, it will continue to work. To stay compatible with future changes, migrate to [`getTicketDefinition()`](/ticket-definitions-v2/get-ticket-definition).
1057
- * > To migrate to the new function:
1058
- * > 1. Add the new import statement:
1059
- * > ```js
1060
- * > import { ticketDefinitionsV2 } from 'wix-events.v2';
1061
- * > ```
1062
- * > 2. Look for any code that uses `ticketDefinitions.getTicketDefinition()`, and replace it with `ticketDefinitionsV2.getTicketDefinition()`. Update your code to work with the new `getTicketDefinition()` response properties.
1063
- * > 3. Test your changes to make sure your code behaves as expected.
1064
- *
1065
- * Retrieves a ticket definition.
1066
- * @param definitionId - Ticket definition ID.
1067
- * @public
1068
- * @requiredField definitionId
1069
- * @param options - Details for the ticket to retrieve.
1070
- * @permissionId WIX_EVENTS.READ_TICKET_DEFINITIONS
1071
- * @permissionScope Manage Events - all permissions
1072
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
1073
- * @permissionScope Manage Events
1074
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1075
- * @permissionScope Manage Orders
1076
- * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
1077
- * @permissionScope Manage Ticket Definitions
1078
- * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
1079
- * @applicableIdentity APP
1080
- * @returns Retrieved ticket definition.
1081
- * @fqn wix.events.ticketing.TicketDefinitionManagement.GetTicketDefinition
1082
- * @deprecated
1083
- * @targetRemovalDate 2024-12-01
1084
- */
1085
- export declare function getTicketDefinition(definitionId: string, options?: GetTicketDefinitionOptions): Promise<TicketDefinition & TicketDefinitionNonNullableFields>;
1086
- export interface GetTicketDefinitionOptions {
1087
- /**
1088
- * Predefined sets of fields to return.
1089
- * - `DASHBOARD`: Returns `dashboard`.
1090
- * - `POLICY`: Returns `policy`.
1091
- *
1092
- * Default: If `fieldset` is omitted from the request, `id`, `price`, `free`, `name`, `limitPerCheckout`, `orderIndex`, `eventId`.
1093
- * @maxSize 20
1094
- */
1095
- fieldset?: TicketDefinitionFieldset[];
1096
- }
1097
- /**
1098
- * **Deprecated.** This function will continue to work until November 8, 2024, but a newer version is available. Use the [`createTicketDefinition()`](/ticket-definitions-v2/create-ticket-definition) function instead.
1099
- * >**Migration Instructions**.
1100
- * > If this function is already in your code, it will continue to work. To stay compatible with future changes, migrate to [`createTicketDefinition()`](/ticket-definitions-v2/create-ticket-definition).
1101
- * > To migrate to the new function:
1102
- * > 1. Add the new import statement:
1103
- * > ```js
1104
- * > import { ticketDefinitionsV2 } from 'wix-events.v2';
1105
- * > ```
1106
- * > 2. Look for any code that uses `ticketDefinitions.createTicketDefinition()`, and replace it with `ticketDefinitionsV2.createTicketDefinition()`. Update your code to work with the new `createTicketDefinition()` response properties.
1107
- * > 3. Test your changes to make sure your code behaves as expected.
1108
- *
1109
- * Creates a ticket definition (and enables ticket sales).
1110
- * @param eventId - Event ID.
1111
- * @public
1112
- * @requiredField eventId
1113
- * @requiredField options
1114
- * @requiredField options.definition
1115
- * @requiredField options.definition.name
1116
- * @permissionId WIX_EVENTS.MANAGE_TICKET_DEFINITIONS
1117
- * @permissionScope Manage Events - all permissions
1118
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
1119
- * @permissionScope Manage Events
1120
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1121
- * @permissionScope Manage Ticket Definitions
1122
- * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
1123
- * @applicableIdentity APP
1124
- * @fqn wix.events.ticketing.TicketDefinitionManagement.CreateTicketDefinition
1125
- * @deprecated
1126
- * @targetRemovalDate 2024-12-01
1127
- */
1128
- export declare function createTicketDefinition(eventId: string, options: CreateTicketDefinitionOptions): Promise<CreateTicketDefinitionResponse & CreateTicketDefinitionResponseNonNullableFields>;
1129
- export interface CreateTicketDefinitionOptions {
1130
- /** Ticket definition data. */
1131
- definition: TicketDefinitionData;
1132
- }
1133
- /**
1134
- * **Deprecated.** This function will continue to work until November 8, 2024, but a newer version is available. Use the [`updateTicketDefinition()`](/ticket-definitions-v2/update-ticket-definition) function instead.
1135
- * >**Migration Instructions**.
1136
- * > If this function is already in your code, it will continue to work. To stay compatible with future changes, migrate to [`updateTicketDefinition()`](/ticket-definitions-v2/update-ticket-definition).
1137
- * > To migrate to the new function:
1138
- * > 1. Add the new import statement:
1139
- * > ```js
1140
- * > import { ticketDefinitionsV2 } from 'wix-events.v2';
1141
- * > ```
1142
- * > 2. Look for any code that uses `ticketDefinitions.updateTicketDefinition()`, and replace it with `ticketDefinitionsV2.updateTicketDefinition()`. Update your code to work with the new `updateTicketDefinition()` response properties.
1143
- * > 3. Test your changes to make sure your code behaves as expected.
1144
- *
1145
- *
1146
- * Updates a ticket definition.
1147
- *
1148
- * See [Partial Updates](/wix-events-v2/partial-updates) for more information.
1149
- * @param definitionId - Ticket definition ID.
1150
- * @param eventId - Event ID.
1151
- * @public
1152
- * @requiredField definitionId
1153
- * @requiredField eventId
1154
- * @requiredField options.definition.pricing.price
1155
- * @param identifiers - Details of the ticket definition to update.
1156
- * @param options - Ticket definition details to update.
1157
- * @permissionId WIX_EVENTS.MANAGE_TICKET_DEFINITIONS
1158
- * @permissionScope Manage Events - all permissions
1159
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
1160
- * @permissionScope Manage Events
1161
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1162
- * @permissionScope Manage Ticket Definitions
1163
- * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
1164
- * @applicableIdentity APP
1165
- * @fqn wix.events.ticketing.TicketDefinitionManagement.UpdateTicketDefinition
1166
- * @deprecated
1167
- * @targetRemovalDate 2024-12-01
1168
- */
1169
- export declare function updateTicketDefinition(definitionId: string, eventId: string, options?: UpdateTicketDefinitionOptions): Promise<UpdateTicketDefinitionResponse & UpdateTicketDefinitionResponseNonNullableFields>;
1170
- export interface UpdateTicketDefinitionOptions {
1171
- /** Ticket definition data. */
1172
- definition?: TicketDefinitionData;
1173
- /** Set of field paths, specifying which parts of ticket definition to update. */
1174
- fields?: string[];
1175
- }
1176
- /**
1177
- * **Deprecated.** This function will continue to work until November 8, 2024, but a newer version is available. Use the [`deleteTicketDefinition()`](/ticket-definitions-v2/delete-ticket-definition) function instead.
1178
- * >**Migration Instructions**.
1179
- * > If this function is already in your code, it will continue to work. To stay compatible with future changes, migrate to [`deleteTicketDefinition()`](/ticket-definitions-v2/delete-ticket-definition).
1180
- * > To migrate to the new function:
1181
- * > 1. Add the new import statement:
1182
- * > ```js
1183
- * > import { ticketDefinitionsV2 } from 'wix-events.v2';
1184
- * > ```
1185
- * > 2. Look for any code that uses `ticketDefinitions.deleteTicketDefinition()`, and replace it with `ticketDefinitionsV2.deleteTicketDefinition()`. Update your code to work with the new `deleteTicketDefinition()` response properties.
1186
- * > 3. Test your changes to make sure your code behaves as expected.
1187
- *
1188
- * Deletes a ticket definition.
1189
- * @param eventId - Event ID.
1190
- * @public
1191
- * @requiredField eventId
1192
- * @param options - Details of tickets to delete.
1193
- * @permissionId WIX_EVENTS.MANAGE_TICKET_DEFINITIONS
1194
- * @permissionScope Manage Events - all permissions
1195
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
1196
- * @permissionScope Manage Events
1197
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1198
- * @permissionScope Manage Ticket Definitions
1199
- * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
1200
- * @applicableIdentity APP
1201
- * @fqn wix.events.ticketing.TicketDefinitionManagement.DeleteTicketDefinition
1202
- * @deprecated
1203
- * @targetRemovalDate 2024-12-01
1204
- */
1205
- export declare function deleteTicketDefinition(eventId: string, options?: DeleteTicketDefinitionOptions): Promise<void>;
1206
- export interface DeleteTicketDefinitionOptions extends DeleteTicketDefinitionOptionsDeleteOneOf {
1207
- /** Ticket definitions to delete. */
1208
- byId?: ById;
1209
- /** Whether to delete all event tickets. */
1210
- all?: boolean;
1211
- }
1212
- /** @oneof */
1213
- export interface DeleteTicketDefinitionOptionsDeleteOneOf {
1214
- /** Ticket definitions to delete. */
1215
- byId?: ById;
1216
- /** Whether to delete all event tickets. */
1217
- all?: boolean;
1218
- }
1219
- /**
1220
- * **Deprecated.** This function will continue to work until November 8, 2024, but a newer version is available at [`changeCurrency()`](/ticket-definitions-v2/change-currency).
1221
- * >**Migration Instructions**.
1222
- * > If this function is already in your code, it will continue to work. To stay compatible with future changes, migrate to [`changeCurrency()`](/ticket-definitions-v2/change-currency).
1223
- * > To migrate to the new function:
1224
- * > 1. Add the new import statement:
1225
- * > ```js
1226
- * > import { ticketDefinitionsV2 } from 'wix-events.v2';
1227
- * > ```
1228
- * > 2. Look for any code that uses `ticketDefinitions.changeCurrency()`, and replace it with `ticketDefinitionsV2.changeCurrency()`. Update your code to work with the new `changeCurrency()` response properties.
1229
- * > 3. Test your changes to make sure your code behaves as expected.
1230
- *
1231
- * Changes the currency for all tickets per event.
1232
- *
1233
- * @public
1234
- * @requiredField options.currency
1235
- * @permissionId WIX_EVENTS.MANAGE_TICKET_DEFINITIONS
1236
- * @permissionScope Manage Events - all permissions
1237
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
1238
- * @permissionScope Manage Events
1239
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1240
- * @permissionScope Manage Ticket Definitions
1241
- * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
1242
- * @applicableIdentity APP
1243
- * @fqn wix.events.ticketing.TicketDefinitionManagement.ChangeCurrency
1244
- * @deprecated
1245
- * @targetRemovalDate 2024-12-01
1246
- */
1247
- export declare function changeCurrency(options?: ChangeCurrencyOptions): Promise<void>;
1248
- export interface ChangeCurrencyOptions {
1249
- /**
1250
- * Event ID.
1251
- * @format GUID
1252
- */
1253
- eventId?: string;
1254
- /**
1255
- * Event currency, in 3-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
1256
- * @minLength 3
1257
- * @maxLength 3
1258
- */
1259
- currency: string;
1260
- }
1261
- export {};