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