@wix/auto_sdk_events_ticket-definitions 1.0.8 → 1.0.10
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.
- package/build/cjs/index.d.ts +1 -0
- package/build/cjs/index.js +18 -0
- package/build/cjs/index.js.map +1 -0
- package/build/cjs/index.typings.d.ts +1 -0
- package/build/cjs/index.typings.js +18 -0
- package/build/cjs/index.typings.js.map +1 -0
- package/build/cjs/meta.d.ts +1 -0
- package/build/cjs/meta.js +18 -0
- package/build/cjs/meta.js.map +1 -0
- package/build/cjs/src/events-v1-ticket-definition-ticket-definitions.context.d.ts +22 -0
- package/build/cjs/src/events-v1-ticket-definition-ticket-definitions.context.js +34 -0
- package/build/cjs/src/events-v1-ticket-definition-ticket-definitions.context.js.map +1 -0
- package/build/cjs/src/events-v1-ticket-definition-ticket-definitions.http.d.ts +132 -0
- package/build/cjs/src/events-v1-ticket-definition-ticket-definitions.http.js +703 -0
- package/build/cjs/src/events-v1-ticket-definition-ticket-definitions.http.js.map +1 -0
- package/build/cjs/src/events-v1-ticket-definition-ticket-definitions.meta.d.ts +24 -0
- package/build/cjs/src/events-v1-ticket-definition-ticket-definitions.meta.js +180 -0
- package/build/cjs/src/events-v1-ticket-definition-ticket-definitions.meta.js.map +1 -0
- package/build/{internal/index.d.ts → cjs/src/events-v1-ticket-definition-ticket-definitions.public.d.ts} +17 -30
- package/build/cjs/src/events-v1-ticket-definition-ticket-definitions.public.js +86 -0
- package/build/cjs/src/events-v1-ticket-definition-ticket-definitions.public.js.map +1 -0
- package/build/{meta.d.mts → cjs/src/events-v1-ticket-definition-ticket-definitions.types.d.ts} +214 -72
- package/build/cjs/src/events-v1-ticket-definition-ticket-definitions.types.js +71 -0
- package/build/cjs/src/events-v1-ticket-definition-ticket-definitions.types.js.map +1 -0
- package/build/{events-v1-ticket-definition-ticket-definitions.universal-DjrTBlvE.d.mts → cjs/src/events-v1-ticket-definition-ticket-definitions.universal.d.ts} +379 -75
- package/build/cjs/src/events-v1-ticket-definition-ticket-definitions.universal.js +609 -0
- package/build/cjs/src/events-v1-ticket-definition-ticket-definitions.universal.js.map +1 -0
- package/build/es/index.d.ts +1 -0
- package/build/es/index.js +2 -0
- package/build/es/index.js.map +1 -0
- package/build/es/index.typings.d.ts +1 -0
- package/build/es/index.typings.js +2 -0
- package/build/es/index.typings.js.map +1 -0
- package/build/es/meta.d.ts +1 -0
- package/build/es/meta.js +2 -0
- package/build/es/meta.js.map +1 -0
- package/build/es/src/events-v1-ticket-definition-ticket-definitions.context.d.ts +22 -0
- package/build/es/src/events-v1-ticket-definition-ticket-definitions.context.js +22 -0
- package/build/es/src/events-v1-ticket-definition-ticket-definitions.context.js.map +1 -0
- package/build/es/src/events-v1-ticket-definition-ticket-definitions.http.d.ts +132 -0
- package/build/es/src/events-v1-ticket-definition-ticket-definitions.http.js +692 -0
- package/build/es/src/events-v1-ticket-definition-ticket-definitions.http.js.map +1 -0
- package/build/es/src/events-v1-ticket-definition-ticket-definitions.meta.d.ts +24 -0
- package/build/es/src/events-v1-ticket-definition-ticket-definitions.meta.js +146 -0
- package/build/es/src/events-v1-ticket-definition-ticket-definitions.meta.js.map +1 -0
- package/build/{index.d.ts → es/src/events-v1-ticket-definition-ticket-definitions.public.d.ts} +17 -30
- package/build/es/src/events-v1-ticket-definition-ticket-definitions.public.js +66 -0
- package/build/es/src/events-v1-ticket-definition-ticket-definitions.public.js.map +1 -0
- package/build/{meta.d.ts → es/src/events-v1-ticket-definition-ticket-definitions.types.d.ts} +214 -72
- package/build/es/src/events-v1-ticket-definition-ticket-definitions.types.js +68 -0
- package/build/es/src/events-v1-ticket-definition-ticket-definitions.types.js.map +1 -0
- package/build/{events-v1-ticket-definition-ticket-definitions.universal-DjrTBlvE.d.ts → es/src/events-v1-ticket-definition-ticket-definitions.universal.d.ts} +379 -75
- package/build/es/src/events-v1-ticket-definition-ticket-definitions.universal.js +575 -0
- package/build/es/src/events-v1-ticket-definition-ticket-definitions.universal.js.map +1 -0
- package/build/internal/cjs/index.d.ts +1 -0
- package/build/internal/cjs/index.js +18 -0
- package/build/internal/cjs/index.js.map +1 -0
- package/build/internal/cjs/index.typings.d.ts +1 -0
- package/build/internal/cjs/index.typings.js +18 -0
- package/build/internal/cjs/index.typings.js.map +1 -0
- package/build/internal/cjs/meta.d.ts +1 -0
- package/build/internal/cjs/meta.js +18 -0
- package/build/internal/cjs/meta.js.map +1 -0
- package/build/internal/cjs/src/events-v1-ticket-definition-ticket-definitions.context.d.ts +22 -0
- package/build/internal/cjs/src/events-v1-ticket-definition-ticket-definitions.context.js +34 -0
- package/build/internal/cjs/src/events-v1-ticket-definition-ticket-definitions.context.js.map +1 -0
- package/build/internal/cjs/src/events-v1-ticket-definition-ticket-definitions.http.d.ts +132 -0
- package/build/internal/cjs/src/events-v1-ticket-definition-ticket-definitions.http.js +703 -0
- package/build/internal/cjs/src/events-v1-ticket-definition-ticket-definitions.http.js.map +1 -0
- package/build/internal/cjs/src/events-v1-ticket-definition-ticket-definitions.meta.d.ts +24 -0
- package/build/internal/cjs/src/events-v1-ticket-definition-ticket-definitions.meta.js +180 -0
- package/build/internal/cjs/src/events-v1-ticket-definition-ticket-definitions.meta.js.map +1 -0
- package/build/internal/{index.d.mts → cjs/src/events-v1-ticket-definition-ticket-definitions.public.d.ts} +17 -30
- package/build/internal/cjs/src/events-v1-ticket-definition-ticket-definitions.public.js +86 -0
- package/build/internal/cjs/src/events-v1-ticket-definition-ticket-definitions.public.js.map +1 -0
- package/build/internal/{meta.d.mts → cjs/src/events-v1-ticket-definition-ticket-definitions.types.d.ts} +214 -72
- package/build/internal/cjs/src/events-v1-ticket-definition-ticket-definitions.types.js +71 -0
- package/build/internal/cjs/src/events-v1-ticket-definition-ticket-definitions.types.js.map +1 -0
- package/build/internal/{events-v1-ticket-definition-ticket-definitions.universal-I_qGL_cH.d.ts → cjs/src/events-v1-ticket-definition-ticket-definitions.universal.d.ts} +379 -75
- package/build/internal/cjs/src/events-v1-ticket-definition-ticket-definitions.universal.js +609 -0
- package/build/internal/cjs/src/events-v1-ticket-definition-ticket-definitions.universal.js.map +1 -0
- package/build/internal/es/index.d.ts +1 -0
- package/build/internal/es/index.js +2 -0
- package/build/internal/es/index.js.map +1 -0
- package/build/internal/es/index.typings.d.ts +1 -0
- package/build/internal/es/index.typings.js +2 -0
- package/build/internal/es/index.typings.js.map +1 -0
- package/build/internal/es/meta.d.ts +1 -0
- package/build/internal/es/meta.js +2 -0
- package/build/internal/es/meta.js.map +1 -0
- package/build/internal/es/src/events-v1-ticket-definition-ticket-definitions.context.d.ts +22 -0
- package/build/internal/es/src/events-v1-ticket-definition-ticket-definitions.context.js +22 -0
- package/build/internal/es/src/events-v1-ticket-definition-ticket-definitions.context.js.map +1 -0
- package/build/internal/es/src/events-v1-ticket-definition-ticket-definitions.http.d.ts +132 -0
- package/build/internal/es/src/events-v1-ticket-definition-ticket-definitions.http.js +692 -0
- package/build/internal/es/src/events-v1-ticket-definition-ticket-definitions.http.js.map +1 -0
- package/build/internal/es/src/events-v1-ticket-definition-ticket-definitions.meta.d.ts +24 -0
- package/build/internal/es/src/events-v1-ticket-definition-ticket-definitions.meta.js +146 -0
- package/build/internal/es/src/events-v1-ticket-definition-ticket-definitions.meta.js.map +1 -0
- package/build/{index.d.mts → internal/es/src/events-v1-ticket-definition-ticket-definitions.public.d.ts} +17 -30
- package/build/internal/es/src/events-v1-ticket-definition-ticket-definitions.public.js +66 -0
- package/build/internal/es/src/events-v1-ticket-definition-ticket-definitions.public.js.map +1 -0
- package/build/internal/{meta.d.ts → es/src/events-v1-ticket-definition-ticket-definitions.types.d.ts} +214 -72
- package/build/internal/es/src/events-v1-ticket-definition-ticket-definitions.types.js +68 -0
- package/build/internal/es/src/events-v1-ticket-definition-ticket-definitions.types.js.map +1 -0
- package/build/internal/{events-v1-ticket-definition-ticket-definitions.universal-I_qGL_cH.d.mts → es/src/events-v1-ticket-definition-ticket-definitions.universal.d.ts} +379 -75
- package/build/internal/es/src/events-v1-ticket-definition-ticket-definitions.universal.js +575 -0
- package/build/internal/es/src/events-v1-ticket-definition-ticket-definitions.universal.js.map +1 -0
- package/package.json +11 -12
- package/build/index.js +0 -1092
- package/build/index.js.map +0 -1
- package/build/index.mjs +0 -1049
- package/build/index.mjs.map +0 -1
- package/build/internal/index.js +0 -1092
- package/build/internal/index.js.map +0 -1
- package/build/internal/index.mjs +0 -1049
- package/build/internal/index.mjs.map +0 -1
- package/build/internal/meta.js +0 -760
- package/build/internal/meta.js.map +0 -1
- package/build/internal/meta.mjs +0 -726
- package/build/internal/meta.mjs.map +0 -1
- package/build/meta.js +0 -760
- package/build/meta.js.map +0 -1
- package/build/meta.mjs +0 -726
- package/build/meta.mjs.map +0 -1
|
@@ -1,4 +1,5 @@
|
|
|
1
|
-
|
|
1
|
+
import { NonNullablePaths } from '@wix/sdk-types';
|
|
2
|
+
export interface TicketDefinition {
|
|
2
3
|
/**
|
|
3
4
|
* Ticket definition ID.
|
|
4
5
|
* @format GUID
|
|
@@ -46,7 +47,7 @@ interface TicketDefinition {
|
|
|
46
47
|
/** Ticket pricing. */
|
|
47
48
|
pricing?: TicketPricing;
|
|
48
49
|
}
|
|
49
|
-
interface Money {
|
|
50
|
+
export interface Money {
|
|
50
51
|
/**
|
|
51
52
|
* @internal
|
|
52
53
|
* @internal
|
|
@@ -66,7 +67,7 @@ interface Money {
|
|
|
66
67
|
*/
|
|
67
68
|
value?: string | null;
|
|
68
69
|
}
|
|
69
|
-
interface Dashboard {
|
|
70
|
+
export interface Dashboard {
|
|
70
71
|
/** Whether ticket is hidden and cannot be sold. */
|
|
71
72
|
hidden?: boolean;
|
|
72
73
|
/**
|
|
@@ -85,7 +86,7 @@ interface Dashboard {
|
|
|
85
86
|
/** Number of tickets reserved. */
|
|
86
87
|
ticketsReserved?: number;
|
|
87
88
|
}
|
|
88
|
-
interface WixFeeConfig {
|
|
89
|
+
export interface WixFeeConfig {
|
|
89
90
|
/**
|
|
90
91
|
* Fee calculation method.
|
|
91
92
|
*
|
|
@@ -95,7 +96,7 @@ interface WixFeeConfig {
|
|
|
95
96
|
*/
|
|
96
97
|
type?: FeeType;
|
|
97
98
|
}
|
|
98
|
-
declare enum FeeType {
|
|
99
|
+
export declare enum FeeType {
|
|
99
100
|
/** Fee is added to the ticket price at checkout. */
|
|
100
101
|
FEE_ADDED = "FEE_ADDED",
|
|
101
102
|
/** Seller absorbs the fee. It is deducted from the ticket price. */
|
|
@@ -103,7 +104,7 @@ declare enum FeeType {
|
|
|
103
104
|
/** Fee is added to the ticket price at checkout. */
|
|
104
105
|
FEE_ADDED_AT_CHECKOUT = "FEE_ADDED_AT_CHECKOUT"
|
|
105
106
|
}
|
|
106
|
-
interface TicketSalePeriod {
|
|
107
|
+
export interface TicketSalePeriod {
|
|
107
108
|
/** Ticket sale start timestamp. */
|
|
108
109
|
startDate?: Date | null;
|
|
109
110
|
/** Ticket sale end timestamp. */
|
|
@@ -111,7 +112,7 @@ interface TicketSalePeriod {
|
|
|
111
112
|
/** Whether to hide this ticket if it's not on sale */
|
|
112
113
|
hideNotOnSale?: boolean;
|
|
113
114
|
}
|
|
114
|
-
declare enum TicketSaleStatus {
|
|
115
|
+
export declare enum TicketSaleStatus {
|
|
115
116
|
/** Ticket sale is scheduled to start. */
|
|
116
117
|
SALE_SCHEDULED = "SALE_SCHEDULED",
|
|
117
118
|
/** Ticket sale has started. */
|
|
@@ -119,10 +120,10 @@ declare enum TicketSaleStatus {
|
|
|
119
120
|
/** Ticket sale has ended. */
|
|
120
121
|
SALE_ENDED = "SALE_ENDED"
|
|
121
122
|
}
|
|
122
|
-
declare enum TicketDefinitionStateEnumState {
|
|
123
|
+
export declare enum TicketDefinitionStateEnumState {
|
|
123
124
|
INCLUDE_HIDDEN_NOT_ON_SALE = "INCLUDE_HIDDEN_NOT_ON_SALE"
|
|
124
125
|
}
|
|
125
|
-
interface TicketPricing extends TicketPricingPriceOneOf {
|
|
126
|
+
export interface TicketPricing extends TicketPricingPriceOneOf {
|
|
126
127
|
/** Ticket price which is read only. */
|
|
127
128
|
fixedPrice?: Money;
|
|
128
129
|
/** Min price per ticket, customizable. */
|
|
@@ -136,7 +137,7 @@ interface TicketPricing extends TicketPricingPriceOneOf {
|
|
|
136
137
|
pricingType?: Type;
|
|
137
138
|
}
|
|
138
139
|
/** @oneof */
|
|
139
|
-
interface TicketPricingPriceOneOf {
|
|
140
|
+
export interface TicketPricingPriceOneOf {
|
|
140
141
|
/** Ticket price which is read only. */
|
|
141
142
|
fixedPrice?: Money;
|
|
142
143
|
/** Min price per ticket, customizable. */
|
|
@@ -144,11 +145,11 @@ interface TicketPricingPriceOneOf {
|
|
|
144
145
|
/** Ticket pricing options. */
|
|
145
146
|
pricingOptions?: PricingOptions;
|
|
146
147
|
}
|
|
147
|
-
interface PricingOptions {
|
|
148
|
+
export interface PricingOptions {
|
|
148
149
|
/** Multiple ticket pricing options. */
|
|
149
150
|
options?: PricingOption[];
|
|
150
151
|
}
|
|
151
|
-
interface PricingOption {
|
|
152
|
+
export interface PricingOption {
|
|
152
153
|
/**
|
|
153
154
|
* Ticket pricing option ID.
|
|
154
155
|
* @format GUID
|
|
@@ -163,11 +164,11 @@ interface PricingOption {
|
|
|
163
164
|
/** Ticket pricing option price. */
|
|
164
165
|
price?: Money;
|
|
165
166
|
}
|
|
166
|
-
declare enum Type {
|
|
167
|
+
export declare enum Type {
|
|
167
168
|
STANDARD = "STANDARD",
|
|
168
169
|
DONATION = "DONATION"
|
|
169
170
|
}
|
|
170
|
-
interface QueryTicketDefinitionsRequest {
|
|
171
|
+
export interface QueryTicketDefinitionsRequest {
|
|
171
172
|
/** Offset. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */
|
|
172
173
|
offset?: number;
|
|
173
174
|
/**
|
|
@@ -196,13 +197,13 @@ interface QueryTicketDefinitionsRequest {
|
|
|
196
197
|
*/
|
|
197
198
|
facet?: string[];
|
|
198
199
|
}
|
|
199
|
-
declare enum TicketDefinitionFieldset {
|
|
200
|
+
export declare enum TicketDefinitionFieldset {
|
|
200
201
|
/** Include `policy` in the response. */
|
|
201
202
|
POLICY = "POLICY",
|
|
202
203
|
/** Include `dashboard` in the response. */
|
|
203
204
|
DASHBOARD = "DASHBOARD"
|
|
204
205
|
}
|
|
205
|
-
interface QueryTicketDefinitionsResponse {
|
|
206
|
+
export interface QueryTicketDefinitionsResponse {
|
|
206
207
|
/** Total ticket definitions matching the given filters. */
|
|
207
208
|
total?: number;
|
|
208
209
|
/** Offset. */
|
|
@@ -217,15 +218,15 @@ interface QueryTicketDefinitionsResponse {
|
|
|
217
218
|
/** Filter facets. */
|
|
218
219
|
facets?: Record<string, FacetCounts>;
|
|
219
220
|
}
|
|
220
|
-
interface FacetCounts {
|
|
221
|
+
export interface FacetCounts {
|
|
221
222
|
/** Facet counts aggregated per value. */
|
|
222
223
|
counts?: Record<string, number>;
|
|
223
224
|
}
|
|
224
|
-
interface QueryTicketDefinitionsV2Request {
|
|
225
|
+
export interface QueryTicketDefinitionsV2Request {
|
|
225
226
|
/** Query request object. */
|
|
226
227
|
query?: QueryV2;
|
|
227
228
|
}
|
|
228
|
-
interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
229
|
+
export interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
229
230
|
/** Paging options to limit and skip the number of items. */
|
|
230
231
|
paging?: Paging;
|
|
231
232
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
@@ -248,13 +249,13 @@ interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
|
248
249
|
fieldsets?: string[];
|
|
249
250
|
}
|
|
250
251
|
/** @oneof */
|
|
251
|
-
interface QueryV2PagingMethodOneOf {
|
|
252
|
+
export interface QueryV2PagingMethodOneOf {
|
|
252
253
|
/** Paging options to limit and skip the number of items. */
|
|
253
254
|
paging?: Paging;
|
|
254
255
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
255
256
|
cursorPaging?: CursorPaging;
|
|
256
257
|
}
|
|
257
|
-
interface Sorting {
|
|
258
|
+
export interface Sorting {
|
|
258
259
|
/**
|
|
259
260
|
* Name of the field to sort by.
|
|
260
261
|
* @maxLength 512
|
|
@@ -263,17 +264,17 @@ interface Sorting {
|
|
|
263
264
|
/** Sort order. */
|
|
264
265
|
order?: SortOrder;
|
|
265
266
|
}
|
|
266
|
-
declare enum SortOrder {
|
|
267
|
+
export declare enum SortOrder {
|
|
267
268
|
ASC = "ASC",
|
|
268
269
|
DESC = "DESC"
|
|
269
270
|
}
|
|
270
|
-
interface Paging {
|
|
271
|
+
export interface Paging {
|
|
271
272
|
/** Number of items to load. */
|
|
272
273
|
limit?: number | null;
|
|
273
274
|
/** Number of items to skip in the current sort order. */
|
|
274
275
|
offset?: number | null;
|
|
275
276
|
}
|
|
276
|
-
interface CursorPaging {
|
|
277
|
+
export interface CursorPaging {
|
|
277
278
|
/**
|
|
278
279
|
* Maximum number of items to return in the results.
|
|
279
280
|
* @max 100
|
|
@@ -288,13 +289,13 @@ interface CursorPaging {
|
|
|
288
289
|
*/
|
|
289
290
|
cursor?: string | null;
|
|
290
291
|
}
|
|
291
|
-
interface QueryTicketDefinitionsV2Response {
|
|
292
|
+
export interface QueryTicketDefinitionsV2Response {
|
|
292
293
|
/** Ticket definitions. */
|
|
293
294
|
definitions?: TicketDefinition[];
|
|
294
295
|
/** Paging metadata definitions. */
|
|
295
296
|
metadata?: PagingMetadataV2;
|
|
296
297
|
}
|
|
297
|
-
interface PagingMetadataV2 {
|
|
298
|
+
export interface PagingMetadataV2 {
|
|
298
299
|
/** Number of items returned in the response. */
|
|
299
300
|
count?: number | null;
|
|
300
301
|
/** Offset that was requested. */
|
|
@@ -306,7 +307,7 @@ interface PagingMetadataV2 {
|
|
|
306
307
|
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
307
308
|
cursors?: Cursors;
|
|
308
309
|
}
|
|
309
|
-
interface Cursors {
|
|
310
|
+
export interface Cursors {
|
|
310
311
|
/**
|
|
311
312
|
* Cursor string pointing to the next page in the list of results.
|
|
312
313
|
* @maxLength 16000
|
|
@@ -318,7 +319,7 @@ interface Cursors {
|
|
|
318
319
|
*/
|
|
319
320
|
prev?: string | null;
|
|
320
321
|
}
|
|
321
|
-
interface ListTicketDefinitionsRequest {
|
|
322
|
+
export interface ListTicketDefinitionsRequest {
|
|
322
323
|
/**
|
|
323
324
|
* Event ID.
|
|
324
325
|
* @format GUID
|
|
@@ -376,7 +377,7 @@ interface ListTicketDefinitionsRequest {
|
|
|
376
377
|
*/
|
|
377
378
|
facet?: string[];
|
|
378
379
|
}
|
|
379
|
-
declare enum State {
|
|
380
|
+
export declare enum State {
|
|
380
381
|
/** The ticket is available for purchase. */
|
|
381
382
|
VISIBLE = "VISIBLE",
|
|
382
383
|
/** The ticket is unavailable for purchase. */
|
|
@@ -386,7 +387,7 @@ declare enum State {
|
|
|
386
387
|
/** The ticket price is greater than 0. */
|
|
387
388
|
PAID = "PAID"
|
|
388
389
|
}
|
|
389
|
-
declare enum GroupBy {
|
|
390
|
+
export declare enum GroupBy {
|
|
390
391
|
/** No grouping. */
|
|
391
392
|
NONE = "NONE",
|
|
392
393
|
/** Groups by event created date with descending sorting. */
|
|
@@ -394,7 +395,7 @@ declare enum GroupBy {
|
|
|
394
395
|
/** Groups by event created date with ascending sorting. */
|
|
395
396
|
EVENT_CREATED_ASC = "EVENT_CREATED_ASC"
|
|
396
397
|
}
|
|
397
|
-
interface ListTicketDefinitionsResponse {
|
|
398
|
+
export interface ListTicketDefinitionsResponse {
|
|
398
399
|
/** Meta data. */
|
|
399
400
|
metaData?: ResponseMetaData;
|
|
400
401
|
/** Retrieved ticket definitions. */
|
|
@@ -402,7 +403,7 @@ interface ListTicketDefinitionsResponse {
|
|
|
402
403
|
/** Filter facets. */
|
|
403
404
|
facets?: Record<string, FacetCounts>;
|
|
404
405
|
}
|
|
405
|
-
interface ResponseMetaData {
|
|
406
|
+
export interface ResponseMetaData {
|
|
406
407
|
/** Number of items in the response. */
|
|
407
408
|
count?: number;
|
|
408
409
|
/** Offset of items. */
|
|
@@ -410,7 +411,7 @@ interface ResponseMetaData {
|
|
|
410
411
|
/** Total number of matching items. */
|
|
411
412
|
total?: number;
|
|
412
413
|
}
|
|
413
|
-
interface GetTicketDefinitionRequest {
|
|
414
|
+
export interface GetTicketDefinitionRequest {
|
|
414
415
|
/**
|
|
415
416
|
* Ticket definition ID.
|
|
416
417
|
* @format GUID
|
|
@@ -426,11 +427,11 @@ interface GetTicketDefinitionRequest {
|
|
|
426
427
|
*/
|
|
427
428
|
fieldset?: TicketDefinitionFieldset[];
|
|
428
429
|
}
|
|
429
|
-
interface GetTicketDefinitionResponse {
|
|
430
|
+
export interface GetTicketDefinitionResponse {
|
|
430
431
|
/** Retrieved ticket definition. */
|
|
431
432
|
definition?: TicketDefinition;
|
|
432
433
|
}
|
|
433
|
-
interface CreateTicketDefinitionRequest {
|
|
434
|
+
export interface CreateTicketDefinitionRequest {
|
|
434
435
|
/**
|
|
435
436
|
* Event ID.
|
|
436
437
|
* @format GUID
|
|
@@ -439,7 +440,7 @@ interface CreateTicketDefinitionRequest {
|
|
|
439
440
|
/** Ticket definition data. */
|
|
440
441
|
definition: TicketDefinitionData;
|
|
441
442
|
}
|
|
442
|
-
interface TicketDefinitionData {
|
|
443
|
+
export interface TicketDefinitionData {
|
|
443
444
|
/**
|
|
444
445
|
* Ticket name.
|
|
445
446
|
* @maxLength 30
|
|
@@ -476,11 +477,11 @@ interface TicketDefinitionData {
|
|
|
476
477
|
/** Ticket pricing. */
|
|
477
478
|
pricing?: TicketPricing;
|
|
478
479
|
}
|
|
479
|
-
interface CreateTicketDefinitionResponse {
|
|
480
|
+
export interface CreateTicketDefinitionResponse {
|
|
480
481
|
/** Created ticket definition. */
|
|
481
482
|
definition?: TicketDefinition;
|
|
482
483
|
}
|
|
483
|
-
interface TicketDefinitionCreated {
|
|
484
|
+
export interface TicketDefinitionCreated {
|
|
484
485
|
/** Ticket Definition created timestamp in ISO UTC format. */
|
|
485
486
|
timestamp?: Date | null;
|
|
486
487
|
/**
|
|
@@ -496,7 +497,7 @@ interface TicketDefinitionCreated {
|
|
|
496
497
|
/** Originated from. */
|
|
497
498
|
originatedFrom?: OriginatedFrom;
|
|
498
499
|
}
|
|
499
|
-
interface OriginatedFrom {
|
|
500
|
+
export interface OriginatedFrom {
|
|
500
501
|
/**
|
|
501
502
|
* Instance ID. Indicates the original app instance which current entity originated from.
|
|
502
503
|
* @format GUID
|
|
@@ -513,7 +514,7 @@ interface OriginatedFrom {
|
|
|
513
514
|
*/
|
|
514
515
|
entityId?: string;
|
|
515
516
|
}
|
|
516
|
-
interface UpdateTicketDefinitionRequest {
|
|
517
|
+
export interface UpdateTicketDefinitionRequest {
|
|
517
518
|
/**
|
|
518
519
|
* Event ID.
|
|
519
520
|
* @format GUID
|
|
@@ -529,11 +530,11 @@ interface UpdateTicketDefinitionRequest {
|
|
|
529
530
|
/** Set of field paths, specifying which parts of ticket definition to update. */
|
|
530
531
|
fields?: string[];
|
|
531
532
|
}
|
|
532
|
-
interface UpdateTicketDefinitionResponse {
|
|
533
|
+
export interface UpdateTicketDefinitionResponse {
|
|
533
534
|
/** Updated ticket definition. */
|
|
534
535
|
definition?: TicketDefinition;
|
|
535
536
|
}
|
|
536
|
-
interface TicketDefinitionUpdated {
|
|
537
|
+
export interface TicketDefinitionUpdated {
|
|
537
538
|
/** Ticket definition updated timestamp in ISO UTC format. */
|
|
538
539
|
timestamp?: Date | null;
|
|
539
540
|
/**
|
|
@@ -547,7 +548,7 @@ interface TicketDefinitionUpdated {
|
|
|
547
548
|
*/
|
|
548
549
|
eventId?: string;
|
|
549
550
|
}
|
|
550
|
-
interface DeleteTicketDefinitionRequest extends DeleteTicketDefinitionRequestDeleteOneOf {
|
|
551
|
+
export interface DeleteTicketDefinitionRequest extends DeleteTicketDefinitionRequestDeleteOneOf {
|
|
551
552
|
/** Ticket definitions to delete. */
|
|
552
553
|
byId?: ById;
|
|
553
554
|
/** Whether to delete all event tickets. */
|
|
@@ -559,13 +560,13 @@ interface DeleteTicketDefinitionRequest extends DeleteTicketDefinitionRequestDel
|
|
|
559
560
|
eventId: string;
|
|
560
561
|
}
|
|
561
562
|
/** @oneof */
|
|
562
|
-
interface DeleteTicketDefinitionRequestDeleteOneOf {
|
|
563
|
+
export interface DeleteTicketDefinitionRequestDeleteOneOf {
|
|
563
564
|
/** Ticket definitions to delete. */
|
|
564
565
|
byId?: ById;
|
|
565
566
|
/** Whether to delete all event tickets. */
|
|
566
567
|
all?: boolean;
|
|
567
568
|
}
|
|
568
|
-
interface ById {
|
|
569
|
+
export interface ById {
|
|
569
570
|
/**
|
|
570
571
|
* Ticket definition IDs.
|
|
571
572
|
* @format GUID
|
|
@@ -574,9 +575,9 @@ interface ById {
|
|
|
574
575
|
*/
|
|
575
576
|
definitionId?: string[];
|
|
576
577
|
}
|
|
577
|
-
interface DeleteTicketDefinitionResponse {
|
|
578
|
+
export interface DeleteTicketDefinitionResponse {
|
|
578
579
|
}
|
|
579
|
-
interface TicketDefinitionDeleted {
|
|
580
|
+
export interface TicketDefinitionDeleted {
|
|
580
581
|
/** Ticket definition deleted timestamp in ISO UTC format. */
|
|
581
582
|
timestamp?: Date | null;
|
|
582
583
|
/**
|
|
@@ -590,7 +591,7 @@ interface TicketDefinitionDeleted {
|
|
|
590
591
|
*/
|
|
591
592
|
eventId?: string;
|
|
592
593
|
}
|
|
593
|
-
interface ChangeCurrencyRequest {
|
|
594
|
+
export interface ChangeCurrencyRequest {
|
|
594
595
|
/**
|
|
595
596
|
* Event ID.
|
|
596
597
|
* @format GUID
|
|
@@ -603,9 +604,9 @@ interface ChangeCurrencyRequest {
|
|
|
603
604
|
*/
|
|
604
605
|
currency: string;
|
|
605
606
|
}
|
|
606
|
-
interface ChangeCurrencyResponse {
|
|
607
|
+
export interface ChangeCurrencyResponse {
|
|
607
608
|
}
|
|
608
|
-
interface BulkCopyTicketDefinitionsByEventIdRequest {
|
|
609
|
+
export interface BulkCopyTicketDefinitionsByEventIdRequest {
|
|
609
610
|
/** Origin instance ID. */
|
|
610
611
|
originInstanceId?: string | null;
|
|
611
612
|
/**
|
|
@@ -619,23 +620,23 @@ interface BulkCopyTicketDefinitionsByEventIdRequest {
|
|
|
619
620
|
*/
|
|
620
621
|
targetEventId?: string;
|
|
621
622
|
}
|
|
622
|
-
interface BulkCopyTicketDefinitionsByEventIdResponse {
|
|
623
|
+
export interface BulkCopyTicketDefinitionsByEventIdResponse {
|
|
623
624
|
/** Copied ticket definitions. */
|
|
624
625
|
definitions?: CopiedTicketDefinition[];
|
|
625
626
|
}
|
|
626
|
-
interface CopiedTicketDefinition {
|
|
627
|
+
export interface CopiedTicketDefinition {
|
|
627
628
|
/** Origin Ticket definition ID. */
|
|
628
629
|
originTicketDefinitionId?: string;
|
|
629
630
|
/** Ticket definition ID. */
|
|
630
631
|
ticketDefinitionId?: string;
|
|
631
632
|
}
|
|
632
|
-
interface PaidTicketDefinitionExistsRequest {
|
|
633
|
+
export interface PaidTicketDefinitionExistsRequest {
|
|
633
634
|
}
|
|
634
|
-
interface PaidTicketDefinitionExistsResponse {
|
|
635
|
+
export interface PaidTicketDefinitionExistsResponse {
|
|
635
636
|
/** Paid exists. */
|
|
636
637
|
paidExists?: boolean;
|
|
637
638
|
}
|
|
638
|
-
interface MessageEnvelope {
|
|
639
|
+
export interface MessageEnvelope {
|
|
639
640
|
/**
|
|
640
641
|
* App instance ID.
|
|
641
642
|
* @format GUID
|
|
@@ -651,7 +652,7 @@ interface MessageEnvelope {
|
|
|
651
652
|
/** Stringify payload. */
|
|
652
653
|
data?: string;
|
|
653
654
|
}
|
|
654
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
655
|
+
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
655
656
|
/**
|
|
656
657
|
* ID of a site visitor that has not logged in to the site.
|
|
657
658
|
* @format GUID
|
|
@@ -676,7 +677,7 @@ interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
676
677
|
identityType?: WebhookIdentityType;
|
|
677
678
|
}
|
|
678
679
|
/** @oneof */
|
|
679
|
-
interface IdentificationDataIdOneOf {
|
|
680
|
+
export interface IdentificationDataIdOneOf {
|
|
680
681
|
/**
|
|
681
682
|
* ID of a site visitor that has not logged in to the site.
|
|
682
683
|
* @format GUID
|
|
@@ -698,14 +699,14 @@ interface IdentificationDataIdOneOf {
|
|
|
698
699
|
*/
|
|
699
700
|
appId?: string;
|
|
700
701
|
}
|
|
701
|
-
declare enum WebhookIdentityType {
|
|
702
|
+
export declare enum WebhookIdentityType {
|
|
702
703
|
UNKNOWN = "UNKNOWN",
|
|
703
704
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
704
705
|
MEMBER = "MEMBER",
|
|
705
706
|
WIX_USER = "WIX_USER",
|
|
706
707
|
APP = "APP"
|
|
707
708
|
}
|
|
708
|
-
interface BaseEventMetadata {
|
|
709
|
+
export interface BaseEventMetadata {
|
|
709
710
|
/**
|
|
710
711
|
* App instance ID.
|
|
711
712
|
* @format GUID
|
|
@@ -719,19 +720,96 @@ interface BaseEventMetadata {
|
|
|
719
720
|
/** The identification type and identity data. */
|
|
720
721
|
identity?: IdentificationData;
|
|
721
722
|
}
|
|
722
|
-
interface TicketDefinitionCreatedEnvelope {
|
|
723
|
+
export interface TicketDefinitionCreatedEnvelope {
|
|
723
724
|
data: TicketDefinitionCreated;
|
|
724
725
|
metadata: BaseEventMetadata;
|
|
725
726
|
}
|
|
726
|
-
|
|
727
|
+
/** @permissionScope Manage Events - all permissions
|
|
728
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
729
|
+
* @permissionScope Manage Events
|
|
730
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
731
|
+
* @permissionScope Manage Orders
|
|
732
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
733
|
+
* @permissionScope Manage Ticket Definitions
|
|
734
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
|
|
735
|
+
* @permissionId WIX_EVENTS.READ_TICKET_DEFINITIONS
|
|
736
|
+
* @webhook
|
|
737
|
+
* @eventType wix.events.ticketing.events.TicketDefinitionCreated
|
|
738
|
+
* @serviceIdentifier wix.events.ticketing.TicketDefinitionManagement
|
|
739
|
+
* @slug ticket_definition_created
|
|
740
|
+
*/
|
|
741
|
+
export declare function onTicketDefinitionCreated(handler: (event: TicketDefinitionCreatedEnvelope) => void | Promise<void>): void;
|
|
742
|
+
export interface TicketDefinitionDeletedEnvelope {
|
|
727
743
|
data: TicketDefinitionDeleted;
|
|
728
744
|
metadata: BaseEventMetadata;
|
|
729
745
|
}
|
|
730
|
-
|
|
746
|
+
/** @permissionScope Manage Events - all permissions
|
|
747
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
748
|
+
* @permissionScope Manage Events
|
|
749
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
750
|
+
* @permissionScope Manage Orders
|
|
751
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
752
|
+
* @permissionScope Manage Ticket Definitions
|
|
753
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
|
|
754
|
+
* @permissionId WIX_EVENTS.READ_TICKET_DEFINITIONS
|
|
755
|
+
* @webhook
|
|
756
|
+
* @eventType wix.events.ticketing.events.TicketDefinitionDeleted
|
|
757
|
+
* @serviceIdentifier wix.events.ticketing.TicketDefinitionManagement
|
|
758
|
+
* @slug ticket_definition_deleted
|
|
759
|
+
*/
|
|
760
|
+
export declare function onTicketDefinitionDeleted(handler: (event: TicketDefinitionDeletedEnvelope) => void | Promise<void>): void;
|
|
761
|
+
export interface TicketDefinitionUpdatedEnvelope {
|
|
731
762
|
data: TicketDefinitionUpdated;
|
|
732
763
|
metadata: BaseEventMetadata;
|
|
733
764
|
}
|
|
734
|
-
|
|
765
|
+
/** @permissionScope Manage Events - all permissions
|
|
766
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
767
|
+
* @permissionScope Manage Events
|
|
768
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
769
|
+
* @permissionScope Manage Orders
|
|
770
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
771
|
+
* @permissionScope Manage Ticket Definitions
|
|
772
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
|
|
773
|
+
* @permissionId WIX_EVENTS.READ_TICKET_DEFINITIONS
|
|
774
|
+
* @webhook
|
|
775
|
+
* @eventType wix.events.ticketing.events.TicketDefinitionUpdated
|
|
776
|
+
* @serviceIdentifier wix.events.ticketing.TicketDefinitionManagement
|
|
777
|
+
* @slug ticket_definition_updated
|
|
778
|
+
*/
|
|
779
|
+
export declare function onTicketDefinitionUpdated(handler: (event: TicketDefinitionUpdatedEnvelope) => void | Promise<void>): void;
|
|
780
|
+
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`;
|
|
781
|
+
/**
|
|
782
|
+
* **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.
|
|
783
|
+
* >**Migration Instructions**.
|
|
784
|
+
* > 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).
|
|
785
|
+
* > To migrate to the new function:
|
|
786
|
+
* > 1. Add the new import statement:
|
|
787
|
+
* > ```js
|
|
788
|
+
* > import { ticketDefinitionsV2 } from 'wix-events.v2';
|
|
789
|
+
* > ```
|
|
790
|
+
* > 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.
|
|
791
|
+
* > 3. Test your changes to make sure your code behaves as expected.
|
|
792
|
+
*
|
|
793
|
+
* Retrieves a list of up to 100 ticket definitions.
|
|
794
|
+
* @public
|
|
795
|
+
* @permissionId WIX_EVENTS.READ_TICKET_DEFINITIONS
|
|
796
|
+
* @permissionScope Manage Events - all permissions
|
|
797
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
798
|
+
* @permissionScope Manage Events
|
|
799
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
800
|
+
* @permissionScope Manage Orders
|
|
801
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
802
|
+
* @permissionScope Manage Ticket Definitions
|
|
803
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
|
|
804
|
+
* @applicableIdentity APP
|
|
805
|
+
* @fqn wix.events.ticketing.TicketDefinitionManagement.QueryTicketDefinitions
|
|
806
|
+
* @deprecated
|
|
807
|
+
* @targetRemovalDate 2024-12-01
|
|
808
|
+
*/
|
|
809
|
+
export declare function queryTicketDefinitions(options?: QueryTicketDefinitionsOptions): Promise<NonNullablePaths<QueryTicketDefinitionsResponse, `total` | `offset` | `limit` | {
|
|
810
|
+
[P in TicketDefinitionNonNullablePaths]: `definitions.${number}.${P}`;
|
|
811
|
+
}[TicketDefinitionNonNullablePaths]>>;
|
|
812
|
+
export interface QueryTicketDefinitionsOptions {
|
|
735
813
|
/** Offset. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */
|
|
736
814
|
offset?: number;
|
|
737
815
|
/**
|
|
@@ -760,7 +838,37 @@ interface QueryTicketDefinitionsOptions {
|
|
|
760
838
|
*/
|
|
761
839
|
facet?: string[];
|
|
762
840
|
}
|
|
763
|
-
|
|
841
|
+
/**
|
|
842
|
+
* **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).
|
|
843
|
+
* >**Migration Instructions**.
|
|
844
|
+
* > 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).
|
|
845
|
+
* > To migrate to the new function:
|
|
846
|
+
* > 1. Add the new import statement:
|
|
847
|
+
* > ```js
|
|
848
|
+
* > import { ticketDefinitionsV2 } from 'wix-events.v2';
|
|
849
|
+
* > ```
|
|
850
|
+
* > 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.
|
|
851
|
+
* > 3. Test your changes to make sure your code behaves as expected.
|
|
852
|
+
*
|
|
853
|
+
* Retrieves a list of up to 1,000 ticket definitions, given the provided paging and filtering.
|
|
854
|
+
* @public
|
|
855
|
+
* @documentationMaturity preview
|
|
856
|
+
* @permissionScope Manage Events - all permissions
|
|
857
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
858
|
+
* @permissionScope Manage Events
|
|
859
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
860
|
+
* @permissionScope Manage Orders
|
|
861
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
862
|
+
* @permissionScope Manage Ticket Definitions
|
|
863
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
|
|
864
|
+
* @permissionId WIX_EVENTS.READ_TICKET_DEFINITIONS
|
|
865
|
+
* @applicableIdentity APP
|
|
866
|
+
* @fqn wix.events.ticketing.TicketDefinitionManagement.QueryTicketDefinitionsV2
|
|
867
|
+
* @deprecated
|
|
868
|
+
* @targetRemovalDate 2024-12-01
|
|
869
|
+
*/
|
|
870
|
+
export declare function queryTicketDefinitionsV2(options?: QueryTicketDefinitionsV2Options): DefinitionsQueryBuilder;
|
|
871
|
+
export interface QueryTicketDefinitionsV2Options {
|
|
764
872
|
}
|
|
765
873
|
interface QueryCursorResult {
|
|
766
874
|
cursors: Cursors;
|
|
@@ -769,13 +877,13 @@ interface QueryCursorResult {
|
|
|
769
877
|
length: number;
|
|
770
878
|
pageSize: number;
|
|
771
879
|
}
|
|
772
|
-
interface DefinitionsQueryResult extends QueryCursorResult {
|
|
880
|
+
export interface DefinitionsQueryResult extends QueryCursorResult {
|
|
773
881
|
items: TicketDefinition[];
|
|
774
882
|
query: DefinitionsQueryBuilder;
|
|
775
883
|
next: () => Promise<DefinitionsQueryResult>;
|
|
776
884
|
prev: () => Promise<DefinitionsQueryResult>;
|
|
777
885
|
}
|
|
778
|
-
interface DefinitionsQueryBuilder {
|
|
886
|
+
export interface DefinitionsQueryBuilder {
|
|
779
887
|
/** @param limit - Number of items to return, which is also the `pageSize` of the results object.
|
|
780
888
|
* @documentationMaturity preview
|
|
781
889
|
*/
|
|
@@ -787,7 +895,39 @@ interface DefinitionsQueryBuilder {
|
|
|
787
895
|
/** @documentationMaturity preview */
|
|
788
896
|
find: () => Promise<DefinitionsQueryResult>;
|
|
789
897
|
}
|
|
790
|
-
|
|
898
|
+
/**
|
|
899
|
+
* **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.
|
|
900
|
+
* >**Migration Instructions**.
|
|
901
|
+
* > 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).
|
|
902
|
+
* > To migrate to the new function:
|
|
903
|
+
* > 1. Add the new import statement:
|
|
904
|
+
* > ```js
|
|
905
|
+
* > import { ticketDefinitionsV2 } from 'wix-events.v2';
|
|
906
|
+
* > ```
|
|
907
|
+
* > 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.
|
|
908
|
+
* > 3. Test your changes to make sure your code behaves as expected.
|
|
909
|
+
*
|
|
910
|
+
* Retrieves a list of up to 100 ticket definitions, with basic filter support.
|
|
911
|
+
* @public
|
|
912
|
+
* @param options - Details for the tickets to retrieve.
|
|
913
|
+
* @permissionId WIX_EVENTS.READ_TICKET_DEFINITIONS
|
|
914
|
+
* @permissionScope Manage Events - all permissions
|
|
915
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
916
|
+
* @permissionScope Manage Events
|
|
917
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
918
|
+
* @permissionScope Manage Orders
|
|
919
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
920
|
+
* @permissionScope Manage Ticket Definitions
|
|
921
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
|
|
922
|
+
* @applicableIdentity APP
|
|
923
|
+
* @fqn wix.events.ticketing.TicketDefinitionManagement.ListTicketDefinitions
|
|
924
|
+
* @deprecated
|
|
925
|
+
* @targetRemovalDate 2024-12-01
|
|
926
|
+
*/
|
|
927
|
+
export declare function listTicketDefinitions(options?: ListTicketDefinitionsOptions): Promise<NonNullablePaths<ListTicketDefinitionsResponse, `metaData.count` | `metaData.offset` | `metaData.total` | {
|
|
928
|
+
[P in TicketDefinitionNonNullablePaths]: `definitions.${number}.${P}`;
|
|
929
|
+
}[TicketDefinitionNonNullablePaths]>>;
|
|
930
|
+
export interface ListTicketDefinitionsOptions {
|
|
791
931
|
/**
|
|
792
932
|
* Event ID.
|
|
793
933
|
* @format GUID
|
|
@@ -850,7 +990,40 @@ interface ListTicketDefinitionsOptions {
|
|
|
850
990
|
*/
|
|
851
991
|
facet?: string[];
|
|
852
992
|
}
|
|
853
|
-
|
|
993
|
+
/**
|
|
994
|
+
* **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.
|
|
995
|
+
* >**Migration Instructions**.
|
|
996
|
+
* > 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).
|
|
997
|
+
* > To migrate to the new function:
|
|
998
|
+
* > 1. Add the new import statement:
|
|
999
|
+
* > ```js
|
|
1000
|
+
* > import { ticketDefinitionsV2 } from 'wix-events.v2';
|
|
1001
|
+
* > ```
|
|
1002
|
+
* > 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.
|
|
1003
|
+
* > 3. Test your changes to make sure your code behaves as expected.
|
|
1004
|
+
*
|
|
1005
|
+
* Retrieves a ticket definition.
|
|
1006
|
+
* @param definitionId - Ticket definition ID.
|
|
1007
|
+
* @public
|
|
1008
|
+
* @requiredField definitionId
|
|
1009
|
+
* @param options - Details for the ticket to retrieve.
|
|
1010
|
+
* @permissionId WIX_EVENTS.READ_TICKET_DEFINITIONS
|
|
1011
|
+
* @permissionScope Manage Events - all permissions
|
|
1012
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
1013
|
+
* @permissionScope Manage Events
|
|
1014
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1015
|
+
* @permissionScope Manage Orders
|
|
1016
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
1017
|
+
* @permissionScope Manage Ticket Definitions
|
|
1018
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
|
|
1019
|
+
* @applicableIdentity APP
|
|
1020
|
+
* @returns Retrieved ticket definition.
|
|
1021
|
+
* @fqn wix.events.ticketing.TicketDefinitionManagement.GetTicketDefinition
|
|
1022
|
+
* @deprecated
|
|
1023
|
+
* @targetRemovalDate 2024-12-01
|
|
1024
|
+
*/
|
|
1025
|
+
export declare function getTicketDefinition(definitionId: string, options?: GetTicketDefinitionOptions): Promise<NonNullablePaths<TicketDefinition, TicketDefinitionNonNullablePaths>>;
|
|
1026
|
+
export interface GetTicketDefinitionOptions {
|
|
854
1027
|
/**
|
|
855
1028
|
* Predefined sets of fields to return.
|
|
856
1029
|
* - `DASHBOARD`: Returns `dashboard`.
|
|
@@ -861,30 +1034,162 @@ interface GetTicketDefinitionOptions {
|
|
|
861
1034
|
*/
|
|
862
1035
|
fieldset?: TicketDefinitionFieldset[];
|
|
863
1036
|
}
|
|
864
|
-
|
|
1037
|
+
/**
|
|
1038
|
+
* **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.
|
|
1039
|
+
* >**Migration Instructions**.
|
|
1040
|
+
* > 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).
|
|
1041
|
+
* > To migrate to the new function:
|
|
1042
|
+
* > 1. Add the new import statement:
|
|
1043
|
+
* > ```js
|
|
1044
|
+
* > import { ticketDefinitionsV2 } from 'wix-events.v2';
|
|
1045
|
+
* > ```
|
|
1046
|
+
* > 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.
|
|
1047
|
+
* > 3. Test your changes to make sure your code behaves as expected.
|
|
1048
|
+
*
|
|
1049
|
+
* Creates a ticket definition (and enables ticket sales).
|
|
1050
|
+
* @param eventId - Event ID.
|
|
1051
|
+
* @public
|
|
1052
|
+
* @requiredField eventId
|
|
1053
|
+
* @requiredField options
|
|
1054
|
+
* @requiredField options.definition
|
|
1055
|
+
* @requiredField options.definition.name
|
|
1056
|
+
* @permissionId WIX_EVENTS.MANAGE_TICKET_DEFINITIONS
|
|
1057
|
+
* @permissionScope Manage Events - all permissions
|
|
1058
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
1059
|
+
* @permissionScope Manage Events
|
|
1060
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1061
|
+
* @permissionScope Manage Ticket Definitions
|
|
1062
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
|
|
1063
|
+
* @applicableIdentity APP
|
|
1064
|
+
* @fqn wix.events.ticketing.TicketDefinitionManagement.CreateTicketDefinition
|
|
1065
|
+
* @deprecated
|
|
1066
|
+
* @targetRemovalDate 2024-12-01
|
|
1067
|
+
*/
|
|
1068
|
+
export declare function createTicketDefinition(eventId: string, options: NonNullablePaths<CreateTicketDefinitionOptions, `definition` | `definition.name`>): Promise<NonNullablePaths<CreateTicketDefinitionResponse, {
|
|
1069
|
+
[P in TicketDefinitionNonNullablePaths]: `definition.${P}`;
|
|
1070
|
+
}[TicketDefinitionNonNullablePaths]>>;
|
|
1071
|
+
export interface CreateTicketDefinitionOptions {
|
|
865
1072
|
/** Ticket definition data. */
|
|
866
1073
|
definition: TicketDefinitionData;
|
|
867
1074
|
}
|
|
868
|
-
|
|
1075
|
+
/**
|
|
1076
|
+
* **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.
|
|
1077
|
+
* >**Migration Instructions**.
|
|
1078
|
+
* > 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).
|
|
1079
|
+
* > To migrate to the new function:
|
|
1080
|
+
* > 1. Add the new import statement:
|
|
1081
|
+
* > ```js
|
|
1082
|
+
* > import { ticketDefinitionsV2 } from 'wix-events.v2';
|
|
1083
|
+
* > ```
|
|
1084
|
+
* > 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.
|
|
1085
|
+
* > 3. Test your changes to make sure your code behaves as expected.
|
|
1086
|
+
*
|
|
1087
|
+
*
|
|
1088
|
+
* Updates a ticket definition.
|
|
1089
|
+
*
|
|
1090
|
+
* See [Partial Updates](/wix-events-v2/partial-updates) for more information.
|
|
1091
|
+
* @param definitionId - Ticket definition ID.
|
|
1092
|
+
* @param eventId - Event ID.
|
|
1093
|
+
* @public
|
|
1094
|
+
* @requiredField definitionId
|
|
1095
|
+
* @requiredField eventId
|
|
1096
|
+
* @requiredField options.definition.pricing.price
|
|
1097
|
+
* @param identifiers - Details of the ticket definition to update.
|
|
1098
|
+
* @param options - Ticket definition details to update.
|
|
1099
|
+
* @permissionId WIX_EVENTS.MANAGE_TICKET_DEFINITIONS
|
|
1100
|
+
* @permissionScope Manage Events - all permissions
|
|
1101
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
1102
|
+
* @permissionScope Manage Events
|
|
1103
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1104
|
+
* @permissionScope Manage Ticket Definitions
|
|
1105
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
|
|
1106
|
+
* @applicableIdentity APP
|
|
1107
|
+
* @fqn wix.events.ticketing.TicketDefinitionManagement.UpdateTicketDefinition
|
|
1108
|
+
* @deprecated
|
|
1109
|
+
* @targetRemovalDate 2024-12-01
|
|
1110
|
+
*/
|
|
1111
|
+
export declare function updateTicketDefinition(definitionId: string, eventId: string, options?: NonNullablePaths<UpdateTicketDefinitionOptions, `definition.pricing`>): Promise<NonNullablePaths<UpdateTicketDefinitionResponse, {
|
|
1112
|
+
[P in TicketDefinitionNonNullablePaths]: `definition.${P}`;
|
|
1113
|
+
}[TicketDefinitionNonNullablePaths]>>;
|
|
1114
|
+
export interface UpdateTicketDefinitionOptions {
|
|
869
1115
|
/** Ticket definition data. */
|
|
870
1116
|
definition?: TicketDefinitionData;
|
|
871
1117
|
/** Set of field paths, specifying which parts of ticket definition to update. */
|
|
872
1118
|
fields?: string[];
|
|
873
1119
|
}
|
|
874
|
-
|
|
1120
|
+
/**
|
|
1121
|
+
* **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.
|
|
1122
|
+
* >**Migration Instructions**.
|
|
1123
|
+
* > 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).
|
|
1124
|
+
* > To migrate to the new function:
|
|
1125
|
+
* > 1. Add the new import statement:
|
|
1126
|
+
* > ```js
|
|
1127
|
+
* > import { ticketDefinitionsV2 } from 'wix-events.v2';
|
|
1128
|
+
* > ```
|
|
1129
|
+
* > 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.
|
|
1130
|
+
* > 3. Test your changes to make sure your code behaves as expected.
|
|
1131
|
+
*
|
|
1132
|
+
* Deletes a ticket definition.
|
|
1133
|
+
* @param eventId - Event ID.
|
|
1134
|
+
* @public
|
|
1135
|
+
* @requiredField eventId
|
|
1136
|
+
* @param options - Details of tickets to delete.
|
|
1137
|
+
* @permissionId WIX_EVENTS.MANAGE_TICKET_DEFINITIONS
|
|
1138
|
+
* @permissionScope Manage Events - all permissions
|
|
1139
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
1140
|
+
* @permissionScope Manage Events
|
|
1141
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1142
|
+
* @permissionScope Manage Ticket Definitions
|
|
1143
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
|
|
1144
|
+
* @applicableIdentity APP
|
|
1145
|
+
* @fqn wix.events.ticketing.TicketDefinitionManagement.DeleteTicketDefinition
|
|
1146
|
+
* @deprecated
|
|
1147
|
+
* @targetRemovalDate 2024-12-01
|
|
1148
|
+
*/
|
|
1149
|
+
export declare function deleteTicketDefinition(eventId: string, options?: DeleteTicketDefinitionOptions): Promise<void>;
|
|
1150
|
+
export interface DeleteTicketDefinitionOptions extends DeleteTicketDefinitionOptionsDeleteOneOf {
|
|
875
1151
|
/** Ticket definitions to delete. */
|
|
876
1152
|
byId?: ById;
|
|
877
1153
|
/** Whether to delete all event tickets. */
|
|
878
1154
|
all?: boolean;
|
|
879
1155
|
}
|
|
880
1156
|
/** @oneof */
|
|
881
|
-
interface DeleteTicketDefinitionOptionsDeleteOneOf {
|
|
1157
|
+
export interface DeleteTicketDefinitionOptionsDeleteOneOf {
|
|
882
1158
|
/** Ticket definitions to delete. */
|
|
883
1159
|
byId?: ById;
|
|
884
1160
|
/** Whether to delete all event tickets. */
|
|
885
1161
|
all?: boolean;
|
|
886
1162
|
}
|
|
887
|
-
|
|
1163
|
+
/**
|
|
1164
|
+
* **Deprecated.** This function will continue to work until November 8, 2024, but a newer version is available at [`changeCurrency()`](/ticket-definitions-v2/change-currency).
|
|
1165
|
+
* >**Migration Instructions**.
|
|
1166
|
+
* > 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).
|
|
1167
|
+
* > To migrate to the new function:
|
|
1168
|
+
* > 1. Add the new import statement:
|
|
1169
|
+
* > ```js
|
|
1170
|
+
* > import { ticketDefinitionsV2 } from 'wix-events.v2';
|
|
1171
|
+
* > ```
|
|
1172
|
+
* > 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.
|
|
1173
|
+
* > 3. Test your changes to make sure your code behaves as expected.
|
|
1174
|
+
*
|
|
1175
|
+
* Changes the currency for all tickets per event.
|
|
1176
|
+
*
|
|
1177
|
+
* @public
|
|
1178
|
+
* @requiredField options.currency
|
|
1179
|
+
* @permissionId WIX_EVENTS.MANAGE_TICKET_DEFINITIONS
|
|
1180
|
+
* @permissionScope Manage Events - all permissions
|
|
1181
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
1182
|
+
* @permissionScope Manage Events
|
|
1183
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1184
|
+
* @permissionScope Manage Ticket Definitions
|
|
1185
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
|
|
1186
|
+
* @applicableIdentity APP
|
|
1187
|
+
* @fqn wix.events.ticketing.TicketDefinitionManagement.ChangeCurrency
|
|
1188
|
+
* @deprecated
|
|
1189
|
+
* @targetRemovalDate 2024-12-01
|
|
1190
|
+
*/
|
|
1191
|
+
export declare function changeCurrency(options?: NonNullablePaths<ChangeCurrencyOptions, `currency`>): Promise<void>;
|
|
1192
|
+
export interface ChangeCurrencyOptions {
|
|
888
1193
|
/**
|
|
889
1194
|
* Event ID.
|
|
890
1195
|
* @format GUID
|
|
@@ -897,5 +1202,4 @@ interface ChangeCurrencyOptions {
|
|
|
897
1202
|
*/
|
|
898
1203
|
currency: string;
|
|
899
1204
|
}
|
|
900
|
-
|
|
901
|
-
export { type DeleteTicketDefinitionRequestDeleteOneOf as $, type CursorPaging as A, type QueryTicketDefinitionsV2Response as B, type CreateTicketDefinitionOptions as C, type DefinitionsQueryBuilder as D, type PagingMetadataV2 as E, FeeType as F, type GetTicketDefinitionOptions as G, type Cursors as H, type ListTicketDefinitionsRequest as I, type GetTicketDefinitionRequest as J, type GetTicketDefinitionResponse as K, type ListTicketDefinitionsOptions as L, type Money as M, type CreateTicketDefinitionRequest as N, type TicketDefinitionData 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 TicketDefinitionCreated as V, WebhookIdentityType as W, type OriginatedFrom as X, type UpdateTicketDefinitionRequest as Y, type TicketDefinitionUpdated as Z, type DeleteTicketDefinitionRequest as _, type QueryTicketDefinitionsResponse as a, type ById as a0, type DeleteTicketDefinitionResponse as a1, type TicketDefinitionDeleted as a2, type ChangeCurrencyRequest as a3, type ChangeCurrencyResponse as a4, type BulkCopyTicketDefinitionsByEventIdRequest as a5, type BulkCopyTicketDefinitionsByEventIdResponse as a6, type CopiedTicketDefinition as a7, type PaidTicketDefinitionExistsRequest as a8, type PaidTicketDefinitionExistsResponse as a9, type MessageEnvelope as aa, type IdentificationData as ab, type IdentificationDataIdOneOf as ac, type BaseEventMetadata as ad, type TicketDefinitionCreatedEnvelope as ae, type TicketDefinitionDeletedEnvelope as af, type TicketDefinitionUpdatedEnvelope 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, TicketSaleStatus as h, TicketDefinitionStateEnumState as i, Type as j, TicketDefinitionFieldset as k, State as l, GroupBy as m, type Dashboard as n, type WixFeeConfig as o, type TicketSalePeriod as p, type TicketPricing as q, type TicketPricingPriceOneOf as r, type PricingOption as s, type QueryTicketDefinitionsRequest as t, type FacetCounts as u, type QueryTicketDefinitionsV2Request as v, type QueryV2 as w, type QueryV2PagingMethodOneOf as x, type Sorting as y, type Paging as z };
|
|
1205
|
+
export {};
|