@wix/events 1.0.146 → 1.0.148
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 +7 -1
- package/build/cjs/index.js +8 -2
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +7 -1
- package/build/cjs/index.typings.js +8 -2
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +7 -1
- package/build/cjs/meta.js +8 -2
- package/build/cjs/meta.js.map +1 -1
- package/build/cjs/src/events-guests-v1-guest.http.d.ts +23 -0
- package/build/cjs/src/events-guests-v1-guest.http.js +116 -0
- package/build/cjs/src/events-guests-v1-guest.http.js.map +1 -0
- package/build/cjs/src/events-guests-v1-guest.meta.d.ts +13 -0
- package/build/cjs/src/events-guests-v1-guest.meta.js +47 -0
- package/build/cjs/src/events-guests-v1-guest.meta.js.map +1 -0
- package/build/cjs/src/events-guests-v1-guest.public.d.ts +7 -0
- package/build/cjs/src/events-guests-v1-guest.public.js +24 -0
- package/build/cjs/src/events-guests-v1-guest.public.js.map +1 -0
- package/build/cjs/src/events-guests-v1-guest.types.d.ts +867 -0
- package/build/cjs/src/events-guests-v1-guest.types.js +105 -0
- package/build/cjs/src/events-guests-v1-guest.types.js.map +1 -0
- package/build/cjs/src/events-guests-v1-guest.universal.d.ts +931 -0
- package/build/cjs/src/events-guests-v1-guest.universal.js +241 -0
- package/build/cjs/src/events-guests-v1-guest.universal.js.map +1 -0
- package/build/cjs/src/events-v1-order-checkout.http.d.ts +89 -0
- package/build/cjs/src/events-v1-order-checkout.http.js +1073 -0
- package/build/cjs/src/events-v1-order-checkout.http.js.map +1 -0
- package/build/cjs/src/events-v1-order-checkout.meta.d.ts +26 -0
- package/build/cjs/src/events-v1-order-checkout.meta.js +180 -0
- package/build/cjs/src/events-v1-order-checkout.meta.js.map +1 -0
- package/build/cjs/src/events-v1-order-checkout.public.d.ts +15 -0
- package/build/cjs/src/events-v1-order-checkout.public.js +69 -0
- package/build/cjs/src/events-v1-order-checkout.public.js.map +1 -0
- package/build/cjs/src/events-v1-order-checkout.types.d.ts +3626 -0
- package/build/cjs/src/events-v1-order-checkout.types.js +145 -0
- package/build/cjs/src/events-v1-order-checkout.types.js.map +1 -0
- package/build/cjs/src/events-v1-order-checkout.universal.d.ts +3645 -0
- package/build/cjs/src/events-v1-order-checkout.universal.js +824 -0
- package/build/cjs/src/events-v1-order-checkout.universal.js.map +1 -0
- package/build/cjs/src/events-v1-order-orders.http.d.ts +121 -0
- package/build/cjs/src/events-v1-order-orders.http.js +1105 -0
- package/build/cjs/src/events-v1-order-orders.http.js.map +1 -0
- package/build/cjs/src/events-v1-order-orders.meta.d.ts +28 -0
- package/build/cjs/src/events-v1-order-orders.meta.js +142 -0
- package/build/cjs/src/events-v1-order-orders.meta.js.map +1 -0
- package/build/cjs/src/events-v1-order-orders.public.d.ts +220 -0
- package/build/cjs/src/events-v1-order-orders.public.js +57 -0
- package/build/cjs/src/events-v1-order-orders.public.js.map +1 -0
- package/build/cjs/src/events-v1-order-orders.types.d.ts +3626 -0
- package/build/cjs/src/events-v1-order-orders.types.js +145 -0
- package/build/cjs/src/events-v1-order-orders.types.js.map +1 -0
- package/build/cjs/src/events-v1-order-orders.universal.d.ts +3615 -0
- package/build/cjs/src/events-v1-order-orders.universal.js +679 -0
- package/build/cjs/src/events-v1-order-orders.universal.js.map +1 -0
- package/build/cjs/src/events-v1-ticket-definition.http.d.ts +50 -0
- package/build/cjs/src/events-v1-ticket-definition.http.js +413 -0
- package/build/cjs/src/events-v1-ticket-definition.http.js.map +1 -0
- package/build/cjs/src/events-v1-ticket-definition.meta.d.ts +23 -0
- package/build/cjs/src/{events-v3-ticket-definition.meta.js → events-v1-ticket-definition.meta.js} +42 -42
- package/build/cjs/src/events-v1-ticket-definition.meta.js.map +1 -0
- package/build/cjs/src/events-v1-ticket-definition.public.d.ts +61 -0
- package/build/cjs/src/events-v1-ticket-definition.public.js +57 -0
- package/build/cjs/src/events-v1-ticket-definition.public.js.map +1 -0
- package/build/cjs/src/events-v1-ticket-definition.types.d.ts +725 -0
- package/build/cjs/src/events-v1-ticket-definition.types.js +63 -0
- package/build/cjs/src/events-v1-ticket-definition.types.js.map +1 -0
- package/build/cjs/src/events-v1-ticket-definition.universal.d.ts +960 -0
- package/build/cjs/src/events-v1-ticket-definition.universal.js +618 -0
- package/build/cjs/src/events-v1-ticket-definition.universal.js.map +1 -0
- package/build/cjs/src/events-v1-ticket.http.d.ts +44 -0
- package/build/cjs/src/events-v1-ticket.http.js +570 -0
- package/build/cjs/src/events-v1-ticket.http.js.map +1 -0
- package/build/cjs/src/events-v1-ticket.meta.d.ts +28 -0
- package/build/cjs/src/events-v1-ticket.meta.js +142 -0
- package/build/cjs/src/events-v1-ticket.meta.js.map +1 -0
- package/build/cjs/src/events-v1-ticket.public.d.ts +45 -0
- package/build/cjs/src/events-v1-ticket.public.js +48 -0
- package/build/cjs/src/events-v1-ticket.public.js.map +1 -0
- package/build/cjs/src/events-v1-ticket.types.d.ts +791 -0
- package/build/cjs/src/events-v1-ticket.types.js +76 -0
- package/build/cjs/src/events-v1-ticket.types.js.map +1 -0
- package/build/cjs/src/events-v1-ticket.universal.d.ts +892 -0
- package/build/cjs/src/events-v1-ticket.universal.js +621 -0
- package/build/cjs/src/events-v1-ticket.universal.js.map +1 -0
- package/build/cjs/src/events-v2-policy.http.d.ts +80 -0
- package/build/cjs/src/events-v2-policy.http.js +308 -0
- package/build/cjs/src/events-v2-policy.http.js.map +1 -0
- package/build/cjs/src/events-v2-policy.meta.d.ts +24 -0
- package/build/cjs/src/events-v2-policy.meta.js +142 -0
- package/build/cjs/src/events-v2-policy.meta.js.map +1 -0
- package/build/cjs/src/events-v2-policy.public.d.ts +25 -0
- package/build/cjs/src/events-v2-policy.public.js +48 -0
- package/build/cjs/src/events-v2-policy.public.js.map +1 -0
- package/build/cjs/src/events-v2-policy.types.d.ts +472 -0
- package/build/cjs/src/events-v2-policy.types.js +56 -0
- package/build/cjs/src/events-v2-policy.types.js.map +1 -0
- package/build/cjs/src/events-v2-policy.universal.d.ts +721 -0
- package/build/cjs/src/events-v2-policy.universal.js +539 -0
- package/build/cjs/src/events-v2-policy.universal.js.map +1 -0
- package/build/cjs/src/events-v3-event.http.d.ts +69 -0
- package/build/cjs/src/events-v3-event.http.js +661 -0
- package/build/cjs/src/events-v3-event.http.js.map +1 -0
- package/build/cjs/src/events-v3-event.meta.d.ts +39 -0
- package/build/cjs/src/events-v3-event.meta.js +275 -0
- package/build/cjs/src/events-v3-event.meta.js.map +1 -0
- package/build/cjs/src/events-v3-event.public.d.ts +566 -0
- package/build/cjs/src/events-v3-event.public.js +106 -0
- package/build/cjs/src/events-v3-event.public.js.map +1 -0
- package/build/cjs/src/events-v3-event.types.d.ts +3678 -0
- package/build/cjs/src/events-v3-event.types.js +261 -0
- package/build/cjs/src/events-v3-event.types.js.map +1 -0
- package/build/cjs/src/events-v3-event.universal.d.ts +3846 -0
- package/build/cjs/src/events-v3-event.universal.js +1165 -0
- package/build/cjs/src/events-v3-event.universal.js.map +1 -0
- package/build/es/index.d.ts +7 -1
- package/build/es/index.js +7 -1
- package/build/es/index.js.map +1 -1
- package/build/es/index.typings.d.ts +7 -1
- package/build/es/index.typings.js +7 -1
- package/build/es/index.typings.js.map +1 -1
- package/build/es/meta.d.ts +7 -1
- package/build/es/meta.js +7 -1
- package/build/es/meta.js.map +1 -1
- package/build/es/src/events-guests-v1-guest.http.d.ts +23 -0
- package/build/es/src/events-guests-v1-guest.http.js +112 -0
- package/build/es/src/events-guests-v1-guest.http.js.map +1 -0
- package/build/es/src/events-guests-v1-guest.meta.d.ts +13 -0
- package/build/es/src/events-guests-v1-guest.meta.js +20 -0
- package/build/es/src/events-guests-v1-guest.meta.js.map +1 -0
- package/build/es/src/events-guests-v1-guest.public.d.ts +7 -0
- package/build/es/src/events-guests-v1-guest.public.js +9 -0
- package/build/es/src/events-guests-v1-guest.public.js.map +1 -0
- package/build/es/src/events-guests-v1-guest.types.d.ts +867 -0
- package/build/es/src/events-guests-v1-guest.types.js +102 -0
- package/build/es/src/events-guests-v1-guest.types.js.map +1 -0
- package/build/es/src/events-guests-v1-guest.universal.d.ts +931 -0
- package/build/es/src/events-guests-v1-guest.universal.js +214 -0
- package/build/es/src/events-guests-v1-guest.universal.js.map +1 -0
- package/build/es/src/events-v1-order-checkout.http.d.ts +89 -0
- package/build/es/src/events-v1-order-checkout.http.js +1056 -0
- package/build/es/src/events-v1-order-checkout.http.js.map +1 -0
- package/build/es/src/events-v1-order-checkout.meta.d.ts +26 -0
- package/build/es/src/events-v1-order-checkout.meta.js +146 -0
- package/build/es/src/events-v1-order-checkout.meta.js.map +1 -0
- package/build/es/src/events-v1-order-checkout.public.d.ts +15 -0
- package/build/es/src/events-v1-order-checkout.public.js +44 -0
- package/build/es/src/events-v1-order-checkout.public.js.map +1 -0
- package/build/es/src/events-v1-order-checkout.types.d.ts +3626 -0
- package/build/es/src/events-v1-order-checkout.types.js +142 -0
- package/build/es/src/events-v1-order-checkout.types.js.map +1 -0
- package/build/es/src/events-v1-order-checkout.universal.d.ts +3645 -0
- package/build/es/src/events-v1-order-checkout.universal.js +790 -0
- package/build/es/src/events-v1-order-checkout.universal.js.map +1 -0
- package/build/es/src/events-v1-order-orders.http.d.ts +121 -0
- package/build/es/src/events-v1-order-orders.http.js +1088 -0
- package/build/es/src/events-v1-order-orders.http.js.map +1 -0
- package/build/es/src/events-v1-order-orders.meta.d.ts +28 -0
- package/build/es/src/events-v1-order-orders.meta.js +110 -0
- package/build/es/src/events-v1-order-orders.meta.js.map +1 -0
- package/build/es/src/events-v1-order-orders.public.d.ts +220 -0
- package/build/es/src/events-v1-order-orders.public.js +34 -0
- package/build/es/src/events-v1-order-orders.public.js.map +1 -0
- package/build/es/src/events-v1-order-orders.types.d.ts +3626 -0
- package/build/es/src/events-v1-order-orders.types.js +142 -0
- package/build/es/src/events-v1-order-orders.types.js.map +1 -0
- package/build/es/src/events-v1-order-orders.universal.d.ts +3615 -0
- package/build/es/src/events-v1-order-orders.universal.js +647 -0
- package/build/es/src/events-v1-order-orders.universal.js.map +1 -0
- package/build/es/src/events-v1-ticket-definition.http.d.ts +50 -0
- package/build/es/src/events-v1-ticket-definition.http.js +403 -0
- package/build/es/src/events-v1-ticket-definition.http.js.map +1 -0
- package/build/es/src/events-v1-ticket-definition.meta.d.ts +23 -0
- package/build/es/src/{events-v3-ticket-definition.meta.js → events-v1-ticket-definition.meta.js} +35 -35
- package/build/es/src/events-v1-ticket-definition.meta.js.map +1 -0
- package/build/es/src/events-v1-ticket-definition.public.d.ts +61 -0
- package/build/es/src/events-v1-ticket-definition.public.js +39 -0
- package/build/es/src/events-v1-ticket-definition.public.js.map +1 -0
- package/build/es/src/events-v1-ticket-definition.types.d.ts +725 -0
- package/build/es/src/events-v1-ticket-definition.types.js +60 -0
- package/build/es/src/events-v1-ticket-definition.types.js.map +1 -0
- package/build/es/src/events-v1-ticket-definition.universal.d.ts +960 -0
- package/build/es/src/events-v1-ticket-definition.universal.js +585 -0
- package/build/es/src/events-v1-ticket-definition.universal.js.map +1 -0
- package/build/es/src/events-v1-ticket.http.d.ts +44 -0
- package/build/es/src/events-v1-ticket.http.js +561 -0
- package/build/es/src/events-v1-ticket.http.js.map +1 -0
- package/build/es/src/events-v1-ticket.meta.d.ts +28 -0
- package/build/es/src/events-v1-ticket.meta.js +110 -0
- package/build/es/src/events-v1-ticket.meta.js.map +1 -0
- package/build/es/src/events-v1-ticket.public.d.ts +45 -0
- package/build/es/src/events-v1-ticket.public.js +34 -0
- package/build/es/src/events-v1-ticket.public.js.map +1 -0
- package/build/es/src/events-v1-ticket.types.d.ts +791 -0
- package/build/es/src/events-v1-ticket.types.js +73 -0
- package/build/es/src/events-v1-ticket.types.js.map +1 -0
- package/build/es/src/events-v1-ticket.universal.d.ts +892 -0
- package/build/es/src/events-v1-ticket.universal.js +589 -0
- package/build/es/src/events-v1-ticket.universal.js.map +1 -0
- package/build/es/src/events-v2-policy.http.d.ts +80 -0
- package/build/es/src/events-v2-policy.http.js +299 -0
- package/build/es/src/events-v2-policy.http.js.map +1 -0
- package/build/es/src/events-v2-policy.meta.d.ts +24 -0
- package/build/es/src/events-v2-policy.meta.js +110 -0
- package/build/es/src/events-v2-policy.meta.js.map +1 -0
- package/build/es/src/events-v2-policy.public.d.ts +25 -0
- package/build/es/src/events-v2-policy.public.js +34 -0
- package/build/es/src/events-v2-policy.public.js.map +1 -0
- package/build/es/src/events-v2-policy.types.d.ts +472 -0
- package/build/es/src/events-v2-policy.types.js +53 -0
- package/build/es/src/events-v2-policy.types.js.map +1 -0
- package/build/es/src/events-v2-policy.universal.d.ts +721 -0
- package/build/es/src/events-v2-policy.universal.js +507 -0
- package/build/es/src/events-v2-policy.universal.js.map +1 -0
- package/build/es/src/events-v3-event.http.d.ts +69 -0
- package/build/es/src/events-v3-event.http.js +645 -0
- package/build/es/src/events-v3-event.http.js.map +1 -0
- package/build/es/src/events-v3-event.meta.d.ts +39 -0
- package/build/es/src/events-v3-event.meta.js +236 -0
- package/build/es/src/events-v3-event.meta.js.map +1 -0
- package/build/es/src/events-v3-event.public.d.ts +566 -0
- package/build/es/src/events-v3-event.public.js +69 -0
- package/build/es/src/events-v3-event.public.js.map +1 -0
- package/build/es/src/events-v3-event.types.d.ts +3678 -0
- package/build/es/src/events-v3-event.types.js +258 -0
- package/build/es/src/events-v3-event.types.js.map +1 -0
- package/build/es/src/events-v3-event.universal.d.ts +3846 -0
- package/build/es/src/events-v3-event.universal.js +1126 -0
- package/build/es/src/events-v3-event.universal.js.map +1 -0
- package/package.json +2 -2
- package/build/cjs/src/events-v3-ticket-definition.http.d.ts +0 -33
- package/build/cjs/src/events-v3-ticket-definition.http.js +0 -271
- package/build/cjs/src/events-v3-ticket-definition.http.js.map +0 -1
- package/build/cjs/src/events-v3-ticket-definition.meta.d.ts +0 -25
- package/build/cjs/src/events-v3-ticket-definition.meta.js.map +0 -1
- package/build/cjs/src/events-v3-ticket-definition.public.d.ts +0 -98
- package/build/cjs/src/events-v3-ticket-definition.public.js +0 -63
- package/build/cjs/src/events-v3-ticket-definition.public.js.map +0 -1
- package/build/cjs/src/events-v3-ticket-definition.types.d.ts +0 -1265
- package/build/cjs/src/events-v3-ticket-definition.types.js +0 -195
- package/build/cjs/src/events-v3-ticket-definition.types.js.map +0 -1
- package/build/cjs/src/events-v3-ticket-definition.universal.d.ts +0 -1449
- package/build/cjs/src/events-v3-ticket-definition.universal.js +0 -698
- package/build/cjs/src/events-v3-ticket-definition.universal.js.map +0 -1
- package/build/es/src/events-v3-ticket-definition.http.d.ts +0 -33
- package/build/es/src/events-v3-ticket-definition.http.js +0 -261
- package/build/es/src/events-v3-ticket-definition.http.js.map +0 -1
- package/build/es/src/events-v3-ticket-definition.meta.d.ts +0 -25
- package/build/es/src/events-v3-ticket-definition.meta.js.map +0 -1
- package/build/es/src/events-v3-ticket-definition.public.d.ts +0 -98
- package/build/es/src/events-v3-ticket-definition.public.js +0 -39
- package/build/es/src/events-v3-ticket-definition.public.js.map +0 -1
- package/build/es/src/events-v3-ticket-definition.types.d.ts +0 -1265
- package/build/es/src/events-v3-ticket-definition.types.js +0 -192
- package/build/es/src/events-v3-ticket-definition.types.js.map +0 -1
- package/build/es/src/events-v3-ticket-definition.universal.d.ts +0 -1449
- package/build/es/src/events-v3-ticket-definition.universal.js +0 -665
- package/build/es/src/events-v3-ticket-definition.universal.js.map +0 -1
|
@@ -0,0 +1,3846 @@
|
|
|
1
|
+
export declare const __debug: {
|
|
2
|
+
verboseLogging: {
|
|
3
|
+
on: () => boolean;
|
|
4
|
+
off: () => boolean;
|
|
5
|
+
};
|
|
6
|
+
};
|
|
7
|
+
export interface Event {
|
|
8
|
+
/**
|
|
9
|
+
* Event ID.
|
|
10
|
+
* @readonly
|
|
11
|
+
*/
|
|
12
|
+
_id?: string;
|
|
13
|
+
/** Event location. */
|
|
14
|
+
location?: Location;
|
|
15
|
+
/** Event date and time settings. */
|
|
16
|
+
dateAndTimeSettings?: DateAndTimeSettings;
|
|
17
|
+
title?: string | null;
|
|
18
|
+
shortDescription?: string | null;
|
|
19
|
+
detailedDescription?: string | null;
|
|
20
|
+
/** Main event image. */
|
|
21
|
+
mainImage?: string;
|
|
22
|
+
/**
|
|
23
|
+
* 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".
|
|
24
|
+
* @readonly
|
|
25
|
+
*/
|
|
26
|
+
slug?: string;
|
|
27
|
+
/**
|
|
28
|
+
* Date and time when the event was created in `yyyy-mm-ddThh:mm:sssZ` format.
|
|
29
|
+
* @readonly
|
|
30
|
+
*/
|
|
31
|
+
_createdDate?: Date;
|
|
32
|
+
/**
|
|
33
|
+
* Date and time when the event was updated in `yyyy-mm-ddThh:mm:sssZ` format.
|
|
34
|
+
* @readonly
|
|
35
|
+
*/
|
|
36
|
+
_updatedDate?: Date;
|
|
37
|
+
/** @readonly */
|
|
38
|
+
status?: Status;
|
|
39
|
+
/** RSVP or ticketing registration details. */
|
|
40
|
+
registration?: Registration;
|
|
41
|
+
/** URLs that allow you to add an event to the Google calendar, or to download an [ICS calendar](https://icscalendar.com/) file. */
|
|
42
|
+
calendarUrls?: CalendarUrls;
|
|
43
|
+
/** Event page URL components. */
|
|
44
|
+
eventPageUrl?: string;
|
|
45
|
+
/** Event registration form. */
|
|
46
|
+
form?: Form;
|
|
47
|
+
/** Summary of RSVP or ticket sales. */
|
|
48
|
+
summaries?: Summaries;
|
|
49
|
+
/**
|
|
50
|
+
* Instance ID of the site where the event is hosted.
|
|
51
|
+
* @readonly
|
|
52
|
+
*/
|
|
53
|
+
instanceId?: string;
|
|
54
|
+
/** Guest list configuration. */
|
|
55
|
+
guestListSettings?: GuestListSettings;
|
|
56
|
+
/**
|
|
57
|
+
* ID of the user who created the event.
|
|
58
|
+
* @readonly
|
|
59
|
+
*/
|
|
60
|
+
userId?: string;
|
|
61
|
+
/** Online conferencing details. */
|
|
62
|
+
onlineConferencing?: OnlineConferencing;
|
|
63
|
+
/** SEO settings. */
|
|
64
|
+
seoSettings?: SeoSettings;
|
|
65
|
+
/** Assigned contacts label key. */
|
|
66
|
+
contactLabel?: string | null;
|
|
67
|
+
/** Event schedule details. */
|
|
68
|
+
agendaSettings?: AgendaSettings;
|
|
69
|
+
/** Visual settings for event. */
|
|
70
|
+
eventDisplaySettings?: EventDisplaySettings;
|
|
71
|
+
}
|
|
72
|
+
export interface Location {
|
|
73
|
+
name?: string | null;
|
|
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
|
+
/** Default value. This value is unused. */
|
|
82
|
+
UNKNOWN_LOCATION = "UNKNOWN_LOCATION",
|
|
83
|
+
VENUE = "VENUE",
|
|
84
|
+
ONLINE = "ONLINE"
|
|
85
|
+
}
|
|
86
|
+
/** Physical address */
|
|
87
|
+
export interface CommonAddress extends CommonAddressStreetOneOf {
|
|
88
|
+
/** Street address. */
|
|
89
|
+
streetAddress?: CommonStreetAddress;
|
|
90
|
+
/** Primary address information (street and building number). */
|
|
91
|
+
addressLine1?: string | null;
|
|
92
|
+
/** 2-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */
|
|
93
|
+
country?: string | null;
|
|
94
|
+
/** Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */
|
|
95
|
+
subdivision?: string | null;
|
|
96
|
+
/** City name. */
|
|
97
|
+
city?: string | null;
|
|
98
|
+
/** Zip or postal code. */
|
|
99
|
+
postalCode?: string | null;
|
|
100
|
+
/** Secondary address information (suite or apartment number and room number). */
|
|
101
|
+
addressLine2?: string | null;
|
|
102
|
+
}
|
|
103
|
+
/** @oneof */
|
|
104
|
+
export interface CommonAddressStreetOneOf {
|
|
105
|
+
/** Street address. */
|
|
106
|
+
streetAddress?: CommonStreetAddress;
|
|
107
|
+
/** Primary address information (street and building number). */
|
|
108
|
+
addressLine?: string | null;
|
|
109
|
+
}
|
|
110
|
+
export interface CommonStreetAddress {
|
|
111
|
+
/** Street number. */
|
|
112
|
+
number?: string;
|
|
113
|
+
/** Street name. */
|
|
114
|
+
name?: string;
|
|
115
|
+
}
|
|
116
|
+
export interface CommonAddressLocation {
|
|
117
|
+
/** Address latitude coordinates. */
|
|
118
|
+
latitude?: number | null;
|
|
119
|
+
/** Address longitude coordinates. */
|
|
120
|
+
longitude?: number | null;
|
|
121
|
+
}
|
|
122
|
+
export interface CommonSubdivision {
|
|
123
|
+
/** Short subdivision code. */
|
|
124
|
+
code?: string;
|
|
125
|
+
/** Subdivision full name. */
|
|
126
|
+
name?: string;
|
|
127
|
+
}
|
|
128
|
+
export declare enum SubdivisionSubdivisionType {
|
|
129
|
+
UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
|
|
130
|
+
/** State */
|
|
131
|
+
ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
|
|
132
|
+
/** County */
|
|
133
|
+
ADMINISTRATIVE_AREA_LEVEL_2 = "ADMINISTRATIVE_AREA_LEVEL_2",
|
|
134
|
+
/** City/town */
|
|
135
|
+
ADMINISTRATIVE_AREA_LEVEL_3 = "ADMINISTRATIVE_AREA_LEVEL_3",
|
|
136
|
+
/** Neighborhood/quarter */
|
|
137
|
+
ADMINISTRATIVE_AREA_LEVEL_4 = "ADMINISTRATIVE_AREA_LEVEL_4",
|
|
138
|
+
/** Street/block */
|
|
139
|
+
ADMINISTRATIVE_AREA_LEVEL_5 = "ADMINISTRATIVE_AREA_LEVEL_5",
|
|
140
|
+
/** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
|
|
141
|
+
COUNTRY = "COUNTRY"
|
|
142
|
+
}
|
|
143
|
+
export interface DateAndTimeSettings {
|
|
144
|
+
/** Whether the event date and time are TBD. */
|
|
145
|
+
dateAndTimeTbd?: boolean | null;
|
|
146
|
+
dateAndTimeTbdMessage?: string | null;
|
|
147
|
+
/** Event start date in `yyyy-mm-ddThh:mm:sssZ` format. */
|
|
148
|
+
startDate?: Date;
|
|
149
|
+
/** Event end date in `yyyy-mm-ddThh:mm:sssZ` format. */
|
|
150
|
+
endDate?: Date;
|
|
151
|
+
/** Event time zone ID in the [TZ database](https://www.iana.org/time-zones) format. */
|
|
152
|
+
timeZoneId?: string | null;
|
|
153
|
+
/** Whether the end date is hidden in the formatted date and time. */
|
|
154
|
+
hideEndDate?: boolean | null;
|
|
155
|
+
/** Whether the time zone is displayed in the formatted schedule. */
|
|
156
|
+
showTimeZone?: boolean | null;
|
|
157
|
+
/** @readonly */
|
|
158
|
+
recurrenceStatus?: RecurrenceStatusStatus;
|
|
159
|
+
/** Event repetitions. */
|
|
160
|
+
recurringEvents?: Recurrences;
|
|
161
|
+
/** Formatted date and time settings. */
|
|
162
|
+
formatted?: Formatted;
|
|
163
|
+
}
|
|
164
|
+
export declare enum RecurrenceStatusStatus {
|
|
165
|
+
/** Default value. This value is unused. */
|
|
166
|
+
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
167
|
+
/** Event happens only once. */
|
|
168
|
+
ONE_TIME = "ONE_TIME",
|
|
169
|
+
/** Event is repeating and has a list of scheduled repetitions. */
|
|
170
|
+
RECURRING = "RECURRING",
|
|
171
|
+
/** An upcoming event from the list of repetitions. */
|
|
172
|
+
RECURRING_UPCOMING = "RECURRING_UPCOMING",
|
|
173
|
+
/** Latest ended event from the list of repetitions. */
|
|
174
|
+
RECURRING_RECENTLY_ENDED = "RECURRING_RECENTLY_ENDED",
|
|
175
|
+
/** Latest cancelled event from the list of repetitions. */
|
|
176
|
+
RECURRING_RECENTLY_CANCELED = "RECURRING_RECENTLY_CANCELED"
|
|
177
|
+
}
|
|
178
|
+
export interface Recurrences {
|
|
179
|
+
individualEventDates?: Occurrence[];
|
|
180
|
+
/**
|
|
181
|
+
* Recurring event category ID.
|
|
182
|
+
* @readonly
|
|
183
|
+
*/
|
|
184
|
+
categoryId?: string | null;
|
|
185
|
+
}
|
|
186
|
+
export interface Occurrence {
|
|
187
|
+
/** Event start date in `yyyy-mm-ddThh:mm:sssZ` format. */
|
|
188
|
+
startDate?: Date;
|
|
189
|
+
/** Event end date in `yyyy-mm-ddThh:mm:sssZ` format. */
|
|
190
|
+
endDate?: Date;
|
|
191
|
+
/** Event time zone ID in the [TZ database](https://www.iana.org/time-zones) format. */
|
|
192
|
+
timeZoneId?: string | null;
|
|
193
|
+
/** Whether the time zone is displayed in a formatted schedule. */
|
|
194
|
+
showTimeZone?: boolean;
|
|
195
|
+
}
|
|
196
|
+
export interface Formatted {
|
|
197
|
+
/** @readonly */
|
|
198
|
+
dateAndTime?: string | null;
|
|
199
|
+
/**
|
|
200
|
+
* Formatted start date of the event. Empty for TBD schedules.
|
|
201
|
+
* @readonly
|
|
202
|
+
*/
|
|
203
|
+
startDate?: string | null;
|
|
204
|
+
/**
|
|
205
|
+
* Formatted start time of the event. Empty for TBD schedules.
|
|
206
|
+
* @readonly
|
|
207
|
+
*/
|
|
208
|
+
startTime?: string | null;
|
|
209
|
+
/**
|
|
210
|
+
* Formatted end date of the event. Empty for TBD schedules or when the end date is hidden.
|
|
211
|
+
* @readonly
|
|
212
|
+
*/
|
|
213
|
+
endDate?: string | null;
|
|
214
|
+
/**
|
|
215
|
+
* Formatted end time of the event. Empty for TBD schedules or when the end date is hidden.
|
|
216
|
+
* @readonly
|
|
217
|
+
*/
|
|
218
|
+
endTime?: string | null;
|
|
219
|
+
}
|
|
220
|
+
export declare enum Status {
|
|
221
|
+
/** Default value. This value is unused */
|
|
222
|
+
UNKNOWN_EVENT_STATUS = "UNKNOWN_EVENT_STATUS",
|
|
223
|
+
/** Event is public and scheduled to start */
|
|
224
|
+
UPCOMING = "UPCOMING",
|
|
225
|
+
/** Event has started */
|
|
226
|
+
STARTED = "STARTED",
|
|
227
|
+
/** Event has ended */
|
|
228
|
+
ENDED = "ENDED",
|
|
229
|
+
/** Event is canceled */
|
|
230
|
+
CANCELED = "CANCELED",
|
|
231
|
+
/** Event is not public */
|
|
232
|
+
DRAFT = "DRAFT"
|
|
233
|
+
}
|
|
234
|
+
export interface Registration {
|
|
235
|
+
/** @readonly */
|
|
236
|
+
type?: RegistrationTypeType;
|
|
237
|
+
/** @readonly */
|
|
238
|
+
status?: RegistrationStatusStatus;
|
|
239
|
+
/** RSVP registration details. */
|
|
240
|
+
rsvp?: RsvpRegistration;
|
|
241
|
+
/** Ticket registration details. */
|
|
242
|
+
tickets?: TicketsRegistration;
|
|
243
|
+
/** External registration details. */
|
|
244
|
+
external?: ExternalRegistration;
|
|
245
|
+
allowedGuestTypes?: GuestTypeType;
|
|
246
|
+
initialType?: InitialRegistrationTypeType;
|
|
247
|
+
/** Whether the registration is paused. */
|
|
248
|
+
registrationPaused?: boolean;
|
|
249
|
+
/** Whether the registration is disabled. */
|
|
250
|
+
registrationDisabled?: boolean;
|
|
251
|
+
}
|
|
252
|
+
export declare enum RegistrationTypeType {
|
|
253
|
+
/** Default value. This value is unused */
|
|
254
|
+
UNKNOWN_REGISTRATION_TYPE = "UNKNOWN_REGISTRATION_TYPE",
|
|
255
|
+
/** Registration via RSVP */
|
|
256
|
+
RSVP = "RSVP",
|
|
257
|
+
/** Registration via ticket purchase */
|
|
258
|
+
TICKETING = "TICKETING",
|
|
259
|
+
/** External registration */
|
|
260
|
+
EXTERNAL = "EXTERNAL",
|
|
261
|
+
/** Registration not available */
|
|
262
|
+
NONE = "NONE"
|
|
263
|
+
}
|
|
264
|
+
export declare enum RegistrationStatusStatus {
|
|
265
|
+
/** Registration status is not applicable */
|
|
266
|
+
UNKNOWN_REGISTRATION_STATUS = "UNKNOWN_REGISTRATION_STATUS",
|
|
267
|
+
/** Registration to event is closed */
|
|
268
|
+
CLOSED_AUTOMATICALLY = "CLOSED_AUTOMATICALLY",
|
|
269
|
+
/** Registration to event is closed manually */
|
|
270
|
+
CLOSED_MANUALLY = "CLOSED_MANUALLY",
|
|
271
|
+
/** Registration is open via RSVP */
|
|
272
|
+
OPEN_RSVP = "OPEN_RSVP",
|
|
273
|
+
/** Registration to event waitlist is open via RSVP */
|
|
274
|
+
OPEN_RSVP_WAITLIST_ONLY = "OPEN_RSVP_WAITLIST_ONLY",
|
|
275
|
+
/** Registration is open via ticket purchase */
|
|
276
|
+
OPEN_TICKETS = "OPEN_TICKETS",
|
|
277
|
+
/** Registration is open via external URL */
|
|
278
|
+
OPEN_EXTERNAL = "OPEN_EXTERNAL",
|
|
279
|
+
/** Registration will be open via RSVP */
|
|
280
|
+
SCHEDULED_RSVP = "SCHEDULED_RSVP"
|
|
281
|
+
}
|
|
282
|
+
export interface RsvpRegistration {
|
|
283
|
+
responseType?: ResponseType;
|
|
284
|
+
/** How many guests can RSVP to an event. */
|
|
285
|
+
limit?: number | null;
|
|
286
|
+
/** Whether a waitlist is opened when the total guest limit is reached. If `true`, guests can RSVP to an event and are automatically put in the waitlist with the `IN_WAITLIST` status. */
|
|
287
|
+
waitlistEnabled?: boolean;
|
|
288
|
+
/** Registration start date in `yyyy-mm-ddThh:mm:sssZ` format. */
|
|
289
|
+
startDate?: Date;
|
|
290
|
+
/** Registration end date in `yyyy-mm-ddThh:mm:sssZ` format. */
|
|
291
|
+
endDate?: Date;
|
|
292
|
+
}
|
|
293
|
+
export declare enum ResponseType {
|
|
294
|
+
/** Default value. This value is unused. */
|
|
295
|
+
UNKNOWN_RESPONSE_TYPE = "UNKNOWN_RESPONSE_TYPE",
|
|
296
|
+
/** Only a **Yes** answer is available for the registration. */
|
|
297
|
+
YES_ONLY = "YES_ONLY",
|
|
298
|
+
/** *Yes** and **No** answers are available for the registration. */
|
|
299
|
+
YES_AND_NO = "YES_AND_NO"
|
|
300
|
+
}
|
|
301
|
+
export interface TicketsRegistration {
|
|
302
|
+
/** Whether the registration form must be filled out separately for each ticket. */
|
|
303
|
+
guestsAssignedSeparately?: boolean;
|
|
304
|
+
ticketLimitPerOrder?: number;
|
|
305
|
+
/** Ticket price currency. */
|
|
306
|
+
currency?: string | null;
|
|
307
|
+
/**
|
|
308
|
+
* Lowest ticket price.
|
|
309
|
+
* @readonly
|
|
310
|
+
*/
|
|
311
|
+
lowestPrice?: Money;
|
|
312
|
+
/**
|
|
313
|
+
* Highest ticket price.
|
|
314
|
+
* @readonly
|
|
315
|
+
*/
|
|
316
|
+
highestPrice?: Money;
|
|
317
|
+
/**
|
|
318
|
+
* Whether all tickets are sold for the event.
|
|
319
|
+
* @readonly
|
|
320
|
+
*/
|
|
321
|
+
soldOut?: boolean | null;
|
|
322
|
+
/** How tax is applied. */
|
|
323
|
+
taxSettings?: TaxSettings;
|
|
324
|
+
}
|
|
325
|
+
/**
|
|
326
|
+
* Money.
|
|
327
|
+
* Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.
|
|
328
|
+
*/
|
|
329
|
+
export interface Money {
|
|
330
|
+
/** Amount of money in decimal form. A period is used as a decimal separator (for example, `3.99`). */
|
|
331
|
+
value?: string;
|
|
332
|
+
/** Currency code in 3-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. */
|
|
333
|
+
currency?: string;
|
|
334
|
+
/**
|
|
335
|
+
* Amount of money in decimal form. A period or comma are used as a decimal separator (for example, `1 000,30`).
|
|
336
|
+
* @readonly
|
|
337
|
+
*/
|
|
338
|
+
formattedValue?: string | null;
|
|
339
|
+
}
|
|
340
|
+
export interface TaxSettings {
|
|
341
|
+
type?: TaxType;
|
|
342
|
+
name?: string | null;
|
|
343
|
+
rate?: string | null;
|
|
344
|
+
/** Apply tax to donations. */
|
|
345
|
+
appliedToDonations?: boolean | null;
|
|
346
|
+
}
|
|
347
|
+
export declare enum TaxType {
|
|
348
|
+
/** Default value. This value is unused. */
|
|
349
|
+
UNKNOWN_TAX_TYPE = "UNKNOWN_TAX_TYPE",
|
|
350
|
+
/** Tax is included in the ticket price */
|
|
351
|
+
INCLUDED_IN_PRICE = "INCLUDED_IN_PRICE",
|
|
352
|
+
/** Tax is added to the final total at the checkout */
|
|
353
|
+
ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
|
|
354
|
+
}
|
|
355
|
+
export interface ExternalRegistration {
|
|
356
|
+
/** External event registration URL. */
|
|
357
|
+
url?: string | null;
|
|
358
|
+
}
|
|
359
|
+
export declare enum GuestTypeType {
|
|
360
|
+
/** Default value. This value is unused */
|
|
361
|
+
UNKNOWN_GUEST_TYPE = "UNKNOWN_GUEST_TYPE",
|
|
362
|
+
/** Site visitor or member */
|
|
363
|
+
VISITOR_OR_MEMBER = "VISITOR_OR_MEMBER",
|
|
364
|
+
/** Site member */
|
|
365
|
+
MEMBER = "MEMBER"
|
|
366
|
+
}
|
|
367
|
+
export declare enum InitialRegistrationTypeType {
|
|
368
|
+
/** Default value. This value is unused */
|
|
369
|
+
UNKNOWN_INITIAL_REGISTRATION_TYPE = "UNKNOWN_INITIAL_REGISTRATION_TYPE",
|
|
370
|
+
/** Registration via RSVP */
|
|
371
|
+
RSVP = "RSVP",
|
|
372
|
+
/** Registration via ticket purchase */
|
|
373
|
+
TICKETING = "TICKETING"
|
|
374
|
+
}
|
|
375
|
+
export interface CalendarUrls {
|
|
376
|
+
/**
|
|
377
|
+
* "Add to Google calendar" URL.
|
|
378
|
+
* @readonly
|
|
379
|
+
*/
|
|
380
|
+
google?: string;
|
|
381
|
+
/**
|
|
382
|
+
* "Download ICS calendar file" URL.
|
|
383
|
+
* @readonly
|
|
384
|
+
*/
|
|
385
|
+
ics?: string;
|
|
386
|
+
}
|
|
387
|
+
/**
|
|
388
|
+
* The form defines which elements are rendered in the Wix UI during the registration process (RSVP or checkout).
|
|
389
|
+
* It also contains customizable messages and labels.
|
|
390
|
+
*
|
|
391
|
+
*
|
|
392
|
+
* A form is an ordered list of controls (blocks), which accept guest information into a field input.
|
|
393
|
+
*
|
|
394
|
+
* Each control contains one or more nested inputs. For example, `Name` control has two inputs:
|
|
395
|
+
* - First Name
|
|
396
|
+
* - Last Name
|
|
397
|
+
*
|
|
398
|
+
* By default, name and email controls are always required and are pinned to the top of the form.
|
|
399
|
+
*/
|
|
400
|
+
export interface Form {
|
|
401
|
+
/** Nested fields as an ordered list. */
|
|
402
|
+
controls?: InputControl[];
|
|
403
|
+
/** Set of configured form messages. */
|
|
404
|
+
messages?: FormMessages;
|
|
405
|
+
}
|
|
406
|
+
/**
|
|
407
|
+
* A block of nested fields.
|
|
408
|
+
* Used to aggregate similar inputs like First Name and Last Name.
|
|
409
|
+
*/
|
|
410
|
+
export interface InputControl {
|
|
411
|
+
/** Field control type. */
|
|
412
|
+
type?: InputControlType;
|
|
413
|
+
/** Whether control is mandatory (such as name & email). When true, only label can be changed. */
|
|
414
|
+
system?: boolean;
|
|
415
|
+
/** Deprecated: Use `id`. */
|
|
416
|
+
name?: string;
|
|
417
|
+
/** Child inputs. */
|
|
418
|
+
inputs?: Input[];
|
|
419
|
+
/** Deprecated: use `inputs.label`. */
|
|
420
|
+
label?: string;
|
|
421
|
+
/** Field controls are sorted by this value in ascending order. */
|
|
422
|
+
orderIndex?: number;
|
|
423
|
+
/** Unique control ID. */
|
|
424
|
+
_id?: string;
|
|
425
|
+
}
|
|
426
|
+
export declare enum InputControlType {
|
|
427
|
+
/** Single text value field. */
|
|
428
|
+
INPUT = "INPUT",
|
|
429
|
+
/** Single text value field. */
|
|
430
|
+
TEXTAREA = "TEXTAREA",
|
|
431
|
+
/** Single-choice field of predefined values. */
|
|
432
|
+
DROPDOWN = "DROPDOWN",
|
|
433
|
+
/** Single-choice field of predefined values. */
|
|
434
|
+
RADIO = "RADIO",
|
|
435
|
+
/** Multiple-choice field of predefined values. */
|
|
436
|
+
CHECKBOX = "CHECKBOX",
|
|
437
|
+
/** First and last name fields. */
|
|
438
|
+
NAME = "NAME",
|
|
439
|
+
/** Additional guests and respective guest names fields. */
|
|
440
|
+
GUEST_CONTROL = "GUEST_CONTROL",
|
|
441
|
+
/** Single-line address field. */
|
|
442
|
+
ADDRESS_SHORT = "ADDRESS_SHORT",
|
|
443
|
+
/** Full address field. */
|
|
444
|
+
ADDRESS_FULL = "ADDRESS_FULL",
|
|
445
|
+
/** Year, month and day fields. */
|
|
446
|
+
DATE = "DATE"
|
|
447
|
+
}
|
|
448
|
+
/** An input of one or multiple text values */
|
|
449
|
+
export interface Input {
|
|
450
|
+
/** Field name. */
|
|
451
|
+
name?: string;
|
|
452
|
+
/** Deprecated: use `ValueType.TEXT_ARRAY`. */
|
|
453
|
+
array?: boolean;
|
|
454
|
+
/** Main field label */
|
|
455
|
+
label?: string;
|
|
456
|
+
/** Additional labels for multi-valued fields such as address. */
|
|
457
|
+
additionalLabels?: Record<string, string>;
|
|
458
|
+
/** Predefined choice options for fields, such as dropdown. */
|
|
459
|
+
options?: string[];
|
|
460
|
+
/** Whether field is mandatory. */
|
|
461
|
+
mandatory?: boolean;
|
|
462
|
+
/** Maximum number of accepted characters (relevant for text fields). */
|
|
463
|
+
maxLength?: number;
|
|
464
|
+
/**
|
|
465
|
+
* Type which determines field format.
|
|
466
|
+
* Used to validate submitted response.
|
|
467
|
+
*/
|
|
468
|
+
type?: ValueType;
|
|
469
|
+
/**
|
|
470
|
+
* A maximum accepted values for array input.
|
|
471
|
+
* Only applicable for inputs of valueType: TEXT_ARRAY.
|
|
472
|
+
*/
|
|
473
|
+
maxSize?: number | null;
|
|
474
|
+
/**
|
|
475
|
+
* Preselected option.
|
|
476
|
+
* Currently only applicable for dropdown.
|
|
477
|
+
*/
|
|
478
|
+
defaultOptionSelection?: OptionSelection;
|
|
479
|
+
/**
|
|
480
|
+
* Additional labels for multi-valued fields such as address.
|
|
481
|
+
* @readonly
|
|
482
|
+
*/
|
|
483
|
+
labels?: Label[];
|
|
484
|
+
}
|
|
485
|
+
export declare enum ValueType {
|
|
486
|
+
TEXT = "TEXT",
|
|
487
|
+
NUMBER = "NUMBER",
|
|
488
|
+
TEXT_ARRAY = "TEXT_ARRAY",
|
|
489
|
+
DATE_TIME = "DATE_TIME",
|
|
490
|
+
ADDRESS = "ADDRESS"
|
|
491
|
+
}
|
|
492
|
+
/**
|
|
493
|
+
* Describes initially selected option when an input has multiple choices.
|
|
494
|
+
* Defaults to first (0th) option if not configured.
|
|
495
|
+
*/
|
|
496
|
+
export interface OptionSelection extends OptionSelectionSelectedOptionOneOf {
|
|
497
|
+
/** 0-based index from predefined `input.options` which is selected initially. */
|
|
498
|
+
optionIndex?: number;
|
|
499
|
+
/**
|
|
500
|
+
* Placeholder hint describing expected choices (such as "Please select").
|
|
501
|
+
* Considered an empty choice.
|
|
502
|
+
*/
|
|
503
|
+
placeholderText?: string;
|
|
504
|
+
}
|
|
505
|
+
/** @oneof */
|
|
506
|
+
export interface OptionSelectionSelectedOptionOneOf {
|
|
507
|
+
/** 0-based index from predefined `input.options` which is selected initially. */
|
|
508
|
+
optionIndex?: number;
|
|
509
|
+
/**
|
|
510
|
+
* Placeholder hint describing expected choices (such as "Please select").
|
|
511
|
+
* Considered an empty choice.
|
|
512
|
+
*/
|
|
513
|
+
placeholderText?: string;
|
|
514
|
+
}
|
|
515
|
+
export interface Label {
|
|
516
|
+
/** Field name. */
|
|
517
|
+
name?: string;
|
|
518
|
+
/** Field label. */
|
|
519
|
+
label?: string;
|
|
520
|
+
}
|
|
521
|
+
/**
|
|
522
|
+
* Defines form messages shown in UI before, during, and after registration flow.
|
|
523
|
+
* It enables configuration of form titles, response labels, "thank you" messages, and call-to-action texts.
|
|
524
|
+
*/
|
|
525
|
+
export interface FormMessages {
|
|
526
|
+
/** RSVP form messages. */
|
|
527
|
+
rsvp?: RsvpFormMessages;
|
|
528
|
+
/** Checkout form messages. */
|
|
529
|
+
checkout?: CheckoutFormMessages;
|
|
530
|
+
/** Messages shown when event registration is closed. */
|
|
531
|
+
registrationClosed?: RegistrationClosedMessages;
|
|
532
|
+
/** Messages shown when event tickets are unavailable. */
|
|
533
|
+
ticketsUnavailable?: TicketsUnavailableMessages;
|
|
534
|
+
}
|
|
535
|
+
export interface RsvpFormMessages {
|
|
536
|
+
/** Label text indicating RSVP `YES` response. */
|
|
537
|
+
rsvpYesOption?: string;
|
|
538
|
+
/** Label text indicating RSVP `NO` response. */
|
|
539
|
+
rsvpNoOption?: string;
|
|
540
|
+
/** Messages shown for RSVP = `YES`. */
|
|
541
|
+
positiveMessages?: Positive;
|
|
542
|
+
/** Messages shown for RSVP = `WAITING` (when event is full and waitlist is available). */
|
|
543
|
+
waitlistMessages?: Positive;
|
|
544
|
+
/** Messages shown for RSVP = `NO`. */
|
|
545
|
+
negativeMessages?: Negative;
|
|
546
|
+
/** "Submit form" call-to-action label text. */
|
|
547
|
+
submitActionLabel?: string;
|
|
548
|
+
}
|
|
549
|
+
/** Confirmation messages shown after registration. */
|
|
550
|
+
export interface PositiveResponseConfirmation {
|
|
551
|
+
/** Confirmation message title. */
|
|
552
|
+
title?: string;
|
|
553
|
+
/** Confirmation message text. */
|
|
554
|
+
message?: string;
|
|
555
|
+
/** "Add to calendar" call-to-action label text. */
|
|
556
|
+
addToCalendarActionLabel?: string;
|
|
557
|
+
/** "Share event" call-to-action label text. */
|
|
558
|
+
shareActionLabel?: string;
|
|
559
|
+
}
|
|
560
|
+
/** Confirmation messages shown after registration. */
|
|
561
|
+
export interface NegativeResponseConfirmation {
|
|
562
|
+
/** Confirmation message title. */
|
|
563
|
+
title?: string;
|
|
564
|
+
/** "Share event" call-to-action label text. */
|
|
565
|
+
shareActionLabel?: string;
|
|
566
|
+
}
|
|
567
|
+
/** Set of messages shown during registration when RSVP response is positive. */
|
|
568
|
+
export interface Positive {
|
|
569
|
+
/** Main form title for positive response. */
|
|
570
|
+
title?: string;
|
|
571
|
+
/** Confirmation messages shown after registration. */
|
|
572
|
+
confirmation?: PositiveResponseConfirmation;
|
|
573
|
+
}
|
|
574
|
+
/** A set of messages shown during registration with negative response */
|
|
575
|
+
export interface Negative {
|
|
576
|
+
/** Main form title for negative response. */
|
|
577
|
+
title?: string;
|
|
578
|
+
/** Confirmation messages shown after registration. */
|
|
579
|
+
confirmation?: NegativeResponseConfirmation;
|
|
580
|
+
}
|
|
581
|
+
export interface CheckoutFormMessages {
|
|
582
|
+
/** Main form title for response. */
|
|
583
|
+
title?: string;
|
|
584
|
+
/** Submit form call-to-action label text. */
|
|
585
|
+
submitActionLabel?: string;
|
|
586
|
+
/** Confirmation messages shown after checkout. */
|
|
587
|
+
confirmation?: ResponseConfirmation;
|
|
588
|
+
}
|
|
589
|
+
/** Confirmation messages shown after checkout. */
|
|
590
|
+
export interface ResponseConfirmation {
|
|
591
|
+
/** Confirmation message title. */
|
|
592
|
+
title?: string;
|
|
593
|
+
/** Confirmation message text. */
|
|
594
|
+
message?: string;
|
|
595
|
+
/** "Download tickets" call-to-action label text. */
|
|
596
|
+
downloadTicketsLabel?: string;
|
|
597
|
+
/** "Add to calendar" call-to-action label text. */
|
|
598
|
+
addToCalendarLabel?: string;
|
|
599
|
+
/** "Share event" call-to-action label text. */
|
|
600
|
+
shareEventLabel?: string;
|
|
601
|
+
}
|
|
602
|
+
export interface RegistrationClosedMessages {
|
|
603
|
+
/** Message shown when event registration is closed. */
|
|
604
|
+
message?: string;
|
|
605
|
+
/** "Explore other events" call-to-action label text. */
|
|
606
|
+
exploreEventsActionLabel?: string;
|
|
607
|
+
}
|
|
608
|
+
export interface TicketsUnavailableMessages {
|
|
609
|
+
/** Message shown when event tickets are unavailable. */
|
|
610
|
+
message?: string;
|
|
611
|
+
/** "Explore other events" call-to-action label text. */
|
|
612
|
+
exploreEventsActionLabel?: string;
|
|
613
|
+
}
|
|
614
|
+
export interface Summaries {
|
|
615
|
+
/** RSVP summary of guests. */
|
|
616
|
+
rsvps?: Rsvps;
|
|
617
|
+
/** Summary of revenue and sold tickets. Archived orders are not included. */
|
|
618
|
+
tickets?: Tickets;
|
|
619
|
+
}
|
|
620
|
+
export interface EventsMoney {
|
|
621
|
+
/** *Deprecated:** Use `value` instead. */
|
|
622
|
+
amount?: string;
|
|
623
|
+
/** ISO 4217 format of the currency i.e. `USD`. */
|
|
624
|
+
currency?: string;
|
|
625
|
+
/** 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. */
|
|
626
|
+
value?: string | null;
|
|
627
|
+
}
|
|
628
|
+
export interface Rsvps {
|
|
629
|
+
/**
|
|
630
|
+
* Total number of RSVPs.
|
|
631
|
+
* @readonly
|
|
632
|
+
*/
|
|
633
|
+
totalCount?: number;
|
|
634
|
+
/**
|
|
635
|
+
* Number of RSVPs with status `YES`.
|
|
636
|
+
* @readonly
|
|
637
|
+
*/
|
|
638
|
+
yesCount?: number;
|
|
639
|
+
/**
|
|
640
|
+
* Number of RSVPs with status `NO`.
|
|
641
|
+
* @readonly
|
|
642
|
+
*/
|
|
643
|
+
noCount?: number;
|
|
644
|
+
/**
|
|
645
|
+
* Number of RSVPs in a waitlist.
|
|
646
|
+
* @readonly
|
|
647
|
+
*/
|
|
648
|
+
waitlistCount?: number;
|
|
649
|
+
}
|
|
650
|
+
export interface Tickets {
|
|
651
|
+
/**
|
|
652
|
+
* Number of sold tickets.
|
|
653
|
+
* @readonly
|
|
654
|
+
*/
|
|
655
|
+
ticketsSold?: number;
|
|
656
|
+
/**
|
|
657
|
+
* Total revenue. Taxes and payment provider fees aren't deducted.
|
|
658
|
+
* @readonly
|
|
659
|
+
*/
|
|
660
|
+
revenue?: EventsMoney;
|
|
661
|
+
/**
|
|
662
|
+
* Whether the currency is locked and can’t be changed.
|
|
663
|
+
* @readonly
|
|
664
|
+
*/
|
|
665
|
+
currencyLocked?: boolean;
|
|
666
|
+
/**
|
|
667
|
+
* Number of orders placed.
|
|
668
|
+
* @readonly
|
|
669
|
+
*/
|
|
670
|
+
totalOrders?: number;
|
|
671
|
+
/**
|
|
672
|
+
* Total balance of confirmed transactions.
|
|
673
|
+
* @readonly
|
|
674
|
+
*/
|
|
675
|
+
totalSales?: EventsMoney;
|
|
676
|
+
}
|
|
677
|
+
export interface GuestListSettings {
|
|
678
|
+
/** Whether the guest list is public for all guests. */
|
|
679
|
+
displayedPublicly?: boolean;
|
|
680
|
+
}
|
|
681
|
+
export interface Feed {
|
|
682
|
+
/** Event discussion feed token. */
|
|
683
|
+
token?: string;
|
|
684
|
+
}
|
|
685
|
+
export interface OnlineConferencing {
|
|
686
|
+
/** Whether online conferencing is enabled. Not applicable for events, where date and time are TBD. When enabled, links to join the conference are generated and provided to guests. */
|
|
687
|
+
enabled?: boolean;
|
|
688
|
+
/** Conference host ID. */
|
|
689
|
+
providerId?: string | null;
|
|
690
|
+
type?: ConferenceTypeType;
|
|
691
|
+
/** Online conferencing session information. */
|
|
692
|
+
session?: OnlineConferencingSession;
|
|
693
|
+
}
|
|
694
|
+
export declare enum ConferenceTypeType {
|
|
695
|
+
/** Default value. This value is unused */
|
|
696
|
+
UNKNOWN_CONFERENCE_TYPE = "UNKNOWN_CONFERENCE_TYPE",
|
|
697
|
+
/** Guests can publish and subscribe to video and audio. */
|
|
698
|
+
MEETING = "MEETING",
|
|
699
|
+
/** Guests can only subscribe to video and audio. */
|
|
700
|
+
WEBINAR = "WEBINAR"
|
|
701
|
+
}
|
|
702
|
+
export interface OnlineConferencingSession {
|
|
703
|
+
/**
|
|
704
|
+
* Link for the event host to start the online conference session.
|
|
705
|
+
* @readonly
|
|
706
|
+
*/
|
|
707
|
+
hostLink?: string;
|
|
708
|
+
/**
|
|
709
|
+
* Link for guests to join the online conference session.
|
|
710
|
+
* @readonly
|
|
711
|
+
*/
|
|
712
|
+
guestLink?: string;
|
|
713
|
+
/**
|
|
714
|
+
* Password required to join the online conferencing session (when relevant).
|
|
715
|
+
* @readonly
|
|
716
|
+
*/
|
|
717
|
+
password?: string | null;
|
|
718
|
+
/**
|
|
719
|
+
* Whether the session was created successfully on the event host side.
|
|
720
|
+
* @readonly
|
|
721
|
+
*/
|
|
722
|
+
sessionCreated?: boolean | null;
|
|
723
|
+
/**
|
|
724
|
+
* Unique session ID.
|
|
725
|
+
* @readonly
|
|
726
|
+
*/
|
|
727
|
+
sessionId?: string | null;
|
|
728
|
+
}
|
|
729
|
+
export interface SeoSettings {
|
|
730
|
+
/** URL slug. */
|
|
731
|
+
slug?: string;
|
|
732
|
+
/** Advanced SEO data. */
|
|
733
|
+
advancedSeoData?: SeoSchema;
|
|
734
|
+
/**
|
|
735
|
+
* Whether the slug is hidden from the SEO Site Map.
|
|
736
|
+
* @readonly
|
|
737
|
+
*/
|
|
738
|
+
hidden?: boolean | null;
|
|
739
|
+
}
|
|
740
|
+
/**
|
|
741
|
+
* 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.
|
|
742
|
+
* The search engines use this information for ranking purposes, or to display snippets in the search results.
|
|
743
|
+
* 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.
|
|
744
|
+
*/
|
|
745
|
+
export interface SeoSchema {
|
|
746
|
+
/** SEO tag information. */
|
|
747
|
+
tags?: Tag[];
|
|
748
|
+
/** SEO general settings. */
|
|
749
|
+
settings?: Settings;
|
|
750
|
+
}
|
|
751
|
+
export interface Keyword {
|
|
752
|
+
/** Keyword value. */
|
|
753
|
+
term?: string;
|
|
754
|
+
/** Whether the keyword is the main focus keyword. */
|
|
755
|
+
isMain?: boolean;
|
|
756
|
+
}
|
|
757
|
+
export interface Tag {
|
|
758
|
+
/**
|
|
759
|
+
* SEO tag type.
|
|
760
|
+
*
|
|
761
|
+
*
|
|
762
|
+
* Supported values: `title`, `meta`, `script`, `link`.
|
|
763
|
+
*/
|
|
764
|
+
type?: string;
|
|
765
|
+
/**
|
|
766
|
+
* A `{'key':'value'}` pair object where each SEO tag property (`'name'`, `'content'`, `'rel'`, `'href'`) contains a value.
|
|
767
|
+
* For example: `{'name': 'description', 'content': 'the description itself'}`.
|
|
768
|
+
*/
|
|
769
|
+
props?: Record<string, any> | null;
|
|
770
|
+
/** SEO tag meta data. For example, `{height: 300, width: 240}`. */
|
|
771
|
+
meta?: Record<string, any> | null;
|
|
772
|
+
/** SEO tag inner content. For example, `<title> inner content </title>`. */
|
|
773
|
+
children?: string;
|
|
774
|
+
/** Whether the tag is a custom tag. */
|
|
775
|
+
custom?: boolean;
|
|
776
|
+
/** Whether the tag is disabled. */
|
|
777
|
+
disabled?: boolean;
|
|
778
|
+
}
|
|
779
|
+
export interface Settings {
|
|
780
|
+
/**
|
|
781
|
+
* Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.
|
|
782
|
+
*
|
|
783
|
+
*
|
|
784
|
+
* Default: `false` (Auto Redirect is enabled.)
|
|
785
|
+
*/
|
|
786
|
+
preventAutoRedirect?: boolean;
|
|
787
|
+
/** User-selected keyword terms for a specific page. */
|
|
788
|
+
keywords?: Keyword[];
|
|
789
|
+
}
|
|
790
|
+
export interface AgendaSettings {
|
|
791
|
+
/** Whether the schedule is enabled for the event. */
|
|
792
|
+
enabled?: boolean;
|
|
793
|
+
/**
|
|
794
|
+
* Schedule page URL.
|
|
795
|
+
* @readonly
|
|
796
|
+
*/
|
|
797
|
+
pageUrl?: string;
|
|
798
|
+
}
|
|
799
|
+
export interface EventCategories {
|
|
800
|
+
/** Event categories. */
|
|
801
|
+
categories?: EventCategory[];
|
|
802
|
+
}
|
|
803
|
+
export interface EventCategory {
|
|
804
|
+
/**
|
|
805
|
+
* Category ID.
|
|
806
|
+
* @readonly
|
|
807
|
+
*/
|
|
808
|
+
_id?: string;
|
|
809
|
+
/** Category name. */
|
|
810
|
+
name?: string;
|
|
811
|
+
/**
|
|
812
|
+
* Category creation timestamp.
|
|
813
|
+
* @readonly
|
|
814
|
+
*/
|
|
815
|
+
_createdDate?: Date;
|
|
816
|
+
/**
|
|
817
|
+
* Category is hidden.
|
|
818
|
+
* @readonly
|
|
819
|
+
*/
|
|
820
|
+
hidden?: boolean;
|
|
821
|
+
/**
|
|
822
|
+
* Category type.
|
|
823
|
+
* @readonly
|
|
824
|
+
*/
|
|
825
|
+
type?: Type;
|
|
826
|
+
}
|
|
827
|
+
export declare enum Type {
|
|
828
|
+
/** Created manually by the user. */
|
|
829
|
+
MANUAL = "MANUAL",
|
|
830
|
+
/** Created automatically when publishing recurring events. */
|
|
831
|
+
RECURRING_EVENT = "RECURRING_EVENT",
|
|
832
|
+
/** Created automatically and used to store component events. */
|
|
833
|
+
COMPONENT = "COMPONENT"
|
|
834
|
+
}
|
|
835
|
+
export interface EventDisplaySettings {
|
|
836
|
+
/** Whether event details button is hidden. Only available for events with no registration. */
|
|
837
|
+
hideEventDetailsButton?: boolean | null;
|
|
838
|
+
}
|
|
839
|
+
export interface V3EventStarted {
|
|
840
|
+
/** Event schedule configuration. */
|
|
841
|
+
timestamp?: Date;
|
|
842
|
+
/** Event ID. */
|
|
843
|
+
eventId?: string;
|
|
844
|
+
}
|
|
845
|
+
export interface V3EventReminder {
|
|
846
|
+
/** Reminder timestamp in ISO UTC format. */
|
|
847
|
+
timestamp?: Date;
|
|
848
|
+
/** Event ID. */
|
|
849
|
+
eventId?: string;
|
|
850
|
+
/** Event location. */
|
|
851
|
+
location?: Location;
|
|
852
|
+
/** Event schedule configuration. */
|
|
853
|
+
dateAndTimeSettings?: DateAndTimeSettings;
|
|
854
|
+
/** Event title. */
|
|
855
|
+
title?: string;
|
|
856
|
+
/** ID of the user who created the event. */
|
|
857
|
+
userId?: string | null;
|
|
858
|
+
/** Time until the event starts (currently, reminder letter is triggered 1 day before event starts). */
|
|
859
|
+
startsIn?: TimeDuration;
|
|
860
|
+
}
|
|
861
|
+
/**
|
|
862
|
+
* A coarse-grained representation of time duration divided into whole constituting components of days, hours, and minutes.
|
|
863
|
+
* For example, 25.5 hours duration is represented as `{ days: 1, hours: 1, minutes: 30 }`.
|
|
864
|
+
*/
|
|
865
|
+
export interface TimeDuration {
|
|
866
|
+
/** Number of days */
|
|
867
|
+
days?: number;
|
|
868
|
+
/** Number of hours */
|
|
869
|
+
hours?: number;
|
|
870
|
+
/** Number of minutes */
|
|
871
|
+
minutes?: number;
|
|
872
|
+
}
|
|
873
|
+
export interface V3EventEnded {
|
|
874
|
+
/** Event end timestamp in ISO UTC format. */
|
|
875
|
+
timestamp?: Date;
|
|
876
|
+
/** Event ID. */
|
|
877
|
+
eventId?: string;
|
|
878
|
+
}
|
|
879
|
+
export interface CreateEventRequest {
|
|
880
|
+
/** Event data. */
|
|
881
|
+
event: Event;
|
|
882
|
+
/** Whether to create the event as a draft. */
|
|
883
|
+
draft?: boolean;
|
|
884
|
+
/**
|
|
885
|
+
* Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
|
|
886
|
+
* - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
|
|
887
|
+
* - `TEXTS`: Returns `detailedDescription`.
|
|
888
|
+
* - `REGISTRATION`: Returns `registration`.
|
|
889
|
+
* - `URLS`: Returns `eventPageUrl`.
|
|
890
|
+
* - `FORM`: Returns `form`.
|
|
891
|
+
* - `DASHBOARD`: Returns `summaries`.
|
|
892
|
+
* - `FEED`: Returns `feed`.
|
|
893
|
+
* - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
|
|
894
|
+
* - `SEO_SETTINGS`: Returns `seoSettings`.
|
|
895
|
+
* - `AGENDA`: Returns `agendaSettings`.
|
|
896
|
+
* - `CATEGORIES`: Returns `categories`.
|
|
897
|
+
*/
|
|
898
|
+
fields?: RequestedFields[];
|
|
899
|
+
}
|
|
900
|
+
export declare enum RequestedFields {
|
|
901
|
+
UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
|
|
902
|
+
/** Include `description`, `mainImage` and `calendarLinks` in the response. */
|
|
903
|
+
DETAILS = "DETAILS",
|
|
904
|
+
/** Include `about` event rich text in the response. */
|
|
905
|
+
TEXTS = "TEXTS",
|
|
906
|
+
/** Include `registration` in the response. */
|
|
907
|
+
REGISTRATION = "REGISTRATION",
|
|
908
|
+
/** Include `eventPageUrl` in the response. */
|
|
909
|
+
URLS = "URLS",
|
|
910
|
+
/** Include `form` in the response. */
|
|
911
|
+
FORM = "FORM",
|
|
912
|
+
/** Include `dashboard` in the response. */
|
|
913
|
+
DASHBOARD = "DASHBOARD",
|
|
914
|
+
/** Include `feed` in the response. */
|
|
915
|
+
FEED = "FEED",
|
|
916
|
+
/** Include `onlineConferencing` in the response. */
|
|
917
|
+
ONLINE_CONFERENCING_SESSION = "ONLINE_CONFERENCING_SESSION",
|
|
918
|
+
/** Include `seoSettings` in the response. */
|
|
919
|
+
SEO_SETTINGS = "SEO_SETTINGS",
|
|
920
|
+
/** Include `agendaSettings` in the response. */
|
|
921
|
+
AGENDA = "AGENDA",
|
|
922
|
+
/** Include `categories` in the response. */
|
|
923
|
+
CATEGORIES = "CATEGORIES",
|
|
924
|
+
CUSTOMIZABLE_TICKETS = "CUSTOMIZABLE_TICKETS"
|
|
925
|
+
}
|
|
926
|
+
export interface CreateEventResponse {
|
|
927
|
+
/** Created event. */
|
|
928
|
+
event?: Event;
|
|
929
|
+
}
|
|
930
|
+
export interface V3EventPublished {
|
|
931
|
+
/** Event publishing timestamp in ISO UTC format. */
|
|
932
|
+
timestamp?: Date;
|
|
933
|
+
/** Event ID. */
|
|
934
|
+
eventId?: string;
|
|
935
|
+
/** Event status. */
|
|
936
|
+
status?: Status;
|
|
937
|
+
/**
|
|
938
|
+
* Event ID. Indicates the original event from which the current event was derived from.
|
|
939
|
+
* Can be used to track the original event and add missing information.
|
|
940
|
+
*/
|
|
941
|
+
derivedFromEventId?: string | null;
|
|
942
|
+
}
|
|
943
|
+
export interface CloneEventRequest {
|
|
944
|
+
/** Event ID. */
|
|
945
|
+
eventId: string;
|
|
946
|
+
/** Field values to be changed when cloning the event. */
|
|
947
|
+
event?: Event;
|
|
948
|
+
/** Whether to clone the event as a draft. */
|
|
949
|
+
draft?: boolean;
|
|
950
|
+
/**
|
|
951
|
+
* Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
|
|
952
|
+
* - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
|
|
953
|
+
* - `TEXTS`: Returns `detailedDescription`.
|
|
954
|
+
* - `REGISTRATION`: Returns `registration`.
|
|
955
|
+
* - `URLS`: Returns `eventPageUrl`.
|
|
956
|
+
* - `FORM`: Returns `form`.
|
|
957
|
+
* - `DASHBOARD`: Returns `summaries`.
|
|
958
|
+
* - `FEED`: Returns `feed`.
|
|
959
|
+
* - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
|
|
960
|
+
* - `SEO_SETTINGS`: Returns `seoSettings`.
|
|
961
|
+
* - `AGENDA`: Returns `agendaSettings`.
|
|
962
|
+
* - `CATEGORIES`: Returns `categories`.
|
|
963
|
+
*/
|
|
964
|
+
fields?: RequestedFields[];
|
|
965
|
+
}
|
|
966
|
+
export interface CloneEventResponse {
|
|
967
|
+
/** Cloned event. */
|
|
968
|
+
event?: Event;
|
|
969
|
+
}
|
|
970
|
+
export interface EventCloned {
|
|
971
|
+
/** Event creation timestamp in ISO UTC format. */
|
|
972
|
+
timestamp?: Date;
|
|
973
|
+
/** Event ID. */
|
|
974
|
+
eventId?: string;
|
|
975
|
+
/** Event location. */
|
|
976
|
+
location?: Location;
|
|
977
|
+
/** Event date and time settings. */
|
|
978
|
+
dateAndTimeSettings?: DateAndTimeSettings;
|
|
979
|
+
/** Event title. */
|
|
980
|
+
title?: string;
|
|
981
|
+
/** ID of the user who created the event. */
|
|
982
|
+
userId?: string | null;
|
|
983
|
+
/** Event status. */
|
|
984
|
+
status?: Status;
|
|
985
|
+
/** Instance ID. Indicates the original app instance from which current event was derived from. */
|
|
986
|
+
derivedFromInstanceId?: string | null;
|
|
987
|
+
/** Event ID. Indicates the original event from which current event was derived from. */
|
|
988
|
+
derivedFromEventId?: string | null;
|
|
989
|
+
/**
|
|
990
|
+
* Map of copied ticket definitions from the original event.
|
|
991
|
+
* Key represents ticket definition ID in the original event.
|
|
992
|
+
* Value represents ticket definition ID in the newly event.
|
|
993
|
+
*/
|
|
994
|
+
ticketDefinitions?: Record<string, string>;
|
|
995
|
+
}
|
|
996
|
+
export interface UpdateEventRequest {
|
|
997
|
+
/** Field values to be changed. */
|
|
998
|
+
event?: Event;
|
|
999
|
+
/**
|
|
1000
|
+
* Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
|
|
1001
|
+
* - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
|
|
1002
|
+
* - `TEXTS`: Returns `detailedDescription`.
|
|
1003
|
+
* - `REGISTRATION`: Returns `registration`.
|
|
1004
|
+
* - `URLS`: Returns `eventPageUrl`.
|
|
1005
|
+
* - `FORM`: Returns `form`.
|
|
1006
|
+
* - `DASHBOARD`: Returns `summaries`.
|
|
1007
|
+
* - `FEED`: Returns `feed`.
|
|
1008
|
+
* - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
|
|
1009
|
+
* - `SEO_SETTINGS`: Returns `seoSettings`.
|
|
1010
|
+
* - `AGENDA`: Returns `agendaSettings`.
|
|
1011
|
+
* - `CATEGORIES`: Returns `categories`.
|
|
1012
|
+
*/
|
|
1013
|
+
fields?: RequestedFields[];
|
|
1014
|
+
}
|
|
1015
|
+
export interface UpdateEventResponse {
|
|
1016
|
+
/** Updated event. */
|
|
1017
|
+
event?: Event;
|
|
1018
|
+
}
|
|
1019
|
+
export interface PublishDraftEventRequest {
|
|
1020
|
+
/** Event ID. */
|
|
1021
|
+
eventId: string;
|
|
1022
|
+
/**
|
|
1023
|
+
* Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
|
|
1024
|
+
* - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
|
|
1025
|
+
* - `TEXTS`: Returns `detailedDescription`.
|
|
1026
|
+
* - `REGISTRATION`: Returns `registration`.
|
|
1027
|
+
* - `URLS`: Returns `eventPageUrl`.
|
|
1028
|
+
* - `FORM`: Returns `form`.
|
|
1029
|
+
* - `DASHBOARD`: Returns `summaries`.
|
|
1030
|
+
* - `FEED`: Returns `feed`.
|
|
1031
|
+
* - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
|
|
1032
|
+
* - `SEO_SETTINGS`: Returns `seoSettings`.
|
|
1033
|
+
* - `AGENDA`: Returns `agendaSettings`.
|
|
1034
|
+
* - `CATEGORIES`: Returns `categories`.
|
|
1035
|
+
*/
|
|
1036
|
+
fields?: RequestedFields[];
|
|
1037
|
+
}
|
|
1038
|
+
export interface PublishDraftEventResponse {
|
|
1039
|
+
/** Published event. */
|
|
1040
|
+
event?: Event;
|
|
1041
|
+
}
|
|
1042
|
+
export interface CancelEventRequest {
|
|
1043
|
+
/** Event ID. */
|
|
1044
|
+
eventId: string;
|
|
1045
|
+
/**
|
|
1046
|
+
* Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
|
|
1047
|
+
* - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
|
|
1048
|
+
* - `TEXTS`: Returns `detailedDescription`.
|
|
1049
|
+
* - `REGISTRATION`: Returns `registration`.
|
|
1050
|
+
* - `URLS`: Returns `eventPageUrl`.
|
|
1051
|
+
* - `FORM`: Returns `form`.
|
|
1052
|
+
* - `DASHBOARD`: Returns `summaries`.
|
|
1053
|
+
* - `FEED`: Returns `feed`.
|
|
1054
|
+
* - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
|
|
1055
|
+
* - `SEO_SETTINGS`: Returns `seoSettings`.
|
|
1056
|
+
* - `AGENDA`: Returns `agendaSettings`.
|
|
1057
|
+
* - `CATEGORIES`: Returns `categories`.
|
|
1058
|
+
*/
|
|
1059
|
+
fields?: RequestedFields[];
|
|
1060
|
+
}
|
|
1061
|
+
export interface CancelEventResponse {
|
|
1062
|
+
/** Canceled event. */
|
|
1063
|
+
event?: Event;
|
|
1064
|
+
}
|
|
1065
|
+
export interface V3EventCanceled {
|
|
1066
|
+
/** Event cancelation timestamp in ISO UTC format. */
|
|
1067
|
+
timestamp?: Date;
|
|
1068
|
+
/** Event ID. */
|
|
1069
|
+
eventId?: string;
|
|
1070
|
+
/** Event title. */
|
|
1071
|
+
title?: string;
|
|
1072
|
+
/** ID of the user who created the event. */
|
|
1073
|
+
userId?: string | null;
|
|
1074
|
+
}
|
|
1075
|
+
export interface BulkCancelEventsByFilterRequest {
|
|
1076
|
+
/** 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). */
|
|
1077
|
+
filter?: QueryV2;
|
|
1078
|
+
}
|
|
1079
|
+
export interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
1080
|
+
/** Paging options. Can't be used together with `cursorPaging`. */
|
|
1081
|
+
paging?: Paging;
|
|
1082
|
+
/**
|
|
1083
|
+
* Filter object in the following format:
|
|
1084
|
+
* `"filter" : {
|
|
1085
|
+
* "fieldName1": "value1",
|
|
1086
|
+
* "fieldName2":{"$operator":"value2"}
|
|
1087
|
+
* }`
|
|
1088
|
+
*/
|
|
1089
|
+
filter?: Record<string, any> | null;
|
|
1090
|
+
/**
|
|
1091
|
+
* Sort object in the following format:
|
|
1092
|
+
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
1093
|
+
*/
|
|
1094
|
+
sort?: Sorting[];
|
|
1095
|
+
}
|
|
1096
|
+
/** @oneof */
|
|
1097
|
+
export interface QueryV2PagingMethodOneOf {
|
|
1098
|
+
/** Paging options. Can't be used together with `cursorPaging`. */
|
|
1099
|
+
paging?: Paging;
|
|
1100
|
+
}
|
|
1101
|
+
export interface Sorting {
|
|
1102
|
+
/** Name of the field to sort by. */
|
|
1103
|
+
fieldName?: string;
|
|
1104
|
+
/**
|
|
1105
|
+
* Sort order.
|
|
1106
|
+
* Use `ASC` for ascending order or `DESC` for descending order.
|
|
1107
|
+
*
|
|
1108
|
+
* Default: `ASC`.
|
|
1109
|
+
*/
|
|
1110
|
+
order?: SortOrder;
|
|
1111
|
+
}
|
|
1112
|
+
export declare enum SortOrder {
|
|
1113
|
+
ASC = "ASC",
|
|
1114
|
+
DESC = "DESC"
|
|
1115
|
+
}
|
|
1116
|
+
export interface Paging {
|
|
1117
|
+
/** Number of items to return. See [Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging#getting-started_sorting-and-paging_paging) for more information. */
|
|
1118
|
+
limit?: number | null;
|
|
1119
|
+
/** Number of items to skip in the current sort order. */
|
|
1120
|
+
offset?: number | null;
|
|
1121
|
+
}
|
|
1122
|
+
export interface BulkCancelEventsByFilterResponse {
|
|
1123
|
+
}
|
|
1124
|
+
export interface DeleteEventRequest {
|
|
1125
|
+
/** Event ID. */
|
|
1126
|
+
eventId: string;
|
|
1127
|
+
}
|
|
1128
|
+
export interface DeleteEventResponse {
|
|
1129
|
+
/** Deleted event ID. */
|
|
1130
|
+
eventId?: string;
|
|
1131
|
+
}
|
|
1132
|
+
export interface BulkDeleteEventsByFilterRequest {
|
|
1133
|
+
/** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
|
|
1134
|
+
filter?: QueryV2;
|
|
1135
|
+
}
|
|
1136
|
+
export interface BulkDeleteEventsByFilterResponse {
|
|
1137
|
+
}
|
|
1138
|
+
export interface QueryEventsRequest {
|
|
1139
|
+
/** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
|
|
1140
|
+
query?: QueryV2;
|
|
1141
|
+
/**
|
|
1142
|
+
* Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
|
|
1143
|
+
* - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
|
|
1144
|
+
* - `TEXTS`: Returns `detailedDescription`.
|
|
1145
|
+
* - `REGISTRATION`: Returns `registration`.
|
|
1146
|
+
* - `URLS`: Returns `eventPageUrl`.
|
|
1147
|
+
* - `FORM`: Returns `form`.
|
|
1148
|
+
* - `DASHBOARD`: Returns `summaries`.
|
|
1149
|
+
* - `FEED`: Returns `feed`.
|
|
1150
|
+
* - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
|
|
1151
|
+
* - `SEO_SETTINGS`: Returns `seoSettings`.
|
|
1152
|
+
* - `AGENDA`: Returns `agendaSettings`.
|
|
1153
|
+
* - `CATEGORIES`: Returns `categories`.
|
|
1154
|
+
*/
|
|
1155
|
+
fields?: RequestedFields[];
|
|
1156
|
+
/**
|
|
1157
|
+
* Whether draft events should be returned in the response.
|
|
1158
|
+
* This parameter requires the `WIX_EVENTS.MANAGE_EVENTS` permission.
|
|
1159
|
+
*/
|
|
1160
|
+
includeDrafts?: boolean;
|
|
1161
|
+
}
|
|
1162
|
+
export interface QueryEventsResponse {
|
|
1163
|
+
/** Metadata for the paginated results. */
|
|
1164
|
+
pagingMetadata?: PagingMetadataV2;
|
|
1165
|
+
/** List of events. */
|
|
1166
|
+
events?: Event[];
|
|
1167
|
+
}
|
|
1168
|
+
export interface PagingMetadataV2 {
|
|
1169
|
+
/** Number of items to return. See [Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging#getting-started_sorting-and-paging_paging) for more information. */
|
|
1170
|
+
count?: number | null;
|
|
1171
|
+
/** Requested offset. */
|
|
1172
|
+
offset?: number | null;
|
|
1173
|
+
/** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
|
|
1174
|
+
total?: number | null;
|
|
1175
|
+
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
1176
|
+
tooManyToCount?: boolean | null;
|
|
1177
|
+
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
1178
|
+
cursors?: Cursors;
|
|
1179
|
+
}
|
|
1180
|
+
export interface Cursors {
|
|
1181
|
+
/** Cursor pointing to the next page in the list of results. */
|
|
1182
|
+
next?: string | null;
|
|
1183
|
+
/** Cursor pointing to the previous page in the list of results. */
|
|
1184
|
+
prev?: string | null;
|
|
1185
|
+
}
|
|
1186
|
+
export interface CountEventsByStatusRequest {
|
|
1187
|
+
/** Filter object in the following format: <br/> `"filter" : { "fieldName1": "value1" }`. */
|
|
1188
|
+
filter?: Record<string, any> | null;
|
|
1189
|
+
/**
|
|
1190
|
+
* Parameters to count events by.
|
|
1191
|
+
*
|
|
1192
|
+
* - Max: 20 facets
|
|
1193
|
+
*/
|
|
1194
|
+
facet?: string[];
|
|
1195
|
+
/**
|
|
1196
|
+
* Whether draft events should be returned in the response.
|
|
1197
|
+
* This parameter requires the `WIX_EVENTS.MANAGE_EVENTS` permission.
|
|
1198
|
+
*/
|
|
1199
|
+
includeDrafts?: boolean;
|
|
1200
|
+
}
|
|
1201
|
+
export interface CountEventsByStatusResponse {
|
|
1202
|
+
/** Metadata for the paginated results. */
|
|
1203
|
+
pagingMetadata?: PagingMetadataV2;
|
|
1204
|
+
/** Filter facets. */
|
|
1205
|
+
facets?: Record<string, FacetCounts>;
|
|
1206
|
+
}
|
|
1207
|
+
export interface FacetCounts {
|
|
1208
|
+
/** Facet counts aggregated per value */
|
|
1209
|
+
counts?: Record<string, number>;
|
|
1210
|
+
}
|
|
1211
|
+
export interface ListUserEventsRequest {
|
|
1212
|
+
/** Paging options to limit and skip the number of items. */
|
|
1213
|
+
paging?: Paging;
|
|
1214
|
+
/**
|
|
1215
|
+
* Sort order, defaults to `"created:asc"`.
|
|
1216
|
+
* 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).
|
|
1217
|
+
*/
|
|
1218
|
+
sort?: Sorting[];
|
|
1219
|
+
/** Event status. */
|
|
1220
|
+
status?: Status[];
|
|
1221
|
+
/**
|
|
1222
|
+
* Wix user filter, by default any.
|
|
1223
|
+
* Allows to filter events by user relation to the event among all wix sites.
|
|
1224
|
+
*/
|
|
1225
|
+
userFilter?: UserFilter;
|
|
1226
|
+
/**
|
|
1227
|
+
* Filter facets to include in the response.
|
|
1228
|
+
* 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).
|
|
1229
|
+
*/
|
|
1230
|
+
facet?: string[];
|
|
1231
|
+
}
|
|
1232
|
+
export interface UserFilter {
|
|
1233
|
+
/** User who is related to event */
|
|
1234
|
+
userId?: string;
|
|
1235
|
+
/** Relation of user to event */
|
|
1236
|
+
relation?: Relation[];
|
|
1237
|
+
}
|
|
1238
|
+
export declare enum Relation {
|
|
1239
|
+
/**
|
|
1240
|
+
* User is attending the event.
|
|
1241
|
+
* User has RSVP with status YES or has ordered tickets.
|
|
1242
|
+
*/
|
|
1243
|
+
ATTENDING = "ATTENDING"
|
|
1244
|
+
}
|
|
1245
|
+
export interface ListUserEventsResponse {
|
|
1246
|
+
/** Metadata for the paginated results. */
|
|
1247
|
+
pagingMetadata?: PagingMetadataV2;
|
|
1248
|
+
/** List of events. */
|
|
1249
|
+
events?: Event[];
|
|
1250
|
+
/** Filter facets. */
|
|
1251
|
+
facets?: Record<string, FacetCounts>;
|
|
1252
|
+
}
|
|
1253
|
+
export interface ListEventsByCategoryRequest {
|
|
1254
|
+
/** Category ID. */
|
|
1255
|
+
categoryId?: string;
|
|
1256
|
+
/** Paging options to limit and skip the number of items. */
|
|
1257
|
+
paging?: Paging;
|
|
1258
|
+
/**
|
|
1259
|
+
* Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
|
|
1260
|
+
* - `DETAILS`: Returns `shortDescription`, `mainImage`, and `calendarUrls`.
|
|
1261
|
+
* - `TEXTS`: Returns `detailedDescription`.
|
|
1262
|
+
* - `REGISTRATION`: Returns `registration`.
|
|
1263
|
+
* - `URLS`: Returns `eventPageUrl`.
|
|
1264
|
+
* - `FORM`: Returns `form`.
|
|
1265
|
+
* - `DASHBOARD`: Returns `summaries`.
|
|
1266
|
+
* - `FEED`: Returns `feed`.
|
|
1267
|
+
* - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
|
|
1268
|
+
* - `SEO_SETTINGS`: Returns `seoSettings`.
|
|
1269
|
+
* - `AGENDA`: Returns `agendaSettings`.
|
|
1270
|
+
* - `CATEGORIES`: Returns `categories`.
|
|
1271
|
+
*/
|
|
1272
|
+
fields?: RequestedFields[];
|
|
1273
|
+
}
|
|
1274
|
+
export interface ListEventsByCategoryResponse {
|
|
1275
|
+
/** Metadata for the paginated results. */
|
|
1276
|
+
pagingMetadata?: PagingMetadataV2;
|
|
1277
|
+
/** List of events. */
|
|
1278
|
+
events?: Event[];
|
|
1279
|
+
}
|
|
1280
|
+
export interface GetEventRequest {
|
|
1281
|
+
/** Event ID. */
|
|
1282
|
+
eventId: string | null;
|
|
1283
|
+
/**
|
|
1284
|
+
* Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
|
|
1285
|
+
* - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
|
|
1286
|
+
* - `TEXTS`: Returns `detailedDescription`.
|
|
1287
|
+
* - `REGISTRATION`: Returns `registration`.
|
|
1288
|
+
* - `URLS`: Returns `eventPageUrl`.
|
|
1289
|
+
* - `FORM`: Returns `form`.
|
|
1290
|
+
* - `DASHBOARD`: Returns `summaries`.
|
|
1291
|
+
* - `FEED`: Returns `feed`.
|
|
1292
|
+
* - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
|
|
1293
|
+
* - `SEO_SETTINGS`: Returns `seoSettings`.
|
|
1294
|
+
* - `AGENDA`: Returns `agendaSettings`.
|
|
1295
|
+
* - `CATEGORIES`: Returns `categories`.
|
|
1296
|
+
*/
|
|
1297
|
+
fields?: RequestedFields[];
|
|
1298
|
+
}
|
|
1299
|
+
export interface GetEventResponse {
|
|
1300
|
+
/** Event. */
|
|
1301
|
+
event?: Event;
|
|
1302
|
+
}
|
|
1303
|
+
export interface GetEventBySlugRequest {
|
|
1304
|
+
/** URL slug. */
|
|
1305
|
+
slug: string | null;
|
|
1306
|
+
/**
|
|
1307
|
+
* Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
|
|
1308
|
+
* - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
|
|
1309
|
+
* - `TEXTS`: Returns `detailedDescription`.
|
|
1310
|
+
* - `REGISTRATION`: Returns `registration`.
|
|
1311
|
+
* - `URLS`: Returns `eventPageUrl`.
|
|
1312
|
+
* - `FORM`: Returns `form`.
|
|
1313
|
+
* - `DASHBOARD`: Returns `summaries`.
|
|
1314
|
+
* - `FEED`: Returns `feed`.
|
|
1315
|
+
* - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
|
|
1316
|
+
* - `SEO_SETTINGS`: Returns `seoSettings`.
|
|
1317
|
+
* - `AGENDA`: Returns `agendaSettings`.
|
|
1318
|
+
* - `CATEGORIES`: Returns `categories`.
|
|
1319
|
+
*/
|
|
1320
|
+
fields?: RequestedFields[];
|
|
1321
|
+
}
|
|
1322
|
+
export interface GetEventBySlugResponse {
|
|
1323
|
+
/** Event. */
|
|
1324
|
+
event?: Event;
|
|
1325
|
+
}
|
|
1326
|
+
export interface FindEventRequest extends FindEventRequestFindByOneOf {
|
|
1327
|
+
/** Event ID. */
|
|
1328
|
+
eventId?: string | null;
|
|
1329
|
+
/** URL slug. */
|
|
1330
|
+
slug?: string | null;
|
|
1331
|
+
/**
|
|
1332
|
+
* 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).
|
|
1333
|
+
* Some fields require additional computation that affects latency.
|
|
1334
|
+
* Use minimum set of required fieldset for best performance.
|
|
1335
|
+
*/
|
|
1336
|
+
fields?: RequestedFields[];
|
|
1337
|
+
}
|
|
1338
|
+
/** @oneof */
|
|
1339
|
+
export interface FindEventRequestFindByOneOf {
|
|
1340
|
+
/** Event ID. */
|
|
1341
|
+
eventId?: string | null;
|
|
1342
|
+
/** URL slug. */
|
|
1343
|
+
slug?: string | null;
|
|
1344
|
+
}
|
|
1345
|
+
export interface FindEventResponse {
|
|
1346
|
+
/** Event. */
|
|
1347
|
+
event?: Event;
|
|
1348
|
+
}
|
|
1349
|
+
export interface EventDeleted {
|
|
1350
|
+
/** Event deleted timestamp in ISO UTC format. */
|
|
1351
|
+
timestamp?: Date;
|
|
1352
|
+
/** Event ID. */
|
|
1353
|
+
eventId?: string;
|
|
1354
|
+
/** Event title. */
|
|
1355
|
+
title?: string;
|
|
1356
|
+
/** Event creator user ID. */
|
|
1357
|
+
userId?: string | null;
|
|
1358
|
+
}
|
|
1359
|
+
export interface Empty {
|
|
1360
|
+
}
|
|
1361
|
+
export interface EventCopied {
|
|
1362
|
+
/** Event created timestamp in ISO UTC format. */
|
|
1363
|
+
timestamp?: Date;
|
|
1364
|
+
/** Event ID. */
|
|
1365
|
+
eventId?: string;
|
|
1366
|
+
/** Event location. */
|
|
1367
|
+
location?: EventsLocation;
|
|
1368
|
+
/** Event schedule configuration. */
|
|
1369
|
+
scheduleConfig?: ScheduleConfig;
|
|
1370
|
+
/** Event title. */
|
|
1371
|
+
title?: string;
|
|
1372
|
+
/** Event creator user ID. */
|
|
1373
|
+
userId?: string | null;
|
|
1374
|
+
/** Event status. */
|
|
1375
|
+
status?: EventStatus;
|
|
1376
|
+
/** Instance ID. Indicates the original app instance which current event was derived from. */
|
|
1377
|
+
derivedFromInstanceId?: string | null;
|
|
1378
|
+
/** Event ID. Indicates the original event which current event was derived from. */
|
|
1379
|
+
derivedFromEventId?: string | null;
|
|
1380
|
+
/**
|
|
1381
|
+
* Map of copied ticket definitions from original event.
|
|
1382
|
+
* Key represents ticket def id in the original event.
|
|
1383
|
+
* Value represents ticket def id in the newly created event.
|
|
1384
|
+
*/
|
|
1385
|
+
ticketDefinitions?: Record<string, string>;
|
|
1386
|
+
}
|
|
1387
|
+
export interface EventsLocation {
|
|
1388
|
+
/** Location name. */
|
|
1389
|
+
name?: string | null;
|
|
1390
|
+
/** Location map coordinates. */
|
|
1391
|
+
coordinates?: MapCoordinates;
|
|
1392
|
+
/** Single line address representation. */
|
|
1393
|
+
address?: string | null;
|
|
1394
|
+
/** Location type. */
|
|
1395
|
+
type?: LocationLocationType;
|
|
1396
|
+
/**
|
|
1397
|
+
* Full address derived from formatted single line `address`.
|
|
1398
|
+
* When `full_address` is used to create or update the event, deprecated `address` and `coordinates` are ignored.
|
|
1399
|
+
* If provided `full_address` has empty `formatted_address` or `coordinates`, it will be auto-completed using Atlas service.
|
|
1400
|
+
*
|
|
1401
|
+
* Migration notes:
|
|
1402
|
+
* - `full_address.formatted_address` is equivalent to `address`.
|
|
1403
|
+
* - `full_address.geocode` is equivalent to `coordinates`.
|
|
1404
|
+
*/
|
|
1405
|
+
fullAddress?: Address;
|
|
1406
|
+
/**
|
|
1407
|
+
* Defines event location as TBD (To Be Determined).
|
|
1408
|
+
* When event location is not yet defined, `name` is displayed instead of location address.
|
|
1409
|
+
* `coordinates`, `address`, `type` and `full_address` are not required when location is TBD.
|
|
1410
|
+
*/
|
|
1411
|
+
tbd?: boolean | null;
|
|
1412
|
+
}
|
|
1413
|
+
export interface MapCoordinates {
|
|
1414
|
+
/** Latitude. */
|
|
1415
|
+
lat?: number;
|
|
1416
|
+
/** Longitude. */
|
|
1417
|
+
lng?: number;
|
|
1418
|
+
}
|
|
1419
|
+
export declare enum LocationLocationType {
|
|
1420
|
+
VENUE = "VENUE",
|
|
1421
|
+
ONLINE = "ONLINE"
|
|
1422
|
+
}
|
|
1423
|
+
/** Physical address */
|
|
1424
|
+
export interface Address extends AddressStreetOneOf {
|
|
1425
|
+
/** a break down of the street to number and street name */
|
|
1426
|
+
streetAddress?: StreetAddress;
|
|
1427
|
+
/** Main address line (usually street and number) as free text */
|
|
1428
|
+
addressLine1?: string | null;
|
|
1429
|
+
/** country code */
|
|
1430
|
+
country?: string | null;
|
|
1431
|
+
/** subdivision (usually state or region) code according to ISO 3166-2 */
|
|
1432
|
+
subdivision?: string | null;
|
|
1433
|
+
/** city name */
|
|
1434
|
+
city?: string | null;
|
|
1435
|
+
/** zip/postal code */
|
|
1436
|
+
postalCode?: string | null;
|
|
1437
|
+
/** Free text providing more detailed address info. Usually contains Apt, Suite, Floor */
|
|
1438
|
+
addressLine2?: string | null;
|
|
1439
|
+
/** A string containing the human-readable address of this location */
|
|
1440
|
+
formatted?: string | null;
|
|
1441
|
+
/** coordinates of the physical address */
|
|
1442
|
+
location?: AddressLocation;
|
|
1443
|
+
}
|
|
1444
|
+
/** @oneof */
|
|
1445
|
+
export interface AddressStreetOneOf {
|
|
1446
|
+
/** a break down of the street to number and street name */
|
|
1447
|
+
streetAddress?: StreetAddress;
|
|
1448
|
+
/** Main address line (usually street and number) as free text */
|
|
1449
|
+
addressLine?: string | null;
|
|
1450
|
+
}
|
|
1451
|
+
export interface StreetAddress {
|
|
1452
|
+
/** street number */
|
|
1453
|
+
number?: string;
|
|
1454
|
+
/** street name */
|
|
1455
|
+
name?: string;
|
|
1456
|
+
}
|
|
1457
|
+
export interface AddressLocation {
|
|
1458
|
+
/** address latitude coordinates */
|
|
1459
|
+
latitude?: number | null;
|
|
1460
|
+
/** address longitude coordinates */
|
|
1461
|
+
longitude?: number | null;
|
|
1462
|
+
}
|
|
1463
|
+
export interface Subdivision {
|
|
1464
|
+
/** subdivision short code */
|
|
1465
|
+
code?: string;
|
|
1466
|
+
/** subdivision full-name */
|
|
1467
|
+
name?: string;
|
|
1468
|
+
}
|
|
1469
|
+
export declare enum SubdivisionType {
|
|
1470
|
+
UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
|
|
1471
|
+
/** State */
|
|
1472
|
+
ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
|
|
1473
|
+
/** County */
|
|
1474
|
+
ADMINISTRATIVE_AREA_LEVEL_2 = "ADMINISTRATIVE_AREA_LEVEL_2",
|
|
1475
|
+
/** City/town */
|
|
1476
|
+
ADMINISTRATIVE_AREA_LEVEL_3 = "ADMINISTRATIVE_AREA_LEVEL_3",
|
|
1477
|
+
/** Neighborhood/quarter */
|
|
1478
|
+
ADMINISTRATIVE_AREA_LEVEL_4 = "ADMINISTRATIVE_AREA_LEVEL_4",
|
|
1479
|
+
/** Street/block */
|
|
1480
|
+
ADMINISTRATIVE_AREA_LEVEL_5 = "ADMINISTRATIVE_AREA_LEVEL_5",
|
|
1481
|
+
/** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
|
|
1482
|
+
COUNTRY = "COUNTRY"
|
|
1483
|
+
}
|
|
1484
|
+
export interface ScheduleConfig {
|
|
1485
|
+
/**
|
|
1486
|
+
* Defines event as TBD (To Be Determined) schedule.
|
|
1487
|
+
* When event time is not yet defined, TBD message is displayed instead of event start and end times.
|
|
1488
|
+
* `startDate`, `endDate` and `timeZoneId` are not required when schedule is TBD.
|
|
1489
|
+
*/
|
|
1490
|
+
scheduleTbd?: boolean;
|
|
1491
|
+
/** TBD message. */
|
|
1492
|
+
scheduleTbdMessage?: string | null;
|
|
1493
|
+
/** Event start timestamp. */
|
|
1494
|
+
startDate?: Date;
|
|
1495
|
+
/** Event end timestamp. */
|
|
1496
|
+
endDate?: Date;
|
|
1497
|
+
/** Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`. */
|
|
1498
|
+
timeZoneId?: string | null;
|
|
1499
|
+
/** Whether end date is hidden in the formatted schedule. */
|
|
1500
|
+
endDateHidden?: boolean;
|
|
1501
|
+
/** Whether time zone is displayed in formatted schedule. */
|
|
1502
|
+
showTimeZone?: boolean;
|
|
1503
|
+
/** Event recurrences. */
|
|
1504
|
+
recurrences?: EventsRecurrences;
|
|
1505
|
+
}
|
|
1506
|
+
export interface EventsRecurrences {
|
|
1507
|
+
/** Event occurrences. */
|
|
1508
|
+
occurrences?: EventsOccurrence[];
|
|
1509
|
+
/**
|
|
1510
|
+
* Recurring event category ID.
|
|
1511
|
+
* @readonly
|
|
1512
|
+
*/
|
|
1513
|
+
categoryId?: string | null;
|
|
1514
|
+
/**
|
|
1515
|
+
* Recurrence status.
|
|
1516
|
+
* @readonly
|
|
1517
|
+
*/
|
|
1518
|
+
status?: EventsRecurrenceStatusStatus;
|
|
1519
|
+
}
|
|
1520
|
+
export interface EventsOccurrence {
|
|
1521
|
+
/** Event start timestamp. */
|
|
1522
|
+
startDate?: Date;
|
|
1523
|
+
/** Event end timestamp. */
|
|
1524
|
+
endDate?: Date;
|
|
1525
|
+
/** Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`. */
|
|
1526
|
+
timeZoneId?: string | null;
|
|
1527
|
+
/** Whether time zone is displayed in formatted schedule. */
|
|
1528
|
+
showTimeZone?: boolean;
|
|
1529
|
+
}
|
|
1530
|
+
export declare enum EventsRecurrenceStatusStatus {
|
|
1531
|
+
/** Event occurs only once. */
|
|
1532
|
+
ONE_TIME = "ONE_TIME",
|
|
1533
|
+
/** Event is recurring. */
|
|
1534
|
+
RECURRING = "RECURRING",
|
|
1535
|
+
/** Marks the next upcoming occurrence of the recurring event. */
|
|
1536
|
+
RECURRING_NEXT = "RECURRING_NEXT",
|
|
1537
|
+
/** Marks the most recent ended occurrence of the recurring event. */
|
|
1538
|
+
RECURRING_LAST_ENDED = "RECURRING_LAST_ENDED",
|
|
1539
|
+
/** Marks the most recent canceled occurrence of the recurring event. */
|
|
1540
|
+
RECURRING_LAST_CANCELED = "RECURRING_LAST_CANCELED"
|
|
1541
|
+
}
|
|
1542
|
+
export declare enum EventStatus {
|
|
1543
|
+
/** Event is public and scheduled to start */
|
|
1544
|
+
SCHEDULED = "SCHEDULED",
|
|
1545
|
+
/** Event has started */
|
|
1546
|
+
STARTED = "STARTED",
|
|
1547
|
+
/** Event has ended */
|
|
1548
|
+
ENDED = "ENDED",
|
|
1549
|
+
/** Event was canceled */
|
|
1550
|
+
CANCELED = "CANCELED",
|
|
1551
|
+
/** Event is not public and needs to be published */
|
|
1552
|
+
DRAFT = "DRAFT"
|
|
1553
|
+
}
|
|
1554
|
+
export interface EventPublished {
|
|
1555
|
+
/** Event publish timestamp in ISO UTC format. */
|
|
1556
|
+
timestamp?: Date;
|
|
1557
|
+
/** Event ID. */
|
|
1558
|
+
eventId?: string;
|
|
1559
|
+
/** Event status. */
|
|
1560
|
+
status?: EventStatus;
|
|
1561
|
+
/**
|
|
1562
|
+
* Event ID. Indicates the original event which current event was derived from.
|
|
1563
|
+
* Can be used to track the original event and add missing information.
|
|
1564
|
+
*/
|
|
1565
|
+
derivedFromEventId?: string | null;
|
|
1566
|
+
}
|
|
1567
|
+
export interface EventCanceled {
|
|
1568
|
+
/** Event canceled timestamp in ISO UTC format. */
|
|
1569
|
+
timestamp?: Date;
|
|
1570
|
+
/** Event ID. */
|
|
1571
|
+
eventId?: string;
|
|
1572
|
+
/** Event title */
|
|
1573
|
+
title?: string;
|
|
1574
|
+
/** Event creator user ID. */
|
|
1575
|
+
userId?: string | null;
|
|
1576
|
+
}
|
|
1577
|
+
export interface EventStarted {
|
|
1578
|
+
/** Event start timestamp in ISO UTC format. */
|
|
1579
|
+
timestamp?: Date;
|
|
1580
|
+
/** Event ID. */
|
|
1581
|
+
eventId?: string;
|
|
1582
|
+
}
|
|
1583
|
+
export interface EventEnded {
|
|
1584
|
+
/** Event end timestamp in ISO UTC format. */
|
|
1585
|
+
timestamp?: Date;
|
|
1586
|
+
/** Event ID. */
|
|
1587
|
+
eventId?: string;
|
|
1588
|
+
}
|
|
1589
|
+
export interface EventReminder {
|
|
1590
|
+
/** Reminder timestamp in ISO UTC format. */
|
|
1591
|
+
timestamp?: Date;
|
|
1592
|
+
/** Event ID. */
|
|
1593
|
+
eventId?: string;
|
|
1594
|
+
/** Event location. */
|
|
1595
|
+
location?: EventsLocation;
|
|
1596
|
+
/** Event schedule configuration. */
|
|
1597
|
+
scheduleConfig?: ScheduleConfig;
|
|
1598
|
+
/** Event title. */
|
|
1599
|
+
title?: string;
|
|
1600
|
+
/** Event creator user ID. */
|
|
1601
|
+
userId?: string | null;
|
|
1602
|
+
/** Time until the event starts (currently, reminder is triggered 1 day before event starts). */
|
|
1603
|
+
startsIn?: TimeDuration;
|
|
1604
|
+
}
|
|
1605
|
+
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
1606
|
+
createdEvent?: EntityCreatedEvent;
|
|
1607
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
1608
|
+
deletedEvent?: EntityDeletedEvent;
|
|
1609
|
+
actionEvent?: ActionEvent;
|
|
1610
|
+
/**
|
|
1611
|
+
* Unique event ID.
|
|
1612
|
+
* Allows clients to ignore duplicate webhooks.
|
|
1613
|
+
*/
|
|
1614
|
+
_id?: string;
|
|
1615
|
+
/**
|
|
1616
|
+
* Assumes actions are also always typed to an entity_type
|
|
1617
|
+
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
1618
|
+
*/
|
|
1619
|
+
entityFqdn?: string;
|
|
1620
|
+
/**
|
|
1621
|
+
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
1622
|
+
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
1623
|
+
* Example: created/updated/deleted/started/completed/email_opened
|
|
1624
|
+
*/
|
|
1625
|
+
slug?: string;
|
|
1626
|
+
/** ID of the entity associated with the event. */
|
|
1627
|
+
entityId?: string;
|
|
1628
|
+
/** Event timestamp. */
|
|
1629
|
+
eventTime?: Date;
|
|
1630
|
+
/**
|
|
1631
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
1632
|
+
* (for example, GDPR).
|
|
1633
|
+
*/
|
|
1634
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
1635
|
+
/** If present, indicates the action that triggered the event. */
|
|
1636
|
+
originatedFrom?: string | null;
|
|
1637
|
+
/**
|
|
1638
|
+
* A sequence number defining the order of updates to the underlying entity.
|
|
1639
|
+
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
1640
|
+
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
1641
|
+
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
1642
|
+
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
1643
|
+
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
1644
|
+
*/
|
|
1645
|
+
entityEventSequence?: string | null;
|
|
1646
|
+
}
|
|
1647
|
+
/** @oneof */
|
|
1648
|
+
export interface DomainEventBodyOneOf {
|
|
1649
|
+
createdEvent?: EntityCreatedEvent;
|
|
1650
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
1651
|
+
deletedEvent?: EntityDeletedEvent;
|
|
1652
|
+
actionEvent?: ActionEvent;
|
|
1653
|
+
}
|
|
1654
|
+
export interface EntityCreatedEvent {
|
|
1655
|
+
entityAsJson?: string;
|
|
1656
|
+
}
|
|
1657
|
+
export interface EntityUpdatedEvent {
|
|
1658
|
+
/**
|
|
1659
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
1660
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
1661
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
1662
|
+
*/
|
|
1663
|
+
currentEntityAsJson?: string;
|
|
1664
|
+
}
|
|
1665
|
+
export interface EntityDeletedEvent {
|
|
1666
|
+
/** Entity that was deleted */
|
|
1667
|
+
deletedEntityAsJson?: string | null;
|
|
1668
|
+
}
|
|
1669
|
+
export interface ActionEvent {
|
|
1670
|
+
bodyAsJson?: string;
|
|
1671
|
+
}
|
|
1672
|
+
export interface CreateEventResponseNonNullableFields {
|
|
1673
|
+
event?: {
|
|
1674
|
+
_id: string;
|
|
1675
|
+
location?: {
|
|
1676
|
+
type: LocationType;
|
|
1677
|
+
};
|
|
1678
|
+
dateAndTimeSettings?: {
|
|
1679
|
+
recurrenceStatus: RecurrenceStatusStatus;
|
|
1680
|
+
recurringEvents?: {
|
|
1681
|
+
individualEventDates: {
|
|
1682
|
+
showTimeZone: boolean;
|
|
1683
|
+
}[];
|
|
1684
|
+
};
|
|
1685
|
+
};
|
|
1686
|
+
mainImage: string;
|
|
1687
|
+
slug: string;
|
|
1688
|
+
status: Status;
|
|
1689
|
+
registration?: {
|
|
1690
|
+
type: RegistrationTypeType;
|
|
1691
|
+
status: RegistrationStatusStatus;
|
|
1692
|
+
rsvp?: {
|
|
1693
|
+
responseType: ResponseType;
|
|
1694
|
+
waitlistEnabled: boolean;
|
|
1695
|
+
};
|
|
1696
|
+
tickets?: {
|
|
1697
|
+
guestsAssignedSeparately: boolean;
|
|
1698
|
+
ticketLimitPerOrder: number;
|
|
1699
|
+
lowestPrice?: {
|
|
1700
|
+
value: string;
|
|
1701
|
+
currency: string;
|
|
1702
|
+
};
|
|
1703
|
+
highestPrice?: {
|
|
1704
|
+
value: string;
|
|
1705
|
+
currency: string;
|
|
1706
|
+
};
|
|
1707
|
+
taxSettings?: {
|
|
1708
|
+
type: TaxType;
|
|
1709
|
+
};
|
|
1710
|
+
};
|
|
1711
|
+
allowedGuestTypes: GuestTypeType;
|
|
1712
|
+
initialType: InitialRegistrationTypeType;
|
|
1713
|
+
registrationPaused: boolean;
|
|
1714
|
+
registrationDisabled: boolean;
|
|
1715
|
+
};
|
|
1716
|
+
calendarUrls?: {
|
|
1717
|
+
google: string;
|
|
1718
|
+
ics: string;
|
|
1719
|
+
};
|
|
1720
|
+
eventPageUrl: string;
|
|
1721
|
+
form?: {
|
|
1722
|
+
controls: {
|
|
1723
|
+
type: InputControlType;
|
|
1724
|
+
system: boolean;
|
|
1725
|
+
name: string;
|
|
1726
|
+
inputs: {
|
|
1727
|
+
name: string;
|
|
1728
|
+
array: boolean;
|
|
1729
|
+
label: string;
|
|
1730
|
+
options: string[];
|
|
1731
|
+
mandatory: boolean;
|
|
1732
|
+
maxLength: number;
|
|
1733
|
+
type: ValueType;
|
|
1734
|
+
defaultOptionSelection?: {
|
|
1735
|
+
optionIndex: number;
|
|
1736
|
+
placeholderText: string;
|
|
1737
|
+
};
|
|
1738
|
+
labels: {
|
|
1739
|
+
name: string;
|
|
1740
|
+
label: string;
|
|
1741
|
+
}[];
|
|
1742
|
+
}[];
|
|
1743
|
+
label: string;
|
|
1744
|
+
orderIndex: number;
|
|
1745
|
+
_id: string;
|
|
1746
|
+
}[];
|
|
1747
|
+
messages?: {
|
|
1748
|
+
rsvp?: {
|
|
1749
|
+
rsvpYesOption: string;
|
|
1750
|
+
rsvpNoOption: string;
|
|
1751
|
+
positiveMessages?: {
|
|
1752
|
+
title: string;
|
|
1753
|
+
confirmation?: {
|
|
1754
|
+
title: string;
|
|
1755
|
+
message: string;
|
|
1756
|
+
addToCalendarActionLabel: string;
|
|
1757
|
+
shareActionLabel: string;
|
|
1758
|
+
};
|
|
1759
|
+
};
|
|
1760
|
+
waitlistMessages?: {
|
|
1761
|
+
title: string;
|
|
1762
|
+
confirmation?: {
|
|
1763
|
+
title: string;
|
|
1764
|
+
message: string;
|
|
1765
|
+
addToCalendarActionLabel: string;
|
|
1766
|
+
shareActionLabel: string;
|
|
1767
|
+
};
|
|
1768
|
+
};
|
|
1769
|
+
negativeMessages?: {
|
|
1770
|
+
title: string;
|
|
1771
|
+
confirmation?: {
|
|
1772
|
+
title: string;
|
|
1773
|
+
shareActionLabel: string;
|
|
1774
|
+
};
|
|
1775
|
+
};
|
|
1776
|
+
submitActionLabel: string;
|
|
1777
|
+
};
|
|
1778
|
+
checkout?: {
|
|
1779
|
+
title: string;
|
|
1780
|
+
submitActionLabel: string;
|
|
1781
|
+
confirmation?: {
|
|
1782
|
+
title: string;
|
|
1783
|
+
message: string;
|
|
1784
|
+
downloadTicketsLabel: string;
|
|
1785
|
+
addToCalendarLabel: string;
|
|
1786
|
+
shareEventLabel: string;
|
|
1787
|
+
};
|
|
1788
|
+
};
|
|
1789
|
+
registrationClosed?: {
|
|
1790
|
+
message: string;
|
|
1791
|
+
exploreEventsActionLabel: string;
|
|
1792
|
+
};
|
|
1793
|
+
ticketsUnavailable?: {
|
|
1794
|
+
message: string;
|
|
1795
|
+
exploreEventsActionLabel: string;
|
|
1796
|
+
};
|
|
1797
|
+
};
|
|
1798
|
+
};
|
|
1799
|
+
summaries?: {
|
|
1800
|
+
rsvps?: {
|
|
1801
|
+
totalCount: number;
|
|
1802
|
+
yesCount: number;
|
|
1803
|
+
noCount: number;
|
|
1804
|
+
waitlistCount: number;
|
|
1805
|
+
};
|
|
1806
|
+
tickets?: {
|
|
1807
|
+
ticketsSold: number;
|
|
1808
|
+
revenue?: {
|
|
1809
|
+
amount: string;
|
|
1810
|
+
currency: string;
|
|
1811
|
+
};
|
|
1812
|
+
currencyLocked: boolean;
|
|
1813
|
+
totalOrders: number;
|
|
1814
|
+
totalSales?: {
|
|
1815
|
+
amount: string;
|
|
1816
|
+
currency: string;
|
|
1817
|
+
};
|
|
1818
|
+
};
|
|
1819
|
+
};
|
|
1820
|
+
instanceId: string;
|
|
1821
|
+
guestListSettings?: {
|
|
1822
|
+
displayedPublicly: boolean;
|
|
1823
|
+
};
|
|
1824
|
+
userId: string;
|
|
1825
|
+
onlineConferencing?: {
|
|
1826
|
+
enabled: boolean;
|
|
1827
|
+
type: ConferenceTypeType;
|
|
1828
|
+
session?: {
|
|
1829
|
+
hostLink: string;
|
|
1830
|
+
guestLink: string;
|
|
1831
|
+
};
|
|
1832
|
+
};
|
|
1833
|
+
seoSettings?: {
|
|
1834
|
+
slug: string;
|
|
1835
|
+
advancedSeoData?: {
|
|
1836
|
+
tags: {
|
|
1837
|
+
type: string;
|
|
1838
|
+
children: string;
|
|
1839
|
+
custom: boolean;
|
|
1840
|
+
disabled: boolean;
|
|
1841
|
+
}[];
|
|
1842
|
+
settings?: {
|
|
1843
|
+
preventAutoRedirect: boolean;
|
|
1844
|
+
keywords: {
|
|
1845
|
+
term: string;
|
|
1846
|
+
isMain: boolean;
|
|
1847
|
+
}[];
|
|
1848
|
+
};
|
|
1849
|
+
};
|
|
1850
|
+
};
|
|
1851
|
+
agendaSettings?: {
|
|
1852
|
+
enabled: boolean;
|
|
1853
|
+
pageUrl: string;
|
|
1854
|
+
};
|
|
1855
|
+
};
|
|
1856
|
+
}
|
|
1857
|
+
export interface CloneEventResponseNonNullableFields {
|
|
1858
|
+
event?: {
|
|
1859
|
+
_id: string;
|
|
1860
|
+
location?: {
|
|
1861
|
+
type: LocationType;
|
|
1862
|
+
};
|
|
1863
|
+
dateAndTimeSettings?: {
|
|
1864
|
+
recurrenceStatus: RecurrenceStatusStatus;
|
|
1865
|
+
recurringEvents?: {
|
|
1866
|
+
individualEventDates: {
|
|
1867
|
+
showTimeZone: boolean;
|
|
1868
|
+
}[];
|
|
1869
|
+
};
|
|
1870
|
+
};
|
|
1871
|
+
mainImage: string;
|
|
1872
|
+
slug: string;
|
|
1873
|
+
status: Status;
|
|
1874
|
+
registration?: {
|
|
1875
|
+
type: RegistrationTypeType;
|
|
1876
|
+
status: RegistrationStatusStatus;
|
|
1877
|
+
rsvp?: {
|
|
1878
|
+
responseType: ResponseType;
|
|
1879
|
+
waitlistEnabled: boolean;
|
|
1880
|
+
};
|
|
1881
|
+
tickets?: {
|
|
1882
|
+
guestsAssignedSeparately: boolean;
|
|
1883
|
+
ticketLimitPerOrder: number;
|
|
1884
|
+
lowestPrice?: {
|
|
1885
|
+
value: string;
|
|
1886
|
+
currency: string;
|
|
1887
|
+
};
|
|
1888
|
+
highestPrice?: {
|
|
1889
|
+
value: string;
|
|
1890
|
+
currency: string;
|
|
1891
|
+
};
|
|
1892
|
+
taxSettings?: {
|
|
1893
|
+
type: TaxType;
|
|
1894
|
+
};
|
|
1895
|
+
};
|
|
1896
|
+
allowedGuestTypes: GuestTypeType;
|
|
1897
|
+
initialType: InitialRegistrationTypeType;
|
|
1898
|
+
registrationPaused: boolean;
|
|
1899
|
+
registrationDisabled: boolean;
|
|
1900
|
+
};
|
|
1901
|
+
calendarUrls?: {
|
|
1902
|
+
google: string;
|
|
1903
|
+
ics: string;
|
|
1904
|
+
};
|
|
1905
|
+
eventPageUrl: string;
|
|
1906
|
+
form?: {
|
|
1907
|
+
controls: {
|
|
1908
|
+
type: InputControlType;
|
|
1909
|
+
system: boolean;
|
|
1910
|
+
name: string;
|
|
1911
|
+
inputs: {
|
|
1912
|
+
name: string;
|
|
1913
|
+
array: boolean;
|
|
1914
|
+
label: string;
|
|
1915
|
+
options: string[];
|
|
1916
|
+
mandatory: boolean;
|
|
1917
|
+
maxLength: number;
|
|
1918
|
+
type: ValueType;
|
|
1919
|
+
defaultOptionSelection?: {
|
|
1920
|
+
optionIndex: number;
|
|
1921
|
+
placeholderText: string;
|
|
1922
|
+
};
|
|
1923
|
+
labels: {
|
|
1924
|
+
name: string;
|
|
1925
|
+
label: string;
|
|
1926
|
+
}[];
|
|
1927
|
+
}[];
|
|
1928
|
+
label: string;
|
|
1929
|
+
orderIndex: number;
|
|
1930
|
+
_id: string;
|
|
1931
|
+
}[];
|
|
1932
|
+
messages?: {
|
|
1933
|
+
rsvp?: {
|
|
1934
|
+
rsvpYesOption: string;
|
|
1935
|
+
rsvpNoOption: string;
|
|
1936
|
+
positiveMessages?: {
|
|
1937
|
+
title: string;
|
|
1938
|
+
confirmation?: {
|
|
1939
|
+
title: string;
|
|
1940
|
+
message: string;
|
|
1941
|
+
addToCalendarActionLabel: string;
|
|
1942
|
+
shareActionLabel: string;
|
|
1943
|
+
};
|
|
1944
|
+
};
|
|
1945
|
+
waitlistMessages?: {
|
|
1946
|
+
title: string;
|
|
1947
|
+
confirmation?: {
|
|
1948
|
+
title: string;
|
|
1949
|
+
message: string;
|
|
1950
|
+
addToCalendarActionLabel: string;
|
|
1951
|
+
shareActionLabel: string;
|
|
1952
|
+
};
|
|
1953
|
+
};
|
|
1954
|
+
negativeMessages?: {
|
|
1955
|
+
title: string;
|
|
1956
|
+
confirmation?: {
|
|
1957
|
+
title: string;
|
|
1958
|
+
shareActionLabel: string;
|
|
1959
|
+
};
|
|
1960
|
+
};
|
|
1961
|
+
submitActionLabel: string;
|
|
1962
|
+
};
|
|
1963
|
+
checkout?: {
|
|
1964
|
+
title: string;
|
|
1965
|
+
submitActionLabel: string;
|
|
1966
|
+
confirmation?: {
|
|
1967
|
+
title: string;
|
|
1968
|
+
message: string;
|
|
1969
|
+
downloadTicketsLabel: string;
|
|
1970
|
+
addToCalendarLabel: string;
|
|
1971
|
+
shareEventLabel: string;
|
|
1972
|
+
};
|
|
1973
|
+
};
|
|
1974
|
+
registrationClosed?: {
|
|
1975
|
+
message: string;
|
|
1976
|
+
exploreEventsActionLabel: string;
|
|
1977
|
+
};
|
|
1978
|
+
ticketsUnavailable?: {
|
|
1979
|
+
message: string;
|
|
1980
|
+
exploreEventsActionLabel: string;
|
|
1981
|
+
};
|
|
1982
|
+
};
|
|
1983
|
+
};
|
|
1984
|
+
summaries?: {
|
|
1985
|
+
rsvps?: {
|
|
1986
|
+
totalCount: number;
|
|
1987
|
+
yesCount: number;
|
|
1988
|
+
noCount: number;
|
|
1989
|
+
waitlistCount: number;
|
|
1990
|
+
};
|
|
1991
|
+
tickets?: {
|
|
1992
|
+
ticketsSold: number;
|
|
1993
|
+
revenue?: {
|
|
1994
|
+
amount: string;
|
|
1995
|
+
currency: string;
|
|
1996
|
+
};
|
|
1997
|
+
currencyLocked: boolean;
|
|
1998
|
+
totalOrders: number;
|
|
1999
|
+
totalSales?: {
|
|
2000
|
+
amount: string;
|
|
2001
|
+
currency: string;
|
|
2002
|
+
};
|
|
2003
|
+
};
|
|
2004
|
+
};
|
|
2005
|
+
instanceId: string;
|
|
2006
|
+
guestListSettings?: {
|
|
2007
|
+
displayedPublicly: boolean;
|
|
2008
|
+
};
|
|
2009
|
+
userId: string;
|
|
2010
|
+
onlineConferencing?: {
|
|
2011
|
+
enabled: boolean;
|
|
2012
|
+
type: ConferenceTypeType;
|
|
2013
|
+
session?: {
|
|
2014
|
+
hostLink: string;
|
|
2015
|
+
guestLink: string;
|
|
2016
|
+
};
|
|
2017
|
+
};
|
|
2018
|
+
seoSettings?: {
|
|
2019
|
+
slug: string;
|
|
2020
|
+
advancedSeoData?: {
|
|
2021
|
+
tags: {
|
|
2022
|
+
type: string;
|
|
2023
|
+
children: string;
|
|
2024
|
+
custom: boolean;
|
|
2025
|
+
disabled: boolean;
|
|
2026
|
+
}[];
|
|
2027
|
+
settings?: {
|
|
2028
|
+
preventAutoRedirect: boolean;
|
|
2029
|
+
keywords: {
|
|
2030
|
+
term: string;
|
|
2031
|
+
isMain: boolean;
|
|
2032
|
+
}[];
|
|
2033
|
+
};
|
|
2034
|
+
};
|
|
2035
|
+
};
|
|
2036
|
+
agendaSettings?: {
|
|
2037
|
+
enabled: boolean;
|
|
2038
|
+
pageUrl: string;
|
|
2039
|
+
};
|
|
2040
|
+
};
|
|
2041
|
+
}
|
|
2042
|
+
export interface UpdateEventResponseNonNullableFields {
|
|
2043
|
+
event?: {
|
|
2044
|
+
_id: string;
|
|
2045
|
+
location?: {
|
|
2046
|
+
type: LocationType;
|
|
2047
|
+
};
|
|
2048
|
+
dateAndTimeSettings?: {
|
|
2049
|
+
recurrenceStatus: RecurrenceStatusStatus;
|
|
2050
|
+
recurringEvents?: {
|
|
2051
|
+
individualEventDates: {
|
|
2052
|
+
showTimeZone: boolean;
|
|
2053
|
+
}[];
|
|
2054
|
+
};
|
|
2055
|
+
};
|
|
2056
|
+
mainImage: string;
|
|
2057
|
+
slug: string;
|
|
2058
|
+
status: Status;
|
|
2059
|
+
registration?: {
|
|
2060
|
+
type: RegistrationTypeType;
|
|
2061
|
+
status: RegistrationStatusStatus;
|
|
2062
|
+
rsvp?: {
|
|
2063
|
+
responseType: ResponseType;
|
|
2064
|
+
waitlistEnabled: boolean;
|
|
2065
|
+
};
|
|
2066
|
+
tickets?: {
|
|
2067
|
+
guestsAssignedSeparately: boolean;
|
|
2068
|
+
ticketLimitPerOrder: number;
|
|
2069
|
+
lowestPrice?: {
|
|
2070
|
+
value: string;
|
|
2071
|
+
currency: string;
|
|
2072
|
+
};
|
|
2073
|
+
highestPrice?: {
|
|
2074
|
+
value: string;
|
|
2075
|
+
currency: string;
|
|
2076
|
+
};
|
|
2077
|
+
taxSettings?: {
|
|
2078
|
+
type: TaxType;
|
|
2079
|
+
};
|
|
2080
|
+
};
|
|
2081
|
+
allowedGuestTypes: GuestTypeType;
|
|
2082
|
+
initialType: InitialRegistrationTypeType;
|
|
2083
|
+
registrationPaused: boolean;
|
|
2084
|
+
registrationDisabled: boolean;
|
|
2085
|
+
};
|
|
2086
|
+
calendarUrls?: {
|
|
2087
|
+
google: string;
|
|
2088
|
+
ics: string;
|
|
2089
|
+
};
|
|
2090
|
+
eventPageUrl: string;
|
|
2091
|
+
form?: {
|
|
2092
|
+
controls: {
|
|
2093
|
+
type: InputControlType;
|
|
2094
|
+
system: boolean;
|
|
2095
|
+
name: string;
|
|
2096
|
+
inputs: {
|
|
2097
|
+
name: string;
|
|
2098
|
+
array: boolean;
|
|
2099
|
+
label: string;
|
|
2100
|
+
options: string[];
|
|
2101
|
+
mandatory: boolean;
|
|
2102
|
+
maxLength: number;
|
|
2103
|
+
type: ValueType;
|
|
2104
|
+
defaultOptionSelection?: {
|
|
2105
|
+
optionIndex: number;
|
|
2106
|
+
placeholderText: string;
|
|
2107
|
+
};
|
|
2108
|
+
labels: {
|
|
2109
|
+
name: string;
|
|
2110
|
+
label: string;
|
|
2111
|
+
}[];
|
|
2112
|
+
}[];
|
|
2113
|
+
label: string;
|
|
2114
|
+
orderIndex: number;
|
|
2115
|
+
_id: string;
|
|
2116
|
+
}[];
|
|
2117
|
+
messages?: {
|
|
2118
|
+
rsvp?: {
|
|
2119
|
+
rsvpYesOption: string;
|
|
2120
|
+
rsvpNoOption: string;
|
|
2121
|
+
positiveMessages?: {
|
|
2122
|
+
title: string;
|
|
2123
|
+
confirmation?: {
|
|
2124
|
+
title: string;
|
|
2125
|
+
message: string;
|
|
2126
|
+
addToCalendarActionLabel: string;
|
|
2127
|
+
shareActionLabel: string;
|
|
2128
|
+
};
|
|
2129
|
+
};
|
|
2130
|
+
waitlistMessages?: {
|
|
2131
|
+
title: string;
|
|
2132
|
+
confirmation?: {
|
|
2133
|
+
title: string;
|
|
2134
|
+
message: string;
|
|
2135
|
+
addToCalendarActionLabel: string;
|
|
2136
|
+
shareActionLabel: string;
|
|
2137
|
+
};
|
|
2138
|
+
};
|
|
2139
|
+
negativeMessages?: {
|
|
2140
|
+
title: string;
|
|
2141
|
+
confirmation?: {
|
|
2142
|
+
title: string;
|
|
2143
|
+
shareActionLabel: string;
|
|
2144
|
+
};
|
|
2145
|
+
};
|
|
2146
|
+
submitActionLabel: string;
|
|
2147
|
+
};
|
|
2148
|
+
checkout?: {
|
|
2149
|
+
title: string;
|
|
2150
|
+
submitActionLabel: string;
|
|
2151
|
+
confirmation?: {
|
|
2152
|
+
title: string;
|
|
2153
|
+
message: string;
|
|
2154
|
+
downloadTicketsLabel: string;
|
|
2155
|
+
addToCalendarLabel: string;
|
|
2156
|
+
shareEventLabel: string;
|
|
2157
|
+
};
|
|
2158
|
+
};
|
|
2159
|
+
registrationClosed?: {
|
|
2160
|
+
message: string;
|
|
2161
|
+
exploreEventsActionLabel: string;
|
|
2162
|
+
};
|
|
2163
|
+
ticketsUnavailable?: {
|
|
2164
|
+
message: string;
|
|
2165
|
+
exploreEventsActionLabel: string;
|
|
2166
|
+
};
|
|
2167
|
+
};
|
|
2168
|
+
};
|
|
2169
|
+
summaries?: {
|
|
2170
|
+
rsvps?: {
|
|
2171
|
+
totalCount: number;
|
|
2172
|
+
yesCount: number;
|
|
2173
|
+
noCount: number;
|
|
2174
|
+
waitlistCount: number;
|
|
2175
|
+
};
|
|
2176
|
+
tickets?: {
|
|
2177
|
+
ticketsSold: number;
|
|
2178
|
+
revenue?: {
|
|
2179
|
+
amount: string;
|
|
2180
|
+
currency: string;
|
|
2181
|
+
};
|
|
2182
|
+
currencyLocked: boolean;
|
|
2183
|
+
totalOrders: number;
|
|
2184
|
+
totalSales?: {
|
|
2185
|
+
amount: string;
|
|
2186
|
+
currency: string;
|
|
2187
|
+
};
|
|
2188
|
+
};
|
|
2189
|
+
};
|
|
2190
|
+
instanceId: string;
|
|
2191
|
+
guestListSettings?: {
|
|
2192
|
+
displayedPublicly: boolean;
|
|
2193
|
+
};
|
|
2194
|
+
userId: string;
|
|
2195
|
+
onlineConferencing?: {
|
|
2196
|
+
enabled: boolean;
|
|
2197
|
+
type: ConferenceTypeType;
|
|
2198
|
+
session?: {
|
|
2199
|
+
hostLink: string;
|
|
2200
|
+
guestLink: string;
|
|
2201
|
+
};
|
|
2202
|
+
};
|
|
2203
|
+
seoSettings?: {
|
|
2204
|
+
slug: string;
|
|
2205
|
+
advancedSeoData?: {
|
|
2206
|
+
tags: {
|
|
2207
|
+
type: string;
|
|
2208
|
+
children: string;
|
|
2209
|
+
custom: boolean;
|
|
2210
|
+
disabled: boolean;
|
|
2211
|
+
}[];
|
|
2212
|
+
settings?: {
|
|
2213
|
+
preventAutoRedirect: boolean;
|
|
2214
|
+
keywords: {
|
|
2215
|
+
term: string;
|
|
2216
|
+
isMain: boolean;
|
|
2217
|
+
}[];
|
|
2218
|
+
};
|
|
2219
|
+
};
|
|
2220
|
+
};
|
|
2221
|
+
agendaSettings?: {
|
|
2222
|
+
enabled: boolean;
|
|
2223
|
+
pageUrl: string;
|
|
2224
|
+
};
|
|
2225
|
+
};
|
|
2226
|
+
}
|
|
2227
|
+
export interface PublishDraftEventResponseNonNullableFields {
|
|
2228
|
+
event?: {
|
|
2229
|
+
_id: string;
|
|
2230
|
+
location?: {
|
|
2231
|
+
type: LocationType;
|
|
2232
|
+
};
|
|
2233
|
+
dateAndTimeSettings?: {
|
|
2234
|
+
recurrenceStatus: RecurrenceStatusStatus;
|
|
2235
|
+
recurringEvents?: {
|
|
2236
|
+
individualEventDates: {
|
|
2237
|
+
showTimeZone: boolean;
|
|
2238
|
+
}[];
|
|
2239
|
+
};
|
|
2240
|
+
};
|
|
2241
|
+
mainImage: string;
|
|
2242
|
+
slug: string;
|
|
2243
|
+
status: Status;
|
|
2244
|
+
registration?: {
|
|
2245
|
+
type: RegistrationTypeType;
|
|
2246
|
+
status: RegistrationStatusStatus;
|
|
2247
|
+
rsvp?: {
|
|
2248
|
+
responseType: ResponseType;
|
|
2249
|
+
waitlistEnabled: boolean;
|
|
2250
|
+
};
|
|
2251
|
+
tickets?: {
|
|
2252
|
+
guestsAssignedSeparately: boolean;
|
|
2253
|
+
ticketLimitPerOrder: number;
|
|
2254
|
+
lowestPrice?: {
|
|
2255
|
+
value: string;
|
|
2256
|
+
currency: string;
|
|
2257
|
+
};
|
|
2258
|
+
highestPrice?: {
|
|
2259
|
+
value: string;
|
|
2260
|
+
currency: string;
|
|
2261
|
+
};
|
|
2262
|
+
taxSettings?: {
|
|
2263
|
+
type: TaxType;
|
|
2264
|
+
};
|
|
2265
|
+
};
|
|
2266
|
+
allowedGuestTypes: GuestTypeType;
|
|
2267
|
+
initialType: InitialRegistrationTypeType;
|
|
2268
|
+
registrationPaused: boolean;
|
|
2269
|
+
registrationDisabled: boolean;
|
|
2270
|
+
};
|
|
2271
|
+
calendarUrls?: {
|
|
2272
|
+
google: string;
|
|
2273
|
+
ics: string;
|
|
2274
|
+
};
|
|
2275
|
+
eventPageUrl: string;
|
|
2276
|
+
form?: {
|
|
2277
|
+
controls: {
|
|
2278
|
+
type: InputControlType;
|
|
2279
|
+
system: boolean;
|
|
2280
|
+
name: string;
|
|
2281
|
+
inputs: {
|
|
2282
|
+
name: string;
|
|
2283
|
+
array: boolean;
|
|
2284
|
+
label: string;
|
|
2285
|
+
options: string[];
|
|
2286
|
+
mandatory: boolean;
|
|
2287
|
+
maxLength: number;
|
|
2288
|
+
type: ValueType;
|
|
2289
|
+
defaultOptionSelection?: {
|
|
2290
|
+
optionIndex: number;
|
|
2291
|
+
placeholderText: string;
|
|
2292
|
+
};
|
|
2293
|
+
labels: {
|
|
2294
|
+
name: string;
|
|
2295
|
+
label: string;
|
|
2296
|
+
}[];
|
|
2297
|
+
}[];
|
|
2298
|
+
label: string;
|
|
2299
|
+
orderIndex: number;
|
|
2300
|
+
_id: string;
|
|
2301
|
+
}[];
|
|
2302
|
+
messages?: {
|
|
2303
|
+
rsvp?: {
|
|
2304
|
+
rsvpYesOption: string;
|
|
2305
|
+
rsvpNoOption: string;
|
|
2306
|
+
positiveMessages?: {
|
|
2307
|
+
title: string;
|
|
2308
|
+
confirmation?: {
|
|
2309
|
+
title: string;
|
|
2310
|
+
message: string;
|
|
2311
|
+
addToCalendarActionLabel: string;
|
|
2312
|
+
shareActionLabel: string;
|
|
2313
|
+
};
|
|
2314
|
+
};
|
|
2315
|
+
waitlistMessages?: {
|
|
2316
|
+
title: string;
|
|
2317
|
+
confirmation?: {
|
|
2318
|
+
title: string;
|
|
2319
|
+
message: string;
|
|
2320
|
+
addToCalendarActionLabel: string;
|
|
2321
|
+
shareActionLabel: string;
|
|
2322
|
+
};
|
|
2323
|
+
};
|
|
2324
|
+
negativeMessages?: {
|
|
2325
|
+
title: string;
|
|
2326
|
+
confirmation?: {
|
|
2327
|
+
title: string;
|
|
2328
|
+
shareActionLabel: string;
|
|
2329
|
+
};
|
|
2330
|
+
};
|
|
2331
|
+
submitActionLabel: string;
|
|
2332
|
+
};
|
|
2333
|
+
checkout?: {
|
|
2334
|
+
title: string;
|
|
2335
|
+
submitActionLabel: string;
|
|
2336
|
+
confirmation?: {
|
|
2337
|
+
title: string;
|
|
2338
|
+
message: string;
|
|
2339
|
+
downloadTicketsLabel: string;
|
|
2340
|
+
addToCalendarLabel: string;
|
|
2341
|
+
shareEventLabel: string;
|
|
2342
|
+
};
|
|
2343
|
+
};
|
|
2344
|
+
registrationClosed?: {
|
|
2345
|
+
message: string;
|
|
2346
|
+
exploreEventsActionLabel: string;
|
|
2347
|
+
};
|
|
2348
|
+
ticketsUnavailable?: {
|
|
2349
|
+
message: string;
|
|
2350
|
+
exploreEventsActionLabel: string;
|
|
2351
|
+
};
|
|
2352
|
+
};
|
|
2353
|
+
};
|
|
2354
|
+
summaries?: {
|
|
2355
|
+
rsvps?: {
|
|
2356
|
+
totalCount: number;
|
|
2357
|
+
yesCount: number;
|
|
2358
|
+
noCount: number;
|
|
2359
|
+
waitlistCount: number;
|
|
2360
|
+
};
|
|
2361
|
+
tickets?: {
|
|
2362
|
+
ticketsSold: number;
|
|
2363
|
+
revenue?: {
|
|
2364
|
+
amount: string;
|
|
2365
|
+
currency: string;
|
|
2366
|
+
};
|
|
2367
|
+
currencyLocked: boolean;
|
|
2368
|
+
totalOrders: number;
|
|
2369
|
+
totalSales?: {
|
|
2370
|
+
amount: string;
|
|
2371
|
+
currency: string;
|
|
2372
|
+
};
|
|
2373
|
+
};
|
|
2374
|
+
};
|
|
2375
|
+
instanceId: string;
|
|
2376
|
+
guestListSettings?: {
|
|
2377
|
+
displayedPublicly: boolean;
|
|
2378
|
+
};
|
|
2379
|
+
userId: string;
|
|
2380
|
+
onlineConferencing?: {
|
|
2381
|
+
enabled: boolean;
|
|
2382
|
+
type: ConferenceTypeType;
|
|
2383
|
+
session?: {
|
|
2384
|
+
hostLink: string;
|
|
2385
|
+
guestLink: string;
|
|
2386
|
+
};
|
|
2387
|
+
};
|
|
2388
|
+
seoSettings?: {
|
|
2389
|
+
slug: string;
|
|
2390
|
+
advancedSeoData?: {
|
|
2391
|
+
tags: {
|
|
2392
|
+
type: string;
|
|
2393
|
+
children: string;
|
|
2394
|
+
custom: boolean;
|
|
2395
|
+
disabled: boolean;
|
|
2396
|
+
}[];
|
|
2397
|
+
settings?: {
|
|
2398
|
+
preventAutoRedirect: boolean;
|
|
2399
|
+
keywords: {
|
|
2400
|
+
term: string;
|
|
2401
|
+
isMain: boolean;
|
|
2402
|
+
}[];
|
|
2403
|
+
};
|
|
2404
|
+
};
|
|
2405
|
+
};
|
|
2406
|
+
agendaSettings?: {
|
|
2407
|
+
enabled: boolean;
|
|
2408
|
+
pageUrl: string;
|
|
2409
|
+
};
|
|
2410
|
+
};
|
|
2411
|
+
}
|
|
2412
|
+
export interface CancelEventResponseNonNullableFields {
|
|
2413
|
+
event?: {
|
|
2414
|
+
_id: string;
|
|
2415
|
+
location?: {
|
|
2416
|
+
type: LocationType;
|
|
2417
|
+
};
|
|
2418
|
+
dateAndTimeSettings?: {
|
|
2419
|
+
recurrenceStatus: RecurrenceStatusStatus;
|
|
2420
|
+
recurringEvents?: {
|
|
2421
|
+
individualEventDates: {
|
|
2422
|
+
showTimeZone: boolean;
|
|
2423
|
+
}[];
|
|
2424
|
+
};
|
|
2425
|
+
};
|
|
2426
|
+
mainImage: string;
|
|
2427
|
+
slug: string;
|
|
2428
|
+
status: Status;
|
|
2429
|
+
registration?: {
|
|
2430
|
+
type: RegistrationTypeType;
|
|
2431
|
+
status: RegistrationStatusStatus;
|
|
2432
|
+
rsvp?: {
|
|
2433
|
+
responseType: ResponseType;
|
|
2434
|
+
waitlistEnabled: boolean;
|
|
2435
|
+
};
|
|
2436
|
+
tickets?: {
|
|
2437
|
+
guestsAssignedSeparately: boolean;
|
|
2438
|
+
ticketLimitPerOrder: number;
|
|
2439
|
+
lowestPrice?: {
|
|
2440
|
+
value: string;
|
|
2441
|
+
currency: string;
|
|
2442
|
+
};
|
|
2443
|
+
highestPrice?: {
|
|
2444
|
+
value: string;
|
|
2445
|
+
currency: string;
|
|
2446
|
+
};
|
|
2447
|
+
taxSettings?: {
|
|
2448
|
+
type: TaxType;
|
|
2449
|
+
};
|
|
2450
|
+
};
|
|
2451
|
+
allowedGuestTypes: GuestTypeType;
|
|
2452
|
+
initialType: InitialRegistrationTypeType;
|
|
2453
|
+
registrationPaused: boolean;
|
|
2454
|
+
registrationDisabled: boolean;
|
|
2455
|
+
};
|
|
2456
|
+
calendarUrls?: {
|
|
2457
|
+
google: string;
|
|
2458
|
+
ics: string;
|
|
2459
|
+
};
|
|
2460
|
+
eventPageUrl: string;
|
|
2461
|
+
form?: {
|
|
2462
|
+
controls: {
|
|
2463
|
+
type: InputControlType;
|
|
2464
|
+
system: boolean;
|
|
2465
|
+
name: string;
|
|
2466
|
+
inputs: {
|
|
2467
|
+
name: string;
|
|
2468
|
+
array: boolean;
|
|
2469
|
+
label: string;
|
|
2470
|
+
options: string[];
|
|
2471
|
+
mandatory: boolean;
|
|
2472
|
+
maxLength: number;
|
|
2473
|
+
type: ValueType;
|
|
2474
|
+
defaultOptionSelection?: {
|
|
2475
|
+
optionIndex: number;
|
|
2476
|
+
placeholderText: string;
|
|
2477
|
+
};
|
|
2478
|
+
labels: {
|
|
2479
|
+
name: string;
|
|
2480
|
+
label: string;
|
|
2481
|
+
}[];
|
|
2482
|
+
}[];
|
|
2483
|
+
label: string;
|
|
2484
|
+
orderIndex: number;
|
|
2485
|
+
_id: string;
|
|
2486
|
+
}[];
|
|
2487
|
+
messages?: {
|
|
2488
|
+
rsvp?: {
|
|
2489
|
+
rsvpYesOption: string;
|
|
2490
|
+
rsvpNoOption: string;
|
|
2491
|
+
positiveMessages?: {
|
|
2492
|
+
title: string;
|
|
2493
|
+
confirmation?: {
|
|
2494
|
+
title: string;
|
|
2495
|
+
message: string;
|
|
2496
|
+
addToCalendarActionLabel: string;
|
|
2497
|
+
shareActionLabel: string;
|
|
2498
|
+
};
|
|
2499
|
+
};
|
|
2500
|
+
waitlistMessages?: {
|
|
2501
|
+
title: string;
|
|
2502
|
+
confirmation?: {
|
|
2503
|
+
title: string;
|
|
2504
|
+
message: string;
|
|
2505
|
+
addToCalendarActionLabel: string;
|
|
2506
|
+
shareActionLabel: string;
|
|
2507
|
+
};
|
|
2508
|
+
};
|
|
2509
|
+
negativeMessages?: {
|
|
2510
|
+
title: string;
|
|
2511
|
+
confirmation?: {
|
|
2512
|
+
title: string;
|
|
2513
|
+
shareActionLabel: string;
|
|
2514
|
+
};
|
|
2515
|
+
};
|
|
2516
|
+
submitActionLabel: string;
|
|
2517
|
+
};
|
|
2518
|
+
checkout?: {
|
|
2519
|
+
title: string;
|
|
2520
|
+
submitActionLabel: string;
|
|
2521
|
+
confirmation?: {
|
|
2522
|
+
title: string;
|
|
2523
|
+
message: string;
|
|
2524
|
+
downloadTicketsLabel: string;
|
|
2525
|
+
addToCalendarLabel: string;
|
|
2526
|
+
shareEventLabel: string;
|
|
2527
|
+
};
|
|
2528
|
+
};
|
|
2529
|
+
registrationClosed?: {
|
|
2530
|
+
message: string;
|
|
2531
|
+
exploreEventsActionLabel: string;
|
|
2532
|
+
};
|
|
2533
|
+
ticketsUnavailable?: {
|
|
2534
|
+
message: string;
|
|
2535
|
+
exploreEventsActionLabel: string;
|
|
2536
|
+
};
|
|
2537
|
+
};
|
|
2538
|
+
};
|
|
2539
|
+
summaries?: {
|
|
2540
|
+
rsvps?: {
|
|
2541
|
+
totalCount: number;
|
|
2542
|
+
yesCount: number;
|
|
2543
|
+
noCount: number;
|
|
2544
|
+
waitlistCount: number;
|
|
2545
|
+
};
|
|
2546
|
+
tickets?: {
|
|
2547
|
+
ticketsSold: number;
|
|
2548
|
+
revenue?: {
|
|
2549
|
+
amount: string;
|
|
2550
|
+
currency: string;
|
|
2551
|
+
};
|
|
2552
|
+
currencyLocked: boolean;
|
|
2553
|
+
totalOrders: number;
|
|
2554
|
+
totalSales?: {
|
|
2555
|
+
amount: string;
|
|
2556
|
+
currency: string;
|
|
2557
|
+
};
|
|
2558
|
+
};
|
|
2559
|
+
};
|
|
2560
|
+
instanceId: string;
|
|
2561
|
+
guestListSettings?: {
|
|
2562
|
+
displayedPublicly: boolean;
|
|
2563
|
+
};
|
|
2564
|
+
userId: string;
|
|
2565
|
+
onlineConferencing?: {
|
|
2566
|
+
enabled: boolean;
|
|
2567
|
+
type: ConferenceTypeType;
|
|
2568
|
+
session?: {
|
|
2569
|
+
hostLink: string;
|
|
2570
|
+
guestLink: string;
|
|
2571
|
+
};
|
|
2572
|
+
};
|
|
2573
|
+
seoSettings?: {
|
|
2574
|
+
slug: string;
|
|
2575
|
+
advancedSeoData?: {
|
|
2576
|
+
tags: {
|
|
2577
|
+
type: string;
|
|
2578
|
+
children: string;
|
|
2579
|
+
custom: boolean;
|
|
2580
|
+
disabled: boolean;
|
|
2581
|
+
}[];
|
|
2582
|
+
settings?: {
|
|
2583
|
+
preventAutoRedirect: boolean;
|
|
2584
|
+
keywords: {
|
|
2585
|
+
term: string;
|
|
2586
|
+
isMain: boolean;
|
|
2587
|
+
}[];
|
|
2588
|
+
};
|
|
2589
|
+
};
|
|
2590
|
+
};
|
|
2591
|
+
agendaSettings?: {
|
|
2592
|
+
enabled: boolean;
|
|
2593
|
+
pageUrl: string;
|
|
2594
|
+
};
|
|
2595
|
+
};
|
|
2596
|
+
}
|
|
2597
|
+
export interface DeleteEventResponseNonNullableFields {
|
|
2598
|
+
eventId: string;
|
|
2599
|
+
}
|
|
2600
|
+
export interface QueryEventsResponseNonNullableFields {
|
|
2601
|
+
events: {
|
|
2602
|
+
_id: string;
|
|
2603
|
+
location?: {
|
|
2604
|
+
type: LocationType;
|
|
2605
|
+
};
|
|
2606
|
+
dateAndTimeSettings?: {
|
|
2607
|
+
recurrenceStatus: RecurrenceStatusStatus;
|
|
2608
|
+
recurringEvents?: {
|
|
2609
|
+
individualEventDates: {
|
|
2610
|
+
showTimeZone: boolean;
|
|
2611
|
+
}[];
|
|
2612
|
+
};
|
|
2613
|
+
};
|
|
2614
|
+
mainImage: string;
|
|
2615
|
+
slug: string;
|
|
2616
|
+
status: Status;
|
|
2617
|
+
registration?: {
|
|
2618
|
+
type: RegistrationTypeType;
|
|
2619
|
+
status: RegistrationStatusStatus;
|
|
2620
|
+
rsvp?: {
|
|
2621
|
+
responseType: ResponseType;
|
|
2622
|
+
waitlistEnabled: boolean;
|
|
2623
|
+
};
|
|
2624
|
+
tickets?: {
|
|
2625
|
+
guestsAssignedSeparately: boolean;
|
|
2626
|
+
ticketLimitPerOrder: number;
|
|
2627
|
+
lowestPrice?: {
|
|
2628
|
+
value: string;
|
|
2629
|
+
currency: string;
|
|
2630
|
+
};
|
|
2631
|
+
highestPrice?: {
|
|
2632
|
+
value: string;
|
|
2633
|
+
currency: string;
|
|
2634
|
+
};
|
|
2635
|
+
taxSettings?: {
|
|
2636
|
+
type: TaxType;
|
|
2637
|
+
};
|
|
2638
|
+
};
|
|
2639
|
+
allowedGuestTypes: GuestTypeType;
|
|
2640
|
+
initialType: InitialRegistrationTypeType;
|
|
2641
|
+
registrationPaused: boolean;
|
|
2642
|
+
registrationDisabled: boolean;
|
|
2643
|
+
};
|
|
2644
|
+
calendarUrls?: {
|
|
2645
|
+
google: string;
|
|
2646
|
+
ics: string;
|
|
2647
|
+
};
|
|
2648
|
+
eventPageUrl: string;
|
|
2649
|
+
form?: {
|
|
2650
|
+
controls: {
|
|
2651
|
+
type: InputControlType;
|
|
2652
|
+
system: boolean;
|
|
2653
|
+
name: string;
|
|
2654
|
+
inputs: {
|
|
2655
|
+
name: string;
|
|
2656
|
+
array: boolean;
|
|
2657
|
+
label: string;
|
|
2658
|
+
options: string[];
|
|
2659
|
+
mandatory: boolean;
|
|
2660
|
+
maxLength: number;
|
|
2661
|
+
type: ValueType;
|
|
2662
|
+
defaultOptionSelection?: {
|
|
2663
|
+
optionIndex: number;
|
|
2664
|
+
placeholderText: string;
|
|
2665
|
+
};
|
|
2666
|
+
labels: {
|
|
2667
|
+
name: string;
|
|
2668
|
+
label: string;
|
|
2669
|
+
}[];
|
|
2670
|
+
}[];
|
|
2671
|
+
label: string;
|
|
2672
|
+
orderIndex: number;
|
|
2673
|
+
_id: string;
|
|
2674
|
+
}[];
|
|
2675
|
+
messages?: {
|
|
2676
|
+
rsvp?: {
|
|
2677
|
+
rsvpYesOption: string;
|
|
2678
|
+
rsvpNoOption: string;
|
|
2679
|
+
positiveMessages?: {
|
|
2680
|
+
title: string;
|
|
2681
|
+
confirmation?: {
|
|
2682
|
+
title: string;
|
|
2683
|
+
message: string;
|
|
2684
|
+
addToCalendarActionLabel: string;
|
|
2685
|
+
shareActionLabel: string;
|
|
2686
|
+
};
|
|
2687
|
+
};
|
|
2688
|
+
waitlistMessages?: {
|
|
2689
|
+
title: string;
|
|
2690
|
+
confirmation?: {
|
|
2691
|
+
title: string;
|
|
2692
|
+
message: string;
|
|
2693
|
+
addToCalendarActionLabel: string;
|
|
2694
|
+
shareActionLabel: string;
|
|
2695
|
+
};
|
|
2696
|
+
};
|
|
2697
|
+
negativeMessages?: {
|
|
2698
|
+
title: string;
|
|
2699
|
+
confirmation?: {
|
|
2700
|
+
title: string;
|
|
2701
|
+
shareActionLabel: string;
|
|
2702
|
+
};
|
|
2703
|
+
};
|
|
2704
|
+
submitActionLabel: string;
|
|
2705
|
+
};
|
|
2706
|
+
checkout?: {
|
|
2707
|
+
title: string;
|
|
2708
|
+
submitActionLabel: string;
|
|
2709
|
+
confirmation?: {
|
|
2710
|
+
title: string;
|
|
2711
|
+
message: string;
|
|
2712
|
+
downloadTicketsLabel: string;
|
|
2713
|
+
addToCalendarLabel: string;
|
|
2714
|
+
shareEventLabel: string;
|
|
2715
|
+
};
|
|
2716
|
+
};
|
|
2717
|
+
registrationClosed?: {
|
|
2718
|
+
message: string;
|
|
2719
|
+
exploreEventsActionLabel: string;
|
|
2720
|
+
};
|
|
2721
|
+
ticketsUnavailable?: {
|
|
2722
|
+
message: string;
|
|
2723
|
+
exploreEventsActionLabel: string;
|
|
2724
|
+
};
|
|
2725
|
+
};
|
|
2726
|
+
};
|
|
2727
|
+
summaries?: {
|
|
2728
|
+
rsvps?: {
|
|
2729
|
+
totalCount: number;
|
|
2730
|
+
yesCount: number;
|
|
2731
|
+
noCount: number;
|
|
2732
|
+
waitlistCount: number;
|
|
2733
|
+
};
|
|
2734
|
+
tickets?: {
|
|
2735
|
+
ticketsSold: number;
|
|
2736
|
+
revenue?: {
|
|
2737
|
+
amount: string;
|
|
2738
|
+
currency: string;
|
|
2739
|
+
};
|
|
2740
|
+
currencyLocked: boolean;
|
|
2741
|
+
totalOrders: number;
|
|
2742
|
+
totalSales?: {
|
|
2743
|
+
amount: string;
|
|
2744
|
+
currency: string;
|
|
2745
|
+
};
|
|
2746
|
+
};
|
|
2747
|
+
};
|
|
2748
|
+
instanceId: string;
|
|
2749
|
+
guestListSettings?: {
|
|
2750
|
+
displayedPublicly: boolean;
|
|
2751
|
+
};
|
|
2752
|
+
userId: string;
|
|
2753
|
+
onlineConferencing?: {
|
|
2754
|
+
enabled: boolean;
|
|
2755
|
+
type: ConferenceTypeType;
|
|
2756
|
+
session?: {
|
|
2757
|
+
hostLink: string;
|
|
2758
|
+
guestLink: string;
|
|
2759
|
+
};
|
|
2760
|
+
};
|
|
2761
|
+
seoSettings?: {
|
|
2762
|
+
slug: string;
|
|
2763
|
+
advancedSeoData?: {
|
|
2764
|
+
tags: {
|
|
2765
|
+
type: string;
|
|
2766
|
+
children: string;
|
|
2767
|
+
custom: boolean;
|
|
2768
|
+
disabled: boolean;
|
|
2769
|
+
}[];
|
|
2770
|
+
settings?: {
|
|
2771
|
+
preventAutoRedirect: boolean;
|
|
2772
|
+
keywords: {
|
|
2773
|
+
term: string;
|
|
2774
|
+
isMain: boolean;
|
|
2775
|
+
}[];
|
|
2776
|
+
};
|
|
2777
|
+
};
|
|
2778
|
+
};
|
|
2779
|
+
agendaSettings?: {
|
|
2780
|
+
enabled: boolean;
|
|
2781
|
+
pageUrl: string;
|
|
2782
|
+
};
|
|
2783
|
+
}[];
|
|
2784
|
+
}
|
|
2785
|
+
export interface GetEventResponseNonNullableFields {
|
|
2786
|
+
event?: {
|
|
2787
|
+
_id: string;
|
|
2788
|
+
location?: {
|
|
2789
|
+
type: LocationType;
|
|
2790
|
+
};
|
|
2791
|
+
dateAndTimeSettings?: {
|
|
2792
|
+
recurrenceStatus: RecurrenceStatusStatus;
|
|
2793
|
+
recurringEvents?: {
|
|
2794
|
+
individualEventDates: {
|
|
2795
|
+
showTimeZone: boolean;
|
|
2796
|
+
}[];
|
|
2797
|
+
};
|
|
2798
|
+
};
|
|
2799
|
+
mainImage: string;
|
|
2800
|
+
slug: string;
|
|
2801
|
+
status: Status;
|
|
2802
|
+
registration?: {
|
|
2803
|
+
type: RegistrationTypeType;
|
|
2804
|
+
status: RegistrationStatusStatus;
|
|
2805
|
+
rsvp?: {
|
|
2806
|
+
responseType: ResponseType;
|
|
2807
|
+
waitlistEnabled: boolean;
|
|
2808
|
+
};
|
|
2809
|
+
tickets?: {
|
|
2810
|
+
guestsAssignedSeparately: boolean;
|
|
2811
|
+
ticketLimitPerOrder: number;
|
|
2812
|
+
lowestPrice?: {
|
|
2813
|
+
value: string;
|
|
2814
|
+
currency: string;
|
|
2815
|
+
};
|
|
2816
|
+
highestPrice?: {
|
|
2817
|
+
value: string;
|
|
2818
|
+
currency: string;
|
|
2819
|
+
};
|
|
2820
|
+
taxSettings?: {
|
|
2821
|
+
type: TaxType;
|
|
2822
|
+
};
|
|
2823
|
+
};
|
|
2824
|
+
allowedGuestTypes: GuestTypeType;
|
|
2825
|
+
initialType: InitialRegistrationTypeType;
|
|
2826
|
+
registrationPaused: boolean;
|
|
2827
|
+
registrationDisabled: boolean;
|
|
2828
|
+
};
|
|
2829
|
+
calendarUrls?: {
|
|
2830
|
+
google: string;
|
|
2831
|
+
ics: string;
|
|
2832
|
+
};
|
|
2833
|
+
eventPageUrl: string;
|
|
2834
|
+
form?: {
|
|
2835
|
+
controls: {
|
|
2836
|
+
type: InputControlType;
|
|
2837
|
+
system: boolean;
|
|
2838
|
+
name: string;
|
|
2839
|
+
inputs: {
|
|
2840
|
+
name: string;
|
|
2841
|
+
array: boolean;
|
|
2842
|
+
label: string;
|
|
2843
|
+
options: string[];
|
|
2844
|
+
mandatory: boolean;
|
|
2845
|
+
maxLength: number;
|
|
2846
|
+
type: ValueType;
|
|
2847
|
+
defaultOptionSelection?: {
|
|
2848
|
+
optionIndex: number;
|
|
2849
|
+
placeholderText: string;
|
|
2850
|
+
};
|
|
2851
|
+
labels: {
|
|
2852
|
+
name: string;
|
|
2853
|
+
label: string;
|
|
2854
|
+
}[];
|
|
2855
|
+
}[];
|
|
2856
|
+
label: string;
|
|
2857
|
+
orderIndex: number;
|
|
2858
|
+
_id: string;
|
|
2859
|
+
}[];
|
|
2860
|
+
messages?: {
|
|
2861
|
+
rsvp?: {
|
|
2862
|
+
rsvpYesOption: string;
|
|
2863
|
+
rsvpNoOption: string;
|
|
2864
|
+
positiveMessages?: {
|
|
2865
|
+
title: string;
|
|
2866
|
+
confirmation?: {
|
|
2867
|
+
title: string;
|
|
2868
|
+
message: string;
|
|
2869
|
+
addToCalendarActionLabel: string;
|
|
2870
|
+
shareActionLabel: string;
|
|
2871
|
+
};
|
|
2872
|
+
};
|
|
2873
|
+
waitlistMessages?: {
|
|
2874
|
+
title: string;
|
|
2875
|
+
confirmation?: {
|
|
2876
|
+
title: string;
|
|
2877
|
+
message: string;
|
|
2878
|
+
addToCalendarActionLabel: string;
|
|
2879
|
+
shareActionLabel: string;
|
|
2880
|
+
};
|
|
2881
|
+
};
|
|
2882
|
+
negativeMessages?: {
|
|
2883
|
+
title: string;
|
|
2884
|
+
confirmation?: {
|
|
2885
|
+
title: string;
|
|
2886
|
+
shareActionLabel: string;
|
|
2887
|
+
};
|
|
2888
|
+
};
|
|
2889
|
+
submitActionLabel: string;
|
|
2890
|
+
};
|
|
2891
|
+
checkout?: {
|
|
2892
|
+
title: string;
|
|
2893
|
+
submitActionLabel: string;
|
|
2894
|
+
confirmation?: {
|
|
2895
|
+
title: string;
|
|
2896
|
+
message: string;
|
|
2897
|
+
downloadTicketsLabel: string;
|
|
2898
|
+
addToCalendarLabel: string;
|
|
2899
|
+
shareEventLabel: string;
|
|
2900
|
+
};
|
|
2901
|
+
};
|
|
2902
|
+
registrationClosed?: {
|
|
2903
|
+
message: string;
|
|
2904
|
+
exploreEventsActionLabel: string;
|
|
2905
|
+
};
|
|
2906
|
+
ticketsUnavailable?: {
|
|
2907
|
+
message: string;
|
|
2908
|
+
exploreEventsActionLabel: string;
|
|
2909
|
+
};
|
|
2910
|
+
};
|
|
2911
|
+
};
|
|
2912
|
+
summaries?: {
|
|
2913
|
+
rsvps?: {
|
|
2914
|
+
totalCount: number;
|
|
2915
|
+
yesCount: number;
|
|
2916
|
+
noCount: number;
|
|
2917
|
+
waitlistCount: number;
|
|
2918
|
+
};
|
|
2919
|
+
tickets?: {
|
|
2920
|
+
ticketsSold: number;
|
|
2921
|
+
revenue?: {
|
|
2922
|
+
amount: string;
|
|
2923
|
+
currency: string;
|
|
2924
|
+
};
|
|
2925
|
+
currencyLocked: boolean;
|
|
2926
|
+
totalOrders: number;
|
|
2927
|
+
totalSales?: {
|
|
2928
|
+
amount: string;
|
|
2929
|
+
currency: string;
|
|
2930
|
+
};
|
|
2931
|
+
};
|
|
2932
|
+
};
|
|
2933
|
+
instanceId: string;
|
|
2934
|
+
guestListSettings?: {
|
|
2935
|
+
displayedPublicly: boolean;
|
|
2936
|
+
};
|
|
2937
|
+
userId: string;
|
|
2938
|
+
onlineConferencing?: {
|
|
2939
|
+
enabled: boolean;
|
|
2940
|
+
type: ConferenceTypeType;
|
|
2941
|
+
session?: {
|
|
2942
|
+
hostLink: string;
|
|
2943
|
+
guestLink: string;
|
|
2944
|
+
};
|
|
2945
|
+
};
|
|
2946
|
+
seoSettings?: {
|
|
2947
|
+
slug: string;
|
|
2948
|
+
advancedSeoData?: {
|
|
2949
|
+
tags: {
|
|
2950
|
+
type: string;
|
|
2951
|
+
children: string;
|
|
2952
|
+
custom: boolean;
|
|
2953
|
+
disabled: boolean;
|
|
2954
|
+
}[];
|
|
2955
|
+
settings?: {
|
|
2956
|
+
preventAutoRedirect: boolean;
|
|
2957
|
+
keywords: {
|
|
2958
|
+
term: string;
|
|
2959
|
+
isMain: boolean;
|
|
2960
|
+
}[];
|
|
2961
|
+
};
|
|
2962
|
+
};
|
|
2963
|
+
};
|
|
2964
|
+
agendaSettings?: {
|
|
2965
|
+
enabled: boolean;
|
|
2966
|
+
pageUrl: string;
|
|
2967
|
+
};
|
|
2968
|
+
};
|
|
2969
|
+
}
|
|
2970
|
+
export interface GetEventBySlugResponseNonNullableFields {
|
|
2971
|
+
event?: {
|
|
2972
|
+
_id: string;
|
|
2973
|
+
location?: {
|
|
2974
|
+
type: LocationType;
|
|
2975
|
+
};
|
|
2976
|
+
dateAndTimeSettings?: {
|
|
2977
|
+
recurrenceStatus: RecurrenceStatusStatus;
|
|
2978
|
+
recurringEvents?: {
|
|
2979
|
+
individualEventDates: {
|
|
2980
|
+
showTimeZone: boolean;
|
|
2981
|
+
}[];
|
|
2982
|
+
};
|
|
2983
|
+
};
|
|
2984
|
+
mainImage: string;
|
|
2985
|
+
slug: string;
|
|
2986
|
+
status: Status;
|
|
2987
|
+
registration?: {
|
|
2988
|
+
type: RegistrationTypeType;
|
|
2989
|
+
status: RegistrationStatusStatus;
|
|
2990
|
+
rsvp?: {
|
|
2991
|
+
responseType: ResponseType;
|
|
2992
|
+
waitlistEnabled: boolean;
|
|
2993
|
+
};
|
|
2994
|
+
tickets?: {
|
|
2995
|
+
guestsAssignedSeparately: boolean;
|
|
2996
|
+
ticketLimitPerOrder: number;
|
|
2997
|
+
lowestPrice?: {
|
|
2998
|
+
value: string;
|
|
2999
|
+
currency: string;
|
|
3000
|
+
};
|
|
3001
|
+
highestPrice?: {
|
|
3002
|
+
value: string;
|
|
3003
|
+
currency: string;
|
|
3004
|
+
};
|
|
3005
|
+
taxSettings?: {
|
|
3006
|
+
type: TaxType;
|
|
3007
|
+
};
|
|
3008
|
+
};
|
|
3009
|
+
allowedGuestTypes: GuestTypeType;
|
|
3010
|
+
initialType: InitialRegistrationTypeType;
|
|
3011
|
+
registrationPaused: boolean;
|
|
3012
|
+
registrationDisabled: boolean;
|
|
3013
|
+
};
|
|
3014
|
+
calendarUrls?: {
|
|
3015
|
+
google: string;
|
|
3016
|
+
ics: string;
|
|
3017
|
+
};
|
|
3018
|
+
eventPageUrl: string;
|
|
3019
|
+
form?: {
|
|
3020
|
+
controls: {
|
|
3021
|
+
type: InputControlType;
|
|
3022
|
+
system: boolean;
|
|
3023
|
+
name: string;
|
|
3024
|
+
inputs: {
|
|
3025
|
+
name: string;
|
|
3026
|
+
array: boolean;
|
|
3027
|
+
label: string;
|
|
3028
|
+
options: string[];
|
|
3029
|
+
mandatory: boolean;
|
|
3030
|
+
maxLength: number;
|
|
3031
|
+
type: ValueType;
|
|
3032
|
+
defaultOptionSelection?: {
|
|
3033
|
+
optionIndex: number;
|
|
3034
|
+
placeholderText: string;
|
|
3035
|
+
};
|
|
3036
|
+
labels: {
|
|
3037
|
+
name: string;
|
|
3038
|
+
label: string;
|
|
3039
|
+
}[];
|
|
3040
|
+
}[];
|
|
3041
|
+
label: string;
|
|
3042
|
+
orderIndex: number;
|
|
3043
|
+
_id: string;
|
|
3044
|
+
}[];
|
|
3045
|
+
messages?: {
|
|
3046
|
+
rsvp?: {
|
|
3047
|
+
rsvpYesOption: string;
|
|
3048
|
+
rsvpNoOption: string;
|
|
3049
|
+
positiveMessages?: {
|
|
3050
|
+
title: string;
|
|
3051
|
+
confirmation?: {
|
|
3052
|
+
title: string;
|
|
3053
|
+
message: string;
|
|
3054
|
+
addToCalendarActionLabel: string;
|
|
3055
|
+
shareActionLabel: string;
|
|
3056
|
+
};
|
|
3057
|
+
};
|
|
3058
|
+
waitlistMessages?: {
|
|
3059
|
+
title: string;
|
|
3060
|
+
confirmation?: {
|
|
3061
|
+
title: string;
|
|
3062
|
+
message: string;
|
|
3063
|
+
addToCalendarActionLabel: string;
|
|
3064
|
+
shareActionLabel: string;
|
|
3065
|
+
};
|
|
3066
|
+
};
|
|
3067
|
+
negativeMessages?: {
|
|
3068
|
+
title: string;
|
|
3069
|
+
confirmation?: {
|
|
3070
|
+
title: string;
|
|
3071
|
+
shareActionLabel: string;
|
|
3072
|
+
};
|
|
3073
|
+
};
|
|
3074
|
+
submitActionLabel: string;
|
|
3075
|
+
};
|
|
3076
|
+
checkout?: {
|
|
3077
|
+
title: string;
|
|
3078
|
+
submitActionLabel: string;
|
|
3079
|
+
confirmation?: {
|
|
3080
|
+
title: string;
|
|
3081
|
+
message: string;
|
|
3082
|
+
downloadTicketsLabel: string;
|
|
3083
|
+
addToCalendarLabel: string;
|
|
3084
|
+
shareEventLabel: string;
|
|
3085
|
+
};
|
|
3086
|
+
};
|
|
3087
|
+
registrationClosed?: {
|
|
3088
|
+
message: string;
|
|
3089
|
+
exploreEventsActionLabel: string;
|
|
3090
|
+
};
|
|
3091
|
+
ticketsUnavailable?: {
|
|
3092
|
+
message: string;
|
|
3093
|
+
exploreEventsActionLabel: string;
|
|
3094
|
+
};
|
|
3095
|
+
};
|
|
3096
|
+
};
|
|
3097
|
+
summaries?: {
|
|
3098
|
+
rsvps?: {
|
|
3099
|
+
totalCount: number;
|
|
3100
|
+
yesCount: number;
|
|
3101
|
+
noCount: number;
|
|
3102
|
+
waitlistCount: number;
|
|
3103
|
+
};
|
|
3104
|
+
tickets?: {
|
|
3105
|
+
ticketsSold: number;
|
|
3106
|
+
revenue?: {
|
|
3107
|
+
amount: string;
|
|
3108
|
+
currency: string;
|
|
3109
|
+
};
|
|
3110
|
+
currencyLocked: boolean;
|
|
3111
|
+
totalOrders: number;
|
|
3112
|
+
totalSales?: {
|
|
3113
|
+
amount: string;
|
|
3114
|
+
currency: string;
|
|
3115
|
+
};
|
|
3116
|
+
};
|
|
3117
|
+
};
|
|
3118
|
+
instanceId: string;
|
|
3119
|
+
guestListSettings?: {
|
|
3120
|
+
displayedPublicly: boolean;
|
|
3121
|
+
};
|
|
3122
|
+
userId: string;
|
|
3123
|
+
onlineConferencing?: {
|
|
3124
|
+
enabled: boolean;
|
|
3125
|
+
type: ConferenceTypeType;
|
|
3126
|
+
session?: {
|
|
3127
|
+
hostLink: string;
|
|
3128
|
+
guestLink: string;
|
|
3129
|
+
};
|
|
3130
|
+
};
|
|
3131
|
+
seoSettings?: {
|
|
3132
|
+
slug: string;
|
|
3133
|
+
advancedSeoData?: {
|
|
3134
|
+
tags: {
|
|
3135
|
+
type: string;
|
|
3136
|
+
children: string;
|
|
3137
|
+
custom: boolean;
|
|
3138
|
+
disabled: boolean;
|
|
3139
|
+
}[];
|
|
3140
|
+
settings?: {
|
|
3141
|
+
preventAutoRedirect: boolean;
|
|
3142
|
+
keywords: {
|
|
3143
|
+
term: string;
|
|
3144
|
+
isMain: boolean;
|
|
3145
|
+
}[];
|
|
3146
|
+
};
|
|
3147
|
+
};
|
|
3148
|
+
};
|
|
3149
|
+
agendaSettings?: {
|
|
3150
|
+
enabled: boolean;
|
|
3151
|
+
pageUrl: string;
|
|
3152
|
+
};
|
|
3153
|
+
};
|
|
3154
|
+
}
|
|
3155
|
+
export interface FindEventResponseNonNullableFields {
|
|
3156
|
+
event?: {
|
|
3157
|
+
_id: string;
|
|
3158
|
+
location?: {
|
|
3159
|
+
type: LocationType;
|
|
3160
|
+
};
|
|
3161
|
+
dateAndTimeSettings?: {
|
|
3162
|
+
recurrenceStatus: RecurrenceStatusStatus;
|
|
3163
|
+
recurringEvents?: {
|
|
3164
|
+
individualEventDates: {
|
|
3165
|
+
showTimeZone: boolean;
|
|
3166
|
+
}[];
|
|
3167
|
+
};
|
|
3168
|
+
};
|
|
3169
|
+
mainImage: string;
|
|
3170
|
+
slug: string;
|
|
3171
|
+
status: Status;
|
|
3172
|
+
registration?: {
|
|
3173
|
+
type: RegistrationTypeType;
|
|
3174
|
+
status: RegistrationStatusStatus;
|
|
3175
|
+
rsvp?: {
|
|
3176
|
+
responseType: ResponseType;
|
|
3177
|
+
waitlistEnabled: boolean;
|
|
3178
|
+
};
|
|
3179
|
+
tickets?: {
|
|
3180
|
+
guestsAssignedSeparately: boolean;
|
|
3181
|
+
ticketLimitPerOrder: number;
|
|
3182
|
+
lowestPrice?: {
|
|
3183
|
+
value: string;
|
|
3184
|
+
currency: string;
|
|
3185
|
+
};
|
|
3186
|
+
highestPrice?: {
|
|
3187
|
+
value: string;
|
|
3188
|
+
currency: string;
|
|
3189
|
+
};
|
|
3190
|
+
taxSettings?: {
|
|
3191
|
+
type: TaxType;
|
|
3192
|
+
};
|
|
3193
|
+
};
|
|
3194
|
+
allowedGuestTypes: GuestTypeType;
|
|
3195
|
+
initialType: InitialRegistrationTypeType;
|
|
3196
|
+
registrationPaused: boolean;
|
|
3197
|
+
registrationDisabled: boolean;
|
|
3198
|
+
};
|
|
3199
|
+
calendarUrls?: {
|
|
3200
|
+
google: string;
|
|
3201
|
+
ics: string;
|
|
3202
|
+
};
|
|
3203
|
+
eventPageUrl: string;
|
|
3204
|
+
form?: {
|
|
3205
|
+
controls: {
|
|
3206
|
+
type: InputControlType;
|
|
3207
|
+
system: boolean;
|
|
3208
|
+
name: string;
|
|
3209
|
+
inputs: {
|
|
3210
|
+
name: string;
|
|
3211
|
+
array: boolean;
|
|
3212
|
+
label: string;
|
|
3213
|
+
options: string[];
|
|
3214
|
+
mandatory: boolean;
|
|
3215
|
+
maxLength: number;
|
|
3216
|
+
type: ValueType;
|
|
3217
|
+
defaultOptionSelection?: {
|
|
3218
|
+
optionIndex: number;
|
|
3219
|
+
placeholderText: string;
|
|
3220
|
+
};
|
|
3221
|
+
labels: {
|
|
3222
|
+
name: string;
|
|
3223
|
+
label: string;
|
|
3224
|
+
}[];
|
|
3225
|
+
}[];
|
|
3226
|
+
label: string;
|
|
3227
|
+
orderIndex: number;
|
|
3228
|
+
_id: string;
|
|
3229
|
+
}[];
|
|
3230
|
+
messages?: {
|
|
3231
|
+
rsvp?: {
|
|
3232
|
+
rsvpYesOption: string;
|
|
3233
|
+
rsvpNoOption: string;
|
|
3234
|
+
positiveMessages?: {
|
|
3235
|
+
title: string;
|
|
3236
|
+
confirmation?: {
|
|
3237
|
+
title: string;
|
|
3238
|
+
message: string;
|
|
3239
|
+
addToCalendarActionLabel: string;
|
|
3240
|
+
shareActionLabel: string;
|
|
3241
|
+
};
|
|
3242
|
+
};
|
|
3243
|
+
waitlistMessages?: {
|
|
3244
|
+
title: string;
|
|
3245
|
+
confirmation?: {
|
|
3246
|
+
title: string;
|
|
3247
|
+
message: string;
|
|
3248
|
+
addToCalendarActionLabel: string;
|
|
3249
|
+
shareActionLabel: string;
|
|
3250
|
+
};
|
|
3251
|
+
};
|
|
3252
|
+
negativeMessages?: {
|
|
3253
|
+
title: string;
|
|
3254
|
+
confirmation?: {
|
|
3255
|
+
title: string;
|
|
3256
|
+
shareActionLabel: string;
|
|
3257
|
+
};
|
|
3258
|
+
};
|
|
3259
|
+
submitActionLabel: string;
|
|
3260
|
+
};
|
|
3261
|
+
checkout?: {
|
|
3262
|
+
title: string;
|
|
3263
|
+
submitActionLabel: string;
|
|
3264
|
+
confirmation?: {
|
|
3265
|
+
title: string;
|
|
3266
|
+
message: string;
|
|
3267
|
+
downloadTicketsLabel: string;
|
|
3268
|
+
addToCalendarLabel: string;
|
|
3269
|
+
shareEventLabel: string;
|
|
3270
|
+
};
|
|
3271
|
+
};
|
|
3272
|
+
registrationClosed?: {
|
|
3273
|
+
message: string;
|
|
3274
|
+
exploreEventsActionLabel: string;
|
|
3275
|
+
};
|
|
3276
|
+
ticketsUnavailable?: {
|
|
3277
|
+
message: string;
|
|
3278
|
+
exploreEventsActionLabel: string;
|
|
3279
|
+
};
|
|
3280
|
+
};
|
|
3281
|
+
};
|
|
3282
|
+
summaries?: {
|
|
3283
|
+
rsvps?: {
|
|
3284
|
+
totalCount: number;
|
|
3285
|
+
yesCount: number;
|
|
3286
|
+
noCount: number;
|
|
3287
|
+
waitlistCount: number;
|
|
3288
|
+
};
|
|
3289
|
+
tickets?: {
|
|
3290
|
+
ticketsSold: number;
|
|
3291
|
+
revenue?: {
|
|
3292
|
+
amount: string;
|
|
3293
|
+
currency: string;
|
|
3294
|
+
};
|
|
3295
|
+
currencyLocked: boolean;
|
|
3296
|
+
totalOrders: number;
|
|
3297
|
+
totalSales?: {
|
|
3298
|
+
amount: string;
|
|
3299
|
+
currency: string;
|
|
3300
|
+
};
|
|
3301
|
+
};
|
|
3302
|
+
};
|
|
3303
|
+
instanceId: string;
|
|
3304
|
+
guestListSettings?: {
|
|
3305
|
+
displayedPublicly: boolean;
|
|
3306
|
+
};
|
|
3307
|
+
userId: string;
|
|
3308
|
+
onlineConferencing?: {
|
|
3309
|
+
enabled: boolean;
|
|
3310
|
+
type: ConferenceTypeType;
|
|
3311
|
+
session?: {
|
|
3312
|
+
hostLink: string;
|
|
3313
|
+
guestLink: string;
|
|
3314
|
+
};
|
|
3315
|
+
};
|
|
3316
|
+
seoSettings?: {
|
|
3317
|
+
slug: string;
|
|
3318
|
+
advancedSeoData?: {
|
|
3319
|
+
tags: {
|
|
3320
|
+
type: string;
|
|
3321
|
+
children: string;
|
|
3322
|
+
custom: boolean;
|
|
3323
|
+
disabled: boolean;
|
|
3324
|
+
}[];
|
|
3325
|
+
settings?: {
|
|
3326
|
+
preventAutoRedirect: boolean;
|
|
3327
|
+
keywords: {
|
|
3328
|
+
term: string;
|
|
3329
|
+
isMain: boolean;
|
|
3330
|
+
}[];
|
|
3331
|
+
};
|
|
3332
|
+
};
|
|
3333
|
+
};
|
|
3334
|
+
agendaSettings?: {
|
|
3335
|
+
enabled: boolean;
|
|
3336
|
+
pageUrl: string;
|
|
3337
|
+
};
|
|
3338
|
+
};
|
|
3339
|
+
}
|
|
3340
|
+
/**
|
|
3341
|
+
* Creates an event. <br> <br>
|
|
3342
|
+
* The event includes a default registration form in the selected language, which consists of input fields for first name, last name, and email. See [Registration Form](https://dev.wix.com/api/rest/wix-events/wix-events/registration-form/about-the-registration-form-api) for more information. <br> <br>
|
|
3343
|
+
* You can create the event as a draft by setting the `draft` value to `true`. Otherwise, the event is published right away. <br> <br>
|
|
3344
|
+
* The event is automatically set up to send daily summary reports of new guests to your business email.
|
|
3345
|
+
* @param event - Event data.
|
|
3346
|
+
* @public
|
|
3347
|
+
* @documentationMaturity preview
|
|
3348
|
+
* @requiredField event
|
|
3349
|
+
* @requiredField event.dateAndTimeSettings
|
|
3350
|
+
* @requiredField event.location
|
|
3351
|
+
* @requiredField event.title
|
|
3352
|
+
* @permissionScope Manage Events - all permissions
|
|
3353
|
+
* @permissionScope Manage Events
|
|
3354
|
+
* @applicableIdentity APP
|
|
3355
|
+
* @returns Created event.
|
|
3356
|
+
*/
|
|
3357
|
+
export declare function createEvent(event: Event, options?: CreateEventOptions): Promise<Event & NonNullable<CreateEventResponseNonNullableFields>['event']>;
|
|
3358
|
+
export interface CreateEventOptions {
|
|
3359
|
+
/** Whether to create the event as a draft. */
|
|
3360
|
+
draft?: boolean;
|
|
3361
|
+
/**
|
|
3362
|
+
* Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
|
|
3363
|
+
* - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
|
|
3364
|
+
* - `TEXTS`: Returns `detailedDescription`.
|
|
3365
|
+
* - `REGISTRATION`: Returns `registration`.
|
|
3366
|
+
* - `URLS`: Returns `eventPageUrl`.
|
|
3367
|
+
* - `FORM`: Returns `form`.
|
|
3368
|
+
* - `DASHBOARD`: Returns `summaries`.
|
|
3369
|
+
* - `FEED`: Returns `feed`.
|
|
3370
|
+
* - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
|
|
3371
|
+
* - `SEO_SETTINGS`: Returns `seoSettings`.
|
|
3372
|
+
* - `AGENDA`: Returns `agendaSettings`.
|
|
3373
|
+
* - `CATEGORIES`: Returns `categories`.
|
|
3374
|
+
*/
|
|
3375
|
+
fields?: RequestedFields[];
|
|
3376
|
+
}
|
|
3377
|
+
/**
|
|
3378
|
+
* Clones an event, including the registration form, notifications, multilingual translations and ticket configuration from the original event. <br> <br>
|
|
3379
|
+
* The new event's date is automatically set to 14 days from the original event date. <br> <br>
|
|
3380
|
+
* If an event with the same title already exists, the new event's title gets a sequence number. For example, if you clone an event named "Leather Crafting 101", the new event's title is "Leather Crafting 101 (1)". <br> <br>
|
|
3381
|
+
* You can change the required entity field values while cloning an event. See [Partial Updates](https://dev.wix.com/api/rest/wix-events/wix-events/partial-updates) for more information.
|
|
3382
|
+
* @param eventId - Event ID.
|
|
3383
|
+
* @public
|
|
3384
|
+
* @documentationMaturity preview
|
|
3385
|
+
* @requiredField eventId
|
|
3386
|
+
* @permissionScope Manage Events - all permissions
|
|
3387
|
+
* @permissionScope Manage Events
|
|
3388
|
+
* @applicableIdentity APP
|
|
3389
|
+
*/
|
|
3390
|
+
export declare function cloneEvent(eventId: string, options?: CloneEventOptions): Promise<CloneEventResponse & CloneEventResponseNonNullableFields>;
|
|
3391
|
+
export interface CloneEventOptions {
|
|
3392
|
+
/** Field values to be changed when cloning the event. */
|
|
3393
|
+
event?: Event;
|
|
3394
|
+
/** Whether to clone the event as a draft. */
|
|
3395
|
+
draft?: boolean;
|
|
3396
|
+
/**
|
|
3397
|
+
* Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
|
|
3398
|
+
* - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
|
|
3399
|
+
* - `TEXTS`: Returns `detailedDescription`.
|
|
3400
|
+
* - `REGISTRATION`: Returns `registration`.
|
|
3401
|
+
* - `URLS`: Returns `eventPageUrl`.
|
|
3402
|
+
* - `FORM`: Returns `form`.
|
|
3403
|
+
* - `DASHBOARD`: Returns `summaries`.
|
|
3404
|
+
* - `FEED`: Returns `feed`.
|
|
3405
|
+
* - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
|
|
3406
|
+
* - `SEO_SETTINGS`: Returns `seoSettings`.
|
|
3407
|
+
* - `AGENDA`: Returns `agendaSettings`.
|
|
3408
|
+
* - `CATEGORIES`: Returns `categories`.
|
|
3409
|
+
*/
|
|
3410
|
+
fields?: RequestedFields[];
|
|
3411
|
+
}
|
|
3412
|
+
/**
|
|
3413
|
+
* Updates an event.
|
|
3414
|
+
* @param _id - Event ID.
|
|
3415
|
+
* @public
|
|
3416
|
+
* @documentationMaturity preview
|
|
3417
|
+
* @requiredField _id
|
|
3418
|
+
* @permissionScope Manage Events - all permissions
|
|
3419
|
+
* @permissionScope Manage Events
|
|
3420
|
+
* @applicableIdentity APP
|
|
3421
|
+
* @returns Updated event.
|
|
3422
|
+
*/
|
|
3423
|
+
export declare function updateEvent(_id: string, options?: UpdateEventOptions): Promise<Event & NonNullable<UpdateEventResponseNonNullableFields>['event']>;
|
|
3424
|
+
export interface UpdateEventOptions {
|
|
3425
|
+
event: {
|
|
3426
|
+
/**
|
|
3427
|
+
* Event ID.
|
|
3428
|
+
* @readonly
|
|
3429
|
+
*/
|
|
3430
|
+
_id?: string;
|
|
3431
|
+
/** Event location. */
|
|
3432
|
+
location?: Location;
|
|
3433
|
+
/** Event date and time settings. */
|
|
3434
|
+
dateAndTimeSettings?: DateAndTimeSettings;
|
|
3435
|
+
title?: string | null;
|
|
3436
|
+
shortDescription?: string | null;
|
|
3437
|
+
detailedDescription?: string | null;
|
|
3438
|
+
/** Main event image. */
|
|
3439
|
+
mainImage?: string;
|
|
3440
|
+
/**
|
|
3441
|
+
* 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".
|
|
3442
|
+
* @readonly
|
|
3443
|
+
*/
|
|
3444
|
+
slug?: string;
|
|
3445
|
+
/**
|
|
3446
|
+
* Date and time when the event was created in `yyyy-mm-ddThh:mm:sssZ` format.
|
|
3447
|
+
* @readonly
|
|
3448
|
+
*/
|
|
3449
|
+
_createdDate?: Date;
|
|
3450
|
+
/**
|
|
3451
|
+
* Date and time when the event was updated in `yyyy-mm-ddThh:mm:sssZ` format.
|
|
3452
|
+
* @readonly
|
|
3453
|
+
*/
|
|
3454
|
+
_updatedDate?: Date;
|
|
3455
|
+
/** @readonly */
|
|
3456
|
+
status?: Status;
|
|
3457
|
+
/** RSVP or ticketing registration details. */
|
|
3458
|
+
registration?: Registration;
|
|
3459
|
+
/** URLs that allow you to add an event to the Google calendar, or to download an [ICS calendar](https://icscalendar.com/) file. */
|
|
3460
|
+
calendarUrls?: CalendarUrls;
|
|
3461
|
+
/** Event page URL components. */
|
|
3462
|
+
eventPageUrl?: string;
|
|
3463
|
+
/** Event registration form. */
|
|
3464
|
+
form?: Form;
|
|
3465
|
+
/** Summary of RSVP or ticket sales. */
|
|
3466
|
+
summaries?: Summaries;
|
|
3467
|
+
/**
|
|
3468
|
+
* Instance ID of the site where the event is hosted.
|
|
3469
|
+
* @readonly
|
|
3470
|
+
*/
|
|
3471
|
+
instanceId?: string;
|
|
3472
|
+
/** Guest list configuration. */
|
|
3473
|
+
guestListSettings?: GuestListSettings;
|
|
3474
|
+
/**
|
|
3475
|
+
* ID of the user who created the event.
|
|
3476
|
+
* @readonly
|
|
3477
|
+
*/
|
|
3478
|
+
userId?: string;
|
|
3479
|
+
/** Online conferencing details. */
|
|
3480
|
+
onlineConferencing?: OnlineConferencing;
|
|
3481
|
+
/** SEO settings. */
|
|
3482
|
+
seoSettings?: SeoSettings;
|
|
3483
|
+
/** Assigned contacts label key. */
|
|
3484
|
+
contactLabel?: string | null;
|
|
3485
|
+
/** Event schedule details. */
|
|
3486
|
+
agendaSettings?: AgendaSettings;
|
|
3487
|
+
/** Visual settings for event. */
|
|
3488
|
+
eventDisplaySettings?: EventDisplaySettings;
|
|
3489
|
+
};
|
|
3490
|
+
/**
|
|
3491
|
+
* Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
|
|
3492
|
+
* - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
|
|
3493
|
+
* - `TEXTS`: Returns `detailedDescription`.
|
|
3494
|
+
* - `REGISTRATION`: Returns `registration`.
|
|
3495
|
+
* - `URLS`: Returns `eventPageUrl`.
|
|
3496
|
+
* - `FORM`: Returns `form`.
|
|
3497
|
+
* - `DASHBOARD`: Returns `summaries`.
|
|
3498
|
+
* - `FEED`: Returns `feed`.
|
|
3499
|
+
* - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
|
|
3500
|
+
* - `SEO_SETTINGS`: Returns `seoSettings`.
|
|
3501
|
+
* - `AGENDA`: Returns `agendaSettings`.
|
|
3502
|
+
* - `CATEGORIES`: Returns `categories`.
|
|
3503
|
+
*/
|
|
3504
|
+
fields?: RequestedFields[];
|
|
3505
|
+
}
|
|
3506
|
+
/**
|
|
3507
|
+
* Publishes a draft event to your live site. Once published, the event's status changes from `DRAFT` to `UPCOMING`. <br> <br>
|
|
3508
|
+
* It's impossible to revert the `DRAFT` status after publishing. The only option is to clone the event, then delete the original one.
|
|
3509
|
+
* @param eventId - Event ID.
|
|
3510
|
+
* @public
|
|
3511
|
+
* @documentationMaturity preview
|
|
3512
|
+
* @requiredField eventId
|
|
3513
|
+
* @permissionScope Manage Events - all permissions
|
|
3514
|
+
* @permissionScope Manage Events
|
|
3515
|
+
* @applicableIdentity APP
|
|
3516
|
+
*/
|
|
3517
|
+
export declare function publishDraftEvent(eventId: string, options?: PublishDraftEventOptions): Promise<PublishDraftEventResponse & PublishDraftEventResponseNonNullableFields>;
|
|
3518
|
+
export interface PublishDraftEventOptions {
|
|
3519
|
+
/**
|
|
3520
|
+
* Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
|
|
3521
|
+
* - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
|
|
3522
|
+
* - `TEXTS`: Returns `detailedDescription`.
|
|
3523
|
+
* - `REGISTRATION`: Returns `registration`.
|
|
3524
|
+
* - `URLS`: Returns `eventPageUrl`.
|
|
3525
|
+
* - `FORM`: Returns `form`.
|
|
3526
|
+
* - `DASHBOARD`: Returns `summaries`.
|
|
3527
|
+
* - `FEED`: Returns `feed`.
|
|
3528
|
+
* - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
|
|
3529
|
+
* - `SEO_SETTINGS`: Returns `seoSettings`.
|
|
3530
|
+
* - `AGENDA`: Returns `agendaSettings`.
|
|
3531
|
+
* - `CATEGORIES`: Returns `categories`.
|
|
3532
|
+
*/
|
|
3533
|
+
fields?: RequestedFields[];
|
|
3534
|
+
}
|
|
3535
|
+
/**
|
|
3536
|
+
* Cancels an event. <br> <br>
|
|
3537
|
+
* After cancellation, registration for an event is closed. To reuse the event, [copy]() and [publish]() it again. <br> <br>
|
|
3538
|
+
* If event cancellation notifications are enabled, canceling an event automatically triggers the sending of cancellation emails and/or push notifications to registered guests.
|
|
3539
|
+
* @param eventId - Event ID.
|
|
3540
|
+
* @public
|
|
3541
|
+
* @documentationMaturity preview
|
|
3542
|
+
* @requiredField eventId
|
|
3543
|
+
* @permissionScope Manage Events - all permissions
|
|
3544
|
+
* @permissionScope Manage Events
|
|
3545
|
+
* @applicableIdentity APP
|
|
3546
|
+
*/
|
|
3547
|
+
export declare function cancelEvent(eventId: string, options?: CancelEventOptions): Promise<CancelEventResponse & CancelEventResponseNonNullableFields>;
|
|
3548
|
+
export interface CancelEventOptions {
|
|
3549
|
+
/**
|
|
3550
|
+
* Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
|
|
3551
|
+
* - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
|
|
3552
|
+
* - `TEXTS`: Returns `detailedDescription`.
|
|
3553
|
+
* - `REGISTRATION`: Returns `registration`.
|
|
3554
|
+
* - `URLS`: Returns `eventPageUrl`.
|
|
3555
|
+
* - `FORM`: Returns `form`.
|
|
3556
|
+
* - `DASHBOARD`: Returns `summaries`.
|
|
3557
|
+
* - `FEED`: Returns `feed`.
|
|
3558
|
+
* - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
|
|
3559
|
+
* - `SEO_SETTINGS`: Returns `seoSettings`.
|
|
3560
|
+
* - `AGENDA`: Returns `agendaSettings`.
|
|
3561
|
+
* - `CATEGORIES`: Returns `categories`.
|
|
3562
|
+
*/
|
|
3563
|
+
fields?: RequestedFields[];
|
|
3564
|
+
}
|
|
3565
|
+
/**
|
|
3566
|
+
* Cancels multiple events that meet the given criteria. <br> <br>
|
|
3567
|
+
* After cancellation, registration for an event is closed. To reuse the event, [clone]() and [publish]() it again. <br> <br>
|
|
3568
|
+
* If event cancellation notifications are enabled, canceling an event automatically triggers the sending of cancellation emails and/or push notifications to registered guests.
|
|
3569
|
+
* @public
|
|
3570
|
+
* @documentationMaturity preview
|
|
3571
|
+
* @requiredField options.filter.filter
|
|
3572
|
+
* @permissionScope Manage Events - all permissions
|
|
3573
|
+
* @permissionScope Manage Events
|
|
3574
|
+
* @applicableIdentity APP
|
|
3575
|
+
*/
|
|
3576
|
+
export declare function bulkCancelEventsByFilter(options?: BulkCancelEventsByFilterOptions): Promise<void>;
|
|
3577
|
+
export interface BulkCancelEventsByFilterOptions {
|
|
3578
|
+
/** 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). */
|
|
3579
|
+
filter?: QueryV2;
|
|
3580
|
+
}
|
|
3581
|
+
/**
|
|
3582
|
+
* Permanently deletes an event. <br> <br>
|
|
3583
|
+
* You can retrieve the deleted event through a GDPR access request.
|
|
3584
|
+
* @param eventId - Event ID.
|
|
3585
|
+
* @public
|
|
3586
|
+
* @documentationMaturity preview
|
|
3587
|
+
* @requiredField eventId
|
|
3588
|
+
* @permissionScope Manage Events - all permissions
|
|
3589
|
+
* @permissionScope Manage Events
|
|
3590
|
+
* @applicableIdentity APP
|
|
3591
|
+
*/
|
|
3592
|
+
export declare function deleteEvent(eventId: string): Promise<DeleteEventResponse & DeleteEventResponseNonNullableFields>;
|
|
3593
|
+
/**
|
|
3594
|
+
* Permanently deletes multiple events that meet the given criteria. <br> <br>
|
|
3595
|
+
* You can retrieve the deleted events through a GDPR access request.
|
|
3596
|
+
* @public
|
|
3597
|
+
* @documentationMaturity preview
|
|
3598
|
+
* @requiredField options.filter.filter
|
|
3599
|
+
* @permissionScope Manage Events - all permissions
|
|
3600
|
+
* @permissionScope Manage Events
|
|
3601
|
+
* @applicableIdentity APP
|
|
3602
|
+
*/
|
|
3603
|
+
export declare function bulkDeleteEventsByFilter(options?: BulkDeleteEventsByFilterOptions): Promise<void>;
|
|
3604
|
+
export interface BulkDeleteEventsByFilterOptions {
|
|
3605
|
+
/** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
|
|
3606
|
+
filter?: QueryV2;
|
|
3607
|
+
}
|
|
3608
|
+
/**
|
|
3609
|
+
* Retrieves a list of events, given the provided paging, filtering, and sorting.
|
|
3610
|
+
* Query Events runs with these defaults, which you can override:
|
|
3611
|
+
* - `createdDate` is sorted in `ASC` order
|
|
3612
|
+
* - `paging.limit` is `100`
|
|
3613
|
+
* - `paging.offset` is `0`
|
|
3614
|
+
* For field support for filters and sorting, see [Events v3: Supported Filters and Sorting](https://dev.wix.com/api/rest/wix-events/events-v3/filter-and-sort).
|
|
3615
|
+
* To learn about working with _Query_ endpoints, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language), [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination), and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
|
|
3616
|
+
* @public
|
|
3617
|
+
* @documentationMaturity preview
|
|
3618
|
+
* @permissionScope Read Events - all read permissions
|
|
3619
|
+
* @permissionScope Manage Bookings Services and Settings
|
|
3620
|
+
* @permissionScope Manage Events - all permissions
|
|
3621
|
+
* @permissionScope Read Events
|
|
3622
|
+
* @permissionScope Manage Guest List
|
|
3623
|
+
* @permissionScope Manage Events
|
|
3624
|
+
* @applicableIdentity APP
|
|
3625
|
+
* @applicableIdentity MEMBER
|
|
3626
|
+
* @applicableIdentity VISITOR
|
|
3627
|
+
*/
|
|
3628
|
+
export declare function queryEvents(options?: QueryEventsOptions): EventsQueryBuilder;
|
|
3629
|
+
export interface QueryEventsOptions {
|
|
3630
|
+
/**
|
|
3631
|
+
* Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
|
|
3632
|
+
* - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
|
|
3633
|
+
* - `TEXTS`: Returns `detailedDescription`.
|
|
3634
|
+
* - `REGISTRATION`: Returns `registration`.
|
|
3635
|
+
* - `URLS`: Returns `eventPageUrl`.
|
|
3636
|
+
* - `FORM`: Returns `form`.
|
|
3637
|
+
* - `DASHBOARD`: Returns `summaries`.
|
|
3638
|
+
* - `FEED`: Returns `feed`.
|
|
3639
|
+
* - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
|
|
3640
|
+
* - `SEO_SETTINGS`: Returns `seoSettings`.
|
|
3641
|
+
* - `AGENDA`: Returns `agendaSettings`.
|
|
3642
|
+
* - `CATEGORIES`: Returns `categories`.
|
|
3643
|
+
*/
|
|
3644
|
+
fields?: RequestedFields[] | undefined;
|
|
3645
|
+
/**
|
|
3646
|
+
* Whether draft events should be returned in the response.
|
|
3647
|
+
* This parameter requires the `WIX_EVENTS.MANAGE_EVENTS` permission.
|
|
3648
|
+
*/
|
|
3649
|
+
includeDrafts?: boolean | undefined;
|
|
3650
|
+
}
|
|
3651
|
+
interface QueryOffsetResult {
|
|
3652
|
+
currentPage: number | undefined;
|
|
3653
|
+
totalPages: number | undefined;
|
|
3654
|
+
totalCount: number | undefined;
|
|
3655
|
+
hasNext: () => boolean;
|
|
3656
|
+
hasPrev: () => boolean;
|
|
3657
|
+
length: number;
|
|
3658
|
+
pageSize: number;
|
|
3659
|
+
}
|
|
3660
|
+
export interface EventsQueryResult extends QueryOffsetResult {
|
|
3661
|
+
items: Event[];
|
|
3662
|
+
query: EventsQueryBuilder;
|
|
3663
|
+
next: () => Promise<EventsQueryResult>;
|
|
3664
|
+
prev: () => Promise<EventsQueryResult>;
|
|
3665
|
+
}
|
|
3666
|
+
export interface EventsQueryBuilder {
|
|
3667
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
3668
|
+
* @param value - Value to compare against.
|
|
3669
|
+
* @documentationMaturity preview
|
|
3670
|
+
*/
|
|
3671
|
+
eq: (propertyName: '_id' | 'dateAndTimeSettings.startDate' | 'dateAndTimeSettings.endDate' | 'title' | 'slug' | '_createdDate' | '_updatedDate' | 'status' | 'registration.initialType' | 'userId', value: any) => EventsQueryBuilder;
|
|
3672
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
3673
|
+
* @param value - Value to compare against.
|
|
3674
|
+
* @documentationMaturity preview
|
|
3675
|
+
*/
|
|
3676
|
+
ne: (propertyName: '_id' | 'dateAndTimeSettings.startDate' | 'dateAndTimeSettings.endDate' | 'title' | 'slug' | '_createdDate' | '_updatedDate' | 'status' | 'userId', value: any) => EventsQueryBuilder;
|
|
3677
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
3678
|
+
* @param value - Value to compare against.
|
|
3679
|
+
* @documentationMaturity preview
|
|
3680
|
+
*/
|
|
3681
|
+
ge: (propertyName: 'dateAndTimeSettings.startDate' | 'dateAndTimeSettings.endDate' | '_createdDate' | '_updatedDate', value: any) => EventsQueryBuilder;
|
|
3682
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
3683
|
+
* @param value - Value to compare against.
|
|
3684
|
+
* @documentationMaturity preview
|
|
3685
|
+
*/
|
|
3686
|
+
gt: (propertyName: 'dateAndTimeSettings.startDate' | 'dateAndTimeSettings.endDate' | '_createdDate' | '_updatedDate', value: any) => EventsQueryBuilder;
|
|
3687
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
3688
|
+
* @param value - Value to compare against.
|
|
3689
|
+
* @documentationMaturity preview
|
|
3690
|
+
*/
|
|
3691
|
+
le: (propertyName: 'dateAndTimeSettings.startDate' | 'dateAndTimeSettings.endDate' | '_createdDate' | '_updatedDate', value: any) => EventsQueryBuilder;
|
|
3692
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
3693
|
+
* @param value - Value to compare against.
|
|
3694
|
+
* @documentationMaturity preview
|
|
3695
|
+
*/
|
|
3696
|
+
lt: (propertyName: 'dateAndTimeSettings.startDate' | 'dateAndTimeSettings.endDate' | '_createdDate' | '_updatedDate', value: any) => EventsQueryBuilder;
|
|
3697
|
+
/** @documentationMaturity preview */
|
|
3698
|
+
in: (propertyName: '_id' | 'dateAndTimeSettings.startDate' | 'dateAndTimeSettings.endDate' | 'title' | 'slug' | '_createdDate' | '_updatedDate' | 'status' | 'userId', value: any) => EventsQueryBuilder;
|
|
3699
|
+
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
3700
|
+
* @documentationMaturity preview
|
|
3701
|
+
*/
|
|
3702
|
+
ascending: (...propertyNames: Array<'_id' | 'dateAndTimeSettings.startDate' | 'dateAndTimeSettings.endDate' | 'title' | 'slug' | '_createdDate' | '_updatedDate'>) => EventsQueryBuilder;
|
|
3703
|
+
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
3704
|
+
* @documentationMaturity preview
|
|
3705
|
+
*/
|
|
3706
|
+
descending: (...propertyNames: Array<'_id' | 'dateAndTimeSettings.startDate' | 'dateAndTimeSettings.endDate' | 'title' | 'slug' | '_createdDate' | '_updatedDate'>) => EventsQueryBuilder;
|
|
3707
|
+
/** @param limit - Number of items to return, which is also the `pageSize` of the results object.
|
|
3708
|
+
* @documentationMaturity preview
|
|
3709
|
+
*/
|
|
3710
|
+
limit: (limit: number) => EventsQueryBuilder;
|
|
3711
|
+
/** @param skip - Number of items to skip in the query results before returning the results.
|
|
3712
|
+
* @documentationMaturity preview
|
|
3713
|
+
*/
|
|
3714
|
+
skip: (skip: number) => EventsQueryBuilder;
|
|
3715
|
+
/** @documentationMaturity preview */
|
|
3716
|
+
find: () => Promise<EventsQueryResult>;
|
|
3717
|
+
}
|
|
3718
|
+
/**
|
|
3719
|
+
* Counts events by status.
|
|
3720
|
+
* To learn about working with _query_ endpoints, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language), [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination), and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
|
|
3721
|
+
* @public
|
|
3722
|
+
* @documentationMaturity preview
|
|
3723
|
+
* @permissionScope Read Events - all read permissions
|
|
3724
|
+
* @permissionScope Manage Bookings Services and Settings
|
|
3725
|
+
* @permissionScope Manage Events - all permissions
|
|
3726
|
+
* @permissionScope Read Events
|
|
3727
|
+
* @permissionScope Manage Guest List
|
|
3728
|
+
* @permissionScope Manage Events
|
|
3729
|
+
* @applicableIdentity APP
|
|
3730
|
+
* @applicableIdentity MEMBER
|
|
3731
|
+
* @applicableIdentity VISITOR
|
|
3732
|
+
*/
|
|
3733
|
+
export declare function countEventsByStatus(options?: CountEventsByStatusOptions): Promise<CountEventsByStatusResponse>;
|
|
3734
|
+
export interface CountEventsByStatusOptions {
|
|
3735
|
+
/** Filter object in the following format: <br/> `"filter" : { "fieldName1": "value1" }`. */
|
|
3736
|
+
filter?: Record<string, any> | null;
|
|
3737
|
+
/**
|
|
3738
|
+
* Parameters to count events by.
|
|
3739
|
+
*
|
|
3740
|
+
* - Max: 20 facets
|
|
3741
|
+
*/
|
|
3742
|
+
facet?: string[];
|
|
3743
|
+
/**
|
|
3744
|
+
* Whether draft events should be returned in the response.
|
|
3745
|
+
* This parameter requires the `WIX_EVENTS.MANAGE_EVENTS` permission.
|
|
3746
|
+
*/
|
|
3747
|
+
includeDrafts?: boolean;
|
|
3748
|
+
}
|
|
3749
|
+
/**
|
|
3750
|
+
* Retrieves an event by ID.
|
|
3751
|
+
* @param eventId - Event ID.
|
|
3752
|
+
* @public
|
|
3753
|
+
* @documentationMaturity preview
|
|
3754
|
+
* @requiredField eventId
|
|
3755
|
+
* @permissionScope Read Events - all read permissions
|
|
3756
|
+
* @permissionScope Manage Bookings Services and Settings
|
|
3757
|
+
* @permissionScope Manage Events - all permissions
|
|
3758
|
+
* @permissionScope Read Events
|
|
3759
|
+
* @permissionScope Manage Guest List
|
|
3760
|
+
* @permissionScope Manage Events
|
|
3761
|
+
* @applicableIdentity APP
|
|
3762
|
+
* @applicableIdentity MEMBER
|
|
3763
|
+
* @applicableIdentity VISITOR
|
|
3764
|
+
* @returns Event.
|
|
3765
|
+
*/
|
|
3766
|
+
export declare function getEvent(eventId: string | null, options?: GetEventOptions): Promise<Event & NonNullable<GetEventResponseNonNullableFields>['event']>;
|
|
3767
|
+
export interface GetEventOptions {
|
|
3768
|
+
/**
|
|
3769
|
+
* Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
|
|
3770
|
+
* - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
|
|
3771
|
+
* - `TEXTS`: Returns `detailedDescription`.
|
|
3772
|
+
* - `REGISTRATION`: Returns `registration`.
|
|
3773
|
+
* - `URLS`: Returns `eventPageUrl`.
|
|
3774
|
+
* - `FORM`: Returns `form`.
|
|
3775
|
+
* - `DASHBOARD`: Returns `summaries`.
|
|
3776
|
+
* - `FEED`: Returns `feed`.
|
|
3777
|
+
* - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
|
|
3778
|
+
* - `SEO_SETTINGS`: Returns `seoSettings`.
|
|
3779
|
+
* - `AGENDA`: Returns `agendaSettings`.
|
|
3780
|
+
* - `CATEGORIES`: Returns `categories`.
|
|
3781
|
+
*/
|
|
3782
|
+
fields?: RequestedFields[];
|
|
3783
|
+
}
|
|
3784
|
+
/**
|
|
3785
|
+
* Retrieves an event by the slug URL.
|
|
3786
|
+
* @param slug - URL slug.
|
|
3787
|
+
* @public
|
|
3788
|
+
* @documentationMaturity preview
|
|
3789
|
+
* @requiredField slug
|
|
3790
|
+
* @permissionScope Read Events - all read permissions
|
|
3791
|
+
* @permissionScope Manage Bookings Services and Settings
|
|
3792
|
+
* @permissionScope Manage Events - all permissions
|
|
3793
|
+
* @permissionScope Read Events
|
|
3794
|
+
* @permissionScope Manage Guest List
|
|
3795
|
+
* @permissionScope Manage Events
|
|
3796
|
+
* @applicableIdentity APP
|
|
3797
|
+
* @applicableIdentity MEMBER
|
|
3798
|
+
* @applicableIdentity VISITOR
|
|
3799
|
+
*/
|
|
3800
|
+
export declare function getEventBySlug(slug: string | null, options?: GetEventBySlugOptions): Promise<GetEventBySlugResponse & GetEventBySlugResponseNonNullableFields>;
|
|
3801
|
+
export interface GetEventBySlugOptions {
|
|
3802
|
+
/**
|
|
3803
|
+
* Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
|
|
3804
|
+
* - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
|
|
3805
|
+
* - `TEXTS`: Returns `detailedDescription`.
|
|
3806
|
+
* - `REGISTRATION`: Returns `registration`.
|
|
3807
|
+
* - `URLS`: Returns `eventPageUrl`.
|
|
3808
|
+
* - `FORM`: Returns `form`.
|
|
3809
|
+
* - `DASHBOARD`: Returns `summaries`.
|
|
3810
|
+
* - `FEED`: Returns `feed`.
|
|
3811
|
+
* - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
|
|
3812
|
+
* - `SEO_SETTINGS`: Returns `seoSettings`.
|
|
3813
|
+
* - `AGENDA`: Returns `agendaSettings`.
|
|
3814
|
+
* - `CATEGORIES`: Returns `categories`.
|
|
3815
|
+
*/
|
|
3816
|
+
fields?: RequestedFields[];
|
|
3817
|
+
}
|
|
3818
|
+
/**
|
|
3819
|
+
* Finds an event by ID or URL slug. In contrast to Get Event endpoint which returns not found error,
|
|
3820
|
+
* Find Event returns empty response when an event is not found.
|
|
3821
|
+
* @public
|
|
3822
|
+
* @documentationMaturity preview
|
|
3823
|
+
* @permissionScope Read Events - all read permissions
|
|
3824
|
+
* @permissionScope Manage Bookings Services and Settings
|
|
3825
|
+
* @permissionScope Manage Events - all permissions
|
|
3826
|
+
* @permissionScope Read Events
|
|
3827
|
+
* @permissionScope Manage Guest List
|
|
3828
|
+
* @permissionScope Manage Events
|
|
3829
|
+
* @applicableIdentity APP
|
|
3830
|
+
* @applicableIdentity MEMBER
|
|
3831
|
+
* @applicableIdentity VISITOR
|
|
3832
|
+
*/
|
|
3833
|
+
export declare function findEvent(options?: FindEventOptions): Promise<FindEventResponse & FindEventResponseNonNullableFields>;
|
|
3834
|
+
export interface FindEventOptions extends FindEventRequestFindByOneOf {
|
|
3835
|
+
/** Event ID. */
|
|
3836
|
+
eventId?: string | null;
|
|
3837
|
+
/** URL slug. */
|
|
3838
|
+
slug?: string | null;
|
|
3839
|
+
/**
|
|
3840
|
+
* 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).
|
|
3841
|
+
* Some fields require additional computation that affects latency.
|
|
3842
|
+
* Use minimum set of required fieldset for best performance.
|
|
3843
|
+
*/
|
|
3844
|
+
fields?: RequestedFields[];
|
|
3845
|
+
}
|
|
3846
|
+
export {};
|