@wix/auto_sdk_events_wix-events-v-2 1.0.31 → 1.0.33
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-DqdnERTE.d.mts} +841 -495
- package/build/{internal/cjs/src/events-v3-event-wix-events-v-2.types.d.ts → events-v3-event-wix-events-v-2.universal-DqdnERTE.d.ts} +841 -495
- package/build/index.d.mts +220 -0
- package/build/index.d.ts +220 -0
- package/build/index.js +2657 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +2551 -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-DqdnERTE.d.mts} +841 -495
- package/build/internal/{es/src/events-v3-event-wix-events-v-2.types.d.ts → events-v3-event-wix-events-v-2.universal-DqdnERTE.d.ts} +841 -495
- package/build/internal/index.d.mts +220 -0
- package/build/internal/index.d.ts +220 -0
- package/build/internal/index.js +2657 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +2551 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/meta.d.mts +2848 -0
- package/build/internal/meta.d.ts +2848 -0
- package/build/internal/meta.js +1213 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +1175 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/meta.d.mts +2848 -0
- package/build/meta.d.ts +2848 -0
- package/build/meta.js +1213 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +1175 -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 -1031
- 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 -455
- 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 -676
- 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 -5403
- package/build/cjs/src/events-v3-event-wix-events-v-2.universal.js +0 -1513
- 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/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 -1016
- 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 -377
- 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 -672
- 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 -5403
- package/build/es/src/events-v3-event-wix-events-v-2.universal.js +0 -1474
- 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 -1031
- 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 -455
- 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 -676
- 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 -5403
- package/build/internal/cjs/src/events-v3-event-wix-events-v-2.universal.js +0 -1513
- 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 -1016
- 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 -377
- 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 -672
- 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 -5403
- package/build/internal/es/src/events-v3-event-wix-events-v-2.universal.js +0 -1474
- 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?: StatusWithLiterals;
|
|
@@ -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?: LocationTypeWithLiterals;
|
|
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,16 +161,16 @@ export declare enum LocationType {
|
|
|
149
161
|
ONLINE = "ONLINE"
|
|
150
162
|
}
|
|
151
163
|
/** @enumType */
|
|
152
|
-
|
|
164
|
+
type LocationTypeWithLiterals = LocationType | 'UNKNOWN_LOCATION' | 'VENUE' | 'ONLINE';
|
|
153
165
|
/** Physical address */
|
|
154
|
-
|
|
166
|
+
interface CommonAddress extends CommonAddressStreetOneOf {
|
|
155
167
|
/** Street address. */
|
|
156
168
|
streetAddress?: CommonStreetAddress;
|
|
157
169
|
/**
|
|
158
170
|
* Primary address information (street and building number).
|
|
159
171
|
* @maxLength 250
|
|
160
172
|
*/
|
|
161
|
-
|
|
173
|
+
addressLine1?: string | null;
|
|
162
174
|
/**
|
|
163
175
|
* 2-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format.
|
|
164
176
|
* @format COUNTRY
|
|
@@ -186,7 +198,7 @@ export interface CommonAddress extends CommonAddressStreetOneOf {
|
|
|
186
198
|
addressLine2?: string | null;
|
|
187
199
|
}
|
|
188
200
|
/** @oneof */
|
|
189
|
-
|
|
201
|
+
interface CommonAddressStreetOneOf {
|
|
190
202
|
/** Street address. */
|
|
191
203
|
streetAddress?: CommonStreetAddress;
|
|
192
204
|
/**
|
|
@@ -195,7 +207,7 @@ export interface CommonAddressStreetOneOf {
|
|
|
195
207
|
*/
|
|
196
208
|
addressLine?: string | null;
|
|
197
209
|
}
|
|
198
|
-
|
|
210
|
+
interface CommonStreetAddress {
|
|
199
211
|
/**
|
|
200
212
|
* Street number.
|
|
201
213
|
* @maxLength 100
|
|
@@ -207,7 +219,7 @@ export interface CommonStreetAddress {
|
|
|
207
219
|
*/
|
|
208
220
|
name?: string;
|
|
209
221
|
}
|
|
210
|
-
|
|
222
|
+
interface CommonAddressLocation {
|
|
211
223
|
/**
|
|
212
224
|
* Address latitude coordinates.
|
|
213
225
|
* @min -90
|
|
@@ -221,7 +233,7 @@ export interface CommonAddressLocation {
|
|
|
221
233
|
*/
|
|
222
234
|
longitude?: number | null;
|
|
223
235
|
}
|
|
224
|
-
|
|
236
|
+
interface CommonSubdivision {
|
|
225
237
|
/**
|
|
226
238
|
* Short subdivision code.
|
|
227
239
|
* @maxLength 100
|
|
@@ -233,7 +245,7 @@ export interface CommonSubdivision {
|
|
|
233
245
|
*/
|
|
234
246
|
name?: string;
|
|
235
247
|
}
|
|
236
|
-
|
|
248
|
+
declare enum SubdivisionSubdivisionType {
|
|
237
249
|
UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
|
|
238
250
|
/** State */
|
|
239
251
|
ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
|
|
@@ -248,34 +260,30 @@ export declare enum SubdivisionSubdivisionType {
|
|
|
248
260
|
/** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
|
|
249
261
|
COUNTRY = "COUNTRY"
|
|
250
262
|
}
|
|
251
|
-
|
|
252
|
-
export type SubdivisionSubdivisionTypeWithLiterals = SubdivisionSubdivisionType | 'UNKNOWN_SUBDIVISION_TYPE' | 'ADMINISTRATIVE_AREA_LEVEL_1' | 'ADMINISTRATIVE_AREA_LEVEL_2' | 'ADMINISTRATIVE_AREA_LEVEL_3' | 'ADMINISTRATIVE_AREA_LEVEL_4' | 'ADMINISTRATIVE_AREA_LEVEL_5' | 'COUNTRY';
|
|
253
|
-
export interface DateAndTimeSettings {
|
|
263
|
+
interface DateAndTimeSettings {
|
|
254
264
|
/** Whether the event date and time are TBD. */
|
|
255
265
|
dateAndTimeTbd?: boolean | null;
|
|
256
266
|
/**
|
|
257
267
|
* Message that is displayed when time and date is TBD.
|
|
258
|
-
*
|
|
259
|
-
* **Note:** This field is only used when the `dateAndTimeTbd` field value is `true`.
|
|
260
268
|
* @maxLength 100
|
|
261
269
|
*/
|
|
262
270
|
dateAndTimeTbdMessage?: string | null;
|
|
263
271
|
/**
|
|
264
272
|
* Event start date.
|
|
265
273
|
*
|
|
266
|
-
* **Note:**
|
|
274
|
+
* **Note:** You need to write this field in the snake case, instead of a camel case. For example, `start_date`.
|
|
267
275
|
*/
|
|
268
276
|
startDate?: Date | null;
|
|
269
277
|
/**
|
|
270
278
|
* Event end date.
|
|
271
279
|
*
|
|
272
|
-
* **Note:**
|
|
280
|
+
* **Note:** You need to write this field in the snake case, instead of a camel case. For example, `end_date`.
|
|
273
281
|
*/
|
|
274
282
|
endDate?: Date | null;
|
|
275
283
|
/**
|
|
276
|
-
* Event time zone ID in the
|
|
284
|
+
* Event time zone ID in the TZ database format.
|
|
277
285
|
*
|
|
278
|
-
* **Note:**
|
|
286
|
+
* **Note:** You need to write this field in the snake case, instead of a camel case. For example, `time_zone_id`.
|
|
279
287
|
* @maxLength 100
|
|
280
288
|
*/
|
|
281
289
|
timeZoneId?: string | null;
|
|
@@ -284,7 +292,13 @@ export interface DateAndTimeSettings {
|
|
|
284
292
|
/** Whether the time zone is displayed in the formatted schedule. */
|
|
285
293
|
showTimeZone?: boolean | null;
|
|
286
294
|
/**
|
|
287
|
-
* Repeating event status.
|
|
295
|
+
* Repeating event status. Possible values:
|
|
296
|
+
*
|
|
297
|
+
* - `ONE_TIME`: The event happens only once and can last multiple days.
|
|
298
|
+
* - `RECURRING`: A series of events that repeat.
|
|
299
|
+
* - `RECURRING_UPCOMING`: Next event in a schedule of recurring events.
|
|
300
|
+
* - `RECURRING_RECENTLY_ENDED`: Latest event that ended in a schedule of recurring events.
|
|
301
|
+
* - `RECURRING_RECENTLY_CANCELED`: Latest canceled event tin a schedule of recurring events.
|
|
288
302
|
* @readonly
|
|
289
303
|
*/
|
|
290
304
|
recurrenceStatus?: RecurrenceStatusStatusWithLiterals;
|
|
@@ -293,7 +307,7 @@ export interface DateAndTimeSettings {
|
|
|
293
307
|
/** Formatted date and time settings. */
|
|
294
308
|
formatted?: Formatted;
|
|
295
309
|
}
|
|
296
|
-
|
|
310
|
+
declare enum RecurrenceStatusStatus {
|
|
297
311
|
/** Unknown recurrance status. */
|
|
298
312
|
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
299
313
|
/** Event happens only once and can last multiple days. */
|
|
@@ -308,10 +322,10 @@ export declare enum RecurrenceStatusStatus {
|
|
|
308
322
|
RECURRING_RECENTLY_CANCELED = "RECURRING_RECENTLY_CANCELED"
|
|
309
323
|
}
|
|
310
324
|
/** @enumType */
|
|
311
|
-
|
|
312
|
-
|
|
325
|
+
type RecurrenceStatusStatusWithLiterals = RecurrenceStatusStatus | 'UNKNOWN_STATUS' | 'ONE_TIME' | 'RECURRING' | 'RECURRING_UPCOMING' | 'RECURRING_RECENTLY_ENDED' | 'RECURRING_RECENTLY_CANCELED';
|
|
326
|
+
interface Recurrences {
|
|
313
327
|
/**
|
|
314
|
-
* Individual event dates.
|
|
328
|
+
* Individual event dates info.
|
|
315
329
|
* @maxSize 1000
|
|
316
330
|
*/
|
|
317
331
|
individualEventDates?: Occurrence[];
|
|
@@ -322,7 +336,7 @@ export interface Recurrences {
|
|
|
322
336
|
*/
|
|
323
337
|
categoryId?: string | null;
|
|
324
338
|
}
|
|
325
|
-
|
|
339
|
+
interface Occurrence {
|
|
326
340
|
/** Event start date. */
|
|
327
341
|
startDate?: Date | null;
|
|
328
342
|
/** Event end date. */
|
|
@@ -335,10 +349,11 @@ export interface Occurrence {
|
|
|
335
349
|
/** Whether the time zone is displayed in a formatted schedule. */
|
|
336
350
|
showTimeZone?: boolean;
|
|
337
351
|
}
|
|
338
|
-
|
|
352
|
+
interface Formatted {
|
|
339
353
|
/**
|
|
340
|
-
* Formatted date and time representation.
|
|
341
|
-
*
|
|
354
|
+
* Formatted date and time representation.
|
|
355
|
+
*
|
|
356
|
+
* 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`.
|
|
342
357
|
* 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`.
|
|
343
358
|
* @readonly
|
|
344
359
|
* @maxLength 500
|
|
@@ -373,7 +388,7 @@ export interface Formatted {
|
|
|
373
388
|
* A coarse-grained representation of time duration divided into whole constituting components of days, hours, and minutes.
|
|
374
389
|
* For example, 25.5 hours duration is represented as `{ days: 1, hours: 1, minutes: 30 }`.
|
|
375
390
|
*/
|
|
376
|
-
|
|
391
|
+
interface TimeDuration {
|
|
377
392
|
/** Number of days. */
|
|
378
393
|
days?: number;
|
|
379
394
|
/**
|
|
@@ -387,7 +402,7 @@ export interface TimeDuration {
|
|
|
387
402
|
*/
|
|
388
403
|
minutes?: number;
|
|
389
404
|
}
|
|
390
|
-
|
|
405
|
+
declare enum Status {
|
|
391
406
|
/** Unknown event status. */
|
|
392
407
|
UNKNOWN_EVENT_STATUS = "UNKNOWN_EVENT_STATUS",
|
|
393
408
|
/** Event is published and scheduled to start. */
|
|
@@ -402,27 +417,30 @@ export declare enum Status {
|
|
|
402
417
|
DRAFT = "DRAFT"
|
|
403
418
|
}
|
|
404
419
|
/** @enumType */
|
|
405
|
-
|
|
406
|
-
|
|
420
|
+
type StatusWithLiterals = Status | 'UNKNOWN_EVENT_STATUS' | 'UPCOMING' | 'STARTED' | 'ENDED' | 'CANCELED' | 'DRAFT';
|
|
421
|
+
interface Registration {
|
|
407
422
|
/**
|
|
408
|
-
*
|
|
409
|
-
*
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
*
|
|
414
|
-
*
|
|
415
|
-
|
|
416
|
-
path?: string;
|
|
417
|
-
}
|
|
418
|
-
export interface Registration {
|
|
419
|
-
/**
|
|
420
|
-
* Current registration type.
|
|
423
|
+
* Current registration type:
|
|
424
|
+
*
|
|
425
|
+
* - `RSVP`: Guests register by RSVPing to the event.
|
|
426
|
+
* - `TICKETING`: Guests register by buying tickets.
|
|
427
|
+
* - `EXTERNAL`: Guests register externally using some other site or platform.
|
|
428
|
+
* - `NONE`: No registration is required, all guests can attend. This registration type is for only displaying the event details on a site.
|
|
429
|
+
*
|
|
430
|
+
* The property value might change to `EXTERNAL` or `NONE` after initial event creation, depending on any additional configuration applied to the event.
|
|
421
431
|
* @readonly
|
|
422
432
|
*/
|
|
423
433
|
type?: RegistrationTypeTypeWithLiterals;
|
|
424
434
|
/**
|
|
425
|
-
* Registration status.
|
|
435
|
+
* Registration status. Possible values:
|
|
436
|
+
*
|
|
437
|
+
* - `CLOSED_AUTOMATICALLY`: Registration is closed after tickets are sold out.
|
|
438
|
+
* - `CLOSED_MANUALLY`: Registration is closed when the `registration.registrationDisabled` property is set to `true`.
|
|
439
|
+
* - `OPEN_RSVP`: Guests can start RSVPing to the event.
|
|
440
|
+
* - `OPEN_RSVP_WAITLIST_ONLY`: Guest list has reached the maximum, new guests are added to a waitlist.
|
|
441
|
+
* - `OPEN_TICKETS`: Guests can buy tickets to the event.
|
|
442
|
+
* - `OPEN_EXTERNAL`: Guests register on a different page or web address.
|
|
443
|
+
* - `SCHEDULED_RSVP`: Registration via RSVP is scheduled for the future.
|
|
426
444
|
* @readonly
|
|
427
445
|
*/
|
|
428
446
|
status?: RegistrationStatusStatusWithLiterals;
|
|
@@ -432,10 +450,20 @@ export interface Registration {
|
|
|
432
450
|
tickets?: TicketsRegistration;
|
|
433
451
|
/** External registration details. */
|
|
434
452
|
external?: ExternalRegistration;
|
|
435
|
-
/**
|
|
453
|
+
/**
|
|
454
|
+
* Types of guests allowed to register. Possible values:
|
|
455
|
+
*
|
|
456
|
+
* - `VISITOR_OR_MEMBER`: All site visitors can RSVP to the event.
|
|
457
|
+
* - `MEMBER`: Only people who have signed up as members of your site are able to RSVP to the event.
|
|
458
|
+
*/
|
|
436
459
|
allowedGuestTypes?: GuestTypeTypeWithLiterals;
|
|
437
460
|
/**
|
|
438
|
-
* Initial event type which is set when creating an event.
|
|
461
|
+
* Initial event type which is set when creating an event. Possible values:
|
|
462
|
+
*
|
|
463
|
+
* - `RSVP`: Guests register by RSVPing to the event.
|
|
464
|
+
* - `TICKETING`: Guests register by buying tickets.
|
|
465
|
+
*
|
|
466
|
+
* This property value never changes.
|
|
439
467
|
* @immutable
|
|
440
468
|
*/
|
|
441
469
|
initialType?: InitialRegistrationTypeTypeWithLiterals;
|
|
@@ -444,7 +472,7 @@ export interface Registration {
|
|
|
444
472
|
/** Whether the registration is disabled. */
|
|
445
473
|
registrationDisabled?: boolean;
|
|
446
474
|
}
|
|
447
|
-
|
|
475
|
+
declare enum RegistrationTypeType {
|
|
448
476
|
/** Unknown registration type. */
|
|
449
477
|
UNKNOWN_REGISTRATION_TYPE = "UNKNOWN_REGISTRATION_TYPE",
|
|
450
478
|
/** Guests register by RSVPing to the event. */
|
|
@@ -457,8 +485,8 @@ export declare enum RegistrationTypeType {
|
|
|
457
485
|
NONE = "NONE"
|
|
458
486
|
}
|
|
459
487
|
/** @enumType */
|
|
460
|
-
|
|
461
|
-
|
|
488
|
+
type RegistrationTypeTypeWithLiterals = RegistrationTypeType | 'UNKNOWN_REGISTRATION_TYPE' | 'RSVP' | 'TICKETING' | 'EXTERNAL' | 'NONE';
|
|
489
|
+
declare enum RegistrationStatusStatus {
|
|
462
490
|
/** Registration status is not applicable */
|
|
463
491
|
UNKNOWN_REGISTRATION_STATUS = "UNKNOWN_REGISTRATION_STATUS",
|
|
464
492
|
/** Registration is closed after tickets are sold out. */
|
|
@@ -477,8 +505,8 @@ export declare enum RegistrationStatusStatus {
|
|
|
477
505
|
SCHEDULED_RSVP = "SCHEDULED_RSVP"
|
|
478
506
|
}
|
|
479
507
|
/** @enumType */
|
|
480
|
-
|
|
481
|
-
|
|
508
|
+
type RegistrationStatusStatusWithLiterals = RegistrationStatusStatus | 'UNKNOWN_REGISTRATION_STATUS' | 'CLOSED_AUTOMATICALLY' | 'CLOSED_MANUALLY' | 'OPEN_RSVP' | 'OPEN_RSVP_WAITLIST_ONLY' | 'OPEN_TICKETS' | 'OPEN_EXTERNAL' | 'SCHEDULED_RSVP';
|
|
509
|
+
interface RsvpRegistration {
|
|
482
510
|
/** Available answers for registration to an event. */
|
|
483
511
|
responseType?: ResponseTypeWithLiterals;
|
|
484
512
|
/** How many guests can RSVP to an event. */
|
|
@@ -490,7 +518,7 @@ export interface RsvpRegistration {
|
|
|
490
518
|
/** Registration end date. */
|
|
491
519
|
endDate?: Date | null;
|
|
492
520
|
}
|
|
493
|
-
|
|
521
|
+
declare enum ResponseType {
|
|
494
522
|
/** Unknown response type. */
|
|
495
523
|
UNKNOWN_RESPONSE_TYPE = "UNKNOWN_RESPONSE_TYPE",
|
|
496
524
|
/** Only a **Yes** answer is available to select when RSVP'ing to an event. */
|
|
@@ -499,12 +527,12 @@ export declare enum ResponseType {
|
|
|
499
527
|
YES_AND_NO = "YES_AND_NO"
|
|
500
528
|
}
|
|
501
529
|
/** @enumType */
|
|
502
|
-
|
|
503
|
-
|
|
530
|
+
type ResponseTypeWithLiterals = ResponseType | 'UNKNOWN_RESPONSE_TYPE' | 'YES_ONLY' | 'YES_AND_NO';
|
|
531
|
+
interface TicketsRegistration {
|
|
504
532
|
/** Whether the registration form must be filled out separately for each ticket. */
|
|
505
533
|
guestsAssignedSeparately?: boolean;
|
|
506
534
|
/**
|
|
507
|
-
* Ticket limit per order.
|
|
535
|
+
* Ticket limit per order.
|
|
508
536
|
* Default: 20 tickets.
|
|
509
537
|
* @max 50
|
|
510
538
|
*/
|
|
@@ -539,7 +567,7 @@ export interface TicketsRegistration {
|
|
|
539
567
|
* Money.
|
|
540
568
|
* Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.
|
|
541
569
|
*/
|
|
542
|
-
|
|
570
|
+
interface Money {
|
|
543
571
|
/**
|
|
544
572
|
* Amount of money in decimal form. A period is used as a decimal separator (for example, `3.99`).
|
|
545
573
|
* @format DECIMAL_VALUE
|
|
@@ -556,8 +584,13 @@ export interface Money {
|
|
|
556
584
|
*/
|
|
557
585
|
formattedValue?: string | null;
|
|
558
586
|
}
|
|
559
|
-
|
|
560
|
-
/**
|
|
587
|
+
interface TaxSettings {
|
|
588
|
+
/**
|
|
589
|
+
* Tax application settings:
|
|
590
|
+
*
|
|
591
|
+
* - `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.
|
|
592
|
+
* - `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.
|
|
593
|
+
*/
|
|
561
594
|
type?: TaxTypeWithLiterals;
|
|
562
595
|
/**
|
|
563
596
|
* Tax name.
|
|
@@ -574,7 +607,7 @@ export interface TaxSettings {
|
|
|
574
607
|
appliedToDonations?: boolean | null;
|
|
575
608
|
}
|
|
576
609
|
/** Tax application settings. */
|
|
577
|
-
|
|
610
|
+
declare enum TaxType {
|
|
578
611
|
/** Unknown tax type. */
|
|
579
612
|
UNKNOWN_TAX_TYPE = "UNKNOWN_TAX_TYPE",
|
|
580
613
|
/** 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. */
|
|
@@ -583,15 +616,15 @@ export declare enum TaxType {
|
|
|
583
616
|
ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
|
|
584
617
|
}
|
|
585
618
|
/** @enumType */
|
|
586
|
-
|
|
587
|
-
|
|
619
|
+
type TaxTypeWithLiterals = TaxType | 'UNKNOWN_TAX_TYPE' | 'INCLUDED_IN_PRICE' | 'ADDED_AT_CHECKOUT';
|
|
620
|
+
interface ExternalRegistration {
|
|
588
621
|
/**
|
|
589
622
|
* External event registration URL.
|
|
590
623
|
* @format WEB_URL
|
|
591
624
|
*/
|
|
592
625
|
url?: string | null;
|
|
593
626
|
}
|
|
594
|
-
|
|
627
|
+
declare enum GuestTypeType {
|
|
595
628
|
/** Unknown guest type. */
|
|
596
629
|
UNKNOWN_GUEST_TYPE = "UNKNOWN_GUEST_TYPE",
|
|
597
630
|
/** All site visitors can RSVP to the event. */
|
|
@@ -600,8 +633,8 @@ export declare enum GuestTypeType {
|
|
|
600
633
|
MEMBER = "MEMBER"
|
|
601
634
|
}
|
|
602
635
|
/** @enumType */
|
|
603
|
-
|
|
604
|
-
|
|
636
|
+
type GuestTypeTypeWithLiterals = GuestTypeType | 'UNKNOWN_GUEST_TYPE' | 'VISITOR_OR_MEMBER' | 'MEMBER';
|
|
637
|
+
declare enum InitialRegistrationTypeType {
|
|
605
638
|
/** Unknown initial registration type. */
|
|
606
639
|
UNKNOWN_INITIAL_REGISTRATION_TYPE = "UNKNOWN_INITIAL_REGISTRATION_TYPE",
|
|
607
640
|
/** Guests register by RSVPing to the event. */
|
|
@@ -610,32 +643,8 @@ export declare enum InitialRegistrationTypeType {
|
|
|
610
643
|
TICKETING = "TICKETING"
|
|
611
644
|
}
|
|
612
645
|
/** @enumType */
|
|
613
|
-
|
|
614
|
-
|
|
615
|
-
/**
|
|
616
|
-
* WixMedia image ID.
|
|
617
|
-
* @minLength 1
|
|
618
|
-
* @maxLength 200
|
|
619
|
-
*/
|
|
620
|
-
id?: string;
|
|
621
|
-
/** Image URL. */
|
|
622
|
-
url?: string;
|
|
623
|
-
/**
|
|
624
|
-
* Original image height.
|
|
625
|
-
*
|
|
626
|
-
* **Note:** You have to define height for the image to appear.
|
|
627
|
-
*/
|
|
628
|
-
height?: number;
|
|
629
|
-
/**
|
|
630
|
-
* Original image width.
|
|
631
|
-
*
|
|
632
|
-
* **Note:** You have to define width for the image to appear.
|
|
633
|
-
*/
|
|
634
|
-
width?: number;
|
|
635
|
-
/** Image alt text. */
|
|
636
|
-
altText?: string | null;
|
|
637
|
-
}
|
|
638
|
-
export interface CalendarUrls {
|
|
646
|
+
type InitialRegistrationTypeTypeWithLiterals = InitialRegistrationTypeType | 'UNKNOWN_INITIAL_REGISTRATION_TYPE' | 'RSVP' | 'TICKETING';
|
|
647
|
+
interface CalendarUrls {
|
|
639
648
|
/**
|
|
640
649
|
* "Add to Google calendar" URL.
|
|
641
650
|
* @readonly
|
|
@@ -660,7 +669,7 @@ export interface CalendarUrls {
|
|
|
660
669
|
*
|
|
661
670
|
* By default, name and email controls are always required and are pinned to the top of the form.
|
|
662
671
|
*/
|
|
663
|
-
|
|
672
|
+
interface Form {
|
|
664
673
|
/** Nested fields as an ordered list. */
|
|
665
674
|
controls?: InputControl[];
|
|
666
675
|
/**
|
|
@@ -673,7 +682,7 @@ export interface Form {
|
|
|
673
682
|
* A block of nested fields.
|
|
674
683
|
* Used to aggregate similar inputs like First Name and Last Name.
|
|
675
684
|
*/
|
|
676
|
-
|
|
685
|
+
interface InputControl {
|
|
677
686
|
/** Field control type. */
|
|
678
687
|
type?: InputControlTypeWithLiterals;
|
|
679
688
|
/** Whether the control is mandatory (such as `name` & `email`). When `true`, only the label can be changed. */
|
|
@@ -693,14 +702,14 @@ export interface InputControl {
|
|
|
693
702
|
/** Field controls are sorted by this value in ascending order. */
|
|
694
703
|
orderIndex?: number;
|
|
695
704
|
/** Unique control ID. */
|
|
696
|
-
|
|
705
|
+
_id?: string;
|
|
697
706
|
/**
|
|
698
707
|
* Whether the input control is deleted.
|
|
699
708
|
* @readonly
|
|
700
709
|
*/
|
|
701
710
|
deleted?: boolean | null;
|
|
702
711
|
}
|
|
703
|
-
|
|
712
|
+
declare enum InputControlType {
|
|
704
713
|
/** Single text value field. */
|
|
705
714
|
INPUT = "INPUT",
|
|
706
715
|
/** Single text value field with multiple lines. */
|
|
@@ -723,9 +732,9 @@ export declare enum InputControlType {
|
|
|
723
732
|
DATE = "DATE"
|
|
724
733
|
}
|
|
725
734
|
/** @enumType */
|
|
726
|
-
|
|
735
|
+
type InputControlTypeWithLiterals = InputControlType | 'INPUT' | 'TEXTAREA' | 'DROPDOWN' | 'RADIO' | 'CHECKBOX' | 'NAME' | 'GUEST_CONTROL' | 'ADDRESS_SHORT' | 'ADDRESS_FULL' | 'DATE';
|
|
727
736
|
/** Child inputs. */
|
|
728
|
-
|
|
737
|
+
interface Input {
|
|
729
738
|
/** Field name. */
|
|
730
739
|
name?: string;
|
|
731
740
|
/**
|
|
@@ -767,7 +776,7 @@ export interface Input {
|
|
|
767
776
|
*/
|
|
768
777
|
labels?: Label[];
|
|
769
778
|
}
|
|
770
|
-
|
|
779
|
+
declare enum ValueType {
|
|
771
780
|
TEXT = "TEXT",
|
|
772
781
|
NUMBER = "NUMBER",
|
|
773
782
|
TEXT_ARRAY = "TEXT_ARRAY",
|
|
@@ -775,12 +784,12 @@ export declare enum ValueType {
|
|
|
775
784
|
ADDRESS = "ADDRESS"
|
|
776
785
|
}
|
|
777
786
|
/** @enumType */
|
|
778
|
-
|
|
787
|
+
type ValueTypeWithLiterals = ValueType | 'TEXT' | 'NUMBER' | 'TEXT_ARRAY' | 'DATE_TIME' | 'ADDRESS';
|
|
779
788
|
/**
|
|
780
789
|
* Describes initially selected option when an input has multiple choices.
|
|
781
790
|
* Defaults to first (0th) option if not configured.
|
|
782
791
|
*/
|
|
783
|
-
|
|
792
|
+
interface OptionSelection extends OptionSelectionSelectedOptionOneOf {
|
|
784
793
|
/**
|
|
785
794
|
* 0-based index from predefined `controls.inputs.options` which is initial selection.
|
|
786
795
|
* @max 199
|
|
@@ -794,7 +803,7 @@ export interface OptionSelection extends OptionSelectionSelectedOptionOneOf {
|
|
|
794
803
|
placeholderText?: string;
|
|
795
804
|
}
|
|
796
805
|
/** @oneof */
|
|
797
|
-
|
|
806
|
+
interface OptionSelectionSelectedOptionOneOf {
|
|
798
807
|
/**
|
|
799
808
|
* 0-based index from predefined `controls.inputs.options` which is initial selection.
|
|
800
809
|
* @max 199
|
|
@@ -807,7 +816,7 @@ export interface OptionSelectionSelectedOptionOneOf {
|
|
|
807
816
|
*/
|
|
808
817
|
placeholderText?: string;
|
|
809
818
|
}
|
|
810
|
-
|
|
819
|
+
interface Label {
|
|
811
820
|
/** Field name. */
|
|
812
821
|
name?: string;
|
|
813
822
|
/** Field label. */
|
|
@@ -817,7 +826,7 @@ export interface Label {
|
|
|
817
826
|
* Defines form messages shown in UI before, during, and after registration flow.
|
|
818
827
|
* It enables configuration of form titles, response labels, "thank you" messages, and call-to-action texts.
|
|
819
828
|
*/
|
|
820
|
-
|
|
829
|
+
interface FormMessages {
|
|
821
830
|
/** 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. */
|
|
822
831
|
rsvp?: RsvpFormMessages;
|
|
823
832
|
/** Checkout form messages. */
|
|
@@ -827,7 +836,7 @@ export interface FormMessages {
|
|
|
827
836
|
/** Messages shown when event tickets are unavailable. */
|
|
828
837
|
ticketsUnavailable?: TicketsUnavailableMessages;
|
|
829
838
|
}
|
|
830
|
-
|
|
839
|
+
interface RsvpFormMessages {
|
|
831
840
|
/** Label text indicating RSVP's `status` is `"YES"`. */
|
|
832
841
|
rsvpYesOption?: string;
|
|
833
842
|
/** Label text indicating RSVP's `status` is `"NO"`. */
|
|
@@ -842,7 +851,7 @@ export interface RsvpFormMessages {
|
|
|
842
851
|
submitActionLabel?: string;
|
|
843
852
|
}
|
|
844
853
|
/** Confirmation messages shown after registration. */
|
|
845
|
-
|
|
854
|
+
interface PositiveResponseConfirmation {
|
|
846
855
|
/** Confirmation message title. */
|
|
847
856
|
title?: string;
|
|
848
857
|
/** Confirmation message text. */
|
|
@@ -853,27 +862,27 @@ export interface PositiveResponseConfirmation {
|
|
|
853
862
|
shareActionLabel?: string;
|
|
854
863
|
}
|
|
855
864
|
/** Confirmation messages shown after registration. */
|
|
856
|
-
|
|
865
|
+
interface NegativeResponseConfirmation {
|
|
857
866
|
/** Confirmation message title. */
|
|
858
867
|
title?: string;
|
|
859
868
|
/** "Share event" call-to-action label text. */
|
|
860
869
|
shareActionLabel?: string;
|
|
861
870
|
}
|
|
862
871
|
/** Set of messages shown during registration when RSVP response is positive. */
|
|
863
|
-
|
|
872
|
+
interface Positive {
|
|
864
873
|
/** Main form title for positive response. */
|
|
865
874
|
title?: string;
|
|
866
875
|
/** Confirmation messages shown after registration. */
|
|
867
876
|
confirmation?: PositiveResponseConfirmation;
|
|
868
877
|
}
|
|
869
878
|
/** A set of messages shown during registration with negative response */
|
|
870
|
-
|
|
879
|
+
interface Negative {
|
|
871
880
|
/** Main form title for negative response. */
|
|
872
881
|
title?: string;
|
|
873
882
|
/** Confirmation messages shown after registration. */
|
|
874
883
|
confirmation?: NegativeResponseConfirmation;
|
|
875
884
|
}
|
|
876
|
-
|
|
885
|
+
interface CheckoutFormMessages {
|
|
877
886
|
/** Main form title for response. */
|
|
878
887
|
title?: string;
|
|
879
888
|
/** Submit form call-to-action label text. */
|
|
@@ -882,7 +891,7 @@ export interface CheckoutFormMessages {
|
|
|
882
891
|
confirmation?: ResponseConfirmation;
|
|
883
892
|
}
|
|
884
893
|
/** Confirmation messages shown after checkout. */
|
|
885
|
-
|
|
894
|
+
interface ResponseConfirmation {
|
|
886
895
|
/** Confirmation message title. */
|
|
887
896
|
title?: string;
|
|
888
897
|
/** Confirmation message text. */
|
|
@@ -894,25 +903,25 @@ export interface ResponseConfirmation {
|
|
|
894
903
|
/** "Share event" call-to-action label text. */
|
|
895
904
|
shareEventLabel?: string;
|
|
896
905
|
}
|
|
897
|
-
|
|
906
|
+
interface RegistrationClosedMessages {
|
|
898
907
|
/** Message shown when event registration is closed. */
|
|
899
908
|
message?: string;
|
|
900
909
|
/** "Explore other events" call-to-action label text. */
|
|
901
910
|
exploreEventsActionLabel?: string;
|
|
902
911
|
}
|
|
903
|
-
|
|
912
|
+
interface TicketsUnavailableMessages {
|
|
904
913
|
/** Message shown when event tickets are unavailable. */
|
|
905
914
|
message?: string;
|
|
906
915
|
/** "Explore other events" call-to-action label text. */
|
|
907
916
|
exploreEventsActionLabel?: string;
|
|
908
917
|
}
|
|
909
|
-
|
|
918
|
+
interface Summaries {
|
|
910
919
|
/** RSVP summary of guests. */
|
|
911
920
|
rsvps?: Rsvps;
|
|
912
921
|
/** Summary of revenue and sold tickets. Archived orders are not included. */
|
|
913
922
|
tickets?: Tickets;
|
|
914
923
|
}
|
|
915
|
-
|
|
924
|
+
interface EventsMoney {
|
|
916
925
|
/**
|
|
917
926
|
* *Deprecated:** Use `value` instead.
|
|
918
927
|
* @format DECIMAL_VALUE
|
|
@@ -930,7 +939,7 @@ export interface EventsMoney {
|
|
|
930
939
|
*/
|
|
931
940
|
value?: string | null;
|
|
932
941
|
}
|
|
933
|
-
|
|
942
|
+
interface Rsvps {
|
|
934
943
|
/**
|
|
935
944
|
* Total number of RSVPs.
|
|
936
945
|
* @readonly
|
|
@@ -952,7 +961,7 @@ export interface Rsvps {
|
|
|
952
961
|
*/
|
|
953
962
|
waitlistCount?: number;
|
|
954
963
|
}
|
|
955
|
-
|
|
964
|
+
interface Tickets {
|
|
956
965
|
/**
|
|
957
966
|
* Number of sold tickets.
|
|
958
967
|
* @readonly
|
|
@@ -979,15 +988,15 @@ export interface Tickets {
|
|
|
979
988
|
*/
|
|
980
989
|
totalSales?: EventsMoney;
|
|
981
990
|
}
|
|
982
|
-
|
|
991
|
+
interface GuestListSettings {
|
|
983
992
|
/** Whether the guest list is public for all guests. */
|
|
984
993
|
displayedPublicly?: boolean;
|
|
985
994
|
}
|
|
986
|
-
|
|
995
|
+
interface Feed {
|
|
987
996
|
/** Event discussion feed token. */
|
|
988
997
|
token?: string;
|
|
989
998
|
}
|
|
990
|
-
|
|
999
|
+
interface OnlineConferencing {
|
|
991
1000
|
/** 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. */
|
|
992
1001
|
enabled?: boolean;
|
|
993
1002
|
/**
|
|
@@ -995,12 +1004,17 @@ export interface OnlineConferencing {
|
|
|
995
1004
|
* @format GUID
|
|
996
1005
|
*/
|
|
997
1006
|
providerId?: string | null;
|
|
998
|
-
/**
|
|
1007
|
+
/**
|
|
1008
|
+
* Conference type. Possible values:
|
|
1009
|
+
*
|
|
1010
|
+
* - `MEETING`: Guests can do some actions during the conference, for example talk, turn on camera and show their screen.
|
|
1011
|
+
* - `WEBINAR`: Guests can only watch the conference.
|
|
1012
|
+
*/
|
|
999
1013
|
type?: ConferenceTypeTypeWithLiterals;
|
|
1000
1014
|
/** Online conferencing session information. */
|
|
1001
1015
|
session?: OnlineConferencingSession;
|
|
1002
1016
|
}
|
|
1003
|
-
|
|
1017
|
+
declare enum ConferenceTypeType {
|
|
1004
1018
|
/** Default value. This value is unused */
|
|
1005
1019
|
UNKNOWN_CONFERENCE_TYPE = "UNKNOWN_CONFERENCE_TYPE",
|
|
1006
1020
|
/** Guests can do some actions during the conference, for example talk, turn on their camera and show their screen. */
|
|
@@ -1009,8 +1023,8 @@ export declare enum ConferenceTypeType {
|
|
|
1009
1023
|
WEBINAR = "WEBINAR"
|
|
1010
1024
|
}
|
|
1011
1025
|
/** @enumType */
|
|
1012
|
-
|
|
1013
|
-
|
|
1026
|
+
type ConferenceTypeTypeWithLiterals = ConferenceTypeType | 'UNKNOWN_CONFERENCE_TYPE' | 'MEETING' | 'WEBINAR';
|
|
1027
|
+
interface OnlineConferencingSession {
|
|
1014
1028
|
/**
|
|
1015
1029
|
* Link for the event host to start the online conference session.
|
|
1016
1030
|
* @readonly
|
|
@@ -1037,7 +1051,7 @@ export interface OnlineConferencingSession {
|
|
|
1037
1051
|
*/
|
|
1038
1052
|
sessionId?: string | null;
|
|
1039
1053
|
}
|
|
1040
|
-
|
|
1054
|
+
interface SeoSettings {
|
|
1041
1055
|
/**
|
|
1042
1056
|
* URL slug.
|
|
1043
1057
|
* @maxLength 130
|
|
@@ -1056,13 +1070,13 @@ export interface SeoSettings {
|
|
|
1056
1070
|
* The search engines use this information for ranking purposes, or to display snippets in the search results.
|
|
1057
1071
|
* 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.
|
|
1058
1072
|
*/
|
|
1059
|
-
|
|
1073
|
+
interface SeoSchema {
|
|
1060
1074
|
/** SEO tag information. */
|
|
1061
1075
|
tags?: Tag[];
|
|
1062
1076
|
/** SEO general settings. */
|
|
1063
1077
|
settings?: Settings;
|
|
1064
1078
|
}
|
|
1065
|
-
|
|
1079
|
+
interface Keyword {
|
|
1066
1080
|
/** Keyword value. */
|
|
1067
1081
|
term?: string;
|
|
1068
1082
|
/** Whether the keyword is the main focus keyword. */
|
|
@@ -1073,7 +1087,7 @@ export interface Keyword {
|
|
|
1073
1087
|
*/
|
|
1074
1088
|
origin?: string | null;
|
|
1075
1089
|
}
|
|
1076
|
-
|
|
1090
|
+
interface Tag {
|
|
1077
1091
|
/**
|
|
1078
1092
|
* SEO tag type.
|
|
1079
1093
|
*
|
|
@@ -1095,7 +1109,7 @@ export interface Tag {
|
|
|
1095
1109
|
/** Whether the tag is disabled. */
|
|
1096
1110
|
disabled?: boolean;
|
|
1097
1111
|
}
|
|
1098
|
-
|
|
1112
|
+
interface Settings {
|
|
1099
1113
|
/**
|
|
1100
1114
|
* Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.
|
|
1101
1115
|
*
|
|
@@ -1109,29 +1123,29 @@ export interface Settings {
|
|
|
1109
1123
|
*/
|
|
1110
1124
|
keywords?: Keyword[];
|
|
1111
1125
|
}
|
|
1112
|
-
|
|
1126
|
+
interface AgendaSettings {
|
|
1113
1127
|
/** Whether the schedule is enabled for the event. */
|
|
1114
1128
|
enabled?: boolean;
|
|
1115
1129
|
/**
|
|
1116
1130
|
* Schedule page URL.
|
|
1117
1131
|
* @readonly
|
|
1118
1132
|
*/
|
|
1119
|
-
pageUrl?:
|
|
1133
|
+
pageUrl?: string;
|
|
1120
1134
|
}
|
|
1121
|
-
|
|
1135
|
+
interface EventCategories {
|
|
1122
1136
|
/**
|
|
1123
1137
|
* Event categories.
|
|
1124
1138
|
* @maxSize 10
|
|
1125
1139
|
*/
|
|
1126
1140
|
categories?: EventCategory[];
|
|
1127
1141
|
}
|
|
1128
|
-
|
|
1142
|
+
interface EventCategory {
|
|
1129
1143
|
/**
|
|
1130
1144
|
* Category ID.
|
|
1131
1145
|
* @format GUID
|
|
1132
1146
|
* @readonly
|
|
1133
1147
|
*/
|
|
1134
|
-
|
|
1148
|
+
_id?: string;
|
|
1135
1149
|
/**
|
|
1136
1150
|
* Category name.
|
|
1137
1151
|
* @minLength 1
|
|
@@ -1142,7 +1156,7 @@ export interface EventCategory {
|
|
|
1142
1156
|
* Category creation timestamp.
|
|
1143
1157
|
* @readonly
|
|
1144
1158
|
*/
|
|
1145
|
-
|
|
1159
|
+
_createdDate?: Date | null;
|
|
1146
1160
|
/**
|
|
1147
1161
|
* Category is hidden.
|
|
1148
1162
|
* @readonly
|
|
@@ -1154,23 +1168,23 @@ export interface EventCategory {
|
|
|
1154
1168
|
*/
|
|
1155
1169
|
type?: CategoryTypeTypeWithLiterals;
|
|
1156
1170
|
}
|
|
1157
|
-
|
|
1171
|
+
declare enum CategoryTypeType {
|
|
1158
1172
|
/** Created manually by the user. */
|
|
1159
1173
|
MANUAL = "MANUAL",
|
|
1160
1174
|
/** Created automatically when publishing recurring events. */
|
|
1161
1175
|
RECURRING_EVENT = "RECURRING_EVENT"
|
|
1162
1176
|
}
|
|
1163
1177
|
/** @enumType */
|
|
1164
|
-
|
|
1165
|
-
|
|
1178
|
+
type CategoryTypeTypeWithLiterals = CategoryTypeType | 'MANUAL' | 'RECURRING_EVENT';
|
|
1179
|
+
interface V3EventDisplaySettings {
|
|
1166
1180
|
/** Whether event details button is hidden. Only available for events with no registration. */
|
|
1167
1181
|
hideEventDetailsButton?: boolean | null;
|
|
1168
1182
|
/** Disables event details page visibility. If event has an external registration configured visitors will be redirected from this page. */
|
|
1169
1183
|
hideEventDetailsPage?: boolean | null;
|
|
1170
1184
|
}
|
|
1171
|
-
|
|
1185
|
+
interface LabellingSettings {
|
|
1172
1186
|
}
|
|
1173
|
-
|
|
1187
|
+
interface RichContent {
|
|
1174
1188
|
/** Node objects representing a rich content document. */
|
|
1175
1189
|
nodes?: Node[];
|
|
1176
1190
|
/** Object metadata. */
|
|
@@ -1178,7 +1192,7 @@ export interface RichContent {
|
|
|
1178
1192
|
/** Global styling for header, paragraph, block quote, and code block nodes in the object. */
|
|
1179
1193
|
documentStyle?: DocumentStyle;
|
|
1180
1194
|
}
|
|
1181
|
-
|
|
1195
|
+
interface Node extends NodeDataOneOf {
|
|
1182
1196
|
/** Data for a button node. */
|
|
1183
1197
|
buttonData?: ButtonData;
|
|
1184
1198
|
/** Data for a code block node. */
|
|
@@ -1243,7 +1257,7 @@ export interface Node extends NodeDataOneOf {
|
|
|
1243
1257
|
style?: NodeStyle;
|
|
1244
1258
|
}
|
|
1245
1259
|
/** @oneof */
|
|
1246
|
-
|
|
1260
|
+
interface NodeDataOneOf {
|
|
1247
1261
|
/** Data for a button node. */
|
|
1248
1262
|
buttonData?: ButtonData;
|
|
1249
1263
|
/** Data for a code block node. */
|
|
@@ -1299,7 +1313,7 @@ export interface NodeDataOneOf {
|
|
|
1299
1313
|
/** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
|
|
1300
1314
|
layoutCellData?: LayoutCellData;
|
|
1301
1315
|
}
|
|
1302
|
-
|
|
1316
|
+
declare enum NodeType {
|
|
1303
1317
|
PARAGRAPH = "PARAGRAPH",
|
|
1304
1318
|
TEXT = "TEXT",
|
|
1305
1319
|
HEADING = "HEADING",
|
|
@@ -1336,8 +1350,8 @@ export declare enum NodeType {
|
|
|
1336
1350
|
LAYOUT_CELL = "LAYOUT_CELL"
|
|
1337
1351
|
}
|
|
1338
1352
|
/** @enumType */
|
|
1339
|
-
|
|
1340
|
-
|
|
1353
|
+
type NodeTypeWithLiterals = NodeType | 'PARAGRAPH' | 'TEXT' | 'HEADING' | 'BULLETED_LIST' | 'ORDERED_LIST' | 'LIST_ITEM' | 'BLOCKQUOTE' | 'CODE_BLOCK' | 'VIDEO' | 'DIVIDER' | 'FILE' | 'GALLERY' | 'GIF' | 'HTML' | 'IMAGE' | 'LINK_PREVIEW' | 'MAP' | 'POLL' | 'APP_EMBED' | 'BUTTON' | 'COLLAPSIBLE_LIST' | 'TABLE' | 'EMBED' | 'COLLAPSIBLE_ITEM' | 'COLLAPSIBLE_ITEM_TITLE' | 'COLLAPSIBLE_ITEM_BODY' | 'TABLE_CELL' | 'TABLE_ROW' | 'EXTERNAL' | 'AUDIO' | 'CAPTION' | 'LAYOUT' | 'LAYOUT_CELL';
|
|
1354
|
+
interface NodeStyle {
|
|
1341
1355
|
/** The top padding value in pixels. */
|
|
1342
1356
|
paddingTop?: string | null;
|
|
1343
1357
|
/** The bottom padding value in pixels. */
|
|
@@ -1345,7 +1359,7 @@ export interface NodeStyle {
|
|
|
1345
1359
|
/** The background color as a hexadecimal value. */
|
|
1346
1360
|
backgroundColor?: string | null;
|
|
1347
1361
|
}
|
|
1348
|
-
|
|
1362
|
+
interface ButtonData {
|
|
1349
1363
|
/** Styling for the button's container. */
|
|
1350
1364
|
containerData?: PluginContainerData;
|
|
1351
1365
|
/** The button type. */
|
|
@@ -1357,7 +1371,7 @@ export interface ButtonData {
|
|
|
1357
1371
|
/** Button link details. */
|
|
1358
1372
|
link?: Link;
|
|
1359
1373
|
}
|
|
1360
|
-
|
|
1374
|
+
interface Border {
|
|
1361
1375
|
/**
|
|
1362
1376
|
* Deprecated: Use `borderWidth` in `styles` instead.
|
|
1363
1377
|
* @deprecated
|
|
@@ -1369,7 +1383,7 @@ export interface Border {
|
|
|
1369
1383
|
*/
|
|
1370
1384
|
radius?: number | null;
|
|
1371
1385
|
}
|
|
1372
|
-
|
|
1386
|
+
interface Colors {
|
|
1373
1387
|
/**
|
|
1374
1388
|
* Deprecated: Use `textColor` in `styles` instead.
|
|
1375
1389
|
* @deprecated
|
|
@@ -1386,7 +1400,7 @@ export interface Colors {
|
|
|
1386
1400
|
*/
|
|
1387
1401
|
background?: string | null;
|
|
1388
1402
|
}
|
|
1389
|
-
|
|
1403
|
+
interface PluginContainerData {
|
|
1390
1404
|
/** The width of the node when it's displayed. */
|
|
1391
1405
|
width?: PluginContainerDataWidth;
|
|
1392
1406
|
/** The node's alignment within its container. */
|
|
@@ -1398,7 +1412,7 @@ export interface PluginContainerData {
|
|
|
1398
1412
|
/** 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`. */
|
|
1399
1413
|
textWrap?: boolean | null;
|
|
1400
1414
|
}
|
|
1401
|
-
|
|
1415
|
+
declare enum WidthType {
|
|
1402
1416
|
/** Width matches the content width */
|
|
1403
1417
|
CONTENT = "CONTENT",
|
|
1404
1418
|
/** Small Width */
|
|
@@ -1409,8 +1423,8 @@ export declare enum WidthType {
|
|
|
1409
1423
|
FULL_WIDTH = "FULL_WIDTH"
|
|
1410
1424
|
}
|
|
1411
1425
|
/** @enumType */
|
|
1412
|
-
|
|
1413
|
-
|
|
1426
|
+
type WidthTypeWithLiterals = WidthType | 'CONTENT' | 'SMALL' | 'ORIGINAL' | 'FULL_WIDTH';
|
|
1427
|
+
interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
1414
1428
|
/**
|
|
1415
1429
|
* One of the following predefined width options:
|
|
1416
1430
|
* `CONTENT`: The width of the container matches the content width.
|
|
@@ -1423,7 +1437,7 @@ export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOn
|
|
|
1423
1437
|
custom?: string | null;
|
|
1424
1438
|
}
|
|
1425
1439
|
/** @oneof */
|
|
1426
|
-
|
|
1440
|
+
interface PluginContainerDataWidthDataOneOf {
|
|
1427
1441
|
/**
|
|
1428
1442
|
* One of the following predefined width options:
|
|
1429
1443
|
* `CONTENT`: The width of the container matches the content width.
|
|
@@ -1435,7 +1449,7 @@ export interface PluginContainerDataWidthDataOneOf {
|
|
|
1435
1449
|
/** A custom width value in pixels. */
|
|
1436
1450
|
custom?: string | null;
|
|
1437
1451
|
}
|
|
1438
|
-
|
|
1452
|
+
declare enum PluginContainerDataAlignment {
|
|
1439
1453
|
/** Center Alignment */
|
|
1440
1454
|
CENTER = "CENTER",
|
|
1441
1455
|
/** Left Alignment */
|
|
@@ -1444,8 +1458,8 @@ export declare enum PluginContainerDataAlignment {
|
|
|
1444
1458
|
RIGHT = "RIGHT"
|
|
1445
1459
|
}
|
|
1446
1460
|
/** @enumType */
|
|
1447
|
-
|
|
1448
|
-
|
|
1461
|
+
type PluginContainerDataAlignmentWithLiterals = PluginContainerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
1462
|
+
interface Spoiler {
|
|
1449
1463
|
/** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
|
|
1450
1464
|
enabled?: boolean | null;
|
|
1451
1465
|
/** The description displayed on top of the spoiler cover. */
|
|
@@ -1453,19 +1467,19 @@ export interface Spoiler {
|
|
|
1453
1467
|
/** The text for the button used to remove the spoiler cover. */
|
|
1454
1468
|
buttonText?: string | null;
|
|
1455
1469
|
}
|
|
1456
|
-
|
|
1470
|
+
interface Height {
|
|
1457
1471
|
/** A custom height value in pixels. */
|
|
1458
1472
|
custom?: string | null;
|
|
1459
1473
|
}
|
|
1460
|
-
|
|
1474
|
+
declare enum ButtonDataType {
|
|
1461
1475
|
/** Regular link button */
|
|
1462
1476
|
LINK = "LINK",
|
|
1463
1477
|
/** Triggers custom action that is defined in plugin configuration by the consumer */
|
|
1464
1478
|
ACTION = "ACTION"
|
|
1465
1479
|
}
|
|
1466
1480
|
/** @enumType */
|
|
1467
|
-
|
|
1468
|
-
|
|
1481
|
+
type ButtonDataTypeWithLiterals = ButtonDataType | 'LINK' | 'ACTION';
|
|
1482
|
+
interface Styles {
|
|
1469
1483
|
/**
|
|
1470
1484
|
* Deprecated: Use `borderWidth` and `borderRadius` instead.
|
|
1471
1485
|
* @deprecated
|
|
@@ -1518,7 +1532,7 @@ export interface Styles {
|
|
|
1518
1532
|
/** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
|
|
1519
1533
|
buttonSize?: string | null;
|
|
1520
1534
|
}
|
|
1521
|
-
|
|
1535
|
+
interface Link extends LinkDataOneOf {
|
|
1522
1536
|
/** The absolute URL for the linked document. */
|
|
1523
1537
|
url?: string;
|
|
1524
1538
|
/** The target node's ID. Used for linking to another node in this object. */
|
|
@@ -1537,13 +1551,13 @@ export interface Link extends LinkDataOneOf {
|
|
|
1537
1551
|
customData?: string | null;
|
|
1538
1552
|
}
|
|
1539
1553
|
/** @oneof */
|
|
1540
|
-
|
|
1554
|
+
interface LinkDataOneOf {
|
|
1541
1555
|
/** The absolute URL for the linked document. */
|
|
1542
1556
|
url?: string;
|
|
1543
1557
|
/** The target node's ID. Used for linking to another node in this object. */
|
|
1544
1558
|
anchor?: string;
|
|
1545
1559
|
}
|
|
1546
|
-
|
|
1560
|
+
declare enum Target {
|
|
1547
1561
|
/** Opens the linked document in the same frame as it was clicked (this is default) */
|
|
1548
1562
|
SELF = "SELF",
|
|
1549
1563
|
/** Opens the linked document in a new window or tab */
|
|
@@ -1554,8 +1568,8 @@ export declare enum Target {
|
|
|
1554
1568
|
TOP = "TOP"
|
|
1555
1569
|
}
|
|
1556
1570
|
/** @enumType */
|
|
1557
|
-
|
|
1558
|
-
|
|
1571
|
+
type TargetWithLiterals = Target | 'SELF' | 'BLANK' | 'PARENT' | 'TOP';
|
|
1572
|
+
interface Rel {
|
|
1559
1573
|
/** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
|
|
1560
1574
|
nofollow?: boolean | null;
|
|
1561
1575
|
/** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
|
|
@@ -1565,17 +1579,17 @@ export interface Rel {
|
|
|
1565
1579
|
/** Indicates that this link protect referral information from being passed to the target website. */
|
|
1566
1580
|
noreferrer?: boolean | null;
|
|
1567
1581
|
}
|
|
1568
|
-
|
|
1582
|
+
interface CodeBlockData {
|
|
1569
1583
|
/** Styling for the code block's text. */
|
|
1570
1584
|
textStyle?: TextStyle;
|
|
1571
1585
|
}
|
|
1572
|
-
|
|
1586
|
+
interface TextStyle {
|
|
1573
1587
|
/** Text alignment. Defaults to `AUTO`. */
|
|
1574
1588
|
textAlignment?: TextAlignmentWithLiterals;
|
|
1575
1589
|
/** 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. */
|
|
1576
1590
|
lineHeight?: string | null;
|
|
1577
1591
|
}
|
|
1578
|
-
|
|
1592
|
+
declare enum TextAlignment {
|
|
1579
1593
|
/** browser default, eqivalent to `initial` */
|
|
1580
1594
|
AUTO = "AUTO",
|
|
1581
1595
|
/** Left align */
|
|
@@ -1588,8 +1602,8 @@ export declare enum TextAlignment {
|
|
|
1588
1602
|
JUSTIFY = "JUSTIFY"
|
|
1589
1603
|
}
|
|
1590
1604
|
/** @enumType */
|
|
1591
|
-
|
|
1592
|
-
|
|
1605
|
+
type TextAlignmentWithLiterals = TextAlignment | 'AUTO' | 'LEFT' | 'RIGHT' | 'CENTER' | 'JUSTIFY';
|
|
1606
|
+
interface DividerData {
|
|
1593
1607
|
/** Styling for the divider's container. */
|
|
1594
1608
|
containerData?: PluginContainerData;
|
|
1595
1609
|
/** Divider line style. */
|
|
@@ -1599,7 +1613,7 @@ export interface DividerData {
|
|
|
1599
1613
|
/** Divider alignment. */
|
|
1600
1614
|
alignment?: AlignmentWithLiterals;
|
|
1601
1615
|
}
|
|
1602
|
-
|
|
1616
|
+
declare enum LineStyle {
|
|
1603
1617
|
/** Single Line */
|
|
1604
1618
|
SINGLE = "SINGLE",
|
|
1605
1619
|
/** Double Line */
|
|
@@ -1610,8 +1624,8 @@ export declare enum LineStyle {
|
|
|
1610
1624
|
DOTTED = "DOTTED"
|
|
1611
1625
|
}
|
|
1612
1626
|
/** @enumType */
|
|
1613
|
-
|
|
1614
|
-
|
|
1627
|
+
type LineStyleWithLiterals = LineStyle | 'SINGLE' | 'DOUBLE' | 'DASHED' | 'DOTTED';
|
|
1628
|
+
declare enum Width {
|
|
1615
1629
|
/** Large line */
|
|
1616
1630
|
LARGE = "LARGE",
|
|
1617
1631
|
/** Medium line */
|
|
@@ -1620,8 +1634,8 @@ export declare enum Width {
|
|
|
1620
1634
|
SMALL = "SMALL"
|
|
1621
1635
|
}
|
|
1622
1636
|
/** @enumType */
|
|
1623
|
-
|
|
1624
|
-
|
|
1637
|
+
type WidthWithLiterals = Width | 'LARGE' | 'MEDIUM' | 'SMALL';
|
|
1638
|
+
declare enum Alignment {
|
|
1625
1639
|
/** Center alignment */
|
|
1626
1640
|
CENTER = "CENTER",
|
|
1627
1641
|
/** Left alignment */
|
|
@@ -1630,8 +1644,8 @@ export declare enum Alignment {
|
|
|
1630
1644
|
RIGHT = "RIGHT"
|
|
1631
1645
|
}
|
|
1632
1646
|
/** @enumType */
|
|
1633
|
-
|
|
1634
|
-
|
|
1647
|
+
type AlignmentWithLiterals = Alignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
1648
|
+
interface FileData {
|
|
1635
1649
|
/** Styling for the file's container. */
|
|
1636
1650
|
containerData?: PluginContainerData;
|
|
1637
1651
|
/** The source for the file's data. */
|
|
@@ -1654,7 +1668,7 @@ export interface FileData {
|
|
|
1654
1668
|
/** File size in KB. */
|
|
1655
1669
|
sizeInKb?: string | null;
|
|
1656
1670
|
}
|
|
1657
|
-
|
|
1671
|
+
declare enum ViewMode {
|
|
1658
1672
|
/** No PDF view */
|
|
1659
1673
|
NONE = "NONE",
|
|
1660
1674
|
/** Full PDF view */
|
|
@@ -1663,8 +1677,8 @@ export declare enum ViewMode {
|
|
|
1663
1677
|
MINI = "MINI"
|
|
1664
1678
|
}
|
|
1665
1679
|
/** @enumType */
|
|
1666
|
-
|
|
1667
|
-
|
|
1680
|
+
type ViewModeWithLiterals = ViewMode | 'NONE' | 'FULL' | 'MINI';
|
|
1681
|
+
interface FileSource extends FileSourceDataOneOf {
|
|
1668
1682
|
/** The absolute URL for the file's source. */
|
|
1669
1683
|
url?: string | null;
|
|
1670
1684
|
/**
|
|
@@ -1678,7 +1692,7 @@ export interface FileSource extends FileSourceDataOneOf {
|
|
|
1678
1692
|
private?: boolean | null;
|
|
1679
1693
|
}
|
|
1680
1694
|
/** @oneof */
|
|
1681
|
-
|
|
1695
|
+
interface FileSourceDataOneOf {
|
|
1682
1696
|
/** The absolute URL for the file's source. */
|
|
1683
1697
|
url?: string | null;
|
|
1684
1698
|
/**
|
|
@@ -1689,7 +1703,7 @@ export interface FileSourceDataOneOf {
|
|
|
1689
1703
|
/** An ID that's resolved to a URL by a resolver function. */
|
|
1690
1704
|
id?: string | null;
|
|
1691
1705
|
}
|
|
1692
|
-
|
|
1706
|
+
interface PDFSettings {
|
|
1693
1707
|
/**
|
|
1694
1708
|
* PDF view mode. One of the following:
|
|
1695
1709
|
* `NONE` : The PDF isn't displayed.
|
|
@@ -1702,7 +1716,7 @@ export interface PDFSettings {
|
|
|
1702
1716
|
/** Sets whether the PDF print button is disabled. Defaults to `false`. */
|
|
1703
1717
|
disablePrint?: boolean | null;
|
|
1704
1718
|
}
|
|
1705
|
-
|
|
1719
|
+
interface GalleryData {
|
|
1706
1720
|
/** Styling for the gallery's container. */
|
|
1707
1721
|
containerData?: PluginContainerData;
|
|
1708
1722
|
/** The items in the gallery. */
|
|
@@ -1714,7 +1728,7 @@ export interface GalleryData {
|
|
|
1714
1728
|
/** Sets whether the gallery's download button is disabled. Defaults to `false`. */
|
|
1715
1729
|
disableDownload?: boolean | null;
|
|
1716
1730
|
}
|
|
1717
|
-
|
|
1731
|
+
interface Media {
|
|
1718
1732
|
/** The source for the media's data. */
|
|
1719
1733
|
src?: FileSource;
|
|
1720
1734
|
/** Media width in pixels. */
|
|
@@ -1724,21 +1738,21 @@ export interface Media {
|
|
|
1724
1738
|
/** Media duration in seconds. Only relevant for audio and video files. */
|
|
1725
1739
|
duration?: number | null;
|
|
1726
1740
|
}
|
|
1727
|
-
|
|
1741
|
+
interface Image {
|
|
1728
1742
|
/** Image file details. */
|
|
1729
1743
|
media?: Media;
|
|
1730
1744
|
/** Link details for images that are links. */
|
|
1731
1745
|
link?: Link;
|
|
1732
1746
|
}
|
|
1733
|
-
|
|
1747
|
+
interface Video {
|
|
1734
1748
|
/** Video file details. */
|
|
1735
1749
|
media?: Media;
|
|
1736
1750
|
/** Video thumbnail file details. */
|
|
1737
1751
|
thumbnail?: Media;
|
|
1738
1752
|
}
|
|
1739
|
-
|
|
1753
|
+
interface Item extends ItemDataOneOf {
|
|
1740
1754
|
/** An image item. */
|
|
1741
|
-
image?:
|
|
1755
|
+
image?: Image;
|
|
1742
1756
|
/** A video item. */
|
|
1743
1757
|
video?: Video;
|
|
1744
1758
|
/** Item title. */
|
|
@@ -1747,13 +1761,13 @@ export interface Item extends ItemDataOneOf {
|
|
|
1747
1761
|
altText?: string | null;
|
|
1748
1762
|
}
|
|
1749
1763
|
/** @oneof */
|
|
1750
|
-
|
|
1764
|
+
interface ItemDataOneOf {
|
|
1751
1765
|
/** An image item. */
|
|
1752
|
-
image?:
|
|
1766
|
+
image?: Image;
|
|
1753
1767
|
/** A video item. */
|
|
1754
1768
|
video?: Video;
|
|
1755
1769
|
}
|
|
1756
|
-
|
|
1770
|
+
interface GalleryOptions {
|
|
1757
1771
|
/** Gallery layout. */
|
|
1758
1772
|
layout?: Layout;
|
|
1759
1773
|
/** Styling for gallery items. */
|
|
@@ -1761,7 +1775,7 @@ export interface GalleryOptions {
|
|
|
1761
1775
|
/** Styling for gallery thumbnail images. */
|
|
1762
1776
|
thumbnails?: Thumbnails;
|
|
1763
1777
|
}
|
|
1764
|
-
|
|
1778
|
+
declare enum LayoutType {
|
|
1765
1779
|
/** Collage type */
|
|
1766
1780
|
COLLAGE = "COLLAGE",
|
|
1767
1781
|
/** Masonry type */
|
|
@@ -1784,24 +1798,24 @@ export declare enum LayoutType {
|
|
|
1784
1798
|
FULLSIZE = "FULLSIZE"
|
|
1785
1799
|
}
|
|
1786
1800
|
/** @enumType */
|
|
1787
|
-
|
|
1788
|
-
|
|
1801
|
+
type LayoutTypeWithLiterals = LayoutType | 'COLLAGE' | 'MASONRY' | 'GRID' | 'THUMBNAIL' | 'SLIDER' | 'SLIDESHOW' | 'PANORAMA' | 'COLUMN' | 'MAGIC' | 'FULLSIZE';
|
|
1802
|
+
declare enum Orientation {
|
|
1789
1803
|
/** Rows Orientation */
|
|
1790
1804
|
ROWS = "ROWS",
|
|
1791
1805
|
/** Columns Orientation */
|
|
1792
1806
|
COLUMNS = "COLUMNS"
|
|
1793
1807
|
}
|
|
1794
1808
|
/** @enumType */
|
|
1795
|
-
|
|
1796
|
-
|
|
1809
|
+
type OrientationWithLiterals = Orientation | 'ROWS' | 'COLUMNS';
|
|
1810
|
+
declare enum Crop {
|
|
1797
1811
|
/** Crop to fill */
|
|
1798
1812
|
FILL = "FILL",
|
|
1799
1813
|
/** Crop to fit */
|
|
1800
1814
|
FIT = "FIT"
|
|
1801
1815
|
}
|
|
1802
1816
|
/** @enumType */
|
|
1803
|
-
|
|
1804
|
-
|
|
1817
|
+
type CropWithLiterals = Crop | 'FILL' | 'FIT';
|
|
1818
|
+
declare enum ThumbnailsAlignment {
|
|
1805
1819
|
/** Top alignment */
|
|
1806
1820
|
TOP = "TOP",
|
|
1807
1821
|
/** Right alignment */
|
|
@@ -1814,8 +1828,8 @@ export declare enum ThumbnailsAlignment {
|
|
|
1814
1828
|
NONE = "NONE"
|
|
1815
1829
|
}
|
|
1816
1830
|
/** @enumType */
|
|
1817
|
-
|
|
1818
|
-
|
|
1831
|
+
type ThumbnailsAlignmentWithLiterals = ThumbnailsAlignment | 'TOP' | 'RIGHT' | 'BOTTOM' | 'LEFT' | 'NONE';
|
|
1832
|
+
interface Layout {
|
|
1819
1833
|
/** Gallery layout type. */
|
|
1820
1834
|
type?: LayoutTypeWithLiterals;
|
|
1821
1835
|
/** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
|
|
@@ -1827,7 +1841,7 @@ export interface Layout {
|
|
|
1827
1841
|
/** The number of columns to display on mobile screens. */
|
|
1828
1842
|
mobileNumberOfColumns?: number | null;
|
|
1829
1843
|
}
|
|
1830
|
-
|
|
1844
|
+
interface ItemStyle {
|
|
1831
1845
|
/** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
|
|
1832
1846
|
targetSize?: number | null;
|
|
1833
1847
|
/** Item ratio */
|
|
@@ -1837,13 +1851,13 @@ export interface ItemStyle {
|
|
|
1837
1851
|
/** The spacing between items in pixels. */
|
|
1838
1852
|
spacing?: number | null;
|
|
1839
1853
|
}
|
|
1840
|
-
|
|
1854
|
+
interface Thumbnails {
|
|
1841
1855
|
/** Thumbnail alignment. */
|
|
1842
1856
|
placement?: ThumbnailsAlignmentWithLiterals;
|
|
1843
1857
|
/** Spacing between thumbnails in pixels. */
|
|
1844
1858
|
spacing?: number | null;
|
|
1845
1859
|
}
|
|
1846
|
-
|
|
1860
|
+
interface GIFData {
|
|
1847
1861
|
/** Styling for the GIF's container. */
|
|
1848
1862
|
containerData?: PluginContainerData;
|
|
1849
1863
|
/** The source of the full size GIF. */
|
|
@@ -1857,7 +1871,7 @@ export interface GIFData {
|
|
|
1857
1871
|
/** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
|
|
1858
1872
|
gifType?: GIFTypeWithLiterals;
|
|
1859
1873
|
}
|
|
1860
|
-
|
|
1874
|
+
interface GIF {
|
|
1861
1875
|
/**
|
|
1862
1876
|
* GIF format URL.
|
|
1863
1877
|
* @format WEB_URL
|
|
@@ -1874,13 +1888,13 @@ export interface GIF {
|
|
|
1874
1888
|
*/
|
|
1875
1889
|
still?: string | null;
|
|
1876
1890
|
}
|
|
1877
|
-
|
|
1891
|
+
declare enum GIFType {
|
|
1878
1892
|
NORMAL = "NORMAL",
|
|
1879
1893
|
STICKER = "STICKER"
|
|
1880
1894
|
}
|
|
1881
1895
|
/** @enumType */
|
|
1882
|
-
|
|
1883
|
-
|
|
1896
|
+
type GIFTypeWithLiterals = GIFType | 'NORMAL' | 'STICKER';
|
|
1897
|
+
interface HeadingData {
|
|
1884
1898
|
/** Heading level from 1-6. */
|
|
1885
1899
|
level?: number;
|
|
1886
1900
|
/** Styling for the heading text. */
|
|
@@ -1888,7 +1902,7 @@ export interface HeadingData {
|
|
|
1888
1902
|
/** Indentation level from 1-4. */
|
|
1889
1903
|
indentation?: number | null;
|
|
1890
1904
|
}
|
|
1891
|
-
|
|
1905
|
+
interface HTMLData extends HTMLDataDataOneOf {
|
|
1892
1906
|
/** The URL for the HTML code for the node. */
|
|
1893
1907
|
url?: string;
|
|
1894
1908
|
/** The HTML code for the node. */
|
|
@@ -1906,7 +1920,7 @@ export interface HTMLData extends HTMLDataDataOneOf {
|
|
|
1906
1920
|
autoHeight?: boolean | null;
|
|
1907
1921
|
}
|
|
1908
1922
|
/** @oneof */
|
|
1909
|
-
|
|
1923
|
+
interface HTMLDataDataOneOf {
|
|
1910
1924
|
/** The URL for the HTML code for the node. */
|
|
1911
1925
|
url?: string;
|
|
1912
1926
|
/** The HTML code for the node. */
|
|
@@ -1917,13 +1931,13 @@ export interface HTMLDataDataOneOf {
|
|
|
1917
1931
|
*/
|
|
1918
1932
|
isAdsense?: boolean | null;
|
|
1919
1933
|
}
|
|
1920
|
-
|
|
1934
|
+
declare enum Source {
|
|
1921
1935
|
HTML = "HTML",
|
|
1922
1936
|
ADSENSE = "ADSENSE"
|
|
1923
1937
|
}
|
|
1924
1938
|
/** @enumType */
|
|
1925
|
-
|
|
1926
|
-
|
|
1939
|
+
type SourceWithLiterals = Source | 'HTML' | 'ADSENSE';
|
|
1940
|
+
interface ImageData {
|
|
1927
1941
|
/** Styling for the image's container. */
|
|
1928
1942
|
containerData?: PluginContainerData;
|
|
1929
1943
|
/** Image file details. */
|
|
@@ -1946,7 +1960,7 @@ export interface ImageData {
|
|
|
1946
1960
|
/** Styling for the image. */
|
|
1947
1961
|
styles?: ImageDataStyles;
|
|
1948
1962
|
}
|
|
1949
|
-
|
|
1963
|
+
interface StylesBorder {
|
|
1950
1964
|
/** Border width in pixels. */
|
|
1951
1965
|
width?: number | null;
|
|
1952
1966
|
/**
|
|
@@ -1957,11 +1971,11 @@ export interface StylesBorder {
|
|
|
1957
1971
|
/** Border radius in pixels. */
|
|
1958
1972
|
radius?: number | null;
|
|
1959
1973
|
}
|
|
1960
|
-
|
|
1974
|
+
interface ImageDataStyles {
|
|
1961
1975
|
/** Border attributes. */
|
|
1962
1976
|
border?: StylesBorder;
|
|
1963
1977
|
}
|
|
1964
|
-
|
|
1978
|
+
interface LinkPreviewData {
|
|
1965
1979
|
/** Styling for the link preview's container. */
|
|
1966
1980
|
containerData?: PluginContainerData;
|
|
1967
1981
|
/** Link details. */
|
|
@@ -1977,7 +1991,7 @@ export interface LinkPreviewData {
|
|
|
1977
1991
|
/** Styling for the link preview. */
|
|
1978
1992
|
styles?: LinkPreviewDataStyles;
|
|
1979
1993
|
}
|
|
1980
|
-
|
|
1994
|
+
declare enum Position {
|
|
1981
1995
|
/** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
|
|
1982
1996
|
START = "START",
|
|
1983
1997
|
/** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
|
|
@@ -1988,8 +2002,8 @@ export declare enum Position {
|
|
|
1988
2002
|
HIDDEN = "HIDDEN"
|
|
1989
2003
|
}
|
|
1990
2004
|
/** @enumType */
|
|
1991
|
-
|
|
1992
|
-
|
|
2005
|
+
type PositionWithLiterals = Position | 'START' | 'END' | 'TOP' | 'HIDDEN';
|
|
2006
|
+
interface LinkPreviewDataStyles {
|
|
1993
2007
|
/**
|
|
1994
2008
|
* Background color as a hexadecimal value.
|
|
1995
2009
|
* @format COLOR_HEX
|
|
@@ -2022,13 +2036,13 @@ export interface LinkPreviewDataStyles {
|
|
|
2022
2036
|
/** Position of thumbnail. Defaults to `START`. */
|
|
2023
2037
|
thumbnailPosition?: PositionWithLiterals;
|
|
2024
2038
|
}
|
|
2025
|
-
|
|
2039
|
+
interface MapData {
|
|
2026
2040
|
/** Styling for the map's container. */
|
|
2027
2041
|
containerData?: PluginContainerData;
|
|
2028
2042
|
/** Map settings. */
|
|
2029
2043
|
mapSettings?: MapSettings;
|
|
2030
2044
|
}
|
|
2031
|
-
|
|
2045
|
+
interface MapSettings {
|
|
2032
2046
|
/** The address to display on the map. */
|
|
2033
2047
|
address?: string | null;
|
|
2034
2048
|
/** Sets whether the map is draggable. */
|
|
@@ -2052,7 +2066,7 @@ export interface MapSettings {
|
|
|
2052
2066
|
/** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
|
|
2053
2067
|
mapType?: MapTypeWithLiterals;
|
|
2054
2068
|
}
|
|
2055
|
-
|
|
2069
|
+
declare enum MapType {
|
|
2056
2070
|
/** Roadmap map type */
|
|
2057
2071
|
ROADMAP = "ROADMAP",
|
|
2058
2072
|
/** Satellite map type */
|
|
@@ -2063,8 +2077,8 @@ export declare enum MapType {
|
|
|
2063
2077
|
TERRAIN = "TERRAIN"
|
|
2064
2078
|
}
|
|
2065
2079
|
/** @enumType */
|
|
2066
|
-
|
|
2067
|
-
|
|
2080
|
+
type MapTypeWithLiterals = MapType | 'ROADMAP' | 'SATELITE' | 'HYBRID' | 'TERRAIN';
|
|
2081
|
+
interface ParagraphData {
|
|
2068
2082
|
/** Styling for the paragraph text. */
|
|
2069
2083
|
textStyle?: TextStyle;
|
|
2070
2084
|
/** Indentation level from 1-4. */
|
|
@@ -2072,7 +2086,7 @@ export interface ParagraphData {
|
|
|
2072
2086
|
/** Paragraph level */
|
|
2073
2087
|
level?: number | null;
|
|
2074
2088
|
}
|
|
2075
|
-
|
|
2089
|
+
interface PollData {
|
|
2076
2090
|
/** Styling for the poll's container. */
|
|
2077
2091
|
containerData?: PluginContainerData;
|
|
2078
2092
|
/** Poll data. */
|
|
@@ -2082,7 +2096,7 @@ export interface PollData {
|
|
|
2082
2096
|
/** Styling for the poll and voting options. */
|
|
2083
2097
|
design?: Design;
|
|
2084
2098
|
}
|
|
2085
|
-
|
|
2099
|
+
declare enum ViewRole {
|
|
2086
2100
|
/** Only Poll creator can view the results */
|
|
2087
2101
|
CREATOR = "CREATOR",
|
|
2088
2102
|
/** Anyone who voted can see the results */
|
|
@@ -2091,16 +2105,16 @@ export declare enum ViewRole {
|
|
|
2091
2105
|
EVERYONE = "EVERYONE"
|
|
2092
2106
|
}
|
|
2093
2107
|
/** @enumType */
|
|
2094
|
-
|
|
2095
|
-
|
|
2108
|
+
type ViewRoleWithLiterals = ViewRole | 'CREATOR' | 'VOTERS' | 'EVERYONE';
|
|
2109
|
+
declare enum VoteRole {
|
|
2096
2110
|
/** Logged in member */
|
|
2097
2111
|
SITE_MEMBERS = "SITE_MEMBERS",
|
|
2098
2112
|
/** Anyone */
|
|
2099
2113
|
ALL = "ALL"
|
|
2100
2114
|
}
|
|
2101
2115
|
/** @enumType */
|
|
2102
|
-
|
|
2103
|
-
|
|
2116
|
+
type VoteRoleWithLiterals = VoteRole | 'SITE_MEMBERS' | 'ALL';
|
|
2117
|
+
interface Permissions {
|
|
2104
2118
|
/** Sets who can view the poll results. */
|
|
2105
2119
|
view?: ViewRoleWithLiterals;
|
|
2106
2120
|
/** Sets who can vote. */
|
|
@@ -2108,7 +2122,7 @@ export interface Permissions {
|
|
|
2108
2122
|
/** Sets whether one voter can vote multiple times. Defaults to `false`. */
|
|
2109
2123
|
allowMultipleVotes?: boolean | null;
|
|
2110
2124
|
}
|
|
2111
|
-
|
|
2125
|
+
interface Option {
|
|
2112
2126
|
/** Option ID. */
|
|
2113
2127
|
id?: string | null;
|
|
2114
2128
|
/** Option title. */
|
|
@@ -2116,7 +2130,7 @@ export interface Option {
|
|
|
2116
2130
|
/** The image displayed with the option. */
|
|
2117
2131
|
image?: Media;
|
|
2118
2132
|
}
|
|
2119
|
-
|
|
2133
|
+
interface PollSettings {
|
|
2120
2134
|
/** Permissions settings for voting. */
|
|
2121
2135
|
permissions?: Permissions;
|
|
2122
2136
|
/** Sets whether voters are displayed in the vote results. Defaults to `true`. */
|
|
@@ -2124,23 +2138,23 @@ export interface PollSettings {
|
|
|
2124
2138
|
/** Sets whether the vote count is displayed. Defaults to `true`. */
|
|
2125
2139
|
showVotesCount?: boolean | null;
|
|
2126
2140
|
}
|
|
2127
|
-
|
|
2141
|
+
declare enum PollLayoutType {
|
|
2128
2142
|
/** List */
|
|
2129
2143
|
LIST = "LIST",
|
|
2130
2144
|
/** Grid */
|
|
2131
2145
|
GRID = "GRID"
|
|
2132
2146
|
}
|
|
2133
2147
|
/** @enumType */
|
|
2134
|
-
|
|
2135
|
-
|
|
2148
|
+
type PollLayoutTypeWithLiterals = PollLayoutType | 'LIST' | 'GRID';
|
|
2149
|
+
declare enum PollLayoutDirection {
|
|
2136
2150
|
/** Left-to-right */
|
|
2137
2151
|
LTR = "LTR",
|
|
2138
2152
|
/** Right-to-left */
|
|
2139
2153
|
RTL = "RTL"
|
|
2140
2154
|
}
|
|
2141
2155
|
/** @enumType */
|
|
2142
|
-
|
|
2143
|
-
|
|
2156
|
+
type PollLayoutDirectionWithLiterals = PollLayoutDirection | 'LTR' | 'RTL';
|
|
2157
|
+
interface PollLayout {
|
|
2144
2158
|
/** The layout for displaying the voting options. */
|
|
2145
2159
|
type?: PollLayoutTypeWithLiterals;
|
|
2146
2160
|
/** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
|
|
@@ -2148,11 +2162,11 @@ export interface PollLayout {
|
|
|
2148
2162
|
/** Sets whether to display the main poll image. Defaults to `false`. */
|
|
2149
2163
|
enableImage?: boolean | null;
|
|
2150
2164
|
}
|
|
2151
|
-
|
|
2165
|
+
interface OptionLayout {
|
|
2152
2166
|
/** Sets whether to display option images. Defaults to `false`. */
|
|
2153
2167
|
enableImage?: boolean | null;
|
|
2154
2168
|
}
|
|
2155
|
-
|
|
2169
|
+
declare enum BackgroundType {
|
|
2156
2170
|
/** Color background type */
|
|
2157
2171
|
COLOR = "COLOR",
|
|
2158
2172
|
/** Image background type */
|
|
@@ -2161,8 +2175,8 @@ export declare enum BackgroundType {
|
|
|
2161
2175
|
GRADIENT = "GRADIENT"
|
|
2162
2176
|
}
|
|
2163
2177
|
/** @enumType */
|
|
2164
|
-
|
|
2165
|
-
|
|
2178
|
+
type BackgroundTypeWithLiterals = BackgroundType | 'COLOR' | 'IMAGE' | 'GRADIENT';
|
|
2179
|
+
interface Gradient {
|
|
2166
2180
|
/** The gradient angle in degrees. */
|
|
2167
2181
|
angle?: number | null;
|
|
2168
2182
|
/**
|
|
@@ -2176,7 +2190,7 @@ export interface Gradient {
|
|
|
2176
2190
|
*/
|
|
2177
2191
|
lastColor?: string | null;
|
|
2178
2192
|
}
|
|
2179
|
-
|
|
2193
|
+
interface Background extends BackgroundBackgroundOneOf {
|
|
2180
2194
|
/**
|
|
2181
2195
|
* The background color as a hexademical value.
|
|
2182
2196
|
* @format COLOR_HEX
|
|
@@ -2190,7 +2204,7 @@ export interface Background extends BackgroundBackgroundOneOf {
|
|
|
2190
2204
|
type?: BackgroundTypeWithLiterals;
|
|
2191
2205
|
}
|
|
2192
2206
|
/** @oneof */
|
|
2193
|
-
|
|
2207
|
+
interface BackgroundBackgroundOneOf {
|
|
2194
2208
|
/**
|
|
2195
2209
|
* The background color as a hexademical value.
|
|
2196
2210
|
* @format COLOR_HEX
|
|
@@ -2201,17 +2215,17 @@ export interface BackgroundBackgroundOneOf {
|
|
|
2201
2215
|
/** Details for a gradient background. */
|
|
2202
2216
|
gradient?: Gradient;
|
|
2203
2217
|
}
|
|
2204
|
-
|
|
2218
|
+
interface PollDesign {
|
|
2205
2219
|
/** Background styling. */
|
|
2206
2220
|
background?: Background;
|
|
2207
2221
|
/** Border radius in pixels. */
|
|
2208
2222
|
borderRadius?: number | null;
|
|
2209
2223
|
}
|
|
2210
|
-
|
|
2224
|
+
interface OptionDesign {
|
|
2211
2225
|
/** Border radius in pixels. */
|
|
2212
2226
|
borderRadius?: number | null;
|
|
2213
2227
|
}
|
|
2214
|
-
|
|
2228
|
+
interface Poll {
|
|
2215
2229
|
/** Poll ID. */
|
|
2216
2230
|
id?: string | null;
|
|
2217
2231
|
/** Poll title. */
|
|
@@ -2225,26 +2239,26 @@ export interface Poll {
|
|
|
2225
2239
|
/** The poll's permissions and display settings. */
|
|
2226
2240
|
settings?: PollSettings;
|
|
2227
2241
|
}
|
|
2228
|
-
|
|
2242
|
+
interface PollDataLayout {
|
|
2229
2243
|
/** Poll layout settings. */
|
|
2230
2244
|
poll?: PollLayout;
|
|
2231
2245
|
/** Voting otpions layout settings. */
|
|
2232
2246
|
options?: OptionLayout;
|
|
2233
2247
|
}
|
|
2234
|
-
|
|
2248
|
+
interface Design {
|
|
2235
2249
|
/** Styling for the poll. */
|
|
2236
2250
|
poll?: PollDesign;
|
|
2237
2251
|
/** Styling for voting options. */
|
|
2238
2252
|
options?: OptionDesign;
|
|
2239
2253
|
}
|
|
2240
|
-
|
|
2254
|
+
interface TextData {
|
|
2241
2255
|
/** The text to apply decorations to. */
|
|
2242
2256
|
text?: string;
|
|
2243
2257
|
/** The decorations to apply. */
|
|
2244
2258
|
decorations?: Decoration[];
|
|
2245
2259
|
}
|
|
2246
2260
|
/** Adds appearence changes to text */
|
|
2247
|
-
|
|
2261
|
+
interface Decoration extends DecorationDataOneOf {
|
|
2248
2262
|
/** Data for an anchor link decoration. */
|
|
2249
2263
|
anchorData?: AnchorData;
|
|
2250
2264
|
/** Data for a color decoration. */
|
|
@@ -2269,7 +2283,7 @@ export interface Decoration extends DecorationDataOneOf {
|
|
|
2269
2283
|
type?: DecorationTypeWithLiterals;
|
|
2270
2284
|
}
|
|
2271
2285
|
/** @oneof */
|
|
2272
|
-
|
|
2286
|
+
interface DecorationDataOneOf {
|
|
2273
2287
|
/** Data for an anchor link decoration. */
|
|
2274
2288
|
anchorData?: AnchorData;
|
|
2275
2289
|
/** Data for a color decoration. */
|
|
@@ -2291,7 +2305,7 @@ export interface DecorationDataOneOf {
|
|
|
2291
2305
|
/** Data for a strikethrough decoration. Defaults to `true`. */
|
|
2292
2306
|
strikethroughData?: boolean | null;
|
|
2293
2307
|
}
|
|
2294
|
-
|
|
2308
|
+
declare enum DecorationType {
|
|
2295
2309
|
BOLD = "BOLD",
|
|
2296
2310
|
ITALIC = "ITALIC",
|
|
2297
2311
|
UNDERLINE = "UNDERLINE",
|
|
@@ -2305,22 +2319,22 @@ export declare enum DecorationType {
|
|
|
2305
2319
|
STRIKETHROUGH = "STRIKETHROUGH"
|
|
2306
2320
|
}
|
|
2307
2321
|
/** @enumType */
|
|
2308
|
-
|
|
2309
|
-
|
|
2322
|
+
type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL' | 'STRIKETHROUGH';
|
|
2323
|
+
interface AnchorData {
|
|
2310
2324
|
/** The target node's ID. */
|
|
2311
2325
|
anchor?: string;
|
|
2312
2326
|
}
|
|
2313
|
-
|
|
2327
|
+
interface ColorData {
|
|
2314
2328
|
/** The text's background color as a hexadecimal value. */
|
|
2315
2329
|
background?: string | null;
|
|
2316
2330
|
/** The text's foreground color as a hexadecimal value. */
|
|
2317
2331
|
foreground?: string | null;
|
|
2318
2332
|
}
|
|
2319
|
-
|
|
2333
|
+
interface LinkData {
|
|
2320
2334
|
/** Link details. */
|
|
2321
2335
|
link?: Link;
|
|
2322
2336
|
}
|
|
2323
|
-
|
|
2337
|
+
interface MentionData {
|
|
2324
2338
|
/** The mentioned user's name. */
|
|
2325
2339
|
name?: string;
|
|
2326
2340
|
/** The version of the user's name that appears after the `@` character in the mention. */
|
|
@@ -2328,23 +2342,23 @@ export interface MentionData {
|
|
|
2328
2342
|
/** Mentioned user's ID. */
|
|
2329
2343
|
id?: string | null;
|
|
2330
2344
|
}
|
|
2331
|
-
|
|
2345
|
+
interface FontSizeData {
|
|
2332
2346
|
/** The units used for the font size. */
|
|
2333
2347
|
unit?: FontTypeWithLiterals;
|
|
2334
2348
|
/** Font size value. */
|
|
2335
2349
|
value?: number | null;
|
|
2336
2350
|
}
|
|
2337
|
-
|
|
2351
|
+
declare enum FontType {
|
|
2338
2352
|
PX = "PX",
|
|
2339
2353
|
EM = "EM"
|
|
2340
2354
|
}
|
|
2341
2355
|
/** @enumType */
|
|
2342
|
-
|
|
2343
|
-
|
|
2356
|
+
type FontTypeWithLiterals = FontType | 'PX' | 'EM';
|
|
2357
|
+
interface SpoilerData {
|
|
2344
2358
|
/** Spoiler ID. */
|
|
2345
2359
|
id?: string | null;
|
|
2346
2360
|
}
|
|
2347
|
-
|
|
2361
|
+
interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
2348
2362
|
/** Data for embedded Wix Bookings content. */
|
|
2349
2363
|
bookingData?: BookingData;
|
|
2350
2364
|
/** Data for embedded Wix Events content. */
|
|
@@ -2366,30 +2380,30 @@ export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
|
2366
2380
|
image?: Media;
|
|
2367
2381
|
}
|
|
2368
2382
|
/** @oneof */
|
|
2369
|
-
|
|
2383
|
+
interface AppEmbedDataAppDataOneOf {
|
|
2370
2384
|
/** Data for embedded Wix Bookings content. */
|
|
2371
2385
|
bookingData?: BookingData;
|
|
2372
2386
|
/** Data for embedded Wix Events content. */
|
|
2373
2387
|
eventData?: EventData;
|
|
2374
2388
|
}
|
|
2375
|
-
|
|
2389
|
+
declare enum AppType {
|
|
2376
2390
|
PRODUCT = "PRODUCT",
|
|
2377
2391
|
EVENT = "EVENT",
|
|
2378
2392
|
BOOKING = "BOOKING"
|
|
2379
2393
|
}
|
|
2380
2394
|
/** @enumType */
|
|
2381
|
-
|
|
2382
|
-
|
|
2395
|
+
type AppTypeWithLiterals = AppType | 'PRODUCT' | 'EVENT' | 'BOOKING';
|
|
2396
|
+
interface BookingData {
|
|
2383
2397
|
/** Booking duration in minutes. */
|
|
2384
2398
|
durations?: string | null;
|
|
2385
2399
|
}
|
|
2386
|
-
|
|
2400
|
+
interface EventData {
|
|
2387
2401
|
/** Event schedule. */
|
|
2388
2402
|
scheduling?: string | null;
|
|
2389
2403
|
/** Event location. */
|
|
2390
2404
|
location?: string | null;
|
|
2391
2405
|
}
|
|
2392
|
-
|
|
2406
|
+
interface VideoData {
|
|
2393
2407
|
/** Styling for the video's container. */
|
|
2394
2408
|
containerData?: PluginContainerData;
|
|
2395
2409
|
/** Video details. */
|
|
@@ -2403,7 +2417,7 @@ export interface VideoData {
|
|
|
2403
2417
|
/** Video options. */
|
|
2404
2418
|
options?: PlaybackOptions;
|
|
2405
2419
|
}
|
|
2406
|
-
|
|
2420
|
+
interface PlaybackOptions {
|
|
2407
2421
|
/** Sets whether the media will automatically start playing. */
|
|
2408
2422
|
autoPlay?: boolean | null;
|
|
2409
2423
|
/** Sets whether media's will be looped. */
|
|
@@ -2411,7 +2425,7 @@ export interface PlaybackOptions {
|
|
|
2411
2425
|
/** Sets whether media's controls will be shown. */
|
|
2412
2426
|
showControls?: boolean | null;
|
|
2413
2427
|
}
|
|
2414
|
-
|
|
2428
|
+
interface EmbedData {
|
|
2415
2429
|
/** Styling for the oEmbed node's container. */
|
|
2416
2430
|
containerData?: PluginContainerData;
|
|
2417
2431
|
/** An [oEmbed](https://www.oembed.com) object. */
|
|
@@ -2419,7 +2433,7 @@ export interface EmbedData {
|
|
|
2419
2433
|
/** Origin asset source. */
|
|
2420
2434
|
src?: string | null;
|
|
2421
2435
|
}
|
|
2422
|
-
|
|
2436
|
+
interface Oembed {
|
|
2423
2437
|
/** The resource type. */
|
|
2424
2438
|
type?: string | null;
|
|
2425
2439
|
/** The width of the resource specified in the `url` property in pixels. */
|
|
@@ -2451,7 +2465,7 @@ export interface Oembed {
|
|
|
2451
2465
|
/** The oEmbed version number. This value must be `1.0`. */
|
|
2452
2466
|
version?: string | null;
|
|
2453
2467
|
}
|
|
2454
|
-
|
|
2468
|
+
interface CollapsibleListData {
|
|
2455
2469
|
/** Styling for the collapsible list's container. */
|
|
2456
2470
|
containerData?: PluginContainerData;
|
|
2457
2471
|
/** If `true`, only one item can be expanded at a time. Defaults to `false`. */
|
|
@@ -2463,7 +2477,7 @@ export interface CollapsibleListData {
|
|
|
2463
2477
|
/** If `true`, The collapsible item will appear in search results as an FAQ. */
|
|
2464
2478
|
isQapageData?: boolean | null;
|
|
2465
2479
|
}
|
|
2466
|
-
|
|
2480
|
+
declare enum InitialExpandedItems {
|
|
2467
2481
|
/** First item will be expended initally */
|
|
2468
2482
|
FIRST = "FIRST",
|
|
2469
2483
|
/** All items will expended initally */
|
|
@@ -2472,16 +2486,16 @@ export declare enum InitialExpandedItems {
|
|
|
2472
2486
|
NONE = "NONE"
|
|
2473
2487
|
}
|
|
2474
2488
|
/** @enumType */
|
|
2475
|
-
|
|
2476
|
-
|
|
2489
|
+
type InitialExpandedItemsWithLiterals = InitialExpandedItems | 'FIRST' | 'ALL' | 'NONE';
|
|
2490
|
+
declare enum Direction {
|
|
2477
2491
|
/** Left-to-right */
|
|
2478
2492
|
LTR = "LTR",
|
|
2479
2493
|
/** Right-to-left */
|
|
2480
2494
|
RTL = "RTL"
|
|
2481
2495
|
}
|
|
2482
2496
|
/** @enumType */
|
|
2483
|
-
|
|
2484
|
-
|
|
2497
|
+
type DirectionWithLiterals = Direction | 'LTR' | 'RTL';
|
|
2498
|
+
interface TableData {
|
|
2485
2499
|
/** Styling for the table's container. */
|
|
2486
2500
|
containerData?: PluginContainerData;
|
|
2487
2501
|
/** The table's dimensions. */
|
|
@@ -2496,7 +2510,7 @@ export interface TableData {
|
|
|
2496
2510
|
/** Sets whether the table's first column is a header. Defaults to `false`. */
|
|
2497
2511
|
columnHeader?: boolean | null;
|
|
2498
2512
|
}
|
|
2499
|
-
|
|
2513
|
+
interface Dimensions {
|
|
2500
2514
|
/** An array representing relative width of each column in relation to the other columns. */
|
|
2501
2515
|
colsWidthRatio?: number[];
|
|
2502
2516
|
/** An array representing the height of each row in pixels. */
|
|
@@ -2504,13 +2518,13 @@ export interface Dimensions {
|
|
|
2504
2518
|
/** An array representing the minimum width of each column in pixels. */
|
|
2505
2519
|
colsMinWidth?: number[];
|
|
2506
2520
|
}
|
|
2507
|
-
|
|
2521
|
+
interface TableCellData {
|
|
2508
2522
|
/** Styling for the cell's background color and text alignment. */
|
|
2509
2523
|
cellStyle?: CellStyle;
|
|
2510
2524
|
/** The cell's border colors. */
|
|
2511
2525
|
borderColors?: BorderColors;
|
|
2512
2526
|
}
|
|
2513
|
-
|
|
2527
|
+
declare enum VerticalAlignment {
|
|
2514
2528
|
/** Top alignment */
|
|
2515
2529
|
TOP = "TOP",
|
|
2516
2530
|
/** Middle alignment */
|
|
@@ -2519,8 +2533,8 @@ export declare enum VerticalAlignment {
|
|
|
2519
2533
|
BOTTOM = "BOTTOM"
|
|
2520
2534
|
}
|
|
2521
2535
|
/** @enumType */
|
|
2522
|
-
|
|
2523
|
-
|
|
2536
|
+
type VerticalAlignmentWithLiterals = VerticalAlignment | 'TOP' | 'MIDDLE' | 'BOTTOM';
|
|
2537
|
+
interface CellStyle {
|
|
2524
2538
|
/** Vertical alignment for the cell's text. */
|
|
2525
2539
|
verticalAlignment?: VerticalAlignmentWithLiterals;
|
|
2526
2540
|
/**
|
|
@@ -2529,7 +2543,7 @@ export interface CellStyle {
|
|
|
2529
2543
|
*/
|
|
2530
2544
|
backgroundColor?: string | null;
|
|
2531
2545
|
}
|
|
2532
|
-
|
|
2546
|
+
interface BorderColors {
|
|
2533
2547
|
/**
|
|
2534
2548
|
* Left border color as a hexadecimal value.
|
|
2535
2549
|
* @format COLOR_HEX
|
|
@@ -2557,22 +2571,20 @@ export interface BorderColors {
|
|
|
2557
2571
|
*
|
|
2558
2572
|
* The JSON representation for `NullValue` is JSON `null`.
|
|
2559
2573
|
*/
|
|
2560
|
-
|
|
2574
|
+
declare enum NullValue {
|
|
2561
2575
|
/** Null value. */
|
|
2562
2576
|
NULL_VALUE = "NULL_VALUE"
|
|
2563
2577
|
}
|
|
2564
|
-
/** @enumType */
|
|
2565
|
-
export type NullValueWithLiterals = NullValue | 'NULL_VALUE';
|
|
2566
2578
|
/**
|
|
2567
2579
|
* `ListValue` is a wrapper around a repeated field of values.
|
|
2568
2580
|
*
|
|
2569
2581
|
* The JSON representation for `ListValue` is JSON array.
|
|
2570
2582
|
*/
|
|
2571
|
-
|
|
2583
|
+
interface ListValue {
|
|
2572
2584
|
/** Repeated field of dynamically typed values. */
|
|
2573
2585
|
values?: any[];
|
|
2574
2586
|
}
|
|
2575
|
-
|
|
2587
|
+
interface AudioData {
|
|
2576
2588
|
/** Styling for the audio node's container. */
|
|
2577
2589
|
containerData?: PluginContainerData;
|
|
2578
2590
|
/** Audio file details. */
|
|
@@ -2588,7 +2600,7 @@ export interface AudioData {
|
|
|
2588
2600
|
/** An HTML version of the audio node. */
|
|
2589
2601
|
html?: string | null;
|
|
2590
2602
|
}
|
|
2591
|
-
|
|
2603
|
+
interface OrderedListData {
|
|
2592
2604
|
/** Indentation level from 0-4. */
|
|
2593
2605
|
indentation?: number;
|
|
2594
2606
|
/** Offset level from 0-4. */
|
|
@@ -2596,24 +2608,24 @@ export interface OrderedListData {
|
|
|
2596
2608
|
/** List start number. */
|
|
2597
2609
|
start?: number | null;
|
|
2598
2610
|
}
|
|
2599
|
-
|
|
2611
|
+
interface BulletedListData {
|
|
2600
2612
|
/** Indentation level from 0-4. */
|
|
2601
2613
|
indentation?: number;
|
|
2602
2614
|
/** Offset level from 0-4. */
|
|
2603
2615
|
offset?: number | null;
|
|
2604
2616
|
}
|
|
2605
|
-
|
|
2617
|
+
interface BlockquoteData {
|
|
2606
2618
|
/** Indentation level from 1-4. */
|
|
2607
2619
|
indentation?: number;
|
|
2608
2620
|
}
|
|
2609
|
-
|
|
2621
|
+
interface CaptionData {
|
|
2610
2622
|
textStyle?: TextStyle;
|
|
2611
2623
|
}
|
|
2612
|
-
|
|
2624
|
+
interface LayoutCellData {
|
|
2613
2625
|
/** Size of the cell in 12 columns grid. */
|
|
2614
2626
|
colSpan?: number | null;
|
|
2615
2627
|
}
|
|
2616
|
-
|
|
2628
|
+
interface Metadata {
|
|
2617
2629
|
/** Schema version. */
|
|
2618
2630
|
version?: number;
|
|
2619
2631
|
/**
|
|
@@ -2628,9 +2640,9 @@ export interface Metadata {
|
|
|
2628
2640
|
*/
|
|
2629
2641
|
updatedTimestamp?: Date | null;
|
|
2630
2642
|
/** Object ID. */
|
|
2631
|
-
|
|
2643
|
+
_id?: string | null;
|
|
2632
2644
|
}
|
|
2633
|
-
|
|
2645
|
+
interface DocumentStyle {
|
|
2634
2646
|
/** Styling for H1 nodes. */
|
|
2635
2647
|
headerOne?: TextNodeStyle;
|
|
2636
2648
|
/** Styling for H2 nodes. */
|
|
@@ -2650,7 +2662,7 @@ export interface DocumentStyle {
|
|
|
2650
2662
|
/** Styling for code block nodes. */
|
|
2651
2663
|
codeBlock?: TextNodeStyle;
|
|
2652
2664
|
}
|
|
2653
|
-
|
|
2665
|
+
interface TextNodeStyle {
|
|
2654
2666
|
/** The decorations to apply to the node. */
|
|
2655
2667
|
decorations?: Decoration[];
|
|
2656
2668
|
/** Padding and background color for the node. */
|
|
@@ -2658,14 +2670,14 @@ export interface TextNodeStyle {
|
|
|
2658
2670
|
/** Line height for text in the node. */
|
|
2659
2671
|
lineHeight?: string | null;
|
|
2660
2672
|
}
|
|
2661
|
-
|
|
2673
|
+
interface BadgeList {
|
|
2662
2674
|
/**
|
|
2663
2675
|
* Events badges.
|
|
2664
2676
|
* @maxSize 10
|
|
2665
2677
|
*/
|
|
2666
2678
|
badges?: V3Badge[];
|
|
2667
2679
|
}
|
|
2668
|
-
|
|
2680
|
+
interface V3Badge {
|
|
2669
2681
|
/** Badge type. */
|
|
2670
2682
|
type?: BadgeTypeTypeWithLiterals;
|
|
2671
2683
|
/**
|
|
@@ -2674,7 +2686,7 @@ export interface V3Badge {
|
|
|
2674
2686
|
*/
|
|
2675
2687
|
text?: string | null;
|
|
2676
2688
|
}
|
|
2677
|
-
|
|
2689
|
+
declare enum BadgeTypeType {
|
|
2678
2690
|
/** Unknown badge type. */
|
|
2679
2691
|
UNKNOWN_BADGE_TYPE = "UNKNOWN_BADGE_TYPE",
|
|
2680
2692
|
/** 1st priority badge type. */
|
|
@@ -2685,8 +2697,8 @@ export declare enum BadgeTypeType {
|
|
|
2685
2697
|
THIRD_PRIORITY = "THIRD_PRIORITY"
|
|
2686
2698
|
}
|
|
2687
2699
|
/** @enumType */
|
|
2688
|
-
|
|
2689
|
-
|
|
2700
|
+
type BadgeTypeTypeWithLiterals = BadgeTypeType | 'UNKNOWN_BADGE_TYPE' | 'FIRST_PRIORITY' | 'SECOND_PRIORITY' | 'THIRD_PRIORITY';
|
|
2701
|
+
interface EventEventStarted {
|
|
2690
2702
|
/** Event schedule configuration. */
|
|
2691
2703
|
timestamp?: Date | null;
|
|
2692
2704
|
/**
|
|
@@ -2697,7 +2709,7 @@ export interface EventEventStarted {
|
|
|
2697
2709
|
/** True if at least one guest is registered to the event with any attendance status. */
|
|
2698
2710
|
hasGuests?: boolean | null;
|
|
2699
2711
|
}
|
|
2700
|
-
|
|
2712
|
+
interface EventEventEnded {
|
|
2701
2713
|
/** Event end timestamp in ISO UTC format. */
|
|
2702
2714
|
timestamp?: Date | null;
|
|
2703
2715
|
/**
|
|
@@ -2708,7 +2720,7 @@ export interface EventEventEnded {
|
|
|
2708
2720
|
/** True if at least one guest is registered to the event with any attendance status. */
|
|
2709
2721
|
hasGuests?: boolean | null;
|
|
2710
2722
|
}
|
|
2711
|
-
|
|
2723
|
+
interface EventEventReminder {
|
|
2712
2724
|
/** Reminder timestamp in ISO UTC format. */
|
|
2713
2725
|
timestamp?: Date | null;
|
|
2714
2726
|
/**
|
|
@@ -2736,7 +2748,7 @@ export interface EventEventReminder {
|
|
|
2736
2748
|
/** True if at least one guest is registered to the event with any attendance status. */
|
|
2737
2749
|
hasGuests?: boolean | null;
|
|
2738
2750
|
}
|
|
2739
|
-
|
|
2751
|
+
interface EventEventPublished {
|
|
2740
2752
|
/** Event publishing timestamp in ISO UTC format. */
|
|
2741
2753
|
timestamp?: Date | null;
|
|
2742
2754
|
/**
|
|
@@ -2768,11 +2780,11 @@ export interface EventEventPublished {
|
|
|
2768
2780
|
/** Event date and time settings. */
|
|
2769
2781
|
dateAndTimeSettings?: DateAndTimeSettings;
|
|
2770
2782
|
/** Event page URL components. */
|
|
2771
|
-
eventPageUrl?:
|
|
2783
|
+
eventPageUrl?: string;
|
|
2772
2784
|
/** RSVP or ticketing registration details. */
|
|
2773
2785
|
registration?: Registration;
|
|
2774
2786
|
}
|
|
2775
|
-
|
|
2787
|
+
interface EventCloned {
|
|
2776
2788
|
/** Event creation timestamp in ISO UTC format. */
|
|
2777
2789
|
timestamp?: Date | null;
|
|
2778
2790
|
/**
|
|
@@ -2814,7 +2826,7 @@ export interface EventCloned {
|
|
|
2814
2826
|
*/
|
|
2815
2827
|
ticketDefinitions?: Record<string, string>;
|
|
2816
2828
|
}
|
|
2817
|
-
|
|
2829
|
+
interface EventEventCanceled {
|
|
2818
2830
|
/** Event cancelation timestamp in ISO UTC format. */
|
|
2819
2831
|
timestamp?: Date | null;
|
|
2820
2832
|
/**
|
|
@@ -2836,7 +2848,7 @@ export interface EventEventCanceled {
|
|
|
2836
2848
|
/** True if at least one guest is registered to the event with any attendance status. */
|
|
2837
2849
|
hasGuests?: boolean | null;
|
|
2838
2850
|
}
|
|
2839
|
-
|
|
2851
|
+
interface CreateEventRequest {
|
|
2840
2852
|
/** Event data. */
|
|
2841
2853
|
event: V3Event;
|
|
2842
2854
|
/** Whether to create the event as a draft. */
|
|
@@ -2847,7 +2859,7 @@ export interface CreateEventRequest {
|
|
|
2847
2859
|
*/
|
|
2848
2860
|
fields?: RequestedFieldsWithLiterals[];
|
|
2849
2861
|
}
|
|
2850
|
-
|
|
2862
|
+
declare enum RequestedFields {
|
|
2851
2863
|
/** Unknown requested field. */
|
|
2852
2864
|
UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
|
|
2853
2865
|
/** Returns `shortDescription`, `mainImage` and `calendarUrls`. */
|
|
@@ -2874,12 +2886,12 @@ export declare enum RequestedFields {
|
|
|
2874
2886
|
CATEGORIES = "CATEGORIES"
|
|
2875
2887
|
}
|
|
2876
2888
|
/** @enumType */
|
|
2877
|
-
|
|
2878
|
-
|
|
2889
|
+
type RequestedFieldsWithLiterals = RequestedFields | 'UNKNOWN_REQUESTED_FIELD' | 'DETAILS' | 'TEXTS' | 'REGISTRATION' | 'URLS' | 'FORM' | 'DASHBOARD' | 'FEED' | 'ONLINE_CONFERENCING_SESSION' | 'SEO_SETTINGS' | 'AGENDA' | 'CATEGORIES';
|
|
2890
|
+
interface CreateEventResponse {
|
|
2879
2891
|
/** Created event. */
|
|
2880
2892
|
event?: V3Event;
|
|
2881
2893
|
}
|
|
2882
|
-
|
|
2894
|
+
interface CloneEventRequest {
|
|
2883
2895
|
/**
|
|
2884
2896
|
* Event ID.
|
|
2885
2897
|
* @format GUID
|
|
@@ -2895,11 +2907,11 @@ export interface CloneEventRequest {
|
|
|
2895
2907
|
*/
|
|
2896
2908
|
fields?: RequestedFieldsWithLiterals[];
|
|
2897
2909
|
}
|
|
2898
|
-
|
|
2910
|
+
interface CloneEventResponse {
|
|
2899
2911
|
/** Cloned event. */
|
|
2900
2912
|
event?: V3Event;
|
|
2901
2913
|
}
|
|
2902
|
-
|
|
2914
|
+
interface CloneEventFromOtherSiteRequest {
|
|
2903
2915
|
/**
|
|
2904
2916
|
* Event ID.
|
|
2905
2917
|
* @format GUID
|
|
@@ -2916,11 +2928,11 @@ export interface CloneEventFromOtherSiteRequest {
|
|
|
2916
2928
|
*/
|
|
2917
2929
|
fields?: RequestedFieldsWithLiterals[];
|
|
2918
2930
|
}
|
|
2919
|
-
|
|
2931
|
+
interface CloneEventFromOtherSiteResponse {
|
|
2920
2932
|
/** Cloned event. */
|
|
2921
2933
|
event?: V3Event;
|
|
2922
2934
|
}
|
|
2923
|
-
|
|
2935
|
+
interface UpdateEventRequest {
|
|
2924
2936
|
/** Field values to be changed. */
|
|
2925
2937
|
event?: V3Event;
|
|
2926
2938
|
/**
|
|
@@ -2929,11 +2941,11 @@ export interface UpdateEventRequest {
|
|
|
2929
2941
|
*/
|
|
2930
2942
|
fields?: RequestedFieldsWithLiterals[];
|
|
2931
2943
|
}
|
|
2932
|
-
|
|
2944
|
+
interface UpdateEventResponse {
|
|
2933
2945
|
/** Updated event. */
|
|
2934
2946
|
event?: V3Event;
|
|
2935
2947
|
}
|
|
2936
|
-
|
|
2948
|
+
interface PublishDraftEventRequest {
|
|
2937
2949
|
/**
|
|
2938
2950
|
* Event ID.
|
|
2939
2951
|
* @format GUID
|
|
@@ -2945,11 +2957,11 @@ export interface PublishDraftEventRequest {
|
|
|
2945
2957
|
*/
|
|
2946
2958
|
fields?: RequestedFieldsWithLiterals[];
|
|
2947
2959
|
}
|
|
2948
|
-
|
|
2960
|
+
interface PublishDraftEventResponse {
|
|
2949
2961
|
/** Published event. */
|
|
2950
2962
|
event?: V3Event;
|
|
2951
2963
|
}
|
|
2952
|
-
|
|
2964
|
+
interface CancelEventRequest {
|
|
2953
2965
|
/**
|
|
2954
2966
|
* Event ID.
|
|
2955
2967
|
* @format GUID
|
|
@@ -2961,15 +2973,15 @@ export interface CancelEventRequest {
|
|
|
2961
2973
|
*/
|
|
2962
2974
|
fields?: RequestedFieldsWithLiterals[];
|
|
2963
2975
|
}
|
|
2964
|
-
|
|
2976
|
+
interface CancelEventResponse {
|
|
2965
2977
|
/** Canceled event. */
|
|
2966
2978
|
event?: V3Event;
|
|
2967
2979
|
}
|
|
2968
|
-
|
|
2969
|
-
/** Filter.
|
|
2980
|
+
interface BulkCancelEventsByFilterRequest {
|
|
2981
|
+
/** Filter. */
|
|
2970
2982
|
filter?: CommonQueryV2;
|
|
2971
2983
|
}
|
|
2972
|
-
|
|
2984
|
+
interface CommonQueryV2 extends CommonQueryV2PagingMethodOneOf {
|
|
2973
2985
|
/** Paging options. Can't be used together with `cursorPaging`. */
|
|
2974
2986
|
paging?: CommonPaging;
|
|
2975
2987
|
/**
|
|
@@ -2988,11 +3000,11 @@ export interface CommonQueryV2 extends CommonQueryV2PagingMethodOneOf {
|
|
|
2988
3000
|
sort?: CommonSorting[];
|
|
2989
3001
|
}
|
|
2990
3002
|
/** @oneof */
|
|
2991
|
-
|
|
3003
|
+
interface CommonQueryV2PagingMethodOneOf {
|
|
2992
3004
|
/** Paging options. Can't be used together with `cursorPaging`. */
|
|
2993
3005
|
paging?: CommonPaging;
|
|
2994
3006
|
}
|
|
2995
|
-
|
|
3007
|
+
interface CommonSorting {
|
|
2996
3008
|
/**
|
|
2997
3009
|
* Name of the field to sort by.
|
|
2998
3010
|
* @maxLength 100
|
|
@@ -3006,13 +3018,13 @@ export interface CommonSorting {
|
|
|
3006
3018
|
*/
|
|
3007
3019
|
order?: CommonSortOrderWithLiterals;
|
|
3008
3020
|
}
|
|
3009
|
-
|
|
3021
|
+
declare enum CommonSortOrder {
|
|
3010
3022
|
ASC = "ASC",
|
|
3011
3023
|
DESC = "DESC"
|
|
3012
3024
|
}
|
|
3013
3025
|
/** @enumType */
|
|
3014
|
-
|
|
3015
|
-
|
|
3026
|
+
type CommonSortOrderWithLiterals = CommonSortOrder | 'ASC' | 'DESC';
|
|
3027
|
+
interface CommonPaging {
|
|
3016
3028
|
/**
|
|
3017
3029
|
* 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.
|
|
3018
3030
|
* @max 1000
|
|
@@ -3021,29 +3033,29 @@ export interface CommonPaging {
|
|
|
3021
3033
|
/** Number of items to skip in the current sort order. */
|
|
3022
3034
|
offset?: number | null;
|
|
3023
3035
|
}
|
|
3024
|
-
|
|
3036
|
+
interface BulkCancelEventsByFilterResponse {
|
|
3025
3037
|
}
|
|
3026
|
-
|
|
3038
|
+
interface DeleteEventRequest {
|
|
3027
3039
|
/**
|
|
3028
3040
|
* Event ID.
|
|
3029
3041
|
* @format GUID
|
|
3030
3042
|
*/
|
|
3031
3043
|
eventId: string;
|
|
3032
3044
|
}
|
|
3033
|
-
|
|
3045
|
+
interface DeleteEventResponse {
|
|
3034
3046
|
/**
|
|
3035
3047
|
* Deleted event ID.
|
|
3036
3048
|
* @format GUID
|
|
3037
3049
|
*/
|
|
3038
3050
|
eventId?: string;
|
|
3039
3051
|
}
|
|
3040
|
-
|
|
3052
|
+
interface BulkDeleteEventsByFilterRequest {
|
|
3041
3053
|
/** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
|
|
3042
3054
|
filter?: CommonQueryV2;
|
|
3043
3055
|
}
|
|
3044
|
-
|
|
3056
|
+
interface BulkDeleteEventsByFilterResponse {
|
|
3045
3057
|
}
|
|
3046
|
-
|
|
3058
|
+
interface QueryEventsRequest {
|
|
3047
3059
|
/** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
|
|
3048
3060
|
query?: CommonQueryV2;
|
|
3049
3061
|
/**
|
|
@@ -3057,13 +3069,13 @@ export interface QueryEventsRequest {
|
|
|
3057
3069
|
*/
|
|
3058
3070
|
includeDrafts?: boolean;
|
|
3059
3071
|
}
|
|
3060
|
-
|
|
3072
|
+
interface QueryEventsResponse {
|
|
3061
3073
|
/** Metadata for the paginated results. */
|
|
3062
3074
|
pagingMetadata?: CommonPagingMetadataV2;
|
|
3063
3075
|
/** List of events. */
|
|
3064
3076
|
events?: V3Event[];
|
|
3065
3077
|
}
|
|
3066
|
-
|
|
3078
|
+
interface CommonPagingMetadataV2 {
|
|
3067
3079
|
/** 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. */
|
|
3068
3080
|
count?: number | null;
|
|
3069
3081
|
/** Requested offset. */
|
|
@@ -3075,17 +3087,17 @@ export interface CommonPagingMetadataV2 {
|
|
|
3075
3087
|
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
3076
3088
|
cursors?: CommonCursors;
|
|
3077
3089
|
}
|
|
3078
|
-
|
|
3090
|
+
interface CommonCursors {
|
|
3079
3091
|
/** Cursor pointing to the next page in the list of results. */
|
|
3080
3092
|
next?: string | null;
|
|
3081
3093
|
/** Cursor pointing to the previous page in the list of results. */
|
|
3082
3094
|
prev?: string | null;
|
|
3083
3095
|
}
|
|
3084
|
-
|
|
3096
|
+
interface ExportEventsRequest {
|
|
3085
3097
|
/** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
|
|
3086
3098
|
query?: QueryV2;
|
|
3087
3099
|
}
|
|
3088
|
-
|
|
3100
|
+
interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
3089
3101
|
/** Paging options to limit and skip the number of items. */
|
|
3090
3102
|
paging?: Paging;
|
|
3091
3103
|
/** 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`. */
|
|
@@ -3108,13 +3120,13 @@ export interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
|
3108
3120
|
fieldsets?: string[];
|
|
3109
3121
|
}
|
|
3110
3122
|
/** @oneof */
|
|
3111
|
-
|
|
3123
|
+
interface QueryV2PagingMethodOneOf {
|
|
3112
3124
|
/** Paging options to limit and skip the number of items. */
|
|
3113
3125
|
paging?: Paging;
|
|
3114
3126
|
/** 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`. */
|
|
3115
3127
|
cursorPaging?: CursorPaging;
|
|
3116
3128
|
}
|
|
3117
|
-
|
|
3129
|
+
interface Sorting {
|
|
3118
3130
|
/**
|
|
3119
3131
|
* Name of the field to sort by.
|
|
3120
3132
|
* @maxLength 512
|
|
@@ -3123,19 +3135,19 @@ export interface Sorting {
|
|
|
3123
3135
|
/** Sort order. */
|
|
3124
3136
|
order?: SortOrderWithLiterals;
|
|
3125
3137
|
}
|
|
3126
|
-
|
|
3138
|
+
declare enum SortOrder {
|
|
3127
3139
|
ASC = "ASC",
|
|
3128
3140
|
DESC = "DESC"
|
|
3129
3141
|
}
|
|
3130
3142
|
/** @enumType */
|
|
3131
|
-
|
|
3132
|
-
|
|
3143
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
3144
|
+
interface Paging {
|
|
3133
3145
|
/** Number of items to load. */
|
|
3134
3146
|
limit?: number | null;
|
|
3135
3147
|
/** Number of items to skip in the current sort order. */
|
|
3136
3148
|
offset?: number | null;
|
|
3137
3149
|
}
|
|
3138
|
-
|
|
3150
|
+
interface CursorPaging {
|
|
3139
3151
|
/**
|
|
3140
3152
|
* Maximum number of items to return in the results.
|
|
3141
3153
|
* @max 100
|
|
@@ -3150,13 +3162,13 @@ export interface CursorPaging {
|
|
|
3150
3162
|
*/
|
|
3151
3163
|
cursor?: string | null;
|
|
3152
3164
|
}
|
|
3153
|
-
|
|
3165
|
+
interface ExportEventsResponse {
|
|
3154
3166
|
/** Metadata for the paginated results. */
|
|
3155
3167
|
pagingMetadata?: PagingMetadataV2;
|
|
3156
3168
|
/** List of events. */
|
|
3157
3169
|
events?: V3Event[];
|
|
3158
3170
|
}
|
|
3159
|
-
|
|
3171
|
+
interface PagingMetadataV2 {
|
|
3160
3172
|
/** Number of items returned in the response. */
|
|
3161
3173
|
count?: number | null;
|
|
3162
3174
|
/** Offset that was requested. */
|
|
@@ -3168,7 +3180,7 @@ export interface PagingMetadataV2 {
|
|
|
3168
3180
|
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
3169
3181
|
cursors?: Cursors;
|
|
3170
3182
|
}
|
|
3171
|
-
|
|
3183
|
+
interface Cursors {
|
|
3172
3184
|
/**
|
|
3173
3185
|
* Cursor string pointing to the next page in the list of results.
|
|
3174
3186
|
* @maxLength 16000
|
|
@@ -3180,7 +3192,7 @@ export interface Cursors {
|
|
|
3180
3192
|
*/
|
|
3181
3193
|
prev?: string | null;
|
|
3182
3194
|
}
|
|
3183
|
-
|
|
3195
|
+
interface CountEventsByStatusRequest {
|
|
3184
3196
|
/** Filter object in the following format: <br/> `"filter" : { "fieldName1": "value1" }`. */
|
|
3185
3197
|
filter?: Record<string, any> | null;
|
|
3186
3198
|
/**
|
|
@@ -3195,17 +3207,17 @@ export interface CountEventsByStatusRequest {
|
|
|
3195
3207
|
*/
|
|
3196
3208
|
includeDrafts?: boolean;
|
|
3197
3209
|
}
|
|
3198
|
-
|
|
3210
|
+
interface CountEventsByStatusResponse {
|
|
3199
3211
|
/** Metadata for the paginated results. */
|
|
3200
3212
|
pagingMetadata?: CommonPagingMetadataV2;
|
|
3201
3213
|
/** Filter facets. */
|
|
3202
3214
|
facets?: Record<string, FacetCounts>;
|
|
3203
3215
|
}
|
|
3204
|
-
|
|
3216
|
+
interface FacetCounts {
|
|
3205
3217
|
/** Facet counts aggregated per value */
|
|
3206
3218
|
counts?: Record<string, number>;
|
|
3207
3219
|
}
|
|
3208
|
-
|
|
3220
|
+
interface ListUserEventsRequest {
|
|
3209
3221
|
/** Paging options to limit and skip the number of items. */
|
|
3210
3222
|
paging?: CommonPaging;
|
|
3211
3223
|
/**
|
|
@@ -3229,7 +3241,7 @@ export interface ListUserEventsRequest {
|
|
|
3229
3241
|
*/
|
|
3230
3242
|
facet?: string[];
|
|
3231
3243
|
}
|
|
3232
|
-
|
|
3244
|
+
interface UserFilter {
|
|
3233
3245
|
/**
|
|
3234
3246
|
* User who is related to event
|
|
3235
3247
|
* @format GUID
|
|
@@ -3242,13 +3254,13 @@ export interface UserFilter {
|
|
|
3242
3254
|
*/
|
|
3243
3255
|
relation?: RelationWithLiterals[];
|
|
3244
3256
|
}
|
|
3245
|
-
|
|
3257
|
+
declare enum Relation {
|
|
3246
3258
|
/** User is attending the event. The user RSVP'd with status of `YES` or has ordered tickets. */
|
|
3247
3259
|
ATTENDING = "ATTENDING"
|
|
3248
3260
|
}
|
|
3249
3261
|
/** @enumType */
|
|
3250
|
-
|
|
3251
|
-
|
|
3262
|
+
type RelationWithLiterals = Relation | 'ATTENDING';
|
|
3263
|
+
interface ListUserEventsResponse {
|
|
3252
3264
|
/** Metadata for the paginated results. */
|
|
3253
3265
|
pagingMetadata?: CommonPagingMetadataV2;
|
|
3254
3266
|
/** List of events. */
|
|
@@ -3256,7 +3268,7 @@ export interface ListUserEventsResponse {
|
|
|
3256
3268
|
/** Filter facets. */
|
|
3257
3269
|
facets?: Record<string, FacetCounts>;
|
|
3258
3270
|
}
|
|
3259
|
-
|
|
3271
|
+
interface ListEventsByCategoryRequest {
|
|
3260
3272
|
/**
|
|
3261
3273
|
* Category ID.
|
|
3262
3274
|
* @format GUID
|
|
@@ -3270,13 +3282,13 @@ export interface ListEventsByCategoryRequest {
|
|
|
3270
3282
|
*/
|
|
3271
3283
|
fields?: RequestedFieldsWithLiterals[];
|
|
3272
3284
|
}
|
|
3273
|
-
|
|
3285
|
+
interface ListEventsByCategoryResponse {
|
|
3274
3286
|
/** Metadata for the paginated results. */
|
|
3275
3287
|
pagingMetadata?: CommonPagingMetadataV2;
|
|
3276
3288
|
/** List of events. */
|
|
3277
3289
|
events?: V3Event[];
|
|
3278
3290
|
}
|
|
3279
|
-
|
|
3291
|
+
interface GetEventRequest {
|
|
3280
3292
|
/**
|
|
3281
3293
|
* Event ID.
|
|
3282
3294
|
* @format GUID
|
|
@@ -3288,11 +3300,11 @@ export interface GetEventRequest {
|
|
|
3288
3300
|
*/
|
|
3289
3301
|
fields?: RequestedFieldsWithLiterals[];
|
|
3290
3302
|
}
|
|
3291
|
-
|
|
3303
|
+
interface GetEventResponse {
|
|
3292
3304
|
/** Event. */
|
|
3293
3305
|
event?: V3Event;
|
|
3294
3306
|
}
|
|
3295
|
-
|
|
3307
|
+
interface GetEventBySlugRequest {
|
|
3296
3308
|
/**
|
|
3297
3309
|
* URL slug.
|
|
3298
3310
|
* @minLength 1
|
|
@@ -3302,11 +3314,11 @@ export interface GetEventBySlugRequest {
|
|
|
3302
3314
|
/** @maxSize 20 */
|
|
3303
3315
|
fields?: RequestedFieldsWithLiterals[];
|
|
3304
3316
|
}
|
|
3305
|
-
|
|
3317
|
+
interface GetEventBySlugResponse {
|
|
3306
3318
|
/** Event. */
|
|
3307
3319
|
event?: V3Event;
|
|
3308
3320
|
}
|
|
3309
|
-
|
|
3321
|
+
interface FindEventRequest extends FindEventRequestFindByOneOf {
|
|
3310
3322
|
/**
|
|
3311
3323
|
* Event ID.
|
|
3312
3324
|
* @format GUID
|
|
@@ -3325,7 +3337,7 @@ export interface FindEventRequest extends FindEventRequestFindByOneOf {
|
|
|
3325
3337
|
fields?: RequestedFieldsWithLiterals[];
|
|
3326
3338
|
}
|
|
3327
3339
|
/** @oneof */
|
|
3328
|
-
|
|
3340
|
+
interface FindEventRequestFindByOneOf {
|
|
3329
3341
|
/**
|
|
3330
3342
|
* Event ID.
|
|
3331
3343
|
* @format GUID
|
|
@@ -3338,11 +3350,11 @@ export interface FindEventRequestFindByOneOf {
|
|
|
3338
3350
|
*/
|
|
3339
3351
|
slug?: string | null;
|
|
3340
3352
|
}
|
|
3341
|
-
|
|
3353
|
+
interface FindEventResponse {
|
|
3342
3354
|
/** Event. */
|
|
3343
3355
|
event?: V3Event;
|
|
3344
3356
|
}
|
|
3345
|
-
|
|
3357
|
+
interface EventCreated {
|
|
3346
3358
|
/** Event created timestamp in ISO UTC format. */
|
|
3347
3359
|
timestamp?: Date | null;
|
|
3348
3360
|
/**
|
|
@@ -3376,7 +3388,7 @@ export interface EventCreated {
|
|
|
3376
3388
|
/** Event that was created. */
|
|
3377
3389
|
event?: Event;
|
|
3378
3390
|
}
|
|
3379
|
-
|
|
3391
|
+
interface EventsLocation {
|
|
3380
3392
|
/**
|
|
3381
3393
|
* Location name.
|
|
3382
3394
|
* @maxLength 50
|
|
@@ -3408,7 +3420,7 @@ export interface EventsLocation {
|
|
|
3408
3420
|
*/
|
|
3409
3421
|
tbd?: boolean | null;
|
|
3410
3422
|
}
|
|
3411
|
-
|
|
3423
|
+
interface MapCoordinates {
|
|
3412
3424
|
/**
|
|
3413
3425
|
* Latitude.
|
|
3414
3426
|
* @min -90
|
|
@@ -3422,18 +3434,18 @@ export interface MapCoordinates {
|
|
|
3422
3434
|
*/
|
|
3423
3435
|
lng?: number;
|
|
3424
3436
|
}
|
|
3425
|
-
|
|
3437
|
+
declare enum LocationLocationType {
|
|
3426
3438
|
VENUE = "VENUE",
|
|
3427
3439
|
ONLINE = "ONLINE"
|
|
3428
3440
|
}
|
|
3429
3441
|
/** @enumType */
|
|
3430
|
-
|
|
3442
|
+
type LocationLocationTypeWithLiterals = LocationLocationType | 'VENUE' | 'ONLINE';
|
|
3431
3443
|
/** Physical address */
|
|
3432
|
-
|
|
3444
|
+
interface Address extends AddressStreetOneOf {
|
|
3433
3445
|
/** a break down of the street to number and street name */
|
|
3434
3446
|
streetAddress?: StreetAddress;
|
|
3435
3447
|
/** Main address line (usually street and number) as free text */
|
|
3436
|
-
|
|
3448
|
+
addressLine1?: string | null;
|
|
3437
3449
|
/**
|
|
3438
3450
|
* country code
|
|
3439
3451
|
* @format COUNTRY
|
|
@@ -3448,11 +3460,9 @@ export interface Address extends AddressStreetOneOf {
|
|
|
3448
3460
|
/** Free text providing more detailed address info. Usually contains Apt, Suite, Floor */
|
|
3449
3461
|
addressLine2?: string | null;
|
|
3450
3462
|
/** A string containing the human-readable address of this location */
|
|
3451
|
-
|
|
3452
|
-
/** Free text for human-to-human textual orientation aid purposes */
|
|
3453
|
-
hint?: string | null;
|
|
3463
|
+
formatted?: string | null;
|
|
3454
3464
|
/** coordinates of the physical address */
|
|
3455
|
-
|
|
3465
|
+
location?: AddressLocation;
|
|
3456
3466
|
/** country full-name */
|
|
3457
3467
|
countryFullname?: string | null;
|
|
3458
3468
|
/**
|
|
@@ -3462,19 +3472,19 @@ export interface Address extends AddressStreetOneOf {
|
|
|
3462
3472
|
subdivisions?: Subdivision[];
|
|
3463
3473
|
}
|
|
3464
3474
|
/** @oneof */
|
|
3465
|
-
|
|
3475
|
+
interface AddressStreetOneOf {
|
|
3466
3476
|
/** a break down of the street to number and street name */
|
|
3467
3477
|
streetAddress?: StreetAddress;
|
|
3468
3478
|
/** Main address line (usually street and number) as free text */
|
|
3469
3479
|
addressLine?: string | null;
|
|
3470
3480
|
}
|
|
3471
|
-
|
|
3481
|
+
interface StreetAddress {
|
|
3472
3482
|
/** street number */
|
|
3473
3483
|
number?: string;
|
|
3474
3484
|
/** street name */
|
|
3475
3485
|
name?: string;
|
|
3476
3486
|
}
|
|
3477
|
-
|
|
3487
|
+
interface AddressLocation {
|
|
3478
3488
|
/**
|
|
3479
3489
|
* address latitude coordinates
|
|
3480
3490
|
* @min -90
|
|
@@ -3488,13 +3498,13 @@ export interface AddressLocation {
|
|
|
3488
3498
|
*/
|
|
3489
3499
|
longitude?: number | null;
|
|
3490
3500
|
}
|
|
3491
|
-
|
|
3501
|
+
interface Subdivision {
|
|
3492
3502
|
/** subdivision short code */
|
|
3493
3503
|
code?: string;
|
|
3494
3504
|
/** subdivision full-name */
|
|
3495
3505
|
name?: string;
|
|
3496
3506
|
}
|
|
3497
|
-
|
|
3507
|
+
declare enum SubdivisionType {
|
|
3498
3508
|
UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
|
|
3499
3509
|
/** State */
|
|
3500
3510
|
ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
|
|
@@ -3509,9 +3519,7 @@ export declare enum SubdivisionType {
|
|
|
3509
3519
|
/** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
|
|
3510
3520
|
COUNTRY = "COUNTRY"
|
|
3511
3521
|
}
|
|
3512
|
-
|
|
3513
|
-
export type SubdivisionTypeWithLiterals = SubdivisionType | 'UNKNOWN_SUBDIVISION_TYPE' | 'ADMINISTRATIVE_AREA_LEVEL_1' | 'ADMINISTRATIVE_AREA_LEVEL_2' | 'ADMINISTRATIVE_AREA_LEVEL_3' | 'ADMINISTRATIVE_AREA_LEVEL_4' | 'ADMINISTRATIVE_AREA_LEVEL_5' | 'COUNTRY';
|
|
3514
|
-
export interface ScheduleConfig {
|
|
3522
|
+
interface ScheduleConfig {
|
|
3515
3523
|
/**
|
|
3516
3524
|
* Defines event as TBD (To Be Determined) schedule.
|
|
3517
3525
|
* When event time is not yet defined, TBD message is displayed instead of event start and end times.
|
|
@@ -3539,7 +3547,7 @@ export interface ScheduleConfig {
|
|
|
3539
3547
|
/** Event recurrences. */
|
|
3540
3548
|
recurrences?: EventsRecurrences;
|
|
3541
3549
|
}
|
|
3542
|
-
|
|
3550
|
+
interface EventsRecurrences {
|
|
3543
3551
|
/**
|
|
3544
3552
|
* Event occurrences.
|
|
3545
3553
|
* @maxSize 1000
|
|
@@ -3556,7 +3564,7 @@ export interface EventsRecurrences {
|
|
|
3556
3564
|
*/
|
|
3557
3565
|
status?: EventsRecurrenceStatusStatusWithLiterals;
|
|
3558
3566
|
}
|
|
3559
|
-
|
|
3567
|
+
interface EventsOccurrence {
|
|
3560
3568
|
/** Event start timestamp. */
|
|
3561
3569
|
startDate?: Date | null;
|
|
3562
3570
|
/** Event end timestamp. */
|
|
@@ -3569,7 +3577,7 @@ export interface EventsOccurrence {
|
|
|
3569
3577
|
/** Whether time zone is displayed in formatted schedule. */
|
|
3570
3578
|
showTimeZone?: boolean;
|
|
3571
3579
|
}
|
|
3572
|
-
|
|
3580
|
+
declare enum EventsRecurrenceStatusStatus {
|
|
3573
3581
|
/** Event occurs only once. */
|
|
3574
3582
|
ONE_TIME = "ONE_TIME",
|
|
3575
3583
|
/** Event is recurring. */
|
|
@@ -3582,8 +3590,8 @@ export declare enum EventsRecurrenceStatusStatus {
|
|
|
3582
3590
|
RECURRING_LAST_CANCELED = "RECURRING_LAST_CANCELED"
|
|
3583
3591
|
}
|
|
3584
3592
|
/** @enumType */
|
|
3585
|
-
|
|
3586
|
-
|
|
3593
|
+
type EventsRecurrenceStatusStatusWithLiterals = EventsRecurrenceStatusStatus | 'ONE_TIME' | 'RECURRING' | 'RECURRING_NEXT' | 'RECURRING_LAST_ENDED' | 'RECURRING_LAST_CANCELED';
|
|
3594
|
+
declare enum EventStatus {
|
|
3587
3595
|
/** Event is public and scheduled to start */
|
|
3588
3596
|
SCHEDULED = "SCHEDULED",
|
|
3589
3597
|
/** Event has started */
|
|
@@ -3594,14 +3602,14 @@ export declare enum EventStatus {
|
|
|
3594
3602
|
CANCELED = "CANCELED"
|
|
3595
3603
|
}
|
|
3596
3604
|
/** @enumType */
|
|
3597
|
-
|
|
3598
|
-
|
|
3605
|
+
type EventStatusWithLiterals = EventStatus | 'SCHEDULED' | 'STARTED' | 'ENDED' | 'CANCELED';
|
|
3606
|
+
interface Event {
|
|
3599
3607
|
/**
|
|
3600
3608
|
* Event ID.
|
|
3601
3609
|
* @format GUID
|
|
3602
3610
|
* @readonly
|
|
3603
3611
|
*/
|
|
3604
|
-
|
|
3612
|
+
_id?: string;
|
|
3605
3613
|
/** Event location. */
|
|
3606
3614
|
location?: EventsLocation;
|
|
3607
3615
|
/** Event scheduling. */
|
|
@@ -3613,7 +3621,7 @@ export interface Event {
|
|
|
3613
3621
|
/** Rich-text content that are displayed in a site's "About Event" section (HTML). */
|
|
3614
3622
|
about?: string;
|
|
3615
3623
|
/** Main event image. */
|
|
3616
|
-
mainImage?:
|
|
3624
|
+
mainImage?: string;
|
|
3617
3625
|
/** Event slug URL (generated from event title). */
|
|
3618
3626
|
slug?: string;
|
|
3619
3627
|
/** ISO 639-1 language code of the event (used in content translations). */
|
|
@@ -3665,7 +3673,7 @@ export interface Event {
|
|
|
3665
3673
|
*/
|
|
3666
3674
|
publishedDate?: Date | null;
|
|
3667
3675
|
}
|
|
3668
|
-
|
|
3676
|
+
interface Scheduling {
|
|
3669
3677
|
/** Schedule configuration. */
|
|
3670
3678
|
config?: ScheduleConfig;
|
|
3671
3679
|
/** Formatted schedule representation. */
|
|
@@ -3679,23 +3687,7 @@ export interface Scheduling {
|
|
|
3679
3687
|
/** Formatted end time of the event (empty for TBD schedules or when end date is hidden). */
|
|
3680
3688
|
endTimeFormatted?: string;
|
|
3681
3689
|
}
|
|
3682
|
-
|
|
3683
|
-
/**
|
|
3684
|
-
* WixMedia image ID.
|
|
3685
|
-
* @minLength 1
|
|
3686
|
-
* @maxLength 200
|
|
3687
|
-
*/
|
|
3688
|
-
id?: string | null;
|
|
3689
|
-
/** Image URL. */
|
|
3690
|
-
url?: string;
|
|
3691
|
-
/** Original image height. */
|
|
3692
|
-
height?: number | null;
|
|
3693
|
-
/** Original image width. */
|
|
3694
|
-
width?: number | null;
|
|
3695
|
-
/** Image alt text. Optional. */
|
|
3696
|
-
altText?: string | null;
|
|
3697
|
-
}
|
|
3698
|
-
export interface EventsRegistration {
|
|
3690
|
+
interface EventsRegistration {
|
|
3699
3691
|
/** Event type. */
|
|
3700
3692
|
type?: EventTypeWithLiterals;
|
|
3701
3693
|
/** Event registration status. */
|
|
@@ -3711,7 +3703,7 @@ export interface EventsRegistration {
|
|
|
3711
3703
|
/** Initial event type which was set when creating an event. */
|
|
3712
3704
|
initialType?: EventTypeWithLiterals;
|
|
3713
3705
|
}
|
|
3714
|
-
|
|
3706
|
+
declare enum EventType {
|
|
3715
3707
|
/** Type not available for this request fieldset */
|
|
3716
3708
|
NA_EVENT_TYPE = "NA_EVENT_TYPE",
|
|
3717
3709
|
/** Registration via RSVP */
|
|
@@ -3724,8 +3716,8 @@ export declare enum EventType {
|
|
|
3724
3716
|
NO_REGISTRATION = "NO_REGISTRATION"
|
|
3725
3717
|
}
|
|
3726
3718
|
/** @enumType */
|
|
3727
|
-
|
|
3728
|
-
|
|
3719
|
+
type EventTypeWithLiterals = EventType | 'NA_EVENT_TYPE' | 'RSVP' | 'TICKETS' | 'EXTERNAL' | 'NO_REGISTRATION';
|
|
3720
|
+
declare enum RegistrationStatus {
|
|
3729
3721
|
/** Registration status is not applicable */
|
|
3730
3722
|
NA_REGISTRATION_STATUS = "NA_REGISTRATION_STATUS",
|
|
3731
3723
|
/** Registration to event is closed */
|
|
@@ -3744,12 +3736,12 @@ export declare enum RegistrationStatus {
|
|
|
3744
3736
|
SCHEDULED_RSVP = "SCHEDULED_RSVP"
|
|
3745
3737
|
}
|
|
3746
3738
|
/** @enumType */
|
|
3747
|
-
|
|
3748
|
-
|
|
3739
|
+
type RegistrationStatusWithLiterals = RegistrationStatus | 'NA_REGISTRATION_STATUS' | 'CLOSED' | 'CLOSED_MANUALLY' | 'OPEN_RSVP' | 'OPEN_RSVP_WAITLIST' | 'OPEN_TICKETS' | 'OPEN_EXTERNAL' | 'SCHEDULED_RSVP';
|
|
3740
|
+
interface RsvpCollection {
|
|
3749
3741
|
/** RSVP collection configuration. */
|
|
3750
3742
|
config?: RsvpCollectionConfig;
|
|
3751
3743
|
}
|
|
3752
|
-
|
|
3744
|
+
interface RsvpCollectionConfig {
|
|
3753
3745
|
/** Defines the supported RSVP statuses. */
|
|
3754
3746
|
rsvpStatusOptions?: RsvpStatusOptionsWithLiterals;
|
|
3755
3747
|
/**
|
|
@@ -3764,15 +3756,15 @@ export interface RsvpCollectionConfig {
|
|
|
3764
3756
|
/** Registration end timestamp. */
|
|
3765
3757
|
endDate?: Date | null;
|
|
3766
3758
|
}
|
|
3767
|
-
|
|
3759
|
+
declare enum RsvpStatusOptions {
|
|
3768
3760
|
/** Only YES RSVP status is available for RSVP registration */
|
|
3769
3761
|
YES_ONLY = "YES_ONLY",
|
|
3770
3762
|
/** YES and NO RSVP status options are available for the registration */
|
|
3771
3763
|
YES_AND_NO = "YES_AND_NO"
|
|
3772
3764
|
}
|
|
3773
3765
|
/** @enumType */
|
|
3774
|
-
|
|
3775
|
-
|
|
3766
|
+
type RsvpStatusOptionsWithLiterals = RsvpStatusOptions | 'YES_ONLY' | 'YES_AND_NO';
|
|
3767
|
+
interface Ticketing {
|
|
3776
3768
|
/**
|
|
3777
3769
|
* Deprecated.
|
|
3778
3770
|
* @deprecated
|
|
@@ -3813,7 +3805,7 @@ export interface Ticketing {
|
|
|
3813
3805
|
*/
|
|
3814
3806
|
soldOut?: boolean | null;
|
|
3815
3807
|
}
|
|
3816
|
-
|
|
3808
|
+
interface TicketingConfig {
|
|
3817
3809
|
/** Whether the form must be filled out separately for each ticket. */
|
|
3818
3810
|
guestAssignedTickets?: boolean;
|
|
3819
3811
|
/** Tax configuration. */
|
|
@@ -3830,7 +3822,7 @@ export interface TicketingConfig {
|
|
|
3830
3822
|
*/
|
|
3831
3823
|
reservationDurationInMinutes?: number | null;
|
|
3832
3824
|
}
|
|
3833
|
-
|
|
3825
|
+
interface TaxConfig {
|
|
3834
3826
|
/** Tax application settings. */
|
|
3835
3827
|
type?: EventsTaxTypeWithLiterals;
|
|
3836
3828
|
/**
|
|
@@ -3847,7 +3839,7 @@ export interface TaxConfig {
|
|
|
3847
3839
|
/** Applies taxes for donations, default true. */
|
|
3848
3840
|
appliesToDonations?: boolean | null;
|
|
3849
3841
|
}
|
|
3850
|
-
|
|
3842
|
+
declare enum EventsTaxType {
|
|
3851
3843
|
/** Tax is included in the ticket price. */
|
|
3852
3844
|
INCLUDED = "INCLUDED",
|
|
3853
3845
|
/** Tax is added to the order at the checkout. */
|
|
@@ -3856,12 +3848,12 @@ export declare enum EventsTaxType {
|
|
|
3856
3848
|
ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
|
|
3857
3849
|
}
|
|
3858
3850
|
/** @enumType */
|
|
3859
|
-
|
|
3860
|
-
|
|
3851
|
+
type EventsTaxTypeWithLiterals = EventsTaxType | 'INCLUDED' | 'ADDED' | 'ADDED_AT_CHECKOUT';
|
|
3852
|
+
interface ExternalEvent {
|
|
3861
3853
|
/** External event registration URL. */
|
|
3862
3854
|
registration?: string;
|
|
3863
3855
|
}
|
|
3864
|
-
|
|
3856
|
+
declare enum VisitorType {
|
|
3865
3857
|
/** Site visitor (including member) */
|
|
3866
3858
|
VISITOR = "VISITOR",
|
|
3867
3859
|
/** Site member */
|
|
@@ -3870,15 +3862,15 @@ export declare enum VisitorType {
|
|
|
3870
3862
|
VISITOR_OR_MEMBER = "VISITOR_OR_MEMBER"
|
|
3871
3863
|
}
|
|
3872
3864
|
/** @enumType */
|
|
3873
|
-
|
|
3874
|
-
|
|
3865
|
+
type VisitorTypeWithLiterals = VisitorType | 'VISITOR' | 'MEMBER' | 'VISITOR_OR_MEMBER';
|
|
3866
|
+
interface CalendarLinks {
|
|
3875
3867
|
/** "Add to Google calendar" URL. */
|
|
3876
3868
|
google?: string;
|
|
3877
3869
|
/** "Download ICS calendar file" URL. */
|
|
3878
3870
|
ics?: string;
|
|
3879
3871
|
}
|
|
3880
3872
|
/** Site URL components */
|
|
3881
|
-
|
|
3873
|
+
interface SiteUrl {
|
|
3882
3874
|
/**
|
|
3883
3875
|
* Base URL. For premium sites, this will be the domain.
|
|
3884
3876
|
* For free sites, this would be site URL (e.g `mysite.wixsite.com/mysite`)
|
|
@@ -3887,7 +3879,7 @@ export interface SiteUrl {
|
|
|
3887
3879
|
/** The path to that page - e.g `/my-events/weekly-meetup-2` */
|
|
3888
3880
|
path?: string;
|
|
3889
3881
|
}
|
|
3890
|
-
|
|
3882
|
+
interface Dashboard {
|
|
3891
3883
|
/** Guest RSVP summary. */
|
|
3892
3884
|
rsvpSummary?: RsvpSummary;
|
|
3893
3885
|
/**
|
|
@@ -3896,7 +3888,7 @@ export interface Dashboard {
|
|
|
3896
3888
|
*/
|
|
3897
3889
|
ticketingSummary?: TicketingSummary;
|
|
3898
3890
|
}
|
|
3899
|
-
|
|
3891
|
+
interface RsvpSummary {
|
|
3900
3892
|
/** Total number of RSVPs. */
|
|
3901
3893
|
total?: number;
|
|
3902
3894
|
/** Number of RSVPs with status `YES`. */
|
|
@@ -3906,7 +3898,7 @@ export interface RsvpSummary {
|
|
|
3906
3898
|
/** Number of RSVPs in waitlist. */
|
|
3907
3899
|
waitlist?: number;
|
|
3908
3900
|
}
|
|
3909
|
-
|
|
3901
|
+
interface TicketingSummary {
|
|
3910
3902
|
/** Number of tickets sold. */
|
|
3911
3903
|
tickets?: number;
|
|
3912
3904
|
/**
|
|
@@ -3921,19 +3913,19 @@ export interface TicketingSummary {
|
|
|
3921
3913
|
/** Total balance of confirmed transactions. */
|
|
3922
3914
|
totalSales?: EventsMoney;
|
|
3923
3915
|
}
|
|
3924
|
-
|
|
3916
|
+
interface GuestListConfig {
|
|
3925
3917
|
/** Whether members can see other members attending the event (defaults to true). */
|
|
3926
3918
|
publicGuestList?: boolean;
|
|
3927
3919
|
}
|
|
3928
|
-
|
|
3920
|
+
interface EventsFeed {
|
|
3929
3921
|
/** Event discussion feed token. */
|
|
3930
3922
|
token?: string;
|
|
3931
3923
|
}
|
|
3932
|
-
|
|
3924
|
+
interface EventsOnlineConferencing {
|
|
3933
3925
|
config?: OnlineConferencingConfig;
|
|
3934
3926
|
session?: EventsOnlineConferencingSession;
|
|
3935
3927
|
}
|
|
3936
|
-
|
|
3928
|
+
interface OnlineConferencingConfig {
|
|
3937
3929
|
/**
|
|
3938
3930
|
* Whether online conferencing is enabled (not supported for TBD schedules).
|
|
3939
3931
|
* When enabled, links to join conferencing are generated and provided to guests.
|
|
@@ -3947,15 +3939,15 @@ export interface OnlineConferencingConfig {
|
|
|
3947
3939
|
/** Conference type */
|
|
3948
3940
|
conferenceType?: ConferenceTypeWithLiterals;
|
|
3949
3941
|
}
|
|
3950
|
-
|
|
3942
|
+
declare enum ConferenceType {
|
|
3951
3943
|
/** Everyone in the meeting can publish and subscribe video and audio. */
|
|
3952
3944
|
MEETING = "MEETING",
|
|
3953
3945
|
/** Guests can only subscribe to video and audio. */
|
|
3954
3946
|
WEBINAR = "WEBINAR"
|
|
3955
3947
|
}
|
|
3956
3948
|
/** @enumType */
|
|
3957
|
-
|
|
3958
|
-
|
|
3949
|
+
type ConferenceTypeWithLiterals = ConferenceType | 'MEETING' | 'WEBINAR';
|
|
3950
|
+
interface EventsOnlineConferencingSession {
|
|
3959
3951
|
/**
|
|
3960
3952
|
* Link for event host to start the online conference session.
|
|
3961
3953
|
* @readonly
|
|
@@ -3982,7 +3974,7 @@ export interface EventsOnlineConferencingSession {
|
|
|
3982
3974
|
*/
|
|
3983
3975
|
sessionId?: string | null;
|
|
3984
3976
|
}
|
|
3985
|
-
|
|
3977
|
+
interface EventsSeoSettings {
|
|
3986
3978
|
/**
|
|
3987
3979
|
* URL slug
|
|
3988
3980
|
* @maxLength 130
|
|
@@ -3996,7 +3988,7 @@ export interface EventsSeoSettings {
|
|
|
3996
3988
|
*/
|
|
3997
3989
|
hidden?: boolean | null;
|
|
3998
3990
|
}
|
|
3999
|
-
|
|
3991
|
+
interface Agenda {
|
|
4000
3992
|
/** Whether the schedule is enabled for the event. */
|
|
4001
3993
|
enabled?: boolean;
|
|
4002
3994
|
/**
|
|
@@ -4005,13 +3997,13 @@ export interface Agenda {
|
|
|
4005
3997
|
*/
|
|
4006
3998
|
pageUrl?: SiteUrl;
|
|
4007
3999
|
}
|
|
4008
|
-
|
|
4000
|
+
interface Category {
|
|
4009
4001
|
/**
|
|
4010
4002
|
* Category ID.
|
|
4011
4003
|
* @format GUID
|
|
4012
4004
|
* @readonly
|
|
4013
4005
|
*/
|
|
4014
|
-
|
|
4006
|
+
_id?: string;
|
|
4015
4007
|
/**
|
|
4016
4008
|
* Category name.
|
|
4017
4009
|
* @minLength 1
|
|
@@ -4022,7 +4014,7 @@ export interface Category {
|
|
|
4022
4014
|
* Date and time when category was created.
|
|
4023
4015
|
* @readonly
|
|
4024
4016
|
*/
|
|
4025
|
-
|
|
4017
|
+
_createdDate?: Date | null;
|
|
4026
4018
|
/**
|
|
4027
4019
|
* The total number of draft and published events assigned to the category.
|
|
4028
4020
|
* @readonly
|
|
@@ -4043,13 +4035,13 @@ export interface Category {
|
|
|
4043
4035
|
*/
|
|
4044
4036
|
states?: StateWithLiterals[];
|
|
4045
4037
|
}
|
|
4046
|
-
|
|
4038
|
+
interface CategoryCounts {
|
|
4047
4039
|
/** Total number of draft events assigned to the category. */
|
|
4048
4040
|
assignedEventsCount?: number | null;
|
|
4049
4041
|
/** Total number of published events assigned to the category. Deleted events are excluded. */
|
|
4050
4042
|
assignedDraftEventsCount?: number | null;
|
|
4051
4043
|
}
|
|
4052
|
-
|
|
4044
|
+
declare enum State {
|
|
4053
4045
|
/** Created manually by the user. */
|
|
4054
4046
|
MANUAL = "MANUAL",
|
|
4055
4047
|
/** Created automatically. */
|
|
@@ -4060,16 +4052,16 @@ export declare enum State {
|
|
|
4060
4052
|
HIDDEN = "HIDDEN"
|
|
4061
4053
|
}
|
|
4062
4054
|
/** @enumType */
|
|
4063
|
-
|
|
4064
|
-
|
|
4055
|
+
type StateWithLiterals = State | 'MANUAL' | 'AUTO' | 'RECURRING_EVENT' | 'HIDDEN';
|
|
4056
|
+
interface EventDisplaySettings {
|
|
4065
4057
|
/** Whether event details button is hidden. Only available for events with no registration. */
|
|
4066
4058
|
hideEventDetailsButton?: boolean | null;
|
|
4067
4059
|
/** Disables event details page visibility. If event has an external registration configured visitors will be redirected from this page. */
|
|
4068
4060
|
hideEventDetailsPage?: boolean | null;
|
|
4069
4061
|
}
|
|
4070
|
-
|
|
4062
|
+
interface EventsLabellingSettings {
|
|
4071
4063
|
}
|
|
4072
|
-
|
|
4064
|
+
interface Badge {
|
|
4073
4065
|
/** Badge type. */
|
|
4074
4066
|
type?: TypeWithLiterals;
|
|
4075
4067
|
/**
|
|
@@ -4078,7 +4070,7 @@ export interface Badge {
|
|
|
4078
4070
|
*/
|
|
4079
4071
|
text?: string | null;
|
|
4080
4072
|
}
|
|
4081
|
-
|
|
4073
|
+
declare enum Type {
|
|
4082
4074
|
/** Unknown badge type. */
|
|
4083
4075
|
UNKNOWN_BADGE_TYPE = "UNKNOWN_BADGE_TYPE",
|
|
4084
4076
|
/** 1st priority badge type. */
|
|
@@ -4089,10 +4081,10 @@ export declare enum Type {
|
|
|
4089
4081
|
THIRD_PRIORITY = "THIRD_PRIORITY"
|
|
4090
4082
|
}
|
|
4091
4083
|
/** @enumType */
|
|
4092
|
-
|
|
4093
|
-
|
|
4084
|
+
type TypeWithLiterals = Type | 'UNKNOWN_BADGE_TYPE' | 'FIRST_PRIORITY' | 'SECOND_PRIORITY' | 'THIRD_PRIORITY';
|
|
4085
|
+
interface Empty {
|
|
4094
4086
|
}
|
|
4095
|
-
|
|
4087
|
+
interface EventUpdated {
|
|
4096
4088
|
/** Event update timestamp in ISO UTC format. */
|
|
4097
4089
|
timestamp?: Date | null;
|
|
4098
4090
|
/**
|
|
@@ -4114,7 +4106,7 @@ export interface EventUpdated {
|
|
|
4114
4106
|
/** Updated event */
|
|
4115
4107
|
event?: Event;
|
|
4116
4108
|
}
|
|
4117
|
-
|
|
4109
|
+
interface EventDeleted {
|
|
4118
4110
|
/** Event deleted timestamp in ISO UTC format. */
|
|
4119
4111
|
timestamp?: Date | null;
|
|
4120
4112
|
/**
|
|
@@ -4130,7 +4122,7 @@ export interface EventDeleted {
|
|
|
4130
4122
|
*/
|
|
4131
4123
|
userId?: string | null;
|
|
4132
4124
|
}
|
|
4133
|
-
|
|
4125
|
+
interface EventCopied {
|
|
4134
4126
|
/** Event created timestamp in ISO UTC format. */
|
|
4135
4127
|
timestamp?: Date | null;
|
|
4136
4128
|
/**
|
|
@@ -4168,7 +4160,7 @@ export interface EventCopied {
|
|
|
4168
4160
|
*/
|
|
4169
4161
|
ticketDefinitions?: Record<string, string>;
|
|
4170
4162
|
}
|
|
4171
|
-
|
|
4163
|
+
interface EventPublished {
|
|
4172
4164
|
/** Event publish timestamp in ISO UTC format. */
|
|
4173
4165
|
timestamp?: Date | null;
|
|
4174
4166
|
/**
|
|
@@ -4196,7 +4188,7 @@ export interface EventPublished {
|
|
|
4196
4188
|
/** RSVP or ticketing registration details. */
|
|
4197
4189
|
registration?: EventsRegistration;
|
|
4198
4190
|
}
|
|
4199
|
-
|
|
4191
|
+
interface EventCanceled {
|
|
4200
4192
|
/** Event canceled timestamp in ISO UTC format. */
|
|
4201
4193
|
timestamp?: Date | null;
|
|
4202
4194
|
/**
|
|
@@ -4214,7 +4206,7 @@ export interface EventCanceled {
|
|
|
4214
4206
|
/** True if at least one guest is registered to the event with any attendance status. */
|
|
4215
4207
|
hasGuests?: boolean | null;
|
|
4216
4208
|
}
|
|
4217
|
-
|
|
4209
|
+
interface EventStarted {
|
|
4218
4210
|
/** Event start timestamp in ISO UTC format. */
|
|
4219
4211
|
timestamp?: Date | null;
|
|
4220
4212
|
/**
|
|
@@ -4225,7 +4217,7 @@ export interface EventStarted {
|
|
|
4225
4217
|
/** True if at least one guest is registered to the event with any attendance status. */
|
|
4226
4218
|
hasGuests?: boolean | null;
|
|
4227
4219
|
}
|
|
4228
|
-
|
|
4220
|
+
interface EventEnded {
|
|
4229
4221
|
/** Event end timestamp in ISO UTC format. */
|
|
4230
4222
|
timestamp?: Date | null;
|
|
4231
4223
|
/**
|
|
@@ -4236,7 +4228,7 @@ export interface EventEnded {
|
|
|
4236
4228
|
/** True if at least one guest is registered to the event with any attendance status. */
|
|
4237
4229
|
hasGuests?: boolean | null;
|
|
4238
4230
|
}
|
|
4239
|
-
|
|
4231
|
+
interface EventReminder {
|
|
4240
4232
|
/** Reminder timestamp in ISO UTC format. */
|
|
4241
4233
|
timestamp?: Date | null;
|
|
4242
4234
|
/**
|
|
@@ -4260,13 +4252,13 @@ export interface EventReminder {
|
|
|
4260
4252
|
/** True if at least one guest is registered to the event with any attendance status. */
|
|
4261
4253
|
hasGuests?: boolean | null;
|
|
4262
4254
|
}
|
|
4263
|
-
|
|
4255
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
4264
4256
|
createdEvent?: EntityCreatedEvent;
|
|
4265
4257
|
updatedEvent?: EntityUpdatedEvent;
|
|
4266
4258
|
deletedEvent?: EntityDeletedEvent;
|
|
4267
4259
|
actionEvent?: ActionEvent;
|
|
4268
4260
|
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
4269
|
-
|
|
4261
|
+
_id?: string;
|
|
4270
4262
|
/**
|
|
4271
4263
|
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
4272
4264
|
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
@@ -4295,36 +4287,34 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
4295
4287
|
entityEventSequence?: string | null;
|
|
4296
4288
|
}
|
|
4297
4289
|
/** @oneof */
|
|
4298
|
-
|
|
4290
|
+
interface DomainEventBodyOneOf {
|
|
4299
4291
|
createdEvent?: EntityCreatedEvent;
|
|
4300
4292
|
updatedEvent?: EntityUpdatedEvent;
|
|
4301
4293
|
deletedEvent?: EntityDeletedEvent;
|
|
4302
4294
|
actionEvent?: ActionEvent;
|
|
4303
4295
|
}
|
|
4304
|
-
|
|
4305
|
-
|
|
4306
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
4307
|
-
restoreInfo?: RestoreInfo;
|
|
4296
|
+
interface EntityCreatedEvent {
|
|
4297
|
+
entity?: string;
|
|
4308
4298
|
}
|
|
4309
|
-
|
|
4299
|
+
interface RestoreInfo {
|
|
4310
4300
|
deletedDate?: Date | null;
|
|
4311
4301
|
}
|
|
4312
|
-
|
|
4302
|
+
interface EntityUpdatedEvent {
|
|
4313
4303
|
/**
|
|
4314
4304
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
4315
4305
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
4316
4306
|
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
4317
4307
|
*/
|
|
4318
|
-
|
|
4308
|
+
currentEntity?: string;
|
|
4319
4309
|
}
|
|
4320
|
-
|
|
4310
|
+
interface EntityDeletedEvent {
|
|
4321
4311
|
/** Entity that was deleted. */
|
|
4322
|
-
|
|
4312
|
+
deletedEntity?: string | null;
|
|
4323
4313
|
}
|
|
4324
|
-
|
|
4325
|
-
|
|
4314
|
+
interface ActionEvent {
|
|
4315
|
+
body?: string;
|
|
4326
4316
|
}
|
|
4327
|
-
|
|
4317
|
+
interface MessageEnvelope {
|
|
4328
4318
|
/**
|
|
4329
4319
|
* App instance ID.
|
|
4330
4320
|
* @format GUID
|
|
@@ -4340,7 +4330,7 @@ export interface MessageEnvelope {
|
|
|
4340
4330
|
/** Stringify payload. */
|
|
4341
4331
|
data?: string;
|
|
4342
4332
|
}
|
|
4343
|
-
|
|
4333
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
4344
4334
|
/**
|
|
4345
4335
|
* ID of a site visitor that has not logged in to the site.
|
|
4346
4336
|
* @format GUID
|
|
@@ -4365,7 +4355,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
4365
4355
|
identityType?: WebhookIdentityTypeWithLiterals;
|
|
4366
4356
|
}
|
|
4367
4357
|
/** @oneof */
|
|
4368
|
-
|
|
4358
|
+
interface IdentificationDataIdOneOf {
|
|
4369
4359
|
/**
|
|
4370
4360
|
* ID of a site visitor that has not logged in to the site.
|
|
4371
4361
|
* @format GUID
|
|
@@ -4387,7 +4377,7 @@ export interface IdentificationDataIdOneOf {
|
|
|
4387
4377
|
*/
|
|
4388
4378
|
appId?: string;
|
|
4389
4379
|
}
|
|
4390
|
-
|
|
4380
|
+
declare enum WebhookIdentityType {
|
|
4391
4381
|
UNKNOWN = "UNKNOWN",
|
|
4392
4382
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
4393
4383
|
MEMBER = "MEMBER",
|
|
@@ -4395,4 +4385,360 @@ export declare enum WebhookIdentityType {
|
|
|
4395
4385
|
APP = "APP"
|
|
4396
4386
|
}
|
|
4397
4387
|
/** @enumType */
|
|
4398
|
-
|
|
4388
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
4389
|
+
interface BaseEventMetadata {
|
|
4390
|
+
/**
|
|
4391
|
+
* App instance ID.
|
|
4392
|
+
* @format GUID
|
|
4393
|
+
*/
|
|
4394
|
+
instanceId?: string | null;
|
|
4395
|
+
/**
|
|
4396
|
+
* Event type.
|
|
4397
|
+
* @maxLength 150
|
|
4398
|
+
*/
|
|
4399
|
+
eventType?: string;
|
|
4400
|
+
/** The identification type and identity data. */
|
|
4401
|
+
identity?: IdentificationData;
|
|
4402
|
+
}
|
|
4403
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
4404
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
4405
|
+
_id?: string;
|
|
4406
|
+
/**
|
|
4407
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
4408
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
4409
|
+
*/
|
|
4410
|
+
entityFqdn?: string;
|
|
4411
|
+
/**
|
|
4412
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
4413
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
4414
|
+
*/
|
|
4415
|
+
slug?: string;
|
|
4416
|
+
/** ID of the entity associated with the event. */
|
|
4417
|
+
entityId?: string;
|
|
4418
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
4419
|
+
eventTime?: Date | null;
|
|
4420
|
+
/**
|
|
4421
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
4422
|
+
* (for example, GDPR).
|
|
4423
|
+
*/
|
|
4424
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
4425
|
+
/** If present, indicates the action that triggered the event. */
|
|
4426
|
+
originatedFrom?: string | null;
|
|
4427
|
+
/**
|
|
4428
|
+
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
4429
|
+
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
4430
|
+
*/
|
|
4431
|
+
entityEventSequence?: string | null;
|
|
4432
|
+
}
|
|
4433
|
+
interface EventCanceledEnvelope {
|
|
4434
|
+
data: EventEventCanceled;
|
|
4435
|
+
metadata: EventMetadata;
|
|
4436
|
+
}
|
|
4437
|
+
interface EventClonedEnvelope {
|
|
4438
|
+
data: EventCloned;
|
|
4439
|
+
metadata: EventMetadata;
|
|
4440
|
+
}
|
|
4441
|
+
interface EventCreatedEnvelope {
|
|
4442
|
+
entity: V3Event;
|
|
4443
|
+
metadata: EventMetadata;
|
|
4444
|
+
}
|
|
4445
|
+
interface EventDeletedEnvelope {
|
|
4446
|
+
metadata: EventMetadata;
|
|
4447
|
+
}
|
|
4448
|
+
interface EventEndedEnvelope {
|
|
4449
|
+
data: EventEventEnded;
|
|
4450
|
+
metadata: EventMetadata;
|
|
4451
|
+
}
|
|
4452
|
+
interface EventPublishedEnvelope {
|
|
4453
|
+
data: EventEventPublished;
|
|
4454
|
+
metadata: EventMetadata;
|
|
4455
|
+
}
|
|
4456
|
+
interface EventReminderEnvelope {
|
|
4457
|
+
data: EventEventReminder;
|
|
4458
|
+
metadata: EventMetadata;
|
|
4459
|
+
}
|
|
4460
|
+
interface EventStartedEnvelope {
|
|
4461
|
+
data: EventEventStarted;
|
|
4462
|
+
metadata: EventMetadata;
|
|
4463
|
+
}
|
|
4464
|
+
interface EventUpdatedEnvelope {
|
|
4465
|
+
entity: V3Event;
|
|
4466
|
+
metadata: EventMetadata;
|
|
4467
|
+
}
|
|
4468
|
+
interface CreateEventOptions {
|
|
4469
|
+
/** Whether to create the event as a draft. */
|
|
4470
|
+
draft?: boolean;
|
|
4471
|
+
/**
|
|
4472
|
+
* Predefined sets of fields to return.
|
|
4473
|
+
* @maxSize 20
|
|
4474
|
+
*/
|
|
4475
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
4476
|
+
}
|
|
4477
|
+
interface CloneEventOptions {
|
|
4478
|
+
/** Field values to be changed when cloning the event. */
|
|
4479
|
+
event?: V3Event;
|
|
4480
|
+
/** Whether to clone the event as a draft. */
|
|
4481
|
+
draft?: boolean;
|
|
4482
|
+
/**
|
|
4483
|
+
* Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
|
|
4484
|
+
* @maxSize 20
|
|
4485
|
+
*/
|
|
4486
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
4487
|
+
}
|
|
4488
|
+
interface UpdateEventOptions {
|
|
4489
|
+
/** Event to update. */
|
|
4490
|
+
event: {
|
|
4491
|
+
/**
|
|
4492
|
+
* Event ID.
|
|
4493
|
+
* @format GUID
|
|
4494
|
+
* @readonly
|
|
4495
|
+
*/
|
|
4496
|
+
_id?: string;
|
|
4497
|
+
/** Event location. */
|
|
4498
|
+
location?: Location;
|
|
4499
|
+
/** Event date and time settings. */
|
|
4500
|
+
dateAndTimeSettings?: DateAndTimeSettings;
|
|
4501
|
+
/**
|
|
4502
|
+
* Event title.
|
|
4503
|
+
* @minLength 1
|
|
4504
|
+
* @maxLength 120
|
|
4505
|
+
*/
|
|
4506
|
+
title?: string | null;
|
|
4507
|
+
/**
|
|
4508
|
+
* Short description that appears under the event title.
|
|
4509
|
+
* @maxLength 500
|
|
4510
|
+
*/
|
|
4511
|
+
shortDescription?: string | null;
|
|
4512
|
+
/**
|
|
4513
|
+
* 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).
|
|
4514
|
+
* @maxLength 50000
|
|
4515
|
+
* @deprecated Detailed description of an event.
|
|
4516
|
+
*
|
|
4517
|
+
* This field is deprecated.
|
|
4518
|
+
* @replacedBy description
|
|
4519
|
+
* @targetRemovalDate 2025-04-15
|
|
4520
|
+
*/
|
|
4521
|
+
detailedDescription?: string | null;
|
|
4522
|
+
/**
|
|
4523
|
+
* Main event image. <br>
|
|
4524
|
+
* **Note:** This field is returned only when the `DETAILS` fieldset is included in the request.
|
|
4525
|
+
*/
|
|
4526
|
+
mainImage?: string;
|
|
4527
|
+
/**
|
|
4528
|
+
* 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".
|
|
4529
|
+
* @readonly
|
|
4530
|
+
*/
|
|
4531
|
+
slug?: string;
|
|
4532
|
+
/**
|
|
4533
|
+
* Date and time when the event was created.
|
|
4534
|
+
* @readonly
|
|
4535
|
+
*/
|
|
4536
|
+
_createdDate?: Date | null;
|
|
4537
|
+
/**
|
|
4538
|
+
* Date and time when the event was updated.
|
|
4539
|
+
* @readonly
|
|
4540
|
+
*/
|
|
4541
|
+
_updatedDate?: Date | null;
|
|
4542
|
+
/**
|
|
4543
|
+
* Event status. Possible values:
|
|
4544
|
+
*
|
|
4545
|
+
* - `UPCOMING`: The event is published and scheduled to start.
|
|
4546
|
+
* - `STARTED`: The event has started.
|
|
4547
|
+
* - `ENDED`: The event has ended.
|
|
4548
|
+
* - `CANCELED`: The event is canceled.
|
|
4549
|
+
* - `DRAFT`: The event is not published.
|
|
4550
|
+
* @readonly
|
|
4551
|
+
*/
|
|
4552
|
+
status?: StatusWithLiterals;
|
|
4553
|
+
/**
|
|
4554
|
+
* RSVP or ticketing registration details. <br>
|
|
4555
|
+
* **Note:** This field is returned only when the `REGISTRATION` fieldset is included in the request.
|
|
4556
|
+
*/
|
|
4557
|
+
registration?: Registration;
|
|
4558
|
+
/**
|
|
4559
|
+
* URLs that allow you to add an event to the Google calendar, or to download an [ICS calendar](https://icscalendar.com/) file. <br>
|
|
4560
|
+
* **Note:** This field is returned only when the `DETAILS` fieldset is included in the request.
|
|
4561
|
+
* @readonly
|
|
4562
|
+
*/
|
|
4563
|
+
calendarUrls?: CalendarUrls;
|
|
4564
|
+
/**
|
|
4565
|
+
* Event page URL components. <br>
|
|
4566
|
+
* **Note:** This field is returned only when the `URLS` fieldset is included in the request.
|
|
4567
|
+
*/
|
|
4568
|
+
eventPageUrl?: string;
|
|
4569
|
+
/**
|
|
4570
|
+
* Event registration form. <br>
|
|
4571
|
+
* **Note:** This field is returned only when the `FORM` fieldset is included in the request.
|
|
4572
|
+
*/
|
|
4573
|
+
form?: Form;
|
|
4574
|
+
/**
|
|
4575
|
+
* Summary of RSVP or ticket sales. <br>
|
|
4576
|
+
* **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.
|
|
4577
|
+
*/
|
|
4578
|
+
summaries?: Summaries;
|
|
4579
|
+
/**
|
|
4580
|
+
* Instance ID of the site where the event is hosted.
|
|
4581
|
+
* @readonly
|
|
4582
|
+
*/
|
|
4583
|
+
instanceId?: string;
|
|
4584
|
+
/** Guest list configuration. */
|
|
4585
|
+
guestListSettings?: GuestListSettings;
|
|
4586
|
+
/**
|
|
4587
|
+
* ID of the user who created the event.
|
|
4588
|
+
* @readonly
|
|
4589
|
+
* @format GUID
|
|
4590
|
+
*/
|
|
4591
|
+
userId?: string;
|
|
4592
|
+
/**
|
|
4593
|
+
* Online conferencing details. <br>
|
|
4594
|
+
* **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.
|
|
4595
|
+
*/
|
|
4596
|
+
onlineConferencing?: OnlineConferencing;
|
|
4597
|
+
/**
|
|
4598
|
+
* SEO settings. <br>
|
|
4599
|
+
* **Note:** This field is returned only when the `SEO_SETTINGS` fieldset is included in the request.
|
|
4600
|
+
*/
|
|
4601
|
+
seoSettings?: SeoSettings;
|
|
4602
|
+
/**
|
|
4603
|
+
* Assigned contacts label key.
|
|
4604
|
+
* @readonly
|
|
4605
|
+
*/
|
|
4606
|
+
contactLabel?: string | null;
|
|
4607
|
+
/**
|
|
4608
|
+
* Event schedule details. <br>
|
|
4609
|
+
* **Note:** This field is returned only when the `AGENDA` fieldset is included in the request.
|
|
4610
|
+
*/
|
|
4611
|
+
agendaSettings?: AgendaSettings;
|
|
4612
|
+
/** Visual settings for event. */
|
|
4613
|
+
eventDisplaySettings?: V3EventDisplaySettings;
|
|
4614
|
+
/**
|
|
4615
|
+
* Event description with rich content.
|
|
4616
|
+
*
|
|
4617
|
+
* 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.
|
|
4618
|
+
*/
|
|
4619
|
+
description?: RichContent;
|
|
4620
|
+
/**
|
|
4621
|
+
* Event publish timestamp.
|
|
4622
|
+
* @readonly
|
|
4623
|
+
*/
|
|
4624
|
+
publishedDate?: Date | null;
|
|
4625
|
+
};
|
|
4626
|
+
/**
|
|
4627
|
+
* Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
|
|
4628
|
+
* @maxSize 20
|
|
4629
|
+
*/
|
|
4630
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
4631
|
+
}
|
|
4632
|
+
interface PublishDraftEventOptions {
|
|
4633
|
+
/**
|
|
4634
|
+
* Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
|
|
4635
|
+
* @maxSize 20
|
|
4636
|
+
*/
|
|
4637
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
4638
|
+
}
|
|
4639
|
+
interface CancelEventOptions {
|
|
4640
|
+
/**
|
|
4641
|
+
* Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
|
|
4642
|
+
* @maxSize 20
|
|
4643
|
+
*/
|
|
4644
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
4645
|
+
}
|
|
4646
|
+
interface BulkCancelEventsByFilterOptions {
|
|
4647
|
+
/** Filter. */
|
|
4648
|
+
filter?: CommonQueryV2;
|
|
4649
|
+
}
|
|
4650
|
+
interface BulkDeleteEventsByFilterOptions {
|
|
4651
|
+
/** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
|
|
4652
|
+
filter?: CommonQueryV2;
|
|
4653
|
+
}
|
|
4654
|
+
interface QueryEventsOptions {
|
|
4655
|
+
/**
|
|
4656
|
+
* Predefined sets of fields to return.
|
|
4657
|
+
* @maxSize 20
|
|
4658
|
+
*/
|
|
4659
|
+
fields?: RequestedFieldsWithLiterals[] | undefined;
|
|
4660
|
+
/**
|
|
4661
|
+
* Whether draft events should be returned in the response. <br>
|
|
4662
|
+
* **Note:** This parameter requires the `WIX_EVENTS.READ_DRAFT_EVENTS` permission.
|
|
4663
|
+
*/
|
|
4664
|
+
includeDrafts?: boolean | undefined;
|
|
4665
|
+
}
|
|
4666
|
+
interface QueryOffsetResult {
|
|
4667
|
+
currentPage: number | undefined;
|
|
4668
|
+
totalPages: number | undefined;
|
|
4669
|
+
totalCount: number | undefined;
|
|
4670
|
+
hasNext: () => boolean;
|
|
4671
|
+
hasPrev: () => boolean;
|
|
4672
|
+
length: number;
|
|
4673
|
+
pageSize: number;
|
|
4674
|
+
}
|
|
4675
|
+
interface EventsQueryResult extends QueryOffsetResult {
|
|
4676
|
+
items: V3Event[];
|
|
4677
|
+
query: EventsQueryBuilder;
|
|
4678
|
+
next: () => Promise<EventsQueryResult>;
|
|
4679
|
+
prev: () => Promise<EventsQueryResult>;
|
|
4680
|
+
}
|
|
4681
|
+
interface EventsQueryBuilder {
|
|
4682
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
4683
|
+
* @param value - Value to compare against.
|
|
4684
|
+
*/
|
|
4685
|
+
eq: (propertyName: '_id' | 'dateAndTimeSettings.startDate' | 'dateAndTimeSettings.endDate' | 'title' | 'slug' | '_createdDate' | '_updatedDate' | 'status' | 'registration.initialType' | 'userId', value: any) => EventsQueryBuilder;
|
|
4686
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
4687
|
+
* @param value - Value to compare against.
|
|
4688
|
+
*/
|
|
4689
|
+
ne: (propertyName: '_id' | 'dateAndTimeSettings.startDate' | 'dateAndTimeSettings.endDate' | 'title' | 'slug' | '_createdDate' | '_updatedDate' | 'status' | 'userId', value: any) => EventsQueryBuilder;
|
|
4690
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
4691
|
+
* @param value - Value to compare against.
|
|
4692
|
+
*/
|
|
4693
|
+
ge: (propertyName: '_id' | 'dateAndTimeSettings.startDate' | 'dateAndTimeSettings.endDate' | 'title' | 'slug' | '_createdDate' | '_updatedDate', value: any) => EventsQueryBuilder;
|
|
4694
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
4695
|
+
* @param value - Value to compare against.
|
|
4696
|
+
*/
|
|
4697
|
+
gt: (propertyName: '_id' | 'dateAndTimeSettings.startDate' | 'dateAndTimeSettings.endDate' | 'title' | 'slug' | '_createdDate' | '_updatedDate', value: any) => EventsQueryBuilder;
|
|
4698
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
4699
|
+
* @param value - Value to compare against.
|
|
4700
|
+
*/
|
|
4701
|
+
le: (propertyName: '_id' | 'dateAndTimeSettings.startDate' | 'dateAndTimeSettings.endDate' | 'title' | 'slug' | '_createdDate' | '_updatedDate', value: any) => EventsQueryBuilder;
|
|
4702
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
4703
|
+
* @param value - Value to compare against.
|
|
4704
|
+
*/
|
|
4705
|
+
lt: (propertyName: '_id' | 'dateAndTimeSettings.startDate' | 'dateAndTimeSettings.endDate' | 'title' | 'slug' | '_createdDate' | '_updatedDate', value: any) => EventsQueryBuilder;
|
|
4706
|
+
in: (propertyName: '_id' | 'dateAndTimeSettings.startDate' | 'dateAndTimeSettings.endDate' | 'title' | 'slug' | '_createdDate' | '_updatedDate' | 'status' | 'userId', value: any) => EventsQueryBuilder;
|
|
4707
|
+
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
|
|
4708
|
+
ascending: (...propertyNames: Array<'_id' | 'dateAndTimeSettings.startDate' | 'dateAndTimeSettings.endDate' | 'title' | 'slug' | '_createdDate' | '_updatedDate'>) => EventsQueryBuilder;
|
|
4709
|
+
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
|
|
4710
|
+
descending: (...propertyNames: Array<'_id' | 'dateAndTimeSettings.startDate' | 'dateAndTimeSettings.endDate' | 'title' | 'slug' | '_createdDate' | '_updatedDate'>) => EventsQueryBuilder;
|
|
4711
|
+
/** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
|
|
4712
|
+
limit: (limit: number) => EventsQueryBuilder;
|
|
4713
|
+
/** @param skip - Number of items to skip in the query results before returning the results. */
|
|
4714
|
+
skip: (skip: number) => EventsQueryBuilder;
|
|
4715
|
+
find: () => Promise<EventsQueryResult>;
|
|
4716
|
+
}
|
|
4717
|
+
interface CountEventsByStatusOptions {
|
|
4718
|
+
/** Filter object in the following format: <br/> `"filter" : { "fieldName1": "value1" }`. */
|
|
4719
|
+
filter?: Record<string, any> | null;
|
|
4720
|
+
/**
|
|
4721
|
+
* Parameters to count events by.
|
|
4722
|
+
* @maxLength 100
|
|
4723
|
+
* @maxSize 20
|
|
4724
|
+
*/
|
|
4725
|
+
facet?: string[];
|
|
4726
|
+
/**
|
|
4727
|
+
* Whether draft events should be returned in the response. <br>
|
|
4728
|
+
* **Note:** This parameter requires the `WIX_EVENTS.READ_DRAFT_EVENTS` permission.
|
|
4729
|
+
*/
|
|
4730
|
+
includeDrafts?: boolean;
|
|
4731
|
+
}
|
|
4732
|
+
interface GetEventOptions {
|
|
4733
|
+
/**
|
|
4734
|
+
* Predefined sets of fields to return.
|
|
4735
|
+
* @maxSize 20
|
|
4736
|
+
*/
|
|
4737
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
4738
|
+
}
|
|
4739
|
+
interface GetEventBySlugOptions {
|
|
4740
|
+
/** @maxSize 20 */
|
|
4741
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
4742
|
+
}
|
|
4743
|
+
|
|
4744
|
+
export { Orientation as $, ConferenceTypeType as A, type BulkCancelEventsByFilterOptions as B, type CreateEventOptions as C, type DeleteEventResponse as D, type EventsQueryBuilder as E, CategoryTypeType as F, type GetEventOptions as G, PluginContainerDataAlignment as H, InitialRegistrationTypeType as I, ButtonDataType as J, Target as K, LocationType as L, TextAlignment as M, NodeType as N, LineStyle 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, Width as X, Alignment as Y, ViewMode as Z, LayoutType as _, type CloneEventOptions as a, type NegativeResponseConfirmation as a$, Crop as a0, ThumbnailsAlignment as a1, GIFType as a2, Source as a3, Position as a4, MapType as a5, ViewRole as a6, VoteRole as a7, PollLayoutType as a8, PollLayoutDirection as a9, type Location as aA, type CommonAddress as aB, type CommonAddressStreetOneOf as aC, type CommonStreetAddress as aD, type CommonAddressLocation as aE, type CommonSubdivision as aF, type DateAndTimeSettings as aG, type Recurrences as aH, type Occurrence as aI, type Formatted as aJ, type TimeDuration as aK, type Registration as aL, type RsvpRegistration as aM, type TicketsRegistration as aN, type Money as aO, type TaxSettings as aP, type ExternalRegistration as aQ, type CalendarUrls as aR, type Form as aS, type InputControl as aT, type Input as aU, type OptionSelection as aV, type OptionSelectionSelectedOptionOneOf as aW, type Label as aX, type FormMessages as aY, type RsvpFormMessages as aZ, type PositiveResponseConfirmation as a_, BackgroundType as aa, DecorationType as ab, FontType as ac, AppType as ad, InitialExpandedItems as ae, Direction as af, VerticalAlignment as ag, NullValue as ah, BadgeTypeType as ai, RequestedFields as aj, CommonSortOrder as ak, SortOrder as al, Relation as am, LocationLocationType as an, SubdivisionType as ao, EventsRecurrenceStatusStatus as ap, EventStatus as aq, EventType as ar, RegistrationStatus as as, RsvpStatusOptions as at, EventsTaxType as au, VisitorType as av, ConferenceType as aw, State as ax, Type as ay, WebhookIdentityType as az, type CloneEventResponse as b, type StylesBorder as b$, type Positive as b0, type Negative as b1, type CheckoutFormMessages as b2, type ResponseConfirmation as b3, type RegistrationClosedMessages as b4, type TicketsUnavailableMessages as b5, type Summaries as b6, type EventsMoney as b7, type Rsvps as b8, type Tickets as b9, type Styles as bA, type Link as bB, type LinkDataOneOf as bC, type Rel as bD, type CodeBlockData as bE, type TextStyle as bF, type DividerData as bG, type FileData as bH, type FileSource as bI, type FileSourceDataOneOf as bJ, type PDFSettings as bK, type GalleryData as bL, type Media as bM, type Image as bN, type Video as bO, type Item as bP, type ItemDataOneOf as bQ, type GalleryOptions as bR, type Layout as bS, type ItemStyle as bT, type Thumbnails as bU, type GIFData as bV, type GIF as bW, type HeadingData as bX, type HTMLData as bY, type HTMLDataDataOneOf as bZ, type ImageData as b_, type GuestListSettings as ba, type Feed as bb, type OnlineConferencing as bc, type OnlineConferencingSession as bd, type SeoSettings as be, type SeoSchema as bf, type Keyword as bg, type Tag as bh, type Settings as bi, type AgendaSettings as bj, type EventCategories as bk, type EventCategory as bl, type V3EventDisplaySettings as bm, type LabellingSettings as bn, type RichContent as bo, type Node as bp, type NodeDataOneOf as bq, type NodeStyle as br, type ButtonData as bs, type Border as bt, type Colors as bu, type PluginContainerData as bv, type PluginContainerDataWidth as bw, type PluginContainerDataWidthDataOneOf as bx, type Spoiler as by, type Height as bz, type PublishDraftEventResponse as c, type CloneEventRequest as c$, type ImageDataStyles as c0, type LinkPreviewData as c1, type LinkPreviewDataStyles as c2, type MapData as c3, type MapSettings as c4, type ParagraphData as c5, type PollData as c6, type Permissions as c7, type Option as c8, type PollSettings as c9, type Oembed as cA, type CollapsibleListData as cB, type TableData as cC, type Dimensions as cD, type TableCellData as cE, type CellStyle as cF, type BorderColors as cG, type ListValue as cH, type AudioData as cI, type OrderedListData as cJ, type BulletedListData as cK, type BlockquoteData as cL, type CaptionData as cM, type LayoutCellData as cN, type Metadata as cO, type DocumentStyle as cP, type TextNodeStyle as cQ, type BadgeList as cR, type V3Badge as cS, type EventEventStarted as cT, type EventEventEnded as cU, type EventEventReminder as cV, type EventEventPublished as cW, type EventCloned as cX, type EventEventCanceled as cY, type CreateEventRequest as cZ, type CreateEventResponse as c_, type PollLayout as ca, type OptionLayout as cb, type Gradient as cc, type Background as cd, type BackgroundBackgroundOneOf as ce, type PollDesign as cf, type OptionDesign as cg, type Poll as ch, type PollDataLayout as ci, type Design as cj, type TextData as ck, type Decoration as cl, type DecorationDataOneOf as cm, type AnchorData as cn, type ColorData as co, type LinkData as cp, type MentionData as cq, type FontSizeData as cr, type SpoilerData as cs, type AppEmbedData as ct, type AppEmbedDataAppDataOneOf as cu, type BookingData as cv, type EventData as cw, type VideoData as cx, type PlaybackOptions as cy, type EmbedData as cz, type CancelEventOptions as d, type SiteUrl as d$, type CloneEventFromOtherSiteRequest as d0, type CloneEventFromOtherSiteResponse as d1, type UpdateEventRequest as d2, type UpdateEventResponse as d3, type PublishDraftEventRequest as d4, type CancelEventRequest as d5, type BulkCancelEventsByFilterRequest as d6, type CommonQueryV2 as d7, type CommonQueryV2PagingMethodOneOf as d8, type CommonSorting as d9, type GetEventRequest as dA, type GetEventResponse as dB, type GetEventBySlugRequest as dC, type FindEventRequest as dD, type FindEventRequestFindByOneOf as dE, type FindEventResponse as dF, type EventCreated as dG, type EventsLocation as dH, type MapCoordinates as dI, type Address as dJ, type AddressStreetOneOf as dK, type StreetAddress as dL, type AddressLocation as dM, type Subdivision as dN, type ScheduleConfig as dO, type EventsRecurrences as dP, type EventsOccurrence as dQ, type Event as dR, type Scheduling as dS, type EventsRegistration as dT, type RsvpCollection as dU, type RsvpCollectionConfig as dV, type Ticketing as dW, type TicketingConfig as dX, type TaxConfig as dY, type ExternalEvent as dZ, type CalendarLinks as d_, type CommonPaging as da, type BulkCancelEventsByFilterResponse as db, type DeleteEventRequest as dc, type BulkDeleteEventsByFilterRequest as dd, type BulkDeleteEventsByFilterResponse as de, type QueryEventsRequest as df, type QueryEventsResponse as dg, type CommonPagingMetadataV2 as dh, type CommonCursors as di, type ExportEventsRequest as dj, type QueryV2 as dk, type QueryV2PagingMethodOneOf as dl, type Sorting as dm, type Paging as dn, type CursorPaging as dp, type ExportEventsResponse as dq, type PagingMetadataV2 as dr, type Cursors as ds, type CountEventsByStatusRequest as dt, type FacetCounts as du, type ListUserEventsRequest as dv, type UserFilter as dw, type ListUserEventsResponse as dx, type ListEventsByCategoryRequest as dy, type ListEventsByCategoryResponse as dz, type CancelEventResponse as e, type Dashboard as e0, type RsvpSummary as e1, type TicketingSummary as e2, type GuestListConfig as e3, type EventsFeed as e4, type EventsOnlineConferencing as e5, type OnlineConferencingConfig as e6, type EventsOnlineConferencingSession as e7, type EventsSeoSettings as e8, type Agenda as e9, type EventsQueryResult as eA, type Category as ea, type CategoryCounts as eb, type EventDisplaySettings as ec, type EventsLabellingSettings as ed, type Badge as ee, type Empty as ef, type EventUpdated as eg, type EventDeleted as eh, type EventCopied as ei, type EventPublished as ej, type EventCanceled as ek, type EventStarted as el, type EventEnded as em, type EventReminder as en, type DomainEvent as eo, type DomainEventBodyOneOf as ep, type EntityCreatedEvent as eq, type RestoreInfo as er, type EntityUpdatedEvent as es, type EntityDeletedEvent as et, type ActionEvent as eu, type MessageEnvelope as ev, type IdentificationData as ew, type IdentificationDataIdOneOf as ex, type BaseEventMetadata as ey, type EventMetadata as ez, type BulkDeleteEventsByFilterOptions as f, type CountEventsByStatusOptions as g, type CountEventsByStatusResponse as h, type GetEventBySlugOptions as i, type GetEventBySlugResponse as j, type EventCanceledEnvelope as k, type EventClonedEnvelope as l, type EventCreatedEnvelope as m, type EventDeletedEnvelope as n, type EventEndedEnvelope as o, type EventPublishedEnvelope as p, type EventReminderEnvelope as q, type EventStartedEnvelope as r, type EventUpdatedEnvelope as s, Status as t, RegistrationTypeType as u, RegistrationStatusStatus as v, ResponseType as w, GuestTypeType as x, InputControlType as y, ValueType as z };
|