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