@wix/auto_sdk_events_ticket-definitions 1.0.16 → 1.0.17

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