@wix/events 1.0.95 → 1.0.97
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 +2 -1
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/src/events-events-v3-event.http.d.ts +56 -0
- package/build/cjs/src/events-events-v3-event.http.js +548 -0
- package/build/cjs/src/events-events-v3-event.http.js.map +1 -0
- package/build/cjs/src/events-events-v3-event.public.d.ts +19 -0
- package/build/cjs/src/events-events-v3-event.public.js +99 -0
- package/build/cjs/src/events-events-v3-event.public.js.map +1 -0
- package/build/cjs/src/events-events-v3-event.types.d.ts +1512 -0
- package/build/cjs/src/events-events-v3-event.types.js +246 -0
- package/build/cjs/src/events-events-v3-event.types.js.map +1 -0
- package/build/cjs/src/events-events-v3-event.universal.d.ts +1808 -0
- package/build/cjs/src/events-events-v3-event.universal.js +987 -0
- package/build/cjs/src/events-events-v3-event.universal.js.map +1 -0
- package/build/cjs/src/events-guests-v1-guest.public.d.ts +1 -1
- package/build/cjs/src/events-guests-v1-guest.types.d.ts +20 -12
- package/build/cjs/src/events-guests-v1-guest.types.js.map +1 -1
- package/build/cjs/src/events-guests-v1-guest.universal.d.ts +21 -12
- package/build/cjs/src/events-guests-v1-guest.universal.js +1 -0
- package/build/cjs/src/events-guests-v1-guest.universal.js.map +1 -1
- package/build/es/index.d.ts +1 -0
- package/build/es/index.js +1 -0
- package/build/es/index.js.map +1 -1
- package/build/es/src/events-events-v3-event.http.d.ts +56 -0
- package/build/es/src/events-events-v3-event.http.js +533 -0
- package/build/es/src/events-events-v3-event.http.js.map +1 -0
- package/build/es/src/events-events-v3-event.public.d.ts +19 -0
- package/build/es/src/events-events-v3-event.public.js +64 -0
- package/build/es/src/events-events-v3-event.public.js.map +1 -0
- package/build/es/src/events-events-v3-event.types.d.ts +1512 -0
- package/build/es/src/events-events-v3-event.types.js +243 -0
- package/build/es/src/events-events-v3-event.types.js.map +1 -0
- package/build/es/src/events-events-v3-event.universal.d.ts +1808 -0
- package/build/es/src/events-events-v3-event.universal.js +953 -0
- package/build/es/src/events-events-v3-event.universal.js.map +1 -0
- package/build/es/src/events-guests-v1-guest.public.d.ts +1 -1
- package/build/es/src/events-guests-v1-guest.types.d.ts +20 -12
- package/build/es/src/events-guests-v1-guest.types.js.map +1 -1
- package/build/es/src/events-guests-v1-guest.universal.d.ts +21 -12
- package/build/es/src/events-guests-v1-guest.universal.js +1 -0
- package/build/es/src/events-guests-v1-guest.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -0,0 +1,1512 @@
|
|
|
1
|
+
export interface Event {
|
|
2
|
+
/**
|
|
3
|
+
* Event ID.
|
|
4
|
+
* @readonly
|
|
5
|
+
*/
|
|
6
|
+
id?: string;
|
|
7
|
+
/** Event location. */
|
|
8
|
+
location?: Location;
|
|
9
|
+
/** Event time management. */
|
|
10
|
+
scheduling?: Scheduling;
|
|
11
|
+
title?: string | null;
|
|
12
|
+
description?: string | null;
|
|
13
|
+
about?: string | null;
|
|
14
|
+
/** Main event image. */
|
|
15
|
+
mainImage?: Image;
|
|
16
|
+
/**
|
|
17
|
+
* Unique identifier of the event page. The naming is the same as the event title written in kebab case. For example, if your event title is "Leather Crafting 101", then the slug is "leather-crafting-101".
|
|
18
|
+
* @readonly
|
|
19
|
+
*/
|
|
20
|
+
slug?: string;
|
|
21
|
+
/** Language code in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. Used when the event ticket should be translated into another language. Default value is `en`. */
|
|
22
|
+
languageCode?: string;
|
|
23
|
+
/**
|
|
24
|
+
* Date and time when the event was created in `yyyy-mm-ddThh:mm:sssZ` format.
|
|
25
|
+
* @readonly
|
|
26
|
+
*/
|
|
27
|
+
createdDate?: Date;
|
|
28
|
+
/**
|
|
29
|
+
* Date and time when the event was updated in `yyyy-mm-ddThh:mm:sssZ` format.
|
|
30
|
+
* @readonly
|
|
31
|
+
*/
|
|
32
|
+
modifiedDate?: Date;
|
|
33
|
+
/**
|
|
34
|
+
* Event status.
|
|
35
|
+
* @readonly
|
|
36
|
+
*/
|
|
37
|
+
status?: EventStatus;
|
|
38
|
+
/** RSVP or ticketing registration details. */
|
|
39
|
+
registration?: Registration;
|
|
40
|
+
/** URLs that allow you to add an event to the Google calendar, or to download an [ICS calendar](https://icscalendar.com/) file. */
|
|
41
|
+
calendarLinks?: CalendarLinks;
|
|
42
|
+
/** Event page URL components. */
|
|
43
|
+
eventPageUrl?: PageUrl;
|
|
44
|
+
/** Event registration form. */
|
|
45
|
+
form?: Form;
|
|
46
|
+
/** Summary of RSVP or ticket sales. */
|
|
47
|
+
dashboard?: Dashboard;
|
|
48
|
+
/**
|
|
49
|
+
* Instance ID of the site where event is hosted.
|
|
50
|
+
* @readonly
|
|
51
|
+
*/
|
|
52
|
+
instanceId?: string;
|
|
53
|
+
/** Guest list configuration. */
|
|
54
|
+
guestListConfig?: GuestListConfig;
|
|
55
|
+
/**
|
|
56
|
+
* ID of the user who created the event.
|
|
57
|
+
* @readonly
|
|
58
|
+
*/
|
|
59
|
+
userId?: string;
|
|
60
|
+
/** Online conferencing details. */
|
|
61
|
+
onlineConferencing?: OnlineConferencing;
|
|
62
|
+
/** SEO settings. */
|
|
63
|
+
seoSettings?: SeoSettings;
|
|
64
|
+
/** Assigned contacts label key. */
|
|
65
|
+
assignedContactLabel?: string | null;
|
|
66
|
+
/** Event schedule details. */
|
|
67
|
+
agenda?: Agenda;
|
|
68
|
+
/** Event categories. */
|
|
69
|
+
categories?: Category[];
|
|
70
|
+
}
|
|
71
|
+
export interface Location {
|
|
72
|
+
name?: string | null;
|
|
73
|
+
/** Whether the event is online or on-site. */
|
|
74
|
+
type?: LocationType;
|
|
75
|
+
/** Exact location address. */
|
|
76
|
+
address?: CommonAddress;
|
|
77
|
+
/** Whether the event location is TBD. */
|
|
78
|
+
locationTbd?: boolean | null;
|
|
79
|
+
}
|
|
80
|
+
export declare enum LocationType {
|
|
81
|
+
VENUE = "VENUE",
|
|
82
|
+
ONLINE = "ONLINE"
|
|
83
|
+
}
|
|
84
|
+
/** Physical address */
|
|
85
|
+
export interface CommonAddress extends CommonAddressStreetOneOf {
|
|
86
|
+
/** Street name and number. */
|
|
87
|
+
streetAddress?: CommonStreetAddress;
|
|
88
|
+
/** Main address line, usually street and number as free text. */
|
|
89
|
+
addressLine?: string | null;
|
|
90
|
+
/** Country code. */
|
|
91
|
+
country?: string | null;
|
|
92
|
+
/** Subdivision. Usually a state, region, prefecture, or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */
|
|
93
|
+
subdivision?: string | null;
|
|
94
|
+
/** City name. */
|
|
95
|
+
city?: string | null;
|
|
96
|
+
/** Zip/postal code. */
|
|
97
|
+
postalCode?: string | null;
|
|
98
|
+
/** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */
|
|
99
|
+
addressLine2?: string | null;
|
|
100
|
+
}
|
|
101
|
+
/** @oneof */
|
|
102
|
+
export interface CommonAddressStreetOneOf {
|
|
103
|
+
/** Street name and number. */
|
|
104
|
+
streetAddress?: CommonStreetAddress;
|
|
105
|
+
/** Main address line, usually street and number as free text. */
|
|
106
|
+
addressLine?: string | null;
|
|
107
|
+
}
|
|
108
|
+
export interface CommonStreetAddress {
|
|
109
|
+
/** Street number. */
|
|
110
|
+
number?: string;
|
|
111
|
+
/** Street name. */
|
|
112
|
+
name?: string;
|
|
113
|
+
}
|
|
114
|
+
export interface CommonAddressLocation {
|
|
115
|
+
/** Address latitude. */
|
|
116
|
+
latitude?: number | null;
|
|
117
|
+
/** Address longitude. */
|
|
118
|
+
longitude?: number | null;
|
|
119
|
+
}
|
|
120
|
+
export interface CommonSubdivision {
|
|
121
|
+
/** Short subdivision code. */
|
|
122
|
+
code?: string;
|
|
123
|
+
/** Subdivision full name. */
|
|
124
|
+
name?: string;
|
|
125
|
+
}
|
|
126
|
+
export declare enum SubdivisionSubdivisionType {
|
|
127
|
+
UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
|
|
128
|
+
/** State */
|
|
129
|
+
ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
|
|
130
|
+
/** County */
|
|
131
|
+
ADMINISTRATIVE_AREA_LEVEL_2 = "ADMINISTRATIVE_AREA_LEVEL_2",
|
|
132
|
+
/** City/town */
|
|
133
|
+
ADMINISTRATIVE_AREA_LEVEL_3 = "ADMINISTRATIVE_AREA_LEVEL_3",
|
|
134
|
+
/** Neighborhood/quarter */
|
|
135
|
+
ADMINISTRATIVE_AREA_LEVEL_4 = "ADMINISTRATIVE_AREA_LEVEL_4",
|
|
136
|
+
/** Street/block */
|
|
137
|
+
ADMINISTRATIVE_AREA_LEVEL_5 = "ADMINISTRATIVE_AREA_LEVEL_5",
|
|
138
|
+
/** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
|
|
139
|
+
COUNTRY = "COUNTRY"
|
|
140
|
+
}
|
|
141
|
+
export interface Scheduling {
|
|
142
|
+
/** Schedule configuration. */
|
|
143
|
+
config?: ScheduleConfig;
|
|
144
|
+
/**
|
|
145
|
+
* Formatted schedule representation.
|
|
146
|
+
* @readonly
|
|
147
|
+
*/
|
|
148
|
+
formatted?: string;
|
|
149
|
+
/**
|
|
150
|
+
* Formatted start date of the event. Empty for TBD schedules.
|
|
151
|
+
* @readonly
|
|
152
|
+
*/
|
|
153
|
+
startDateFormatted?: string;
|
|
154
|
+
/**
|
|
155
|
+
* Formatted start time of the event. Empty for TBD schedules.
|
|
156
|
+
* @readonly
|
|
157
|
+
*/
|
|
158
|
+
startTimeFormatted?: string;
|
|
159
|
+
}
|
|
160
|
+
export interface ScheduleConfig {
|
|
161
|
+
/** Whether the event date and time is TBD. */
|
|
162
|
+
scheduleTbd?: boolean;
|
|
163
|
+
scheduleTbdMessage?: string | null;
|
|
164
|
+
/** Event start date in `yyyy-mm-ddThh:mm:sssZ` format. */
|
|
165
|
+
startDate?: Date;
|
|
166
|
+
/** Event end date in `yyyy-mm-ddThh:mm:sssZ` format. */
|
|
167
|
+
endDate?: Date;
|
|
168
|
+
/** Event time zone ID in the [TZ database](https://www.iana.org/time-zones) format. */
|
|
169
|
+
timeZoneId?: string | null;
|
|
170
|
+
/** Whether end date is hidden in the formatted schedule. */
|
|
171
|
+
hideEndDate?: boolean;
|
|
172
|
+
/** Whether time zone is displayed in the formatted schedule. */
|
|
173
|
+
showTimeZone?: boolean;
|
|
174
|
+
/**
|
|
175
|
+
* Repeating event status.
|
|
176
|
+
* @readonly
|
|
177
|
+
*/
|
|
178
|
+
recurrenceStatus?: Status;
|
|
179
|
+
/** Event repetitions. */
|
|
180
|
+
recurringEvents?: Recurrences;
|
|
181
|
+
}
|
|
182
|
+
export declare enum Status {
|
|
183
|
+
/** Default value. This value is unused. */
|
|
184
|
+
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
185
|
+
/** Event occurs only once. */
|
|
186
|
+
ONE_TIME = "ONE_TIME",
|
|
187
|
+
/** Event is repeating and has a list of scheduled repetitions. */
|
|
188
|
+
RECURRING = "RECURRING",
|
|
189
|
+
/** An upcoming event from the list of repetitions. */
|
|
190
|
+
RECURRING_UPCOMING = "RECURRING_UPCOMING",
|
|
191
|
+
/** Latest ended event from the list of repetitions. */
|
|
192
|
+
RECURRING_LAST_ENDED = "RECURRING_LAST_ENDED",
|
|
193
|
+
/** Latest cancelled event from the list of repetitions. */
|
|
194
|
+
RECURRING_LAST_CANCELED = "RECURRING_LAST_CANCELED"
|
|
195
|
+
}
|
|
196
|
+
export interface Recurrences {
|
|
197
|
+
individualEventDates?: Occurrence[];
|
|
198
|
+
/**
|
|
199
|
+
* Recurring event category ID.
|
|
200
|
+
* @readonly
|
|
201
|
+
*/
|
|
202
|
+
categoryId?: string | null;
|
|
203
|
+
}
|
|
204
|
+
export interface Occurrence {
|
|
205
|
+
/** Event start date in `yyyy-mm-ddThh:mm:sssZ` format. */
|
|
206
|
+
startDate?: Date;
|
|
207
|
+
/** Event end date in `yyyy-mm-ddThh:mm:sssZ` format. */
|
|
208
|
+
endDate?: Date;
|
|
209
|
+
/** Event time zone ID in the [TZ database](https://www.iana.org/time-zones) format. */
|
|
210
|
+
timeZoneId?: string | null;
|
|
211
|
+
/** Whether the time zone is displayed in a formatted schedule. */
|
|
212
|
+
showTimeZone?: boolean;
|
|
213
|
+
}
|
|
214
|
+
export interface Image {
|
|
215
|
+
/** WixMedia image ID. */
|
|
216
|
+
id?: string;
|
|
217
|
+
/** Image URL. */
|
|
218
|
+
url?: string;
|
|
219
|
+
/**
|
|
220
|
+
* Original image height.
|
|
221
|
+
* @readonly
|
|
222
|
+
*/
|
|
223
|
+
height?: number;
|
|
224
|
+
/**
|
|
225
|
+
* Original image width.
|
|
226
|
+
* @readonly
|
|
227
|
+
*/
|
|
228
|
+
width?: number;
|
|
229
|
+
/** Image alt text. */
|
|
230
|
+
altText?: string | null;
|
|
231
|
+
/**
|
|
232
|
+
* Image filename.
|
|
233
|
+
* @readonly
|
|
234
|
+
*/
|
|
235
|
+
filename?: string | null;
|
|
236
|
+
}
|
|
237
|
+
export declare enum EventStatus {
|
|
238
|
+
/** Default value. This value is unused */
|
|
239
|
+
UNKNOWN_EVENT_STATUS = "UNKNOWN_EVENT_STATUS",
|
|
240
|
+
/** Event is public and scheduled to start */
|
|
241
|
+
SCHEDULED = "SCHEDULED",
|
|
242
|
+
/** Event has started */
|
|
243
|
+
STARTED = "STARTED",
|
|
244
|
+
/** Event has ended */
|
|
245
|
+
ENDED = "ENDED",
|
|
246
|
+
/** Event is canceled */
|
|
247
|
+
CANCELED = "CANCELED",
|
|
248
|
+
/** Event is not public */
|
|
249
|
+
DRAFT = "DRAFT"
|
|
250
|
+
}
|
|
251
|
+
export interface Registration {
|
|
252
|
+
/**
|
|
253
|
+
* Registration type.
|
|
254
|
+
* @readonly
|
|
255
|
+
*/
|
|
256
|
+
type?: RegistrationType;
|
|
257
|
+
/**
|
|
258
|
+
* Registration status.
|
|
259
|
+
* @readonly
|
|
260
|
+
*/
|
|
261
|
+
status?: RegistrationStatus;
|
|
262
|
+
/** RSVP registration details. */
|
|
263
|
+
rsvpRegistration?: RsvpRegistration;
|
|
264
|
+
/** Ticketing registration details. */
|
|
265
|
+
ticketingRegistration?: TicketingRegistration;
|
|
266
|
+
/** External registration details. */
|
|
267
|
+
externalRegistration?: ExternalRegistration;
|
|
268
|
+
/** Types of guests allowed to register. */
|
|
269
|
+
allowedGuestTypes?: GuestType;
|
|
270
|
+
/** Initial event type which was set when creating an event. */
|
|
271
|
+
initialType?: RegistrationType;
|
|
272
|
+
/** Whether the registration is paused. */
|
|
273
|
+
pausedRegistration?: boolean;
|
|
274
|
+
/** Whether the registration is disabled. */
|
|
275
|
+
disabledRegistration?: boolean;
|
|
276
|
+
}
|
|
277
|
+
export declare enum RegistrationType {
|
|
278
|
+
/** Type not available for this request fieldset */
|
|
279
|
+
UNKNOWN_REGISTRATION_TYPE = "UNKNOWN_REGISTRATION_TYPE",
|
|
280
|
+
/** Registration via RSVP */
|
|
281
|
+
RSVP = "RSVP",
|
|
282
|
+
/** Registration via ticket purchase */
|
|
283
|
+
TICKETING = "TICKETING",
|
|
284
|
+
/** External registration */
|
|
285
|
+
EXTERNAL = "EXTERNAL",
|
|
286
|
+
/** Registration not available */
|
|
287
|
+
NONE = "NONE"
|
|
288
|
+
}
|
|
289
|
+
export declare enum RegistrationStatus {
|
|
290
|
+
/** Registration status is not applicable */
|
|
291
|
+
NA_REGISTRATION_STATUS = "NA_REGISTRATION_STATUS",
|
|
292
|
+
/** Registration to event is closed */
|
|
293
|
+
CLOSED = "CLOSED",
|
|
294
|
+
/** Registration to event is closed manually */
|
|
295
|
+
CLOSED_MANUALLY = "CLOSED_MANUALLY",
|
|
296
|
+
/** Registration is open via RSVP */
|
|
297
|
+
OPEN_RSVP = "OPEN_RSVP",
|
|
298
|
+
/** Registration to event waitlist is open via RSVP */
|
|
299
|
+
OPEN_RSVP_WAITLIST = "OPEN_RSVP_WAITLIST",
|
|
300
|
+
/** Registration is open via ticket purchase */
|
|
301
|
+
OPEN_TICKETS = "OPEN_TICKETS",
|
|
302
|
+
/** Registration is open via external URL */
|
|
303
|
+
OPEN_EXTERNAL = "OPEN_EXTERNAL",
|
|
304
|
+
/** Registration will be open via RSVP */
|
|
305
|
+
SCHEDULED_RSVP = "SCHEDULED_RSVP"
|
|
306
|
+
}
|
|
307
|
+
export interface RsvpRegistration {
|
|
308
|
+
/** Available answers for registration to an event. */
|
|
309
|
+
responseType?: ResponseType;
|
|
310
|
+
/** How many guests can RSVP to an event. */
|
|
311
|
+
limit?: number | null;
|
|
312
|
+
/** Whether a waitlist is opened when the total guest limit is reached. Guests can RSVP to an event and they'll be put in the waitlist with the `WAITING RSVP` status. */
|
|
313
|
+
waitlistEnabled?: boolean;
|
|
314
|
+
/** Registration start date in `yyyy-mm-ddThh:mm:sssZ` format. */
|
|
315
|
+
startDate?: Date;
|
|
316
|
+
/** Registration end date in `yyyy-mm-ddThh:mm:sssZ` format. */
|
|
317
|
+
endDate?: Date;
|
|
318
|
+
}
|
|
319
|
+
export declare enum ResponseType {
|
|
320
|
+
/** Only **Yes** answer is available for the registration. */
|
|
321
|
+
YES_ONLY = "YES_ONLY",
|
|
322
|
+
/** *Yes** and **No** answers are available for the registration. */
|
|
323
|
+
YES_AND_NO = "YES_AND_NO"
|
|
324
|
+
}
|
|
325
|
+
export interface TicketingRegistration {
|
|
326
|
+
/** Whether the registration form must be filled out separately for each ticket. */
|
|
327
|
+
guestsAssignedSeparately?: boolean;
|
|
328
|
+
ticketLimitPerOrder?: number;
|
|
329
|
+
/** Ticket price currency. */
|
|
330
|
+
currency?: string | null;
|
|
331
|
+
/**
|
|
332
|
+
* Lowest ticket price.
|
|
333
|
+
* @readonly
|
|
334
|
+
*/
|
|
335
|
+
lowestPrice?: Money;
|
|
336
|
+
/**
|
|
337
|
+
* Highest ticket price.
|
|
338
|
+
* @readonly
|
|
339
|
+
*/
|
|
340
|
+
highestPrice?: Money;
|
|
341
|
+
/**
|
|
342
|
+
* Whether all tickets are sold for the event.
|
|
343
|
+
* @readonly
|
|
344
|
+
*/
|
|
345
|
+
soldOut?: boolean | null;
|
|
346
|
+
/** Tax application settings. */
|
|
347
|
+
taxConfig?: TaxConfig;
|
|
348
|
+
}
|
|
349
|
+
/**
|
|
350
|
+
* Money.
|
|
351
|
+
* Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.
|
|
352
|
+
*/
|
|
353
|
+
export interface Money {
|
|
354
|
+
/** Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, a single (-), to indicate that the amount is negative. */
|
|
355
|
+
value?: string;
|
|
356
|
+
/** Currency code. Must be valid ISO 4217 currency code (e.g., USD). */
|
|
357
|
+
currency?: string;
|
|
358
|
+
/**
|
|
359
|
+
* Monetary amount. Decimal string in local format (e.g., 1 000,30). Optionally, a single (-), to indicate that the amount is negative.
|
|
360
|
+
* @readonly
|
|
361
|
+
*/
|
|
362
|
+
formattedValue?: string | null;
|
|
363
|
+
}
|
|
364
|
+
export interface TaxConfig {
|
|
365
|
+
/** Tax application settings. */
|
|
366
|
+
type?: TaxType;
|
|
367
|
+
name?: string | null;
|
|
368
|
+
rate?: string | null;
|
|
369
|
+
/** Apply tax to donations. */
|
|
370
|
+
applyToDonations?: boolean | null;
|
|
371
|
+
}
|
|
372
|
+
export declare enum TaxType {
|
|
373
|
+
/** Tax is included in the ticket price */
|
|
374
|
+
INCLUDED = "INCLUDED",
|
|
375
|
+
/** Tax is added to the order at the checkout */
|
|
376
|
+
ADDED = "ADDED",
|
|
377
|
+
/** Tax is added to the final total at the checkout */
|
|
378
|
+
ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
|
|
379
|
+
}
|
|
380
|
+
export interface ExternalRegistration {
|
|
381
|
+
/** External event registration URL. */
|
|
382
|
+
externalRegistrationUrl?: string | null;
|
|
383
|
+
}
|
|
384
|
+
export declare enum GuestType {
|
|
385
|
+
/** Site visitor or member */
|
|
386
|
+
VISITOR_OR_MEMBER = "VISITOR_OR_MEMBER",
|
|
387
|
+
/** Site member */
|
|
388
|
+
MEMBER = "MEMBER"
|
|
389
|
+
}
|
|
390
|
+
export interface CalendarLinks {
|
|
391
|
+
/**
|
|
392
|
+
* "Add to Google calendar" URL.
|
|
393
|
+
* @readonly
|
|
394
|
+
*/
|
|
395
|
+
google?: string;
|
|
396
|
+
/**
|
|
397
|
+
* "Download ICS calendar file" URL.
|
|
398
|
+
* @readonly
|
|
399
|
+
*/
|
|
400
|
+
ics?: string;
|
|
401
|
+
}
|
|
402
|
+
export interface PageUrl {
|
|
403
|
+
/** The base URL. For premium sites, this will be the domain. For free sites, this would be site URL (e.g mysite.wixsite.com/mysite) */
|
|
404
|
+
base?: string;
|
|
405
|
+
/** The path to that page - e.g `/my-events/weekly-meetup-2` */
|
|
406
|
+
path?: string;
|
|
407
|
+
}
|
|
408
|
+
/**
|
|
409
|
+
* The form defines which elements are rendered in the Wix UI during the registration process (RSVP or checkout).
|
|
410
|
+
* It also contains customizable messages and labels.
|
|
411
|
+
*
|
|
412
|
+
*
|
|
413
|
+
* A form is an ordered list of controls (blocks), which accept guest information into a field input.
|
|
414
|
+
*
|
|
415
|
+
* Each control contains one or more nested inputs. For example, `Name` control has two inputs:
|
|
416
|
+
* - First Name
|
|
417
|
+
* - Last Name
|
|
418
|
+
*
|
|
419
|
+
* By default, name and email controls are always required and are pinned to the top of the form.
|
|
420
|
+
*/
|
|
421
|
+
export interface Form {
|
|
422
|
+
/** Nested fields as an ordered list. */
|
|
423
|
+
controls?: InputControl[];
|
|
424
|
+
/** Set of configured form messages. */
|
|
425
|
+
messages?: FormMessages;
|
|
426
|
+
}
|
|
427
|
+
/**
|
|
428
|
+
* A block of nested fields.
|
|
429
|
+
* Used to aggregate similar inputs like First Name and Last Name.
|
|
430
|
+
*/
|
|
431
|
+
export interface InputControl {
|
|
432
|
+
/** Field control type. */
|
|
433
|
+
type?: InputControlType;
|
|
434
|
+
/** Whether control is mandatory (such as name & email). When true, only label can be changed. */
|
|
435
|
+
system?: boolean;
|
|
436
|
+
/** Deprecated: Use `id`. */
|
|
437
|
+
name?: string;
|
|
438
|
+
/** Child inputs. */
|
|
439
|
+
inputs?: Input[];
|
|
440
|
+
/** Deprecated: use `inputs.label`. */
|
|
441
|
+
label?: string;
|
|
442
|
+
/** Field controls are sorted by this value in ascending order. */
|
|
443
|
+
orderIndex?: number;
|
|
444
|
+
/** Unique control ID. */
|
|
445
|
+
id?: string;
|
|
446
|
+
}
|
|
447
|
+
export declare enum InputControlType {
|
|
448
|
+
/** Single text value field. */
|
|
449
|
+
INPUT = "INPUT",
|
|
450
|
+
/** Single text value field. */
|
|
451
|
+
TEXTAREA = "TEXTAREA",
|
|
452
|
+
/** Single-choice field of predefined values. */
|
|
453
|
+
DROPDOWN = "DROPDOWN",
|
|
454
|
+
/** Single-choice field of predefined values. */
|
|
455
|
+
RADIO = "RADIO",
|
|
456
|
+
/** Multiple-choice field of predefined values. */
|
|
457
|
+
CHECKBOX = "CHECKBOX",
|
|
458
|
+
/** First and last name fields. */
|
|
459
|
+
NAME = "NAME",
|
|
460
|
+
/** Additional guests and respective guest names fields. */
|
|
461
|
+
GUEST_CONTROL = "GUEST_CONTROL",
|
|
462
|
+
/** Single-line address field. */
|
|
463
|
+
ADDRESS_SHORT = "ADDRESS_SHORT",
|
|
464
|
+
/** Full address field. */
|
|
465
|
+
ADDRESS_FULL = "ADDRESS_FULL",
|
|
466
|
+
/** Year, month and day fields. */
|
|
467
|
+
DATE = "DATE"
|
|
468
|
+
}
|
|
469
|
+
/** An input of one or multiple text values */
|
|
470
|
+
export interface Input {
|
|
471
|
+
/** Field name. */
|
|
472
|
+
name?: string;
|
|
473
|
+
/** Deprecated: use `ValueType.TEXT_ARRAY`. */
|
|
474
|
+
array?: boolean;
|
|
475
|
+
/** Main field label */
|
|
476
|
+
label?: string;
|
|
477
|
+
/** Additional labels for multi-valued fields such as address. */
|
|
478
|
+
additionalLabels?: Record<string, string>;
|
|
479
|
+
/** Predefined choice options for fields, such as dropdown. */
|
|
480
|
+
options?: string[];
|
|
481
|
+
/** Whether field is mandatory. */
|
|
482
|
+
mandatory?: boolean;
|
|
483
|
+
/** Maximum number of accepted characters (relevant for text fields). */
|
|
484
|
+
maxLength?: number;
|
|
485
|
+
/**
|
|
486
|
+
* Type which determines field format.
|
|
487
|
+
* Used to validate submitted response.
|
|
488
|
+
*/
|
|
489
|
+
type?: ValueType;
|
|
490
|
+
/**
|
|
491
|
+
* A maximum accepted values for array input.
|
|
492
|
+
* Only applicable for inputs of valueType: TEXT_ARRAY.
|
|
493
|
+
*/
|
|
494
|
+
maxSize?: number | null;
|
|
495
|
+
/**
|
|
496
|
+
* Preselected option.
|
|
497
|
+
* Currently only applicable for dropdown.
|
|
498
|
+
*/
|
|
499
|
+
defaultOptionSelection?: OptionSelection;
|
|
500
|
+
/**
|
|
501
|
+
* Additional labels for multi-valued fields such as address.
|
|
502
|
+
* @readonly
|
|
503
|
+
*/
|
|
504
|
+
labels?: Label[];
|
|
505
|
+
}
|
|
506
|
+
export declare enum ValueType {
|
|
507
|
+
TEXT = "TEXT",
|
|
508
|
+
NUMBER = "NUMBER",
|
|
509
|
+
TEXT_ARRAY = "TEXT_ARRAY",
|
|
510
|
+
DATE_TIME = "DATE_TIME",
|
|
511
|
+
ADDRESS = "ADDRESS"
|
|
512
|
+
}
|
|
513
|
+
/**
|
|
514
|
+
* Describes initially selected option when an input has multiple choices.
|
|
515
|
+
* Defaults to first (0th) option if not configured.
|
|
516
|
+
*/
|
|
517
|
+
export interface OptionSelection extends OptionSelectionSelectedOptionOneOf {
|
|
518
|
+
/** 0-based index from predefined `input.options` which is selected initially. */
|
|
519
|
+
optionIndex?: number;
|
|
520
|
+
/**
|
|
521
|
+
* Placeholder hint describing expected choices (such as "Please select").
|
|
522
|
+
* Considered an empty choice.
|
|
523
|
+
*/
|
|
524
|
+
placeholderText?: string;
|
|
525
|
+
}
|
|
526
|
+
/** @oneof */
|
|
527
|
+
export interface OptionSelectionSelectedOptionOneOf {
|
|
528
|
+
/** 0-based index from predefined `input.options` which is selected initially. */
|
|
529
|
+
optionIndex?: number;
|
|
530
|
+
/**
|
|
531
|
+
* Placeholder hint describing expected choices (such as "Please select").
|
|
532
|
+
* Considered an empty choice.
|
|
533
|
+
*/
|
|
534
|
+
placeholderText?: string;
|
|
535
|
+
}
|
|
536
|
+
export interface Label {
|
|
537
|
+
/** Field name. */
|
|
538
|
+
name?: string;
|
|
539
|
+
/** Field label. */
|
|
540
|
+
label?: string;
|
|
541
|
+
}
|
|
542
|
+
/**
|
|
543
|
+
* Defines form messages shown in UI before, during, and after registration flow.
|
|
544
|
+
* It enables configuration of form titles, response labels, "thank you" messages, and call-to-action texts.
|
|
545
|
+
*/
|
|
546
|
+
export interface FormMessages {
|
|
547
|
+
/** RSVP form messages. */
|
|
548
|
+
rsvp?: RsvpFormMessages;
|
|
549
|
+
/** Checkout form messages. */
|
|
550
|
+
checkout?: CheckoutFormMessages;
|
|
551
|
+
/** Messages shown when event registration is closed. */
|
|
552
|
+
registrationClosed?: RegistrationClosedMessages;
|
|
553
|
+
/** Messages shown when event tickets are unavailable. */
|
|
554
|
+
ticketsUnavailable?: TicketsUnavailableMessages;
|
|
555
|
+
}
|
|
556
|
+
export interface RsvpFormMessages {
|
|
557
|
+
/** Label text indicating RSVP `YES` response. */
|
|
558
|
+
rsvpYesOption?: string;
|
|
559
|
+
/** Label text indicating RSVP `NO` response. */
|
|
560
|
+
rsvpNoOption?: string;
|
|
561
|
+
/** Messages shown for RSVP = `YES`. */
|
|
562
|
+
positiveMessages?: Positive;
|
|
563
|
+
/** Messages shown for RSVP = `WAITING` (when event is full and waitlist is available). */
|
|
564
|
+
waitlistMessages?: Positive;
|
|
565
|
+
/** Messages shown for RSVP = `NO`. */
|
|
566
|
+
negativeMessages?: Negative;
|
|
567
|
+
/** "Submit form" call-to-action label text. */
|
|
568
|
+
submitActionLabel?: string;
|
|
569
|
+
}
|
|
570
|
+
/** Confirmation messages shown after registration. */
|
|
571
|
+
export interface PositiveResponseConfirmation {
|
|
572
|
+
/** Confirmation message title. */
|
|
573
|
+
title?: string;
|
|
574
|
+
/** Confirmation message text. */
|
|
575
|
+
message?: string;
|
|
576
|
+
/** "Add to calendar" call-to-action label text. */
|
|
577
|
+
addToCalendarActionLabel?: string;
|
|
578
|
+
/** "Share event" call-to-action label text. */
|
|
579
|
+
shareActionLabel?: string;
|
|
580
|
+
}
|
|
581
|
+
/** Confirmation messages shown after registration. */
|
|
582
|
+
export interface ResponseConfirmation {
|
|
583
|
+
/** Confirmation message title. */
|
|
584
|
+
title?: string;
|
|
585
|
+
/** "Share event" call-to-action label text. */
|
|
586
|
+
shareActionLabel?: string;
|
|
587
|
+
}
|
|
588
|
+
/** Set of messages shown during registration when RSVP response is positive. */
|
|
589
|
+
export interface Positive {
|
|
590
|
+
/** Main form title for positive response. */
|
|
591
|
+
title?: string;
|
|
592
|
+
/** Confirmation messages shown after registration. */
|
|
593
|
+
confirmation?: PositiveResponseConfirmation;
|
|
594
|
+
}
|
|
595
|
+
/** A set of messages shown during registration with negative response */
|
|
596
|
+
export interface Negative {
|
|
597
|
+
/** Main form title for negative response. */
|
|
598
|
+
title?: string;
|
|
599
|
+
/** Confirmation messages shown after registration. */
|
|
600
|
+
confirmation?: ResponseConfirmation;
|
|
601
|
+
}
|
|
602
|
+
export interface CheckoutFormMessages {
|
|
603
|
+
/** Main form title for response. */
|
|
604
|
+
title?: string;
|
|
605
|
+
/** Submit form call-to-action label text. */
|
|
606
|
+
submitActionLabel?: string;
|
|
607
|
+
}
|
|
608
|
+
export interface RegistrationClosedMessages {
|
|
609
|
+
/** Message shown when event registration is closed. */
|
|
610
|
+
message?: string;
|
|
611
|
+
/** "Explore other events" call-to-action label text. */
|
|
612
|
+
exploreEventsActionLabel?: string;
|
|
613
|
+
}
|
|
614
|
+
export interface TicketsUnavailableMessages {
|
|
615
|
+
/** Message shown when event tickets are unavailable. */
|
|
616
|
+
message?: string;
|
|
617
|
+
/** "Explore other events" call-to-action label text. */
|
|
618
|
+
exploreEventsActionLabel?: string;
|
|
619
|
+
}
|
|
620
|
+
export interface Dashboard {
|
|
621
|
+
/** RSVP summary of guests. */
|
|
622
|
+
rsvpSummary?: RsvpSummary;
|
|
623
|
+
/** Summary of revenue and sold tickets. Archived orders are not included. */
|
|
624
|
+
ticketSummary?: TicketSummary;
|
|
625
|
+
}
|
|
626
|
+
export interface EventsMoney {
|
|
627
|
+
/** *Deprecated:** Use `value` instead. */
|
|
628
|
+
amount?: string;
|
|
629
|
+
/** ISO 4217 format of the currency i.e. `USD`. */
|
|
630
|
+
currency?: string;
|
|
631
|
+
/** Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, a single (-), to indicate that the amount is negative. */
|
|
632
|
+
value?: string | null;
|
|
633
|
+
}
|
|
634
|
+
export interface RsvpSummary {
|
|
635
|
+
/**
|
|
636
|
+
* Total number of RSVPs.
|
|
637
|
+
* @readonly
|
|
638
|
+
*/
|
|
639
|
+
totalCount?: number;
|
|
640
|
+
/**
|
|
641
|
+
* Number of RSVPs with status `YES`.
|
|
642
|
+
* @readonly
|
|
643
|
+
*/
|
|
644
|
+
yesCount?: number;
|
|
645
|
+
/**
|
|
646
|
+
* Number of RSVPs with status `NO`.
|
|
647
|
+
* @readonly
|
|
648
|
+
*/
|
|
649
|
+
noCount?: number;
|
|
650
|
+
/**
|
|
651
|
+
* Number of RSVPs in a waitlist.
|
|
652
|
+
* @readonly
|
|
653
|
+
*/
|
|
654
|
+
waitlistCount?: number;
|
|
655
|
+
}
|
|
656
|
+
export interface TicketSummary {
|
|
657
|
+
/**
|
|
658
|
+
* Number of sold tickets.
|
|
659
|
+
* @readonly
|
|
660
|
+
*/
|
|
661
|
+
soldTickets?: number;
|
|
662
|
+
/**
|
|
663
|
+
* Total revenue. Taxes and payment provider fees are not deducted.
|
|
664
|
+
* @readonly
|
|
665
|
+
*/
|
|
666
|
+
revenue?: EventsMoney;
|
|
667
|
+
/**
|
|
668
|
+
* Whether currency is locked and cannot be changed.
|
|
669
|
+
* @readonly
|
|
670
|
+
*/
|
|
671
|
+
currencyLocked?: boolean;
|
|
672
|
+
/**
|
|
673
|
+
* Number of orders placed.
|
|
674
|
+
* @readonly
|
|
675
|
+
*/
|
|
676
|
+
totalOrders?: number;
|
|
677
|
+
/**
|
|
678
|
+
* Total balance of confirmed transactions.
|
|
679
|
+
* @readonly
|
|
680
|
+
*/
|
|
681
|
+
totalSales?: EventsMoney;
|
|
682
|
+
}
|
|
683
|
+
export interface GuestListConfig {
|
|
684
|
+
/** Whether guest list is public for all guests. */
|
|
685
|
+
displayPublicly?: boolean;
|
|
686
|
+
}
|
|
687
|
+
export interface Feed {
|
|
688
|
+
/** Event discussion feed token. */
|
|
689
|
+
token?: string;
|
|
690
|
+
}
|
|
691
|
+
export interface OnlineConferencing {
|
|
692
|
+
/** Whether online conferencing is enabled. Not applicable for events, where date and time is TBD. When enabled, links to join the conference are generated and provided to guests. */
|
|
693
|
+
enabled?: boolean;
|
|
694
|
+
/** Conference host ID. */
|
|
695
|
+
providerId?: string | null;
|
|
696
|
+
/** Conference type. */
|
|
697
|
+
conferenceType?: ConferenceType;
|
|
698
|
+
/** Online conferencing session information. */
|
|
699
|
+
session?: OnlineConferencingSession;
|
|
700
|
+
}
|
|
701
|
+
export declare enum ConferenceType {
|
|
702
|
+
/** Guests can publish and subscribe to video and audio. */
|
|
703
|
+
MEETING = "MEETING",
|
|
704
|
+
/** Guests can only subscribe to video and audio. */
|
|
705
|
+
WEBINAR = "WEBINAR"
|
|
706
|
+
}
|
|
707
|
+
export interface OnlineConferencingSession {
|
|
708
|
+
/**
|
|
709
|
+
* Link for the event host to start the online conference session.
|
|
710
|
+
* @readonly
|
|
711
|
+
*/
|
|
712
|
+
hostLink?: string;
|
|
713
|
+
/**
|
|
714
|
+
* Link for guests to join the online conference session.
|
|
715
|
+
* @readonly
|
|
716
|
+
*/
|
|
717
|
+
guestLink?: string;
|
|
718
|
+
/**
|
|
719
|
+
* Password required to join online conferencing session (when relevant).
|
|
720
|
+
* @readonly
|
|
721
|
+
*/
|
|
722
|
+
password?: string | null;
|
|
723
|
+
/**
|
|
724
|
+
* Whether the session was created successfully on the event host side.
|
|
725
|
+
* @readonly
|
|
726
|
+
*/
|
|
727
|
+
sessionCreated?: boolean | null;
|
|
728
|
+
/**
|
|
729
|
+
* Unique session ID.
|
|
730
|
+
* @readonly
|
|
731
|
+
*/
|
|
732
|
+
sessionId?: string | null;
|
|
733
|
+
}
|
|
734
|
+
export interface SeoSettings {
|
|
735
|
+
/** URL slug */
|
|
736
|
+
slug?: string;
|
|
737
|
+
/** Advanced SEO data */
|
|
738
|
+
advancedSeoData?: SeoSchema;
|
|
739
|
+
/**
|
|
740
|
+
* Hidden from SEO Site Map
|
|
741
|
+
* @readonly
|
|
742
|
+
*/
|
|
743
|
+
hidden?: boolean | null;
|
|
744
|
+
}
|
|
745
|
+
/**
|
|
746
|
+
* The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.
|
|
747
|
+
* The search engines use this information for ranking purposes, or to display snippets in the search results.
|
|
748
|
+
* This data will override other sources of tags (for example patterns) and will be included in the <head> section of the HTML document, while not being displayed on the page itself.
|
|
749
|
+
*/
|
|
750
|
+
export interface SeoSchema {
|
|
751
|
+
/** SEO tag information. */
|
|
752
|
+
tags?: Tag[];
|
|
753
|
+
/** SEO general settings. */
|
|
754
|
+
settings?: Settings;
|
|
755
|
+
}
|
|
756
|
+
export interface Keyword {
|
|
757
|
+
/** Keyword value. */
|
|
758
|
+
term?: string;
|
|
759
|
+
/** Whether the keyword is the main focus keyword. */
|
|
760
|
+
isMain?: boolean;
|
|
761
|
+
}
|
|
762
|
+
export interface Tag {
|
|
763
|
+
/**
|
|
764
|
+
* SEO tag type.
|
|
765
|
+
*
|
|
766
|
+
*
|
|
767
|
+
* Supported values: `title`, `meta`, `script`, `link`.
|
|
768
|
+
*/
|
|
769
|
+
type?: string;
|
|
770
|
+
/**
|
|
771
|
+
* A `{'key':'value'}` pair object where each SEO tag property (`'name'`, `'content'`, `'rel'`, `'href'`) contains a value.
|
|
772
|
+
* For example: `{'name': 'description', 'content': 'the description itself'}`.
|
|
773
|
+
*/
|
|
774
|
+
props?: Record<string, any> | null;
|
|
775
|
+
/** SEO tag meta data. For example, `{height: 300, width: 240}`. */
|
|
776
|
+
meta?: Record<string, any> | null;
|
|
777
|
+
/** SEO tag inner content. For example, `<title> inner content </title>`. */
|
|
778
|
+
children?: string;
|
|
779
|
+
/** Whether the tag is a custom tag. */
|
|
780
|
+
custom?: boolean;
|
|
781
|
+
/** Whether the tag is disabled. */
|
|
782
|
+
disabled?: boolean;
|
|
783
|
+
}
|
|
784
|
+
export interface Settings {
|
|
785
|
+
/**
|
|
786
|
+
* Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.
|
|
787
|
+
*
|
|
788
|
+
*
|
|
789
|
+
* Default: `false` (Auto Redirect is enabled.)
|
|
790
|
+
*/
|
|
791
|
+
preventAutoRedirect?: boolean;
|
|
792
|
+
/** User-selected keyword terms for a specific page. */
|
|
793
|
+
keywords?: Keyword[];
|
|
794
|
+
}
|
|
795
|
+
export interface Agenda {
|
|
796
|
+
/** Whether the agenda is enabled for the event. */
|
|
797
|
+
enabled?: boolean;
|
|
798
|
+
/**
|
|
799
|
+
* Agenda page URL.
|
|
800
|
+
* @readonly
|
|
801
|
+
*/
|
|
802
|
+
pageUrl?: PageUrl;
|
|
803
|
+
}
|
|
804
|
+
export interface Category {
|
|
805
|
+
/**
|
|
806
|
+
* Category ID.
|
|
807
|
+
* @readonly
|
|
808
|
+
*/
|
|
809
|
+
id?: string;
|
|
810
|
+
/** Category name. */
|
|
811
|
+
name?: string;
|
|
812
|
+
/**
|
|
813
|
+
* Category creation timestamp.
|
|
814
|
+
* @readonly
|
|
815
|
+
*/
|
|
816
|
+
createdDate?: Date;
|
|
817
|
+
/**
|
|
818
|
+
* Assigned events count. Deleted events are excluded.
|
|
819
|
+
* @readonly
|
|
820
|
+
*/
|
|
821
|
+
assignedEventsCount?: number | null;
|
|
822
|
+
/** @readonly */
|
|
823
|
+
counts?: CategoryCounts;
|
|
824
|
+
/**
|
|
825
|
+
* Category state. Default - MANUAL.
|
|
826
|
+
* WIX_EVENTS.MANAGE_AUTO_CATEGORIES permission is required to use other states.
|
|
827
|
+
* Field will be ignored on update requests.
|
|
828
|
+
*/
|
|
829
|
+
states?: State[];
|
|
830
|
+
}
|
|
831
|
+
export interface CategoryCounts {
|
|
832
|
+
/** Assigned events count. Deleted events are excluded. */
|
|
833
|
+
assignedEventsCount?: number | null;
|
|
834
|
+
/** Assigned draft events count. */
|
|
835
|
+
assignedDraftEventsCount?: number | null;
|
|
836
|
+
}
|
|
837
|
+
export declare enum State {
|
|
838
|
+
/** Created manually by the user. */
|
|
839
|
+
MANUAL = "MANUAL",
|
|
840
|
+
/** Created automatically. */
|
|
841
|
+
AUTO = "AUTO",
|
|
842
|
+
/** Created when publishing recurring events. */
|
|
843
|
+
RECURRING_EVENT = "RECURRING_EVENT",
|
|
844
|
+
/** Category is hidden. */
|
|
845
|
+
HIDDEN = "HIDDEN",
|
|
846
|
+
/** Category is used to store component events. */
|
|
847
|
+
COMPONENT = "COMPONENT"
|
|
848
|
+
}
|
|
849
|
+
export interface V3EventStarted {
|
|
850
|
+
/** Event start timestamp in ISO UTC format. */
|
|
851
|
+
timestamp?: Date;
|
|
852
|
+
/** Event ID. */
|
|
853
|
+
eventId?: string;
|
|
854
|
+
}
|
|
855
|
+
export interface V3EventReminder {
|
|
856
|
+
/** Reminder timestamp in ISO UTC format. */
|
|
857
|
+
timestamp?: Date;
|
|
858
|
+
/** Event ID. */
|
|
859
|
+
eventId?: string;
|
|
860
|
+
/** Event location. */
|
|
861
|
+
location?: Location;
|
|
862
|
+
/** Event schedule configuration. */
|
|
863
|
+
scheduleConfig?: ScheduleConfig;
|
|
864
|
+
/** Event title. */
|
|
865
|
+
title?: string;
|
|
866
|
+
/** Event creator user ID. */
|
|
867
|
+
userId?: string | null;
|
|
868
|
+
/** Time until the event starts (currently, reminder is triggered 1 day before event starts). */
|
|
869
|
+
startsIn?: TimeDuration;
|
|
870
|
+
}
|
|
871
|
+
/**
|
|
872
|
+
* A coarse-grained representation of time duration divided into whole constituting components of days, hours, and minutes.
|
|
873
|
+
* For example, 25.5 hours duration is represented as `{ days: 1, hours: 1, minutes: 30 }`.
|
|
874
|
+
*/
|
|
875
|
+
export interface TimeDuration {
|
|
876
|
+
/** Number of days */
|
|
877
|
+
days?: number;
|
|
878
|
+
/** Number of hours */
|
|
879
|
+
hours?: number;
|
|
880
|
+
/** Number of minutes */
|
|
881
|
+
minutes?: number;
|
|
882
|
+
}
|
|
883
|
+
export interface V3EventEnded {
|
|
884
|
+
/** Event end timestamp in ISO UTC format. */
|
|
885
|
+
timestamp?: Date;
|
|
886
|
+
/** Event ID. */
|
|
887
|
+
eventId?: string;
|
|
888
|
+
}
|
|
889
|
+
export interface CreateEventRequest {
|
|
890
|
+
/** Event data. */
|
|
891
|
+
event: Event;
|
|
892
|
+
/** Whether event should be created as draft. Draft events are hidden from site visitors. */
|
|
893
|
+
draft?: boolean;
|
|
894
|
+
}
|
|
895
|
+
export interface CreateEventResponse {
|
|
896
|
+
/** Created event. */
|
|
897
|
+
event?: Event;
|
|
898
|
+
}
|
|
899
|
+
export interface V3EventPublished {
|
|
900
|
+
/** Event publish timestamp in ISO UTC format. */
|
|
901
|
+
timestamp?: Date;
|
|
902
|
+
/** Event ID. */
|
|
903
|
+
eventId?: string;
|
|
904
|
+
/** Event status. */
|
|
905
|
+
status?: EventStatus;
|
|
906
|
+
/**
|
|
907
|
+
* Event ID. Indicates the original event which current event was derived from.
|
|
908
|
+
* Can be used to track the original event and add missing information.
|
|
909
|
+
*/
|
|
910
|
+
derivedFromEventId?: string | null;
|
|
911
|
+
}
|
|
912
|
+
export interface CloneEventRequest {
|
|
913
|
+
/** Event ID. */
|
|
914
|
+
eventId: string;
|
|
915
|
+
/** Event data to update (partial) */
|
|
916
|
+
event?: Event;
|
|
917
|
+
/**
|
|
918
|
+
* If true, event will be copied as draft.
|
|
919
|
+
* Otherwise copied event will be published, unless it is draft.
|
|
920
|
+
*/
|
|
921
|
+
draft?: boolean;
|
|
922
|
+
}
|
|
923
|
+
export interface CloneEventResponse {
|
|
924
|
+
/** Cloned event. */
|
|
925
|
+
event?: Event;
|
|
926
|
+
}
|
|
927
|
+
export interface EventCloned {
|
|
928
|
+
/** Event created timestamp in ISO UTC format. */
|
|
929
|
+
timestamp?: Date;
|
|
930
|
+
/** Event ID. */
|
|
931
|
+
eventId?: string;
|
|
932
|
+
/** Event location. */
|
|
933
|
+
location?: Location;
|
|
934
|
+
/** Event schedule configuration. */
|
|
935
|
+
scheduleConfig?: ScheduleConfig;
|
|
936
|
+
/** Event title. */
|
|
937
|
+
title?: string;
|
|
938
|
+
/** Event creator user ID. */
|
|
939
|
+
userId?: string | null;
|
|
940
|
+
/** Event status. */
|
|
941
|
+
status?: EventStatus;
|
|
942
|
+
/** Instance ID. Indicates the original app instance which current event was derived from. */
|
|
943
|
+
derivedFromInstanceId?: string | null;
|
|
944
|
+
/** Event ID. Indicates the original event which current event was derived from. */
|
|
945
|
+
derivedFromEventId?: string | null;
|
|
946
|
+
/**
|
|
947
|
+
* Map of copied ticket definitions from original event.
|
|
948
|
+
* Key represents ticket def id in the original event.
|
|
949
|
+
* Value represents ticket def id in the newly created event.
|
|
950
|
+
*/
|
|
951
|
+
ticketDefinitions?: Record<string, string>;
|
|
952
|
+
}
|
|
953
|
+
export interface UpdateEventRequest {
|
|
954
|
+
/** Event data to update (partial) */
|
|
955
|
+
event?: Event;
|
|
956
|
+
}
|
|
957
|
+
export interface UpdateEventResponse {
|
|
958
|
+
/** Updated event. */
|
|
959
|
+
event?: Event;
|
|
960
|
+
}
|
|
961
|
+
export interface PublishDraftEventRequest {
|
|
962
|
+
/** Event ID. */
|
|
963
|
+
eventId: string;
|
|
964
|
+
}
|
|
965
|
+
export interface PublishDraftEventResponse {
|
|
966
|
+
/** Published event. */
|
|
967
|
+
event?: Event;
|
|
968
|
+
}
|
|
969
|
+
export interface CancelEventRequest {
|
|
970
|
+
/** Event ID. */
|
|
971
|
+
eventId: string;
|
|
972
|
+
}
|
|
973
|
+
export interface CancelEventResponse {
|
|
974
|
+
/** Canceled event. */
|
|
975
|
+
event?: Event;
|
|
976
|
+
}
|
|
977
|
+
export interface EventCanceled {
|
|
978
|
+
/** Event canceled timestamp in ISO UTC format. */
|
|
979
|
+
timestamp?: Date;
|
|
980
|
+
/** Event ID. */
|
|
981
|
+
eventId?: string;
|
|
982
|
+
/** Event title */
|
|
983
|
+
title?: string;
|
|
984
|
+
/** Event creator user ID. */
|
|
985
|
+
userId?: string | null;
|
|
986
|
+
}
|
|
987
|
+
export interface V3EventCanceled {
|
|
988
|
+
/** Event canceled timestamp in ISO UTC format. */
|
|
989
|
+
timestamp?: Date;
|
|
990
|
+
/** Event ID. */
|
|
991
|
+
eventId?: string;
|
|
992
|
+
/** Event title */
|
|
993
|
+
title?: string;
|
|
994
|
+
/** Event creator user ID. */
|
|
995
|
+
userId?: string | null;
|
|
996
|
+
}
|
|
997
|
+
export interface BulkCancelEventsByFilterRequest {
|
|
998
|
+
/** 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_list-query-events). */
|
|
999
|
+
filter?: QueryV2;
|
|
1000
|
+
}
|
|
1001
|
+
export interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
1002
|
+
/** Paging options to limit and skip the number of items. */
|
|
1003
|
+
paging?: Paging;
|
|
1004
|
+
/** Filter object in the following format: <br/> `"filter" : { "fieldName1": "value1", "fieldName2":{"$operator":"value2"} }`. <br/> <br/> **Example:** <br/> `"filter" : { "location.name": "Golden Valley", "title": {"$begins": "Hike"} }` <br/> <br/> See [supported fields and operators]() for more information. */
|
|
1005
|
+
filter?: Record<string, any> | null;
|
|
1006
|
+
/** Sort object in the following format: <br/> `[{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]` <br/> <br/> **Example:** <br/> `[{"fieldName":"createdDate","direction":"DESC"}]` <br/> <br/> See [supported fields]() for more information. */
|
|
1007
|
+
sort?: Sorting[];
|
|
1008
|
+
}
|
|
1009
|
+
/** @oneof */
|
|
1010
|
+
export interface QueryV2PagingMethodOneOf {
|
|
1011
|
+
/** Paging options to limit and skip the number of items. */
|
|
1012
|
+
paging?: Paging;
|
|
1013
|
+
}
|
|
1014
|
+
export interface Sorting {
|
|
1015
|
+
/** Name of the field to sort by. */
|
|
1016
|
+
fieldName?: string;
|
|
1017
|
+
/** Sort order (ASC/DESC). Defaults to ASC. */
|
|
1018
|
+
order?: SortOrder;
|
|
1019
|
+
}
|
|
1020
|
+
export declare enum SortOrder {
|
|
1021
|
+
ASC = "ASC",
|
|
1022
|
+
DESC = "DESC"
|
|
1023
|
+
}
|
|
1024
|
+
export interface Paging {
|
|
1025
|
+
/** Number of items to load. */
|
|
1026
|
+
limit?: number | null;
|
|
1027
|
+
/** Number of items to skip in the current sort order. */
|
|
1028
|
+
offset?: number | null;
|
|
1029
|
+
}
|
|
1030
|
+
export interface BulkCancelEventsByFilterResponse {
|
|
1031
|
+
}
|
|
1032
|
+
export interface DeleteEventRequest {
|
|
1033
|
+
/** Event ID. */
|
|
1034
|
+
eventId: string;
|
|
1035
|
+
}
|
|
1036
|
+
export interface DeleteEventResponse {
|
|
1037
|
+
/** Deleted event ID. */
|
|
1038
|
+
eventId?: string;
|
|
1039
|
+
}
|
|
1040
|
+
export interface BulkDeleteEventsByFilterRequest {
|
|
1041
|
+
/** Query options. See [API Query Langauge](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
|
|
1042
|
+
filter?: QueryV2;
|
|
1043
|
+
}
|
|
1044
|
+
export interface BulkDeleteEventsByFilterResponse {
|
|
1045
|
+
}
|
|
1046
|
+
export interface GetRecurringEventStateRequest {
|
|
1047
|
+
/** Recurring event category id. */
|
|
1048
|
+
categoryId?: string;
|
|
1049
|
+
}
|
|
1050
|
+
export interface GetRecurringEventStateResponse {
|
|
1051
|
+
/** Recurring event category id. */
|
|
1052
|
+
categoryId?: string | null;
|
|
1053
|
+
inconsistentState?: boolean;
|
|
1054
|
+
actual?: RecurringEventState;
|
|
1055
|
+
desired?: RecurringEventState;
|
|
1056
|
+
}
|
|
1057
|
+
export interface RecurringEventState {
|
|
1058
|
+
recurringNext?: RecurringEventDetails;
|
|
1059
|
+
recurringLastEnded?: RecurringEventDetails;
|
|
1060
|
+
recurringLastCanceled?: RecurringEventDetails;
|
|
1061
|
+
}
|
|
1062
|
+
export interface RecurringEventDetails {
|
|
1063
|
+
eventId?: string | null;
|
|
1064
|
+
/** Event slug */
|
|
1065
|
+
slug?: string | null;
|
|
1066
|
+
/** Event start timestamp. */
|
|
1067
|
+
startDate?: Date;
|
|
1068
|
+
/** Event end timestamp. */
|
|
1069
|
+
endDate?: Date;
|
|
1070
|
+
recurrenceStatus?: Status;
|
|
1071
|
+
}
|
|
1072
|
+
export interface UpdateRecurringStatusRequest {
|
|
1073
|
+
/** Recurring event category id. */
|
|
1074
|
+
categoryId?: string;
|
|
1075
|
+
}
|
|
1076
|
+
export interface UpdateRecurringStatusResponse {
|
|
1077
|
+
}
|
|
1078
|
+
export interface QueryEventsRequest {
|
|
1079
|
+
/** Query options. See [API Query Langauge](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
|
|
1080
|
+
query?: QueryV2;
|
|
1081
|
+
/**
|
|
1082
|
+
* Controls which event properties are returned. See [Fieldset](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_event-fieldset).
|
|
1083
|
+
* Some fields require additional computation that affects latency.
|
|
1084
|
+
* Use minimum set of required fieldset for best performance.
|
|
1085
|
+
*/
|
|
1086
|
+
fieldset?: EventFieldset[];
|
|
1087
|
+
/**
|
|
1088
|
+
* Filter facets to include in the response.
|
|
1089
|
+
* See [supported facets](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-events).
|
|
1090
|
+
*/
|
|
1091
|
+
facet?: string[];
|
|
1092
|
+
/**
|
|
1093
|
+
* Whether draft events should be returned in the response.
|
|
1094
|
+
* Requires WIX_EVENTS.MANAGE_EVENTS permission.
|
|
1095
|
+
*/
|
|
1096
|
+
includeDrafts?: boolean;
|
|
1097
|
+
}
|
|
1098
|
+
export declare enum EventFieldset {
|
|
1099
|
+
/** Include `description`, `mainImage` and `calendarLinks` in the response. */
|
|
1100
|
+
DETAILS = "DETAILS",
|
|
1101
|
+
/** Include `about` event rich text in the response. */
|
|
1102
|
+
TEXTS = "TEXTS",
|
|
1103
|
+
/** Include `registration` in the response. */
|
|
1104
|
+
REGISTRATION = "REGISTRATION",
|
|
1105
|
+
/** Include `eventPageUrl` in the response. */
|
|
1106
|
+
URLS = "URLS",
|
|
1107
|
+
/** Include `form` in the response. */
|
|
1108
|
+
FORM = "FORM",
|
|
1109
|
+
/** Include `dashboard` in the response. */
|
|
1110
|
+
DASHBOARD = "DASHBOARD",
|
|
1111
|
+
/** Include `feed` in the response. */
|
|
1112
|
+
FEED = "FEED",
|
|
1113
|
+
/** Include `onlineConferencing` in the response. */
|
|
1114
|
+
ONLINE_CONFERENCING_SESSION = "ONLINE_CONFERENCING_SESSION",
|
|
1115
|
+
/** Include `seoSettings` in the response. */
|
|
1116
|
+
SEO_SETTINGS = "SEO_SETTINGS",
|
|
1117
|
+
/** Include `agendaSettings` in the response. */
|
|
1118
|
+
AGENDA = "AGENDA",
|
|
1119
|
+
/** Include `categories` in the response. */
|
|
1120
|
+
CATEGORIES = "CATEGORIES"
|
|
1121
|
+
}
|
|
1122
|
+
export interface QueryEventsResponse {
|
|
1123
|
+
/** Metadata for the paginated results. */
|
|
1124
|
+
pagingMetadata?: PagingMetadataV2;
|
|
1125
|
+
/** Events list */
|
|
1126
|
+
events?: Event[];
|
|
1127
|
+
/** Filter facets. */
|
|
1128
|
+
facets?: Record<string, FacetCounts>;
|
|
1129
|
+
}
|
|
1130
|
+
export interface PagingMetadataV2 {
|
|
1131
|
+
/** Number of items returned in the response. */
|
|
1132
|
+
count?: number | null;
|
|
1133
|
+
/** Offset that was requested. */
|
|
1134
|
+
offset?: number | null;
|
|
1135
|
+
/** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
|
|
1136
|
+
total?: number | null;
|
|
1137
|
+
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
1138
|
+
tooManyToCount?: boolean | null;
|
|
1139
|
+
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
1140
|
+
cursors?: Cursors;
|
|
1141
|
+
}
|
|
1142
|
+
export interface Cursors {
|
|
1143
|
+
/** Cursor pointing to next page in the list of results. */
|
|
1144
|
+
next?: string | null;
|
|
1145
|
+
/** Cursor pointing to previous page in the list of results. */
|
|
1146
|
+
prev?: string | null;
|
|
1147
|
+
}
|
|
1148
|
+
export interface FacetCounts {
|
|
1149
|
+
/** Facet counts aggregated per value */
|
|
1150
|
+
counts?: Record<string, number>;
|
|
1151
|
+
}
|
|
1152
|
+
export interface ListUserEventsRequest {
|
|
1153
|
+
/** Paging options to limit and skip the number of items. */
|
|
1154
|
+
paging?: Paging;
|
|
1155
|
+
/**
|
|
1156
|
+
* Sort order, defaults to `"created:asc"`.
|
|
1157
|
+
* See [supported fields](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-events).
|
|
1158
|
+
*/
|
|
1159
|
+
sort?: Sorting[];
|
|
1160
|
+
/** Event status. */
|
|
1161
|
+
status?: EventStatus[];
|
|
1162
|
+
/**
|
|
1163
|
+
* Wix user filter, by default any.
|
|
1164
|
+
* Allows to filter events by user relation to the event among all wix sites.
|
|
1165
|
+
*/
|
|
1166
|
+
userFilter?: UserFilter;
|
|
1167
|
+
/**
|
|
1168
|
+
* Filter facets to include in the response.
|
|
1169
|
+
* See [supported facets](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-events).
|
|
1170
|
+
*/
|
|
1171
|
+
facet?: string[];
|
|
1172
|
+
}
|
|
1173
|
+
export interface UserFilter {
|
|
1174
|
+
/** User who is related to event */
|
|
1175
|
+
userId?: string;
|
|
1176
|
+
/** Relation of user to event */
|
|
1177
|
+
relation?: Relation[];
|
|
1178
|
+
}
|
|
1179
|
+
export declare enum Relation {
|
|
1180
|
+
/**
|
|
1181
|
+
* User is attending the event.
|
|
1182
|
+
* User has RSVP with status YES or has ordered tickets.
|
|
1183
|
+
*/
|
|
1184
|
+
ATTENDING = "ATTENDING"
|
|
1185
|
+
}
|
|
1186
|
+
export interface ListUserEventsResponse {
|
|
1187
|
+
/** Metadata for the paginated results. */
|
|
1188
|
+
pagingMetadata?: PagingMetadataV2;
|
|
1189
|
+
/** Events list. */
|
|
1190
|
+
events?: Event[];
|
|
1191
|
+
/** Filter facets. */
|
|
1192
|
+
facets?: Record<string, FacetCounts>;
|
|
1193
|
+
}
|
|
1194
|
+
export interface ListEventsByCategoryRequest {
|
|
1195
|
+
/** Category ID */
|
|
1196
|
+
categoryId: string;
|
|
1197
|
+
/** Paging options to limit and skip the number of items. */
|
|
1198
|
+
paging?: Paging;
|
|
1199
|
+
/**
|
|
1200
|
+
* Controls which event properties are returned. See [Fieldset](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_event-fieldset).
|
|
1201
|
+
* Some fields require additional computation that affects latency of the service.
|
|
1202
|
+
* Use minimum set of required fieldset for best performance.
|
|
1203
|
+
*/
|
|
1204
|
+
fieldset?: EventFieldset[];
|
|
1205
|
+
}
|
|
1206
|
+
export interface ListEventsByCategoryResponse {
|
|
1207
|
+
/** Metadata for the paginated results. */
|
|
1208
|
+
pagingMetadata?: PagingMetadataV2;
|
|
1209
|
+
/** Events list. */
|
|
1210
|
+
events?: Event[];
|
|
1211
|
+
}
|
|
1212
|
+
export interface GetEventRequest {
|
|
1213
|
+
/** Event ID. */
|
|
1214
|
+
eventId: string | null;
|
|
1215
|
+
/**
|
|
1216
|
+
* Controls which event properties are returned. See [Fieldset](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_event-fieldset).
|
|
1217
|
+
* Some fields require additional computation that affects latency.
|
|
1218
|
+
* Use minimum set of required fieldset for best performance.
|
|
1219
|
+
*/
|
|
1220
|
+
fieldset?: EventFieldset[];
|
|
1221
|
+
}
|
|
1222
|
+
export interface GetEventResponse {
|
|
1223
|
+
/** Event. */
|
|
1224
|
+
event?: Event;
|
|
1225
|
+
}
|
|
1226
|
+
export interface GetEventBySlugRequest {
|
|
1227
|
+
/** URL slug. */
|
|
1228
|
+
slug: string | null;
|
|
1229
|
+
/**
|
|
1230
|
+
* Controls which event properties are returned. See [Fieldset](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_event-fieldset).
|
|
1231
|
+
* Some fields require additional computation that affects latency.
|
|
1232
|
+
* Use minimum set of required fieldset for best performance.
|
|
1233
|
+
*/
|
|
1234
|
+
fieldset?: EventFieldset[];
|
|
1235
|
+
}
|
|
1236
|
+
export interface GetEventBySlugResponse {
|
|
1237
|
+
/** Event. */
|
|
1238
|
+
event?: Event;
|
|
1239
|
+
}
|
|
1240
|
+
export interface FindEventRequest extends FindEventRequestFindByOneOf {
|
|
1241
|
+
/** Event ID. */
|
|
1242
|
+
eventId?: string | null;
|
|
1243
|
+
/** URL slug. */
|
|
1244
|
+
slug?: string | null;
|
|
1245
|
+
/**
|
|
1246
|
+
* Controls which event properties are returned. See [Fieldset](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_event-fieldset).
|
|
1247
|
+
* Some fields require additional computation that affects latency.
|
|
1248
|
+
* Use minimum set of required fieldset for best performance.
|
|
1249
|
+
*/
|
|
1250
|
+
fieldset?: EventFieldset[];
|
|
1251
|
+
}
|
|
1252
|
+
/** @oneof */
|
|
1253
|
+
export interface FindEventRequestFindByOneOf {
|
|
1254
|
+
/** Event ID. */
|
|
1255
|
+
eventId?: string | null;
|
|
1256
|
+
/** URL slug. */
|
|
1257
|
+
slug?: string | null;
|
|
1258
|
+
}
|
|
1259
|
+
export interface FindEventResponse {
|
|
1260
|
+
/** Event. */
|
|
1261
|
+
event?: Event;
|
|
1262
|
+
}
|
|
1263
|
+
export interface EventDeleted {
|
|
1264
|
+
/** Event deleted timestamp in ISO UTC format. */
|
|
1265
|
+
timestamp?: Date;
|
|
1266
|
+
/** Event ID. */
|
|
1267
|
+
eventId?: string;
|
|
1268
|
+
/** Event title. */
|
|
1269
|
+
title?: string;
|
|
1270
|
+
/** Event creator user ID. */
|
|
1271
|
+
userId?: string | null;
|
|
1272
|
+
}
|
|
1273
|
+
export interface Empty {
|
|
1274
|
+
}
|
|
1275
|
+
export interface EventCopied {
|
|
1276
|
+
/** Event created timestamp in ISO UTC format. */
|
|
1277
|
+
timestamp?: Date;
|
|
1278
|
+
/** Event ID. */
|
|
1279
|
+
eventId?: string;
|
|
1280
|
+
/** Event location. */
|
|
1281
|
+
location?: EventsLocation;
|
|
1282
|
+
/** Event schedule configuration. */
|
|
1283
|
+
scheduleConfig?: EventsScheduleConfig;
|
|
1284
|
+
/** Event title. */
|
|
1285
|
+
title?: string;
|
|
1286
|
+
/** Event creator user ID. */
|
|
1287
|
+
userId?: string | null;
|
|
1288
|
+
/** Event status. */
|
|
1289
|
+
status?: EventsEventStatus;
|
|
1290
|
+
/** Instance ID. Indicates the original app instance which current event was derived from. */
|
|
1291
|
+
derivedFromInstanceId?: string | null;
|
|
1292
|
+
/** Event ID. Indicates the original event which current event was derived from. */
|
|
1293
|
+
derivedFromEventId?: string | null;
|
|
1294
|
+
/**
|
|
1295
|
+
* Map of copied ticket definitions from original event.
|
|
1296
|
+
* Key represents ticket def id in the original event.
|
|
1297
|
+
* Value represents ticket def id in the newly created event.
|
|
1298
|
+
*/
|
|
1299
|
+
ticketDefinitions?: Record<string, string>;
|
|
1300
|
+
}
|
|
1301
|
+
export interface EventsLocation {
|
|
1302
|
+
/** Location name. */
|
|
1303
|
+
name?: string | null;
|
|
1304
|
+
/** Location map coordinates. */
|
|
1305
|
+
coordinates?: MapCoordinates;
|
|
1306
|
+
/** Single line address representation. */
|
|
1307
|
+
address?: string | null;
|
|
1308
|
+
/** Location type. */
|
|
1309
|
+
type?: LocationLocationType;
|
|
1310
|
+
/**
|
|
1311
|
+
* Full address derived from formatted single line `address`.
|
|
1312
|
+
* When `full_address` is used to create or update the event, deprecated `address` and `coordinates` are ignored.
|
|
1313
|
+
* If provided `full_address` has empty `formatted_address` or `coordinates`, it will be auto-completed using Atlas service.
|
|
1314
|
+
*
|
|
1315
|
+
* Migration notes:
|
|
1316
|
+
* - `full_address.formatted_address` is equivalent to `address`.
|
|
1317
|
+
* - `full_address.geocode` is equivalent to `coordinates`.
|
|
1318
|
+
*/
|
|
1319
|
+
fullAddress?: Address;
|
|
1320
|
+
/**
|
|
1321
|
+
* Defines event location as TBD (To Be Determined).
|
|
1322
|
+
* When event location is not yet defined, `name` is displayed instead of location address.
|
|
1323
|
+
* `coordinates`, `address`, `type` and `full_address` are not required when location is TBD.
|
|
1324
|
+
*/
|
|
1325
|
+
tbd?: boolean | null;
|
|
1326
|
+
}
|
|
1327
|
+
export interface MapCoordinates {
|
|
1328
|
+
/** Latitude. */
|
|
1329
|
+
lat?: number;
|
|
1330
|
+
/** Longitude. */
|
|
1331
|
+
lng?: number;
|
|
1332
|
+
}
|
|
1333
|
+
export declare enum LocationLocationType {
|
|
1334
|
+
VENUE = "VENUE",
|
|
1335
|
+
ONLINE = "ONLINE"
|
|
1336
|
+
}
|
|
1337
|
+
/** Physical address */
|
|
1338
|
+
export interface Address extends AddressStreetOneOf {
|
|
1339
|
+
/** a break down of the street to number and street name */
|
|
1340
|
+
streetAddress?: StreetAddress;
|
|
1341
|
+
/** Main address line (usually street and number) as free text */
|
|
1342
|
+
addressLine?: string | null;
|
|
1343
|
+
/** country code */
|
|
1344
|
+
country?: string | null;
|
|
1345
|
+
/** subdivision (usually state or region) code according to ISO 3166-2 */
|
|
1346
|
+
subdivision?: string | null;
|
|
1347
|
+
/** city name */
|
|
1348
|
+
city?: string | null;
|
|
1349
|
+
/** zip/postal code */
|
|
1350
|
+
postalCode?: string | null;
|
|
1351
|
+
/** Free text providing more detailed address info. Usually contains Apt, Suite, Floor */
|
|
1352
|
+
addressLine2?: string | null;
|
|
1353
|
+
/** A string containing the human-readable address of this location */
|
|
1354
|
+
formattedAddress?: string | null;
|
|
1355
|
+
/** Free text for human-to-human textual orientation aid purposes */
|
|
1356
|
+
hint?: string | null;
|
|
1357
|
+
/** coordinates of the physical address */
|
|
1358
|
+
geocode?: AddressLocation;
|
|
1359
|
+
/** country full-name */
|
|
1360
|
+
countryFullname?: string | null;
|
|
1361
|
+
/** multi-level subdivisions from top to bottom */
|
|
1362
|
+
subdivisions?: Subdivision[];
|
|
1363
|
+
}
|
|
1364
|
+
/** @oneof */
|
|
1365
|
+
export interface AddressStreetOneOf {
|
|
1366
|
+
/** a break down of the street to number and street name */
|
|
1367
|
+
streetAddress?: StreetAddress;
|
|
1368
|
+
/** Main address line (usually street and number) as free text */
|
|
1369
|
+
addressLine?: string | null;
|
|
1370
|
+
}
|
|
1371
|
+
export interface StreetAddress {
|
|
1372
|
+
/** street number */
|
|
1373
|
+
number?: string;
|
|
1374
|
+
/** street name */
|
|
1375
|
+
name?: string;
|
|
1376
|
+
}
|
|
1377
|
+
export interface AddressLocation {
|
|
1378
|
+
latitude?: number | null;
|
|
1379
|
+
longitude?: number | null;
|
|
1380
|
+
}
|
|
1381
|
+
export interface Subdivision {
|
|
1382
|
+
/** subdivision short code */
|
|
1383
|
+
code?: string;
|
|
1384
|
+
/** subdivision full-name */
|
|
1385
|
+
name?: string;
|
|
1386
|
+
}
|
|
1387
|
+
export declare enum SubdivisionType {
|
|
1388
|
+
UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
|
|
1389
|
+
/** State */
|
|
1390
|
+
ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
|
|
1391
|
+
/** County */
|
|
1392
|
+
ADMINISTRATIVE_AREA_LEVEL_2 = "ADMINISTRATIVE_AREA_LEVEL_2",
|
|
1393
|
+
/** City/town */
|
|
1394
|
+
ADMINISTRATIVE_AREA_LEVEL_3 = "ADMINISTRATIVE_AREA_LEVEL_3",
|
|
1395
|
+
/** Neighborhood/quarter */
|
|
1396
|
+
ADMINISTRATIVE_AREA_LEVEL_4 = "ADMINISTRATIVE_AREA_LEVEL_4",
|
|
1397
|
+
/** Street/block */
|
|
1398
|
+
ADMINISTRATIVE_AREA_LEVEL_5 = "ADMINISTRATIVE_AREA_LEVEL_5",
|
|
1399
|
+
/** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
|
|
1400
|
+
COUNTRY = "COUNTRY"
|
|
1401
|
+
}
|
|
1402
|
+
export interface EventsScheduleConfig {
|
|
1403
|
+
/**
|
|
1404
|
+
* Defines event as TBD (To Be Determined) schedule.
|
|
1405
|
+
* When event time is not yet defined, TBD message is displayed instead of event start and end times.
|
|
1406
|
+
* `startDate`, `endDate` and `timeZoneId` are not required when schedule is TBD.
|
|
1407
|
+
*/
|
|
1408
|
+
scheduleTbd?: boolean;
|
|
1409
|
+
/** TBD message. */
|
|
1410
|
+
scheduleTbdMessage?: string | null;
|
|
1411
|
+
/** Event start timestamp. */
|
|
1412
|
+
startDate?: Date;
|
|
1413
|
+
/** Event end timestamp. */
|
|
1414
|
+
endDate?: Date;
|
|
1415
|
+
/** Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`. */
|
|
1416
|
+
timeZoneId?: string | null;
|
|
1417
|
+
/** Whether end date is hidden in the formatted schedule. */
|
|
1418
|
+
endDateHidden?: boolean;
|
|
1419
|
+
/** Whether time zone is displayed in formatted schedule. */
|
|
1420
|
+
showTimeZone?: boolean;
|
|
1421
|
+
/** Event recurrences. */
|
|
1422
|
+
recurrences?: EventsRecurrences;
|
|
1423
|
+
}
|
|
1424
|
+
export interface EventsRecurrences {
|
|
1425
|
+
/** Event occurrences. */
|
|
1426
|
+
occurrences?: EventsOccurrence[];
|
|
1427
|
+
/**
|
|
1428
|
+
* Recurring event category ID.
|
|
1429
|
+
* @readonly
|
|
1430
|
+
*/
|
|
1431
|
+
categoryId?: string | null;
|
|
1432
|
+
/**
|
|
1433
|
+
* Recurrence status.
|
|
1434
|
+
* @readonly
|
|
1435
|
+
*/
|
|
1436
|
+
status?: RecurrenceStatusStatus;
|
|
1437
|
+
}
|
|
1438
|
+
export interface EventsOccurrence {
|
|
1439
|
+
/** Event start timestamp. */
|
|
1440
|
+
startDate?: Date;
|
|
1441
|
+
/** Event end timestamp. */
|
|
1442
|
+
endDate?: Date;
|
|
1443
|
+
/** Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`. */
|
|
1444
|
+
timeZoneId?: string | null;
|
|
1445
|
+
/** Whether time zone is displayed in formatted schedule. */
|
|
1446
|
+
showTimeZone?: boolean;
|
|
1447
|
+
}
|
|
1448
|
+
export declare enum RecurrenceStatusStatus {
|
|
1449
|
+
/** Event occurs only once. */
|
|
1450
|
+
ONE_TIME = "ONE_TIME",
|
|
1451
|
+
/** Event is recurring. */
|
|
1452
|
+
RECURRING = "RECURRING",
|
|
1453
|
+
/** Marks the next upcoming occurrence of the recurring event. */
|
|
1454
|
+
RECURRING_NEXT = "RECURRING_NEXT",
|
|
1455
|
+
/** Marks the most recent ended occurrence of the recurring event. */
|
|
1456
|
+
RECURRING_LAST_ENDED = "RECURRING_LAST_ENDED",
|
|
1457
|
+
/** Marks the most recent canceled occurrence of the recurring event. */
|
|
1458
|
+
RECURRING_LAST_CANCELED = "RECURRING_LAST_CANCELED"
|
|
1459
|
+
}
|
|
1460
|
+
export declare enum EventsEventStatus {
|
|
1461
|
+
/** Event is public and scheduled to start */
|
|
1462
|
+
SCHEDULED = "SCHEDULED",
|
|
1463
|
+
/** Event has started */
|
|
1464
|
+
STARTED = "STARTED",
|
|
1465
|
+
/** Event has ended */
|
|
1466
|
+
ENDED = "ENDED",
|
|
1467
|
+
/** Event was canceled */
|
|
1468
|
+
CANCELED = "CANCELED",
|
|
1469
|
+
/** Event is not public and needs to be published */
|
|
1470
|
+
DRAFT = "DRAFT"
|
|
1471
|
+
}
|
|
1472
|
+
export interface EventPublished {
|
|
1473
|
+
/** Event publish timestamp in ISO UTC format. */
|
|
1474
|
+
timestamp?: Date;
|
|
1475
|
+
/** Event ID. */
|
|
1476
|
+
eventId?: string;
|
|
1477
|
+
/** Event status. */
|
|
1478
|
+
status?: EventsEventStatus;
|
|
1479
|
+
/**
|
|
1480
|
+
* Event ID. Indicates the original event which current event was derived from.
|
|
1481
|
+
* Can be used to track the original event and add missing information.
|
|
1482
|
+
*/
|
|
1483
|
+
derivedFromEventId?: string | null;
|
|
1484
|
+
}
|
|
1485
|
+
export interface EventStarted {
|
|
1486
|
+
/** Event start timestamp in ISO UTC format. */
|
|
1487
|
+
timestamp?: Date;
|
|
1488
|
+
/** Event ID. */
|
|
1489
|
+
eventId?: string;
|
|
1490
|
+
}
|
|
1491
|
+
export interface EventEnded {
|
|
1492
|
+
/** Event end timestamp in ISO UTC format. */
|
|
1493
|
+
timestamp?: Date;
|
|
1494
|
+
/** Event ID. */
|
|
1495
|
+
eventId?: string;
|
|
1496
|
+
}
|
|
1497
|
+
export interface EventReminder {
|
|
1498
|
+
/** Reminder timestamp in ISO UTC format. */
|
|
1499
|
+
timestamp?: Date;
|
|
1500
|
+
/** Event ID. */
|
|
1501
|
+
eventId?: string;
|
|
1502
|
+
/** Event location. */
|
|
1503
|
+
location?: EventsLocation;
|
|
1504
|
+
/** Event schedule configuration. */
|
|
1505
|
+
scheduleConfig?: EventsScheduleConfig;
|
|
1506
|
+
/** Event title. */
|
|
1507
|
+
title?: string;
|
|
1508
|
+
/** Event creator user ID. */
|
|
1509
|
+
userId?: string | null;
|
|
1510
|
+
/** Time until the event starts (currently, reminder is triggered 1 day before event starts). */
|
|
1511
|
+
startsIn?: TimeDuration;
|
|
1512
|
+
}
|