@wix/auto_sdk_events_wix-events-v-2 1.0.24 → 1.0.26
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/src/events-v3-event-wix-events-v-2.types.d.ts → events-v3-event-wix-events-v-2.universal-Mx-EGsAz.d.mts} +785 -948
- package/build/{internal/cjs/src/events-v3-event-wix-events-v-2.types.d.ts → events-v3-event-wix-events-v-2.universal-Mx-EGsAz.d.ts} +785 -948
- package/build/index.d.mts +212 -0
- package/build/index.d.ts +212 -0
- package/build/index.js +2626 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +2520 -0
- package/build/index.mjs.map +1 -0
- package/build/{es/src/events-v3-event-wix-events-v-2.types.d.ts → internal/events-v3-event-wix-events-v-2.universal-Mx-EGsAz.d.mts} +785 -948
- package/build/internal/{es/src/events-v3-event-wix-events-v-2.types.d.ts → events-v3-event-wix-events-v-2.universal-Mx-EGsAz.d.ts} +785 -948
- package/build/internal/index.d.mts +212 -0
- package/build/internal/index.d.ts +212 -0
- package/build/internal/index.js +2626 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +2520 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/meta.d.mts +2745 -0
- package/build/internal/meta.d.ts +2745 -0
- package/build/internal/meta.js +1201 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +1163 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/meta.d.mts +2745 -0
- package/build/meta.d.ts +2745 -0
- package/build/meta.js +1201 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +1163 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +13 -12
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.js.map +0 -1
- package/build/cjs/src/events-v3-event-wix-events-v-2.context.d.ts +0 -68
- package/build/cjs/src/events-v3-event-wix-events-v-2.context.js +0 -134
- package/build/cjs/src/events-v3-event-wix-events-v-2.context.js.map +0 -1
- package/build/cjs/src/events-v3-event-wix-events-v-2.http.d.ts +0 -87
- package/build/cjs/src/events-v3-event-wix-events-v-2.http.js +0 -1008
- package/build/cjs/src/events-v3-event-wix-events-v-2.http.js.map +0 -1
- package/build/cjs/src/events-v3-event-wix-events-v-2.meta.d.ts +0 -38
- package/build/cjs/src/events-v3-event-wix-events-v-2.meta.js +0 -256
- package/build/cjs/src/events-v3-event-wix-events-v-2.meta.js.map +0 -1
- package/build/cjs/src/events-v3-event-wix-events-v-2.public.d.ts +0 -165
- package/build/cjs/src/events-v3-event-wix-events-v-2.public.js +0 -452
- package/build/cjs/src/events-v3-event-wix-events-v-2.public.js.map +0 -1
- package/build/cjs/src/events-v3-event-wix-events-v-2.types.js +0 -675
- package/build/cjs/src/events-v3-event-wix-events-v-2.types.js.map +0 -1
- package/build/cjs/src/events-v3-event-wix-events-v-2.universal.d.ts +0 -5776
- package/build/cjs/src/events-v3-event-wix-events-v-2.universal.js +0 -1530
- package/build/cjs/src/events-v3-event-wix-events-v-2.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/package.json +0 -3
- package/build/es/src/events-v3-event-wix-events-v-2.context.d.ts +0 -68
- package/build/es/src/events-v3-event-wix-events-v-2.context.js +0 -68
- package/build/es/src/events-v3-event-wix-events-v-2.context.js.map +0 -1
- package/build/es/src/events-v3-event-wix-events-v-2.http.d.ts +0 -87
- package/build/es/src/events-v3-event-wix-events-v-2.http.js +0 -993
- package/build/es/src/events-v3-event-wix-events-v-2.http.js.map +0 -1
- package/build/es/src/events-v3-event-wix-events-v-2.meta.d.ts +0 -38
- package/build/es/src/events-v3-event-wix-events-v-2.meta.js +0 -218
- package/build/es/src/events-v3-event-wix-events-v-2.meta.js.map +0 -1
- package/build/es/src/events-v3-event-wix-events-v-2.public.d.ts +0 -165
- package/build/es/src/events-v3-event-wix-events-v-2.public.js +0 -374
- package/build/es/src/events-v3-event-wix-events-v-2.public.js.map +0 -1
- package/build/es/src/events-v3-event-wix-events-v-2.types.js +0 -671
- package/build/es/src/events-v3-event-wix-events-v-2.types.js.map +0 -1
- package/build/es/src/events-v3-event-wix-events-v-2.universal.d.ts +0 -5776
- package/build/es/src/events-v3-event-wix-events-v-2.universal.js +0 -1491
- package/build/es/src/events-v3-event-wix-events-v-2.universal.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -1
- package/build/internal/cjs/index.js +0 -18
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.d.ts +0 -1
- package/build/internal/cjs/meta.js +0 -18
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/src/events-v3-event-wix-events-v-2.context.d.ts +0 -68
- package/build/internal/cjs/src/events-v3-event-wix-events-v-2.context.js +0 -134
- package/build/internal/cjs/src/events-v3-event-wix-events-v-2.context.js.map +0 -1
- package/build/internal/cjs/src/events-v3-event-wix-events-v-2.http.d.ts +0 -87
- package/build/internal/cjs/src/events-v3-event-wix-events-v-2.http.js +0 -1008
- package/build/internal/cjs/src/events-v3-event-wix-events-v-2.http.js.map +0 -1
- package/build/internal/cjs/src/events-v3-event-wix-events-v-2.meta.d.ts +0 -38
- package/build/internal/cjs/src/events-v3-event-wix-events-v-2.meta.js +0 -256
- package/build/internal/cjs/src/events-v3-event-wix-events-v-2.meta.js.map +0 -1
- package/build/internal/cjs/src/events-v3-event-wix-events-v-2.public.d.ts +0 -165
- package/build/internal/cjs/src/events-v3-event-wix-events-v-2.public.js +0 -452
- package/build/internal/cjs/src/events-v3-event-wix-events-v-2.public.js.map +0 -1
- package/build/internal/cjs/src/events-v3-event-wix-events-v-2.types.js +0 -675
- package/build/internal/cjs/src/events-v3-event-wix-events-v-2.types.js.map +0 -1
- package/build/internal/cjs/src/events-v3-event-wix-events-v-2.universal.d.ts +0 -5776
- package/build/internal/cjs/src/events-v3-event-wix-events-v-2.universal.js +0 -1530
- package/build/internal/cjs/src/events-v3-event-wix-events-v-2.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/events-v3-event-wix-events-v-2.context.d.ts +0 -68
- package/build/internal/es/src/events-v3-event-wix-events-v-2.context.js +0 -68
- package/build/internal/es/src/events-v3-event-wix-events-v-2.context.js.map +0 -1
- package/build/internal/es/src/events-v3-event-wix-events-v-2.http.d.ts +0 -87
- package/build/internal/es/src/events-v3-event-wix-events-v-2.http.js +0 -993
- package/build/internal/es/src/events-v3-event-wix-events-v-2.http.js.map +0 -1
- package/build/internal/es/src/events-v3-event-wix-events-v-2.meta.d.ts +0 -38
- package/build/internal/es/src/events-v3-event-wix-events-v-2.meta.js +0 -218
- package/build/internal/es/src/events-v3-event-wix-events-v-2.meta.js.map +0 -1
- package/build/internal/es/src/events-v3-event-wix-events-v-2.public.d.ts +0 -165
- package/build/internal/es/src/events-v3-event-wix-events-v-2.public.js +0 -374
- package/build/internal/es/src/events-v3-event-wix-events-v-2.public.js.map +0 -1
- package/build/internal/es/src/events-v3-event-wix-events-v-2.types.js +0 -671
- package/build/internal/es/src/events-v3-event-wix-events-v-2.types.js.map +0 -1
- package/build/internal/es/src/events-v3-event-wix-events-v-2.universal.d.ts +0 -5776
- package/build/internal/es/src/events-v3-event-wix-events-v-2.universal.js +0 -1491
- package/build/internal/es/src/events-v3-event-wix-events-v-2.universal.js.map +0 -1
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
|
|
1
|
+
interface V3Event {
|
|
2
2
|
/**
|
|
3
3
|
* Event ID.
|
|
4
4
|
* @format GUID
|
|
5
5
|
* @readonly
|
|
6
6
|
*/
|
|
7
|
-
|
|
7
|
+
_id?: string;
|
|
8
8
|
/** Event location. */
|
|
9
9
|
location?: Location;
|
|
10
10
|
/** Event date and time settings. */
|
|
@@ -16,15 +16,12 @@ export interface V3Event {
|
|
|
16
16
|
*/
|
|
17
17
|
title?: string | null;
|
|
18
18
|
/**
|
|
19
|
-
* Short description that appears under the event title.
|
|
20
|
-
* **Note:** This field is returned only when the `DETAILS` fieldset is included in the request.
|
|
19
|
+
* Short description that appears under the event title.
|
|
21
20
|
* @maxLength 500
|
|
22
21
|
*/
|
|
23
22
|
shortDescription?: string | null;
|
|
24
23
|
/**
|
|
25
|
-
* Detailed description of an event.
|
|
26
|
-
*
|
|
27
|
-
* This field is deprecated.
|
|
24
|
+
* Detailed description of an event. You can enter the description using rich text format (add various types of markups, such as underlines, italics, bolding, color codes, bullet lists, and links by using HTML formatting tags).
|
|
28
25
|
* @maxLength 50000
|
|
29
26
|
* @deprecated Detailed description of an event.
|
|
30
27
|
*
|
|
@@ -37,7 +34,7 @@ export interface V3Event {
|
|
|
37
34
|
* Main event image. <br>
|
|
38
35
|
* **Note:** This field is returned only when the `DETAILS` fieldset is included in the request.
|
|
39
36
|
*/
|
|
40
|
-
mainImage?:
|
|
37
|
+
mainImage?: string;
|
|
41
38
|
/**
|
|
42
39
|
* 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".
|
|
43
40
|
* @readonly
|
|
@@ -47,14 +44,20 @@ export interface V3Event {
|
|
|
47
44
|
* Date and time when the event was created.
|
|
48
45
|
* @readonly
|
|
49
46
|
*/
|
|
50
|
-
|
|
47
|
+
_createdDate?: Date | null;
|
|
51
48
|
/**
|
|
52
49
|
* Date and time when the event was updated.
|
|
53
50
|
* @readonly
|
|
54
51
|
*/
|
|
55
|
-
|
|
52
|
+
_updatedDate?: Date | null;
|
|
56
53
|
/**
|
|
57
|
-
* Event status
|
|
54
|
+
* Event status:
|
|
55
|
+
*
|
|
56
|
+
* - `UPCOMING`: Event is published and scheduled to start.
|
|
57
|
+
* - `STARTED`: Event has started.
|
|
58
|
+
* - `ENDED`: Event has ended.
|
|
59
|
+
* - `CANCELED`: Event is canceled.
|
|
60
|
+
* - `DRAFT`: Event is not published.
|
|
58
61
|
* @readonly
|
|
59
62
|
*/
|
|
60
63
|
status?: Status;
|
|
@@ -73,7 +76,7 @@ export interface V3Event {
|
|
|
73
76
|
* Event page URL components. <br>
|
|
74
77
|
* **Note:** This field is returned only when the `URLS` fieldset is included in the request.
|
|
75
78
|
*/
|
|
76
|
-
eventPageUrl?:
|
|
79
|
+
eventPageUrl?: string;
|
|
77
80
|
/**
|
|
78
81
|
* Event registration form. <br>
|
|
79
82
|
* **Note:** This field is returned only when the `FORM` fieldset is included in the request.
|
|
@@ -119,7 +122,11 @@ export interface V3Event {
|
|
|
119
122
|
agendaSettings?: AgendaSettings;
|
|
120
123
|
/** Visual settings for event. */
|
|
121
124
|
eventDisplaySettings?: V3EventDisplaySettings;
|
|
122
|
-
/**
|
|
125
|
+
/**
|
|
126
|
+
* Event description with rich content.
|
|
127
|
+
*
|
|
128
|
+
* For the event description to appear on your site, connect the [Rich Content Viewer](https://dev.wix.com/docs/velo/velo-only-apis/$w/rich-content-viewer/introduction) element, and assign the description value to the viewer.
|
|
129
|
+
*/
|
|
123
130
|
description?: RichContent;
|
|
124
131
|
/**
|
|
125
132
|
* Event publish timestamp.
|
|
@@ -127,20 +134,25 @@ export interface V3Event {
|
|
|
127
134
|
*/
|
|
128
135
|
publishedDate?: Date | null;
|
|
129
136
|
}
|
|
130
|
-
|
|
137
|
+
interface Location {
|
|
131
138
|
/**
|
|
132
139
|
* Location name. This value is displayed instead of the address when the location is defined as TBD by setting the `locationTbd` property to `true`.
|
|
133
140
|
* @maxLength 50
|
|
134
141
|
*/
|
|
135
142
|
name?: string | null;
|
|
136
|
-
/**
|
|
143
|
+
/**
|
|
144
|
+
* Location type:
|
|
145
|
+
*
|
|
146
|
+
* - `VENUE`: The event is on-site at a specific physical location.
|
|
147
|
+
* - `ONLINE`: The event is online, such as a virtual video conference.
|
|
148
|
+
*/
|
|
137
149
|
type?: LocationType;
|
|
138
150
|
/** Exact location address. */
|
|
139
151
|
address?: CommonAddress;
|
|
140
152
|
/** Whether the event location is TBD. */
|
|
141
153
|
locationTbd?: boolean | null;
|
|
142
154
|
}
|
|
143
|
-
|
|
155
|
+
declare enum LocationType {
|
|
144
156
|
/** Unknown location type. */
|
|
145
157
|
UNKNOWN_LOCATION = "UNKNOWN_LOCATION",
|
|
146
158
|
/** Event is on-site at a specific physical location. */
|
|
@@ -149,14 +161,14 @@ export declare enum LocationType {
|
|
|
149
161
|
ONLINE = "ONLINE"
|
|
150
162
|
}
|
|
151
163
|
/** Physical address */
|
|
152
|
-
|
|
164
|
+
interface CommonAddress extends CommonAddressStreetOneOf {
|
|
153
165
|
/** Street address. */
|
|
154
166
|
streetAddress?: CommonStreetAddress;
|
|
155
167
|
/**
|
|
156
168
|
* Primary address information (street and building number).
|
|
157
169
|
* @maxLength 250
|
|
158
170
|
*/
|
|
159
|
-
|
|
171
|
+
addressLine1?: string | null;
|
|
160
172
|
/**
|
|
161
173
|
* 2-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format.
|
|
162
174
|
* @format COUNTRY
|
|
@@ -184,7 +196,7 @@ export interface CommonAddress extends CommonAddressStreetOneOf {
|
|
|
184
196
|
addressLine2?: string | null;
|
|
185
197
|
}
|
|
186
198
|
/** @oneof */
|
|
187
|
-
|
|
199
|
+
interface CommonAddressStreetOneOf {
|
|
188
200
|
/** Street address. */
|
|
189
201
|
streetAddress?: CommonStreetAddress;
|
|
190
202
|
/**
|
|
@@ -193,7 +205,7 @@ export interface CommonAddressStreetOneOf {
|
|
|
193
205
|
*/
|
|
194
206
|
addressLine?: string | null;
|
|
195
207
|
}
|
|
196
|
-
|
|
208
|
+
interface CommonStreetAddress {
|
|
197
209
|
/**
|
|
198
210
|
* Street number.
|
|
199
211
|
* @maxLength 100
|
|
@@ -205,7 +217,7 @@ export interface CommonStreetAddress {
|
|
|
205
217
|
*/
|
|
206
218
|
name?: string;
|
|
207
219
|
}
|
|
208
|
-
|
|
220
|
+
interface CommonAddressLocation {
|
|
209
221
|
/**
|
|
210
222
|
* Address latitude coordinates.
|
|
211
223
|
* @min -90
|
|
@@ -219,7 +231,7 @@ export interface CommonAddressLocation {
|
|
|
219
231
|
*/
|
|
220
232
|
longitude?: number | null;
|
|
221
233
|
}
|
|
222
|
-
|
|
234
|
+
interface CommonSubdivision {
|
|
223
235
|
/**
|
|
224
236
|
* Short subdivision code.
|
|
225
237
|
* @maxLength 100
|
|
@@ -231,7 +243,7 @@ export interface CommonSubdivision {
|
|
|
231
243
|
*/
|
|
232
244
|
name?: string;
|
|
233
245
|
}
|
|
234
|
-
|
|
246
|
+
declare enum SubdivisionSubdivisionType {
|
|
235
247
|
UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
|
|
236
248
|
/** State */
|
|
237
249
|
ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
|
|
@@ -246,7 +258,7 @@ export declare enum SubdivisionSubdivisionType {
|
|
|
246
258
|
/** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
|
|
247
259
|
COUNTRY = "COUNTRY"
|
|
248
260
|
}
|
|
249
|
-
|
|
261
|
+
interface DateAndTimeSettings {
|
|
250
262
|
/** Whether the event date and time are TBD. */
|
|
251
263
|
dateAndTimeTbd?: boolean | null;
|
|
252
264
|
/**
|
|
@@ -254,12 +266,22 @@ export interface DateAndTimeSettings {
|
|
|
254
266
|
* @maxLength 100
|
|
255
267
|
*/
|
|
256
268
|
dateAndTimeTbdMessage?: string | null;
|
|
257
|
-
/**
|
|
269
|
+
/**
|
|
270
|
+
* Event start date.
|
|
271
|
+
*
|
|
272
|
+
* **Note:** You need to write this field in the snake case, instead of a camel case. For example, `start_date`.
|
|
273
|
+
*/
|
|
258
274
|
startDate?: Date | null;
|
|
259
|
-
/**
|
|
275
|
+
/**
|
|
276
|
+
* Event end date.
|
|
277
|
+
*
|
|
278
|
+
* **Note:** You need to write this field in the snake case, instead of a camel case. For example, `end_date`.
|
|
279
|
+
*/
|
|
260
280
|
endDate?: Date | null;
|
|
261
281
|
/**
|
|
262
|
-
* Event time zone ID in the
|
|
282
|
+
* Event time zone ID in the TZ database format.
|
|
283
|
+
*
|
|
284
|
+
* **Note:** You need to write this field in the snake case, instead of a camel case. For example, `time_zone_id`.
|
|
263
285
|
* @maxLength 100
|
|
264
286
|
*/
|
|
265
287
|
timeZoneId?: string | null;
|
|
@@ -268,7 +290,13 @@ export interface DateAndTimeSettings {
|
|
|
268
290
|
/** Whether the time zone is displayed in the formatted schedule. */
|
|
269
291
|
showTimeZone?: boolean | null;
|
|
270
292
|
/**
|
|
271
|
-
* Repeating event status.
|
|
293
|
+
* Repeating event status. Possible values:
|
|
294
|
+
*
|
|
295
|
+
* - `ONE_TIME`: The event happens only once and can last multiple days.
|
|
296
|
+
* - `RECURRING`: A series of events that repeat.
|
|
297
|
+
* - `RECURRING_UPCOMING`: Next event in a schedule of recurring events.
|
|
298
|
+
* - `RECURRING_RECENTLY_ENDED`: Latest event that ended in a schedule of recurring events.
|
|
299
|
+
* - `RECURRING_RECENTLY_CANCELED`: Latest canceled event tin a schedule of recurring events.
|
|
272
300
|
* @readonly
|
|
273
301
|
*/
|
|
274
302
|
recurrenceStatus?: RecurrenceStatusStatus;
|
|
@@ -277,7 +305,7 @@ export interface DateAndTimeSettings {
|
|
|
277
305
|
/** Formatted date and time settings. */
|
|
278
306
|
formatted?: Formatted;
|
|
279
307
|
}
|
|
280
|
-
|
|
308
|
+
declare enum RecurrenceStatusStatus {
|
|
281
309
|
/** Unknown recurrance status. */
|
|
282
310
|
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
283
311
|
/** Event happens only once and can last multiple days. */
|
|
@@ -291,9 +319,9 @@ export declare enum RecurrenceStatusStatus {
|
|
|
291
319
|
/** Latest canceled event in a schedule of recurring events */
|
|
292
320
|
RECURRING_RECENTLY_CANCELED = "RECURRING_RECENTLY_CANCELED"
|
|
293
321
|
}
|
|
294
|
-
|
|
322
|
+
interface Recurrences {
|
|
295
323
|
/**
|
|
296
|
-
* Individual event dates.
|
|
324
|
+
* Individual event dates info.
|
|
297
325
|
* @maxSize 1000
|
|
298
326
|
*/
|
|
299
327
|
individualEventDates?: Occurrence[];
|
|
@@ -304,7 +332,7 @@ export interface Recurrences {
|
|
|
304
332
|
*/
|
|
305
333
|
categoryId?: string | null;
|
|
306
334
|
}
|
|
307
|
-
|
|
335
|
+
interface Occurrence {
|
|
308
336
|
/** Event start date. */
|
|
309
337
|
startDate?: Date | null;
|
|
310
338
|
/** Event end date. */
|
|
@@ -317,10 +345,11 @@ export interface Occurrence {
|
|
|
317
345
|
/** Whether the time zone is displayed in a formatted schedule. */
|
|
318
346
|
showTimeZone?: boolean;
|
|
319
347
|
}
|
|
320
|
-
|
|
348
|
+
interface Formatted {
|
|
321
349
|
/**
|
|
322
|
-
* Formatted date and time representation.
|
|
323
|
-
*
|
|
350
|
+
* Formatted date and time representation.
|
|
351
|
+
*
|
|
352
|
+
* Example of formatting when an event lasts multiple days and is in the UTC time zone: `September 1, 2015 at 10:20 AM – September 5, 2015 at 12:14 PM`.
|
|
324
353
|
* Example of formatting when an event lasts 1 day and is in the GMT+2 time zone: `February 1, 2018, 12:10 – 2:50 PM GMT+2`.
|
|
325
354
|
* @readonly
|
|
326
355
|
* @maxLength 500
|
|
@@ -355,7 +384,7 @@ export interface Formatted {
|
|
|
355
384
|
* A coarse-grained representation of time duration divided into whole constituting components of days, hours, and minutes.
|
|
356
385
|
* For example, 25.5 hours duration is represented as `{ days: 1, hours: 1, minutes: 30 }`.
|
|
357
386
|
*/
|
|
358
|
-
|
|
387
|
+
interface TimeDuration {
|
|
359
388
|
/** Number of days. */
|
|
360
389
|
days?: number;
|
|
361
390
|
/**
|
|
@@ -369,7 +398,7 @@ export interface TimeDuration {
|
|
|
369
398
|
*/
|
|
370
399
|
minutes?: number;
|
|
371
400
|
}
|
|
372
|
-
|
|
401
|
+
declare enum Status {
|
|
373
402
|
/** Unknown event status. */
|
|
374
403
|
UNKNOWN_EVENT_STATUS = "UNKNOWN_EVENT_STATUS",
|
|
375
404
|
/** Event is published and scheduled to start. */
|
|
@@ -383,26 +412,29 @@ export declare enum Status {
|
|
|
383
412
|
/** Event is not public. */
|
|
384
413
|
DRAFT = "DRAFT"
|
|
385
414
|
}
|
|
386
|
-
|
|
387
|
-
/**
|
|
388
|
-
* The base URL. For premium sites, the base is the domain. For free sites, the base is the Wix site URL (for example, `https://mysite.wixsite.com/mysite`).
|
|
389
|
-
* @maxLength 500
|
|
390
|
-
*/
|
|
391
|
-
base?: string;
|
|
392
|
-
/**
|
|
393
|
-
* The path to the page. For example, `/product-page/a-product`.
|
|
394
|
-
* @maxLength 500
|
|
395
|
-
*/
|
|
396
|
-
path?: string;
|
|
397
|
-
}
|
|
398
|
-
export interface Registration {
|
|
415
|
+
interface Registration {
|
|
399
416
|
/**
|
|
400
|
-
* Current registration type
|
|
417
|
+
* Current registration type:
|
|
418
|
+
*
|
|
419
|
+
* - `RSVP`: Guests register by RSVPing to the event.
|
|
420
|
+
* - `TICKETING`: Guests register by buying tickets.
|
|
421
|
+
* - `EXTERNAL`: Guests register externally using some other site or platform.
|
|
422
|
+
* - `NONE`: No registration is required, all guests can attend. This registration type is for only displaying the event details on a site.
|
|
423
|
+
*
|
|
424
|
+
* The property value might change to `EXTERNAL` or `NONE` after initial event creation, depending on any additional configuration applied to the event.
|
|
401
425
|
* @readonly
|
|
402
426
|
*/
|
|
403
427
|
type?: RegistrationTypeType;
|
|
404
428
|
/**
|
|
405
|
-
* Registration status.
|
|
429
|
+
* Registration status. Possible values:
|
|
430
|
+
*
|
|
431
|
+
* - `CLOSED_AUTOMATICALLY`: Registration is closed after tickets are sold out.
|
|
432
|
+
* - `CLOSED_MANUALLY`: Registration is closed when the `registration.registrationDisabled` property is set to `true`.
|
|
433
|
+
* - `OPEN_RSVP`: Guests can start RSVPing to the event.
|
|
434
|
+
* - `OPEN_RSVP_WAITLIST_ONLY`: Guest list has reached the maximum, new guests are added to a waitlist.
|
|
435
|
+
* - `OPEN_TICKETS`: Guests can buy tickets to the event.
|
|
436
|
+
* - `OPEN_EXTERNAL`: Guests register on a different page or web address.
|
|
437
|
+
* - `SCHEDULED_RSVP`: Registration via RSVP is scheduled for the future.
|
|
406
438
|
* @readonly
|
|
407
439
|
*/
|
|
408
440
|
status?: RegistrationStatusStatus;
|
|
@@ -412,10 +444,20 @@ export interface Registration {
|
|
|
412
444
|
tickets?: TicketsRegistration;
|
|
413
445
|
/** External registration details. */
|
|
414
446
|
external?: ExternalRegistration;
|
|
415
|
-
/**
|
|
447
|
+
/**
|
|
448
|
+
* Types of guests allowed to register. Possible values:
|
|
449
|
+
*
|
|
450
|
+
* - `VISITOR_OR_MEMBER`: All site visitors can RSVP to the event.
|
|
451
|
+
* - `MEMBER`: Only people who have signed up as members of your site are able to RSVP to the event.
|
|
452
|
+
*/
|
|
416
453
|
allowedGuestTypes?: GuestTypeType;
|
|
417
454
|
/**
|
|
418
|
-
* Initial event type which is set when creating an event.
|
|
455
|
+
* Initial event type which is set when creating an event. Possible values:
|
|
456
|
+
*
|
|
457
|
+
* - `RSVP`: Guests register by RSVPing to the event.
|
|
458
|
+
* - `TICKETING`: Guests register by buying tickets.
|
|
459
|
+
*
|
|
460
|
+
* This property value never changes.
|
|
419
461
|
* @immutable
|
|
420
462
|
*/
|
|
421
463
|
initialType?: InitialRegistrationTypeType;
|
|
@@ -424,7 +466,7 @@ export interface Registration {
|
|
|
424
466
|
/** Whether the registration is disabled. */
|
|
425
467
|
registrationDisabled?: boolean;
|
|
426
468
|
}
|
|
427
|
-
|
|
469
|
+
declare enum RegistrationTypeType {
|
|
428
470
|
/** Unknown registration type. */
|
|
429
471
|
UNKNOWN_REGISTRATION_TYPE = "UNKNOWN_REGISTRATION_TYPE",
|
|
430
472
|
/** Guests register by RSVPing to the event. */
|
|
@@ -436,7 +478,7 @@ export declare enum RegistrationTypeType {
|
|
|
436
478
|
/** No registration is required, all guests can attend. This registration type is for only displaying the event details on a site. The property value can be changed from RSVP/TICKETING to EXTERNAL or NONE after the event is created, depending on any additional configurations applied to the event. */
|
|
437
479
|
NONE = "NONE"
|
|
438
480
|
}
|
|
439
|
-
|
|
481
|
+
declare enum RegistrationStatusStatus {
|
|
440
482
|
/** Registration status is not applicable */
|
|
441
483
|
UNKNOWN_REGISTRATION_STATUS = "UNKNOWN_REGISTRATION_STATUS",
|
|
442
484
|
/** Registration is closed after tickets are sold out. */
|
|
@@ -454,7 +496,7 @@ export declare enum RegistrationStatusStatus {
|
|
|
454
496
|
/** Registration via RSVP is scheduled for the future. */
|
|
455
497
|
SCHEDULED_RSVP = "SCHEDULED_RSVP"
|
|
456
498
|
}
|
|
457
|
-
|
|
499
|
+
interface RsvpRegistration {
|
|
458
500
|
/** Available answers for registration to an event. */
|
|
459
501
|
responseType?: ResponseType;
|
|
460
502
|
/** How many guests can RSVP to an event. */
|
|
@@ -466,7 +508,7 @@ export interface RsvpRegistration {
|
|
|
466
508
|
/** Registration end date. */
|
|
467
509
|
endDate?: Date | null;
|
|
468
510
|
}
|
|
469
|
-
|
|
511
|
+
declare enum ResponseType {
|
|
470
512
|
/** Unknown response type. */
|
|
471
513
|
UNKNOWN_RESPONSE_TYPE = "UNKNOWN_RESPONSE_TYPE",
|
|
472
514
|
/** Only a **Yes** answer is available to select when RSVP'ing to an event. */
|
|
@@ -474,11 +516,11 @@ export declare enum ResponseType {
|
|
|
474
516
|
/** *Yes** and **No** answers are available to select when RSVP'ing to an event. */
|
|
475
517
|
YES_AND_NO = "YES_AND_NO"
|
|
476
518
|
}
|
|
477
|
-
|
|
519
|
+
interface TicketsRegistration {
|
|
478
520
|
/** Whether the registration form must be filled out separately for each ticket. */
|
|
479
521
|
guestsAssignedSeparately?: boolean;
|
|
480
522
|
/**
|
|
481
|
-
* Ticket limit per order.
|
|
523
|
+
* Ticket limit per order.
|
|
482
524
|
* Default: 20 tickets.
|
|
483
525
|
* @max 50
|
|
484
526
|
*/
|
|
@@ -513,7 +555,7 @@ export interface TicketsRegistration {
|
|
|
513
555
|
* Money.
|
|
514
556
|
* Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.
|
|
515
557
|
*/
|
|
516
|
-
|
|
558
|
+
interface Money {
|
|
517
559
|
/**
|
|
518
560
|
* Amount of money in decimal form. A period is used as a decimal separator (for example, `3.99`).
|
|
519
561
|
* @format DECIMAL_VALUE
|
|
@@ -530,8 +572,13 @@ export interface Money {
|
|
|
530
572
|
*/
|
|
531
573
|
formattedValue?: string | null;
|
|
532
574
|
}
|
|
533
|
-
|
|
534
|
-
/**
|
|
575
|
+
interface TaxSettings {
|
|
576
|
+
/**
|
|
577
|
+
* Tax application settings:
|
|
578
|
+
*
|
|
579
|
+
* - `INCLUDED_IN_PRICE`: Deduct the fee from the ticket price for a seller. For example, if you're selling tickets for $10, a ticket service fee of $0.25 is deducted from the price and you'll get $9.75.
|
|
580
|
+
* - `ADDED_AT_CHECKOUT`: Show the fee iin addition to the ticket price at checkout and a guest pays the fee. For example, if you sell tickets for $10, a customer sees a ticket service fee of $0.25 and pays $10.25 in total.
|
|
581
|
+
*/
|
|
535
582
|
type?: TaxType;
|
|
536
583
|
/**
|
|
537
584
|
* Tax name.
|
|
@@ -548,7 +595,7 @@ export interface TaxSettings {
|
|
|
548
595
|
appliedToDonations?: boolean | null;
|
|
549
596
|
}
|
|
550
597
|
/** Tax application settings. */
|
|
551
|
-
|
|
598
|
+
declare enum TaxType {
|
|
552
599
|
/** Unknown tax type. */
|
|
553
600
|
UNKNOWN_TAX_TYPE = "UNKNOWN_TAX_TYPE",
|
|
554
601
|
/** Deduct the fee from the ticket price for a seller. For example, if you're selling tickets for $10, a ticket ticket service fee of $0.25 is deducted from the price and you'll get $9.75. */
|
|
@@ -556,14 +603,14 @@ export declare enum TaxType {
|
|
|
556
603
|
/** Show the fee in addition to the ticket price at checkout and a guest pays the fee. For example, if you sell tickets for $10, a customer sees a ticket ticket service fee of $0.25 and pays $10.25 in total. */
|
|
557
604
|
ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
|
|
558
605
|
}
|
|
559
|
-
|
|
606
|
+
interface ExternalRegistration {
|
|
560
607
|
/**
|
|
561
608
|
* External event registration URL.
|
|
562
609
|
* @format WEB_URL
|
|
563
610
|
*/
|
|
564
611
|
url?: string | null;
|
|
565
612
|
}
|
|
566
|
-
|
|
613
|
+
declare enum GuestTypeType {
|
|
567
614
|
/** Unknown guest type. */
|
|
568
615
|
UNKNOWN_GUEST_TYPE = "UNKNOWN_GUEST_TYPE",
|
|
569
616
|
/** All site visitors can RSVP to the event. */
|
|
@@ -571,7 +618,7 @@ export declare enum GuestTypeType {
|
|
|
571
618
|
/** Only people who have signed up as members of your site are able to RSVP to the event. */
|
|
572
619
|
MEMBER = "MEMBER"
|
|
573
620
|
}
|
|
574
|
-
|
|
621
|
+
declare enum InitialRegistrationTypeType {
|
|
575
622
|
/** Unknown initial registration type. */
|
|
576
623
|
UNKNOWN_INITIAL_REGISTRATION_TYPE = "UNKNOWN_INITIAL_REGISTRATION_TYPE",
|
|
577
624
|
/** Guests register by RSVPing to the event. */
|
|
@@ -579,31 +626,7 @@ export declare enum InitialRegistrationTypeType {
|
|
|
579
626
|
/** Guests register by buying tickets. This property value never changes. */
|
|
580
627
|
TICKETING = "TICKETING"
|
|
581
628
|
}
|
|
582
|
-
|
|
583
|
-
/**
|
|
584
|
-
* WixMedia image ID.
|
|
585
|
-
* @minLength 1
|
|
586
|
-
* @maxLength 200
|
|
587
|
-
*/
|
|
588
|
-
id?: string;
|
|
589
|
-
/** Image URL. */
|
|
590
|
-
url?: string;
|
|
591
|
-
/**
|
|
592
|
-
* Original image height.
|
|
593
|
-
*
|
|
594
|
-
* **Note:** You have to define height for the image to appear.
|
|
595
|
-
*/
|
|
596
|
-
height?: number;
|
|
597
|
-
/**
|
|
598
|
-
* Original image width.
|
|
599
|
-
*
|
|
600
|
-
* **Note:** You have to define width for the image to appear.
|
|
601
|
-
*/
|
|
602
|
-
width?: number;
|
|
603
|
-
/** Image alt text. */
|
|
604
|
-
altText?: string | null;
|
|
605
|
-
}
|
|
606
|
-
export interface CalendarUrls {
|
|
629
|
+
interface CalendarUrls {
|
|
607
630
|
/**
|
|
608
631
|
* "Add to Google calendar" URL.
|
|
609
632
|
* @readonly
|
|
@@ -628,7 +651,7 @@ export interface CalendarUrls {
|
|
|
628
651
|
*
|
|
629
652
|
* By default, name and email controls are always required and are pinned to the top of the form.
|
|
630
653
|
*/
|
|
631
|
-
|
|
654
|
+
interface Form {
|
|
632
655
|
/** Nested fields as an ordered list. */
|
|
633
656
|
controls?: InputControl[];
|
|
634
657
|
/**
|
|
@@ -641,7 +664,7 @@ export interface Form {
|
|
|
641
664
|
* A block of nested fields.
|
|
642
665
|
* Used to aggregate similar inputs like First Name and Last Name.
|
|
643
666
|
*/
|
|
644
|
-
|
|
667
|
+
interface InputControl {
|
|
645
668
|
/** Field control type. */
|
|
646
669
|
type?: InputControlType;
|
|
647
670
|
/** Whether the control is mandatory (such as `name` & `email`). When `true`, only the label can be changed. */
|
|
@@ -661,14 +684,14 @@ export interface InputControl {
|
|
|
661
684
|
/** Field controls are sorted by this value in ascending order. */
|
|
662
685
|
orderIndex?: number;
|
|
663
686
|
/** Unique control ID. */
|
|
664
|
-
|
|
687
|
+
_id?: string;
|
|
665
688
|
/**
|
|
666
689
|
* Whether the input control is deleted.
|
|
667
690
|
* @readonly
|
|
668
691
|
*/
|
|
669
692
|
deleted?: boolean | null;
|
|
670
693
|
}
|
|
671
|
-
|
|
694
|
+
declare enum InputControlType {
|
|
672
695
|
/** Single text value field. */
|
|
673
696
|
INPUT = "INPUT",
|
|
674
697
|
/** Single text value field with multiple lines. */
|
|
@@ -691,7 +714,7 @@ export declare enum InputControlType {
|
|
|
691
714
|
DATE = "DATE"
|
|
692
715
|
}
|
|
693
716
|
/** Child inputs. */
|
|
694
|
-
|
|
717
|
+
interface Input {
|
|
695
718
|
/** Field name. */
|
|
696
719
|
name?: string;
|
|
697
720
|
/**
|
|
@@ -733,7 +756,7 @@ export interface Input {
|
|
|
733
756
|
*/
|
|
734
757
|
labels?: Label[];
|
|
735
758
|
}
|
|
736
|
-
|
|
759
|
+
declare enum ValueType {
|
|
737
760
|
TEXT = "TEXT",
|
|
738
761
|
NUMBER = "NUMBER",
|
|
739
762
|
TEXT_ARRAY = "TEXT_ARRAY",
|
|
@@ -744,7 +767,7 @@ export declare enum ValueType {
|
|
|
744
767
|
* Describes initially selected option when an input has multiple choices.
|
|
745
768
|
* Defaults to first (0th) option if not configured.
|
|
746
769
|
*/
|
|
747
|
-
|
|
770
|
+
interface OptionSelection extends OptionSelectionSelectedOptionOneOf {
|
|
748
771
|
/**
|
|
749
772
|
* 0-based index from predefined `controls.inputs.options` which is initial selection.
|
|
750
773
|
* @max 199
|
|
@@ -758,7 +781,7 @@ export interface OptionSelection extends OptionSelectionSelectedOptionOneOf {
|
|
|
758
781
|
placeholderText?: string;
|
|
759
782
|
}
|
|
760
783
|
/** @oneof */
|
|
761
|
-
|
|
784
|
+
interface OptionSelectionSelectedOptionOneOf {
|
|
762
785
|
/**
|
|
763
786
|
* 0-based index from predefined `controls.inputs.options` which is initial selection.
|
|
764
787
|
* @max 199
|
|
@@ -771,7 +794,7 @@ export interface OptionSelectionSelectedOptionOneOf {
|
|
|
771
794
|
*/
|
|
772
795
|
placeholderText?: string;
|
|
773
796
|
}
|
|
774
|
-
|
|
797
|
+
interface Label {
|
|
775
798
|
/** Field name. */
|
|
776
799
|
name?: string;
|
|
777
800
|
/** Field label. */
|
|
@@ -781,7 +804,7 @@ export interface Label {
|
|
|
781
804
|
* Defines form messages shown in UI before, during, and after registration flow.
|
|
782
805
|
* It enables configuration of form titles, response labels, "thank you" messages, and call-to-action texts.
|
|
783
806
|
*/
|
|
784
|
-
|
|
807
|
+
interface FormMessages {
|
|
785
808
|
/** RSVP form ([SDK](https://dev.wix.com/docs/sdk/backend-modules/events/rsvp-v2/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/events/rsvp-v2/introduction)) messages. */
|
|
786
809
|
rsvp?: RsvpFormMessages;
|
|
787
810
|
/** Checkout form messages. */
|
|
@@ -791,7 +814,7 @@ export interface FormMessages {
|
|
|
791
814
|
/** Messages shown when event tickets are unavailable. */
|
|
792
815
|
ticketsUnavailable?: TicketsUnavailableMessages;
|
|
793
816
|
}
|
|
794
|
-
|
|
817
|
+
interface RsvpFormMessages {
|
|
795
818
|
/** Label text indicating RSVP's `status` is `"YES"`. */
|
|
796
819
|
rsvpYesOption?: string;
|
|
797
820
|
/** Label text indicating RSVP's `status` is `"NO"`. */
|
|
@@ -806,7 +829,7 @@ export interface RsvpFormMessages {
|
|
|
806
829
|
submitActionLabel?: string;
|
|
807
830
|
}
|
|
808
831
|
/** Confirmation messages shown after registration. */
|
|
809
|
-
|
|
832
|
+
interface PositiveResponseConfirmation {
|
|
810
833
|
/** Confirmation message title. */
|
|
811
834
|
title?: string;
|
|
812
835
|
/** Confirmation message text. */
|
|
@@ -817,27 +840,27 @@ export interface PositiveResponseConfirmation {
|
|
|
817
840
|
shareActionLabel?: string;
|
|
818
841
|
}
|
|
819
842
|
/** Confirmation messages shown after registration. */
|
|
820
|
-
|
|
843
|
+
interface NegativeResponseConfirmation {
|
|
821
844
|
/** Confirmation message title. */
|
|
822
845
|
title?: string;
|
|
823
846
|
/** "Share event" call-to-action label text. */
|
|
824
847
|
shareActionLabel?: string;
|
|
825
848
|
}
|
|
826
849
|
/** Set of messages shown during registration when RSVP response is positive. */
|
|
827
|
-
|
|
850
|
+
interface Positive {
|
|
828
851
|
/** Main form title for positive response. */
|
|
829
852
|
title?: string;
|
|
830
853
|
/** Confirmation messages shown after registration. */
|
|
831
854
|
confirmation?: PositiveResponseConfirmation;
|
|
832
855
|
}
|
|
833
856
|
/** A set of messages shown during registration with negative response */
|
|
834
|
-
|
|
857
|
+
interface Negative {
|
|
835
858
|
/** Main form title for negative response. */
|
|
836
859
|
title?: string;
|
|
837
860
|
/** Confirmation messages shown after registration. */
|
|
838
861
|
confirmation?: NegativeResponseConfirmation;
|
|
839
862
|
}
|
|
840
|
-
|
|
863
|
+
interface CheckoutFormMessages {
|
|
841
864
|
/** Main form title for response. */
|
|
842
865
|
title?: string;
|
|
843
866
|
/** Submit form call-to-action label text. */
|
|
@@ -846,7 +869,7 @@ export interface CheckoutFormMessages {
|
|
|
846
869
|
confirmation?: ResponseConfirmation;
|
|
847
870
|
}
|
|
848
871
|
/** Confirmation messages shown after checkout. */
|
|
849
|
-
|
|
872
|
+
interface ResponseConfirmation {
|
|
850
873
|
/** Confirmation message title. */
|
|
851
874
|
title?: string;
|
|
852
875
|
/** Confirmation message text. */
|
|
@@ -858,25 +881,25 @@ export interface ResponseConfirmation {
|
|
|
858
881
|
/** "Share event" call-to-action label text. */
|
|
859
882
|
shareEventLabel?: string;
|
|
860
883
|
}
|
|
861
|
-
|
|
884
|
+
interface RegistrationClosedMessages {
|
|
862
885
|
/** Message shown when event registration is closed. */
|
|
863
886
|
message?: string;
|
|
864
887
|
/** "Explore other events" call-to-action label text. */
|
|
865
888
|
exploreEventsActionLabel?: string;
|
|
866
889
|
}
|
|
867
|
-
|
|
890
|
+
interface TicketsUnavailableMessages {
|
|
868
891
|
/** Message shown when event tickets are unavailable. */
|
|
869
892
|
message?: string;
|
|
870
893
|
/** "Explore other events" call-to-action label text. */
|
|
871
894
|
exploreEventsActionLabel?: string;
|
|
872
895
|
}
|
|
873
|
-
|
|
896
|
+
interface Summaries {
|
|
874
897
|
/** RSVP summary of guests. */
|
|
875
898
|
rsvps?: Rsvps;
|
|
876
899
|
/** Summary of revenue and sold tickets. Archived orders are not included. */
|
|
877
900
|
tickets?: Tickets;
|
|
878
901
|
}
|
|
879
|
-
|
|
902
|
+
interface EventsMoney {
|
|
880
903
|
/**
|
|
881
904
|
* *Deprecated:** Use `value` instead.
|
|
882
905
|
* @format DECIMAL_VALUE
|
|
@@ -894,7 +917,7 @@ export interface EventsMoney {
|
|
|
894
917
|
*/
|
|
895
918
|
value?: string | null;
|
|
896
919
|
}
|
|
897
|
-
|
|
920
|
+
interface Rsvps {
|
|
898
921
|
/**
|
|
899
922
|
* Total number of RSVPs.
|
|
900
923
|
* @readonly
|
|
@@ -916,7 +939,7 @@ export interface Rsvps {
|
|
|
916
939
|
*/
|
|
917
940
|
waitlistCount?: number;
|
|
918
941
|
}
|
|
919
|
-
|
|
942
|
+
interface Tickets {
|
|
920
943
|
/**
|
|
921
944
|
* Number of sold tickets.
|
|
922
945
|
* @readonly
|
|
@@ -943,15 +966,15 @@ export interface Tickets {
|
|
|
943
966
|
*/
|
|
944
967
|
totalSales?: EventsMoney;
|
|
945
968
|
}
|
|
946
|
-
|
|
969
|
+
interface GuestListSettings {
|
|
947
970
|
/** Whether the guest list is public for all guests. */
|
|
948
971
|
displayedPublicly?: boolean;
|
|
949
972
|
}
|
|
950
|
-
|
|
973
|
+
interface Feed {
|
|
951
974
|
/** Event discussion feed token. */
|
|
952
975
|
token?: string;
|
|
953
976
|
}
|
|
954
|
-
|
|
977
|
+
interface OnlineConferencing {
|
|
955
978
|
/** 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. */
|
|
956
979
|
enabled?: boolean;
|
|
957
980
|
/**
|
|
@@ -959,12 +982,17 @@ export interface OnlineConferencing {
|
|
|
959
982
|
* @format GUID
|
|
960
983
|
*/
|
|
961
984
|
providerId?: string | null;
|
|
962
|
-
/**
|
|
985
|
+
/**
|
|
986
|
+
* Conference type. Possible values:
|
|
987
|
+
*
|
|
988
|
+
* - `MEETING`: Guests can do some actions during the conference, for example talk, turn on camera and show their screen.
|
|
989
|
+
* - `WEBINAR`: Guests can only watch the conference.
|
|
990
|
+
*/
|
|
963
991
|
type?: ConferenceTypeType;
|
|
964
992
|
/** Online conferencing session information. */
|
|
965
993
|
session?: OnlineConferencingSession;
|
|
966
994
|
}
|
|
967
|
-
|
|
995
|
+
declare enum ConferenceTypeType {
|
|
968
996
|
/** Default value. This value is unused */
|
|
969
997
|
UNKNOWN_CONFERENCE_TYPE = "UNKNOWN_CONFERENCE_TYPE",
|
|
970
998
|
/** Guests can do some actions during the conference, for example talk, turn on their camera and show their screen. */
|
|
@@ -972,7 +1000,7 @@ export declare enum ConferenceTypeType {
|
|
|
972
1000
|
/** Guests can only watch the conference. */
|
|
973
1001
|
WEBINAR = "WEBINAR"
|
|
974
1002
|
}
|
|
975
|
-
|
|
1003
|
+
interface OnlineConferencingSession {
|
|
976
1004
|
/**
|
|
977
1005
|
* Link for the event host to start the online conference session.
|
|
978
1006
|
* @readonly
|
|
@@ -999,7 +1027,7 @@ export interface OnlineConferencingSession {
|
|
|
999
1027
|
*/
|
|
1000
1028
|
sessionId?: string | null;
|
|
1001
1029
|
}
|
|
1002
|
-
|
|
1030
|
+
interface SeoSettings {
|
|
1003
1031
|
/**
|
|
1004
1032
|
* URL slug.
|
|
1005
1033
|
* @maxLength 130
|
|
@@ -1018,13 +1046,13 @@ export interface SeoSettings {
|
|
|
1018
1046
|
* The search engines use this information for ranking purposes, or to display snippets in the search results.
|
|
1019
1047
|
* 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.
|
|
1020
1048
|
*/
|
|
1021
|
-
|
|
1049
|
+
interface SeoSchema {
|
|
1022
1050
|
/** SEO tag information. */
|
|
1023
1051
|
tags?: Tag[];
|
|
1024
1052
|
/** SEO general settings. */
|
|
1025
1053
|
settings?: Settings;
|
|
1026
1054
|
}
|
|
1027
|
-
|
|
1055
|
+
interface Keyword {
|
|
1028
1056
|
/** Keyword value. */
|
|
1029
1057
|
term?: string;
|
|
1030
1058
|
/** Whether the keyword is the main focus keyword. */
|
|
@@ -1035,7 +1063,7 @@ export interface Keyword {
|
|
|
1035
1063
|
*/
|
|
1036
1064
|
origin?: string | null;
|
|
1037
1065
|
}
|
|
1038
|
-
|
|
1066
|
+
interface Tag {
|
|
1039
1067
|
/**
|
|
1040
1068
|
* SEO tag type.
|
|
1041
1069
|
*
|
|
@@ -1057,7 +1085,7 @@ export interface Tag {
|
|
|
1057
1085
|
/** Whether the tag is disabled. */
|
|
1058
1086
|
disabled?: boolean;
|
|
1059
1087
|
}
|
|
1060
|
-
|
|
1088
|
+
interface Settings {
|
|
1061
1089
|
/**
|
|
1062
1090
|
* Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.
|
|
1063
1091
|
*
|
|
@@ -1071,29 +1099,29 @@ export interface Settings {
|
|
|
1071
1099
|
*/
|
|
1072
1100
|
keywords?: Keyword[];
|
|
1073
1101
|
}
|
|
1074
|
-
|
|
1102
|
+
interface AgendaSettings {
|
|
1075
1103
|
/** Whether the schedule is enabled for the event. */
|
|
1076
1104
|
enabled?: boolean;
|
|
1077
1105
|
/**
|
|
1078
1106
|
* Schedule page URL.
|
|
1079
1107
|
* @readonly
|
|
1080
1108
|
*/
|
|
1081
|
-
pageUrl?:
|
|
1109
|
+
pageUrl?: string;
|
|
1082
1110
|
}
|
|
1083
|
-
|
|
1111
|
+
interface EventCategories {
|
|
1084
1112
|
/**
|
|
1085
1113
|
* Event categories.
|
|
1086
1114
|
* @maxSize 10
|
|
1087
1115
|
*/
|
|
1088
1116
|
categories?: EventCategory[];
|
|
1089
1117
|
}
|
|
1090
|
-
|
|
1118
|
+
interface EventCategory {
|
|
1091
1119
|
/**
|
|
1092
1120
|
* Category ID.
|
|
1093
1121
|
* @format GUID
|
|
1094
1122
|
* @readonly
|
|
1095
1123
|
*/
|
|
1096
|
-
|
|
1124
|
+
_id?: string;
|
|
1097
1125
|
/**
|
|
1098
1126
|
* Category name.
|
|
1099
1127
|
* @minLength 1
|
|
@@ -1104,7 +1132,7 @@ export interface EventCategory {
|
|
|
1104
1132
|
* Category creation timestamp.
|
|
1105
1133
|
* @readonly
|
|
1106
1134
|
*/
|
|
1107
|
-
|
|
1135
|
+
_createdDate?: Date | null;
|
|
1108
1136
|
/**
|
|
1109
1137
|
* Category is hidden.
|
|
1110
1138
|
* @readonly
|
|
@@ -1116,21 +1144,21 @@ export interface EventCategory {
|
|
|
1116
1144
|
*/
|
|
1117
1145
|
type?: CategoryTypeType;
|
|
1118
1146
|
}
|
|
1119
|
-
|
|
1147
|
+
declare enum CategoryTypeType {
|
|
1120
1148
|
/** Created manually by the user. */
|
|
1121
1149
|
MANUAL = "MANUAL",
|
|
1122
1150
|
/** Created automatically when publishing recurring events. */
|
|
1123
1151
|
RECURRING_EVENT = "RECURRING_EVENT"
|
|
1124
1152
|
}
|
|
1125
|
-
|
|
1153
|
+
interface V3EventDisplaySettings {
|
|
1126
1154
|
/** Whether event details button is hidden. Only available for events with no registration. */
|
|
1127
1155
|
hideEventDetailsButton?: boolean | null;
|
|
1128
1156
|
/** Disables event details page visibility. If event has an external registration configured visitors will be redirected from this page. */
|
|
1129
1157
|
hideEventDetailsPage?: boolean | null;
|
|
1130
1158
|
}
|
|
1131
|
-
|
|
1159
|
+
interface LabellingSettings {
|
|
1132
1160
|
}
|
|
1133
|
-
|
|
1161
|
+
interface RichContent {
|
|
1134
1162
|
/** Node objects representing a rich content document. */
|
|
1135
1163
|
nodes?: Node[];
|
|
1136
1164
|
/** Object metadata. */
|
|
@@ -1138,7 +1166,7 @@ export interface RichContent {
|
|
|
1138
1166
|
/** Global styling for header, paragraph, block quote, and code block nodes in the object. */
|
|
1139
1167
|
documentStyle?: DocumentStyle;
|
|
1140
1168
|
}
|
|
1141
|
-
|
|
1169
|
+
interface Node extends NodeDataOneOf {
|
|
1142
1170
|
/** Data for a button node. */
|
|
1143
1171
|
buttonData?: ButtonData;
|
|
1144
1172
|
/** Data for a code block node. */
|
|
@@ -1196,14 +1224,14 @@ export interface Node extends NodeDataOneOf {
|
|
|
1196
1224
|
/** Node type. Use `APP_EMBED` for nodes that embed content from other Wix apps. Use `EMBED` to embed content in [oEmbed](https://oembed.com/) format. */
|
|
1197
1225
|
type?: NodeType;
|
|
1198
1226
|
/** Node ID. */
|
|
1199
|
-
|
|
1227
|
+
_id?: string;
|
|
1200
1228
|
/** A list of child nodes. */
|
|
1201
1229
|
nodes?: Node[];
|
|
1202
1230
|
/** Padding and background color styling for the node. */
|
|
1203
1231
|
style?: NodeStyle;
|
|
1204
1232
|
}
|
|
1205
1233
|
/** @oneof */
|
|
1206
|
-
|
|
1234
|
+
interface NodeDataOneOf {
|
|
1207
1235
|
/** Data for a button node. */
|
|
1208
1236
|
buttonData?: ButtonData;
|
|
1209
1237
|
/** Data for a code block node. */
|
|
@@ -1259,7 +1287,7 @@ export interface NodeDataOneOf {
|
|
|
1259
1287
|
/** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
|
|
1260
1288
|
layoutCellData?: LayoutCellData;
|
|
1261
1289
|
}
|
|
1262
|
-
|
|
1290
|
+
declare enum NodeType {
|
|
1263
1291
|
PARAGRAPH = "PARAGRAPH",
|
|
1264
1292
|
TEXT = "TEXT",
|
|
1265
1293
|
HEADING = "HEADING",
|
|
@@ -1295,7 +1323,7 @@ export declare enum NodeType {
|
|
|
1295
1323
|
LAYOUT = "LAYOUT",
|
|
1296
1324
|
LAYOUT_CELL = "LAYOUT_CELL"
|
|
1297
1325
|
}
|
|
1298
|
-
|
|
1326
|
+
interface NodeStyle {
|
|
1299
1327
|
/** The top padding value in pixels. */
|
|
1300
1328
|
paddingTop?: string | null;
|
|
1301
1329
|
/** The bottom padding value in pixels. */
|
|
@@ -1303,7 +1331,7 @@ export interface NodeStyle {
|
|
|
1303
1331
|
/** The background color as a hexadecimal value. */
|
|
1304
1332
|
backgroundColor?: string | null;
|
|
1305
1333
|
}
|
|
1306
|
-
|
|
1334
|
+
interface ButtonData {
|
|
1307
1335
|
/** Styling for the button's container. */
|
|
1308
1336
|
containerData?: PluginContainerData;
|
|
1309
1337
|
/** The button type. */
|
|
@@ -1315,7 +1343,7 @@ export interface ButtonData {
|
|
|
1315
1343
|
/** Button link details. */
|
|
1316
1344
|
link?: Link;
|
|
1317
1345
|
}
|
|
1318
|
-
|
|
1346
|
+
interface Border {
|
|
1319
1347
|
/**
|
|
1320
1348
|
* Deprecated: Use `borderWidth` in `styles` instead.
|
|
1321
1349
|
* @deprecated
|
|
@@ -1327,7 +1355,7 @@ export interface Border {
|
|
|
1327
1355
|
*/
|
|
1328
1356
|
radius?: number | null;
|
|
1329
1357
|
}
|
|
1330
|
-
|
|
1358
|
+
interface Colors {
|
|
1331
1359
|
/**
|
|
1332
1360
|
* Deprecated: Use `textColor` in `styles` instead.
|
|
1333
1361
|
* @deprecated
|
|
@@ -1344,7 +1372,7 @@ export interface Colors {
|
|
|
1344
1372
|
*/
|
|
1345
1373
|
background?: string | null;
|
|
1346
1374
|
}
|
|
1347
|
-
|
|
1375
|
+
interface PluginContainerData {
|
|
1348
1376
|
/** The width of the node when it's displayed. */
|
|
1349
1377
|
width?: PluginContainerDataWidth;
|
|
1350
1378
|
/** The node's alignment within its container. */
|
|
@@ -1356,7 +1384,7 @@ export interface PluginContainerData {
|
|
|
1356
1384
|
/** Sets whether text should wrap around this node when it's displayed. If `textWrap` is `false`, the node takes up the width of its container. Defaults to `true` for all node types except 'DIVIVDER' where it defaults to `false`. */
|
|
1357
1385
|
textWrap?: boolean | null;
|
|
1358
1386
|
}
|
|
1359
|
-
|
|
1387
|
+
declare enum WidthType {
|
|
1360
1388
|
/** Width matches the content width */
|
|
1361
1389
|
CONTENT = "CONTENT",
|
|
1362
1390
|
/** Small Width */
|
|
@@ -1366,7 +1394,7 @@ export declare enum WidthType {
|
|
|
1366
1394
|
/** coast-to-coast display */
|
|
1367
1395
|
FULL_WIDTH = "FULL_WIDTH"
|
|
1368
1396
|
}
|
|
1369
|
-
|
|
1397
|
+
interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
1370
1398
|
/**
|
|
1371
1399
|
* One of the following predefined width options:
|
|
1372
1400
|
* `CONTENT`: The width of the container matches the content width.
|
|
@@ -1379,7 +1407,7 @@ export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOn
|
|
|
1379
1407
|
custom?: string | null;
|
|
1380
1408
|
}
|
|
1381
1409
|
/** @oneof */
|
|
1382
|
-
|
|
1410
|
+
interface PluginContainerDataWidthDataOneOf {
|
|
1383
1411
|
/**
|
|
1384
1412
|
* One of the following predefined width options:
|
|
1385
1413
|
* `CONTENT`: The width of the container matches the content width.
|
|
@@ -1391,7 +1419,7 @@ export interface PluginContainerDataWidthDataOneOf {
|
|
|
1391
1419
|
/** A custom width value in pixels. */
|
|
1392
1420
|
custom?: string | null;
|
|
1393
1421
|
}
|
|
1394
|
-
|
|
1422
|
+
declare enum PluginContainerDataAlignment {
|
|
1395
1423
|
/** Center Alignment */
|
|
1396
1424
|
CENTER = "CENTER",
|
|
1397
1425
|
/** Left Alignment */
|
|
@@ -1399,7 +1427,7 @@ export declare enum PluginContainerDataAlignment {
|
|
|
1399
1427
|
/** Right Alignment */
|
|
1400
1428
|
RIGHT = "RIGHT"
|
|
1401
1429
|
}
|
|
1402
|
-
|
|
1430
|
+
interface Spoiler {
|
|
1403
1431
|
/** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
|
|
1404
1432
|
enabled?: boolean | null;
|
|
1405
1433
|
/** The description displayed on top of the spoiler cover. */
|
|
@@ -1407,17 +1435,17 @@ export interface Spoiler {
|
|
|
1407
1435
|
/** The text for the button used to remove the spoiler cover. */
|
|
1408
1436
|
buttonText?: string | null;
|
|
1409
1437
|
}
|
|
1410
|
-
|
|
1438
|
+
interface Height {
|
|
1411
1439
|
/** A custom height value in pixels. */
|
|
1412
1440
|
custom?: string | null;
|
|
1413
1441
|
}
|
|
1414
|
-
|
|
1442
|
+
declare enum ButtonDataType {
|
|
1415
1443
|
/** Regular link button */
|
|
1416
1444
|
LINK = "LINK",
|
|
1417
1445
|
/** Triggers custom action that is defined in plugin configuration by the consumer */
|
|
1418
1446
|
ACTION = "ACTION"
|
|
1419
1447
|
}
|
|
1420
|
-
|
|
1448
|
+
interface Styles {
|
|
1421
1449
|
/**
|
|
1422
1450
|
* Deprecated: Use `borderWidth` and `borderRadius` instead.
|
|
1423
1451
|
* @deprecated
|
|
@@ -1470,7 +1498,7 @@ export interface Styles {
|
|
|
1470
1498
|
/** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
|
|
1471
1499
|
buttonSize?: string | null;
|
|
1472
1500
|
}
|
|
1473
|
-
|
|
1501
|
+
interface Link extends LinkDataOneOf {
|
|
1474
1502
|
/** The absolute URL for the linked document. */
|
|
1475
1503
|
url?: string;
|
|
1476
1504
|
/** The target node's ID. Used for linking to another node in this object. */
|
|
@@ -1489,13 +1517,13 @@ export interface Link extends LinkDataOneOf {
|
|
|
1489
1517
|
customData?: string | null;
|
|
1490
1518
|
}
|
|
1491
1519
|
/** @oneof */
|
|
1492
|
-
|
|
1520
|
+
interface LinkDataOneOf {
|
|
1493
1521
|
/** The absolute URL for the linked document. */
|
|
1494
1522
|
url?: string;
|
|
1495
1523
|
/** The target node's ID. Used for linking to another node in this object. */
|
|
1496
1524
|
anchor?: string;
|
|
1497
1525
|
}
|
|
1498
|
-
|
|
1526
|
+
declare enum Target {
|
|
1499
1527
|
/** Opens the linked document in the same frame as it was clicked (this is default) */
|
|
1500
1528
|
SELF = "SELF",
|
|
1501
1529
|
/** Opens the linked document in a new window or tab */
|
|
@@ -1505,7 +1533,7 @@ export declare enum Target {
|
|
|
1505
1533
|
/** Opens the linked document in the full body of the window */
|
|
1506
1534
|
TOP = "TOP"
|
|
1507
1535
|
}
|
|
1508
|
-
|
|
1536
|
+
interface Rel {
|
|
1509
1537
|
/** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
|
|
1510
1538
|
nofollow?: boolean | null;
|
|
1511
1539
|
/** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
|
|
@@ -1515,17 +1543,17 @@ export interface Rel {
|
|
|
1515
1543
|
/** Indicates that this link protect referral information from being passed to the target website. */
|
|
1516
1544
|
noreferrer?: boolean | null;
|
|
1517
1545
|
}
|
|
1518
|
-
|
|
1546
|
+
interface CodeBlockData {
|
|
1519
1547
|
/** Styling for the code block's text. */
|
|
1520
1548
|
textStyle?: TextStyle;
|
|
1521
1549
|
}
|
|
1522
|
-
|
|
1550
|
+
interface TextStyle {
|
|
1523
1551
|
/** Text alignment. Defaults to `AUTO`. */
|
|
1524
1552
|
textAlignment?: TextAlignment;
|
|
1525
1553
|
/** A CSS `line-height` value for the text expressed as a ratio relative to the font size. For example, if the font size is 20px, a `lineHeight` value of `'1.5'`` results in a line height of 30px. */
|
|
1526
1554
|
lineHeight?: string | null;
|
|
1527
1555
|
}
|
|
1528
|
-
|
|
1556
|
+
declare enum TextAlignment {
|
|
1529
1557
|
/** browser default, eqivalent to `initial` */
|
|
1530
1558
|
AUTO = "AUTO",
|
|
1531
1559
|
/** Left align */
|
|
@@ -1537,7 +1565,7 @@ export declare enum TextAlignment {
|
|
|
1537
1565
|
/** Text is spaced to line up its left and right edges to the left and right edges of the line box, except for the last line */
|
|
1538
1566
|
JUSTIFY = "JUSTIFY"
|
|
1539
1567
|
}
|
|
1540
|
-
|
|
1568
|
+
interface DividerData {
|
|
1541
1569
|
/** Styling for the divider's container. */
|
|
1542
1570
|
containerData?: PluginContainerData;
|
|
1543
1571
|
/** Divider line style. */
|
|
@@ -1547,7 +1575,7 @@ export interface DividerData {
|
|
|
1547
1575
|
/** Divider alignment. */
|
|
1548
1576
|
alignment?: Alignment;
|
|
1549
1577
|
}
|
|
1550
|
-
|
|
1578
|
+
declare enum LineStyle {
|
|
1551
1579
|
/** Single Line */
|
|
1552
1580
|
SINGLE = "SINGLE",
|
|
1553
1581
|
/** Double Line */
|
|
@@ -1557,7 +1585,7 @@ export declare enum LineStyle {
|
|
|
1557
1585
|
/** Dotted Line */
|
|
1558
1586
|
DOTTED = "DOTTED"
|
|
1559
1587
|
}
|
|
1560
|
-
|
|
1588
|
+
declare enum Width {
|
|
1561
1589
|
/** Large line */
|
|
1562
1590
|
LARGE = "LARGE",
|
|
1563
1591
|
/** Medium line */
|
|
@@ -1565,7 +1593,7 @@ export declare enum Width {
|
|
|
1565
1593
|
/** Small line */
|
|
1566
1594
|
SMALL = "SMALL"
|
|
1567
1595
|
}
|
|
1568
|
-
|
|
1596
|
+
declare enum Alignment {
|
|
1569
1597
|
/** Center alignment */
|
|
1570
1598
|
CENTER = "CENTER",
|
|
1571
1599
|
/** Left alignment */
|
|
@@ -1573,7 +1601,7 @@ export declare enum Alignment {
|
|
|
1573
1601
|
/** Right alignment */
|
|
1574
1602
|
RIGHT = "RIGHT"
|
|
1575
1603
|
}
|
|
1576
|
-
|
|
1604
|
+
interface FileData {
|
|
1577
1605
|
/** Styling for the file's container. */
|
|
1578
1606
|
containerData?: PluginContainerData;
|
|
1579
1607
|
/** The source for the file's data. */
|
|
@@ -1596,7 +1624,7 @@ export interface FileData {
|
|
|
1596
1624
|
/** File size in KB. */
|
|
1597
1625
|
sizeInKb?: string | null;
|
|
1598
1626
|
}
|
|
1599
|
-
|
|
1627
|
+
declare enum ViewMode {
|
|
1600
1628
|
/** No PDF view */
|
|
1601
1629
|
NONE = "NONE",
|
|
1602
1630
|
/** Full PDF view */
|
|
@@ -1604,7 +1632,7 @@ export declare enum ViewMode {
|
|
|
1604
1632
|
/** Mini PDF view */
|
|
1605
1633
|
MINI = "MINI"
|
|
1606
1634
|
}
|
|
1607
|
-
|
|
1635
|
+
interface FileSource extends FileSourceDataOneOf {
|
|
1608
1636
|
/** The absolute URL for the file's source. */
|
|
1609
1637
|
url?: string | null;
|
|
1610
1638
|
/**
|
|
@@ -1613,12 +1641,12 @@ export interface FileSource extends FileSourceDataOneOf {
|
|
|
1613
1641
|
*/
|
|
1614
1642
|
custom?: string | null;
|
|
1615
1643
|
/** An ID that's resolved to a URL by a resolver function. */
|
|
1616
|
-
|
|
1644
|
+
_id?: string | null;
|
|
1617
1645
|
/** Indicates whether the file's source is private. Defaults to `false`. */
|
|
1618
1646
|
private?: boolean | null;
|
|
1619
1647
|
}
|
|
1620
1648
|
/** @oneof */
|
|
1621
|
-
|
|
1649
|
+
interface FileSourceDataOneOf {
|
|
1622
1650
|
/** The absolute URL for the file's source. */
|
|
1623
1651
|
url?: string | null;
|
|
1624
1652
|
/**
|
|
@@ -1627,9 +1655,9 @@ export interface FileSourceDataOneOf {
|
|
|
1627
1655
|
*/
|
|
1628
1656
|
custom?: string | null;
|
|
1629
1657
|
/** An ID that's resolved to a URL by a resolver function. */
|
|
1630
|
-
|
|
1658
|
+
_id?: string | null;
|
|
1631
1659
|
}
|
|
1632
|
-
|
|
1660
|
+
interface PDFSettings {
|
|
1633
1661
|
/**
|
|
1634
1662
|
* PDF view mode. One of the following:
|
|
1635
1663
|
* `NONE` : The PDF isn't displayed.
|
|
@@ -1642,7 +1670,7 @@ export interface PDFSettings {
|
|
|
1642
1670
|
/** Sets whether the PDF print button is disabled. Defaults to `false`. */
|
|
1643
1671
|
disablePrint?: boolean | null;
|
|
1644
1672
|
}
|
|
1645
|
-
|
|
1673
|
+
interface GalleryData {
|
|
1646
1674
|
/** Styling for the gallery's container. */
|
|
1647
1675
|
containerData?: PluginContainerData;
|
|
1648
1676
|
/** The items in the gallery. */
|
|
@@ -1654,7 +1682,7 @@ export interface GalleryData {
|
|
|
1654
1682
|
/** Sets whether the gallery's download button is disabled. Defaults to `false`. */
|
|
1655
1683
|
disableDownload?: boolean | null;
|
|
1656
1684
|
}
|
|
1657
|
-
|
|
1685
|
+
interface Media {
|
|
1658
1686
|
/** The source for the media's data. */
|
|
1659
1687
|
src?: FileSource;
|
|
1660
1688
|
/** Media width in pixels. */
|
|
@@ -1664,21 +1692,21 @@ export interface Media {
|
|
|
1664
1692
|
/** Media duration in seconds. Only relevant for audio and video files. */
|
|
1665
1693
|
duration?: number | null;
|
|
1666
1694
|
}
|
|
1667
|
-
|
|
1695
|
+
interface Image {
|
|
1668
1696
|
/** Image file details. */
|
|
1669
1697
|
media?: Media;
|
|
1670
1698
|
/** Link details for images that are links. */
|
|
1671
1699
|
link?: Link;
|
|
1672
1700
|
}
|
|
1673
|
-
|
|
1701
|
+
interface Video {
|
|
1674
1702
|
/** Video file details. */
|
|
1675
1703
|
media?: Media;
|
|
1676
1704
|
/** Video thumbnail file details. */
|
|
1677
1705
|
thumbnail?: Media;
|
|
1678
1706
|
}
|
|
1679
|
-
|
|
1707
|
+
interface Item extends ItemDataOneOf {
|
|
1680
1708
|
/** An image item. */
|
|
1681
|
-
image?:
|
|
1709
|
+
image?: Image;
|
|
1682
1710
|
/** A video item. */
|
|
1683
1711
|
video?: Video;
|
|
1684
1712
|
/** Item title. */
|
|
@@ -1687,13 +1715,13 @@ export interface Item extends ItemDataOneOf {
|
|
|
1687
1715
|
altText?: string | null;
|
|
1688
1716
|
}
|
|
1689
1717
|
/** @oneof */
|
|
1690
|
-
|
|
1718
|
+
interface ItemDataOneOf {
|
|
1691
1719
|
/** An image item. */
|
|
1692
|
-
image?:
|
|
1720
|
+
image?: Image;
|
|
1693
1721
|
/** A video item. */
|
|
1694
1722
|
video?: Video;
|
|
1695
1723
|
}
|
|
1696
|
-
|
|
1724
|
+
interface GalleryOptions {
|
|
1697
1725
|
/** Gallery layout. */
|
|
1698
1726
|
layout?: Layout;
|
|
1699
1727
|
/** Styling for gallery items. */
|
|
@@ -1701,7 +1729,7 @@ export interface GalleryOptions {
|
|
|
1701
1729
|
/** Styling for gallery thumbnail images. */
|
|
1702
1730
|
thumbnails?: Thumbnails;
|
|
1703
1731
|
}
|
|
1704
|
-
|
|
1732
|
+
declare enum LayoutType {
|
|
1705
1733
|
/** Collage type */
|
|
1706
1734
|
COLLAGE = "COLLAGE",
|
|
1707
1735
|
/** Masonry type */
|
|
@@ -1723,19 +1751,19 @@ export declare enum LayoutType {
|
|
|
1723
1751
|
/** Fullsize images type */
|
|
1724
1752
|
FULLSIZE = "FULLSIZE"
|
|
1725
1753
|
}
|
|
1726
|
-
|
|
1754
|
+
declare enum Orientation {
|
|
1727
1755
|
/** Rows Orientation */
|
|
1728
1756
|
ROWS = "ROWS",
|
|
1729
1757
|
/** Columns Orientation */
|
|
1730
1758
|
COLUMNS = "COLUMNS"
|
|
1731
1759
|
}
|
|
1732
|
-
|
|
1760
|
+
declare enum Crop {
|
|
1733
1761
|
/** Crop to fill */
|
|
1734
1762
|
FILL = "FILL",
|
|
1735
1763
|
/** Crop to fit */
|
|
1736
1764
|
FIT = "FIT"
|
|
1737
1765
|
}
|
|
1738
|
-
|
|
1766
|
+
declare enum ThumbnailsAlignment {
|
|
1739
1767
|
/** Top alignment */
|
|
1740
1768
|
TOP = "TOP",
|
|
1741
1769
|
/** Right alignment */
|
|
@@ -1747,7 +1775,7 @@ export declare enum ThumbnailsAlignment {
|
|
|
1747
1775
|
/** No thumbnail */
|
|
1748
1776
|
NONE = "NONE"
|
|
1749
1777
|
}
|
|
1750
|
-
|
|
1778
|
+
interface Layout {
|
|
1751
1779
|
/** Gallery layout type. */
|
|
1752
1780
|
type?: LayoutType;
|
|
1753
1781
|
/** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
|
|
@@ -1759,7 +1787,7 @@ export interface Layout {
|
|
|
1759
1787
|
/** The number of columns to display on mobile screens. */
|
|
1760
1788
|
mobileNumberOfColumns?: number | null;
|
|
1761
1789
|
}
|
|
1762
|
-
|
|
1790
|
+
interface ItemStyle {
|
|
1763
1791
|
/** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
|
|
1764
1792
|
targetSize?: number | null;
|
|
1765
1793
|
/** Item ratio */
|
|
@@ -1769,13 +1797,13 @@ export interface ItemStyle {
|
|
|
1769
1797
|
/** The spacing between items in pixels. */
|
|
1770
1798
|
spacing?: number | null;
|
|
1771
1799
|
}
|
|
1772
|
-
|
|
1800
|
+
interface Thumbnails {
|
|
1773
1801
|
/** Thumbnail alignment. */
|
|
1774
1802
|
placement?: ThumbnailsAlignment;
|
|
1775
1803
|
/** Spacing between thumbnails in pixels. */
|
|
1776
1804
|
spacing?: number | null;
|
|
1777
1805
|
}
|
|
1778
|
-
|
|
1806
|
+
interface GIFData {
|
|
1779
1807
|
/** Styling for the GIF's container. */
|
|
1780
1808
|
containerData?: PluginContainerData;
|
|
1781
1809
|
/** The source of the full size GIF. */
|
|
@@ -1789,7 +1817,7 @@ export interface GIFData {
|
|
|
1789
1817
|
/** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
|
|
1790
1818
|
gifType?: GIFType;
|
|
1791
1819
|
}
|
|
1792
|
-
|
|
1820
|
+
interface GIF {
|
|
1793
1821
|
/**
|
|
1794
1822
|
* GIF format URL.
|
|
1795
1823
|
* @format WEB_URL
|
|
@@ -1806,11 +1834,11 @@ export interface GIF {
|
|
|
1806
1834
|
*/
|
|
1807
1835
|
still?: string | null;
|
|
1808
1836
|
}
|
|
1809
|
-
|
|
1837
|
+
declare enum GIFType {
|
|
1810
1838
|
NORMAL = "NORMAL",
|
|
1811
1839
|
STICKER = "STICKER"
|
|
1812
1840
|
}
|
|
1813
|
-
|
|
1841
|
+
interface HeadingData {
|
|
1814
1842
|
/** Heading level from 1-6. */
|
|
1815
1843
|
level?: number;
|
|
1816
1844
|
/** Styling for the heading text. */
|
|
@@ -1818,7 +1846,7 @@ export interface HeadingData {
|
|
|
1818
1846
|
/** Indentation level from 1-4. */
|
|
1819
1847
|
indentation?: number | null;
|
|
1820
1848
|
}
|
|
1821
|
-
|
|
1849
|
+
interface HTMLData extends HTMLDataDataOneOf {
|
|
1822
1850
|
/** The URL for the HTML code for the node. */
|
|
1823
1851
|
url?: string;
|
|
1824
1852
|
/** The HTML code for the node. */
|
|
@@ -1836,7 +1864,7 @@ export interface HTMLData extends HTMLDataDataOneOf {
|
|
|
1836
1864
|
autoHeight?: boolean | null;
|
|
1837
1865
|
}
|
|
1838
1866
|
/** @oneof */
|
|
1839
|
-
|
|
1867
|
+
interface HTMLDataDataOneOf {
|
|
1840
1868
|
/** The URL for the HTML code for the node. */
|
|
1841
1869
|
url?: string;
|
|
1842
1870
|
/** The HTML code for the node. */
|
|
@@ -1847,11 +1875,11 @@ export interface HTMLDataDataOneOf {
|
|
|
1847
1875
|
*/
|
|
1848
1876
|
isAdsense?: boolean | null;
|
|
1849
1877
|
}
|
|
1850
|
-
|
|
1878
|
+
declare enum Source {
|
|
1851
1879
|
HTML = "HTML",
|
|
1852
1880
|
ADSENSE = "ADSENSE"
|
|
1853
1881
|
}
|
|
1854
|
-
|
|
1882
|
+
interface ImageData {
|
|
1855
1883
|
/** Styling for the image's container. */
|
|
1856
1884
|
containerData?: PluginContainerData;
|
|
1857
1885
|
/** Image file details. */
|
|
@@ -1874,7 +1902,7 @@ export interface ImageData {
|
|
|
1874
1902
|
/** Styling for the image. */
|
|
1875
1903
|
styles?: ImageDataStyles;
|
|
1876
1904
|
}
|
|
1877
|
-
|
|
1905
|
+
interface StylesBorder {
|
|
1878
1906
|
/** Border width in pixels. */
|
|
1879
1907
|
width?: number | null;
|
|
1880
1908
|
/**
|
|
@@ -1885,11 +1913,11 @@ export interface StylesBorder {
|
|
|
1885
1913
|
/** Border radius in pixels. */
|
|
1886
1914
|
radius?: number | null;
|
|
1887
1915
|
}
|
|
1888
|
-
|
|
1916
|
+
interface ImageDataStyles {
|
|
1889
1917
|
/** Border attributes. */
|
|
1890
1918
|
border?: StylesBorder;
|
|
1891
1919
|
}
|
|
1892
|
-
|
|
1920
|
+
interface LinkPreviewData {
|
|
1893
1921
|
/** Styling for the link preview's container. */
|
|
1894
1922
|
containerData?: PluginContainerData;
|
|
1895
1923
|
/** Link details. */
|
|
@@ -1905,7 +1933,7 @@ export interface LinkPreviewData {
|
|
|
1905
1933
|
/** Styling for the link preview. */
|
|
1906
1934
|
styles?: LinkPreviewDataStyles;
|
|
1907
1935
|
}
|
|
1908
|
-
|
|
1936
|
+
declare enum Position {
|
|
1909
1937
|
/** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
|
|
1910
1938
|
START = "START",
|
|
1911
1939
|
/** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
|
|
@@ -1915,7 +1943,7 @@ export declare enum Position {
|
|
|
1915
1943
|
/** Thumbnail hidden and not displayed */
|
|
1916
1944
|
HIDDEN = "HIDDEN"
|
|
1917
1945
|
}
|
|
1918
|
-
|
|
1946
|
+
interface LinkPreviewDataStyles {
|
|
1919
1947
|
/**
|
|
1920
1948
|
* Background color as a hexadecimal value.
|
|
1921
1949
|
* @format COLOR_HEX
|
|
@@ -1948,13 +1976,13 @@ export interface LinkPreviewDataStyles {
|
|
|
1948
1976
|
/** Position of thumbnail. Defaults to `START`. */
|
|
1949
1977
|
thumbnailPosition?: Position;
|
|
1950
1978
|
}
|
|
1951
|
-
|
|
1979
|
+
interface MapData {
|
|
1952
1980
|
/** Styling for the map's container. */
|
|
1953
1981
|
containerData?: PluginContainerData;
|
|
1954
1982
|
/** Map settings. */
|
|
1955
1983
|
mapSettings?: MapSettings;
|
|
1956
1984
|
}
|
|
1957
|
-
|
|
1985
|
+
interface MapSettings {
|
|
1958
1986
|
/** The address to display on the map. */
|
|
1959
1987
|
address?: string | null;
|
|
1960
1988
|
/** Sets whether the map is draggable. */
|
|
@@ -1978,7 +2006,7 @@ export interface MapSettings {
|
|
|
1978
2006
|
/** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
|
|
1979
2007
|
mapType?: MapType;
|
|
1980
2008
|
}
|
|
1981
|
-
|
|
2009
|
+
declare enum MapType {
|
|
1982
2010
|
/** Roadmap map type */
|
|
1983
2011
|
ROADMAP = "ROADMAP",
|
|
1984
2012
|
/** Satellite map type */
|
|
@@ -1988,7 +2016,7 @@ export declare enum MapType {
|
|
|
1988
2016
|
/** Terrain map type */
|
|
1989
2017
|
TERRAIN = "TERRAIN"
|
|
1990
2018
|
}
|
|
1991
|
-
|
|
2019
|
+
interface ParagraphData {
|
|
1992
2020
|
/** Styling for the paragraph text. */
|
|
1993
2021
|
textStyle?: TextStyle;
|
|
1994
2022
|
/** Indentation level from 1-4. */
|
|
@@ -1996,7 +2024,7 @@ export interface ParagraphData {
|
|
|
1996
2024
|
/** Paragraph level */
|
|
1997
2025
|
level?: number | null;
|
|
1998
2026
|
}
|
|
1999
|
-
|
|
2027
|
+
interface PollData {
|
|
2000
2028
|
/** Styling for the poll's container. */
|
|
2001
2029
|
containerData?: PluginContainerData;
|
|
2002
2030
|
/** Poll data. */
|
|
@@ -2006,7 +2034,7 @@ export interface PollData {
|
|
|
2006
2034
|
/** Styling for the poll and voting options. */
|
|
2007
2035
|
design?: Design;
|
|
2008
2036
|
}
|
|
2009
|
-
|
|
2037
|
+
declare enum ViewRole {
|
|
2010
2038
|
/** Only Poll creator can view the results */
|
|
2011
2039
|
CREATOR = "CREATOR",
|
|
2012
2040
|
/** Anyone who voted can see the results */
|
|
@@ -2014,13 +2042,13 @@ export declare enum ViewRole {
|
|
|
2014
2042
|
/** Anyone can see the results, even if one didn't vote */
|
|
2015
2043
|
EVERYONE = "EVERYONE"
|
|
2016
2044
|
}
|
|
2017
|
-
|
|
2045
|
+
declare enum VoteRole {
|
|
2018
2046
|
/** Logged in member */
|
|
2019
2047
|
SITE_MEMBERS = "SITE_MEMBERS",
|
|
2020
2048
|
/** Anyone */
|
|
2021
2049
|
ALL = "ALL"
|
|
2022
2050
|
}
|
|
2023
|
-
|
|
2051
|
+
interface Permissions {
|
|
2024
2052
|
/** Sets who can view the poll results. */
|
|
2025
2053
|
view?: ViewRole;
|
|
2026
2054
|
/** Sets who can vote. */
|
|
@@ -2028,15 +2056,15 @@ export interface Permissions {
|
|
|
2028
2056
|
/** Sets whether one voter can vote multiple times. Defaults to `false`. */
|
|
2029
2057
|
allowMultipleVotes?: boolean | null;
|
|
2030
2058
|
}
|
|
2031
|
-
|
|
2059
|
+
interface Option {
|
|
2032
2060
|
/** Option ID. */
|
|
2033
|
-
|
|
2061
|
+
_id?: string | null;
|
|
2034
2062
|
/** Option title. */
|
|
2035
2063
|
title?: string | null;
|
|
2036
2064
|
/** The image displayed with the option. */
|
|
2037
2065
|
image?: Media;
|
|
2038
2066
|
}
|
|
2039
|
-
|
|
2067
|
+
interface PollSettings {
|
|
2040
2068
|
/** Permissions settings for voting. */
|
|
2041
2069
|
permissions?: Permissions;
|
|
2042
2070
|
/** Sets whether voters are displayed in the vote results. Defaults to `true`. */
|
|
@@ -2044,19 +2072,19 @@ export interface PollSettings {
|
|
|
2044
2072
|
/** Sets whether the vote count is displayed. Defaults to `true`. */
|
|
2045
2073
|
showVotesCount?: boolean | null;
|
|
2046
2074
|
}
|
|
2047
|
-
|
|
2075
|
+
declare enum PollLayoutType {
|
|
2048
2076
|
/** List */
|
|
2049
2077
|
LIST = "LIST",
|
|
2050
2078
|
/** Grid */
|
|
2051
2079
|
GRID = "GRID"
|
|
2052
2080
|
}
|
|
2053
|
-
|
|
2081
|
+
declare enum PollLayoutDirection {
|
|
2054
2082
|
/** Left-to-right */
|
|
2055
2083
|
LTR = "LTR",
|
|
2056
2084
|
/** Right-to-left */
|
|
2057
2085
|
RTL = "RTL"
|
|
2058
2086
|
}
|
|
2059
|
-
|
|
2087
|
+
interface PollLayout {
|
|
2060
2088
|
/** The layout for displaying the voting options. */
|
|
2061
2089
|
type?: PollLayoutType;
|
|
2062
2090
|
/** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
|
|
@@ -2064,11 +2092,11 @@ export interface PollLayout {
|
|
|
2064
2092
|
/** Sets whether to display the main poll image. Defaults to `false`. */
|
|
2065
2093
|
enableImage?: boolean | null;
|
|
2066
2094
|
}
|
|
2067
|
-
|
|
2095
|
+
interface OptionLayout {
|
|
2068
2096
|
/** Sets whether to display option images. Defaults to `false`. */
|
|
2069
2097
|
enableImage?: boolean | null;
|
|
2070
2098
|
}
|
|
2071
|
-
|
|
2099
|
+
declare enum BackgroundType {
|
|
2072
2100
|
/** Color background type */
|
|
2073
2101
|
COLOR = "COLOR",
|
|
2074
2102
|
/** Image background type */
|
|
@@ -2076,7 +2104,7 @@ export declare enum BackgroundType {
|
|
|
2076
2104
|
/** Gradiant background type */
|
|
2077
2105
|
GRADIENT = "GRADIENT"
|
|
2078
2106
|
}
|
|
2079
|
-
|
|
2107
|
+
interface Gradient {
|
|
2080
2108
|
/** The gradient angle in degrees. */
|
|
2081
2109
|
angle?: number | null;
|
|
2082
2110
|
/**
|
|
@@ -2090,7 +2118,7 @@ export interface Gradient {
|
|
|
2090
2118
|
*/
|
|
2091
2119
|
lastColor?: string | null;
|
|
2092
2120
|
}
|
|
2093
|
-
|
|
2121
|
+
interface Background extends BackgroundBackgroundOneOf {
|
|
2094
2122
|
/**
|
|
2095
2123
|
* The background color as a hexademical value.
|
|
2096
2124
|
* @format COLOR_HEX
|
|
@@ -2104,7 +2132,7 @@ export interface Background extends BackgroundBackgroundOneOf {
|
|
|
2104
2132
|
type?: BackgroundType;
|
|
2105
2133
|
}
|
|
2106
2134
|
/** @oneof */
|
|
2107
|
-
|
|
2135
|
+
interface BackgroundBackgroundOneOf {
|
|
2108
2136
|
/**
|
|
2109
2137
|
* The background color as a hexademical value.
|
|
2110
2138
|
* @format COLOR_HEX
|
|
@@ -2115,19 +2143,19 @@ export interface BackgroundBackgroundOneOf {
|
|
|
2115
2143
|
/** Details for a gradient background. */
|
|
2116
2144
|
gradient?: Gradient;
|
|
2117
2145
|
}
|
|
2118
|
-
|
|
2146
|
+
interface PollDesign {
|
|
2119
2147
|
/** Background styling. */
|
|
2120
2148
|
background?: Background;
|
|
2121
2149
|
/** Border radius in pixels. */
|
|
2122
2150
|
borderRadius?: number | null;
|
|
2123
2151
|
}
|
|
2124
|
-
|
|
2152
|
+
interface OptionDesign {
|
|
2125
2153
|
/** Border radius in pixels. */
|
|
2126
2154
|
borderRadius?: number | null;
|
|
2127
2155
|
}
|
|
2128
|
-
|
|
2156
|
+
interface Poll {
|
|
2129
2157
|
/** Poll ID. */
|
|
2130
|
-
|
|
2158
|
+
_id?: string | null;
|
|
2131
2159
|
/** Poll title. */
|
|
2132
2160
|
title?: string | null;
|
|
2133
2161
|
/** Poll creator ID. */
|
|
@@ -2139,26 +2167,26 @@ export interface Poll {
|
|
|
2139
2167
|
/** The poll's permissions and display settings. */
|
|
2140
2168
|
settings?: PollSettings;
|
|
2141
2169
|
}
|
|
2142
|
-
|
|
2170
|
+
interface PollDataLayout {
|
|
2143
2171
|
/** Poll layout settings. */
|
|
2144
2172
|
poll?: PollLayout;
|
|
2145
2173
|
/** Voting otpions layout settings. */
|
|
2146
2174
|
options?: OptionLayout;
|
|
2147
2175
|
}
|
|
2148
|
-
|
|
2176
|
+
interface Design {
|
|
2149
2177
|
/** Styling for the poll. */
|
|
2150
2178
|
poll?: PollDesign;
|
|
2151
2179
|
/** Styling for voting options. */
|
|
2152
2180
|
options?: OptionDesign;
|
|
2153
2181
|
}
|
|
2154
|
-
|
|
2182
|
+
interface TextData {
|
|
2155
2183
|
/** The text to apply decorations to. */
|
|
2156
2184
|
text?: string;
|
|
2157
2185
|
/** The decorations to apply. */
|
|
2158
2186
|
decorations?: Decoration[];
|
|
2159
2187
|
}
|
|
2160
2188
|
/** Adds appearence changes to text */
|
|
2161
|
-
|
|
2189
|
+
interface Decoration extends DecorationDataOneOf {
|
|
2162
2190
|
/** Data for an anchor link decoration. */
|
|
2163
2191
|
anchorData?: AnchorData;
|
|
2164
2192
|
/** Data for a color decoration. */
|
|
@@ -2181,7 +2209,7 @@ export interface Decoration extends DecorationDataOneOf {
|
|
|
2181
2209
|
type?: DecorationType;
|
|
2182
2210
|
}
|
|
2183
2211
|
/** @oneof */
|
|
2184
|
-
|
|
2212
|
+
interface DecorationDataOneOf {
|
|
2185
2213
|
/** Data for an anchor link decoration. */
|
|
2186
2214
|
anchorData?: AnchorData;
|
|
2187
2215
|
/** Data for a color decoration. */
|
|
@@ -2201,7 +2229,7 @@ export interface DecorationDataOneOf {
|
|
|
2201
2229
|
/** Data for a spoiler decoration. */
|
|
2202
2230
|
spoilerData?: SpoilerData;
|
|
2203
2231
|
}
|
|
2204
|
-
|
|
2232
|
+
declare enum DecorationType {
|
|
2205
2233
|
BOLD = "BOLD",
|
|
2206
2234
|
ITALIC = "ITALIC",
|
|
2207
2235
|
UNDERLINE = "UNDERLINE",
|
|
@@ -2213,43 +2241,43 @@ export declare enum DecorationType {
|
|
|
2213
2241
|
FONT_SIZE = "FONT_SIZE",
|
|
2214
2242
|
EXTERNAL = "EXTERNAL"
|
|
2215
2243
|
}
|
|
2216
|
-
|
|
2244
|
+
interface AnchorData {
|
|
2217
2245
|
/** The target node's ID. */
|
|
2218
2246
|
anchor?: string;
|
|
2219
2247
|
}
|
|
2220
|
-
|
|
2248
|
+
interface ColorData {
|
|
2221
2249
|
/** The text's background color as a hexadecimal value. */
|
|
2222
2250
|
background?: string | null;
|
|
2223
2251
|
/** The text's foreground color as a hexadecimal value. */
|
|
2224
2252
|
foreground?: string | null;
|
|
2225
2253
|
}
|
|
2226
|
-
|
|
2254
|
+
interface LinkData {
|
|
2227
2255
|
/** Link details. */
|
|
2228
2256
|
link?: Link;
|
|
2229
2257
|
}
|
|
2230
|
-
|
|
2258
|
+
interface MentionData {
|
|
2231
2259
|
/** The mentioned user's name. */
|
|
2232
2260
|
name?: string;
|
|
2233
2261
|
/** The version of the user's name that appears after the `@` character in the mention. */
|
|
2234
2262
|
slug?: string;
|
|
2235
2263
|
/** Mentioned user's ID. */
|
|
2236
|
-
|
|
2264
|
+
_id?: string | null;
|
|
2237
2265
|
}
|
|
2238
|
-
|
|
2266
|
+
interface FontSizeData {
|
|
2239
2267
|
/** The units used for the font size. */
|
|
2240
2268
|
unit?: FontType;
|
|
2241
2269
|
/** Font size value. */
|
|
2242
2270
|
value?: number | null;
|
|
2243
2271
|
}
|
|
2244
|
-
|
|
2272
|
+
declare enum FontType {
|
|
2245
2273
|
PX = "PX",
|
|
2246
2274
|
EM = "EM"
|
|
2247
2275
|
}
|
|
2248
|
-
|
|
2276
|
+
interface SpoilerData {
|
|
2249
2277
|
/** Spoiler ID. */
|
|
2250
|
-
|
|
2278
|
+
_id?: string | null;
|
|
2251
2279
|
}
|
|
2252
|
-
|
|
2280
|
+
interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
2253
2281
|
/** Data for embedded Wix Bookings content. */
|
|
2254
2282
|
bookingData?: BookingData;
|
|
2255
2283
|
/** Data for embedded Wix Events content. */
|
|
@@ -2271,28 +2299,28 @@ export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
|
2271
2299
|
image?: Media;
|
|
2272
2300
|
}
|
|
2273
2301
|
/** @oneof */
|
|
2274
|
-
|
|
2302
|
+
interface AppEmbedDataAppDataOneOf {
|
|
2275
2303
|
/** Data for embedded Wix Bookings content. */
|
|
2276
2304
|
bookingData?: BookingData;
|
|
2277
2305
|
/** Data for embedded Wix Events content. */
|
|
2278
2306
|
eventData?: EventData;
|
|
2279
2307
|
}
|
|
2280
|
-
|
|
2308
|
+
declare enum AppType {
|
|
2281
2309
|
PRODUCT = "PRODUCT",
|
|
2282
2310
|
EVENT = "EVENT",
|
|
2283
2311
|
BOOKING = "BOOKING"
|
|
2284
2312
|
}
|
|
2285
|
-
|
|
2313
|
+
interface BookingData {
|
|
2286
2314
|
/** Booking duration in minutes. */
|
|
2287
2315
|
durations?: string | null;
|
|
2288
2316
|
}
|
|
2289
|
-
|
|
2317
|
+
interface EventData {
|
|
2290
2318
|
/** Event schedule. */
|
|
2291
2319
|
scheduling?: string | null;
|
|
2292
2320
|
/** Event location. */
|
|
2293
2321
|
location?: string | null;
|
|
2294
2322
|
}
|
|
2295
|
-
|
|
2323
|
+
interface VideoData {
|
|
2296
2324
|
/** Styling for the video's container. */
|
|
2297
2325
|
containerData?: PluginContainerData;
|
|
2298
2326
|
/** Video details. */
|
|
@@ -2306,7 +2334,7 @@ export interface VideoData {
|
|
|
2306
2334
|
/** Video options. */
|
|
2307
2335
|
options?: PlaybackOptions;
|
|
2308
2336
|
}
|
|
2309
|
-
|
|
2337
|
+
interface PlaybackOptions {
|
|
2310
2338
|
/** Sets whether the media will automatically start playing. */
|
|
2311
2339
|
autoPlay?: boolean | null;
|
|
2312
2340
|
/** Sets whether media's will be looped. */
|
|
@@ -2314,7 +2342,7 @@ export interface PlaybackOptions {
|
|
|
2314
2342
|
/** Sets whether media's controls will be shown. */
|
|
2315
2343
|
showControls?: boolean | null;
|
|
2316
2344
|
}
|
|
2317
|
-
|
|
2345
|
+
interface EmbedData {
|
|
2318
2346
|
/** Styling for the oEmbed node's container. */
|
|
2319
2347
|
containerData?: PluginContainerData;
|
|
2320
2348
|
/** An [oEmbed](https://www.oembed.com) object. */
|
|
@@ -2322,7 +2350,7 @@ export interface EmbedData {
|
|
|
2322
2350
|
/** Origin asset source. */
|
|
2323
2351
|
src?: string | null;
|
|
2324
2352
|
}
|
|
2325
|
-
|
|
2353
|
+
interface Oembed {
|
|
2326
2354
|
/** The resource type. */
|
|
2327
2355
|
type?: string | null;
|
|
2328
2356
|
/** The width of the resource specified in the `url` property in pixels. */
|
|
@@ -2354,7 +2382,7 @@ export interface Oembed {
|
|
|
2354
2382
|
/** The oEmbed version number. This value must be `1.0`. */
|
|
2355
2383
|
version?: string | null;
|
|
2356
2384
|
}
|
|
2357
|
-
|
|
2385
|
+
interface CollapsibleListData {
|
|
2358
2386
|
/** Styling for the collapsible list's container. */
|
|
2359
2387
|
containerData?: PluginContainerData;
|
|
2360
2388
|
/** If `true`, only one item can be expanded at a time. Defaults to `false`. */
|
|
@@ -2366,7 +2394,7 @@ export interface CollapsibleListData {
|
|
|
2366
2394
|
/** If `true`, The collapsible item will appear in search results as an FAQ. */
|
|
2367
2395
|
isQapageData?: boolean | null;
|
|
2368
2396
|
}
|
|
2369
|
-
|
|
2397
|
+
declare enum InitialExpandedItems {
|
|
2370
2398
|
/** First item will be expended initally */
|
|
2371
2399
|
FIRST = "FIRST",
|
|
2372
2400
|
/** All items will expended initally */
|
|
@@ -2374,13 +2402,13 @@ export declare enum InitialExpandedItems {
|
|
|
2374
2402
|
/** All items collapsed initally */
|
|
2375
2403
|
NONE = "NONE"
|
|
2376
2404
|
}
|
|
2377
|
-
|
|
2405
|
+
declare enum Direction {
|
|
2378
2406
|
/** Left-to-right */
|
|
2379
2407
|
LTR = "LTR",
|
|
2380
2408
|
/** Right-to-left */
|
|
2381
2409
|
RTL = "RTL"
|
|
2382
2410
|
}
|
|
2383
|
-
|
|
2411
|
+
interface TableData {
|
|
2384
2412
|
/** Styling for the table's container. */
|
|
2385
2413
|
containerData?: PluginContainerData;
|
|
2386
2414
|
/** The table's dimensions. */
|
|
@@ -2395,7 +2423,7 @@ export interface TableData {
|
|
|
2395
2423
|
/** Sets whether the table's first column is a header. Defaults to `false`. */
|
|
2396
2424
|
columnHeader?: boolean | null;
|
|
2397
2425
|
}
|
|
2398
|
-
|
|
2426
|
+
interface Dimensions {
|
|
2399
2427
|
/** An array representing relative width of each column in relation to the other columns. */
|
|
2400
2428
|
colsWidthRatio?: number[];
|
|
2401
2429
|
/** An array representing the height of each row in pixels. */
|
|
@@ -2403,13 +2431,13 @@ export interface Dimensions {
|
|
|
2403
2431
|
/** An array representing the minimum width of each column in pixels. */
|
|
2404
2432
|
colsMinWidth?: number[];
|
|
2405
2433
|
}
|
|
2406
|
-
|
|
2434
|
+
interface TableCellData {
|
|
2407
2435
|
/** Styling for the cell's background color and text alignment. */
|
|
2408
2436
|
cellStyle?: CellStyle;
|
|
2409
2437
|
/** The cell's border colors. */
|
|
2410
2438
|
borderColors?: BorderColors;
|
|
2411
2439
|
}
|
|
2412
|
-
|
|
2440
|
+
declare enum VerticalAlignment {
|
|
2413
2441
|
/** Top alignment */
|
|
2414
2442
|
TOP = "TOP",
|
|
2415
2443
|
/** Middle alignment */
|
|
@@ -2417,7 +2445,7 @@ export declare enum VerticalAlignment {
|
|
|
2417
2445
|
/** Bottom alignment */
|
|
2418
2446
|
BOTTOM = "BOTTOM"
|
|
2419
2447
|
}
|
|
2420
|
-
|
|
2448
|
+
interface CellStyle {
|
|
2421
2449
|
/** Vertical alignment for the cell's text. */
|
|
2422
2450
|
verticalAlignment?: VerticalAlignment;
|
|
2423
2451
|
/**
|
|
@@ -2426,7 +2454,7 @@ export interface CellStyle {
|
|
|
2426
2454
|
*/
|
|
2427
2455
|
backgroundColor?: string | null;
|
|
2428
2456
|
}
|
|
2429
|
-
|
|
2457
|
+
interface BorderColors {
|
|
2430
2458
|
/**
|
|
2431
2459
|
* Left border color as a hexadecimal value.
|
|
2432
2460
|
* @format COLOR_HEX
|
|
@@ -2454,7 +2482,7 @@ export interface BorderColors {
|
|
|
2454
2482
|
*
|
|
2455
2483
|
* The JSON representation for `NullValue` is JSON `null`.
|
|
2456
2484
|
*/
|
|
2457
|
-
|
|
2485
|
+
declare enum NullValue {
|
|
2458
2486
|
/** Null value. */
|
|
2459
2487
|
NULL_VALUE = "NULL_VALUE"
|
|
2460
2488
|
}
|
|
@@ -2463,11 +2491,11 @@ export declare enum NullValue {
|
|
|
2463
2491
|
*
|
|
2464
2492
|
* The JSON representation for `ListValue` is JSON array.
|
|
2465
2493
|
*/
|
|
2466
|
-
|
|
2494
|
+
interface ListValue {
|
|
2467
2495
|
/** Repeated field of dynamically typed values. */
|
|
2468
2496
|
values?: any[];
|
|
2469
2497
|
}
|
|
2470
|
-
|
|
2498
|
+
interface AudioData {
|
|
2471
2499
|
/** Styling for the audio node's container. */
|
|
2472
2500
|
containerData?: PluginContainerData;
|
|
2473
2501
|
/** Audio file details. */
|
|
@@ -2483,7 +2511,7 @@ export interface AudioData {
|
|
|
2483
2511
|
/** An HTML version of the audio node. */
|
|
2484
2512
|
html?: string | null;
|
|
2485
2513
|
}
|
|
2486
|
-
|
|
2514
|
+
interface OrderedListData {
|
|
2487
2515
|
/** Indentation level from 0-4. */
|
|
2488
2516
|
indentation?: number;
|
|
2489
2517
|
/** Offset level from 0-4. */
|
|
@@ -2491,24 +2519,24 @@ export interface OrderedListData {
|
|
|
2491
2519
|
/** List start number. */
|
|
2492
2520
|
start?: number | null;
|
|
2493
2521
|
}
|
|
2494
|
-
|
|
2522
|
+
interface BulletedListData {
|
|
2495
2523
|
/** Indentation level from 0-4. */
|
|
2496
2524
|
indentation?: number;
|
|
2497
2525
|
/** Offset level from 0-4. */
|
|
2498
2526
|
offset?: number | null;
|
|
2499
2527
|
}
|
|
2500
|
-
|
|
2528
|
+
interface BlockquoteData {
|
|
2501
2529
|
/** Indentation level from 1-4. */
|
|
2502
2530
|
indentation?: number;
|
|
2503
2531
|
}
|
|
2504
|
-
|
|
2532
|
+
interface CaptionData {
|
|
2505
2533
|
textStyle?: TextStyle;
|
|
2506
2534
|
}
|
|
2507
|
-
|
|
2535
|
+
interface LayoutCellData {
|
|
2508
2536
|
/** Size of the cell in 12 columns grid. */
|
|
2509
2537
|
colSpan?: number | null;
|
|
2510
2538
|
}
|
|
2511
|
-
|
|
2539
|
+
interface Metadata {
|
|
2512
2540
|
/** Schema version. */
|
|
2513
2541
|
version?: number;
|
|
2514
2542
|
/**
|
|
@@ -2523,9 +2551,9 @@ export interface Metadata {
|
|
|
2523
2551
|
*/
|
|
2524
2552
|
updatedTimestamp?: Date | null;
|
|
2525
2553
|
/** Object ID. */
|
|
2526
|
-
|
|
2554
|
+
_id?: string | null;
|
|
2527
2555
|
}
|
|
2528
|
-
|
|
2556
|
+
interface DocumentStyle {
|
|
2529
2557
|
/** Styling for H1 nodes. */
|
|
2530
2558
|
headerOne?: TextNodeStyle;
|
|
2531
2559
|
/** Styling for H2 nodes. */
|
|
@@ -2545,7 +2573,7 @@ export interface DocumentStyle {
|
|
|
2545
2573
|
/** Styling for code block nodes. */
|
|
2546
2574
|
codeBlock?: TextNodeStyle;
|
|
2547
2575
|
}
|
|
2548
|
-
|
|
2576
|
+
interface TextNodeStyle {
|
|
2549
2577
|
/** The decorations to apply to the node. */
|
|
2550
2578
|
decorations?: Decoration[];
|
|
2551
2579
|
/** Padding and background color for the node. */
|
|
@@ -2553,14 +2581,14 @@ export interface TextNodeStyle {
|
|
|
2553
2581
|
/** Line height for text in the node. */
|
|
2554
2582
|
lineHeight?: string | null;
|
|
2555
2583
|
}
|
|
2556
|
-
|
|
2584
|
+
interface BadgeList {
|
|
2557
2585
|
/**
|
|
2558
2586
|
* Events badges.
|
|
2559
2587
|
* @maxSize 10
|
|
2560
2588
|
*/
|
|
2561
2589
|
badges?: V3Badge[];
|
|
2562
2590
|
}
|
|
2563
|
-
|
|
2591
|
+
interface V3Badge {
|
|
2564
2592
|
/** Badge type. */
|
|
2565
2593
|
type?: BadgeTypeType;
|
|
2566
2594
|
/**
|
|
@@ -2569,7 +2597,7 @@ export interface V3Badge {
|
|
|
2569
2597
|
*/
|
|
2570
2598
|
text?: string | null;
|
|
2571
2599
|
}
|
|
2572
|
-
|
|
2600
|
+
declare enum BadgeTypeType {
|
|
2573
2601
|
/** Unknown badge type. */
|
|
2574
2602
|
UNKNOWN_BADGE_TYPE = "UNKNOWN_BADGE_TYPE",
|
|
2575
2603
|
/** 1st priority badge type. */
|
|
@@ -2579,7 +2607,7 @@ export declare enum BadgeTypeType {
|
|
|
2579
2607
|
/** 3rd priority badge type. */
|
|
2580
2608
|
THIRD_PRIORITY = "THIRD_PRIORITY"
|
|
2581
2609
|
}
|
|
2582
|
-
|
|
2610
|
+
interface EventEventStarted {
|
|
2583
2611
|
/** Event schedule configuration. */
|
|
2584
2612
|
timestamp?: Date | null;
|
|
2585
2613
|
/**
|
|
@@ -2590,7 +2618,7 @@ export interface EventEventStarted {
|
|
|
2590
2618
|
/** True if at least one guest is registered to the event with any attendance status. */
|
|
2591
2619
|
hasGuests?: boolean | null;
|
|
2592
2620
|
}
|
|
2593
|
-
|
|
2621
|
+
interface EventEventEnded {
|
|
2594
2622
|
/** Event end timestamp in ISO UTC format. */
|
|
2595
2623
|
timestamp?: Date | null;
|
|
2596
2624
|
/**
|
|
@@ -2601,7 +2629,7 @@ export interface EventEventEnded {
|
|
|
2601
2629
|
/** True if at least one guest is registered to the event with any attendance status. */
|
|
2602
2630
|
hasGuests?: boolean | null;
|
|
2603
2631
|
}
|
|
2604
|
-
|
|
2632
|
+
interface EventEventReminder {
|
|
2605
2633
|
/** Reminder timestamp in ISO UTC format. */
|
|
2606
2634
|
timestamp?: Date | null;
|
|
2607
2635
|
/**
|
|
@@ -2629,7 +2657,7 @@ export interface EventEventReminder {
|
|
|
2629
2657
|
/** True if at least one guest is registered to the event with any attendance status. */
|
|
2630
2658
|
hasGuests?: boolean | null;
|
|
2631
2659
|
}
|
|
2632
|
-
|
|
2660
|
+
interface EventEventPublished {
|
|
2633
2661
|
/** Event publishing timestamp in ISO UTC format. */
|
|
2634
2662
|
timestamp?: Date | null;
|
|
2635
2663
|
/**
|
|
@@ -2661,11 +2689,11 @@ export interface EventEventPublished {
|
|
|
2661
2689
|
/** Event date and time settings. */
|
|
2662
2690
|
dateAndTimeSettings?: DateAndTimeSettings;
|
|
2663
2691
|
/** Event page URL components. */
|
|
2664
|
-
eventPageUrl?:
|
|
2692
|
+
eventPageUrl?: string;
|
|
2665
2693
|
/** RSVP or ticketing registration details. */
|
|
2666
2694
|
registration?: Registration;
|
|
2667
2695
|
}
|
|
2668
|
-
|
|
2696
|
+
interface EventCloned {
|
|
2669
2697
|
/** Event creation timestamp in ISO UTC format. */
|
|
2670
2698
|
timestamp?: Date | null;
|
|
2671
2699
|
/**
|
|
@@ -2707,7 +2735,7 @@ export interface EventCloned {
|
|
|
2707
2735
|
*/
|
|
2708
2736
|
ticketDefinitions?: Record<string, string>;
|
|
2709
2737
|
}
|
|
2710
|
-
|
|
2738
|
+
interface EventEventCanceled {
|
|
2711
2739
|
/** Event cancelation timestamp in ISO UTC format. */
|
|
2712
2740
|
timestamp?: Date | null;
|
|
2713
2741
|
/**
|
|
@@ -2729,7 +2757,7 @@ export interface EventEventCanceled {
|
|
|
2729
2757
|
/** True if at least one guest is registered to the event with any attendance status. */
|
|
2730
2758
|
hasGuests?: boolean | null;
|
|
2731
2759
|
}
|
|
2732
|
-
|
|
2760
|
+
interface CreateEventRequest {
|
|
2733
2761
|
/** Event data. */
|
|
2734
2762
|
event: V3Event;
|
|
2735
2763
|
/** Whether to create the event as a draft. */
|
|
@@ -2740,7 +2768,7 @@ export interface CreateEventRequest {
|
|
|
2740
2768
|
*/
|
|
2741
2769
|
fields?: RequestedFields[];
|
|
2742
2770
|
}
|
|
2743
|
-
|
|
2771
|
+
declare enum RequestedFields {
|
|
2744
2772
|
/** Unknown requested field. */
|
|
2745
2773
|
UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
|
|
2746
2774
|
/** Returns `shortDescription`, `mainImage` and `calendarUrls`. */
|
|
@@ -2766,11 +2794,11 @@ export declare enum RequestedFields {
|
|
|
2766
2794
|
/** Returns `categories`. */
|
|
2767
2795
|
CATEGORIES = "CATEGORIES"
|
|
2768
2796
|
}
|
|
2769
|
-
|
|
2797
|
+
interface CreateEventResponse {
|
|
2770
2798
|
/** Created event. */
|
|
2771
2799
|
event?: V3Event;
|
|
2772
2800
|
}
|
|
2773
|
-
|
|
2801
|
+
interface CloneEventRequest {
|
|
2774
2802
|
/**
|
|
2775
2803
|
* Event ID.
|
|
2776
2804
|
* @format GUID
|
|
@@ -2786,11 +2814,11 @@ export interface CloneEventRequest {
|
|
|
2786
2814
|
*/
|
|
2787
2815
|
fields?: RequestedFields[];
|
|
2788
2816
|
}
|
|
2789
|
-
|
|
2817
|
+
interface CloneEventResponse {
|
|
2790
2818
|
/** Cloned event. */
|
|
2791
2819
|
event?: V3Event;
|
|
2792
2820
|
}
|
|
2793
|
-
|
|
2821
|
+
interface CloneEventFromOtherSiteRequest {
|
|
2794
2822
|
/**
|
|
2795
2823
|
* Event ID.
|
|
2796
2824
|
* @format GUID
|
|
@@ -2807,11 +2835,11 @@ export interface CloneEventFromOtherSiteRequest {
|
|
|
2807
2835
|
*/
|
|
2808
2836
|
fields?: RequestedFields[];
|
|
2809
2837
|
}
|
|
2810
|
-
|
|
2838
|
+
interface CloneEventFromOtherSiteResponse {
|
|
2811
2839
|
/** Cloned event. */
|
|
2812
2840
|
event?: V3Event;
|
|
2813
2841
|
}
|
|
2814
|
-
|
|
2842
|
+
interface UpdateEventRequest {
|
|
2815
2843
|
/** Field values to be changed. */
|
|
2816
2844
|
event?: V3Event;
|
|
2817
2845
|
/**
|
|
@@ -2820,11 +2848,11 @@ export interface UpdateEventRequest {
|
|
|
2820
2848
|
*/
|
|
2821
2849
|
fields?: RequestedFields[];
|
|
2822
2850
|
}
|
|
2823
|
-
|
|
2851
|
+
interface UpdateEventResponse {
|
|
2824
2852
|
/** Updated event. */
|
|
2825
2853
|
event?: V3Event;
|
|
2826
2854
|
}
|
|
2827
|
-
|
|
2855
|
+
interface PublishDraftEventRequest {
|
|
2828
2856
|
/**
|
|
2829
2857
|
* Event ID.
|
|
2830
2858
|
* @format GUID
|
|
@@ -2836,11 +2864,11 @@ export interface PublishDraftEventRequest {
|
|
|
2836
2864
|
*/
|
|
2837
2865
|
fields?: RequestedFields[];
|
|
2838
2866
|
}
|
|
2839
|
-
|
|
2867
|
+
interface PublishDraftEventResponse {
|
|
2840
2868
|
/** Published event. */
|
|
2841
2869
|
event?: V3Event;
|
|
2842
2870
|
}
|
|
2843
|
-
|
|
2871
|
+
interface CancelEventRequest {
|
|
2844
2872
|
/**
|
|
2845
2873
|
* Event ID.
|
|
2846
2874
|
* @format GUID
|
|
@@ -2852,15 +2880,15 @@ export interface CancelEventRequest {
|
|
|
2852
2880
|
*/
|
|
2853
2881
|
fields?: RequestedFields[];
|
|
2854
2882
|
}
|
|
2855
|
-
|
|
2883
|
+
interface CancelEventResponse {
|
|
2856
2884
|
/** Canceled event. */
|
|
2857
2885
|
event?: V3Event;
|
|
2858
2886
|
}
|
|
2859
|
-
|
|
2860
|
-
/** Filter.
|
|
2887
|
+
interface BulkCancelEventsByFilterRequest {
|
|
2888
|
+
/** Filter. */
|
|
2861
2889
|
filter?: CommonQueryV2;
|
|
2862
2890
|
}
|
|
2863
|
-
|
|
2891
|
+
interface CommonQueryV2 extends CommonQueryV2PagingMethodOneOf {
|
|
2864
2892
|
/** Paging options. Can't be used together with `cursorPaging`. */
|
|
2865
2893
|
paging?: CommonPaging;
|
|
2866
2894
|
/**
|
|
@@ -2879,11 +2907,11 @@ export interface CommonQueryV2 extends CommonQueryV2PagingMethodOneOf {
|
|
|
2879
2907
|
sort?: CommonSorting[];
|
|
2880
2908
|
}
|
|
2881
2909
|
/** @oneof */
|
|
2882
|
-
|
|
2910
|
+
interface CommonQueryV2PagingMethodOneOf {
|
|
2883
2911
|
/** Paging options. Can't be used together with `cursorPaging`. */
|
|
2884
2912
|
paging?: CommonPaging;
|
|
2885
2913
|
}
|
|
2886
|
-
|
|
2914
|
+
interface CommonSorting {
|
|
2887
2915
|
/**
|
|
2888
2916
|
* Name of the field to sort by.
|
|
2889
2917
|
* @maxLength 100
|
|
@@ -2897,11 +2925,11 @@ export interface CommonSorting {
|
|
|
2897
2925
|
*/
|
|
2898
2926
|
order?: CommonSortOrder;
|
|
2899
2927
|
}
|
|
2900
|
-
|
|
2928
|
+
declare enum CommonSortOrder {
|
|
2901
2929
|
ASC = "ASC",
|
|
2902
2930
|
DESC = "DESC"
|
|
2903
2931
|
}
|
|
2904
|
-
|
|
2932
|
+
interface CommonPaging {
|
|
2905
2933
|
/**
|
|
2906
2934
|
* 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.
|
|
2907
2935
|
* @max 1000
|
|
@@ -2910,29 +2938,29 @@ export interface CommonPaging {
|
|
|
2910
2938
|
/** Number of items to skip in the current sort order. */
|
|
2911
2939
|
offset?: number | null;
|
|
2912
2940
|
}
|
|
2913
|
-
|
|
2941
|
+
interface BulkCancelEventsByFilterResponse {
|
|
2914
2942
|
}
|
|
2915
|
-
|
|
2943
|
+
interface DeleteEventRequest {
|
|
2916
2944
|
/**
|
|
2917
2945
|
* Event ID.
|
|
2918
2946
|
* @format GUID
|
|
2919
2947
|
*/
|
|
2920
2948
|
eventId: string;
|
|
2921
2949
|
}
|
|
2922
|
-
|
|
2950
|
+
interface DeleteEventResponse {
|
|
2923
2951
|
/**
|
|
2924
2952
|
* Deleted event ID.
|
|
2925
2953
|
* @format GUID
|
|
2926
2954
|
*/
|
|
2927
2955
|
eventId?: string;
|
|
2928
2956
|
}
|
|
2929
|
-
|
|
2957
|
+
interface BulkDeleteEventsByFilterRequest {
|
|
2930
2958
|
/** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
|
|
2931
2959
|
filter?: CommonQueryV2;
|
|
2932
2960
|
}
|
|
2933
|
-
|
|
2961
|
+
interface BulkDeleteEventsByFilterResponse {
|
|
2934
2962
|
}
|
|
2935
|
-
|
|
2963
|
+
interface QueryEventsRequest {
|
|
2936
2964
|
/** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
|
|
2937
2965
|
query?: CommonQueryV2;
|
|
2938
2966
|
/**
|
|
@@ -2946,13 +2974,13 @@ export interface QueryEventsRequest {
|
|
|
2946
2974
|
*/
|
|
2947
2975
|
includeDrafts?: boolean;
|
|
2948
2976
|
}
|
|
2949
|
-
|
|
2977
|
+
interface QueryEventsResponse {
|
|
2950
2978
|
/** Metadata for the paginated results. */
|
|
2951
2979
|
pagingMetadata?: CommonPagingMetadataV2;
|
|
2952
2980
|
/** List of events. */
|
|
2953
2981
|
events?: V3Event[];
|
|
2954
2982
|
}
|
|
2955
|
-
|
|
2983
|
+
interface CommonPagingMetadataV2 {
|
|
2956
2984
|
/** 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. */
|
|
2957
2985
|
count?: number | null;
|
|
2958
2986
|
/** Requested offset. */
|
|
@@ -2964,17 +2992,17 @@ export interface CommonPagingMetadataV2 {
|
|
|
2964
2992
|
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
2965
2993
|
cursors?: CommonCursors;
|
|
2966
2994
|
}
|
|
2967
|
-
|
|
2995
|
+
interface CommonCursors {
|
|
2968
2996
|
/** Cursor pointing to the next page in the list of results. */
|
|
2969
2997
|
next?: string | null;
|
|
2970
2998
|
/** Cursor pointing to the previous page in the list of results. */
|
|
2971
2999
|
prev?: string | null;
|
|
2972
3000
|
}
|
|
2973
|
-
|
|
3001
|
+
interface ExportEventsRequest {
|
|
2974
3002
|
/** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
|
|
2975
3003
|
query?: QueryV2;
|
|
2976
3004
|
}
|
|
2977
|
-
|
|
3005
|
+
interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
2978
3006
|
/** Paging options to limit and skip the number of items. */
|
|
2979
3007
|
paging?: Paging;
|
|
2980
3008
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
@@ -2997,13 +3025,13 @@ export interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
|
2997
3025
|
fieldsets?: string[];
|
|
2998
3026
|
}
|
|
2999
3027
|
/** @oneof */
|
|
3000
|
-
|
|
3028
|
+
interface QueryV2PagingMethodOneOf {
|
|
3001
3029
|
/** Paging options to limit and skip the number of items. */
|
|
3002
3030
|
paging?: Paging;
|
|
3003
3031
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
3004
3032
|
cursorPaging?: CursorPaging;
|
|
3005
3033
|
}
|
|
3006
|
-
|
|
3034
|
+
interface Sorting {
|
|
3007
3035
|
/**
|
|
3008
3036
|
* Name of the field to sort by.
|
|
3009
3037
|
* @maxLength 512
|
|
@@ -3012,17 +3040,17 @@ export interface Sorting {
|
|
|
3012
3040
|
/** Sort order. */
|
|
3013
3041
|
order?: SortOrder;
|
|
3014
3042
|
}
|
|
3015
|
-
|
|
3043
|
+
declare enum SortOrder {
|
|
3016
3044
|
ASC = "ASC",
|
|
3017
3045
|
DESC = "DESC"
|
|
3018
3046
|
}
|
|
3019
|
-
|
|
3047
|
+
interface Paging {
|
|
3020
3048
|
/** Number of items to load. */
|
|
3021
3049
|
limit?: number | null;
|
|
3022
3050
|
/** Number of items to skip in the current sort order. */
|
|
3023
3051
|
offset?: number | null;
|
|
3024
3052
|
}
|
|
3025
|
-
|
|
3053
|
+
interface CursorPaging {
|
|
3026
3054
|
/**
|
|
3027
3055
|
* Maximum number of items to return in the results.
|
|
3028
3056
|
* @max 100
|
|
@@ -3037,13 +3065,13 @@ export interface CursorPaging {
|
|
|
3037
3065
|
*/
|
|
3038
3066
|
cursor?: string | null;
|
|
3039
3067
|
}
|
|
3040
|
-
|
|
3068
|
+
interface ExportEventsResponse {
|
|
3041
3069
|
/** Metadata for the paginated results. */
|
|
3042
3070
|
pagingMetadata?: PagingMetadataV2;
|
|
3043
3071
|
/** List of events. */
|
|
3044
3072
|
events?: V3Event[];
|
|
3045
3073
|
}
|
|
3046
|
-
|
|
3074
|
+
interface PagingMetadataV2 {
|
|
3047
3075
|
/** Number of items returned in the response. */
|
|
3048
3076
|
count?: number | null;
|
|
3049
3077
|
/** Offset that was requested. */
|
|
@@ -3055,7 +3083,7 @@ export interface PagingMetadataV2 {
|
|
|
3055
3083
|
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
3056
3084
|
cursors?: Cursors;
|
|
3057
3085
|
}
|
|
3058
|
-
|
|
3086
|
+
interface Cursors {
|
|
3059
3087
|
/**
|
|
3060
3088
|
* Cursor string pointing to the next page in the list of results.
|
|
3061
3089
|
* @maxLength 16000
|
|
@@ -3067,7 +3095,7 @@ export interface Cursors {
|
|
|
3067
3095
|
*/
|
|
3068
3096
|
prev?: string | null;
|
|
3069
3097
|
}
|
|
3070
|
-
|
|
3098
|
+
interface CountEventsByStatusRequest {
|
|
3071
3099
|
/** Filter object in the following format: <br/> `"filter" : { "fieldName1": "value1" }`. */
|
|
3072
3100
|
filter?: Record<string, any> | null;
|
|
3073
3101
|
/**
|
|
@@ -3082,17 +3110,17 @@ export interface CountEventsByStatusRequest {
|
|
|
3082
3110
|
*/
|
|
3083
3111
|
includeDrafts?: boolean;
|
|
3084
3112
|
}
|
|
3085
|
-
|
|
3113
|
+
interface CountEventsByStatusResponse {
|
|
3086
3114
|
/** Metadata for the paginated results. */
|
|
3087
3115
|
pagingMetadata?: CommonPagingMetadataV2;
|
|
3088
3116
|
/** Filter facets. */
|
|
3089
3117
|
facets?: Record<string, FacetCounts>;
|
|
3090
3118
|
}
|
|
3091
|
-
|
|
3119
|
+
interface FacetCounts {
|
|
3092
3120
|
/** Facet counts aggregated per value */
|
|
3093
3121
|
counts?: Record<string, number>;
|
|
3094
3122
|
}
|
|
3095
|
-
|
|
3123
|
+
interface ListUserEventsRequest {
|
|
3096
3124
|
/** Paging options to limit and skip the number of items. */
|
|
3097
3125
|
paging?: CommonPaging;
|
|
3098
3126
|
/**
|
|
@@ -3116,7 +3144,7 @@ export interface ListUserEventsRequest {
|
|
|
3116
3144
|
*/
|
|
3117
3145
|
facet?: string[];
|
|
3118
3146
|
}
|
|
3119
|
-
|
|
3147
|
+
interface UserFilter {
|
|
3120
3148
|
/**
|
|
3121
3149
|
* User who is related to event
|
|
3122
3150
|
* @format GUID
|
|
@@ -3129,11 +3157,11 @@ export interface UserFilter {
|
|
|
3129
3157
|
*/
|
|
3130
3158
|
relation?: Relation[];
|
|
3131
3159
|
}
|
|
3132
|
-
|
|
3160
|
+
declare enum Relation {
|
|
3133
3161
|
/** User is attending the event. The user RSVP'd with status of `YES` or has ordered tickets. */
|
|
3134
3162
|
ATTENDING = "ATTENDING"
|
|
3135
3163
|
}
|
|
3136
|
-
|
|
3164
|
+
interface ListUserEventsResponse {
|
|
3137
3165
|
/** Metadata for the paginated results. */
|
|
3138
3166
|
pagingMetadata?: CommonPagingMetadataV2;
|
|
3139
3167
|
/** List of events. */
|
|
@@ -3141,7 +3169,7 @@ export interface ListUserEventsResponse {
|
|
|
3141
3169
|
/** Filter facets. */
|
|
3142
3170
|
facets?: Record<string, FacetCounts>;
|
|
3143
3171
|
}
|
|
3144
|
-
|
|
3172
|
+
interface ListEventsByCategoryRequest {
|
|
3145
3173
|
/**
|
|
3146
3174
|
* Category ID.
|
|
3147
3175
|
* @format GUID
|
|
@@ -3155,13 +3183,13 @@ export interface ListEventsByCategoryRequest {
|
|
|
3155
3183
|
*/
|
|
3156
3184
|
fields?: RequestedFields[];
|
|
3157
3185
|
}
|
|
3158
|
-
|
|
3186
|
+
interface ListEventsByCategoryResponse {
|
|
3159
3187
|
/** Metadata for the paginated results. */
|
|
3160
3188
|
pagingMetadata?: CommonPagingMetadataV2;
|
|
3161
3189
|
/** List of events. */
|
|
3162
3190
|
events?: V3Event[];
|
|
3163
3191
|
}
|
|
3164
|
-
|
|
3192
|
+
interface GetEventRequest {
|
|
3165
3193
|
/**
|
|
3166
3194
|
* Event ID.
|
|
3167
3195
|
* @format GUID
|
|
@@ -3173,11 +3201,11 @@ export interface GetEventRequest {
|
|
|
3173
3201
|
*/
|
|
3174
3202
|
fields?: RequestedFields[];
|
|
3175
3203
|
}
|
|
3176
|
-
|
|
3204
|
+
interface GetEventResponse {
|
|
3177
3205
|
/** Event. */
|
|
3178
3206
|
event?: V3Event;
|
|
3179
3207
|
}
|
|
3180
|
-
|
|
3208
|
+
interface GetEventBySlugRequest {
|
|
3181
3209
|
/**
|
|
3182
3210
|
* URL slug.
|
|
3183
3211
|
* @minLength 1
|
|
@@ -3187,11 +3215,11 @@ export interface GetEventBySlugRequest {
|
|
|
3187
3215
|
/** @maxSize 20 */
|
|
3188
3216
|
fields?: RequestedFields[];
|
|
3189
3217
|
}
|
|
3190
|
-
|
|
3218
|
+
interface GetEventBySlugResponse {
|
|
3191
3219
|
/** Event. */
|
|
3192
3220
|
event?: V3Event;
|
|
3193
3221
|
}
|
|
3194
|
-
|
|
3222
|
+
interface FindEventRequest extends FindEventRequestFindByOneOf {
|
|
3195
3223
|
/**
|
|
3196
3224
|
* Event ID.
|
|
3197
3225
|
* @format GUID
|
|
@@ -3210,7 +3238,7 @@ export interface FindEventRequest extends FindEventRequestFindByOneOf {
|
|
|
3210
3238
|
fields?: RequestedFields[];
|
|
3211
3239
|
}
|
|
3212
3240
|
/** @oneof */
|
|
3213
|
-
|
|
3241
|
+
interface FindEventRequestFindByOneOf {
|
|
3214
3242
|
/**
|
|
3215
3243
|
* Event ID.
|
|
3216
3244
|
* @format GUID
|
|
@@ -3223,11 +3251,11 @@ export interface FindEventRequestFindByOneOf {
|
|
|
3223
3251
|
*/
|
|
3224
3252
|
slug?: string | null;
|
|
3225
3253
|
}
|
|
3226
|
-
|
|
3254
|
+
interface FindEventResponse {
|
|
3227
3255
|
/** Event. */
|
|
3228
3256
|
event?: V3Event;
|
|
3229
3257
|
}
|
|
3230
|
-
|
|
3258
|
+
interface EventCreated {
|
|
3231
3259
|
/** Event created timestamp in ISO UTC format. */
|
|
3232
3260
|
timestamp?: Date | null;
|
|
3233
3261
|
/**
|
|
@@ -3261,7 +3289,7 @@ export interface EventCreated {
|
|
|
3261
3289
|
/** Event that was created. */
|
|
3262
3290
|
event?: Event;
|
|
3263
3291
|
}
|
|
3264
|
-
|
|
3292
|
+
interface EventsLocation {
|
|
3265
3293
|
/**
|
|
3266
3294
|
* Location name.
|
|
3267
3295
|
* @maxLength 50
|
|
@@ -3293,7 +3321,7 @@ export interface EventsLocation {
|
|
|
3293
3321
|
*/
|
|
3294
3322
|
tbd?: boolean | null;
|
|
3295
3323
|
}
|
|
3296
|
-
|
|
3324
|
+
interface MapCoordinates {
|
|
3297
3325
|
/**
|
|
3298
3326
|
* Latitude.
|
|
3299
3327
|
* @min -90
|
|
@@ -3307,16 +3335,16 @@ export interface MapCoordinates {
|
|
|
3307
3335
|
*/
|
|
3308
3336
|
lng?: number;
|
|
3309
3337
|
}
|
|
3310
|
-
|
|
3338
|
+
declare enum LocationLocationType {
|
|
3311
3339
|
VENUE = "VENUE",
|
|
3312
3340
|
ONLINE = "ONLINE"
|
|
3313
3341
|
}
|
|
3314
3342
|
/** Physical address */
|
|
3315
|
-
|
|
3343
|
+
interface Address extends AddressStreetOneOf {
|
|
3316
3344
|
/** a break down of the street to number and street name */
|
|
3317
3345
|
streetAddress?: StreetAddress;
|
|
3318
3346
|
/** Main address line (usually street and number) as free text */
|
|
3319
|
-
|
|
3347
|
+
addressLine1?: string | null;
|
|
3320
3348
|
/**
|
|
3321
3349
|
* country code
|
|
3322
3350
|
* @format COUNTRY
|
|
@@ -3331,11 +3359,9 @@ export interface Address extends AddressStreetOneOf {
|
|
|
3331
3359
|
/** Free text providing more detailed address info. Usually contains Apt, Suite, Floor */
|
|
3332
3360
|
addressLine2?: string | null;
|
|
3333
3361
|
/** A string containing the human-readable address of this location */
|
|
3334
|
-
|
|
3335
|
-
/** Free text for human-to-human textual orientation aid purposes */
|
|
3336
|
-
hint?: string | null;
|
|
3362
|
+
formatted?: string | null;
|
|
3337
3363
|
/** coordinates of the physical address */
|
|
3338
|
-
|
|
3364
|
+
location?: AddressLocation;
|
|
3339
3365
|
/** country full-name */
|
|
3340
3366
|
countryFullname?: string | null;
|
|
3341
3367
|
/**
|
|
@@ -3345,19 +3371,19 @@ export interface Address extends AddressStreetOneOf {
|
|
|
3345
3371
|
subdivisions?: Subdivision[];
|
|
3346
3372
|
}
|
|
3347
3373
|
/** @oneof */
|
|
3348
|
-
|
|
3374
|
+
interface AddressStreetOneOf {
|
|
3349
3375
|
/** a break down of the street to number and street name */
|
|
3350
3376
|
streetAddress?: StreetAddress;
|
|
3351
3377
|
/** Main address line (usually street and number) as free text */
|
|
3352
3378
|
addressLine?: string | null;
|
|
3353
3379
|
}
|
|
3354
|
-
|
|
3380
|
+
interface StreetAddress {
|
|
3355
3381
|
/** street number */
|
|
3356
3382
|
number?: string;
|
|
3357
3383
|
/** street name */
|
|
3358
3384
|
name?: string;
|
|
3359
3385
|
}
|
|
3360
|
-
|
|
3386
|
+
interface AddressLocation {
|
|
3361
3387
|
/**
|
|
3362
3388
|
* address latitude coordinates
|
|
3363
3389
|
* @min -90
|
|
@@ -3371,13 +3397,13 @@ export interface AddressLocation {
|
|
|
3371
3397
|
*/
|
|
3372
3398
|
longitude?: number | null;
|
|
3373
3399
|
}
|
|
3374
|
-
|
|
3400
|
+
interface Subdivision {
|
|
3375
3401
|
/** subdivision short code */
|
|
3376
3402
|
code?: string;
|
|
3377
3403
|
/** subdivision full-name */
|
|
3378
3404
|
name?: string;
|
|
3379
3405
|
}
|
|
3380
|
-
|
|
3406
|
+
declare enum SubdivisionType {
|
|
3381
3407
|
UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
|
|
3382
3408
|
/** State */
|
|
3383
3409
|
ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
|
|
@@ -3392,7 +3418,7 @@ export declare enum SubdivisionType {
|
|
|
3392
3418
|
/** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
|
|
3393
3419
|
COUNTRY = "COUNTRY"
|
|
3394
3420
|
}
|
|
3395
|
-
|
|
3421
|
+
interface ScheduleConfig {
|
|
3396
3422
|
/**
|
|
3397
3423
|
* Defines event as TBD (To Be Determined) schedule.
|
|
3398
3424
|
* When event time is not yet defined, TBD message is displayed instead of event start and end times.
|
|
@@ -3420,7 +3446,7 @@ export interface ScheduleConfig {
|
|
|
3420
3446
|
/** Event recurrences. */
|
|
3421
3447
|
recurrences?: EventsRecurrences;
|
|
3422
3448
|
}
|
|
3423
|
-
|
|
3449
|
+
interface EventsRecurrences {
|
|
3424
3450
|
/**
|
|
3425
3451
|
* Event occurrences.
|
|
3426
3452
|
* @maxSize 1000
|
|
@@ -3437,7 +3463,7 @@ export interface EventsRecurrences {
|
|
|
3437
3463
|
*/
|
|
3438
3464
|
status?: EventsRecurrenceStatusStatus;
|
|
3439
3465
|
}
|
|
3440
|
-
|
|
3466
|
+
interface EventsOccurrence {
|
|
3441
3467
|
/** Event start timestamp. */
|
|
3442
3468
|
startDate?: Date | null;
|
|
3443
3469
|
/** Event end timestamp. */
|
|
@@ -3450,7 +3476,7 @@ export interface EventsOccurrence {
|
|
|
3450
3476
|
/** Whether time zone is displayed in formatted schedule. */
|
|
3451
3477
|
showTimeZone?: boolean;
|
|
3452
3478
|
}
|
|
3453
|
-
|
|
3479
|
+
declare enum EventsRecurrenceStatusStatus {
|
|
3454
3480
|
/** Event occurs only once. */
|
|
3455
3481
|
ONE_TIME = "ONE_TIME",
|
|
3456
3482
|
/** Event is recurring. */
|
|
@@ -3462,7 +3488,7 @@ export declare enum EventsRecurrenceStatusStatus {
|
|
|
3462
3488
|
/** Marks the most recent canceled occurrence of the recurring event. */
|
|
3463
3489
|
RECURRING_LAST_CANCELED = "RECURRING_LAST_CANCELED"
|
|
3464
3490
|
}
|
|
3465
|
-
|
|
3491
|
+
declare enum EventStatus {
|
|
3466
3492
|
/** Event is public and scheduled to start */
|
|
3467
3493
|
SCHEDULED = "SCHEDULED",
|
|
3468
3494
|
/** Event has started */
|
|
@@ -3472,13 +3498,13 @@ export declare enum EventStatus {
|
|
|
3472
3498
|
/** Event was canceled */
|
|
3473
3499
|
CANCELED = "CANCELED"
|
|
3474
3500
|
}
|
|
3475
|
-
|
|
3501
|
+
interface Event {
|
|
3476
3502
|
/**
|
|
3477
3503
|
* Event ID.
|
|
3478
3504
|
* @format GUID
|
|
3479
3505
|
* @readonly
|
|
3480
3506
|
*/
|
|
3481
|
-
|
|
3507
|
+
_id?: string;
|
|
3482
3508
|
/** Event location. */
|
|
3483
3509
|
location?: EventsLocation;
|
|
3484
3510
|
/** Event scheduling. */
|
|
@@ -3490,7 +3516,7 @@ export interface Event {
|
|
|
3490
3516
|
/** Rich-text content that are displayed in a site's "About Event" section (HTML). */
|
|
3491
3517
|
about?: string;
|
|
3492
3518
|
/** Main event image. */
|
|
3493
|
-
mainImage?:
|
|
3519
|
+
mainImage?: string;
|
|
3494
3520
|
/** Event slug URL (generated from event title). */
|
|
3495
3521
|
slug?: string;
|
|
3496
3522
|
/** ISO 639-1 language code of the event (used in content translations). */
|
|
@@ -3542,7 +3568,7 @@ export interface Event {
|
|
|
3542
3568
|
*/
|
|
3543
3569
|
publishedDate?: Date | null;
|
|
3544
3570
|
}
|
|
3545
|
-
|
|
3571
|
+
interface Scheduling {
|
|
3546
3572
|
/** Schedule configuration. */
|
|
3547
3573
|
config?: ScheduleConfig;
|
|
3548
3574
|
/** Formatted schedule representation. */
|
|
@@ -3556,23 +3582,7 @@ export interface Scheduling {
|
|
|
3556
3582
|
/** Formatted end time of the event (empty for TBD schedules or when end date is hidden). */
|
|
3557
3583
|
endTimeFormatted?: string;
|
|
3558
3584
|
}
|
|
3559
|
-
|
|
3560
|
-
/**
|
|
3561
|
-
* WixMedia image ID.
|
|
3562
|
-
* @minLength 1
|
|
3563
|
-
* @maxLength 200
|
|
3564
|
-
*/
|
|
3565
|
-
id?: string | null;
|
|
3566
|
-
/** Image URL. */
|
|
3567
|
-
url?: string;
|
|
3568
|
-
/** Original image height. */
|
|
3569
|
-
height?: number | null;
|
|
3570
|
-
/** Original image width. */
|
|
3571
|
-
width?: number | null;
|
|
3572
|
-
/** Image alt text. Optional. */
|
|
3573
|
-
altText?: string | null;
|
|
3574
|
-
}
|
|
3575
|
-
export interface EventsRegistration {
|
|
3585
|
+
interface EventsRegistration {
|
|
3576
3586
|
/** Event type. */
|
|
3577
3587
|
type?: EventType;
|
|
3578
3588
|
/** Event registration status. */
|
|
@@ -3588,7 +3598,7 @@ export interface EventsRegistration {
|
|
|
3588
3598
|
/** Initial event type which was set when creating an event. */
|
|
3589
3599
|
initialType?: EventType;
|
|
3590
3600
|
}
|
|
3591
|
-
|
|
3601
|
+
declare enum EventType {
|
|
3592
3602
|
/** Type not available for this request fieldset */
|
|
3593
3603
|
NA_EVENT_TYPE = "NA_EVENT_TYPE",
|
|
3594
3604
|
/** Registration via RSVP */
|
|
@@ -3600,7 +3610,7 @@ export declare enum EventType {
|
|
|
3600
3610
|
/** Registration not available */
|
|
3601
3611
|
NO_REGISTRATION = "NO_REGISTRATION"
|
|
3602
3612
|
}
|
|
3603
|
-
|
|
3613
|
+
declare enum RegistrationStatus {
|
|
3604
3614
|
/** Registration status is not applicable */
|
|
3605
3615
|
NA_REGISTRATION_STATUS = "NA_REGISTRATION_STATUS",
|
|
3606
3616
|
/** Registration to event is closed */
|
|
@@ -3618,11 +3628,11 @@ export declare enum RegistrationStatus {
|
|
|
3618
3628
|
/** Registration will be open via RSVP */
|
|
3619
3629
|
SCHEDULED_RSVP = "SCHEDULED_RSVP"
|
|
3620
3630
|
}
|
|
3621
|
-
|
|
3631
|
+
interface RsvpCollection {
|
|
3622
3632
|
/** RSVP collection configuration. */
|
|
3623
3633
|
config?: RsvpCollectionConfig;
|
|
3624
3634
|
}
|
|
3625
|
-
|
|
3635
|
+
interface RsvpCollectionConfig {
|
|
3626
3636
|
/** Defines the supported RSVP statuses. */
|
|
3627
3637
|
rsvpStatusOptions?: RsvpStatusOptions;
|
|
3628
3638
|
/**
|
|
@@ -3637,13 +3647,13 @@ export interface RsvpCollectionConfig {
|
|
|
3637
3647
|
/** Registration end timestamp. */
|
|
3638
3648
|
endDate?: Date | null;
|
|
3639
3649
|
}
|
|
3640
|
-
|
|
3650
|
+
declare enum RsvpStatusOptions {
|
|
3641
3651
|
/** Only YES RSVP status is available for RSVP registration */
|
|
3642
3652
|
YES_ONLY = "YES_ONLY",
|
|
3643
3653
|
/** YES and NO RSVP status options are available for the registration */
|
|
3644
3654
|
YES_AND_NO = "YES_AND_NO"
|
|
3645
3655
|
}
|
|
3646
|
-
|
|
3656
|
+
interface Ticketing {
|
|
3647
3657
|
/**
|
|
3648
3658
|
* Deprecated.
|
|
3649
3659
|
* @deprecated
|
|
@@ -3684,7 +3694,7 @@ export interface Ticketing {
|
|
|
3684
3694
|
*/
|
|
3685
3695
|
soldOut?: boolean | null;
|
|
3686
3696
|
}
|
|
3687
|
-
|
|
3697
|
+
interface TicketingConfig {
|
|
3688
3698
|
/** Whether the form must be filled out separately for each ticket. */
|
|
3689
3699
|
guestAssignedTickets?: boolean;
|
|
3690
3700
|
/** Tax configuration. */
|
|
@@ -3701,7 +3711,7 @@ export interface TicketingConfig {
|
|
|
3701
3711
|
*/
|
|
3702
3712
|
reservationDurationInMinutes?: number | null;
|
|
3703
3713
|
}
|
|
3704
|
-
|
|
3714
|
+
interface TaxConfig {
|
|
3705
3715
|
/** Tax application settings. */
|
|
3706
3716
|
type?: EventsTaxType;
|
|
3707
3717
|
/**
|
|
@@ -3718,7 +3728,7 @@ export interface TaxConfig {
|
|
|
3718
3728
|
/** Applies taxes for donations, default true. */
|
|
3719
3729
|
appliesToDonations?: boolean | null;
|
|
3720
3730
|
}
|
|
3721
|
-
|
|
3731
|
+
declare enum EventsTaxType {
|
|
3722
3732
|
/** Tax is included in the ticket price. */
|
|
3723
3733
|
INCLUDED = "INCLUDED",
|
|
3724
3734
|
/** Tax is added to the order at the checkout. */
|
|
@@ -3726,11 +3736,11 @@ export declare enum EventsTaxType {
|
|
|
3726
3736
|
/** Tax is added to the final total at the checkout. */
|
|
3727
3737
|
ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
|
|
3728
3738
|
}
|
|
3729
|
-
|
|
3739
|
+
interface ExternalEvent {
|
|
3730
3740
|
/** External event registration URL. */
|
|
3731
3741
|
registration?: string;
|
|
3732
3742
|
}
|
|
3733
|
-
|
|
3743
|
+
declare enum VisitorType {
|
|
3734
3744
|
/** Site visitor (including member) */
|
|
3735
3745
|
VISITOR = "VISITOR",
|
|
3736
3746
|
/** Site member */
|
|
@@ -3738,14 +3748,14 @@ export declare enum VisitorType {
|
|
|
3738
3748
|
/** Site visitor or member */
|
|
3739
3749
|
VISITOR_OR_MEMBER = "VISITOR_OR_MEMBER"
|
|
3740
3750
|
}
|
|
3741
|
-
|
|
3751
|
+
interface CalendarLinks {
|
|
3742
3752
|
/** "Add to Google calendar" URL. */
|
|
3743
3753
|
google?: string;
|
|
3744
3754
|
/** "Download ICS calendar file" URL. */
|
|
3745
3755
|
ics?: string;
|
|
3746
3756
|
}
|
|
3747
3757
|
/** Site URL components */
|
|
3748
|
-
|
|
3758
|
+
interface SiteUrl {
|
|
3749
3759
|
/**
|
|
3750
3760
|
* Base URL. For premium sites, this will be the domain.
|
|
3751
3761
|
* For free sites, this would be site URL (e.g `mysite.wixsite.com/mysite`)
|
|
@@ -3754,7 +3764,7 @@ export interface SiteUrl {
|
|
|
3754
3764
|
/** The path to that page - e.g `/my-events/weekly-meetup-2` */
|
|
3755
3765
|
path?: string;
|
|
3756
3766
|
}
|
|
3757
|
-
|
|
3767
|
+
interface Dashboard {
|
|
3758
3768
|
/** Guest RSVP summary. */
|
|
3759
3769
|
rsvpSummary?: RsvpSummary;
|
|
3760
3770
|
/**
|
|
@@ -3763,7 +3773,7 @@ export interface Dashboard {
|
|
|
3763
3773
|
*/
|
|
3764
3774
|
ticketingSummary?: TicketingSummary;
|
|
3765
3775
|
}
|
|
3766
|
-
|
|
3776
|
+
interface RsvpSummary {
|
|
3767
3777
|
/** Total number of RSVPs. */
|
|
3768
3778
|
total?: number;
|
|
3769
3779
|
/** Number of RSVPs with status `YES`. */
|
|
@@ -3773,7 +3783,7 @@ export interface RsvpSummary {
|
|
|
3773
3783
|
/** Number of RSVPs in waitlist. */
|
|
3774
3784
|
waitlist?: number;
|
|
3775
3785
|
}
|
|
3776
|
-
|
|
3786
|
+
interface TicketingSummary {
|
|
3777
3787
|
/** Number of tickets sold. */
|
|
3778
3788
|
tickets?: number;
|
|
3779
3789
|
/**
|
|
@@ -3788,19 +3798,19 @@ export interface TicketingSummary {
|
|
|
3788
3798
|
/** Total balance of confirmed transactions. */
|
|
3789
3799
|
totalSales?: EventsMoney;
|
|
3790
3800
|
}
|
|
3791
|
-
|
|
3801
|
+
interface GuestListConfig {
|
|
3792
3802
|
/** Whether members can see other members attending the event (defaults to true). */
|
|
3793
3803
|
publicGuestList?: boolean;
|
|
3794
3804
|
}
|
|
3795
|
-
|
|
3805
|
+
interface EventsFeed {
|
|
3796
3806
|
/** Event discussion feed token. */
|
|
3797
3807
|
token?: string;
|
|
3798
3808
|
}
|
|
3799
|
-
|
|
3809
|
+
interface EventsOnlineConferencing {
|
|
3800
3810
|
config?: OnlineConferencingConfig;
|
|
3801
3811
|
session?: EventsOnlineConferencingSession;
|
|
3802
3812
|
}
|
|
3803
|
-
|
|
3813
|
+
interface OnlineConferencingConfig {
|
|
3804
3814
|
/**
|
|
3805
3815
|
* Whether online conferencing is enabled (not supported for TBD schedules).
|
|
3806
3816
|
* When enabled, links to join conferencing are generated and provided to guests.
|
|
@@ -3814,13 +3824,13 @@ export interface OnlineConferencingConfig {
|
|
|
3814
3824
|
/** Conference type */
|
|
3815
3825
|
conferenceType?: ConferenceType;
|
|
3816
3826
|
}
|
|
3817
|
-
|
|
3827
|
+
declare enum ConferenceType {
|
|
3818
3828
|
/** Everyone in the meeting can publish and subscribe video and audio. */
|
|
3819
3829
|
MEETING = "MEETING",
|
|
3820
3830
|
/** Guests can only subscribe to video and audio. */
|
|
3821
3831
|
WEBINAR = "WEBINAR"
|
|
3822
3832
|
}
|
|
3823
|
-
|
|
3833
|
+
interface EventsOnlineConferencingSession {
|
|
3824
3834
|
/**
|
|
3825
3835
|
* Link for event host to start the online conference session.
|
|
3826
3836
|
* @readonly
|
|
@@ -3847,7 +3857,7 @@ export interface EventsOnlineConferencingSession {
|
|
|
3847
3857
|
*/
|
|
3848
3858
|
sessionId?: string | null;
|
|
3849
3859
|
}
|
|
3850
|
-
|
|
3860
|
+
interface EventsSeoSettings {
|
|
3851
3861
|
/**
|
|
3852
3862
|
* URL slug
|
|
3853
3863
|
* @maxLength 130
|
|
@@ -3861,7 +3871,7 @@ export interface EventsSeoSettings {
|
|
|
3861
3871
|
*/
|
|
3862
3872
|
hidden?: boolean | null;
|
|
3863
3873
|
}
|
|
3864
|
-
|
|
3874
|
+
interface Agenda {
|
|
3865
3875
|
/** Whether the schedule is enabled for the event. */
|
|
3866
3876
|
enabled?: boolean;
|
|
3867
3877
|
/**
|
|
@@ -3870,13 +3880,13 @@ export interface Agenda {
|
|
|
3870
3880
|
*/
|
|
3871
3881
|
pageUrl?: SiteUrl;
|
|
3872
3882
|
}
|
|
3873
|
-
|
|
3883
|
+
interface Category {
|
|
3874
3884
|
/**
|
|
3875
3885
|
* Category ID.
|
|
3876
3886
|
* @format GUID
|
|
3877
3887
|
* @readonly
|
|
3878
3888
|
*/
|
|
3879
|
-
|
|
3889
|
+
_id?: string;
|
|
3880
3890
|
/**
|
|
3881
3891
|
* Category name.
|
|
3882
3892
|
* @minLength 1
|
|
@@ -3887,7 +3897,7 @@ export interface Category {
|
|
|
3887
3897
|
* Date and time when category was created.
|
|
3888
3898
|
* @readonly
|
|
3889
3899
|
*/
|
|
3890
|
-
|
|
3900
|
+
_createdDate?: Date | null;
|
|
3891
3901
|
/**
|
|
3892
3902
|
* The total number of draft and published events assigned to the category.
|
|
3893
3903
|
* @readonly
|
|
@@ -3908,13 +3918,13 @@ export interface Category {
|
|
|
3908
3918
|
*/
|
|
3909
3919
|
states?: State[];
|
|
3910
3920
|
}
|
|
3911
|
-
|
|
3921
|
+
interface CategoryCounts {
|
|
3912
3922
|
/** Total number of draft events assigned to the category. */
|
|
3913
3923
|
assignedEventsCount?: number | null;
|
|
3914
3924
|
/** Total number of published events assigned to the category. Deleted events are excluded. */
|
|
3915
3925
|
assignedDraftEventsCount?: number | null;
|
|
3916
3926
|
}
|
|
3917
|
-
|
|
3927
|
+
declare enum State {
|
|
3918
3928
|
/** Created manually by the user. */
|
|
3919
3929
|
MANUAL = "MANUAL",
|
|
3920
3930
|
/** Created automatically. */
|
|
@@ -3924,15 +3934,15 @@ export declare enum State {
|
|
|
3924
3934
|
/** Category is hidden. */
|
|
3925
3935
|
HIDDEN = "HIDDEN"
|
|
3926
3936
|
}
|
|
3927
|
-
|
|
3937
|
+
interface EventDisplaySettings {
|
|
3928
3938
|
/** Whether event details button is hidden. Only available for events with no registration. */
|
|
3929
3939
|
hideEventDetailsButton?: boolean | null;
|
|
3930
3940
|
/** Disables event details page visibility. If event has an external registration configured visitors will be redirected from this page. */
|
|
3931
3941
|
hideEventDetailsPage?: boolean | null;
|
|
3932
3942
|
}
|
|
3933
|
-
|
|
3943
|
+
interface EventsLabellingSettings {
|
|
3934
3944
|
}
|
|
3935
|
-
|
|
3945
|
+
interface Badge {
|
|
3936
3946
|
/** Badge type. */
|
|
3937
3947
|
type?: Type;
|
|
3938
3948
|
/**
|
|
@@ -3941,7 +3951,7 @@ export interface Badge {
|
|
|
3941
3951
|
*/
|
|
3942
3952
|
text?: string | null;
|
|
3943
3953
|
}
|
|
3944
|
-
|
|
3954
|
+
declare enum Type {
|
|
3945
3955
|
/** Unknown badge type. */
|
|
3946
3956
|
UNKNOWN_BADGE_TYPE = "UNKNOWN_BADGE_TYPE",
|
|
3947
3957
|
/** 1st priority badge type. */
|
|
@@ -3951,9 +3961,9 @@ export declare enum Type {
|
|
|
3951
3961
|
/** 3rd priority badge type. */
|
|
3952
3962
|
THIRD_PRIORITY = "THIRD_PRIORITY"
|
|
3953
3963
|
}
|
|
3954
|
-
|
|
3964
|
+
interface Empty {
|
|
3955
3965
|
}
|
|
3956
|
-
|
|
3966
|
+
interface EventUpdated {
|
|
3957
3967
|
/** Event update timestamp in ISO UTC format. */
|
|
3958
3968
|
timestamp?: Date | null;
|
|
3959
3969
|
/**
|
|
@@ -3975,7 +3985,7 @@ export interface EventUpdated {
|
|
|
3975
3985
|
/** Updated event */
|
|
3976
3986
|
event?: Event;
|
|
3977
3987
|
}
|
|
3978
|
-
|
|
3988
|
+
interface EventDeleted {
|
|
3979
3989
|
/** Event deleted timestamp in ISO UTC format. */
|
|
3980
3990
|
timestamp?: Date | null;
|
|
3981
3991
|
/**
|
|
@@ -3991,7 +4001,7 @@ export interface EventDeleted {
|
|
|
3991
4001
|
*/
|
|
3992
4002
|
userId?: string | null;
|
|
3993
4003
|
}
|
|
3994
|
-
|
|
4004
|
+
interface EventCopied {
|
|
3995
4005
|
/** Event created timestamp in ISO UTC format. */
|
|
3996
4006
|
timestamp?: Date | null;
|
|
3997
4007
|
/**
|
|
@@ -4029,7 +4039,7 @@ export interface EventCopied {
|
|
|
4029
4039
|
*/
|
|
4030
4040
|
ticketDefinitions?: Record<string, string>;
|
|
4031
4041
|
}
|
|
4032
|
-
|
|
4042
|
+
interface EventPublished {
|
|
4033
4043
|
/** Event publish timestamp in ISO UTC format. */
|
|
4034
4044
|
timestamp?: Date | null;
|
|
4035
4045
|
/**
|
|
@@ -4057,7 +4067,7 @@ export interface EventPublished {
|
|
|
4057
4067
|
/** RSVP or ticketing registration details. */
|
|
4058
4068
|
registration?: EventsRegistration;
|
|
4059
4069
|
}
|
|
4060
|
-
|
|
4070
|
+
interface EventCanceled {
|
|
4061
4071
|
/** Event canceled timestamp in ISO UTC format. */
|
|
4062
4072
|
timestamp?: Date | null;
|
|
4063
4073
|
/**
|
|
@@ -4075,7 +4085,7 @@ export interface EventCanceled {
|
|
|
4075
4085
|
/** True if at least one guest is registered to the event with any attendance status. */
|
|
4076
4086
|
hasGuests?: boolean | null;
|
|
4077
4087
|
}
|
|
4078
|
-
|
|
4088
|
+
interface EventStarted {
|
|
4079
4089
|
/** Event start timestamp in ISO UTC format. */
|
|
4080
4090
|
timestamp?: Date | null;
|
|
4081
4091
|
/**
|
|
@@ -4086,7 +4096,7 @@ export interface EventStarted {
|
|
|
4086
4096
|
/** True if at least one guest is registered to the event with any attendance status. */
|
|
4087
4097
|
hasGuests?: boolean | null;
|
|
4088
4098
|
}
|
|
4089
|
-
|
|
4099
|
+
interface EventEnded {
|
|
4090
4100
|
/** Event end timestamp in ISO UTC format. */
|
|
4091
4101
|
timestamp?: Date | null;
|
|
4092
4102
|
/**
|
|
@@ -4097,7 +4107,7 @@ export interface EventEnded {
|
|
|
4097
4107
|
/** True if at least one guest is registered to the event with any attendance status. */
|
|
4098
4108
|
hasGuests?: boolean | null;
|
|
4099
4109
|
}
|
|
4100
|
-
|
|
4110
|
+
interface EventReminder {
|
|
4101
4111
|
/** Reminder timestamp in ISO UTC format. */
|
|
4102
4112
|
timestamp?: Date | null;
|
|
4103
4113
|
/**
|
|
@@ -4121,7 +4131,7 @@ export interface EventReminder {
|
|
|
4121
4131
|
/** True if at least one guest is registered to the event with any attendance status. */
|
|
4122
4132
|
hasGuests?: boolean | null;
|
|
4123
4133
|
}
|
|
4124
|
-
|
|
4134
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
4125
4135
|
createdEvent?: EntityCreatedEvent;
|
|
4126
4136
|
updatedEvent?: EntityUpdatedEvent;
|
|
4127
4137
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -4130,7 +4140,7 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
4130
4140
|
* Unique event ID.
|
|
4131
4141
|
* Allows clients to ignore duplicate webhooks.
|
|
4132
4142
|
*/
|
|
4133
|
-
|
|
4143
|
+
_id?: string;
|
|
4134
4144
|
/**
|
|
4135
4145
|
* Assumes actions are also always typed to an entity_type
|
|
4136
4146
|
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
@@ -4164,36 +4174,34 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
4164
4174
|
entityEventSequence?: string | null;
|
|
4165
4175
|
}
|
|
4166
4176
|
/** @oneof */
|
|
4167
|
-
|
|
4177
|
+
interface DomainEventBodyOneOf {
|
|
4168
4178
|
createdEvent?: EntityCreatedEvent;
|
|
4169
4179
|
updatedEvent?: EntityUpdatedEvent;
|
|
4170
4180
|
deletedEvent?: EntityDeletedEvent;
|
|
4171
4181
|
actionEvent?: ActionEvent;
|
|
4172
4182
|
}
|
|
4173
|
-
|
|
4174
|
-
|
|
4175
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
4176
|
-
restoreInfo?: RestoreInfo;
|
|
4183
|
+
interface EntityCreatedEvent {
|
|
4184
|
+
entity?: string;
|
|
4177
4185
|
}
|
|
4178
|
-
|
|
4186
|
+
interface RestoreInfo {
|
|
4179
4187
|
deletedDate?: Date | null;
|
|
4180
4188
|
}
|
|
4181
|
-
|
|
4189
|
+
interface EntityUpdatedEvent {
|
|
4182
4190
|
/**
|
|
4183
4191
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
4184
4192
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
4185
4193
|
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
4186
4194
|
*/
|
|
4187
|
-
|
|
4195
|
+
currentEntity?: string;
|
|
4188
4196
|
}
|
|
4189
|
-
|
|
4197
|
+
interface EntityDeletedEvent {
|
|
4190
4198
|
/** Entity that was deleted */
|
|
4191
|
-
|
|
4199
|
+
deletedEntity?: string | null;
|
|
4192
4200
|
}
|
|
4193
|
-
|
|
4194
|
-
|
|
4201
|
+
interface ActionEvent {
|
|
4202
|
+
body?: string;
|
|
4195
4203
|
}
|
|
4196
|
-
|
|
4204
|
+
interface MessageEnvelope {
|
|
4197
4205
|
/**
|
|
4198
4206
|
* App instance ID.
|
|
4199
4207
|
* @format GUID
|
|
@@ -4209,7 +4217,7 @@ export interface MessageEnvelope {
|
|
|
4209
4217
|
/** Stringify payload. */
|
|
4210
4218
|
data?: string;
|
|
4211
4219
|
}
|
|
4212
|
-
|
|
4220
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
4213
4221
|
/**
|
|
4214
4222
|
* ID of a site visitor that has not logged in to the site.
|
|
4215
4223
|
* @format GUID
|
|
@@ -4234,7 +4242,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
4234
4242
|
identityType?: WebhookIdentityType;
|
|
4235
4243
|
}
|
|
4236
4244
|
/** @oneof */
|
|
4237
|
-
|
|
4245
|
+
interface IdentificationDataIdOneOf {
|
|
4238
4246
|
/**
|
|
4239
4247
|
* ID of a site visitor that has not logged in to the site.
|
|
4240
4248
|
* @format GUID
|
|
@@ -4256,545 +4264,374 @@ export interface IdentificationDataIdOneOf {
|
|
|
4256
4264
|
*/
|
|
4257
4265
|
appId?: string;
|
|
4258
4266
|
}
|
|
4259
|
-
|
|
4267
|
+
declare enum WebhookIdentityType {
|
|
4260
4268
|
UNKNOWN = "UNKNOWN",
|
|
4261
4269
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
4262
4270
|
MEMBER = "MEMBER",
|
|
4263
4271
|
WIX_USER = "WIX_USER",
|
|
4264
4272
|
APP = "APP"
|
|
4265
4273
|
}
|
|
4266
|
-
interface
|
|
4267
|
-
|
|
4268
|
-
|
|
4269
|
-
|
|
4270
|
-
|
|
4271
|
-
|
|
4272
|
-
|
|
4273
|
-
|
|
4274
|
-
|
|
4275
|
-
|
|
4276
|
-
|
|
4277
|
-
|
|
4278
|
-
|
|
4279
|
-
}
|
|
4280
|
-
interface LocationNonNullableFields {
|
|
4281
|
-
type: LocationType;
|
|
4282
|
-
address?: CommonAddressNonNullableFields;
|
|
4283
|
-
}
|
|
4284
|
-
interface OccurrenceNonNullableFields {
|
|
4285
|
-
showTimeZone: boolean;
|
|
4286
|
-
}
|
|
4287
|
-
interface RecurrencesNonNullableFields {
|
|
4288
|
-
individualEventDates: OccurrenceNonNullableFields[];
|
|
4289
|
-
}
|
|
4290
|
-
interface DateAndTimeSettingsNonNullableFields {
|
|
4291
|
-
recurrenceStatus: RecurrenceStatusStatus;
|
|
4292
|
-
recurringEvents?: RecurrencesNonNullableFields;
|
|
4293
|
-
}
|
|
4294
|
-
interface CommonImageNonNullableFields {
|
|
4295
|
-
id: string;
|
|
4296
|
-
url: string;
|
|
4297
|
-
height: number;
|
|
4298
|
-
width: number;
|
|
4299
|
-
}
|
|
4300
|
-
interface RsvpRegistrationNonNullableFields {
|
|
4301
|
-
responseType: ResponseType;
|
|
4302
|
-
waitlistEnabled: boolean;
|
|
4303
|
-
}
|
|
4304
|
-
interface MoneyNonNullableFields {
|
|
4305
|
-
value: string;
|
|
4306
|
-
currency: string;
|
|
4307
|
-
}
|
|
4308
|
-
interface TaxSettingsNonNullableFields {
|
|
4309
|
-
type: TaxType;
|
|
4310
|
-
}
|
|
4311
|
-
interface TicketsRegistrationNonNullableFields {
|
|
4312
|
-
guestsAssignedSeparately: boolean;
|
|
4313
|
-
ticketLimitPerOrder: number;
|
|
4314
|
-
lowestPrice?: MoneyNonNullableFields;
|
|
4315
|
-
highestPrice?: MoneyNonNullableFields;
|
|
4316
|
-
taxSettings?: TaxSettingsNonNullableFields;
|
|
4317
|
-
}
|
|
4318
|
-
interface RegistrationNonNullableFields {
|
|
4319
|
-
type: RegistrationTypeType;
|
|
4320
|
-
status: RegistrationStatusStatus;
|
|
4321
|
-
rsvp?: RsvpRegistrationNonNullableFields;
|
|
4322
|
-
tickets?: TicketsRegistrationNonNullableFields;
|
|
4323
|
-
allowedGuestTypes: GuestTypeType;
|
|
4324
|
-
initialType: InitialRegistrationTypeType;
|
|
4325
|
-
registrationPaused: boolean;
|
|
4326
|
-
registrationDisabled: boolean;
|
|
4327
|
-
}
|
|
4328
|
-
interface CalendarUrlsNonNullableFields {
|
|
4329
|
-
google: string;
|
|
4330
|
-
ics: string;
|
|
4331
|
-
}
|
|
4332
|
-
interface PageUrlNonNullableFields {
|
|
4333
|
-
base: string;
|
|
4334
|
-
path: string;
|
|
4335
|
-
}
|
|
4336
|
-
interface OptionSelectionNonNullableFields {
|
|
4337
|
-
optionIndex: number;
|
|
4338
|
-
placeholderText: string;
|
|
4339
|
-
}
|
|
4340
|
-
interface LabelNonNullableFields {
|
|
4341
|
-
name: string;
|
|
4342
|
-
label: string;
|
|
4343
|
-
}
|
|
4344
|
-
interface InputNonNullableFields {
|
|
4345
|
-
name: string;
|
|
4346
|
-
array: boolean;
|
|
4347
|
-
label: string;
|
|
4348
|
-
options: string[];
|
|
4349
|
-
mandatory: boolean;
|
|
4350
|
-
maxLength: number;
|
|
4351
|
-
type: ValueType;
|
|
4352
|
-
defaultOptionSelection?: OptionSelectionNonNullableFields;
|
|
4353
|
-
labels: LabelNonNullableFields[];
|
|
4354
|
-
}
|
|
4355
|
-
interface InputControlNonNullableFields {
|
|
4356
|
-
type: InputControlType;
|
|
4357
|
-
system: boolean;
|
|
4358
|
-
name: string;
|
|
4359
|
-
inputs: InputNonNullableFields[];
|
|
4360
|
-
label: string;
|
|
4361
|
-
orderIndex: number;
|
|
4362
|
-
id: string;
|
|
4363
|
-
}
|
|
4364
|
-
interface PositiveResponseConfirmationNonNullableFields {
|
|
4365
|
-
title: string;
|
|
4366
|
-
message: string;
|
|
4367
|
-
addToCalendarActionLabel: string;
|
|
4368
|
-
shareActionLabel: string;
|
|
4369
|
-
}
|
|
4370
|
-
interface PositiveNonNullableFields {
|
|
4371
|
-
title: string;
|
|
4372
|
-
confirmation?: PositiveResponseConfirmationNonNullableFields;
|
|
4373
|
-
}
|
|
4374
|
-
interface NegativeResponseConfirmationNonNullableFields {
|
|
4375
|
-
title: string;
|
|
4376
|
-
shareActionLabel: string;
|
|
4377
|
-
}
|
|
4378
|
-
interface NegativeNonNullableFields {
|
|
4379
|
-
title: string;
|
|
4380
|
-
confirmation?: NegativeResponseConfirmationNonNullableFields;
|
|
4381
|
-
}
|
|
4382
|
-
interface RsvpFormMessagesNonNullableFields {
|
|
4383
|
-
rsvpYesOption: string;
|
|
4384
|
-
rsvpNoOption: string;
|
|
4385
|
-
positiveMessages?: PositiveNonNullableFields;
|
|
4386
|
-
waitlistMessages?: PositiveNonNullableFields;
|
|
4387
|
-
negativeMessages?: NegativeNonNullableFields;
|
|
4388
|
-
submitActionLabel: string;
|
|
4389
|
-
}
|
|
4390
|
-
interface ResponseConfirmationNonNullableFields {
|
|
4391
|
-
title: string;
|
|
4392
|
-
message: string;
|
|
4393
|
-
downloadTicketsLabel: string;
|
|
4394
|
-
addToCalendarLabel: string;
|
|
4395
|
-
shareEventLabel: string;
|
|
4396
|
-
}
|
|
4397
|
-
interface CheckoutFormMessagesNonNullableFields {
|
|
4398
|
-
title: string;
|
|
4399
|
-
submitActionLabel: string;
|
|
4400
|
-
confirmation?: ResponseConfirmationNonNullableFields;
|
|
4401
|
-
}
|
|
4402
|
-
interface RegistrationClosedMessagesNonNullableFields {
|
|
4403
|
-
message: string;
|
|
4404
|
-
exploreEventsActionLabel: string;
|
|
4405
|
-
}
|
|
4406
|
-
interface TicketsUnavailableMessagesNonNullableFields {
|
|
4407
|
-
message: string;
|
|
4408
|
-
exploreEventsActionLabel: string;
|
|
4409
|
-
}
|
|
4410
|
-
interface FormMessagesNonNullableFields {
|
|
4411
|
-
rsvp?: RsvpFormMessagesNonNullableFields;
|
|
4412
|
-
checkout?: CheckoutFormMessagesNonNullableFields;
|
|
4413
|
-
registrationClosed?: RegistrationClosedMessagesNonNullableFields;
|
|
4414
|
-
ticketsUnavailable?: TicketsUnavailableMessagesNonNullableFields;
|
|
4415
|
-
}
|
|
4416
|
-
interface FormNonNullableFields {
|
|
4417
|
-
controls: InputControlNonNullableFields[];
|
|
4418
|
-
messages?: FormMessagesNonNullableFields;
|
|
4419
|
-
}
|
|
4420
|
-
interface RsvpsNonNullableFields {
|
|
4421
|
-
totalCount: number;
|
|
4422
|
-
yesCount: number;
|
|
4423
|
-
noCount: number;
|
|
4424
|
-
waitlistCount: number;
|
|
4425
|
-
}
|
|
4426
|
-
interface EventsMoneyNonNullableFields {
|
|
4427
|
-
amount: string;
|
|
4428
|
-
currency: string;
|
|
4429
|
-
}
|
|
4430
|
-
interface TicketsNonNullableFields {
|
|
4431
|
-
ticketsSold: number;
|
|
4432
|
-
revenue?: EventsMoneyNonNullableFields;
|
|
4433
|
-
currencyLocked: boolean;
|
|
4434
|
-
totalOrders: number;
|
|
4435
|
-
totalSales?: EventsMoneyNonNullableFields;
|
|
4436
|
-
}
|
|
4437
|
-
interface SummariesNonNullableFields {
|
|
4438
|
-
rsvps?: RsvpsNonNullableFields;
|
|
4439
|
-
tickets?: TicketsNonNullableFields;
|
|
4440
|
-
}
|
|
4441
|
-
interface GuestListSettingsNonNullableFields {
|
|
4442
|
-
displayedPublicly: boolean;
|
|
4443
|
-
}
|
|
4444
|
-
interface FeedNonNullableFields {
|
|
4445
|
-
token: string;
|
|
4446
|
-
}
|
|
4447
|
-
interface OnlineConferencingSessionNonNullableFields {
|
|
4448
|
-
hostLink: string;
|
|
4449
|
-
guestLink: string;
|
|
4450
|
-
}
|
|
4451
|
-
interface OnlineConferencingNonNullableFields {
|
|
4452
|
-
enabled: boolean;
|
|
4453
|
-
providerName: string;
|
|
4454
|
-
type: ConferenceTypeType;
|
|
4455
|
-
session?: OnlineConferencingSessionNonNullableFields;
|
|
4456
|
-
}
|
|
4457
|
-
interface TagNonNullableFields {
|
|
4458
|
-
type: string;
|
|
4459
|
-
children: string;
|
|
4460
|
-
custom: boolean;
|
|
4461
|
-
disabled: boolean;
|
|
4462
|
-
}
|
|
4463
|
-
interface KeywordNonNullableFields {
|
|
4464
|
-
term: string;
|
|
4465
|
-
isMain: boolean;
|
|
4466
|
-
}
|
|
4467
|
-
interface SettingsNonNullableFields {
|
|
4468
|
-
preventAutoRedirect: boolean;
|
|
4469
|
-
keywords: KeywordNonNullableFields[];
|
|
4470
|
-
}
|
|
4471
|
-
interface SeoSchemaNonNullableFields {
|
|
4472
|
-
tags: TagNonNullableFields[];
|
|
4473
|
-
settings?: SettingsNonNullableFields;
|
|
4474
|
-
}
|
|
4475
|
-
interface SeoSettingsNonNullableFields {
|
|
4476
|
-
slug: string;
|
|
4477
|
-
advancedSeoData?: SeoSchemaNonNullableFields;
|
|
4478
|
-
}
|
|
4479
|
-
interface AgendaSettingsNonNullableFields {
|
|
4480
|
-
enabled: boolean;
|
|
4481
|
-
pageUrl?: PageUrlNonNullableFields;
|
|
4482
|
-
}
|
|
4483
|
-
interface EventCategoryNonNullableFields {
|
|
4484
|
-
id: string;
|
|
4485
|
-
name: string;
|
|
4486
|
-
hidden: boolean;
|
|
4487
|
-
type: CategoryTypeType;
|
|
4488
|
-
}
|
|
4489
|
-
interface EventCategoriesNonNullableFields {
|
|
4490
|
-
categories: EventCategoryNonNullableFields[];
|
|
4491
|
-
}
|
|
4492
|
-
interface PluginContainerDataWidthNonNullableFields {
|
|
4493
|
-
size: WidthType;
|
|
4494
|
-
}
|
|
4495
|
-
interface PluginContainerDataNonNullableFields {
|
|
4496
|
-
width?: PluginContainerDataWidthNonNullableFields;
|
|
4497
|
-
alignment: PluginContainerDataAlignment;
|
|
4498
|
-
}
|
|
4499
|
-
interface LinkNonNullableFields {
|
|
4500
|
-
url: string;
|
|
4501
|
-
anchor: string;
|
|
4502
|
-
target: Target;
|
|
4503
|
-
}
|
|
4504
|
-
interface ButtonDataNonNullableFields {
|
|
4505
|
-
containerData?: PluginContainerDataNonNullableFields;
|
|
4506
|
-
type: ButtonDataType;
|
|
4507
|
-
link?: LinkNonNullableFields;
|
|
4508
|
-
}
|
|
4509
|
-
interface TextStyleNonNullableFields {
|
|
4510
|
-
textAlignment: TextAlignment;
|
|
4511
|
-
}
|
|
4512
|
-
interface CodeBlockDataNonNullableFields {
|
|
4513
|
-
textStyle?: TextStyleNonNullableFields;
|
|
4514
|
-
}
|
|
4515
|
-
interface DividerDataNonNullableFields {
|
|
4516
|
-
containerData?: PluginContainerDataNonNullableFields;
|
|
4517
|
-
lineStyle: LineStyle;
|
|
4518
|
-
width: Width;
|
|
4519
|
-
alignment: Alignment;
|
|
4520
|
-
}
|
|
4521
|
-
interface PDFSettingsNonNullableFields {
|
|
4522
|
-
viewMode: ViewMode;
|
|
4523
|
-
}
|
|
4524
|
-
interface FileDataNonNullableFields {
|
|
4525
|
-
containerData?: PluginContainerDataNonNullableFields;
|
|
4526
|
-
pdfSettings?: PDFSettingsNonNullableFields;
|
|
4527
|
-
}
|
|
4528
|
-
interface ItemImageNonNullableFields {
|
|
4529
|
-
link?: LinkNonNullableFields;
|
|
4530
|
-
}
|
|
4531
|
-
interface ItemNonNullableFields {
|
|
4532
|
-
image?: ItemImageNonNullableFields;
|
|
4533
|
-
}
|
|
4534
|
-
interface LayoutNonNullableFields {
|
|
4535
|
-
type: LayoutType;
|
|
4536
|
-
orientation: Orientation;
|
|
4537
|
-
}
|
|
4538
|
-
interface ItemStyleNonNullableFields {
|
|
4539
|
-
crop: Crop;
|
|
4540
|
-
}
|
|
4541
|
-
interface ThumbnailsNonNullableFields {
|
|
4542
|
-
placement: ThumbnailsAlignment;
|
|
4274
|
+
interface BaseEventMetadata {
|
|
4275
|
+
/**
|
|
4276
|
+
* App instance ID.
|
|
4277
|
+
* @format GUID
|
|
4278
|
+
*/
|
|
4279
|
+
instanceId?: string | null;
|
|
4280
|
+
/**
|
|
4281
|
+
* Event type.
|
|
4282
|
+
* @maxLength 150
|
|
4283
|
+
*/
|
|
4284
|
+
eventType?: string;
|
|
4285
|
+
/** The identification type and identity data. */
|
|
4286
|
+
identity?: IdentificationData;
|
|
4543
4287
|
}
|
|
4544
|
-
interface
|
|
4545
|
-
|
|
4546
|
-
|
|
4547
|
-
|
|
4288
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
4289
|
+
/**
|
|
4290
|
+
* Unique event ID.
|
|
4291
|
+
* Allows clients to ignore duplicate webhooks.
|
|
4292
|
+
*/
|
|
4293
|
+
_id?: string;
|
|
4294
|
+
/**
|
|
4295
|
+
* Assumes actions are also always typed to an entity_type
|
|
4296
|
+
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
4297
|
+
*/
|
|
4298
|
+
entityFqdn?: string;
|
|
4299
|
+
/**
|
|
4300
|
+
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
4301
|
+
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
4302
|
+
* Example: created/updated/deleted/started/completed/email_opened
|
|
4303
|
+
*/
|
|
4304
|
+
slug?: string;
|
|
4305
|
+
/** ID of the entity associated with the event. */
|
|
4306
|
+
entityId?: string;
|
|
4307
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
4308
|
+
eventTime?: Date | null;
|
|
4309
|
+
/**
|
|
4310
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
4311
|
+
* (for example, GDPR).
|
|
4312
|
+
*/
|
|
4313
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
4314
|
+
/** If present, indicates the action that triggered the event. */
|
|
4315
|
+
originatedFrom?: string | null;
|
|
4316
|
+
/**
|
|
4317
|
+
* A sequence number defining the order of updates to the underlying entity.
|
|
4318
|
+
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
4319
|
+
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
4320
|
+
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
4321
|
+
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
4322
|
+
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
4323
|
+
*/
|
|
4324
|
+
entityEventSequence?: string | null;
|
|
4548
4325
|
}
|
|
4549
|
-
interface
|
|
4550
|
-
|
|
4551
|
-
|
|
4552
|
-
options?: GalleryOptionsNonNullableFields;
|
|
4326
|
+
interface EventCanceledEnvelope {
|
|
4327
|
+
data: EventEventCanceled;
|
|
4328
|
+
metadata: EventMetadata;
|
|
4553
4329
|
}
|
|
4554
|
-
interface
|
|
4555
|
-
|
|
4556
|
-
|
|
4557
|
-
width: number;
|
|
4558
|
-
gifType: GIFType;
|
|
4330
|
+
interface EventClonedEnvelope {
|
|
4331
|
+
data: EventCloned;
|
|
4332
|
+
metadata: EventMetadata;
|
|
4559
4333
|
}
|
|
4560
|
-
interface
|
|
4561
|
-
|
|
4562
|
-
|
|
4334
|
+
interface EventCreatedEnvelope {
|
|
4335
|
+
entity: V3Event;
|
|
4336
|
+
metadata: EventMetadata;
|
|
4563
4337
|
}
|
|
4564
|
-
interface
|
|
4565
|
-
|
|
4566
|
-
html: string;
|
|
4567
|
-
containerData?: PluginContainerDataNonNullableFields;
|
|
4568
|
-
source: Source;
|
|
4338
|
+
interface EventDeletedEnvelope {
|
|
4339
|
+
metadata: EventMetadata;
|
|
4569
4340
|
}
|
|
4570
|
-
interface
|
|
4571
|
-
|
|
4572
|
-
|
|
4341
|
+
interface EventEndedEnvelope {
|
|
4342
|
+
data: EventEventEnded;
|
|
4343
|
+
metadata: EventMetadata;
|
|
4573
4344
|
}
|
|
4574
|
-
interface
|
|
4575
|
-
|
|
4345
|
+
interface EventPublishedEnvelope {
|
|
4346
|
+
data: EventEventPublished;
|
|
4347
|
+
metadata: EventMetadata;
|
|
4576
4348
|
}
|
|
4577
|
-
interface
|
|
4578
|
-
|
|
4579
|
-
|
|
4580
|
-
styles?: LinkPreviewDataStylesNonNullableFields;
|
|
4349
|
+
interface EventReminderEnvelope {
|
|
4350
|
+
data: EventEventReminder;
|
|
4351
|
+
metadata: EventMetadata;
|
|
4581
4352
|
}
|
|
4582
|
-
interface
|
|
4583
|
-
|
|
4353
|
+
interface EventStartedEnvelope {
|
|
4354
|
+
data: EventEventStarted;
|
|
4355
|
+
metadata: EventMetadata;
|
|
4584
4356
|
}
|
|
4585
|
-
interface
|
|
4586
|
-
|
|
4587
|
-
|
|
4357
|
+
interface EventUpdatedEnvelope {
|
|
4358
|
+
entity: V3Event;
|
|
4359
|
+
metadata: EventMetadata;
|
|
4588
4360
|
}
|
|
4589
|
-
interface
|
|
4590
|
-
|
|
4361
|
+
interface CreateEventOptions {
|
|
4362
|
+
/** Whether to create the event as a draft. */
|
|
4363
|
+
draft?: boolean;
|
|
4364
|
+
/**
|
|
4365
|
+
* Predefined sets of fields to return.
|
|
4366
|
+
* @maxSize 20
|
|
4367
|
+
*/
|
|
4368
|
+
fields?: RequestedFields[];
|
|
4591
4369
|
}
|
|
4592
|
-
interface
|
|
4593
|
-
|
|
4594
|
-
|
|
4370
|
+
interface CloneEventOptions {
|
|
4371
|
+
/** Field values to be changed when cloning the event. */
|
|
4372
|
+
event?: V3Event;
|
|
4373
|
+
/** Whether to clone the event as a draft. */
|
|
4374
|
+
draft?: boolean;
|
|
4375
|
+
/**
|
|
4376
|
+
* Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
|
|
4377
|
+
* @maxSize 20
|
|
4378
|
+
*/
|
|
4379
|
+
fields?: RequestedFields[];
|
|
4595
4380
|
}
|
|
4596
|
-
interface
|
|
4597
|
-
|
|
4381
|
+
interface UpdateEventOptions {
|
|
4382
|
+
/** Event to update. */
|
|
4383
|
+
event: {
|
|
4384
|
+
/**
|
|
4385
|
+
* Event ID.
|
|
4386
|
+
* @format GUID
|
|
4387
|
+
* @readonly
|
|
4388
|
+
*/
|
|
4389
|
+
_id?: string;
|
|
4390
|
+
/** Event location. */
|
|
4391
|
+
location?: Location;
|
|
4392
|
+
/** Event date and time settings. */
|
|
4393
|
+
dateAndTimeSettings?: DateAndTimeSettings;
|
|
4394
|
+
/**
|
|
4395
|
+
* Event title.
|
|
4396
|
+
* @minLength 1
|
|
4397
|
+
* @maxLength 120
|
|
4398
|
+
*/
|
|
4399
|
+
title?: string | null;
|
|
4400
|
+
/**
|
|
4401
|
+
* Short description that appears under the event title.
|
|
4402
|
+
* @maxLength 500
|
|
4403
|
+
*/
|
|
4404
|
+
shortDescription?: string | null;
|
|
4405
|
+
/**
|
|
4406
|
+
* Detailed description of an event. You can enter the description using rich text format (add various types of markups, such as underlines, italics, bolding, color codes, bullet lists, and links by using HTML formatting tags).
|
|
4407
|
+
* @maxLength 50000
|
|
4408
|
+
* @deprecated Detailed description of an event.
|
|
4409
|
+
*
|
|
4410
|
+
* This field is deprecated.
|
|
4411
|
+
* @replacedBy description
|
|
4412
|
+
* @targetRemovalDate 2025-04-15
|
|
4413
|
+
*/
|
|
4414
|
+
detailedDescription?: string | null;
|
|
4415
|
+
/**
|
|
4416
|
+
* Main event image. <br>
|
|
4417
|
+
* **Note:** This field is returned only when the `DETAILS` fieldset is included in the request.
|
|
4418
|
+
*/
|
|
4419
|
+
mainImage?: string;
|
|
4420
|
+
/**
|
|
4421
|
+
* 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".
|
|
4422
|
+
* @readonly
|
|
4423
|
+
*/
|
|
4424
|
+
slug?: string;
|
|
4425
|
+
/**
|
|
4426
|
+
* Date and time when the event was created.
|
|
4427
|
+
* @readonly
|
|
4428
|
+
*/
|
|
4429
|
+
_createdDate?: Date | null;
|
|
4430
|
+
/**
|
|
4431
|
+
* Date and time when the event was updated.
|
|
4432
|
+
* @readonly
|
|
4433
|
+
*/
|
|
4434
|
+
_updatedDate?: Date | null;
|
|
4435
|
+
/**
|
|
4436
|
+
* Event status. Possible values:
|
|
4437
|
+
*
|
|
4438
|
+
* - `UPCOMING`: The event is published and scheduled to start.
|
|
4439
|
+
* - `STARTED`: The event has started.
|
|
4440
|
+
* - `ENDED`: The event has ended.
|
|
4441
|
+
* - `CANCELED`: The event is canceled.
|
|
4442
|
+
* - `DRAFT`: The event is not published.
|
|
4443
|
+
* @readonly
|
|
4444
|
+
*/
|
|
4445
|
+
status?: Status;
|
|
4446
|
+
/**
|
|
4447
|
+
* RSVP or ticketing registration details. <br>
|
|
4448
|
+
* **Note:** This field is returned only when the `REGISTRATION` fieldset is included in the request.
|
|
4449
|
+
*/
|
|
4450
|
+
registration?: Registration;
|
|
4451
|
+
/**
|
|
4452
|
+
* URLs that allow you to add an event to the Google calendar, or to download an [ICS calendar](https://icscalendar.com/) file. <br>
|
|
4453
|
+
* **Note:** This field is returned only when the `DETAILS` fieldset is included in the request.
|
|
4454
|
+
* @readonly
|
|
4455
|
+
*/
|
|
4456
|
+
calendarUrls?: CalendarUrls;
|
|
4457
|
+
/**
|
|
4458
|
+
* Event page URL components. <br>
|
|
4459
|
+
* **Note:** This field is returned only when the `URLS` fieldset is included in the request.
|
|
4460
|
+
*/
|
|
4461
|
+
eventPageUrl?: string;
|
|
4462
|
+
/**
|
|
4463
|
+
* Event registration form. <br>
|
|
4464
|
+
* **Note:** This field is returned only when the `FORM` fieldset is included in the request.
|
|
4465
|
+
*/
|
|
4466
|
+
form?: Form;
|
|
4467
|
+
/**
|
|
4468
|
+
* Summary of RSVP or ticket sales. <br>
|
|
4469
|
+
* **Note:** This field is returned only when the `DASHBOARD` fieldset is included in the request and you have the "WIX_EVENTS.READ_EVENT_DASHBOARD" permissions.
|
|
4470
|
+
*/
|
|
4471
|
+
summaries?: Summaries;
|
|
4472
|
+
/**
|
|
4473
|
+
* Instance ID of the site where the event is hosted.
|
|
4474
|
+
* @readonly
|
|
4475
|
+
*/
|
|
4476
|
+
instanceId?: string;
|
|
4477
|
+
/** Guest list configuration. */
|
|
4478
|
+
guestListSettings?: GuestListSettings;
|
|
4479
|
+
/**
|
|
4480
|
+
* ID of the user who created the event.
|
|
4481
|
+
* @readonly
|
|
4482
|
+
* @format GUID
|
|
4483
|
+
*/
|
|
4484
|
+
userId?: string;
|
|
4485
|
+
/**
|
|
4486
|
+
* Online conferencing details. <br>
|
|
4487
|
+
* **Note:** This field is returned only when the `ONLINE_CONFERENCING_SESSION` fieldset is included in the request and you have the "WIX_EVENTS.READ_ONLINE_CONFERENCING" permissions.
|
|
4488
|
+
*/
|
|
4489
|
+
onlineConferencing?: OnlineConferencing;
|
|
4490
|
+
/**
|
|
4491
|
+
* SEO settings. <br>
|
|
4492
|
+
* **Note:** This field is returned only when the `SEO_SETTINGS` fieldset is included in the request.
|
|
4493
|
+
*/
|
|
4494
|
+
seoSettings?: SeoSettings;
|
|
4495
|
+
/**
|
|
4496
|
+
* Assigned contacts label key.
|
|
4497
|
+
* @readonly
|
|
4498
|
+
*/
|
|
4499
|
+
contactLabel?: string | null;
|
|
4500
|
+
/**
|
|
4501
|
+
* Event schedule details. <br>
|
|
4502
|
+
* **Note:** This field is returned only when the `AGENDA` fieldset is included in the request.
|
|
4503
|
+
*/
|
|
4504
|
+
agendaSettings?: AgendaSettings;
|
|
4505
|
+
/** Visual settings for event. */
|
|
4506
|
+
eventDisplaySettings?: V3EventDisplaySettings;
|
|
4507
|
+
/**
|
|
4508
|
+
* Event description with rich content.
|
|
4509
|
+
*
|
|
4510
|
+
* For the event description to appear on your site, connect the [Rich Content Viewer](https://dev.wix.com/docs/velo/velo-only-apis/$w/rich-content-viewer/introduction) element, and assign the description value to the viewer.
|
|
4511
|
+
*/
|
|
4512
|
+
description?: RichContent;
|
|
4513
|
+
/**
|
|
4514
|
+
* Event publish timestamp.
|
|
4515
|
+
* @readonly
|
|
4516
|
+
*/
|
|
4517
|
+
publishedDate?: Date | null;
|
|
4518
|
+
};
|
|
4519
|
+
/**
|
|
4520
|
+
* Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
|
|
4521
|
+
* @maxSize 20
|
|
4522
|
+
*/
|
|
4523
|
+
fields?: RequestedFields[];
|
|
4598
4524
|
}
|
|
4599
|
-
interface
|
|
4600
|
-
|
|
4525
|
+
interface PublishDraftEventOptions {
|
|
4526
|
+
/**
|
|
4527
|
+
* Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
|
|
4528
|
+
* @maxSize 20
|
|
4529
|
+
*/
|
|
4530
|
+
fields?: RequestedFields[];
|
|
4601
4531
|
}
|
|
4602
|
-
interface
|
|
4603
|
-
|
|
4604
|
-
|
|
4532
|
+
interface CancelEventOptions {
|
|
4533
|
+
/**
|
|
4534
|
+
* Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
|
|
4535
|
+
* @maxSize 20
|
|
4536
|
+
*/
|
|
4537
|
+
fields?: RequestedFields[];
|
|
4605
4538
|
}
|
|
4606
|
-
interface
|
|
4607
|
-
|
|
4539
|
+
interface BulkCancelEventsByFilterOptions {
|
|
4540
|
+
/** Filter. */
|
|
4541
|
+
filter?: CommonQueryV2;
|
|
4608
4542
|
}
|
|
4609
|
-
interface
|
|
4610
|
-
|
|
4611
|
-
|
|
4612
|
-
interface PollDesignNonNullableFields {
|
|
4613
|
-
background?: BackgroundNonNullableFields;
|
|
4614
|
-
}
|
|
4615
|
-
interface DesignNonNullableFields {
|
|
4616
|
-
poll?: PollDesignNonNullableFields;
|
|
4617
|
-
}
|
|
4618
|
-
interface PollDataNonNullableFields {
|
|
4619
|
-
containerData?: PluginContainerDataNonNullableFields;
|
|
4620
|
-
poll?: PollNonNullableFields;
|
|
4621
|
-
layout?: PollDataLayoutNonNullableFields;
|
|
4622
|
-
design?: DesignNonNullableFields;
|
|
4623
|
-
}
|
|
4624
|
-
interface AnchorDataNonNullableFields {
|
|
4625
|
-
anchor: string;
|
|
4626
|
-
}
|
|
4627
|
-
interface LinkDataNonNullableFields {
|
|
4628
|
-
link?: LinkNonNullableFields;
|
|
4629
|
-
}
|
|
4630
|
-
interface MentionDataNonNullableFields {
|
|
4631
|
-
name: string;
|
|
4632
|
-
slug: string;
|
|
4633
|
-
}
|
|
4634
|
-
interface FontSizeDataNonNullableFields {
|
|
4635
|
-
unit: FontType;
|
|
4636
|
-
}
|
|
4637
|
-
interface DecorationNonNullableFields {
|
|
4638
|
-
anchorData?: AnchorDataNonNullableFields;
|
|
4639
|
-
linkData?: LinkDataNonNullableFields;
|
|
4640
|
-
mentionData?: MentionDataNonNullableFields;
|
|
4641
|
-
fontSizeData?: FontSizeDataNonNullableFields;
|
|
4642
|
-
type: DecorationType;
|
|
4643
|
-
}
|
|
4644
|
-
interface TextDataNonNullableFields {
|
|
4645
|
-
text: string;
|
|
4646
|
-
decorations: DecorationNonNullableFields[];
|
|
4647
|
-
}
|
|
4648
|
-
interface AppEmbedDataNonNullableFields {
|
|
4649
|
-
type: AppType;
|
|
4650
|
-
}
|
|
4651
|
-
interface VideoDataNonNullableFields {
|
|
4652
|
-
containerData?: PluginContainerDataNonNullableFields;
|
|
4653
|
-
}
|
|
4654
|
-
interface EmbedDataNonNullableFields {
|
|
4655
|
-
containerData?: PluginContainerDataNonNullableFields;
|
|
4656
|
-
}
|
|
4657
|
-
interface CollapsibleListDataNonNullableFields {
|
|
4658
|
-
containerData?: PluginContainerDataNonNullableFields;
|
|
4659
|
-
initialExpandedItems: InitialExpandedItems;
|
|
4660
|
-
direction: Direction;
|
|
4661
|
-
}
|
|
4662
|
-
interface DimensionsNonNullableFields {
|
|
4663
|
-
colsWidthRatio: number[];
|
|
4664
|
-
rowsHeight: number[];
|
|
4665
|
-
colsMinWidth: number[];
|
|
4666
|
-
}
|
|
4667
|
-
interface TableDataNonNullableFields {
|
|
4668
|
-
containerData?: PluginContainerDataNonNullableFields;
|
|
4669
|
-
dimensions?: DimensionsNonNullableFields;
|
|
4670
|
-
}
|
|
4671
|
-
interface CellStyleNonNullableFields {
|
|
4672
|
-
verticalAlignment: VerticalAlignment;
|
|
4673
|
-
}
|
|
4674
|
-
interface TableCellDataNonNullableFields {
|
|
4675
|
-
cellStyle?: CellStyleNonNullableFields;
|
|
4676
|
-
}
|
|
4677
|
-
interface AudioDataNonNullableFields {
|
|
4678
|
-
containerData?: PluginContainerDataNonNullableFields;
|
|
4679
|
-
}
|
|
4680
|
-
interface OrderedListDataNonNullableFields {
|
|
4681
|
-
indentation: number;
|
|
4682
|
-
}
|
|
4683
|
-
interface BulletedListDataNonNullableFields {
|
|
4684
|
-
indentation: number;
|
|
4685
|
-
}
|
|
4686
|
-
interface BlockquoteDataNonNullableFields {
|
|
4687
|
-
indentation: number;
|
|
4688
|
-
}
|
|
4689
|
-
interface CaptionDataNonNullableFields {
|
|
4690
|
-
textStyle?: TextStyleNonNullableFields;
|
|
4691
|
-
}
|
|
4692
|
-
interface NodeNonNullableFields {
|
|
4693
|
-
buttonData?: ButtonDataNonNullableFields;
|
|
4694
|
-
codeBlockData?: CodeBlockDataNonNullableFields;
|
|
4695
|
-
dividerData?: DividerDataNonNullableFields;
|
|
4696
|
-
fileData?: FileDataNonNullableFields;
|
|
4697
|
-
galleryData?: GalleryDataNonNullableFields;
|
|
4698
|
-
gifData?: GIFDataNonNullableFields;
|
|
4699
|
-
headingData?: HeadingDataNonNullableFields;
|
|
4700
|
-
htmlData?: HTMLDataNonNullableFields;
|
|
4701
|
-
imageData?: ImageDataNonNullableFields;
|
|
4702
|
-
linkPreviewData?: LinkPreviewDataNonNullableFields;
|
|
4703
|
-
mapData?: MapDataNonNullableFields;
|
|
4704
|
-
paragraphData?: ParagraphDataNonNullableFields;
|
|
4705
|
-
pollData?: PollDataNonNullableFields;
|
|
4706
|
-
textData?: TextDataNonNullableFields;
|
|
4707
|
-
appEmbedData?: AppEmbedDataNonNullableFields;
|
|
4708
|
-
videoData?: VideoDataNonNullableFields;
|
|
4709
|
-
embedData?: EmbedDataNonNullableFields;
|
|
4710
|
-
collapsibleListData?: CollapsibleListDataNonNullableFields;
|
|
4711
|
-
tableData?: TableDataNonNullableFields;
|
|
4712
|
-
tableCellData?: TableCellDataNonNullableFields;
|
|
4713
|
-
audioData?: AudioDataNonNullableFields;
|
|
4714
|
-
orderedListData?: OrderedListDataNonNullableFields;
|
|
4715
|
-
bulletedListData?: BulletedListDataNonNullableFields;
|
|
4716
|
-
blockquoteData?: BlockquoteDataNonNullableFields;
|
|
4717
|
-
captionData?: CaptionDataNonNullableFields;
|
|
4718
|
-
type: NodeType;
|
|
4719
|
-
id: string;
|
|
4720
|
-
nodes: NodeNonNullableFields[];
|
|
4721
|
-
}
|
|
4722
|
-
interface MetadataNonNullableFields {
|
|
4723
|
-
version: number;
|
|
4724
|
-
}
|
|
4725
|
-
interface TextNodeStyleNonNullableFields {
|
|
4726
|
-
decorations: DecorationNonNullableFields[];
|
|
4727
|
-
}
|
|
4728
|
-
interface DocumentStyleNonNullableFields {
|
|
4729
|
-
headerOne?: TextNodeStyleNonNullableFields;
|
|
4730
|
-
headerTwo?: TextNodeStyleNonNullableFields;
|
|
4731
|
-
headerThree?: TextNodeStyleNonNullableFields;
|
|
4732
|
-
headerFour?: TextNodeStyleNonNullableFields;
|
|
4733
|
-
headerFive?: TextNodeStyleNonNullableFields;
|
|
4734
|
-
headerSix?: TextNodeStyleNonNullableFields;
|
|
4735
|
-
paragraph?: TextNodeStyleNonNullableFields;
|
|
4736
|
-
blockquote?: TextNodeStyleNonNullableFields;
|
|
4737
|
-
codeBlock?: TextNodeStyleNonNullableFields;
|
|
4738
|
-
}
|
|
4739
|
-
interface RichContentNonNullableFields {
|
|
4740
|
-
nodes: NodeNonNullableFields[];
|
|
4741
|
-
metadata?: MetadataNonNullableFields;
|
|
4742
|
-
documentStyle?: DocumentStyleNonNullableFields;
|
|
4743
|
-
}
|
|
4744
|
-
interface V3BadgeNonNullableFields {
|
|
4745
|
-
type: BadgeTypeType;
|
|
4746
|
-
}
|
|
4747
|
-
interface BadgeListNonNullableFields {
|
|
4748
|
-
badges: V3BadgeNonNullableFields[];
|
|
4749
|
-
}
|
|
4750
|
-
interface V3EventNonNullableFields {
|
|
4751
|
-
id: string;
|
|
4752
|
-
location?: LocationNonNullableFields;
|
|
4753
|
-
dateAndTimeSettings?: DateAndTimeSettingsNonNullableFields;
|
|
4754
|
-
mainImage?: CommonImageNonNullableFields;
|
|
4755
|
-
slug: string;
|
|
4756
|
-
status: Status;
|
|
4757
|
-
registration?: RegistrationNonNullableFields;
|
|
4758
|
-
calendarUrls?: CalendarUrlsNonNullableFields;
|
|
4759
|
-
eventPageUrl?: PageUrlNonNullableFields;
|
|
4760
|
-
form?: FormNonNullableFields;
|
|
4761
|
-
summaries?: SummariesNonNullableFields;
|
|
4762
|
-
instanceId: string;
|
|
4763
|
-
guestListSettings?: GuestListSettingsNonNullableFields;
|
|
4764
|
-
userId: string;
|
|
4765
|
-
feed?: FeedNonNullableFields;
|
|
4766
|
-
onlineConferencing?: OnlineConferencingNonNullableFields;
|
|
4767
|
-
seoSettings?: SeoSettingsNonNullableFields;
|
|
4768
|
-
agendaSettings?: AgendaSettingsNonNullableFields;
|
|
4769
|
-
categories?: EventCategoriesNonNullableFields;
|
|
4770
|
-
description?: RichContentNonNullableFields;
|
|
4771
|
-
badges?: BadgeListNonNullableFields;
|
|
4772
|
-
}
|
|
4773
|
-
export interface CreateEventResponseNonNullableFields {
|
|
4774
|
-
event?: V3EventNonNullableFields;
|
|
4775
|
-
}
|
|
4776
|
-
export interface CloneEventResponseNonNullableFields {
|
|
4777
|
-
event?: V3EventNonNullableFields;
|
|
4778
|
-
}
|
|
4779
|
-
export interface UpdateEventResponseNonNullableFields {
|
|
4780
|
-
event?: V3EventNonNullableFields;
|
|
4781
|
-
}
|
|
4782
|
-
export interface PublishDraftEventResponseNonNullableFields {
|
|
4783
|
-
event?: V3EventNonNullableFields;
|
|
4784
|
-
}
|
|
4785
|
-
export interface CancelEventResponseNonNullableFields {
|
|
4786
|
-
event?: V3EventNonNullableFields;
|
|
4787
|
-
}
|
|
4788
|
-
export interface DeleteEventResponseNonNullableFields {
|
|
4789
|
-
eventId: string;
|
|
4543
|
+
interface BulkDeleteEventsByFilterOptions {
|
|
4544
|
+
/** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
|
|
4545
|
+
filter?: CommonQueryV2;
|
|
4790
4546
|
}
|
|
4791
|
-
|
|
4792
|
-
|
|
4547
|
+
interface QueryEventsOptions {
|
|
4548
|
+
/**
|
|
4549
|
+
* Predefined sets of fields to return.
|
|
4550
|
+
* @maxSize 20
|
|
4551
|
+
*/
|
|
4552
|
+
fields?: RequestedFields[] | undefined;
|
|
4553
|
+
/**
|
|
4554
|
+
* Whether draft events should be returned in the response. <br>
|
|
4555
|
+
* **Note:** This parameter requires the `WIX_EVENTS.READ_DRAFT_EVENTS` permission.
|
|
4556
|
+
*/
|
|
4557
|
+
includeDrafts?: boolean | undefined;
|
|
4558
|
+
}
|
|
4559
|
+
interface QueryOffsetResult {
|
|
4560
|
+
currentPage: number | undefined;
|
|
4561
|
+
totalPages: number | undefined;
|
|
4562
|
+
totalCount: number | undefined;
|
|
4563
|
+
hasNext: () => boolean;
|
|
4564
|
+
hasPrev: () => boolean;
|
|
4565
|
+
length: number;
|
|
4566
|
+
pageSize: number;
|
|
4567
|
+
}
|
|
4568
|
+
interface EventsQueryResult extends QueryOffsetResult {
|
|
4569
|
+
items: V3Event[];
|
|
4570
|
+
query: EventsQueryBuilder;
|
|
4571
|
+
next: () => Promise<EventsQueryResult>;
|
|
4572
|
+
prev: () => Promise<EventsQueryResult>;
|
|
4573
|
+
}
|
|
4574
|
+
interface EventsQueryBuilder {
|
|
4575
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
4576
|
+
* @param value - Value to compare against.
|
|
4577
|
+
*/
|
|
4578
|
+
eq: (propertyName: '_id' | 'dateAndTimeSettings.startDate' | 'dateAndTimeSettings.endDate' | 'title' | 'slug' | '_createdDate' | '_updatedDate' | 'status' | 'registration.initialType' | 'userId', value: any) => EventsQueryBuilder;
|
|
4579
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
4580
|
+
* @param value - Value to compare against.
|
|
4581
|
+
*/
|
|
4582
|
+
ne: (propertyName: '_id' | 'dateAndTimeSettings.startDate' | 'dateAndTimeSettings.endDate' | 'title' | 'slug' | '_createdDate' | '_updatedDate' | 'status' | 'userId', value: any) => EventsQueryBuilder;
|
|
4583
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
4584
|
+
* @param value - Value to compare against.
|
|
4585
|
+
*/
|
|
4586
|
+
ge: (propertyName: 'dateAndTimeSettings.startDate' | 'dateAndTimeSettings.endDate' | '_createdDate' | '_updatedDate', value: any) => EventsQueryBuilder;
|
|
4587
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
4588
|
+
* @param value - Value to compare against.
|
|
4589
|
+
*/
|
|
4590
|
+
gt: (propertyName: 'dateAndTimeSettings.startDate' | 'dateAndTimeSettings.endDate' | '_createdDate' | '_updatedDate', value: any) => EventsQueryBuilder;
|
|
4591
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
4592
|
+
* @param value - Value to compare against.
|
|
4593
|
+
*/
|
|
4594
|
+
le: (propertyName: 'dateAndTimeSettings.startDate' | 'dateAndTimeSettings.endDate' | '_createdDate' | '_updatedDate', value: any) => EventsQueryBuilder;
|
|
4595
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
4596
|
+
* @param value - Value to compare against.
|
|
4597
|
+
*/
|
|
4598
|
+
lt: (propertyName: 'dateAndTimeSettings.startDate' | 'dateAndTimeSettings.endDate' | '_createdDate' | '_updatedDate', value: any) => EventsQueryBuilder;
|
|
4599
|
+
in: (propertyName: '_id' | 'dateAndTimeSettings.startDate' | 'dateAndTimeSettings.endDate' | 'title' | 'slug' | '_createdDate' | '_updatedDate' | 'status' | 'userId', value: any) => EventsQueryBuilder;
|
|
4600
|
+
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
|
|
4601
|
+
ascending: (...propertyNames: Array<'_id' | 'dateAndTimeSettings.startDate' | 'dateAndTimeSettings.endDate' | 'title' | 'slug' | '_createdDate' | '_updatedDate'>) => EventsQueryBuilder;
|
|
4602
|
+
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
|
|
4603
|
+
descending: (...propertyNames: Array<'_id' | 'dateAndTimeSettings.startDate' | 'dateAndTimeSettings.endDate' | 'title' | 'slug' | '_createdDate' | '_updatedDate'>) => EventsQueryBuilder;
|
|
4604
|
+
/** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
|
|
4605
|
+
limit: (limit: number) => EventsQueryBuilder;
|
|
4606
|
+
/** @param skip - Number of items to skip in the query results before returning the results. */
|
|
4607
|
+
skip: (skip: number) => EventsQueryBuilder;
|
|
4608
|
+
find: () => Promise<EventsQueryResult>;
|
|
4609
|
+
}
|
|
4610
|
+
interface CountEventsByStatusOptions {
|
|
4611
|
+
/** Filter object in the following format: <br/> `"filter" : { "fieldName1": "value1" }`. */
|
|
4612
|
+
filter?: Record<string, any> | null;
|
|
4613
|
+
/**
|
|
4614
|
+
* Parameters to count events by.
|
|
4615
|
+
* @maxLength 100
|
|
4616
|
+
* @maxSize 20
|
|
4617
|
+
*/
|
|
4618
|
+
facet?: string[];
|
|
4619
|
+
/**
|
|
4620
|
+
* Whether draft events should be returned in the response. <br>
|
|
4621
|
+
* **Note:** This parameter requires the `WIX_EVENTS.READ_DRAFT_EVENTS` permission.
|
|
4622
|
+
*/
|
|
4623
|
+
includeDrafts?: boolean;
|
|
4793
4624
|
}
|
|
4794
|
-
|
|
4795
|
-
|
|
4625
|
+
interface GetEventOptions {
|
|
4626
|
+
/**
|
|
4627
|
+
* Predefined sets of fields to return.
|
|
4628
|
+
* @maxSize 20
|
|
4629
|
+
*/
|
|
4630
|
+
fields?: RequestedFields[];
|
|
4796
4631
|
}
|
|
4797
|
-
|
|
4798
|
-
|
|
4632
|
+
interface GetEventBySlugOptions {
|
|
4633
|
+
/** @maxSize 20 */
|
|
4634
|
+
fields?: RequestedFields[];
|
|
4799
4635
|
}
|
|
4800
|
-
|
|
4636
|
+
|
|
4637
|
+
export { PollLayoutType as $, Alignment as A, type BulkCancelEventsByFilterOptions as B, type CreateEventOptions as C, type DeleteEventResponse as D, type EventsQueryBuilder as E, LayoutType as F, type GetEventOptions as G, Crop as H, InitialRegistrationTypeType as I, ThumbnailsAlignment as J, GIFType as K, LocationType as L, Source as M, NodeType as N, Orientation as O, type PublishDraftEventOptions as P, type QueryEventsOptions as Q, RecurrenceStatusStatus as R, SubdivisionSubdivisionType as S, TaxType as T, type UpdateEventOptions as U, type V3Event as V, WidthType as W, Position as X, MapType as Y, ViewRole as Z, VoteRole as _, type CloneEventOptions as a, type Rsvps as a$, PollLayoutDirection as a0, BackgroundType as a1, DecorationType as a2, FontType as a3, AppType as a4, InitialExpandedItems as a5, Direction as a6, VerticalAlignment as a7, NullValue as a8, BadgeTypeType as a9, type Formatted as aA, type TimeDuration as aB, type Registration as aC, type RsvpRegistration as aD, type TicketsRegistration as aE, type Money as aF, type TaxSettings as aG, type ExternalRegistration as aH, type CalendarUrls as aI, type Form as aJ, type InputControl as aK, type Input as aL, type OptionSelection as aM, type OptionSelectionSelectedOptionOneOf as aN, type Label as aO, type FormMessages as aP, type RsvpFormMessages as aQ, type PositiveResponseConfirmation as aR, type NegativeResponseConfirmation as aS, type Positive as aT, type Negative as aU, type CheckoutFormMessages as aV, type ResponseConfirmation as aW, type RegistrationClosedMessages as aX, type TicketsUnavailableMessages as aY, type Summaries as aZ, type EventsMoney as a_, RequestedFields as aa, CommonSortOrder as ab, SortOrder as ac, Relation as ad, LocationLocationType as ae, SubdivisionType as af, EventsRecurrenceStatusStatus as ag, EventStatus as ah, EventType as ai, RegistrationStatus as aj, RsvpStatusOptions as ak, EventsTaxType as al, VisitorType as am, ConferenceType as an, State as ao, Type as ap, WebhookIdentityType as aq, type Location as ar, type CommonAddress as as, type CommonAddressStreetOneOf as at, type CommonStreetAddress as au, type CommonAddressLocation as av, type CommonSubdivision as aw, type DateAndTimeSettings as ax, type Recurrences as ay, type Occurrence as az, type CloneEventResponse as b, type Option as b$, type Tickets as b0, type GuestListSettings as b1, type Feed as b2, type OnlineConferencing as b3, type OnlineConferencingSession as b4, type SeoSettings as b5, type SeoSchema as b6, type Keyword as b7, type Tag as b8, type Settings as b9, type FileSourceDataOneOf as bA, type PDFSettings as bB, type GalleryData as bC, type Media as bD, type Image as bE, type Video as bF, type Item as bG, type ItemDataOneOf as bH, type GalleryOptions as bI, type Layout as bJ, type ItemStyle as bK, type Thumbnails as bL, type GIFData as bM, type GIF as bN, type HeadingData as bO, type HTMLData as bP, type HTMLDataDataOneOf as bQ, type ImageData as bR, type StylesBorder as bS, type ImageDataStyles as bT, type LinkPreviewData as bU, type LinkPreviewDataStyles as bV, type MapData as bW, type MapSettings as bX, type ParagraphData as bY, type PollData as bZ, type Permissions as b_, type AgendaSettings as ba, type EventCategories as bb, type EventCategory as bc, type V3EventDisplaySettings as bd, type LabellingSettings as be, type RichContent as bf, type Node as bg, type NodeDataOneOf as bh, type NodeStyle as bi, type ButtonData as bj, type Border as bk, type Colors as bl, type PluginContainerData as bm, type PluginContainerDataWidth as bn, type PluginContainerDataWidthDataOneOf as bo, type Spoiler as bp, type Height as bq, type Styles as br, type Link as bs, type LinkDataOneOf as bt, type Rel as bu, type CodeBlockData as bv, type TextStyle as bw, type DividerData as bx, type FileData as by, type FileSource as bz, type PublishDraftEventResponse as c, type CommonQueryV2PagingMethodOneOf as c$, type PollSettings as c0, type PollLayout as c1, type OptionLayout as c2, type Gradient as c3, type Background as c4, type BackgroundBackgroundOneOf as c5, type PollDesign as c6, type OptionDesign as c7, type Poll as c8, type PollDataLayout as c9, type OrderedListData as cA, type BulletedListData as cB, type BlockquoteData as cC, type CaptionData as cD, type LayoutCellData as cE, type Metadata as cF, type DocumentStyle as cG, type TextNodeStyle as cH, type BadgeList as cI, type V3Badge as cJ, type EventEventStarted as cK, type EventEventEnded as cL, type EventEventReminder as cM, type EventEventPublished as cN, type EventCloned as cO, type EventEventCanceled as cP, type CreateEventRequest as cQ, type CreateEventResponse as cR, type CloneEventRequest as cS, type CloneEventFromOtherSiteRequest as cT, type CloneEventFromOtherSiteResponse as cU, type UpdateEventRequest as cV, type UpdateEventResponse as cW, type PublishDraftEventRequest as cX, type CancelEventRequest as cY, type BulkCancelEventsByFilterRequest as cZ, type CommonQueryV2 as c_, type Design as ca, type TextData as cb, type Decoration as cc, type DecorationDataOneOf as cd, type AnchorData as ce, type ColorData as cf, type LinkData as cg, type MentionData as ch, type FontSizeData as ci, type SpoilerData as cj, type AppEmbedData as ck, type AppEmbedDataAppDataOneOf as cl, type BookingData as cm, type EventData as cn, type VideoData as co, type PlaybackOptions as cp, type EmbedData as cq, type Oembed as cr, type CollapsibleListData as cs, type TableData as ct, type Dimensions as cu, type TableCellData as cv, type CellStyle as cw, type BorderColors as cx, type ListValue as cy, type AudioData as cz, type CancelEventOptions as d, type EventsSeoSettings as d$, type CommonSorting as d0, type CommonPaging as d1, type BulkCancelEventsByFilterResponse as d2, type DeleteEventRequest as d3, type BulkDeleteEventsByFilterRequest as d4, type BulkDeleteEventsByFilterResponse as d5, type QueryEventsRequest as d6, type QueryEventsResponse as d7, type CommonPagingMetadataV2 as d8, type CommonCursors as d9, type Address as dA, type AddressStreetOneOf as dB, type StreetAddress as dC, type AddressLocation as dD, type Subdivision as dE, type ScheduleConfig as dF, type EventsRecurrences as dG, type EventsOccurrence as dH, type Event as dI, type Scheduling as dJ, type EventsRegistration as dK, type RsvpCollection as dL, type RsvpCollectionConfig as dM, type Ticketing as dN, type TicketingConfig as dO, type TaxConfig as dP, type ExternalEvent as dQ, type CalendarLinks as dR, type SiteUrl as dS, type Dashboard as dT, type RsvpSummary as dU, type TicketingSummary as dV, type GuestListConfig as dW, type EventsFeed as dX, type EventsOnlineConferencing as dY, type OnlineConferencingConfig as dZ, type EventsOnlineConferencingSession as d_, type ExportEventsRequest as da, type QueryV2 as db, type QueryV2PagingMethodOneOf as dc, type Sorting as dd, type Paging as de, type CursorPaging as df, type ExportEventsResponse as dg, type PagingMetadataV2 as dh, type Cursors as di, type CountEventsByStatusRequest as dj, type FacetCounts as dk, type ListUserEventsRequest as dl, type UserFilter as dm, type ListUserEventsResponse as dn, type ListEventsByCategoryRequest as dp, type ListEventsByCategoryResponse as dq, type GetEventRequest as dr, type GetEventResponse as ds, type GetEventBySlugRequest as dt, type FindEventRequest as du, type FindEventRequestFindByOneOf as dv, type FindEventResponse as dw, type EventCreated as dx, type EventsLocation as dy, type MapCoordinates as dz, type CancelEventResponse as e, type Agenda as e0, type Category as e1, type CategoryCounts as e2, type EventDisplaySettings as e3, type EventsLabellingSettings as e4, type Badge as e5, type Empty as e6, type EventUpdated as e7, type EventDeleted as e8, type EventCopied as e9, type EventsQueryResult as eA, type EventPublished as ea, type EventCanceled as eb, type EventStarted as ec, type EventEnded as ed, type EventReminder as ee, type DomainEvent as ef, type DomainEventBodyOneOf as eg, type EntityCreatedEvent as eh, type RestoreInfo as ei, type EntityUpdatedEvent as ej, type EntityDeletedEvent as ek, type ActionEvent as el, type MessageEnvelope as em, type IdentificationData as en, type IdentificationDataIdOneOf as eo, type BaseEventMetadata as ep, type EventMetadata as eq, type EventCanceledEnvelope as er, type EventClonedEnvelope as es, type EventCreatedEnvelope as et, type EventDeletedEnvelope as eu, type EventEndedEnvelope as ev, type EventPublishedEnvelope as ew, type EventReminderEnvelope as ex, type EventStartedEnvelope as ey, type EventUpdatedEnvelope as ez, type BulkDeleteEventsByFilterOptions as f, type CountEventsByStatusOptions as g, type CountEventsByStatusResponse as h, type GetEventBySlugOptions as i, type GetEventBySlugResponse as j, Status as k, RegistrationTypeType as l, RegistrationStatusStatus as m, ResponseType as n, GuestTypeType as o, InputControlType as p, ValueType as q, ConferenceTypeType as r, CategoryTypeType as s, PluginContainerDataAlignment as t, ButtonDataType as u, Target as v, TextAlignment as w, LineStyle as x, Width as y, ViewMode as z };
|