@wix/auto_sdk_events_forms 1.0.18 → 1.0.20
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/{internal/cjs/src/events-v1-form-forms.universal.d.ts → events-v1-form-forms.universal-DYWoz6AH.d.mts} +251 -534
- package/build/{cjs/src/events-v1-form-forms.universal.d.ts → events-v1-form-forms.universal-DYWoz6AH.d.ts} +251 -534
- package/build/index.d.mts +84 -0
- package/build/index.d.ts +84 -0
- package/build/index.js +1511 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +1434 -0
- package/build/index.mjs.map +1 -0
- package/build/internal/{es/src/events-v1-form-forms.universal.d.ts → events-v1-form-forms.universal-DYWoz6AH.d.mts} +251 -534
- package/build/{es/src/events-v1-form-forms.universal.d.ts → internal/events-v1-form-forms.universal-DYWoz6AH.d.ts} +251 -534
- package/build/internal/index.d.mts +84 -0
- package/build/internal/index.d.ts +84 -0
- package/build/internal/index.js +1511 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +1434 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/meta.d.mts +648 -0
- package/build/internal/meta.d.ts +648 -0
- package/build/internal/meta.js +800 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +767 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/meta.d.mts +648 -0
- package/build/meta.d.ts +648 -0
- package/build/meta.js +800 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +767 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +13 -12
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.js.map +0 -1
- package/build/cjs/src/events-v1-form-forms.context.d.ts +0 -17
- package/build/cjs/src/events-v1-form-forms.context.js +0 -67
- package/build/cjs/src/events-v1-form-forms.context.js.map +0 -1
- package/build/cjs/src/events-v1-form-forms.http.d.ts +0 -22
- package/build/cjs/src/events-v1-form-forms.http.js +0 -653
- package/build/cjs/src/events-v1-form-forms.http.js.map +0 -1
- package/build/cjs/src/events-v1-form-forms.meta.d.ts +0 -35
- package/build/cjs/src/events-v1-form-forms.meta.js +0 -161
- package/build/cjs/src/events-v1-form-forms.meta.js.map +0 -1
- package/build/cjs/src/events-v1-form-forms.public.d.ts +0 -72
- package/build/cjs/src/events-v1-form-forms.public.js +0 -202
- package/build/cjs/src/events-v1-form-forms.public.js.map +0 -1
- package/build/cjs/src/events-v1-form-forms.types.d.ts +0 -3091
- package/build/cjs/src/events-v1-form-forms.types.js +0 -487
- package/build/cjs/src/events-v1-form-forms.types.js.map +0 -1
- package/build/cjs/src/events-v1-form-forms.universal.js +0 -866
- package/build/cjs/src/events-v1-form-forms.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/package.json +0 -3
- package/build/es/src/events-v1-form-forms.context.d.ts +0 -17
- package/build/es/src/events-v1-form-forms.context.js +0 -17
- package/build/es/src/events-v1-form-forms.context.js.map +0 -1
- package/build/es/src/events-v1-form-forms.http.d.ts +0 -22
- package/build/es/src/events-v1-form-forms.http.js +0 -643
- package/build/es/src/events-v1-form-forms.http.js.map +0 -1
- package/build/es/src/events-v1-form-forms.meta.d.ts +0 -35
- package/build/es/src/events-v1-form-forms.meta.js +0 -128
- package/build/es/src/events-v1-form-forms.meta.js.map +0 -1
- package/build/es/src/events-v1-form-forms.public.d.ts +0 -72
- package/build/es/src/events-v1-form-forms.public.js +0 -145
- package/build/es/src/events-v1-form-forms.public.js.map +0 -1
- package/build/es/src/events-v1-form-forms.types.d.ts +0 -3091
- package/build/es/src/events-v1-form-forms.types.js +0 -484
- package/build/es/src/events-v1-form-forms.types.js.map +0 -1
- package/build/es/src/events-v1-form-forms.universal.js +0 -832
- package/build/es/src/events-v1-form-forms.universal.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -1
- package/build/internal/cjs/index.js +0 -18
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.d.ts +0 -1
- package/build/internal/cjs/meta.js +0 -18
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/src/events-v1-form-forms.context.d.ts +0 -17
- package/build/internal/cjs/src/events-v1-form-forms.context.js +0 -67
- package/build/internal/cjs/src/events-v1-form-forms.context.js.map +0 -1
- package/build/internal/cjs/src/events-v1-form-forms.http.d.ts +0 -22
- package/build/internal/cjs/src/events-v1-form-forms.http.js +0 -653
- package/build/internal/cjs/src/events-v1-form-forms.http.js.map +0 -1
- package/build/internal/cjs/src/events-v1-form-forms.meta.d.ts +0 -35
- package/build/internal/cjs/src/events-v1-form-forms.meta.js +0 -161
- package/build/internal/cjs/src/events-v1-form-forms.meta.js.map +0 -1
- package/build/internal/cjs/src/events-v1-form-forms.public.d.ts +0 -72
- package/build/internal/cjs/src/events-v1-form-forms.public.js +0 -202
- package/build/internal/cjs/src/events-v1-form-forms.public.js.map +0 -1
- package/build/internal/cjs/src/events-v1-form-forms.types.d.ts +0 -3091
- package/build/internal/cjs/src/events-v1-form-forms.types.js +0 -487
- package/build/internal/cjs/src/events-v1-form-forms.types.js.map +0 -1
- package/build/internal/cjs/src/events-v1-form-forms.universal.js +0 -866
- package/build/internal/cjs/src/events-v1-form-forms.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/events-v1-form-forms.context.d.ts +0 -17
- package/build/internal/es/src/events-v1-form-forms.context.js +0 -17
- package/build/internal/es/src/events-v1-form-forms.context.js.map +0 -1
- package/build/internal/es/src/events-v1-form-forms.http.d.ts +0 -22
- package/build/internal/es/src/events-v1-form-forms.http.js +0 -643
- package/build/internal/es/src/events-v1-form-forms.http.js.map +0 -1
- package/build/internal/es/src/events-v1-form-forms.meta.d.ts +0 -35
- package/build/internal/es/src/events-v1-form-forms.meta.js +0 -128
- package/build/internal/es/src/events-v1-form-forms.meta.js.map +0 -1
- package/build/internal/es/src/events-v1-form-forms.public.d.ts +0 -72
- package/build/internal/es/src/events-v1-form-forms.public.js +0 -145
- package/build/internal/es/src/events-v1-form-forms.public.js.map +0 -1
- package/build/internal/es/src/events-v1-form-forms.types.d.ts +0 -3091
- package/build/internal/es/src/events-v1-form-forms.types.js +0 -484
- package/build/internal/es/src/events-v1-form-forms.types.js.map +0 -1
- package/build/internal/es/src/events-v1-form-forms.universal.js +0 -832
- package/build/internal/es/src/events-v1-form-forms.universal.js.map +0 -1
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
*
|
|
12
12
|
* By default, name and email controls are always required and are pinned to the top of the form.
|
|
13
13
|
*/
|
|
14
|
-
|
|
14
|
+
interface Form {
|
|
15
15
|
/** Nested fields as an ordered list. */
|
|
16
16
|
controls?: InputControl[];
|
|
17
17
|
/**
|
|
@@ -24,7 +24,7 @@ export interface Form {
|
|
|
24
24
|
* A block of nested fields.
|
|
25
25
|
* Used to aggregate similar inputs like First Name and Last Name.
|
|
26
26
|
*/
|
|
27
|
-
|
|
27
|
+
interface InputControl {
|
|
28
28
|
/** Field control type. */
|
|
29
29
|
type?: InputControlType;
|
|
30
30
|
/** Whether the control is mandatory (such as `name` & `email`). When `true`, only the label can be changed. */
|
|
@@ -51,7 +51,7 @@ export interface InputControl {
|
|
|
51
51
|
*/
|
|
52
52
|
deleted?: boolean | null;
|
|
53
53
|
}
|
|
54
|
-
|
|
54
|
+
declare enum InputControlType {
|
|
55
55
|
/** Single text value field. */
|
|
56
56
|
INPUT = "INPUT",
|
|
57
57
|
/** Single text value field with multiple lines. */
|
|
@@ -74,7 +74,7 @@ export declare enum InputControlType {
|
|
|
74
74
|
DATE = "DATE"
|
|
75
75
|
}
|
|
76
76
|
/** Child inputs. */
|
|
77
|
-
|
|
77
|
+
interface Input {
|
|
78
78
|
/** Field name. */
|
|
79
79
|
name?: string;
|
|
80
80
|
/**
|
|
@@ -116,7 +116,7 @@ export interface Input {
|
|
|
116
116
|
*/
|
|
117
117
|
labels?: Label[];
|
|
118
118
|
}
|
|
119
|
-
|
|
119
|
+
declare enum ValueType {
|
|
120
120
|
TEXT = "TEXT",
|
|
121
121
|
NUMBER = "NUMBER",
|
|
122
122
|
TEXT_ARRAY = "TEXT_ARRAY",
|
|
@@ -127,7 +127,7 @@ export declare enum ValueType {
|
|
|
127
127
|
* Describes initially selected option when an input has multiple choices.
|
|
128
128
|
* Defaults to first (0th) option if not configured.
|
|
129
129
|
*/
|
|
130
|
-
|
|
130
|
+
interface OptionSelection extends OptionSelectionSelectedOptionOneOf {
|
|
131
131
|
/**
|
|
132
132
|
* 0-based index from predefined `controls.inputs.options` which is initial selection.
|
|
133
133
|
* @max 199
|
|
@@ -141,7 +141,7 @@ export interface OptionSelection extends OptionSelectionSelectedOptionOneOf {
|
|
|
141
141
|
placeholderText?: string;
|
|
142
142
|
}
|
|
143
143
|
/** @oneof */
|
|
144
|
-
|
|
144
|
+
interface OptionSelectionSelectedOptionOneOf {
|
|
145
145
|
/**
|
|
146
146
|
* 0-based index from predefined `controls.inputs.options` which is initial selection.
|
|
147
147
|
* @max 199
|
|
@@ -154,7 +154,7 @@ export interface OptionSelectionSelectedOptionOneOf {
|
|
|
154
154
|
*/
|
|
155
155
|
placeholderText?: string;
|
|
156
156
|
}
|
|
157
|
-
|
|
157
|
+
interface Label {
|
|
158
158
|
/** Field name. */
|
|
159
159
|
name?: string;
|
|
160
160
|
/** Field label. */
|
|
@@ -164,7 +164,7 @@ export interface Label {
|
|
|
164
164
|
* Defines form messages shown in UI before, during, and after registration flow.
|
|
165
165
|
* It enables configuration of form titles, response labels, "thank you" messages, and call-to-action texts.
|
|
166
166
|
*/
|
|
167
|
-
|
|
167
|
+
interface FormMessages {
|
|
168
168
|
/** 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. */
|
|
169
169
|
rsvp?: RsvpFormMessages;
|
|
170
170
|
/** Checkout form messages. */
|
|
@@ -174,7 +174,7 @@ export interface FormMessages {
|
|
|
174
174
|
/** Messages shown when event tickets are unavailable. */
|
|
175
175
|
ticketsUnavailable?: TicketsUnavailableMessages;
|
|
176
176
|
}
|
|
177
|
-
|
|
177
|
+
interface RsvpFormMessages {
|
|
178
178
|
/** Label text indicating RSVP's `status` is `"YES"`. */
|
|
179
179
|
rsvpYesOption?: string;
|
|
180
180
|
/** Label text indicating RSVP's `status` is `"NO"`. */
|
|
@@ -189,7 +189,7 @@ export interface RsvpFormMessages {
|
|
|
189
189
|
submitActionLabel?: string;
|
|
190
190
|
}
|
|
191
191
|
/** Confirmation messages shown after registration. */
|
|
192
|
-
|
|
192
|
+
interface PositiveResponseConfirmation {
|
|
193
193
|
/** Confirmation message title. */
|
|
194
194
|
title?: string;
|
|
195
195
|
/** Confirmation message text. */
|
|
@@ -200,27 +200,27 @@ export interface PositiveResponseConfirmation {
|
|
|
200
200
|
shareActionLabel?: string;
|
|
201
201
|
}
|
|
202
202
|
/** Confirmation messages shown after registration. */
|
|
203
|
-
|
|
203
|
+
interface NegativeResponseConfirmation {
|
|
204
204
|
/** Confirmation message title. */
|
|
205
205
|
title?: string;
|
|
206
206
|
/** "Share event" call-to-action label text. */
|
|
207
207
|
shareActionLabel?: string;
|
|
208
208
|
}
|
|
209
209
|
/** Set of messages shown during registration when RSVP response is positive. */
|
|
210
|
-
|
|
210
|
+
interface Positive {
|
|
211
211
|
/** Main form title for positive response. */
|
|
212
212
|
title?: string;
|
|
213
213
|
/** Confirmation messages shown after registration. */
|
|
214
214
|
confirmation?: PositiveResponseConfirmation;
|
|
215
215
|
}
|
|
216
216
|
/** A set of messages shown during registration with negative response */
|
|
217
|
-
|
|
217
|
+
interface Negative {
|
|
218
218
|
/** Main form title for negative response. */
|
|
219
219
|
title?: string;
|
|
220
220
|
/** Confirmation messages shown after registration. */
|
|
221
221
|
confirmation?: NegativeResponseConfirmation;
|
|
222
222
|
}
|
|
223
|
-
|
|
223
|
+
interface CheckoutFormMessages {
|
|
224
224
|
/** Main form title for response. */
|
|
225
225
|
title?: string;
|
|
226
226
|
/** Submit form call-to-action label text. */
|
|
@@ -229,7 +229,7 @@ export interface CheckoutFormMessages {
|
|
|
229
229
|
confirmation?: ResponseConfirmation;
|
|
230
230
|
}
|
|
231
231
|
/** Confirmation messages shown after checkout. */
|
|
232
|
-
|
|
232
|
+
interface ResponseConfirmation {
|
|
233
233
|
/** Confirmation message title. */
|
|
234
234
|
title?: string;
|
|
235
235
|
/** Confirmation message text. */
|
|
@@ -241,49 +241,49 @@ export interface ResponseConfirmation {
|
|
|
241
241
|
/** "Share event" call-to-action label text. */
|
|
242
242
|
shareEventLabel?: string;
|
|
243
243
|
}
|
|
244
|
-
|
|
244
|
+
interface RegistrationClosedMessages {
|
|
245
245
|
/** Message shown when event registration is closed. */
|
|
246
246
|
message?: string;
|
|
247
247
|
/** "Explore other events" call-to-action label text. */
|
|
248
248
|
exploreEventsActionLabel?: string;
|
|
249
249
|
}
|
|
250
|
-
|
|
250
|
+
interface TicketsUnavailableMessages {
|
|
251
251
|
/** Message shown when event tickets are unavailable. */
|
|
252
252
|
message?: string;
|
|
253
253
|
/** "Explore other events" call-to-action label text. */
|
|
254
254
|
exploreEventsActionLabel?: string;
|
|
255
255
|
}
|
|
256
|
-
|
|
256
|
+
interface FormInputControlAdded {
|
|
257
257
|
/** Event ID. */
|
|
258
258
|
eventId?: string;
|
|
259
259
|
/** Input control. */
|
|
260
260
|
inputControl?: InputControl;
|
|
261
261
|
}
|
|
262
|
-
|
|
262
|
+
interface FormInputControlUpdated {
|
|
263
263
|
/** Event ID. */
|
|
264
264
|
eventId?: string;
|
|
265
265
|
/** Input control. */
|
|
266
266
|
updatedInputControl?: InputControl;
|
|
267
267
|
}
|
|
268
|
-
|
|
268
|
+
interface FormInputControlDeleted {
|
|
269
269
|
/** Event ID. */
|
|
270
270
|
eventId?: string;
|
|
271
271
|
/** Input control. */
|
|
272
272
|
deletedInputControl?: InputControl;
|
|
273
273
|
}
|
|
274
|
-
|
|
274
|
+
interface GetFormRequest {
|
|
275
275
|
/**
|
|
276
276
|
* Event ID to which the form belongs.
|
|
277
277
|
* @format GUID
|
|
278
278
|
*/
|
|
279
279
|
eventId: string;
|
|
280
280
|
}
|
|
281
|
-
|
|
281
|
+
declare enum RequestedFields {
|
|
282
282
|
UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
|
|
283
283
|
/** Include soft deleted input controls in the response. */
|
|
284
284
|
DELETED = "DELETED"
|
|
285
285
|
}
|
|
286
|
-
|
|
286
|
+
interface GetFormResponse {
|
|
287
287
|
/**
|
|
288
288
|
* Currently published event form.
|
|
289
289
|
* Published form is visible to site visitors.
|
|
@@ -295,7 +295,7 @@ export interface GetFormResponse {
|
|
|
295
295
|
*/
|
|
296
296
|
draftForm?: Form;
|
|
297
297
|
}
|
|
298
|
-
|
|
298
|
+
interface AddControlRequest extends AddControlRequestControlOneOf {
|
|
299
299
|
/** Phone number input control. */
|
|
300
300
|
phone?: PhoneControl;
|
|
301
301
|
/** Single-line or full address input control. */
|
|
@@ -319,7 +319,7 @@ export interface AddControlRequest extends AddControlRequestControlOneOf {
|
|
|
319
319
|
eventId: string;
|
|
320
320
|
}
|
|
321
321
|
/** @oneof */
|
|
322
|
-
|
|
322
|
+
interface AddControlRequestControlOneOf {
|
|
323
323
|
/** Phone number input control. */
|
|
324
324
|
phone?: PhoneControl;
|
|
325
325
|
/** Single-line or full address input control. */
|
|
@@ -337,7 +337,7 @@ export interface AddControlRequestControlOneOf {
|
|
|
337
337
|
/** Single-choice radio button style input control. */
|
|
338
338
|
radioButton?: RadioButtonControl;
|
|
339
339
|
}
|
|
340
|
-
|
|
340
|
+
interface PhoneControl {
|
|
341
341
|
/**
|
|
342
342
|
* Phone input label.
|
|
343
343
|
* @maxLength 100
|
|
@@ -346,7 +346,7 @@ export interface PhoneControl {
|
|
|
346
346
|
/** Whether the phone input is required. */
|
|
347
347
|
mandatory?: boolean;
|
|
348
348
|
}
|
|
349
|
-
|
|
349
|
+
interface AddressControl {
|
|
350
350
|
/** Address control labels for each input. */
|
|
351
351
|
labels?: AddressControlLabels;
|
|
352
352
|
/** Whether an address is multi-line (consisting of multiple fields such as country, city, postal code). When `false`, address is single-line. */
|
|
@@ -354,7 +354,7 @@ export interface AddressControl {
|
|
|
354
354
|
/** Whether the address input is required. */
|
|
355
355
|
mandatory?: boolean;
|
|
356
356
|
}
|
|
357
|
-
|
|
357
|
+
interface AddressControlLabels {
|
|
358
358
|
/**
|
|
359
359
|
* Single-line address input label.
|
|
360
360
|
* @maxLength 100
|
|
@@ -386,7 +386,7 @@ export interface AddressControlLabels {
|
|
|
386
386
|
*/
|
|
387
387
|
streetAddress?: string;
|
|
388
388
|
}
|
|
389
|
-
|
|
389
|
+
interface DateControl {
|
|
390
390
|
/**
|
|
391
391
|
* Input control label.
|
|
392
392
|
* @maxLength 100
|
|
@@ -395,7 +395,7 @@ export interface DateControl {
|
|
|
395
395
|
/** Whether the date input is required. */
|
|
396
396
|
mandatory?: boolean;
|
|
397
397
|
}
|
|
398
|
-
|
|
398
|
+
interface AdditionalGuestsControl {
|
|
399
399
|
/** Additional guests control labels for each input. */
|
|
400
400
|
labels?: Labels;
|
|
401
401
|
/** Whether the individual guest names are required. */
|
|
@@ -407,7 +407,7 @@ export interface AdditionalGuestsControl {
|
|
|
407
407
|
*/
|
|
408
408
|
maxGuests?: number;
|
|
409
409
|
}
|
|
410
|
-
|
|
410
|
+
interface Labels {
|
|
411
411
|
/**
|
|
412
412
|
* Input label for a single guest.
|
|
413
413
|
* @maxLength 200
|
|
@@ -419,7 +419,7 @@ export interface Labels {
|
|
|
419
419
|
*/
|
|
420
420
|
multiple?: string;
|
|
421
421
|
}
|
|
422
|
-
|
|
422
|
+
interface DropdownControl {
|
|
423
423
|
/**
|
|
424
424
|
* Input control label.
|
|
425
425
|
* @maxLength 200
|
|
@@ -441,7 +441,7 @@ export interface DropdownControl {
|
|
|
441
441
|
*/
|
|
442
442
|
defaultOptionSelection?: OptionSelection;
|
|
443
443
|
}
|
|
444
|
-
|
|
444
|
+
interface RadioButtonControl {
|
|
445
445
|
/**
|
|
446
446
|
* Input control label.
|
|
447
447
|
* @maxLength 200
|
|
@@ -455,7 +455,7 @@ export interface RadioButtonControl {
|
|
|
455
455
|
*/
|
|
456
456
|
options?: string[];
|
|
457
457
|
}
|
|
458
|
-
|
|
458
|
+
interface CheckboxControl {
|
|
459
459
|
/**
|
|
460
460
|
* Input control label.
|
|
461
461
|
* @maxLength 200
|
|
@@ -471,7 +471,7 @@ export interface CheckboxControl {
|
|
|
471
471
|
*/
|
|
472
472
|
options?: string[];
|
|
473
473
|
}
|
|
474
|
-
|
|
474
|
+
interface TextControl {
|
|
475
475
|
/**
|
|
476
476
|
* Input control label.
|
|
477
477
|
* @maxLength 200
|
|
@@ -489,13 +489,13 @@ export interface TextControl {
|
|
|
489
489
|
/** Whether the input control should be displayed as a comment. */
|
|
490
490
|
comment?: boolean;
|
|
491
491
|
}
|
|
492
|
-
|
|
492
|
+
interface AddControlResponse {
|
|
493
493
|
/** Generated unique input control ID. */
|
|
494
494
|
_id?: string;
|
|
495
495
|
/** Modified draft event form. */
|
|
496
496
|
form?: Form;
|
|
497
497
|
}
|
|
498
|
-
|
|
498
|
+
interface UpdateControlRequest extends UpdateControlRequestControlOneOf {
|
|
499
499
|
/** Phone number input control. */
|
|
500
500
|
phone?: PhoneControl;
|
|
501
501
|
/** Single-line or full address input control. */
|
|
@@ -527,7 +527,7 @@ export interface UpdateControlRequest extends UpdateControlRequestControlOneOf {
|
|
|
527
527
|
orderIndex?: number;
|
|
528
528
|
}
|
|
529
529
|
/** @oneof */
|
|
530
|
-
|
|
530
|
+
interface UpdateControlRequestControlOneOf {
|
|
531
531
|
/** Phone number input control. */
|
|
532
532
|
phone?: PhoneControl;
|
|
533
533
|
/** Single-line or full address input control. */
|
|
@@ -549,11 +549,11 @@ export interface UpdateControlRequestControlOneOf {
|
|
|
549
549
|
/** Single-choice radio style input control. */
|
|
550
550
|
radioButton?: RadioButtonControl;
|
|
551
551
|
}
|
|
552
|
-
|
|
552
|
+
interface NameControl {
|
|
553
553
|
/** Name control labels of each input. */
|
|
554
554
|
labels?: NameControlLabels;
|
|
555
555
|
}
|
|
556
|
-
|
|
556
|
+
interface NameControlLabels {
|
|
557
557
|
/**
|
|
558
558
|
* First name input label.
|
|
559
559
|
* @maxLength 100
|
|
@@ -565,18 +565,18 @@ export interface NameControlLabels {
|
|
|
565
565
|
*/
|
|
566
566
|
lastName?: string;
|
|
567
567
|
}
|
|
568
|
-
|
|
568
|
+
interface EmailControl {
|
|
569
569
|
/**
|
|
570
570
|
* Email input label.
|
|
571
571
|
* @maxLength 100
|
|
572
572
|
*/
|
|
573
573
|
label?: string;
|
|
574
574
|
}
|
|
575
|
-
|
|
575
|
+
interface UpdateControlResponse {
|
|
576
576
|
/** Modified draft event form. */
|
|
577
577
|
form?: Form;
|
|
578
578
|
}
|
|
579
|
-
|
|
579
|
+
interface DeleteControlRequest {
|
|
580
580
|
/**
|
|
581
581
|
* Event ID to which the form belongs.
|
|
582
582
|
* @format GUID
|
|
@@ -588,11 +588,11 @@ export interface DeleteControlRequest {
|
|
|
588
588
|
*/
|
|
589
589
|
_id: string;
|
|
590
590
|
}
|
|
591
|
-
|
|
591
|
+
interface DeleteControlResponse {
|
|
592
592
|
/** Modified draft event form. */
|
|
593
593
|
form?: Form;
|
|
594
594
|
}
|
|
595
|
-
|
|
595
|
+
interface UpdateMessagesRequest {
|
|
596
596
|
/**
|
|
597
597
|
* Event ID to which the form belongs.
|
|
598
598
|
* @format GUID
|
|
@@ -607,22 +607,22 @@ export interface UpdateMessagesRequest {
|
|
|
607
607
|
/** Set of configured form messages to update. */
|
|
608
608
|
messages?: FormMessages;
|
|
609
609
|
}
|
|
610
|
-
|
|
610
|
+
interface UpdateMessagesResponse {
|
|
611
611
|
/** Modified draft event form. */
|
|
612
612
|
form?: Form;
|
|
613
613
|
}
|
|
614
|
-
|
|
614
|
+
interface PublishDraftRequest {
|
|
615
615
|
/**
|
|
616
616
|
* Event ID to which the form belongs.
|
|
617
617
|
* @format GUID
|
|
618
618
|
*/
|
|
619
619
|
eventId: string;
|
|
620
620
|
}
|
|
621
|
-
|
|
621
|
+
interface PublishDraftResponse {
|
|
622
622
|
/** Published event form. */
|
|
623
623
|
form?: Form;
|
|
624
624
|
}
|
|
625
|
-
|
|
625
|
+
interface EventUpdated {
|
|
626
626
|
/** Event update timestamp in ISO UTC format. */
|
|
627
627
|
timestamp?: Date | null;
|
|
628
628
|
/**
|
|
@@ -644,7 +644,7 @@ export interface EventUpdated {
|
|
|
644
644
|
/** Updated event */
|
|
645
645
|
event?: Event;
|
|
646
646
|
}
|
|
647
|
-
|
|
647
|
+
interface Location {
|
|
648
648
|
/**
|
|
649
649
|
* Location name.
|
|
650
650
|
* @maxLength 50
|
|
@@ -676,7 +676,7 @@ export interface Location {
|
|
|
676
676
|
*/
|
|
677
677
|
tbd?: boolean | null;
|
|
678
678
|
}
|
|
679
|
-
|
|
679
|
+
interface MapCoordinates {
|
|
680
680
|
/**
|
|
681
681
|
* Latitude.
|
|
682
682
|
* @min -90
|
|
@@ -690,12 +690,12 @@ export interface MapCoordinates {
|
|
|
690
690
|
*/
|
|
691
691
|
lng?: number;
|
|
692
692
|
}
|
|
693
|
-
|
|
693
|
+
declare enum LocationType {
|
|
694
694
|
VENUE = "VENUE",
|
|
695
695
|
ONLINE = "ONLINE"
|
|
696
696
|
}
|
|
697
697
|
/** Physical address */
|
|
698
|
-
|
|
698
|
+
interface Address extends AddressStreetOneOf {
|
|
699
699
|
/** a break down of the street to number and street name */
|
|
700
700
|
streetAddress?: StreetAddress;
|
|
701
701
|
/** Main address line (usually street and number) as free text */
|
|
@@ -726,19 +726,19 @@ export interface Address extends AddressStreetOneOf {
|
|
|
726
726
|
subdivisions?: Subdivision[];
|
|
727
727
|
}
|
|
728
728
|
/** @oneof */
|
|
729
|
-
|
|
729
|
+
interface AddressStreetOneOf {
|
|
730
730
|
/** a break down of the street to number and street name */
|
|
731
731
|
streetAddress?: StreetAddress;
|
|
732
732
|
/** Main address line (usually street and number) as free text */
|
|
733
733
|
addressLine?: string | null;
|
|
734
734
|
}
|
|
735
|
-
|
|
735
|
+
interface StreetAddress {
|
|
736
736
|
/** street number */
|
|
737
737
|
number?: string;
|
|
738
738
|
/** street name */
|
|
739
739
|
name?: string;
|
|
740
740
|
}
|
|
741
|
-
|
|
741
|
+
interface AddressLocation {
|
|
742
742
|
/**
|
|
743
743
|
* address latitude coordinates
|
|
744
744
|
* @min -90
|
|
@@ -752,13 +752,13 @@ export interface AddressLocation {
|
|
|
752
752
|
*/
|
|
753
753
|
longitude?: number | null;
|
|
754
754
|
}
|
|
755
|
-
|
|
755
|
+
interface Subdivision {
|
|
756
756
|
/** subdivision short code */
|
|
757
757
|
code?: string;
|
|
758
758
|
/** subdivision full-name */
|
|
759
759
|
name?: string;
|
|
760
760
|
}
|
|
761
|
-
|
|
761
|
+
declare enum SubdivisionType {
|
|
762
762
|
UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
|
|
763
763
|
/** State */
|
|
764
764
|
ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
|
|
@@ -773,7 +773,7 @@ export declare enum SubdivisionType {
|
|
|
773
773
|
/** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
|
|
774
774
|
COUNTRY = "COUNTRY"
|
|
775
775
|
}
|
|
776
|
-
|
|
776
|
+
interface ScheduleConfig {
|
|
777
777
|
/**
|
|
778
778
|
* Defines event as TBD (To Be Determined) schedule.
|
|
779
779
|
* When event time is not yet defined, TBD message is displayed instead of event start and end times.
|
|
@@ -801,7 +801,7 @@ export interface ScheduleConfig {
|
|
|
801
801
|
/** Event recurrences. */
|
|
802
802
|
recurrences?: Recurrences;
|
|
803
803
|
}
|
|
804
|
-
|
|
804
|
+
interface Recurrences {
|
|
805
805
|
/**
|
|
806
806
|
* Event occurrences.
|
|
807
807
|
* @maxSize 1000
|
|
@@ -818,7 +818,7 @@ export interface Recurrences {
|
|
|
818
818
|
*/
|
|
819
819
|
status?: Status;
|
|
820
820
|
}
|
|
821
|
-
|
|
821
|
+
interface Occurrence {
|
|
822
822
|
/** Event start timestamp. */
|
|
823
823
|
startDate?: Date | null;
|
|
824
824
|
/** Event end timestamp. */
|
|
@@ -831,7 +831,7 @@ export interface Occurrence {
|
|
|
831
831
|
/** Whether time zone is displayed in formatted schedule. */
|
|
832
832
|
showTimeZone?: boolean;
|
|
833
833
|
}
|
|
834
|
-
|
|
834
|
+
declare enum Status {
|
|
835
835
|
/** Event occurs only once. */
|
|
836
836
|
ONE_TIME = "ONE_TIME",
|
|
837
837
|
/** Event is recurring. */
|
|
@@ -843,7 +843,7 @@ export declare enum Status {
|
|
|
843
843
|
/** Marks the most recent canceled occurrence of the recurring event. */
|
|
844
844
|
RECURRING_LAST_CANCELED = "RECURRING_LAST_CANCELED"
|
|
845
845
|
}
|
|
846
|
-
|
|
846
|
+
interface Event {
|
|
847
847
|
/**
|
|
848
848
|
* Event ID.
|
|
849
849
|
* @format GUID
|
|
@@ -913,7 +913,7 @@ export interface Event {
|
|
|
913
913
|
*/
|
|
914
914
|
publishedDate?: Date | null;
|
|
915
915
|
}
|
|
916
|
-
|
|
916
|
+
interface Scheduling {
|
|
917
917
|
/** Schedule configuration. */
|
|
918
918
|
config?: ScheduleConfig;
|
|
919
919
|
/** Formatted schedule representation. */
|
|
@@ -927,7 +927,7 @@ export interface Scheduling {
|
|
|
927
927
|
/** Formatted end time of the event (empty for TBD schedules or when end date is hidden). */
|
|
928
928
|
endTimeFormatted?: string;
|
|
929
929
|
}
|
|
930
|
-
|
|
930
|
+
declare enum EventStatus {
|
|
931
931
|
/** Event is public and scheduled to start */
|
|
932
932
|
SCHEDULED = "SCHEDULED",
|
|
933
933
|
/** Event has started */
|
|
@@ -937,7 +937,7 @@ export declare enum EventStatus {
|
|
|
937
937
|
/** Event was canceled */
|
|
938
938
|
CANCELED = "CANCELED"
|
|
939
939
|
}
|
|
940
|
-
|
|
940
|
+
interface Registration {
|
|
941
941
|
/** Event type. */
|
|
942
942
|
type?: EventType;
|
|
943
943
|
/** Event registration status. */
|
|
@@ -953,7 +953,7 @@ export interface Registration {
|
|
|
953
953
|
/** Initial event type which was set when creating an event. */
|
|
954
954
|
initialType?: EventType;
|
|
955
955
|
}
|
|
956
|
-
|
|
956
|
+
declare enum EventType {
|
|
957
957
|
/** Type not available for this request fieldset */
|
|
958
958
|
NA_EVENT_TYPE = "NA_EVENT_TYPE",
|
|
959
959
|
/** Registration via RSVP */
|
|
@@ -965,7 +965,7 @@ export declare enum EventType {
|
|
|
965
965
|
/** Registration not available */
|
|
966
966
|
NO_REGISTRATION = "NO_REGISTRATION"
|
|
967
967
|
}
|
|
968
|
-
|
|
968
|
+
declare enum RegistrationStatus {
|
|
969
969
|
/** Registration status is not applicable */
|
|
970
970
|
NA_REGISTRATION_STATUS = "NA_REGISTRATION_STATUS",
|
|
971
971
|
/** Registration to event is closed */
|
|
@@ -983,11 +983,11 @@ export declare enum RegistrationStatus {
|
|
|
983
983
|
/** Registration will be open via RSVP */
|
|
984
984
|
SCHEDULED_RSVP = "SCHEDULED_RSVP"
|
|
985
985
|
}
|
|
986
|
-
|
|
986
|
+
interface RsvpCollection {
|
|
987
987
|
/** RSVP collection configuration. */
|
|
988
988
|
config?: RsvpCollectionConfig;
|
|
989
989
|
}
|
|
990
|
-
|
|
990
|
+
interface RsvpCollectionConfig {
|
|
991
991
|
/** Defines the supported RSVP statuses. */
|
|
992
992
|
rsvpStatusOptions?: RsvpStatusOptions;
|
|
993
993
|
/**
|
|
@@ -1002,13 +1002,13 @@ export interface RsvpCollectionConfig {
|
|
|
1002
1002
|
/** Registration end timestamp. */
|
|
1003
1003
|
endDate?: Date | null;
|
|
1004
1004
|
}
|
|
1005
|
-
|
|
1005
|
+
declare enum RsvpStatusOptions {
|
|
1006
1006
|
/** Only YES RSVP status is available for RSVP registration */
|
|
1007
1007
|
YES_ONLY = "YES_ONLY",
|
|
1008
1008
|
/** YES and NO RSVP status options are available for the registration */
|
|
1009
1009
|
YES_AND_NO = "YES_AND_NO"
|
|
1010
1010
|
}
|
|
1011
|
-
|
|
1011
|
+
interface Ticketing {
|
|
1012
1012
|
/**
|
|
1013
1013
|
* Deprecated.
|
|
1014
1014
|
* @deprecated
|
|
@@ -1049,7 +1049,7 @@ export interface Ticketing {
|
|
|
1049
1049
|
*/
|
|
1050
1050
|
soldOut?: boolean | null;
|
|
1051
1051
|
}
|
|
1052
|
-
|
|
1052
|
+
interface TicketingConfig {
|
|
1053
1053
|
/** Whether the form must be filled out separately for each ticket. */
|
|
1054
1054
|
guestAssignedTickets?: boolean;
|
|
1055
1055
|
/** Tax configuration. */
|
|
@@ -1066,7 +1066,7 @@ export interface TicketingConfig {
|
|
|
1066
1066
|
*/
|
|
1067
1067
|
reservationDurationInMinutes?: number | null;
|
|
1068
1068
|
}
|
|
1069
|
-
|
|
1069
|
+
interface TaxConfig {
|
|
1070
1070
|
/** Tax application settings. */
|
|
1071
1071
|
type?: TaxType;
|
|
1072
1072
|
/**
|
|
@@ -1083,7 +1083,7 @@ export interface TaxConfig {
|
|
|
1083
1083
|
/** Applies taxes for donations, default true. */
|
|
1084
1084
|
appliesToDonations?: boolean | null;
|
|
1085
1085
|
}
|
|
1086
|
-
|
|
1086
|
+
declare enum TaxType {
|
|
1087
1087
|
/** Tax is included in the ticket price. */
|
|
1088
1088
|
INCLUDED = "INCLUDED",
|
|
1089
1089
|
/** Tax is added to the order at the checkout. */
|
|
@@ -1091,7 +1091,7 @@ export declare enum TaxType {
|
|
|
1091
1091
|
/** Tax is added to the final total at the checkout. */
|
|
1092
1092
|
ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
|
|
1093
1093
|
}
|
|
1094
|
-
|
|
1094
|
+
interface Money {
|
|
1095
1095
|
/**
|
|
1096
1096
|
* *Deprecated:** Use `value` instead.
|
|
1097
1097
|
* @format DECIMAL_VALUE
|
|
@@ -1109,11 +1109,11 @@ export interface Money {
|
|
|
1109
1109
|
*/
|
|
1110
1110
|
value?: string | null;
|
|
1111
1111
|
}
|
|
1112
|
-
|
|
1112
|
+
interface ExternalEvent {
|
|
1113
1113
|
/** External event registration URL. */
|
|
1114
1114
|
registration?: string;
|
|
1115
1115
|
}
|
|
1116
|
-
|
|
1116
|
+
declare enum VisitorType {
|
|
1117
1117
|
/** Site visitor (including member) */
|
|
1118
1118
|
VISITOR = "VISITOR",
|
|
1119
1119
|
/** Site member */
|
|
@@ -1121,14 +1121,14 @@ export declare enum VisitorType {
|
|
|
1121
1121
|
/** Site visitor or member */
|
|
1122
1122
|
VISITOR_OR_MEMBER = "VISITOR_OR_MEMBER"
|
|
1123
1123
|
}
|
|
1124
|
-
|
|
1124
|
+
interface CalendarLinks {
|
|
1125
1125
|
/** "Add to Google calendar" URL. */
|
|
1126
1126
|
google?: string;
|
|
1127
1127
|
/** "Download ICS calendar file" URL. */
|
|
1128
1128
|
ics?: string;
|
|
1129
1129
|
}
|
|
1130
1130
|
/** Site URL components */
|
|
1131
|
-
|
|
1131
|
+
interface SiteUrl {
|
|
1132
1132
|
/**
|
|
1133
1133
|
* Base URL. For premium sites, this will be the domain.
|
|
1134
1134
|
* For free sites, this would be site URL (e.g `mysite.wixsite.com/mysite`)
|
|
@@ -1137,7 +1137,7 @@ export interface SiteUrl {
|
|
|
1137
1137
|
/** The path to that page - e.g `/my-events/weekly-meetup-2` */
|
|
1138
1138
|
path?: string;
|
|
1139
1139
|
}
|
|
1140
|
-
|
|
1140
|
+
interface Dashboard {
|
|
1141
1141
|
/** Guest RSVP summary. */
|
|
1142
1142
|
rsvpSummary?: RsvpSummary;
|
|
1143
1143
|
/**
|
|
@@ -1146,7 +1146,7 @@ export interface Dashboard {
|
|
|
1146
1146
|
*/
|
|
1147
1147
|
ticketingSummary?: TicketingSummary;
|
|
1148
1148
|
}
|
|
1149
|
-
|
|
1149
|
+
interface RsvpSummary {
|
|
1150
1150
|
/** Total number of RSVPs. */
|
|
1151
1151
|
total?: number;
|
|
1152
1152
|
/** Number of RSVPs with status `YES`. */
|
|
@@ -1156,7 +1156,7 @@ export interface RsvpSummary {
|
|
|
1156
1156
|
/** Number of RSVPs in waitlist. */
|
|
1157
1157
|
waitlist?: number;
|
|
1158
1158
|
}
|
|
1159
|
-
|
|
1159
|
+
interface TicketingSummary {
|
|
1160
1160
|
/** Number of tickets sold. */
|
|
1161
1161
|
tickets?: number;
|
|
1162
1162
|
/**
|
|
@@ -1171,19 +1171,19 @@ export interface TicketingSummary {
|
|
|
1171
1171
|
/** Total balance of confirmed transactions. */
|
|
1172
1172
|
totalSales?: Money;
|
|
1173
1173
|
}
|
|
1174
|
-
|
|
1174
|
+
interface GuestListConfig {
|
|
1175
1175
|
/** Whether members can see other members attending the event (defaults to true). */
|
|
1176
1176
|
publicGuestList?: boolean;
|
|
1177
1177
|
}
|
|
1178
|
-
|
|
1178
|
+
interface Feed {
|
|
1179
1179
|
/** Event discussion feed token. */
|
|
1180
1180
|
token?: string;
|
|
1181
1181
|
}
|
|
1182
|
-
|
|
1182
|
+
interface OnlineConferencing {
|
|
1183
1183
|
config?: OnlineConferencingConfig;
|
|
1184
1184
|
session?: OnlineConferencingSession;
|
|
1185
1185
|
}
|
|
1186
|
-
|
|
1186
|
+
interface OnlineConferencingConfig {
|
|
1187
1187
|
/**
|
|
1188
1188
|
* Whether online conferencing is enabled (not supported for TBD schedules).
|
|
1189
1189
|
* When enabled, links to join conferencing are generated and provided to guests.
|
|
@@ -1197,13 +1197,13 @@ export interface OnlineConferencingConfig {
|
|
|
1197
1197
|
/** Conference type */
|
|
1198
1198
|
conferenceType?: ConferenceType;
|
|
1199
1199
|
}
|
|
1200
|
-
|
|
1200
|
+
declare enum ConferenceType {
|
|
1201
1201
|
/** Everyone in the meeting can publish and subscribe video and audio. */
|
|
1202
1202
|
MEETING = "MEETING",
|
|
1203
1203
|
/** Guests can only subscribe to video and audio. */
|
|
1204
1204
|
WEBINAR = "WEBINAR"
|
|
1205
1205
|
}
|
|
1206
|
-
|
|
1206
|
+
interface OnlineConferencingSession {
|
|
1207
1207
|
/**
|
|
1208
1208
|
* Link for event host to start the online conference session.
|
|
1209
1209
|
* @readonly
|
|
@@ -1230,7 +1230,7 @@ export interface OnlineConferencingSession {
|
|
|
1230
1230
|
*/
|
|
1231
1231
|
sessionId?: string | null;
|
|
1232
1232
|
}
|
|
1233
|
-
|
|
1233
|
+
interface SeoSettings {
|
|
1234
1234
|
/**
|
|
1235
1235
|
* URL slug
|
|
1236
1236
|
* @maxLength 130
|
|
@@ -1249,13 +1249,13 @@ export interface SeoSettings {
|
|
|
1249
1249
|
* The search engines use this information for ranking purposes, or to display snippets in the search results.
|
|
1250
1250
|
* 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.
|
|
1251
1251
|
*/
|
|
1252
|
-
|
|
1252
|
+
interface SeoSchema {
|
|
1253
1253
|
/** SEO tag information. */
|
|
1254
1254
|
tags?: Tag[];
|
|
1255
1255
|
/** SEO general settings. */
|
|
1256
1256
|
settings?: Settings;
|
|
1257
1257
|
}
|
|
1258
|
-
|
|
1258
|
+
interface Keyword {
|
|
1259
1259
|
/** Keyword value. */
|
|
1260
1260
|
term?: string;
|
|
1261
1261
|
/** Whether the keyword is the main focus keyword. */
|
|
@@ -1266,7 +1266,7 @@ export interface Keyword {
|
|
|
1266
1266
|
*/
|
|
1267
1267
|
origin?: string | null;
|
|
1268
1268
|
}
|
|
1269
|
-
|
|
1269
|
+
interface Tag {
|
|
1270
1270
|
/**
|
|
1271
1271
|
* SEO tag type.
|
|
1272
1272
|
*
|
|
@@ -1288,7 +1288,7 @@ export interface Tag {
|
|
|
1288
1288
|
/** Whether the tag is disabled. */
|
|
1289
1289
|
disabled?: boolean;
|
|
1290
1290
|
}
|
|
1291
|
-
|
|
1291
|
+
interface Settings {
|
|
1292
1292
|
/**
|
|
1293
1293
|
* Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.
|
|
1294
1294
|
*
|
|
@@ -1302,7 +1302,7 @@ export interface Settings {
|
|
|
1302
1302
|
*/
|
|
1303
1303
|
keywords?: Keyword[];
|
|
1304
1304
|
}
|
|
1305
|
-
|
|
1305
|
+
interface Agenda {
|
|
1306
1306
|
/** Whether the schedule is enabled for the event. */
|
|
1307
1307
|
enabled?: boolean;
|
|
1308
1308
|
/**
|
|
@@ -1311,7 +1311,7 @@ export interface Agenda {
|
|
|
1311
1311
|
*/
|
|
1312
1312
|
pageUrl?: SiteUrl;
|
|
1313
1313
|
}
|
|
1314
|
-
|
|
1314
|
+
interface Category {
|
|
1315
1315
|
/**
|
|
1316
1316
|
* Category ID.
|
|
1317
1317
|
* @format GUID
|
|
@@ -1349,13 +1349,13 @@ export interface Category {
|
|
|
1349
1349
|
*/
|
|
1350
1350
|
states?: State[];
|
|
1351
1351
|
}
|
|
1352
|
-
|
|
1352
|
+
interface CategoryCounts {
|
|
1353
1353
|
/** Total number of draft events assigned to the category. */
|
|
1354
1354
|
assignedEventsCount?: number | null;
|
|
1355
1355
|
/** Total number of published events assigned to the category. Deleted events are excluded. */
|
|
1356
1356
|
assignedDraftEventsCount?: number | null;
|
|
1357
1357
|
}
|
|
1358
|
-
|
|
1358
|
+
declare enum State {
|
|
1359
1359
|
/** Created manually by the user. */
|
|
1360
1360
|
MANUAL = "MANUAL",
|
|
1361
1361
|
/** Created automatically. */
|
|
@@ -1365,15 +1365,15 @@ export declare enum State {
|
|
|
1365
1365
|
/** Category is hidden. */
|
|
1366
1366
|
HIDDEN = "HIDDEN"
|
|
1367
1367
|
}
|
|
1368
|
-
|
|
1368
|
+
interface EventDisplaySettings {
|
|
1369
1369
|
/** Whether event details button is hidden. Only available for events with no registration. */
|
|
1370
1370
|
hideEventDetailsButton?: boolean | null;
|
|
1371
1371
|
/** Disables event details page visibility. If event has an external registration configured visitors will be redirected from this page. */
|
|
1372
1372
|
hideEventDetailsPage?: boolean | null;
|
|
1373
1373
|
}
|
|
1374
|
-
|
|
1374
|
+
interface LabellingSettings {
|
|
1375
1375
|
}
|
|
1376
|
-
|
|
1376
|
+
interface RichContent {
|
|
1377
1377
|
/** Node objects representing a rich content document. */
|
|
1378
1378
|
nodes?: Node[];
|
|
1379
1379
|
/** Object metadata. */
|
|
@@ -1381,7 +1381,7 @@ export interface RichContent {
|
|
|
1381
1381
|
/** Global styling for header, paragraph, block quote, and code block nodes in the object. */
|
|
1382
1382
|
documentStyle?: DocumentStyle;
|
|
1383
1383
|
}
|
|
1384
|
-
|
|
1384
|
+
interface Node extends NodeDataOneOf {
|
|
1385
1385
|
/** Data for a button node. */
|
|
1386
1386
|
buttonData?: ButtonData;
|
|
1387
1387
|
/** Data for a code block node. */
|
|
@@ -1446,7 +1446,7 @@ export interface Node extends NodeDataOneOf {
|
|
|
1446
1446
|
style?: NodeStyle;
|
|
1447
1447
|
}
|
|
1448
1448
|
/** @oneof */
|
|
1449
|
-
|
|
1449
|
+
interface NodeDataOneOf {
|
|
1450
1450
|
/** Data for a button node. */
|
|
1451
1451
|
buttonData?: ButtonData;
|
|
1452
1452
|
/** Data for a code block node. */
|
|
@@ -1502,7 +1502,7 @@ export interface NodeDataOneOf {
|
|
|
1502
1502
|
/** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
|
|
1503
1503
|
layoutCellData?: LayoutCellData;
|
|
1504
1504
|
}
|
|
1505
|
-
|
|
1505
|
+
declare enum NodeType {
|
|
1506
1506
|
PARAGRAPH = "PARAGRAPH",
|
|
1507
1507
|
TEXT = "TEXT",
|
|
1508
1508
|
HEADING = "HEADING",
|
|
@@ -1538,7 +1538,7 @@ export declare enum NodeType {
|
|
|
1538
1538
|
LAYOUT = "LAYOUT",
|
|
1539
1539
|
LAYOUT_CELL = "LAYOUT_CELL"
|
|
1540
1540
|
}
|
|
1541
|
-
|
|
1541
|
+
interface NodeStyle {
|
|
1542
1542
|
/** The top padding value in pixels. */
|
|
1543
1543
|
paddingTop?: string | null;
|
|
1544
1544
|
/** The bottom padding value in pixels. */
|
|
@@ -1546,7 +1546,7 @@ export interface NodeStyle {
|
|
|
1546
1546
|
/** The background color as a hexadecimal value. */
|
|
1547
1547
|
backgroundColor?: string | null;
|
|
1548
1548
|
}
|
|
1549
|
-
|
|
1549
|
+
interface ButtonData {
|
|
1550
1550
|
/** Styling for the button's container. */
|
|
1551
1551
|
containerData?: PluginContainerData;
|
|
1552
1552
|
/** The button type. */
|
|
@@ -1558,7 +1558,7 @@ export interface ButtonData {
|
|
|
1558
1558
|
/** Button link details. */
|
|
1559
1559
|
link?: Link;
|
|
1560
1560
|
}
|
|
1561
|
-
|
|
1561
|
+
interface Border {
|
|
1562
1562
|
/**
|
|
1563
1563
|
* Deprecated: Use `borderWidth` in `styles` instead.
|
|
1564
1564
|
* @deprecated
|
|
@@ -1570,7 +1570,7 @@ export interface Border {
|
|
|
1570
1570
|
*/
|
|
1571
1571
|
radius?: number | null;
|
|
1572
1572
|
}
|
|
1573
|
-
|
|
1573
|
+
interface Colors {
|
|
1574
1574
|
/**
|
|
1575
1575
|
* Deprecated: Use `textColor` in `styles` instead.
|
|
1576
1576
|
* @deprecated
|
|
@@ -1587,7 +1587,7 @@ export interface Colors {
|
|
|
1587
1587
|
*/
|
|
1588
1588
|
background?: string | null;
|
|
1589
1589
|
}
|
|
1590
|
-
|
|
1590
|
+
interface PluginContainerData {
|
|
1591
1591
|
/** The width of the node when it's displayed. */
|
|
1592
1592
|
width?: PluginContainerDataWidth;
|
|
1593
1593
|
/** The node's alignment within its container. */
|
|
@@ -1599,7 +1599,7 @@ export interface PluginContainerData {
|
|
|
1599
1599
|
/** 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`. */
|
|
1600
1600
|
textWrap?: boolean | null;
|
|
1601
1601
|
}
|
|
1602
|
-
|
|
1602
|
+
declare enum WidthType {
|
|
1603
1603
|
/** Width matches the content width */
|
|
1604
1604
|
CONTENT = "CONTENT",
|
|
1605
1605
|
/** Small Width */
|
|
@@ -1609,7 +1609,7 @@ export declare enum WidthType {
|
|
|
1609
1609
|
/** coast-to-coast display */
|
|
1610
1610
|
FULL_WIDTH = "FULL_WIDTH"
|
|
1611
1611
|
}
|
|
1612
|
-
|
|
1612
|
+
interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
1613
1613
|
/**
|
|
1614
1614
|
* One of the following predefined width options:
|
|
1615
1615
|
* `CONTENT`: The width of the container matches the content width.
|
|
@@ -1622,7 +1622,7 @@ export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOn
|
|
|
1622
1622
|
custom?: string | null;
|
|
1623
1623
|
}
|
|
1624
1624
|
/** @oneof */
|
|
1625
|
-
|
|
1625
|
+
interface PluginContainerDataWidthDataOneOf {
|
|
1626
1626
|
/**
|
|
1627
1627
|
* One of the following predefined width options:
|
|
1628
1628
|
* `CONTENT`: The width of the container matches the content width.
|
|
@@ -1634,7 +1634,7 @@ export interface PluginContainerDataWidthDataOneOf {
|
|
|
1634
1634
|
/** A custom width value in pixels. */
|
|
1635
1635
|
custom?: string | null;
|
|
1636
1636
|
}
|
|
1637
|
-
|
|
1637
|
+
declare enum PluginContainerDataAlignment {
|
|
1638
1638
|
/** Center Alignment */
|
|
1639
1639
|
CENTER = "CENTER",
|
|
1640
1640
|
/** Left Alignment */
|
|
@@ -1642,7 +1642,7 @@ export declare enum PluginContainerDataAlignment {
|
|
|
1642
1642
|
/** Right Alignment */
|
|
1643
1643
|
RIGHT = "RIGHT"
|
|
1644
1644
|
}
|
|
1645
|
-
|
|
1645
|
+
interface Spoiler {
|
|
1646
1646
|
/** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
|
|
1647
1647
|
enabled?: boolean | null;
|
|
1648
1648
|
/** The description displayed on top of the spoiler cover. */
|
|
@@ -1650,17 +1650,17 @@ export interface Spoiler {
|
|
|
1650
1650
|
/** The text for the button used to remove the spoiler cover. */
|
|
1651
1651
|
buttonText?: string | null;
|
|
1652
1652
|
}
|
|
1653
|
-
|
|
1653
|
+
interface Height {
|
|
1654
1654
|
/** A custom height value in pixels. */
|
|
1655
1655
|
custom?: string | null;
|
|
1656
1656
|
}
|
|
1657
|
-
|
|
1657
|
+
declare enum ButtonDataType {
|
|
1658
1658
|
/** Regular link button */
|
|
1659
1659
|
LINK = "LINK",
|
|
1660
1660
|
/** Triggers custom action that is defined in plugin configuration by the consumer */
|
|
1661
1661
|
ACTION = "ACTION"
|
|
1662
1662
|
}
|
|
1663
|
-
|
|
1663
|
+
interface Styles {
|
|
1664
1664
|
/**
|
|
1665
1665
|
* Deprecated: Use `borderWidth` and `borderRadius` instead.
|
|
1666
1666
|
* @deprecated
|
|
@@ -1713,7 +1713,7 @@ export interface Styles {
|
|
|
1713
1713
|
/** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
|
|
1714
1714
|
buttonSize?: string | null;
|
|
1715
1715
|
}
|
|
1716
|
-
|
|
1716
|
+
interface Link extends LinkDataOneOf {
|
|
1717
1717
|
/** The absolute URL for the linked document. */
|
|
1718
1718
|
url?: string;
|
|
1719
1719
|
/** The target node's ID. Used for linking to another node in this object. */
|
|
@@ -1732,13 +1732,13 @@ export interface Link extends LinkDataOneOf {
|
|
|
1732
1732
|
customData?: string | null;
|
|
1733
1733
|
}
|
|
1734
1734
|
/** @oneof */
|
|
1735
|
-
|
|
1735
|
+
interface LinkDataOneOf {
|
|
1736
1736
|
/** The absolute URL for the linked document. */
|
|
1737
1737
|
url?: string;
|
|
1738
1738
|
/** The target node's ID. Used for linking to another node in this object. */
|
|
1739
1739
|
anchor?: string;
|
|
1740
1740
|
}
|
|
1741
|
-
|
|
1741
|
+
declare enum Target {
|
|
1742
1742
|
/** Opens the linked document in the same frame as it was clicked (this is default) */
|
|
1743
1743
|
SELF = "SELF",
|
|
1744
1744
|
/** Opens the linked document in a new window or tab */
|
|
@@ -1748,7 +1748,7 @@ export declare enum Target {
|
|
|
1748
1748
|
/** Opens the linked document in the full body of the window */
|
|
1749
1749
|
TOP = "TOP"
|
|
1750
1750
|
}
|
|
1751
|
-
|
|
1751
|
+
interface Rel {
|
|
1752
1752
|
/** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
|
|
1753
1753
|
nofollow?: boolean | null;
|
|
1754
1754
|
/** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
|
|
@@ -1758,17 +1758,17 @@ export interface Rel {
|
|
|
1758
1758
|
/** Indicates that this link protect referral information from being passed to the target website. */
|
|
1759
1759
|
noreferrer?: boolean | null;
|
|
1760
1760
|
}
|
|
1761
|
-
|
|
1761
|
+
interface CodeBlockData {
|
|
1762
1762
|
/** Styling for the code block's text. */
|
|
1763
1763
|
textStyle?: TextStyle;
|
|
1764
1764
|
}
|
|
1765
|
-
|
|
1765
|
+
interface TextStyle {
|
|
1766
1766
|
/** Text alignment. Defaults to `AUTO`. */
|
|
1767
1767
|
textAlignment?: TextAlignment;
|
|
1768
1768
|
/** 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. */
|
|
1769
1769
|
lineHeight?: string | null;
|
|
1770
1770
|
}
|
|
1771
|
-
|
|
1771
|
+
declare enum TextAlignment {
|
|
1772
1772
|
/** browser default, eqivalent to `initial` */
|
|
1773
1773
|
AUTO = "AUTO",
|
|
1774
1774
|
/** Left align */
|
|
@@ -1780,7 +1780,7 @@ export declare enum TextAlignment {
|
|
|
1780
1780
|
/** Text is spaced to line up its left and right edges to the left and right edges of the line box, except for the last line */
|
|
1781
1781
|
JUSTIFY = "JUSTIFY"
|
|
1782
1782
|
}
|
|
1783
|
-
|
|
1783
|
+
interface DividerData {
|
|
1784
1784
|
/** Styling for the divider's container. */
|
|
1785
1785
|
containerData?: PluginContainerData;
|
|
1786
1786
|
/** Divider line style. */
|
|
@@ -1790,7 +1790,7 @@ export interface DividerData {
|
|
|
1790
1790
|
/** Divider alignment. */
|
|
1791
1791
|
alignment?: Alignment;
|
|
1792
1792
|
}
|
|
1793
|
-
|
|
1793
|
+
declare enum LineStyle {
|
|
1794
1794
|
/** Single Line */
|
|
1795
1795
|
SINGLE = "SINGLE",
|
|
1796
1796
|
/** Double Line */
|
|
@@ -1800,7 +1800,7 @@ export declare enum LineStyle {
|
|
|
1800
1800
|
/** Dotted Line */
|
|
1801
1801
|
DOTTED = "DOTTED"
|
|
1802
1802
|
}
|
|
1803
|
-
|
|
1803
|
+
declare enum Width {
|
|
1804
1804
|
/** Large line */
|
|
1805
1805
|
LARGE = "LARGE",
|
|
1806
1806
|
/** Medium line */
|
|
@@ -1808,7 +1808,7 @@ export declare enum Width {
|
|
|
1808
1808
|
/** Small line */
|
|
1809
1809
|
SMALL = "SMALL"
|
|
1810
1810
|
}
|
|
1811
|
-
|
|
1811
|
+
declare enum Alignment {
|
|
1812
1812
|
/** Center alignment */
|
|
1813
1813
|
CENTER = "CENTER",
|
|
1814
1814
|
/** Left alignment */
|
|
@@ -1816,7 +1816,7 @@ export declare enum Alignment {
|
|
|
1816
1816
|
/** Right alignment */
|
|
1817
1817
|
RIGHT = "RIGHT"
|
|
1818
1818
|
}
|
|
1819
|
-
|
|
1819
|
+
interface FileData {
|
|
1820
1820
|
/** Styling for the file's container. */
|
|
1821
1821
|
containerData?: PluginContainerData;
|
|
1822
1822
|
/** The source for the file's data. */
|
|
@@ -1839,7 +1839,7 @@ export interface FileData {
|
|
|
1839
1839
|
/** File size in KB. */
|
|
1840
1840
|
sizeInKb?: string | null;
|
|
1841
1841
|
}
|
|
1842
|
-
|
|
1842
|
+
declare enum ViewMode {
|
|
1843
1843
|
/** No PDF view */
|
|
1844
1844
|
NONE = "NONE",
|
|
1845
1845
|
/** Full PDF view */
|
|
@@ -1847,7 +1847,7 @@ export declare enum ViewMode {
|
|
|
1847
1847
|
/** Mini PDF view */
|
|
1848
1848
|
MINI = "MINI"
|
|
1849
1849
|
}
|
|
1850
|
-
|
|
1850
|
+
interface FileSource extends FileSourceDataOneOf {
|
|
1851
1851
|
/** The absolute URL for the file's source. */
|
|
1852
1852
|
url?: string | null;
|
|
1853
1853
|
/**
|
|
@@ -1861,7 +1861,7 @@ export interface FileSource extends FileSourceDataOneOf {
|
|
|
1861
1861
|
private?: boolean | null;
|
|
1862
1862
|
}
|
|
1863
1863
|
/** @oneof */
|
|
1864
|
-
|
|
1864
|
+
interface FileSourceDataOneOf {
|
|
1865
1865
|
/** The absolute URL for the file's source. */
|
|
1866
1866
|
url?: string | null;
|
|
1867
1867
|
/**
|
|
@@ -1872,7 +1872,7 @@ export interface FileSourceDataOneOf {
|
|
|
1872
1872
|
/** An ID that's resolved to a URL by a resolver function. */
|
|
1873
1873
|
_id?: string | null;
|
|
1874
1874
|
}
|
|
1875
|
-
|
|
1875
|
+
interface PDFSettings {
|
|
1876
1876
|
/**
|
|
1877
1877
|
* PDF view mode. One of the following:
|
|
1878
1878
|
* `NONE` : The PDF isn't displayed.
|
|
@@ -1885,7 +1885,7 @@ export interface PDFSettings {
|
|
|
1885
1885
|
/** Sets whether the PDF print button is disabled. Defaults to `false`. */
|
|
1886
1886
|
disablePrint?: boolean | null;
|
|
1887
1887
|
}
|
|
1888
|
-
|
|
1888
|
+
interface GalleryData {
|
|
1889
1889
|
/** Styling for the gallery's container. */
|
|
1890
1890
|
containerData?: PluginContainerData;
|
|
1891
1891
|
/** The items in the gallery. */
|
|
@@ -1897,7 +1897,7 @@ export interface GalleryData {
|
|
|
1897
1897
|
/** Sets whether the gallery's download button is disabled. Defaults to `false`. */
|
|
1898
1898
|
disableDownload?: boolean | null;
|
|
1899
1899
|
}
|
|
1900
|
-
|
|
1900
|
+
interface Media {
|
|
1901
1901
|
/** The source for the media's data. */
|
|
1902
1902
|
src?: FileSource;
|
|
1903
1903
|
/** Media width in pixels. */
|
|
@@ -1907,19 +1907,19 @@ export interface Media {
|
|
|
1907
1907
|
/** Media duration in seconds. Only relevant for audio and video files. */
|
|
1908
1908
|
duration?: number | null;
|
|
1909
1909
|
}
|
|
1910
|
-
|
|
1910
|
+
interface Image {
|
|
1911
1911
|
/** Image file details. */
|
|
1912
1912
|
media?: Media;
|
|
1913
1913
|
/** Link details for images that are links. */
|
|
1914
1914
|
link?: Link;
|
|
1915
1915
|
}
|
|
1916
|
-
|
|
1916
|
+
interface Video {
|
|
1917
1917
|
/** Video file details. */
|
|
1918
1918
|
media?: Media;
|
|
1919
1919
|
/** Video thumbnail file details. */
|
|
1920
1920
|
thumbnail?: Media;
|
|
1921
1921
|
}
|
|
1922
|
-
|
|
1922
|
+
interface Item extends ItemDataOneOf {
|
|
1923
1923
|
/** An image item. */
|
|
1924
1924
|
image?: Image;
|
|
1925
1925
|
/** A video item. */
|
|
@@ -1930,13 +1930,13 @@ export interface Item extends ItemDataOneOf {
|
|
|
1930
1930
|
altText?: string | null;
|
|
1931
1931
|
}
|
|
1932
1932
|
/** @oneof */
|
|
1933
|
-
|
|
1933
|
+
interface ItemDataOneOf {
|
|
1934
1934
|
/** An image item. */
|
|
1935
1935
|
image?: Image;
|
|
1936
1936
|
/** A video item. */
|
|
1937
1937
|
video?: Video;
|
|
1938
1938
|
}
|
|
1939
|
-
|
|
1939
|
+
interface GalleryOptions {
|
|
1940
1940
|
/** Gallery layout. */
|
|
1941
1941
|
layout?: Layout;
|
|
1942
1942
|
/** Styling for gallery items. */
|
|
@@ -1944,7 +1944,7 @@ export interface GalleryOptions {
|
|
|
1944
1944
|
/** Styling for gallery thumbnail images. */
|
|
1945
1945
|
thumbnails?: Thumbnails;
|
|
1946
1946
|
}
|
|
1947
|
-
|
|
1947
|
+
declare enum LayoutType {
|
|
1948
1948
|
/** Collage type */
|
|
1949
1949
|
COLLAGE = "COLLAGE",
|
|
1950
1950
|
/** Masonry type */
|
|
@@ -1966,19 +1966,19 @@ export declare enum LayoutType {
|
|
|
1966
1966
|
/** Fullsize images type */
|
|
1967
1967
|
FULLSIZE = "FULLSIZE"
|
|
1968
1968
|
}
|
|
1969
|
-
|
|
1969
|
+
declare enum Orientation {
|
|
1970
1970
|
/** Rows Orientation */
|
|
1971
1971
|
ROWS = "ROWS",
|
|
1972
1972
|
/** Columns Orientation */
|
|
1973
1973
|
COLUMNS = "COLUMNS"
|
|
1974
1974
|
}
|
|
1975
|
-
|
|
1975
|
+
declare enum Crop {
|
|
1976
1976
|
/** Crop to fill */
|
|
1977
1977
|
FILL = "FILL",
|
|
1978
1978
|
/** Crop to fit */
|
|
1979
1979
|
FIT = "FIT"
|
|
1980
1980
|
}
|
|
1981
|
-
|
|
1981
|
+
declare enum ThumbnailsAlignment {
|
|
1982
1982
|
/** Top alignment */
|
|
1983
1983
|
TOP = "TOP",
|
|
1984
1984
|
/** Right alignment */
|
|
@@ -1990,7 +1990,7 @@ export declare enum ThumbnailsAlignment {
|
|
|
1990
1990
|
/** No thumbnail */
|
|
1991
1991
|
NONE = "NONE"
|
|
1992
1992
|
}
|
|
1993
|
-
|
|
1993
|
+
interface Layout {
|
|
1994
1994
|
/** Gallery layout type. */
|
|
1995
1995
|
type?: LayoutType;
|
|
1996
1996
|
/** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
|
|
@@ -2002,7 +2002,7 @@ export interface Layout {
|
|
|
2002
2002
|
/** The number of columns to display on mobile screens. */
|
|
2003
2003
|
mobileNumberOfColumns?: number | null;
|
|
2004
2004
|
}
|
|
2005
|
-
|
|
2005
|
+
interface ItemStyle {
|
|
2006
2006
|
/** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
|
|
2007
2007
|
targetSize?: number | null;
|
|
2008
2008
|
/** Item ratio */
|
|
@@ -2012,13 +2012,13 @@ export interface ItemStyle {
|
|
|
2012
2012
|
/** The spacing between items in pixels. */
|
|
2013
2013
|
spacing?: number | null;
|
|
2014
2014
|
}
|
|
2015
|
-
|
|
2015
|
+
interface Thumbnails {
|
|
2016
2016
|
/** Thumbnail alignment. */
|
|
2017
2017
|
placement?: ThumbnailsAlignment;
|
|
2018
2018
|
/** Spacing between thumbnails in pixels. */
|
|
2019
2019
|
spacing?: number | null;
|
|
2020
2020
|
}
|
|
2021
|
-
|
|
2021
|
+
interface GIFData {
|
|
2022
2022
|
/** Styling for the GIF's container. */
|
|
2023
2023
|
containerData?: PluginContainerData;
|
|
2024
2024
|
/** The source of the full size GIF. */
|
|
@@ -2032,7 +2032,7 @@ export interface GIFData {
|
|
|
2032
2032
|
/** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
|
|
2033
2033
|
gifType?: GIFType;
|
|
2034
2034
|
}
|
|
2035
|
-
|
|
2035
|
+
interface GIF {
|
|
2036
2036
|
/**
|
|
2037
2037
|
* GIF format URL.
|
|
2038
2038
|
* @format WEB_URL
|
|
@@ -2049,11 +2049,11 @@ export interface GIF {
|
|
|
2049
2049
|
*/
|
|
2050
2050
|
still?: string | null;
|
|
2051
2051
|
}
|
|
2052
|
-
|
|
2052
|
+
declare enum GIFType {
|
|
2053
2053
|
NORMAL = "NORMAL",
|
|
2054
2054
|
STICKER = "STICKER"
|
|
2055
2055
|
}
|
|
2056
|
-
|
|
2056
|
+
interface HeadingData {
|
|
2057
2057
|
/** Heading level from 1-6. */
|
|
2058
2058
|
level?: number;
|
|
2059
2059
|
/** Styling for the heading text. */
|
|
@@ -2061,7 +2061,7 @@ export interface HeadingData {
|
|
|
2061
2061
|
/** Indentation level from 1-4. */
|
|
2062
2062
|
indentation?: number | null;
|
|
2063
2063
|
}
|
|
2064
|
-
|
|
2064
|
+
interface HTMLData extends HTMLDataDataOneOf {
|
|
2065
2065
|
/** The URL for the HTML code for the node. */
|
|
2066
2066
|
url?: string;
|
|
2067
2067
|
/** The HTML code for the node. */
|
|
@@ -2079,7 +2079,7 @@ export interface HTMLData extends HTMLDataDataOneOf {
|
|
|
2079
2079
|
autoHeight?: boolean | null;
|
|
2080
2080
|
}
|
|
2081
2081
|
/** @oneof */
|
|
2082
|
-
|
|
2082
|
+
interface HTMLDataDataOneOf {
|
|
2083
2083
|
/** The URL for the HTML code for the node. */
|
|
2084
2084
|
url?: string;
|
|
2085
2085
|
/** The HTML code for the node. */
|
|
@@ -2090,11 +2090,11 @@ export interface HTMLDataDataOneOf {
|
|
|
2090
2090
|
*/
|
|
2091
2091
|
isAdsense?: boolean | null;
|
|
2092
2092
|
}
|
|
2093
|
-
|
|
2093
|
+
declare enum Source {
|
|
2094
2094
|
HTML = "HTML",
|
|
2095
2095
|
ADSENSE = "ADSENSE"
|
|
2096
2096
|
}
|
|
2097
|
-
|
|
2097
|
+
interface ImageData {
|
|
2098
2098
|
/** Styling for the image's container. */
|
|
2099
2099
|
containerData?: PluginContainerData;
|
|
2100
2100
|
/** Image file details. */
|
|
@@ -2117,7 +2117,7 @@ export interface ImageData {
|
|
|
2117
2117
|
/** Styling for the image. */
|
|
2118
2118
|
styles?: ImageDataStyles;
|
|
2119
2119
|
}
|
|
2120
|
-
|
|
2120
|
+
interface StylesBorder {
|
|
2121
2121
|
/** Border width in pixels. */
|
|
2122
2122
|
width?: number | null;
|
|
2123
2123
|
/**
|
|
@@ -2128,11 +2128,11 @@ export interface StylesBorder {
|
|
|
2128
2128
|
/** Border radius in pixels. */
|
|
2129
2129
|
radius?: number | null;
|
|
2130
2130
|
}
|
|
2131
|
-
|
|
2131
|
+
interface ImageDataStyles {
|
|
2132
2132
|
/** Border attributes. */
|
|
2133
2133
|
border?: StylesBorder;
|
|
2134
2134
|
}
|
|
2135
|
-
|
|
2135
|
+
interface LinkPreviewData {
|
|
2136
2136
|
/** Styling for the link preview's container. */
|
|
2137
2137
|
containerData?: PluginContainerData;
|
|
2138
2138
|
/** Link details. */
|
|
@@ -2148,7 +2148,7 @@ export interface LinkPreviewData {
|
|
|
2148
2148
|
/** Styling for the link preview. */
|
|
2149
2149
|
styles?: LinkPreviewDataStyles;
|
|
2150
2150
|
}
|
|
2151
|
-
|
|
2151
|
+
declare enum Position {
|
|
2152
2152
|
/** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
|
|
2153
2153
|
START = "START",
|
|
2154
2154
|
/** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
|
|
@@ -2158,7 +2158,7 @@ export declare enum Position {
|
|
|
2158
2158
|
/** Thumbnail hidden and not displayed */
|
|
2159
2159
|
HIDDEN = "HIDDEN"
|
|
2160
2160
|
}
|
|
2161
|
-
|
|
2161
|
+
interface LinkPreviewDataStyles {
|
|
2162
2162
|
/**
|
|
2163
2163
|
* Background color as a hexadecimal value.
|
|
2164
2164
|
* @format COLOR_HEX
|
|
@@ -2191,13 +2191,13 @@ export interface LinkPreviewDataStyles {
|
|
|
2191
2191
|
/** Position of thumbnail. Defaults to `START`. */
|
|
2192
2192
|
thumbnailPosition?: Position;
|
|
2193
2193
|
}
|
|
2194
|
-
|
|
2194
|
+
interface MapData {
|
|
2195
2195
|
/** Styling for the map's container. */
|
|
2196
2196
|
containerData?: PluginContainerData;
|
|
2197
2197
|
/** Map settings. */
|
|
2198
2198
|
mapSettings?: MapSettings;
|
|
2199
2199
|
}
|
|
2200
|
-
|
|
2200
|
+
interface MapSettings {
|
|
2201
2201
|
/** The address to display on the map. */
|
|
2202
2202
|
address?: string | null;
|
|
2203
2203
|
/** Sets whether the map is draggable. */
|
|
@@ -2221,7 +2221,7 @@ export interface MapSettings {
|
|
|
2221
2221
|
/** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
|
|
2222
2222
|
mapType?: MapType;
|
|
2223
2223
|
}
|
|
2224
|
-
|
|
2224
|
+
declare enum MapType {
|
|
2225
2225
|
/** Roadmap map type */
|
|
2226
2226
|
ROADMAP = "ROADMAP",
|
|
2227
2227
|
/** Satellite map type */
|
|
@@ -2231,7 +2231,7 @@ export declare enum MapType {
|
|
|
2231
2231
|
/** Terrain map type */
|
|
2232
2232
|
TERRAIN = "TERRAIN"
|
|
2233
2233
|
}
|
|
2234
|
-
|
|
2234
|
+
interface ParagraphData {
|
|
2235
2235
|
/** Styling for the paragraph text. */
|
|
2236
2236
|
textStyle?: TextStyle;
|
|
2237
2237
|
/** Indentation level from 1-4. */
|
|
@@ -2239,7 +2239,7 @@ export interface ParagraphData {
|
|
|
2239
2239
|
/** Paragraph level */
|
|
2240
2240
|
level?: number | null;
|
|
2241
2241
|
}
|
|
2242
|
-
|
|
2242
|
+
interface PollData {
|
|
2243
2243
|
/** Styling for the poll's container. */
|
|
2244
2244
|
containerData?: PluginContainerData;
|
|
2245
2245
|
/** Poll data. */
|
|
@@ -2249,7 +2249,7 @@ export interface PollData {
|
|
|
2249
2249
|
/** Styling for the poll and voting options. */
|
|
2250
2250
|
design?: Design;
|
|
2251
2251
|
}
|
|
2252
|
-
|
|
2252
|
+
declare enum ViewRole {
|
|
2253
2253
|
/** Only Poll creator can view the results */
|
|
2254
2254
|
CREATOR = "CREATOR",
|
|
2255
2255
|
/** Anyone who voted can see the results */
|
|
@@ -2257,13 +2257,13 @@ export declare enum ViewRole {
|
|
|
2257
2257
|
/** Anyone can see the results, even if one didn't vote */
|
|
2258
2258
|
EVERYONE = "EVERYONE"
|
|
2259
2259
|
}
|
|
2260
|
-
|
|
2260
|
+
declare enum VoteRole {
|
|
2261
2261
|
/** Logged in member */
|
|
2262
2262
|
SITE_MEMBERS = "SITE_MEMBERS",
|
|
2263
2263
|
/** Anyone */
|
|
2264
2264
|
ALL = "ALL"
|
|
2265
2265
|
}
|
|
2266
|
-
|
|
2266
|
+
interface Permissions {
|
|
2267
2267
|
/** Sets who can view the poll results. */
|
|
2268
2268
|
view?: ViewRole;
|
|
2269
2269
|
/** Sets who can vote. */
|
|
@@ -2271,7 +2271,7 @@ export interface Permissions {
|
|
|
2271
2271
|
/** Sets whether one voter can vote multiple times. Defaults to `false`. */
|
|
2272
2272
|
allowMultipleVotes?: boolean | null;
|
|
2273
2273
|
}
|
|
2274
|
-
|
|
2274
|
+
interface Option {
|
|
2275
2275
|
/** Option ID. */
|
|
2276
2276
|
_id?: string | null;
|
|
2277
2277
|
/** Option title. */
|
|
@@ -2279,7 +2279,7 @@ export interface Option {
|
|
|
2279
2279
|
/** The image displayed with the option. */
|
|
2280
2280
|
image?: Media;
|
|
2281
2281
|
}
|
|
2282
|
-
|
|
2282
|
+
interface PollSettings {
|
|
2283
2283
|
/** Permissions settings for voting. */
|
|
2284
2284
|
permissions?: Permissions;
|
|
2285
2285
|
/** Sets whether voters are displayed in the vote results. Defaults to `true`. */
|
|
@@ -2287,19 +2287,19 @@ export interface PollSettings {
|
|
|
2287
2287
|
/** Sets whether the vote count is displayed. Defaults to `true`. */
|
|
2288
2288
|
showVotesCount?: boolean | null;
|
|
2289
2289
|
}
|
|
2290
|
-
|
|
2290
|
+
declare enum PollLayoutType {
|
|
2291
2291
|
/** List */
|
|
2292
2292
|
LIST = "LIST",
|
|
2293
2293
|
/** Grid */
|
|
2294
2294
|
GRID = "GRID"
|
|
2295
2295
|
}
|
|
2296
|
-
|
|
2296
|
+
declare enum PollLayoutDirection {
|
|
2297
2297
|
/** Left-to-right */
|
|
2298
2298
|
LTR = "LTR",
|
|
2299
2299
|
/** Right-to-left */
|
|
2300
2300
|
RTL = "RTL"
|
|
2301
2301
|
}
|
|
2302
|
-
|
|
2302
|
+
interface PollLayout {
|
|
2303
2303
|
/** The layout for displaying the voting options. */
|
|
2304
2304
|
type?: PollLayoutType;
|
|
2305
2305
|
/** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
|
|
@@ -2307,11 +2307,11 @@ export interface PollLayout {
|
|
|
2307
2307
|
/** Sets whether to display the main poll image. Defaults to `false`. */
|
|
2308
2308
|
enableImage?: boolean | null;
|
|
2309
2309
|
}
|
|
2310
|
-
|
|
2310
|
+
interface OptionLayout {
|
|
2311
2311
|
/** Sets whether to display option images. Defaults to `false`. */
|
|
2312
2312
|
enableImage?: boolean | null;
|
|
2313
2313
|
}
|
|
2314
|
-
|
|
2314
|
+
declare enum BackgroundType {
|
|
2315
2315
|
/** Color background type */
|
|
2316
2316
|
COLOR = "COLOR",
|
|
2317
2317
|
/** Image background type */
|
|
@@ -2319,7 +2319,7 @@ export declare enum BackgroundType {
|
|
|
2319
2319
|
/** Gradiant background type */
|
|
2320
2320
|
GRADIENT = "GRADIENT"
|
|
2321
2321
|
}
|
|
2322
|
-
|
|
2322
|
+
interface Gradient {
|
|
2323
2323
|
/** The gradient angle in degrees. */
|
|
2324
2324
|
angle?: number | null;
|
|
2325
2325
|
/**
|
|
@@ -2333,7 +2333,7 @@ export interface Gradient {
|
|
|
2333
2333
|
*/
|
|
2334
2334
|
lastColor?: string | null;
|
|
2335
2335
|
}
|
|
2336
|
-
|
|
2336
|
+
interface Background extends BackgroundBackgroundOneOf {
|
|
2337
2337
|
/**
|
|
2338
2338
|
* The background color as a hexademical value.
|
|
2339
2339
|
* @format COLOR_HEX
|
|
@@ -2347,7 +2347,7 @@ export interface Background extends BackgroundBackgroundOneOf {
|
|
|
2347
2347
|
type?: BackgroundType;
|
|
2348
2348
|
}
|
|
2349
2349
|
/** @oneof */
|
|
2350
|
-
|
|
2350
|
+
interface BackgroundBackgroundOneOf {
|
|
2351
2351
|
/**
|
|
2352
2352
|
* The background color as a hexademical value.
|
|
2353
2353
|
* @format COLOR_HEX
|
|
@@ -2358,17 +2358,17 @@ export interface BackgroundBackgroundOneOf {
|
|
|
2358
2358
|
/** Details for a gradient background. */
|
|
2359
2359
|
gradient?: Gradient;
|
|
2360
2360
|
}
|
|
2361
|
-
|
|
2361
|
+
interface PollDesign {
|
|
2362
2362
|
/** Background styling. */
|
|
2363
2363
|
background?: Background;
|
|
2364
2364
|
/** Border radius in pixels. */
|
|
2365
2365
|
borderRadius?: number | null;
|
|
2366
2366
|
}
|
|
2367
|
-
|
|
2367
|
+
interface OptionDesign {
|
|
2368
2368
|
/** Border radius in pixels. */
|
|
2369
2369
|
borderRadius?: number | null;
|
|
2370
2370
|
}
|
|
2371
|
-
|
|
2371
|
+
interface Poll {
|
|
2372
2372
|
/** Poll ID. */
|
|
2373
2373
|
_id?: string | null;
|
|
2374
2374
|
/** Poll title. */
|
|
@@ -2382,26 +2382,26 @@ export interface Poll {
|
|
|
2382
2382
|
/** The poll's permissions and display settings. */
|
|
2383
2383
|
settings?: PollSettings;
|
|
2384
2384
|
}
|
|
2385
|
-
|
|
2385
|
+
interface PollDataLayout {
|
|
2386
2386
|
/** Poll layout settings. */
|
|
2387
2387
|
poll?: PollLayout;
|
|
2388
2388
|
/** Voting otpions layout settings. */
|
|
2389
2389
|
options?: OptionLayout;
|
|
2390
2390
|
}
|
|
2391
|
-
|
|
2391
|
+
interface Design {
|
|
2392
2392
|
/** Styling for the poll. */
|
|
2393
2393
|
poll?: PollDesign;
|
|
2394
2394
|
/** Styling for voting options. */
|
|
2395
2395
|
options?: OptionDesign;
|
|
2396
2396
|
}
|
|
2397
|
-
|
|
2397
|
+
interface TextData {
|
|
2398
2398
|
/** The text to apply decorations to. */
|
|
2399
2399
|
text?: string;
|
|
2400
2400
|
/** The decorations to apply. */
|
|
2401
2401
|
decorations?: Decoration[];
|
|
2402
2402
|
}
|
|
2403
2403
|
/** Adds appearence changes to text */
|
|
2404
|
-
|
|
2404
|
+
interface Decoration extends DecorationDataOneOf {
|
|
2405
2405
|
/** Data for an anchor link decoration. */
|
|
2406
2406
|
anchorData?: AnchorData;
|
|
2407
2407
|
/** Data for a color decoration. */
|
|
@@ -2424,7 +2424,7 @@ export interface Decoration extends DecorationDataOneOf {
|
|
|
2424
2424
|
type?: DecorationType;
|
|
2425
2425
|
}
|
|
2426
2426
|
/** @oneof */
|
|
2427
|
-
|
|
2427
|
+
interface DecorationDataOneOf {
|
|
2428
2428
|
/** Data for an anchor link decoration. */
|
|
2429
2429
|
anchorData?: AnchorData;
|
|
2430
2430
|
/** Data for a color decoration. */
|
|
@@ -2444,7 +2444,7 @@ export interface DecorationDataOneOf {
|
|
|
2444
2444
|
/** Data for a spoiler decoration. */
|
|
2445
2445
|
spoilerData?: SpoilerData;
|
|
2446
2446
|
}
|
|
2447
|
-
|
|
2447
|
+
declare enum DecorationType {
|
|
2448
2448
|
BOLD = "BOLD",
|
|
2449
2449
|
ITALIC = "ITALIC",
|
|
2450
2450
|
UNDERLINE = "UNDERLINE",
|
|
@@ -2456,21 +2456,21 @@ export declare enum DecorationType {
|
|
|
2456
2456
|
FONT_SIZE = "FONT_SIZE",
|
|
2457
2457
|
EXTERNAL = "EXTERNAL"
|
|
2458
2458
|
}
|
|
2459
|
-
|
|
2459
|
+
interface AnchorData {
|
|
2460
2460
|
/** The target node's ID. */
|
|
2461
2461
|
anchor?: string;
|
|
2462
2462
|
}
|
|
2463
|
-
|
|
2463
|
+
interface ColorData {
|
|
2464
2464
|
/** The text's background color as a hexadecimal value. */
|
|
2465
2465
|
background?: string | null;
|
|
2466
2466
|
/** The text's foreground color as a hexadecimal value. */
|
|
2467
2467
|
foreground?: string | null;
|
|
2468
2468
|
}
|
|
2469
|
-
|
|
2469
|
+
interface LinkData {
|
|
2470
2470
|
/** Link details. */
|
|
2471
2471
|
link?: Link;
|
|
2472
2472
|
}
|
|
2473
|
-
|
|
2473
|
+
interface MentionData {
|
|
2474
2474
|
/** The mentioned user's name. */
|
|
2475
2475
|
name?: string;
|
|
2476
2476
|
/** The version of the user's name that appears after the `@` character in the mention. */
|
|
@@ -2478,21 +2478,21 @@ export interface MentionData {
|
|
|
2478
2478
|
/** Mentioned user's ID. */
|
|
2479
2479
|
_id?: string | null;
|
|
2480
2480
|
}
|
|
2481
|
-
|
|
2481
|
+
interface FontSizeData {
|
|
2482
2482
|
/** The units used for the font size. */
|
|
2483
2483
|
unit?: FontType;
|
|
2484
2484
|
/** Font size value. */
|
|
2485
2485
|
value?: number | null;
|
|
2486
2486
|
}
|
|
2487
|
-
|
|
2487
|
+
declare enum FontType {
|
|
2488
2488
|
PX = "PX",
|
|
2489
2489
|
EM = "EM"
|
|
2490
2490
|
}
|
|
2491
|
-
|
|
2491
|
+
interface SpoilerData {
|
|
2492
2492
|
/** Spoiler ID. */
|
|
2493
2493
|
_id?: string | null;
|
|
2494
2494
|
}
|
|
2495
|
-
|
|
2495
|
+
interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
2496
2496
|
/** Data for embedded Wix Bookings content. */
|
|
2497
2497
|
bookingData?: BookingData;
|
|
2498
2498
|
/** Data for embedded Wix Events content. */
|
|
@@ -2514,28 +2514,28 @@ export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
|
2514
2514
|
image?: Media;
|
|
2515
2515
|
}
|
|
2516
2516
|
/** @oneof */
|
|
2517
|
-
|
|
2517
|
+
interface AppEmbedDataAppDataOneOf {
|
|
2518
2518
|
/** Data for embedded Wix Bookings content. */
|
|
2519
2519
|
bookingData?: BookingData;
|
|
2520
2520
|
/** Data for embedded Wix Events content. */
|
|
2521
2521
|
eventData?: EventData;
|
|
2522
2522
|
}
|
|
2523
|
-
|
|
2523
|
+
declare enum AppType {
|
|
2524
2524
|
PRODUCT = "PRODUCT",
|
|
2525
2525
|
EVENT = "EVENT",
|
|
2526
2526
|
BOOKING = "BOOKING"
|
|
2527
2527
|
}
|
|
2528
|
-
|
|
2528
|
+
interface BookingData {
|
|
2529
2529
|
/** Booking duration in minutes. */
|
|
2530
2530
|
durations?: string | null;
|
|
2531
2531
|
}
|
|
2532
|
-
|
|
2532
|
+
interface EventData {
|
|
2533
2533
|
/** Event schedule. */
|
|
2534
2534
|
scheduling?: string | null;
|
|
2535
2535
|
/** Event location. */
|
|
2536
2536
|
location?: string | null;
|
|
2537
2537
|
}
|
|
2538
|
-
|
|
2538
|
+
interface VideoData {
|
|
2539
2539
|
/** Styling for the video's container. */
|
|
2540
2540
|
containerData?: PluginContainerData;
|
|
2541
2541
|
/** Video details. */
|
|
@@ -2549,7 +2549,7 @@ export interface VideoData {
|
|
|
2549
2549
|
/** Video options. */
|
|
2550
2550
|
options?: PlaybackOptions;
|
|
2551
2551
|
}
|
|
2552
|
-
|
|
2552
|
+
interface PlaybackOptions {
|
|
2553
2553
|
/** Sets whether the media will automatically start playing. */
|
|
2554
2554
|
autoPlay?: boolean | null;
|
|
2555
2555
|
/** Sets whether media's will be looped. */
|
|
@@ -2557,7 +2557,7 @@ export interface PlaybackOptions {
|
|
|
2557
2557
|
/** Sets whether media's controls will be shown. */
|
|
2558
2558
|
showControls?: boolean | null;
|
|
2559
2559
|
}
|
|
2560
|
-
|
|
2560
|
+
interface EmbedData {
|
|
2561
2561
|
/** Styling for the oEmbed node's container. */
|
|
2562
2562
|
containerData?: PluginContainerData;
|
|
2563
2563
|
/** An [oEmbed](https://www.oembed.com) object. */
|
|
@@ -2565,7 +2565,7 @@ export interface EmbedData {
|
|
|
2565
2565
|
/** Origin asset source. */
|
|
2566
2566
|
src?: string | null;
|
|
2567
2567
|
}
|
|
2568
|
-
|
|
2568
|
+
interface Oembed {
|
|
2569
2569
|
/** The resource type. */
|
|
2570
2570
|
type?: string | null;
|
|
2571
2571
|
/** The width of the resource specified in the `url` property in pixels. */
|
|
@@ -2597,7 +2597,7 @@ export interface Oembed {
|
|
|
2597
2597
|
/** The oEmbed version number. This value must be `1.0`. */
|
|
2598
2598
|
version?: string | null;
|
|
2599
2599
|
}
|
|
2600
|
-
|
|
2600
|
+
interface CollapsibleListData {
|
|
2601
2601
|
/** Styling for the collapsible list's container. */
|
|
2602
2602
|
containerData?: PluginContainerData;
|
|
2603
2603
|
/** If `true`, only one item can be expanded at a time. Defaults to `false`. */
|
|
@@ -2609,7 +2609,7 @@ export interface CollapsibleListData {
|
|
|
2609
2609
|
/** If `true`, The collapsible item will appear in search results as an FAQ. */
|
|
2610
2610
|
isQapageData?: boolean | null;
|
|
2611
2611
|
}
|
|
2612
|
-
|
|
2612
|
+
declare enum InitialExpandedItems {
|
|
2613
2613
|
/** First item will be expended initally */
|
|
2614
2614
|
FIRST = "FIRST",
|
|
2615
2615
|
/** All items will expended initally */
|
|
@@ -2617,13 +2617,13 @@ export declare enum InitialExpandedItems {
|
|
|
2617
2617
|
/** All items collapsed initally */
|
|
2618
2618
|
NONE = "NONE"
|
|
2619
2619
|
}
|
|
2620
|
-
|
|
2620
|
+
declare enum Direction {
|
|
2621
2621
|
/** Left-to-right */
|
|
2622
2622
|
LTR = "LTR",
|
|
2623
2623
|
/** Right-to-left */
|
|
2624
2624
|
RTL = "RTL"
|
|
2625
2625
|
}
|
|
2626
|
-
|
|
2626
|
+
interface TableData {
|
|
2627
2627
|
/** Styling for the table's container. */
|
|
2628
2628
|
containerData?: PluginContainerData;
|
|
2629
2629
|
/** The table's dimensions. */
|
|
@@ -2638,7 +2638,7 @@ export interface TableData {
|
|
|
2638
2638
|
/** Sets whether the table's first column is a header. Defaults to `false`. */
|
|
2639
2639
|
columnHeader?: boolean | null;
|
|
2640
2640
|
}
|
|
2641
|
-
|
|
2641
|
+
interface Dimensions {
|
|
2642
2642
|
/** An array representing relative width of each column in relation to the other columns. */
|
|
2643
2643
|
colsWidthRatio?: number[];
|
|
2644
2644
|
/** An array representing the height of each row in pixels. */
|
|
@@ -2646,13 +2646,13 @@ export interface Dimensions {
|
|
|
2646
2646
|
/** An array representing the minimum width of each column in pixels. */
|
|
2647
2647
|
colsMinWidth?: number[];
|
|
2648
2648
|
}
|
|
2649
|
-
|
|
2649
|
+
interface TableCellData {
|
|
2650
2650
|
/** Styling for the cell's background color and text alignment. */
|
|
2651
2651
|
cellStyle?: CellStyle;
|
|
2652
2652
|
/** The cell's border colors. */
|
|
2653
2653
|
borderColors?: BorderColors;
|
|
2654
2654
|
}
|
|
2655
|
-
|
|
2655
|
+
declare enum VerticalAlignment {
|
|
2656
2656
|
/** Top alignment */
|
|
2657
2657
|
TOP = "TOP",
|
|
2658
2658
|
/** Middle alignment */
|
|
@@ -2660,7 +2660,7 @@ export declare enum VerticalAlignment {
|
|
|
2660
2660
|
/** Bottom alignment */
|
|
2661
2661
|
BOTTOM = "BOTTOM"
|
|
2662
2662
|
}
|
|
2663
|
-
|
|
2663
|
+
interface CellStyle {
|
|
2664
2664
|
/** Vertical alignment for the cell's text. */
|
|
2665
2665
|
verticalAlignment?: VerticalAlignment;
|
|
2666
2666
|
/**
|
|
@@ -2669,7 +2669,7 @@ export interface CellStyle {
|
|
|
2669
2669
|
*/
|
|
2670
2670
|
backgroundColor?: string | null;
|
|
2671
2671
|
}
|
|
2672
|
-
|
|
2672
|
+
interface BorderColors {
|
|
2673
2673
|
/**
|
|
2674
2674
|
* Left border color as a hexadecimal value.
|
|
2675
2675
|
* @format COLOR_HEX
|
|
@@ -2697,7 +2697,7 @@ export interface BorderColors {
|
|
|
2697
2697
|
*
|
|
2698
2698
|
* The JSON representation for `NullValue` is JSON `null`.
|
|
2699
2699
|
*/
|
|
2700
|
-
|
|
2700
|
+
declare enum NullValue {
|
|
2701
2701
|
/** Null value. */
|
|
2702
2702
|
NULL_VALUE = "NULL_VALUE"
|
|
2703
2703
|
}
|
|
@@ -2706,11 +2706,11 @@ export declare enum NullValue {
|
|
|
2706
2706
|
*
|
|
2707
2707
|
* The JSON representation for `ListValue` is JSON array.
|
|
2708
2708
|
*/
|
|
2709
|
-
|
|
2709
|
+
interface ListValue {
|
|
2710
2710
|
/** Repeated field of dynamically typed values. */
|
|
2711
2711
|
values?: any[];
|
|
2712
2712
|
}
|
|
2713
|
-
|
|
2713
|
+
interface AudioData {
|
|
2714
2714
|
/** Styling for the audio node's container. */
|
|
2715
2715
|
containerData?: PluginContainerData;
|
|
2716
2716
|
/** Audio file details. */
|
|
@@ -2726,7 +2726,7 @@ export interface AudioData {
|
|
|
2726
2726
|
/** An HTML version of the audio node. */
|
|
2727
2727
|
html?: string | null;
|
|
2728
2728
|
}
|
|
2729
|
-
|
|
2729
|
+
interface OrderedListData {
|
|
2730
2730
|
/** Indentation level from 0-4. */
|
|
2731
2731
|
indentation?: number;
|
|
2732
2732
|
/** Offset level from 0-4. */
|
|
@@ -2734,24 +2734,24 @@ export interface OrderedListData {
|
|
|
2734
2734
|
/** List start number. */
|
|
2735
2735
|
start?: number | null;
|
|
2736
2736
|
}
|
|
2737
|
-
|
|
2737
|
+
interface BulletedListData {
|
|
2738
2738
|
/** Indentation level from 0-4. */
|
|
2739
2739
|
indentation?: number;
|
|
2740
2740
|
/** Offset level from 0-4. */
|
|
2741
2741
|
offset?: number | null;
|
|
2742
2742
|
}
|
|
2743
|
-
|
|
2743
|
+
interface BlockquoteData {
|
|
2744
2744
|
/** Indentation level from 1-4. */
|
|
2745
2745
|
indentation?: number;
|
|
2746
2746
|
}
|
|
2747
|
-
|
|
2747
|
+
interface CaptionData {
|
|
2748
2748
|
textStyle?: TextStyle;
|
|
2749
2749
|
}
|
|
2750
|
-
|
|
2750
|
+
interface LayoutCellData {
|
|
2751
2751
|
/** Size of the cell in 12 columns grid. */
|
|
2752
2752
|
colSpan?: number | null;
|
|
2753
2753
|
}
|
|
2754
|
-
|
|
2754
|
+
interface Metadata {
|
|
2755
2755
|
/** Schema version. */
|
|
2756
2756
|
version?: number;
|
|
2757
2757
|
/**
|
|
@@ -2768,7 +2768,7 @@ export interface Metadata {
|
|
|
2768
2768
|
/** Object ID. */
|
|
2769
2769
|
_id?: string | null;
|
|
2770
2770
|
}
|
|
2771
|
-
|
|
2771
|
+
interface DocumentStyle {
|
|
2772
2772
|
/** Styling for H1 nodes. */
|
|
2773
2773
|
headerOne?: TextNodeStyle;
|
|
2774
2774
|
/** Styling for H2 nodes. */
|
|
@@ -2788,7 +2788,7 @@ export interface DocumentStyle {
|
|
|
2788
2788
|
/** Styling for code block nodes. */
|
|
2789
2789
|
codeBlock?: TextNodeStyle;
|
|
2790
2790
|
}
|
|
2791
|
-
|
|
2791
|
+
interface TextNodeStyle {
|
|
2792
2792
|
/** The decorations to apply to the node. */
|
|
2793
2793
|
decorations?: Decoration[];
|
|
2794
2794
|
/** Padding and background color for the node. */
|
|
@@ -2796,7 +2796,7 @@ export interface TextNodeStyle {
|
|
|
2796
2796
|
/** Line height for text in the node. */
|
|
2797
2797
|
lineHeight?: string | null;
|
|
2798
2798
|
}
|
|
2799
|
-
|
|
2799
|
+
interface Badge {
|
|
2800
2800
|
/** Badge type. */
|
|
2801
2801
|
type?: Type;
|
|
2802
2802
|
/**
|
|
@@ -2805,7 +2805,7 @@ export interface Badge {
|
|
|
2805
2805
|
*/
|
|
2806
2806
|
text?: string | null;
|
|
2807
2807
|
}
|
|
2808
|
-
|
|
2808
|
+
declare enum Type {
|
|
2809
2809
|
/** Unknown badge type. */
|
|
2810
2810
|
UNKNOWN_BADGE_TYPE = "UNKNOWN_BADGE_TYPE",
|
|
2811
2811
|
/** 1st priority badge type. */
|
|
@@ -2815,16 +2815,16 @@ export declare enum Type {
|
|
|
2815
2815
|
/** 3rd priority badge type. */
|
|
2816
2816
|
THIRD_PRIORITY = "THIRD_PRIORITY"
|
|
2817
2817
|
}
|
|
2818
|
-
|
|
2818
|
+
interface DiscardDraftRequest {
|
|
2819
2819
|
/**
|
|
2820
2820
|
* Event ID to which the form belongs.
|
|
2821
2821
|
* @format GUID
|
|
2822
2822
|
*/
|
|
2823
2823
|
eventId: string;
|
|
2824
2824
|
}
|
|
2825
|
-
|
|
2825
|
+
interface DiscardDraftResponse {
|
|
2826
2826
|
}
|
|
2827
|
-
|
|
2827
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
2828
2828
|
createdEvent?: EntityCreatedEvent;
|
|
2829
2829
|
updatedEvent?: EntityUpdatedEvent;
|
|
2830
2830
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -2867,19 +2867,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
2867
2867
|
entityEventSequence?: string | null;
|
|
2868
2868
|
}
|
|
2869
2869
|
/** @oneof */
|
|
2870
|
-
|
|
2870
|
+
interface DomainEventBodyOneOf {
|
|
2871
2871
|
createdEvent?: EntityCreatedEvent;
|
|
2872
2872
|
updatedEvent?: EntityUpdatedEvent;
|
|
2873
2873
|
deletedEvent?: EntityDeletedEvent;
|
|
2874
2874
|
actionEvent?: ActionEvent;
|
|
2875
2875
|
}
|
|
2876
|
-
|
|
2876
|
+
interface EntityCreatedEvent {
|
|
2877
2877
|
entity?: string;
|
|
2878
2878
|
}
|
|
2879
|
-
|
|
2879
|
+
interface RestoreInfo {
|
|
2880
2880
|
deletedDate?: Date | null;
|
|
2881
2881
|
}
|
|
2882
|
-
|
|
2882
|
+
interface EntityUpdatedEvent {
|
|
2883
2883
|
/**
|
|
2884
2884
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
2885
2885
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -2887,14 +2887,14 @@ export interface EntityUpdatedEvent {
|
|
|
2887
2887
|
*/
|
|
2888
2888
|
currentEntity?: string;
|
|
2889
2889
|
}
|
|
2890
|
-
|
|
2890
|
+
interface EntityDeletedEvent {
|
|
2891
2891
|
/** Entity that was deleted */
|
|
2892
2892
|
deletedEntity?: string | null;
|
|
2893
2893
|
}
|
|
2894
|
-
|
|
2894
|
+
interface ActionEvent {
|
|
2895
2895
|
body?: string;
|
|
2896
2896
|
}
|
|
2897
|
-
|
|
2897
|
+
interface MessageEnvelope {
|
|
2898
2898
|
/**
|
|
2899
2899
|
* App instance ID.
|
|
2900
2900
|
* @format GUID
|
|
@@ -2910,7 +2910,7 @@ export interface MessageEnvelope {
|
|
|
2910
2910
|
/** Stringify payload. */
|
|
2911
2911
|
data?: string;
|
|
2912
2912
|
}
|
|
2913
|
-
|
|
2913
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
2914
2914
|
/**
|
|
2915
2915
|
* ID of a site visitor that has not logged in to the site.
|
|
2916
2916
|
* @format GUID
|
|
@@ -2935,7 +2935,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
2935
2935
|
identityType?: WebhookIdentityType;
|
|
2936
2936
|
}
|
|
2937
2937
|
/** @oneof */
|
|
2938
|
-
|
|
2938
|
+
interface IdentificationDataIdOneOf {
|
|
2939
2939
|
/**
|
|
2940
2940
|
* ID of a site visitor that has not logged in to the site.
|
|
2941
2941
|
* @format GUID
|
|
@@ -2957,118 +2957,14 @@ export interface IdentificationDataIdOneOf {
|
|
|
2957
2957
|
*/
|
|
2958
2958
|
appId?: string;
|
|
2959
2959
|
}
|
|
2960
|
-
|
|
2960
|
+
declare enum WebhookIdentityType {
|
|
2961
2961
|
UNKNOWN = "UNKNOWN",
|
|
2962
2962
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
2963
2963
|
MEMBER = "MEMBER",
|
|
2964
2964
|
WIX_USER = "WIX_USER",
|
|
2965
2965
|
APP = "APP"
|
|
2966
2966
|
}
|
|
2967
|
-
interface
|
|
2968
|
-
optionIndex: number;
|
|
2969
|
-
placeholderText: string;
|
|
2970
|
-
}
|
|
2971
|
-
interface LabelNonNullableFields {
|
|
2972
|
-
name: string;
|
|
2973
|
-
label: string;
|
|
2974
|
-
}
|
|
2975
|
-
interface InputNonNullableFields {
|
|
2976
|
-
name: string;
|
|
2977
|
-
array: boolean;
|
|
2978
|
-
label: string;
|
|
2979
|
-
options: string[];
|
|
2980
|
-
mandatory: boolean;
|
|
2981
|
-
maxLength: number;
|
|
2982
|
-
type: ValueType;
|
|
2983
|
-
defaultOptionSelection?: OptionSelectionNonNullableFields;
|
|
2984
|
-
labels: LabelNonNullableFields[];
|
|
2985
|
-
}
|
|
2986
|
-
interface InputControlNonNullableFields {
|
|
2987
|
-
type: InputControlType;
|
|
2988
|
-
system: boolean;
|
|
2989
|
-
name: string;
|
|
2990
|
-
inputs: InputNonNullableFields[];
|
|
2991
|
-
label: string;
|
|
2992
|
-
orderIndex: number;
|
|
2993
|
-
_id: string;
|
|
2994
|
-
}
|
|
2995
|
-
interface PositiveResponseConfirmationNonNullableFields {
|
|
2996
|
-
title: string;
|
|
2997
|
-
message: string;
|
|
2998
|
-
addToCalendarActionLabel: string;
|
|
2999
|
-
shareActionLabel: string;
|
|
3000
|
-
}
|
|
3001
|
-
interface PositiveNonNullableFields {
|
|
3002
|
-
title: string;
|
|
3003
|
-
confirmation?: PositiveResponseConfirmationNonNullableFields;
|
|
3004
|
-
}
|
|
3005
|
-
interface NegativeResponseConfirmationNonNullableFields {
|
|
3006
|
-
title: string;
|
|
3007
|
-
shareActionLabel: string;
|
|
3008
|
-
}
|
|
3009
|
-
interface NegativeNonNullableFields {
|
|
3010
|
-
title: string;
|
|
3011
|
-
confirmation?: NegativeResponseConfirmationNonNullableFields;
|
|
3012
|
-
}
|
|
3013
|
-
interface RsvpFormMessagesNonNullableFields {
|
|
3014
|
-
rsvpYesOption: string;
|
|
3015
|
-
rsvpNoOption: string;
|
|
3016
|
-
positiveMessages?: PositiveNonNullableFields;
|
|
3017
|
-
waitlistMessages?: PositiveNonNullableFields;
|
|
3018
|
-
negativeMessages?: NegativeNonNullableFields;
|
|
3019
|
-
submitActionLabel: string;
|
|
3020
|
-
}
|
|
3021
|
-
interface ResponseConfirmationNonNullableFields {
|
|
3022
|
-
title: string;
|
|
3023
|
-
message: string;
|
|
3024
|
-
downloadTicketsLabel: string;
|
|
3025
|
-
addToCalendarLabel: string;
|
|
3026
|
-
shareEventLabel: string;
|
|
3027
|
-
}
|
|
3028
|
-
interface CheckoutFormMessagesNonNullableFields {
|
|
3029
|
-
title: string;
|
|
3030
|
-
submitActionLabel: string;
|
|
3031
|
-
confirmation?: ResponseConfirmationNonNullableFields;
|
|
3032
|
-
}
|
|
3033
|
-
interface RegistrationClosedMessagesNonNullableFields {
|
|
3034
|
-
message: string;
|
|
3035
|
-
exploreEventsActionLabel: string;
|
|
3036
|
-
}
|
|
3037
|
-
interface TicketsUnavailableMessagesNonNullableFields {
|
|
3038
|
-
message: string;
|
|
3039
|
-
exploreEventsActionLabel: string;
|
|
3040
|
-
}
|
|
3041
|
-
interface FormMessagesNonNullableFields {
|
|
3042
|
-
rsvp?: RsvpFormMessagesNonNullableFields;
|
|
3043
|
-
checkout?: CheckoutFormMessagesNonNullableFields;
|
|
3044
|
-
registrationClosed?: RegistrationClosedMessagesNonNullableFields;
|
|
3045
|
-
ticketsUnavailable?: TicketsUnavailableMessagesNonNullableFields;
|
|
3046
|
-
}
|
|
3047
|
-
export interface FormNonNullableFields {
|
|
3048
|
-
controls: InputControlNonNullableFields[];
|
|
3049
|
-
messages?: FormMessagesNonNullableFields;
|
|
3050
|
-
}
|
|
3051
|
-
export interface GetFormResponseNonNullableFields {
|
|
3052
|
-
form?: FormNonNullableFields;
|
|
3053
|
-
draftForm?: FormNonNullableFields;
|
|
3054
|
-
}
|
|
3055
|
-
export interface AddControlResponseNonNullableFields {
|
|
3056
|
-
_id: string;
|
|
3057
|
-
form?: FormNonNullableFields;
|
|
3058
|
-
}
|
|
3059
|
-
export interface UpdateControlResponseNonNullableFields {
|
|
3060
|
-
form?: FormNonNullableFields;
|
|
3061
|
-
}
|
|
3062
|
-
export interface DeleteControlResponseNonNullableFields {
|
|
3063
|
-
form?: FormNonNullableFields;
|
|
3064
|
-
}
|
|
3065
|
-
export interface UpdateMessagesResponseNonNullableFields {
|
|
3066
|
-
form?: FormNonNullableFields;
|
|
3067
|
-
}
|
|
3068
|
-
export interface PublishDraftResponseNonNullableFields {
|
|
3069
|
-
form?: FormNonNullableFields;
|
|
3070
|
-
}
|
|
3071
|
-
export interface BaseEventMetadata {
|
|
2967
|
+
interface BaseEventMetadata {
|
|
3072
2968
|
/**
|
|
3073
2969
|
* App instance ID.
|
|
3074
2970
|
* @format GUID
|
|
@@ -3082,103 +2978,11 @@ export interface BaseEventMetadata {
|
|
|
3082
2978
|
/** The identification type and identity data. */
|
|
3083
2979
|
identity?: IdentificationData;
|
|
3084
2980
|
}
|
|
3085
|
-
|
|
2981
|
+
interface FormEventUpdatedEnvelope {
|
|
3086
2982
|
data: EventUpdated;
|
|
3087
2983
|
metadata: BaseEventMetadata;
|
|
3088
2984
|
}
|
|
3089
|
-
|
|
3090
|
-
* Triggered when a form is updated or published.
|
|
3091
|
-
* @permissionScope Read Events - all read permissions
|
|
3092
|
-
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
3093
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
3094
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
3095
|
-
* @permissionScope Manage Events - all permissions
|
|
3096
|
-
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
3097
|
-
* @permissionScope Manage Events
|
|
3098
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
3099
|
-
* @permissionScope Read Events
|
|
3100
|
-
* @permissionScopeId SCOPE.DC-EVENTS.READ-EVENTS
|
|
3101
|
-
* @permissionScope Manage Challenges
|
|
3102
|
-
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
3103
|
-
* @permissionScope Manage Portfolio
|
|
3104
|
-
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
3105
|
-
* @permissionScope Access Verticals by Automations
|
|
3106
|
-
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
3107
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
3108
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
3109
|
-
* @permissionScope Set Up Automations
|
|
3110
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
3111
|
-
* @permissionScope Manage Guest List
|
|
3112
|
-
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
3113
|
-
* @permissionScope Manage Events
|
|
3114
|
-
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
3115
|
-
* @permissionId WIX_EVENTS.READ_EVENTS
|
|
3116
|
-
* @webhook
|
|
3117
|
-
* @eventType wix.events.events.EventUpdated
|
|
3118
|
-
* @serviceIdentifier wix.events.form.FormBuilder
|
|
3119
|
-
* @slug event_updated
|
|
3120
|
-
*/
|
|
3121
|
-
export declare function onFormEventUpdated(handler: (event: FormEventUpdatedEnvelope) => void | Promise<void>): void;
|
|
3122
|
-
/**
|
|
3123
|
-
* Retrieves an event registration form.
|
|
3124
|
-
*
|
|
3125
|
-
* Retrieves both the draft and published versions.
|
|
3126
|
-
* @param eventId - Event ID to which the form belongs.
|
|
3127
|
-
* @public
|
|
3128
|
-
* @requiredField eventId
|
|
3129
|
-
* @param options - Optional fields.
|
|
3130
|
-
* @permissionId WIX_EVENTS.READ_EVENTS
|
|
3131
|
-
* @permissionScope Read Events - all read permissions
|
|
3132
|
-
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
3133
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
3134
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
3135
|
-
* @permissionScope Manage Events - all permissions
|
|
3136
|
-
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
3137
|
-
* @permissionScope Manage Events
|
|
3138
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
3139
|
-
* @permissionScope Read Events
|
|
3140
|
-
* @permissionScopeId SCOPE.DC-EVENTS.READ-EVENTS
|
|
3141
|
-
* @permissionScope Manage Challenges
|
|
3142
|
-
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
3143
|
-
* @permissionScope Manage Portfolio
|
|
3144
|
-
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
3145
|
-
* @permissionScope Access Verticals by Automations
|
|
3146
|
-
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
3147
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
3148
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
3149
|
-
* @permissionScope Set Up Automations
|
|
3150
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
3151
|
-
* @permissionScope Manage Guest List
|
|
3152
|
-
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
3153
|
-
* @permissionScope Manage Events
|
|
3154
|
-
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
3155
|
-
* @applicableIdentity APP
|
|
3156
|
-
* @applicableIdentity VISITOR
|
|
3157
|
-
* @returns Currently published event form.
|
|
3158
|
-
* Published form is visible to site visitors.
|
|
3159
|
-
* @fqn wix.events.form.FormBuilder.GetForm
|
|
3160
|
-
*/
|
|
3161
|
-
export declare function getForm(eventId: string): Promise<Form & FormNonNullableFields>;
|
|
3162
|
-
/**
|
|
3163
|
-
* Adds an input control to the draft form.
|
|
3164
|
-
* @param eventId - Event ID to which the form belongs.
|
|
3165
|
-
* @public
|
|
3166
|
-
* @requiredField eventId
|
|
3167
|
-
* @requiredField options
|
|
3168
|
-
* @requiredField options.control
|
|
3169
|
-
* @param options - Optional fields.
|
|
3170
|
-
* @permissionId WIX_EVENTS.MANAGE_EVENTS
|
|
3171
|
-
* @permissionScope Manage Events - all permissions
|
|
3172
|
-
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
3173
|
-
* @permissionScope Manage Events
|
|
3174
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
3175
|
-
* @permissionScope Manage Events
|
|
3176
|
-
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
3177
|
-
* @applicableIdentity APP
|
|
3178
|
-
* @fqn wix.events.form.FormBuilder.AddControl
|
|
3179
|
-
*/
|
|
3180
|
-
export declare function addControl(eventId: string, options: AddControlOptions): Promise<AddControlResponse & AddControlResponseNonNullableFields>;
|
|
3181
|
-
export interface AddControlOptions extends AddControlOptionsControlOneOf {
|
|
2985
|
+
interface AddControlOptions extends AddControlOptionsControlOneOf {
|
|
3182
2986
|
/** Phone number input control. */
|
|
3183
2987
|
phone?: PhoneControl;
|
|
3184
2988
|
/** Single-line or full address input control. */
|
|
@@ -3197,7 +3001,7 @@ export interface AddControlOptions extends AddControlOptionsControlOneOf {
|
|
|
3197
3001
|
radioButton?: RadioButtonControl;
|
|
3198
3002
|
}
|
|
3199
3003
|
/** @oneof */
|
|
3200
|
-
|
|
3004
|
+
interface AddControlOptionsControlOneOf {
|
|
3201
3005
|
/** Phone number input control. */
|
|
3202
3006
|
phone?: PhoneControl;
|
|
3203
3007
|
/** Single-line or full address input control. */
|
|
@@ -3215,27 +3019,7 @@ export interface AddControlOptionsControlOneOf {
|
|
|
3215
3019
|
/** Single-choice radio button style input control. */
|
|
3216
3020
|
radioButton?: RadioButtonControl;
|
|
3217
3021
|
}
|
|
3218
|
-
|
|
3219
|
-
* Updates an existing input control in the draft form.
|
|
3220
|
-
* @public
|
|
3221
|
-
* @requiredField identifiers
|
|
3222
|
-
* @requiredField identifiers._id
|
|
3223
|
-
* @requiredField identifiers.eventId
|
|
3224
|
-
* @requiredField options.control
|
|
3225
|
-
* @param options - Optional fields.
|
|
3226
|
-
* @param identifiers - Identifies what form to update.
|
|
3227
|
-
* @permissionId WIX_EVENTS.MANAGE_EVENTS
|
|
3228
|
-
* @permissionScope Manage Events - all permissions
|
|
3229
|
-
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
3230
|
-
* @permissionScope Manage Events
|
|
3231
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
3232
|
-
* @permissionScope Manage Events
|
|
3233
|
-
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
3234
|
-
* @applicableIdentity APP
|
|
3235
|
-
* @fqn wix.events.form.FormBuilder.UpdateControl
|
|
3236
|
-
*/
|
|
3237
|
-
export declare function updateControl(identifiers: UpdateControlIdentifiers, options?: UpdateControlOptions): Promise<UpdateControlResponse & UpdateControlResponseNonNullableFields>;
|
|
3238
|
-
export interface UpdateControlIdentifiers extends UpdateControlIdentifiersControlOneOf {
|
|
3022
|
+
interface UpdateControlIdentifiers extends UpdateControlIdentifiersControlOneOf {
|
|
3239
3023
|
/**
|
|
3240
3024
|
* Event ID to which the form belongs.
|
|
3241
3025
|
* @format GUID
|
|
@@ -3245,7 +3029,7 @@ export interface UpdateControlIdentifiers extends UpdateControlIdentifiersContro
|
|
|
3245
3029
|
_id: string;
|
|
3246
3030
|
}
|
|
3247
3031
|
/** @oneof */
|
|
3248
|
-
|
|
3032
|
+
interface UpdateControlIdentifiersControlOneOf {
|
|
3249
3033
|
/** Phone number input control. */
|
|
3250
3034
|
phone?: PhoneControl;
|
|
3251
3035
|
/** Single-line or full address input control. */
|
|
@@ -3267,7 +3051,7 @@ export interface UpdateControlIdentifiersControlOneOf {
|
|
|
3267
3051
|
/** Single-choice radio style input control. */
|
|
3268
3052
|
radioButton?: RadioButtonControl;
|
|
3269
3053
|
}
|
|
3270
|
-
|
|
3054
|
+
interface UpdateControlOptions extends UpdateControlOptionsControlOneOf {
|
|
3271
3055
|
/** Index used to sort input controls in ascending order. */
|
|
3272
3056
|
orderIndex?: number;
|
|
3273
3057
|
/** Phone number input control. */
|
|
@@ -3292,7 +3076,7 @@ export interface UpdateControlOptions extends UpdateControlOptionsControlOneOf {
|
|
|
3292
3076
|
radioButton?: RadioButtonControl;
|
|
3293
3077
|
}
|
|
3294
3078
|
/** @oneof */
|
|
3295
|
-
|
|
3079
|
+
interface UpdateControlOptionsControlOneOf {
|
|
3296
3080
|
/** Phone number input control. */
|
|
3297
3081
|
phone?: PhoneControl;
|
|
3298
3082
|
/** Single-line or full address input control. */
|
|
@@ -3314,25 +3098,7 @@ export interface UpdateControlOptionsControlOneOf {
|
|
|
3314
3098
|
/** Single-choice radio style input control. */
|
|
3315
3099
|
radioButton?: RadioButtonControl;
|
|
3316
3100
|
}
|
|
3317
|
-
|
|
3318
|
-
* Deletes an input control from the draft form.
|
|
3319
|
-
* @public
|
|
3320
|
-
* @requiredField identifiers
|
|
3321
|
-
* @requiredField identifiers._id
|
|
3322
|
-
* @requiredField identifiers.eventId
|
|
3323
|
-
* @param identifiers - Identifies what form to delete.
|
|
3324
|
-
* @permissionId WIX_EVENTS.MANAGE_EVENTS
|
|
3325
|
-
* @permissionScope Manage Events - all permissions
|
|
3326
|
-
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
3327
|
-
* @permissionScope Manage Events
|
|
3328
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
3329
|
-
* @permissionScope Manage Events
|
|
3330
|
-
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
3331
|
-
* @applicableIdentity APP
|
|
3332
|
-
* @fqn wix.events.form.FormBuilder.DeleteControl
|
|
3333
|
-
*/
|
|
3334
|
-
export declare function deleteControl(identifiers: DeleteControlIdentifiers): Promise<DeleteControlResponse & DeleteControlResponseNonNullableFields>;
|
|
3335
|
-
export interface DeleteControlIdentifiers {
|
|
3101
|
+
interface DeleteControlIdentifiers {
|
|
3336
3102
|
/**
|
|
3337
3103
|
* Event ID to which the form belongs.
|
|
3338
3104
|
* @format GUID
|
|
@@ -3344,25 +3110,7 @@ export interface DeleteControlIdentifiers {
|
|
|
3344
3110
|
*/
|
|
3345
3111
|
_id: string;
|
|
3346
3112
|
}
|
|
3347
|
-
|
|
3348
|
-
* Updates a set of defined form messages that are displayed to a site visitor before, during, and after the registration flow.
|
|
3349
|
-
* Includes the configuration of form titles, response labels, "thank you" messages, and call-to-action texts.
|
|
3350
|
-
* @param eventId - Event ID to which the form belongs.
|
|
3351
|
-
* @public
|
|
3352
|
-
* @requiredField eventId
|
|
3353
|
-
* @param options - Optional fields.
|
|
3354
|
-
* @permissionId WIX_EVENTS.MANAGE_EVENTS
|
|
3355
|
-
* @permissionScope Manage Events - all permissions
|
|
3356
|
-
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
3357
|
-
* @permissionScope Manage Events
|
|
3358
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
3359
|
-
* @permissionScope Manage Events
|
|
3360
|
-
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
3361
|
-
* @applicableIdentity APP
|
|
3362
|
-
* @fqn wix.events.form.FormBuilder.UpdateMessages
|
|
3363
|
-
*/
|
|
3364
|
-
export declare function updateMessages(eventId: string, options?: UpdateMessagesOptions): Promise<UpdateMessagesResponse & UpdateMessagesResponseNonNullableFields>;
|
|
3365
|
-
export interface UpdateMessagesOptions {
|
|
3113
|
+
interface UpdateMessagesOptions {
|
|
3366
3114
|
/**
|
|
3367
3115
|
* Set of field paths, specifying which parts of this resource to update.
|
|
3368
3116
|
* When fields are empty, request is interpreted as full update.
|
|
@@ -3372,36 +3120,5 @@ export interface UpdateMessagesOptions {
|
|
|
3372
3120
|
/** Set of configured form messages to update. */
|
|
3373
3121
|
messages?: FormMessages;
|
|
3374
3122
|
}
|
|
3375
|
-
|
|
3376
|
-
|
|
3377
|
-
* @param eventId - Event ID to which the form belongs.
|
|
3378
|
-
* @public
|
|
3379
|
-
* @requiredField eventId
|
|
3380
|
-
* @permissionId WIX_EVENTS.MANAGE_EVENTS
|
|
3381
|
-
* @permissionScope Manage Events - all permissions
|
|
3382
|
-
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
3383
|
-
* @permissionScope Manage Events
|
|
3384
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
3385
|
-
* @permissionScope Manage Events
|
|
3386
|
-
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
3387
|
-
* @applicableIdentity APP
|
|
3388
|
-
* @fqn wix.events.form.FormBuilder.PublishDraft
|
|
3389
|
-
*/
|
|
3390
|
-
export declare function publishDraft(eventId: string): Promise<PublishDraftResponse & PublishDraftResponseNonNullableFields>;
|
|
3391
|
-
/**
|
|
3392
|
-
* Clears all changes to the draft form.
|
|
3393
|
-
* @param eventId - Event ID to which the form belongs.
|
|
3394
|
-
* @public
|
|
3395
|
-
* @requiredField eventId
|
|
3396
|
-
* @permissionId WIX_EVENTS.MANAGE_EVENTS
|
|
3397
|
-
* @permissionScope Manage Events - all permissions
|
|
3398
|
-
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
3399
|
-
* @permissionScope Manage Events
|
|
3400
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
3401
|
-
* @permissionScope Manage Events
|
|
3402
|
-
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
3403
|
-
* @applicableIdentity APP
|
|
3404
|
-
* @fqn wix.events.form.FormBuilder.DiscardDraft
|
|
3405
|
-
*/
|
|
3406
|
-
export declare function discardDraft(eventId: string): Promise<void>;
|
|
3407
|
-
export {};
|
|
3123
|
+
|
|
3124
|
+
export { VerticalAlignment as $, type AddControlOptions as A, ButtonDataType as B, ConferenceType as C, type DeleteControlIdentifiers as D, EventStatus as E, type Form as F, GIFType as G, PollLayoutType as H, InputControlType as I, PollLayoutDirection as J, BackgroundType as K, LocationType as L, MapType as M, NodeType as N, Orientation as O, type PublishDraftResponse as P, DecorationType as Q, RequestedFields as R, SubdivisionType as S, TaxType as T, type UpdateControlIdentifiers as U, ValueType as V, WidthType as W, FontType as X, AppType as Y, InitialExpandedItems as Z, Direction as _, type AddControlResponse as a, type ExternalEvent as a$, NullValue as a0, Type as a1, WebhookIdentityType as a2, type InputControl as a3, type Input as a4, type OptionSelection as a5, type OptionSelectionSelectedOptionOneOf as a6, type Label as a7, type FormMessages as a8, type RsvpFormMessages as a9, type UpdateControlRequestControlOneOf as aA, type NameControl as aB, type NameControlLabels as aC, type EmailControl as aD, type DeleteControlRequest as aE, type UpdateMessagesRequest as aF, type PublishDraftRequest as aG, type EventUpdated as aH, type Location as aI, type MapCoordinates as aJ, type Address as aK, type AddressStreetOneOf as aL, type StreetAddress as aM, type AddressLocation as aN, type Subdivision as aO, type ScheduleConfig as aP, type Recurrences as aQ, type Occurrence as aR, type Event as aS, type Scheduling as aT, type Registration as aU, type RsvpCollection as aV, type RsvpCollectionConfig as aW, type Ticketing as aX, type TicketingConfig as aY, type TaxConfig as aZ, type Money as a_, type PositiveResponseConfirmation as aa, type NegativeResponseConfirmation as ab, type Positive as ac, type Negative as ad, type CheckoutFormMessages as ae, type ResponseConfirmation as af, type RegistrationClosedMessages as ag, type TicketsUnavailableMessages as ah, type FormInputControlAdded as ai, type FormInputControlUpdated as aj, type FormInputControlDeleted as ak, type GetFormRequest as al, type GetFormResponse as am, type AddControlRequest as an, type AddControlRequestControlOneOf as ao, type PhoneControl as ap, type AddressControl as aq, type AddressControlLabels as ar, type DateControl as as, type AdditionalGuestsControl as at, type Labels as au, type DropdownControl as av, type RadioButtonControl as aw, type CheckboxControl as ax, type TextControl as ay, type UpdateControlRequest as az, type UpdateControlOptions as b, type MapData as b$, type CalendarLinks as b0, type SiteUrl as b1, type Dashboard as b2, type RsvpSummary as b3, type TicketingSummary as b4, type GuestListConfig as b5, type Feed as b6, type OnlineConferencing as b7, type OnlineConferencingConfig as b8, type OnlineConferencingSession as b9, type CodeBlockData as bA, type TextStyle as bB, type DividerData as bC, type FileData as bD, type FileSource as bE, type FileSourceDataOneOf as bF, type PDFSettings as bG, type GalleryData as bH, type Media as bI, type Image as bJ, type Video as bK, type Item as bL, type ItemDataOneOf as bM, type GalleryOptions as bN, type Layout as bO, type ItemStyle as bP, type Thumbnails as bQ, type GIFData as bR, type GIF as bS, type HeadingData as bT, type HTMLData as bU, type HTMLDataDataOneOf as bV, type ImageData as bW, type StylesBorder as bX, type ImageDataStyles as bY, type LinkPreviewData as bZ, type LinkPreviewDataStyles as b_, type SeoSettings as ba, type SeoSchema as bb, type Keyword as bc, type Tag as bd, type Settings as be, type Agenda as bf, type Category as bg, type CategoryCounts as bh, type EventDisplaySettings as bi, type LabellingSettings as bj, type RichContent as bk, type Node as bl, type NodeDataOneOf as bm, type NodeStyle as bn, type ButtonData as bo, type Border as bp, type Colors as bq, type PluginContainerData as br, type PluginContainerDataWidth as bs, type PluginContainerDataWidthDataOneOf as bt, type Spoiler as bu, type Height as bv, type Styles as bw, type Link as bx, type LinkDataOneOf as by, type Rel as bz, type UpdateControlResponse as c, type FormEventUpdatedEnvelope as c$, type MapSettings as c0, type ParagraphData as c1, type PollData as c2, type Permissions as c3, type Option as c4, type PollSettings as c5, type PollLayout as c6, type OptionLayout as c7, type Gradient as c8, type Background as c9, type TableCellData as cA, type CellStyle as cB, type BorderColors as cC, type ListValue as cD, type AudioData as cE, type OrderedListData as cF, type BulletedListData as cG, type BlockquoteData as cH, type CaptionData as cI, type LayoutCellData as cJ, type Metadata as cK, type DocumentStyle as cL, type TextNodeStyle as cM, type Badge as cN, type DiscardDraftRequest as cO, type DiscardDraftResponse as cP, type DomainEvent as cQ, type DomainEventBodyOneOf as cR, type EntityCreatedEvent as cS, type RestoreInfo as cT, type EntityUpdatedEvent as cU, type EntityDeletedEvent as cV, type ActionEvent as cW, type MessageEnvelope as cX, type IdentificationData as cY, type IdentificationDataIdOneOf as cZ, type BaseEventMetadata as c_, type BackgroundBackgroundOneOf as ca, type PollDesign as cb, type OptionDesign as cc, type Poll as cd, type PollDataLayout as ce, type Design as cf, type TextData as cg, type Decoration as ch, type DecorationDataOneOf as ci, type AnchorData as cj, type ColorData as ck, type LinkData as cl, type MentionData as cm, type FontSizeData as cn, type SpoilerData as co, type AppEmbedData as cp, type AppEmbedDataAppDataOneOf as cq, type BookingData as cr, type EventData as cs, type VideoData as ct, type PlaybackOptions as cu, type EmbedData as cv, type Oembed as cw, type CollapsibleListData as cx, type TableData as cy, type Dimensions as cz, type DeleteControlResponse as d, type AddControlOptionsControlOneOf as d0, type UpdateControlIdentifiersControlOneOf as d1, type UpdateControlOptionsControlOneOf as d2, type UpdateMessagesOptions as e, type UpdateMessagesResponse as f, Status as g, EventType as h, RegistrationStatus as i, RsvpStatusOptions as j, VisitorType as k, State as l, PluginContainerDataAlignment as m, Target as n, TextAlignment as o, LineStyle as p, Width as q, Alignment as r, ViewMode as s, LayoutType as t, Crop as u, ThumbnailsAlignment as v, Source as w, Position as x, ViewRole as y, VoteRole as z };
|