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