@wix/auto_sdk_events_ticket-definitions 1.0.16 → 1.0.18

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (130) hide show
  1. package/build/events-v1-ticket-definition-ticket-definitions.universal-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/package.json +0 -3
  65. package/build/es/src/events-v1-ticket-definition-ticket-definitions.context.d.ts +0 -22
  66. package/build/es/src/events-v1-ticket-definition-ticket-definitions.context.js +0 -22
  67. package/build/es/src/events-v1-ticket-definition-ticket-definitions.context.js.map +0 -1
  68. package/build/es/src/events-v1-ticket-definition-ticket-definitions.http.d.ts +0 -132
  69. package/build/es/src/events-v1-ticket-definition-ticket-definitions.http.js +0 -692
  70. package/build/es/src/events-v1-ticket-definition-ticket-definitions.http.js.map +0 -1
  71. package/build/es/src/events-v1-ticket-definition-ticket-definitions.meta.d.ts +0 -24
  72. package/build/es/src/events-v1-ticket-definition-ticket-definitions.meta.js +0 -146
  73. package/build/es/src/events-v1-ticket-definition-ticket-definitions.meta.js.map +0 -1
  74. package/build/es/src/events-v1-ticket-definition-ticket-definitions.public.js +0 -66
  75. package/build/es/src/events-v1-ticket-definition-ticket-definitions.public.js.map +0 -1
  76. package/build/es/src/events-v1-ticket-definition-ticket-definitions.types.js +0 -68
  77. package/build/es/src/events-v1-ticket-definition-ticket-definitions.types.js.map +0 -1
  78. package/build/es/src/events-v1-ticket-definition-ticket-definitions.universal.d.ts +0 -1216
  79. package/build/es/src/events-v1-ticket-definition-ticket-definitions.universal.js +0 -577
  80. package/build/es/src/events-v1-ticket-definition-ticket-definitions.universal.js.map +0 -1
  81. package/build/internal/cjs/index.d.ts +0 -1
  82. package/build/internal/cjs/index.js +0 -18
  83. package/build/internal/cjs/index.js.map +0 -1
  84. package/build/internal/cjs/index.typings.d.ts +0 -1
  85. package/build/internal/cjs/index.typings.js +0 -18
  86. package/build/internal/cjs/index.typings.js.map +0 -1
  87. package/build/internal/cjs/meta.d.ts +0 -1
  88. package/build/internal/cjs/meta.js +0 -18
  89. package/build/internal/cjs/meta.js.map +0 -1
  90. package/build/internal/cjs/src/events-v1-ticket-definition-ticket-definitions.context.d.ts +0 -22
  91. package/build/internal/cjs/src/events-v1-ticket-definition-ticket-definitions.context.js +0 -34
  92. package/build/internal/cjs/src/events-v1-ticket-definition-ticket-definitions.context.js.map +0 -1
  93. package/build/internal/cjs/src/events-v1-ticket-definition-ticket-definitions.http.d.ts +0 -132
  94. package/build/internal/cjs/src/events-v1-ticket-definition-ticket-definitions.http.js +0 -703
  95. package/build/internal/cjs/src/events-v1-ticket-definition-ticket-definitions.http.js.map +0 -1
  96. package/build/internal/cjs/src/events-v1-ticket-definition-ticket-definitions.meta.d.ts +0 -24
  97. package/build/internal/cjs/src/events-v1-ticket-definition-ticket-definitions.meta.js +0 -180
  98. package/build/internal/cjs/src/events-v1-ticket-definition-ticket-definitions.meta.js.map +0 -1
  99. package/build/internal/cjs/src/events-v1-ticket-definition-ticket-definitions.public.js +0 -86
  100. package/build/internal/cjs/src/events-v1-ticket-definition-ticket-definitions.public.js.map +0 -1
  101. package/build/internal/cjs/src/events-v1-ticket-definition-ticket-definitions.types.js +0 -71
  102. package/build/internal/cjs/src/events-v1-ticket-definition-ticket-definitions.types.js.map +0 -1
  103. package/build/internal/cjs/src/events-v1-ticket-definition-ticket-definitions.universal.d.ts +0 -1223
  104. package/build/internal/cjs/src/events-v1-ticket-definition-ticket-definitions.universal.js +0 -611
  105. package/build/internal/cjs/src/events-v1-ticket-definition-ticket-definitions.universal.js.map +0 -1
  106. package/build/internal/es/index.d.ts +0 -1
  107. package/build/internal/es/index.js +0 -2
  108. package/build/internal/es/index.js.map +0 -1
  109. package/build/internal/es/index.typings.d.ts +0 -1
  110. package/build/internal/es/index.typings.js +0 -2
  111. package/build/internal/es/index.typings.js.map +0 -1
  112. package/build/internal/es/meta.d.ts +0 -1
  113. package/build/internal/es/meta.js +0 -2
  114. package/build/internal/es/meta.js.map +0 -1
  115. package/build/internal/es/src/events-v1-ticket-definition-ticket-definitions.context.d.ts +0 -22
  116. package/build/internal/es/src/events-v1-ticket-definition-ticket-definitions.context.js +0 -22
  117. package/build/internal/es/src/events-v1-ticket-definition-ticket-definitions.context.js.map +0 -1
  118. package/build/internal/es/src/events-v1-ticket-definition-ticket-definitions.http.d.ts +0 -132
  119. package/build/internal/es/src/events-v1-ticket-definition-ticket-definitions.http.js +0 -692
  120. package/build/internal/es/src/events-v1-ticket-definition-ticket-definitions.http.js.map +0 -1
  121. package/build/internal/es/src/events-v1-ticket-definition-ticket-definitions.meta.d.ts +0 -24
  122. package/build/internal/es/src/events-v1-ticket-definition-ticket-definitions.meta.js +0 -146
  123. package/build/internal/es/src/events-v1-ticket-definition-ticket-definitions.meta.js.map +0 -1
  124. package/build/internal/es/src/events-v1-ticket-definition-ticket-definitions.public.js +0 -66
  125. package/build/internal/es/src/events-v1-ticket-definition-ticket-definitions.public.js.map +0 -1
  126. package/build/internal/es/src/events-v1-ticket-definition-ticket-definitions.types.js +0 -68
  127. package/build/internal/es/src/events-v1-ticket-definition-ticket-definitions.types.js.map +0 -1
  128. package/build/internal/es/src/events-v1-ticket-definition-ticket-definitions.universal.d.ts +0 -1223
  129. package/build/internal/es/src/events-v1-ticket-definition-ticket-definitions.universal.js +0 -577
  130. package/build/internal/es/src/events-v1-ticket-definition-ticket-definitions.universal.js.map +0 -1
@@ -0,0 +1,910 @@
1
+ interface TicketDefinition {
2
+ /**
3
+ * Ticket definition ID.
4
+ * @format GUID
5
+ */
6
+ _id?: string;
7
+ /** Ticket price. */
8
+ price?: Money;
9
+ /** Whether the ticket is free (read only). */
10
+ free?: boolean;
11
+ /** Ticket name. */
12
+ name?: string;
13
+ /** Ticket description. */
14
+ description?: string;
15
+ /**
16
+ * Limit of tickets that can be purchased per checkout.
17
+ * Set to 20 for unlimited ticket definition.
18
+ * @max 20
19
+ */
20
+ limitPerCheckout?: number;
21
+ /** Custom sort index. */
22
+ orderIndex?: number;
23
+ /** Policy information plain text block, as printed on the ticket. */
24
+ policy?: string;
25
+ /** Sensitive dashboard data. */
26
+ dashboard?: Dashboard;
27
+ /**
28
+ * Event ID associated with the ticket.
29
+ * @format GUID
30
+ */
31
+ eventId?: string;
32
+ /**
33
+ * Configuration of the fixed-rate Wix ticket service fee that is applied at checkout to each ticket sold.
34
+ * @readonly
35
+ */
36
+ wixFeeConfig?: WixFeeConfig;
37
+ /** Ticket sale period. */
38
+ salePeriod?: TicketSalePeriod;
39
+ /**
40
+ * Ticket sale status.
41
+ * @readonly
42
+ */
43
+ saleStatus?: TicketSaleStatusWithLiterals;
44
+ /** Ticket state. */
45
+ state?: TicketDefinitionStateEnumStateWithLiterals[];
46
+ /** Ticket pricing. */
47
+ pricing?: TicketPricing;
48
+ }
49
+ interface Money {
50
+ /**
51
+ * Three-letter currency code in
52
+ * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
53
+ * @format CURRENCY
54
+ */
55
+ currency?: string;
56
+ /**
57
+ * Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, starts with a single (-), to indicate that the amount is negative.
58
+ * @format DECIMAL_VALUE
59
+ */
60
+ value?: string | null;
61
+ }
62
+ interface Dashboard {
63
+ /** Whether ticket is hidden and cannot be sold. */
64
+ hidden?: boolean;
65
+ /**
66
+ * Number of tickets sold and reserved.
67
+ * @deprecated
68
+ */
69
+ sold?: number;
70
+ /** Whether the ticket has limited quantity. */
71
+ limited?: boolean;
72
+ /** Ticket limit. `NULL` for unlimited ticket definitions. */
73
+ quantity?: number | null;
74
+ /** Number of unsold tickets. `NULL` for unlimited ticket definitions. */
75
+ unsold?: number | null;
76
+ /** Number of tickets sold. */
77
+ ticketsSold?: number;
78
+ /** Number of tickets reserved. */
79
+ ticketsReserved?: number;
80
+ }
81
+ interface WixFeeConfig {
82
+ /**
83
+ * Fee calculation method.
84
+ *
85
+ * Supported values: `"FEE_ADDED"`, `"FEE_INCLUDED"`, `"FEE_ADDED_AT_CHECKOUT"`
86
+ *
87
+ * Default: `"FEE_ADDED_AT_CHECKOUT"`
88
+ */
89
+ type?: FeeTypeWithLiterals;
90
+ }
91
+ declare enum FeeType {
92
+ /** Fee is added to the ticket price at checkout. */
93
+ FEE_ADDED = "FEE_ADDED",
94
+ /** Seller absorbs the fee. It's deducted from the ticket price. */
95
+ FEE_INCLUDED = "FEE_INCLUDED",
96
+ /** Fee is added to the ticket price at checkout. */
97
+ FEE_ADDED_AT_CHECKOUT = "FEE_ADDED_AT_CHECKOUT"
98
+ }
99
+ /** @enumType */
100
+ type FeeTypeWithLiterals = FeeType | 'FEE_ADDED' | 'FEE_INCLUDED' | 'FEE_ADDED_AT_CHECKOUT';
101
+ interface TicketSalePeriod {
102
+ /** Ticket sale start timestamp. */
103
+ startDate?: Date | null;
104
+ /** Ticket sale end timestamp. */
105
+ endDate?: Date | null;
106
+ /** Whether to hide this ticket if it's not on sale */
107
+ hideNotOnSale?: boolean;
108
+ }
109
+ declare enum TicketSaleStatus {
110
+ /** Ticket sale is scheduled to start. */
111
+ SALE_SCHEDULED = "SALE_SCHEDULED",
112
+ /** Ticket sale has started. */
113
+ SALE_STARTED = "SALE_STARTED",
114
+ /** Ticket sale has ended. */
115
+ SALE_ENDED = "SALE_ENDED"
116
+ }
117
+ /** @enumType */
118
+ type TicketSaleStatusWithLiterals = TicketSaleStatus | 'SALE_SCHEDULED' | 'SALE_STARTED' | 'SALE_ENDED';
119
+ declare enum TicketDefinitionStateEnumState {
120
+ INCLUDE_HIDDEN_NOT_ON_SALE = "INCLUDE_HIDDEN_NOT_ON_SALE"
121
+ }
122
+ /** @enumType */
123
+ type TicketDefinitionStateEnumStateWithLiterals = TicketDefinitionStateEnumState | 'INCLUDE_HIDDEN_NOT_ON_SALE';
124
+ interface TicketPricing extends TicketPricingPriceOneOf {
125
+ /** Ticket price which is read only. */
126
+ fixedPrice?: Money;
127
+ /** Min price per ticket, customizable. */
128
+ minPrice?: Money;
129
+ /** Ticket pricing options. */
130
+ pricingOptions?: PricingOptions;
131
+ /**
132
+ * Ticket pricing type.
133
+ * @readonly
134
+ */
135
+ pricingType?: TypeWithLiterals;
136
+ }
137
+ /** @oneof */
138
+ interface TicketPricingPriceOneOf {
139
+ /** Ticket price which is read only. */
140
+ fixedPrice?: Money;
141
+ /** Min price per ticket, customizable. */
142
+ minPrice?: Money;
143
+ /** Ticket pricing options. */
144
+ pricingOptions?: PricingOptions;
145
+ }
146
+ interface PricingOptions {
147
+ /** Multiple ticket pricing options. */
148
+ options?: PricingOption[];
149
+ }
150
+ interface PricingOption {
151
+ /**
152
+ * Ticket pricing option ID.
153
+ * @format GUID
154
+ */
155
+ _id?: string | null;
156
+ /**
157
+ * Ticket pricing option name.
158
+ * @minLength 1
159
+ * @maxLength 200
160
+ */
161
+ name?: string | null;
162
+ /** Ticket pricing option price. */
163
+ price?: Money;
164
+ }
165
+ declare enum Type {
166
+ STANDARD = "STANDARD",
167
+ DONATION = "DONATION"
168
+ }
169
+ /** @enumType */
170
+ type TypeWithLiterals = Type | 'STANDARD' | 'DONATION';
171
+ interface QueryTicketDefinitionsRequest {
172
+ /** Offset. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */
173
+ offset?: number;
174
+ /**
175
+ * Limit. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).
176
+ * @max 100
177
+ */
178
+ limit?: number;
179
+ /**
180
+ * 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).
181
+ * @maxSize 20
182
+ */
183
+ fieldset?: TicketDefinitionFieldsetWithLiterals[];
184
+ /** 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). */
185
+ filter?: Record<string, any> | null;
186
+ /**
187
+ * Sort order. Defaults to: "created:asc".
188
+ * 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).
189
+ * @maxLength 100
190
+ */
191
+ sort?: string;
192
+ /**
193
+ * Filter facets to include in the response.
194
+ * 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).
195
+ * @maxLength 20
196
+ * @maxSize 10
197
+ */
198
+ facet?: string[];
199
+ }
200
+ declare enum TicketDefinitionFieldset {
201
+ /** Include `policy` in the response. */
202
+ POLICY = "POLICY",
203
+ /** Include `dashboard` in the response. */
204
+ DASHBOARD = "DASHBOARD"
205
+ }
206
+ /** @enumType */
207
+ type TicketDefinitionFieldsetWithLiterals = TicketDefinitionFieldset | 'POLICY' | 'DASHBOARD';
208
+ interface QueryTicketDefinitionsResponse {
209
+ /** Total ticket definitions matching the given filters. */
210
+ total?: number;
211
+ /** Offset. */
212
+ offset?: number;
213
+ /**
214
+ * Limit.
215
+ * @max 100
216
+ */
217
+ limit?: number;
218
+ /** Ticket definitions. */
219
+ definitions?: TicketDefinition[];
220
+ /** Filter facets. */
221
+ facets?: Record<string, FacetCounts>;
222
+ }
223
+ interface FacetCounts {
224
+ /** Facet counts aggregated per value. */
225
+ counts?: Record<string, number>;
226
+ }
227
+ interface QueryTicketDefinitionsV2Request {
228
+ /** Query request object. */
229
+ query?: QueryV2;
230
+ }
231
+ interface QueryV2 extends QueryV2PagingMethodOneOf {
232
+ /** Paging options to limit and skip the number of items. */
233
+ paging?: Paging;
234
+ /** 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`. */
235
+ cursorPaging?: CursorPaging;
236
+ /**
237
+ * Filter object.
238
+ *
239
+ * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
240
+ */
241
+ filter?: Record<string, any> | null;
242
+ /**
243
+ * Sort object.
244
+ *
245
+ * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
246
+ */
247
+ sort?: Sorting[];
248
+ /** 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. */
249
+ fields?: string[];
250
+ /** 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. */
251
+ fieldsets?: string[];
252
+ }
253
+ /** @oneof */
254
+ interface QueryV2PagingMethodOneOf {
255
+ /** Paging options to limit and skip the number of items. */
256
+ paging?: Paging;
257
+ /** 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`. */
258
+ cursorPaging?: CursorPaging;
259
+ }
260
+ interface Sorting {
261
+ /**
262
+ * Name of the field to sort by.
263
+ * @maxLength 512
264
+ */
265
+ fieldName?: string;
266
+ /** Sort order. */
267
+ order?: SortOrderWithLiterals;
268
+ }
269
+ declare enum SortOrder {
270
+ ASC = "ASC",
271
+ DESC = "DESC"
272
+ }
273
+ /** @enumType */
274
+ type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
275
+ interface Paging {
276
+ /** Number of items to load. */
277
+ limit?: number | null;
278
+ /** Number of items to skip in the current sort order. */
279
+ offset?: number | null;
280
+ }
281
+ interface CursorPaging {
282
+ /**
283
+ * Maximum number of items to return in the results.
284
+ * @max 100
285
+ */
286
+ limit?: number | null;
287
+ /**
288
+ * Pointer to the next or previous page in the list of results.
289
+ *
290
+ * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
291
+ * Not relevant for the first request.
292
+ * @maxLength 16000
293
+ */
294
+ cursor?: string | null;
295
+ }
296
+ interface QueryTicketDefinitionsV2Response {
297
+ /** Ticket definitions. */
298
+ definitions?: TicketDefinition[];
299
+ /** Paging metadata definitions. */
300
+ metadata?: PagingMetadataV2;
301
+ }
302
+ interface PagingMetadataV2 {
303
+ /** Number of items returned in the response. */
304
+ count?: number | null;
305
+ /** Offset that was requested. */
306
+ offset?: number | null;
307
+ /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
308
+ total?: number | null;
309
+ /** Flag that indicates the server failed to calculate the `total` field. */
310
+ tooManyToCount?: boolean | null;
311
+ /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
312
+ cursors?: Cursors;
313
+ }
314
+ interface Cursors {
315
+ /**
316
+ * Cursor string pointing to the next page in the list of results.
317
+ * @maxLength 16000
318
+ */
319
+ next?: string | null;
320
+ /**
321
+ * Cursor pointing to the previous page in the list of results.
322
+ * @maxLength 16000
323
+ */
324
+ prev?: string | null;
325
+ }
326
+ interface ListTicketDefinitionsRequest {
327
+ /**
328
+ * Event ID.
329
+ * @format GUID
330
+ * @maxSize 100
331
+ */
332
+ eventId?: string[];
333
+ /** Offset. */
334
+ offset?: number;
335
+ /**
336
+ * Paging limit.
337
+ * @max 100
338
+ */
339
+ limit?: number;
340
+ /**
341
+ * Predefined sets of fields to return.
342
+ * - `DASHBOARD`: Returns `dashboard`.
343
+ * - `POLICY`: Returns `policy`.
344
+ *
345
+ * Default: If `fieldset` is omitted from the request, `id`, `price`, `free`, `name`, `limitPerCheckout`, `orderIndex`, `eventId`.
346
+ *
347
+ * @maxSize 20
348
+ */
349
+ fieldset?: TicketDefinitionFieldsetWithLiterals[];
350
+ /**
351
+ * Event creator ID.
352
+ * @format GUID
353
+ * @maxSize 1
354
+ */
355
+ eventCreatorId?: string[];
356
+ /**
357
+ * Filter by ticket definition state.
358
+ *
359
+ * Supported values: `"VISIBLE"`, `"HIDDEN"`, `"FREE"`, `"PAID"`
360
+ * @maxSize 20
361
+ */
362
+ state?: StateWithLiterals[];
363
+ /**
364
+ * Sort order.
365
+ *
366
+ * Default: `"created"`:`"asc"`
367
+ * @maxLength 100
368
+ */
369
+ sort?: string;
370
+ /**
371
+ * Ticket sale status.
372
+ *
373
+ * Supported values: `"SALE_SCHEDULED"`, `"SALE_STARTED"`, `"SALE_ENDED"`
374
+ * @maxSize 5
375
+ */
376
+ saleStatus?: TicketSaleStatusWithLiterals[];
377
+ /**
378
+ * Filter facets.
379
+ * @maxLength 20
380
+ * @maxSize 10
381
+ */
382
+ facet?: string[];
383
+ }
384
+ declare enum State {
385
+ /** The ticket is available for purchase. */
386
+ VISIBLE = "VISIBLE",
387
+ /** The ticket is unavailable for purchase. */
388
+ HIDDEN = "HIDDEN",
389
+ /** The ticket price is 0. */
390
+ FREE = "FREE",
391
+ /** The ticket price is greater than 0. */
392
+ PAID = "PAID"
393
+ }
394
+ /** @enumType */
395
+ type StateWithLiterals = State | 'VISIBLE' | 'HIDDEN' | 'FREE' | 'PAID';
396
+ declare enum GroupBy {
397
+ /** No grouping. */
398
+ NONE = "NONE",
399
+ /** Groups by event created date with descending sorting. */
400
+ EVENT_CREATED_DESC = "EVENT_CREATED_DESC",
401
+ /** Groups by event created date with ascending sorting. */
402
+ EVENT_CREATED_ASC = "EVENT_CREATED_ASC"
403
+ }
404
+ interface ListTicketDefinitionsResponse {
405
+ /** Meta data. */
406
+ metaData?: ResponseMetaData;
407
+ /** Retrieved ticket definitions. */
408
+ definitions?: TicketDefinition[];
409
+ /** Filter facets. */
410
+ facets?: Record<string, FacetCounts>;
411
+ }
412
+ interface ResponseMetaData {
413
+ /** Number of items in the response. */
414
+ count?: number;
415
+ /** Offset of items. */
416
+ offset?: number;
417
+ /** Total number of matching items. */
418
+ total?: number;
419
+ }
420
+ interface GetTicketDefinitionRequest {
421
+ /**
422
+ * Ticket definition ID.
423
+ * @format GUID
424
+ */
425
+ definitionId: string;
426
+ /**
427
+ * Predefined sets of fields to return.
428
+ * - `DASHBOARD`: Returns `dashboard`.
429
+ * - `POLICY`: Returns `policy`.
430
+ *
431
+ * Default: If `fieldset` is omitted from the request, `id`, `price`, `free`, `name`, `limitPerCheckout`, `orderIndex`, `eventId`.
432
+ * @maxSize 20
433
+ */
434
+ fieldset?: TicketDefinitionFieldsetWithLiterals[];
435
+ }
436
+ interface GetTicketDefinitionResponse {
437
+ /** Retrieved ticket definition. */
438
+ definition?: TicketDefinition;
439
+ }
440
+ interface CreateTicketDefinitionRequest {
441
+ /**
442
+ * Event ID.
443
+ * @format GUID
444
+ */
445
+ eventId: string;
446
+ /** Ticket definition data. */
447
+ definition: TicketDefinitionData;
448
+ }
449
+ interface TicketDefinitionData {
450
+ /**
451
+ * Ticket name.
452
+ * @maxLength 30
453
+ */
454
+ name?: string | null;
455
+ /** Ticket price. */
456
+ price?: Money;
457
+ /**
458
+ * Ticket description.
459
+ * @maxLength 500
460
+ */
461
+ description?: string | null;
462
+ /** Whether this ticket type is limited in quantity. */
463
+ limited?: boolean;
464
+ /**
465
+ * Limit for this ticket type.
466
+ *
467
+ * `NULL` for unlimited.
468
+ */
469
+ quantity?: number | null;
470
+ /** Custom sort index for manual tickets ordering implementation. */
471
+ orderIndex?: number;
472
+ /**
473
+ * Policy information in plain text (as listed on the ticket).
474
+ * @maxLength 1000
475
+ */
476
+ policy?: string | null;
477
+ /** Whether this ticket type is hidden to customers and cannot be purchased. */
478
+ hidden?: boolean;
479
+ /** Configuration of the fixed-rate Wix ticket service fee that is applied to each ticket sold. */
480
+ wixFeeConfig?: WixFeeConfig;
481
+ /** Ticket sale period. */
482
+ salePeriod?: TicketSalePeriod;
483
+ /** Ticket pricing. */
484
+ pricing?: TicketPricing;
485
+ }
486
+ interface CreateTicketDefinitionResponse {
487
+ /** Created ticket definition. */
488
+ definition?: TicketDefinition;
489
+ }
490
+ interface TicketDefinitionCreated {
491
+ /** Ticket Definition created timestamp in ISO UTC format. */
492
+ timestamp?: Date | null;
493
+ /**
494
+ * Ticket Definition ID.
495
+ * @format GUID
496
+ */
497
+ ticketDefinitionId?: string;
498
+ /**
499
+ * Event ID.
500
+ * @format GUID
501
+ */
502
+ eventId?: string;
503
+ /** Originated from. */
504
+ originatedFrom?: OriginatedFrom;
505
+ }
506
+ interface OriginatedFrom {
507
+ /**
508
+ * Instance ID. Indicates the original app instance which current entity originated from.
509
+ * @format GUID
510
+ */
511
+ instanceId?: string;
512
+ /**
513
+ * Event ID. Indicates the original event which current entity originated from.
514
+ * @format GUID
515
+ */
516
+ eventId?: string;
517
+ /**
518
+ * Event ID. Indicates the original entity which current entity originated from.
519
+ * @format GUID
520
+ */
521
+ entityId?: string;
522
+ }
523
+ interface UpdateTicketDefinitionRequest {
524
+ /**
525
+ * Event ID.
526
+ * @format GUID
527
+ */
528
+ eventId: string;
529
+ /**
530
+ * Ticket definition ID.
531
+ * @format GUID
532
+ */
533
+ definitionId: string;
534
+ /** Ticket definition data. */
535
+ definition?: TicketDefinitionData;
536
+ /** Set of field paths, specifying which parts of ticket definition to update. */
537
+ fields?: string[];
538
+ }
539
+ interface UpdateTicketDefinitionResponse {
540
+ /** Updated ticket definition. */
541
+ definition?: TicketDefinition;
542
+ }
543
+ interface TicketDefinitionUpdated {
544
+ /** Ticket definition updated timestamp in ISO UTC format. */
545
+ timestamp?: Date | null;
546
+ /**
547
+ * Ticket definition ID.
548
+ * @format GUID
549
+ */
550
+ ticketDefinitionId?: string;
551
+ /**
552
+ * Event ID.
553
+ * @format GUID
554
+ */
555
+ eventId?: string;
556
+ }
557
+ interface DeleteTicketDefinitionRequest extends DeleteTicketDefinitionRequestDeleteOneOf {
558
+ /** Ticket definitions to delete. */
559
+ byId?: ById;
560
+ /** Whether to delete all event tickets. */
561
+ all?: boolean;
562
+ /**
563
+ * Event ID.
564
+ * @format GUID
565
+ */
566
+ eventId: string;
567
+ }
568
+ /** @oneof */
569
+ interface DeleteTicketDefinitionRequestDeleteOneOf {
570
+ /** Ticket definitions to delete. */
571
+ byId?: ById;
572
+ /** Whether to delete all event tickets. */
573
+ all?: boolean;
574
+ }
575
+ interface ById {
576
+ /**
577
+ * Ticket definition IDs.
578
+ * @format GUID
579
+ * @minSize 1
580
+ * @maxSize 100
581
+ */
582
+ definitionId?: string[];
583
+ }
584
+ interface DeleteTicketDefinitionResponse {
585
+ }
586
+ interface TicketDefinitionDeleted {
587
+ /** Ticket definition deleted timestamp in ISO UTC format. */
588
+ timestamp?: Date | null;
589
+ /**
590
+ * Ticket definition ID.
591
+ * @format GUID
592
+ */
593
+ ticketDefinitionId?: string;
594
+ /**
595
+ * Event ID.
596
+ * @format GUID
597
+ */
598
+ eventId?: string;
599
+ }
600
+ interface ChangeCurrencyRequest {
601
+ /**
602
+ * Event ID.
603
+ * @format GUID
604
+ */
605
+ eventId?: string;
606
+ /**
607
+ * Event currency, in 3-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
608
+ * @minLength 3
609
+ * @maxLength 3
610
+ */
611
+ currency: string;
612
+ }
613
+ interface ChangeCurrencyResponse {
614
+ }
615
+ interface BulkCopyTicketDefinitionsByEventIdRequest {
616
+ /** Origin instance ID. */
617
+ originInstanceId?: string | null;
618
+ /**
619
+ * Origin Event ID.
620
+ * @format GUID
621
+ */
622
+ originEventId?: string;
623
+ /**
624
+ * Target Event ID.
625
+ * @format GUID
626
+ */
627
+ targetEventId?: string;
628
+ }
629
+ interface BulkCopyTicketDefinitionsByEventIdResponse {
630
+ /** Copied ticket definitions. */
631
+ definitions?: CopiedTicketDefinition[];
632
+ }
633
+ interface CopiedTicketDefinition {
634
+ /** Origin Ticket definition ID. */
635
+ originTicketDefinitionId?: string;
636
+ /** Ticket definition ID. */
637
+ ticketDefinitionId?: string;
638
+ }
639
+ interface PaidTicketDefinitionExistsRequest {
640
+ }
641
+ interface PaidTicketDefinitionExistsResponse {
642
+ /** Paid exists. */
643
+ paidExists?: boolean;
644
+ }
645
+ interface MessageEnvelope {
646
+ /**
647
+ * App instance ID.
648
+ * @format GUID
649
+ */
650
+ instanceId?: string | null;
651
+ /**
652
+ * Event type.
653
+ * @maxLength 150
654
+ */
655
+ eventType?: string;
656
+ /** The identification type and identity data. */
657
+ identity?: IdentificationData;
658
+ /** Stringify payload. */
659
+ data?: string;
660
+ }
661
+ interface IdentificationData extends IdentificationDataIdOneOf {
662
+ /**
663
+ * ID of a site visitor that has not logged in to the site.
664
+ * @format GUID
665
+ */
666
+ anonymousVisitorId?: string;
667
+ /**
668
+ * ID of a site visitor that has logged in to the site.
669
+ * @format GUID
670
+ */
671
+ memberId?: string;
672
+ /**
673
+ * ID of a Wix user (site owner, contributor, etc.).
674
+ * @format GUID
675
+ */
676
+ wixUserId?: string;
677
+ /**
678
+ * ID of an app.
679
+ * @format GUID
680
+ */
681
+ appId?: string;
682
+ /** @readonly */
683
+ identityType?: WebhookIdentityTypeWithLiterals;
684
+ }
685
+ /** @oneof */
686
+ interface IdentificationDataIdOneOf {
687
+ /**
688
+ * ID of a site visitor that has not logged in to the site.
689
+ * @format GUID
690
+ */
691
+ anonymousVisitorId?: string;
692
+ /**
693
+ * ID of a site visitor that has logged in to the site.
694
+ * @format GUID
695
+ */
696
+ memberId?: string;
697
+ /**
698
+ * ID of a Wix user (site owner, contributor, etc.).
699
+ * @format GUID
700
+ */
701
+ wixUserId?: string;
702
+ /**
703
+ * ID of an app.
704
+ * @format GUID
705
+ */
706
+ appId?: string;
707
+ }
708
+ declare enum WebhookIdentityType {
709
+ UNKNOWN = "UNKNOWN",
710
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
711
+ MEMBER = "MEMBER",
712
+ WIX_USER = "WIX_USER",
713
+ APP = "APP"
714
+ }
715
+ /** @enumType */
716
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
717
+ interface BaseEventMetadata {
718
+ /**
719
+ * App instance ID.
720
+ * @format GUID
721
+ */
722
+ instanceId?: string | null;
723
+ /**
724
+ * Event type.
725
+ * @maxLength 150
726
+ */
727
+ eventType?: string;
728
+ /** The identification type and identity data. */
729
+ identity?: IdentificationData;
730
+ }
731
+ interface TicketDefinitionCreatedEnvelope {
732
+ data: TicketDefinitionCreated;
733
+ metadata: BaseEventMetadata;
734
+ }
735
+ interface TicketDefinitionDeletedEnvelope {
736
+ data: TicketDefinitionDeleted;
737
+ metadata: BaseEventMetadata;
738
+ }
739
+ interface TicketDefinitionUpdatedEnvelope {
740
+ data: TicketDefinitionUpdated;
741
+ metadata: BaseEventMetadata;
742
+ }
743
+ interface QueryTicketDefinitionsOptions {
744
+ /** Offset. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */
745
+ offset?: number;
746
+ /**
747
+ * Limit. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).
748
+ * @max 100
749
+ */
750
+ limit?: number;
751
+ /**
752
+ * 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).
753
+ * @maxSize 20
754
+ */
755
+ fieldset?: TicketDefinitionFieldsetWithLiterals[];
756
+ /** 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). */
757
+ filter?: Record<string, any> | null;
758
+ /**
759
+ * Sort order. Defaults to: "created:asc".
760
+ * 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).
761
+ * @maxLength 100
762
+ */
763
+ sort?: string;
764
+ /**
765
+ * Filter facets to include in the response.
766
+ * 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).
767
+ * @maxLength 20
768
+ * @maxSize 10
769
+ */
770
+ facet?: string[];
771
+ }
772
+ interface QueryTicketDefinitionsV2Options {
773
+ }
774
+ interface QueryCursorResult {
775
+ cursors: Cursors;
776
+ hasNext: () => boolean;
777
+ hasPrev: () => boolean;
778
+ length: number;
779
+ pageSize: number;
780
+ }
781
+ interface DefinitionsQueryResult extends QueryCursorResult {
782
+ items: TicketDefinition[];
783
+ query: DefinitionsQueryBuilder;
784
+ next: () => Promise<DefinitionsQueryResult>;
785
+ prev: () => Promise<DefinitionsQueryResult>;
786
+ }
787
+ interface DefinitionsQueryBuilder {
788
+ /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
789
+ * @documentationMaturity preview
790
+ */
791
+ limit: (limit: number) => DefinitionsQueryBuilder;
792
+ /** @param cursor - A pointer to specific record
793
+ * @documentationMaturity preview
794
+ */
795
+ skipTo: (cursor: string) => DefinitionsQueryBuilder;
796
+ /** @documentationMaturity preview */
797
+ find: () => Promise<DefinitionsQueryResult>;
798
+ }
799
+ interface ListTicketDefinitionsOptions {
800
+ /**
801
+ * Event ID.
802
+ * @format GUID
803
+ * @maxSize 100
804
+ */
805
+ eventId?: string[];
806
+ /** Offset. */
807
+ offset?: number;
808
+ /**
809
+ * Paging limit.
810
+ * @max 100
811
+ */
812
+ limit?: number;
813
+ /**
814
+ * Predefined sets of fields to return.
815
+ * - `DASHBOARD`: Returns `dashboard`.
816
+ * - `POLICY`: Returns `policy`.
817
+ *
818
+ * Default: If `fieldset` is omitted from the request, `id`, `price`, `free`, `name`, `limitPerCheckout`, `orderIndex`, `eventId`.
819
+ * @maxSize 20
820
+ */
821
+ fieldset?: TicketDefinitionFieldsetWithLiterals[];
822
+ /**
823
+ * Event creator ID.
824
+ * @format GUID
825
+ * @maxSize 1
826
+ */
827
+ eventCreatorId?: string[];
828
+ /**
829
+ * Filter by ticket definition state.
830
+ *
831
+ * Supported values: `"VISIBLE"`, `"HIDDEN"`, `"FREE"`, `"PAID"`
832
+ * @maxSize 20
833
+ */
834
+ state?: StateWithLiterals[];
835
+ /**
836
+ * Sort order.
837
+ *
838
+ * Default: `"created"`:`"asc"`.
839
+ *
840
+ * See [Ticket Definitions Sort](/wix-events-v2/ticketdefinitions/ticket-definitions-sort) for more information.
841
+ *
842
+ *
843
+ *
844
+ *
845
+ * @maxLength 100
846
+ */
847
+ sort?: string;
848
+ /**
849
+ * Ticket sale status.
850
+ *
851
+ * Supported values: `"SALE_SCHEDULED"`, `"SALE_STARTED"`, `"SALE_ENDED"`
852
+ * @maxSize 5
853
+ */
854
+ saleStatus?: TicketSaleStatusWithLiterals[];
855
+ /**
856
+ * Filter facets.
857
+ * @maxLength 20
858
+ * @maxSize 10
859
+ */
860
+ facet?: string[];
861
+ }
862
+ interface GetTicketDefinitionOptions {
863
+ /**
864
+ * Predefined sets of fields to return.
865
+ * - `DASHBOARD`: Returns `dashboard`.
866
+ * - `POLICY`: Returns `policy`.
867
+ *
868
+ * Default: If `fieldset` is omitted from the request, `id`, `price`, `free`, `name`, `limitPerCheckout`, `orderIndex`, `eventId`.
869
+ * @maxSize 20
870
+ */
871
+ fieldset?: TicketDefinitionFieldsetWithLiterals[];
872
+ }
873
+ interface CreateTicketDefinitionOptions {
874
+ /** Ticket definition data. */
875
+ definition: TicketDefinitionData;
876
+ }
877
+ interface UpdateTicketDefinitionOptions {
878
+ /** Ticket definition data. */
879
+ definition?: TicketDefinitionData;
880
+ /** Set of field paths, specifying which parts of ticket definition to update. */
881
+ fields?: string[];
882
+ }
883
+ interface DeleteTicketDefinitionOptions extends DeleteTicketDefinitionOptionsDeleteOneOf {
884
+ /** Ticket definitions to delete. */
885
+ byId?: ById;
886
+ /** Whether to delete all event tickets. */
887
+ all?: boolean;
888
+ }
889
+ /** @oneof */
890
+ interface DeleteTicketDefinitionOptionsDeleteOneOf {
891
+ /** Ticket definitions to delete. */
892
+ byId?: ById;
893
+ /** Whether to delete all event tickets. */
894
+ all?: boolean;
895
+ }
896
+ interface ChangeCurrencyOptions {
897
+ /**
898
+ * Event ID.
899
+ * @format GUID
900
+ */
901
+ eventId?: string;
902
+ /**
903
+ * Event currency, in 3-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
904
+ * @minLength 3
905
+ * @maxLength 3
906
+ */
907
+ currency: string;
908
+ }
909
+
910
+ export { type UpdateTicketDefinitionRequest as $, type QueryV2PagingMethodOneOf as A, type Sorting as B, type CreateTicketDefinitionOptions as C, type DefinitionsQueryBuilder as D, type Paging as E, FeeType as F, type GetTicketDefinitionOptions as G, type CursorPaging as H, type QueryTicketDefinitionsV2Response as I, type PagingMetadataV2 as J, type Cursors as K, type ListTicketDefinitionsOptions as L, type Money as M, type ListTicketDefinitionsRequest as N, type GetTicketDefinitionRequest as O, type PricingOptions as P, type QueryTicketDefinitionsOptions as Q, type ResponseMetaData as R, SortOrder as S, type TicketDefinition as T, type UpdateTicketDefinitionOptions as U, type GetTicketDefinitionResponse as V, WebhookIdentityType as W, type CreateTicketDefinitionRequest as X, type TicketDefinitionData as Y, type TicketDefinitionCreated as Z, type OriginatedFrom as _, type QueryTicketDefinitionsResponse as a, type TicketDefinitionUpdated as a0, type DeleteTicketDefinitionRequest as a1, type DeleteTicketDefinitionRequestDeleteOneOf as a2, type ById as a3, type DeleteTicketDefinitionResponse as a4, type TicketDefinitionDeleted as a5, type ChangeCurrencyRequest as a6, type ChangeCurrencyResponse as a7, type BulkCopyTicketDefinitionsByEventIdRequest as a8, type BulkCopyTicketDefinitionsByEventIdResponse as a9, type CopiedTicketDefinition as aa, type PaidTicketDefinitionExistsRequest as ab, type PaidTicketDefinitionExistsResponse as ac, type MessageEnvelope as ad, type IdentificationData as ae, type IdentificationDataIdOneOf as af, type BaseEventMetadata as ag, type DefinitionsQueryResult as ah, type DeleteTicketDefinitionOptionsDeleteOneOf as ai, type QueryTicketDefinitionsV2Options as b, type ListTicketDefinitionsResponse as c, type CreateTicketDefinitionResponse as d, type UpdateTicketDefinitionResponse as e, type DeleteTicketDefinitionOptions as f, type ChangeCurrencyOptions as g, type TicketDefinitionCreatedEnvelope as h, type TicketDefinitionDeletedEnvelope as i, type TicketDefinitionUpdatedEnvelope as j, TicketSaleStatus as k, TicketDefinitionStateEnumState as l, Type as m, TicketDefinitionFieldset as n, State as o, GroupBy as p, type Dashboard as q, type WixFeeConfig as r, type TicketSalePeriod as s, type TicketPricing as t, type TicketPricingPriceOneOf as u, type PricingOption as v, type QueryTicketDefinitionsRequest as w, type FacetCounts as x, type QueryTicketDefinitionsV2Request as y, type QueryV2 as z };