@wix/auto_sdk_events_forms 1.0.22 → 1.0.24

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.
Files changed (133) hide show
  1. package/build/cjs/index.d.ts +1 -0
  2. package/build/cjs/index.js +18 -0
  3. package/build/cjs/index.js.map +1 -0
  4. package/build/cjs/index.typings.d.ts +1 -0
  5. package/build/cjs/index.typings.js +18 -0
  6. package/build/cjs/index.typings.js.map +1 -0
  7. package/build/cjs/meta.d.ts +1 -0
  8. package/build/cjs/meta.js +18 -0
  9. package/build/cjs/meta.js.map +1 -0
  10. package/build/cjs/src/events-v1-form-forms.context.d.ts +17 -0
  11. package/build/cjs/src/events-v1-form-forms.context.js +67 -0
  12. package/build/cjs/src/events-v1-form-forms.context.js.map +1 -0
  13. package/build/cjs/src/events-v1-form-forms.http.d.ts +22 -0
  14. package/build/cjs/src/events-v1-form-forms.http.js +653 -0
  15. package/build/cjs/src/events-v1-form-forms.http.js.map +1 -0
  16. package/build/cjs/src/events-v1-form-forms.meta.d.ts +35 -0
  17. package/build/cjs/src/events-v1-form-forms.meta.js +161 -0
  18. package/build/cjs/src/events-v1-form-forms.meta.js.map +1 -0
  19. package/build/cjs/src/events-v1-form-forms.public.d.ts +72 -0
  20. package/build/cjs/src/events-v1-form-forms.public.js +202 -0
  21. package/build/cjs/src/events-v1-form-forms.public.js.map +1 -0
  22. package/build/cjs/src/events-v1-form-forms.types.d.ts +2991 -0
  23. package/build/cjs/src/events-v1-form-forms.types.js +488 -0
  24. package/build/cjs/src/events-v1-form-forms.types.js.map +1 -0
  25. package/build/{events-v1-form-forms.universal-DsBBfrf9.d.mts → cjs/src/events-v1-form-forms.universal.d.ts} +442 -251
  26. package/build/cjs/src/events-v1-form-forms.universal.js +867 -0
  27. package/build/cjs/src/events-v1-form-forms.universal.js.map +1 -0
  28. package/build/es/index.d.ts +1 -0
  29. package/build/es/index.js +2 -0
  30. package/build/es/index.js.map +1 -0
  31. package/build/es/index.typings.d.ts +1 -0
  32. package/build/es/index.typings.js +2 -0
  33. package/build/es/index.typings.js.map +1 -0
  34. package/build/es/meta.d.ts +1 -0
  35. package/build/es/meta.js +2 -0
  36. package/build/es/meta.js.map +1 -0
  37. package/build/es/src/events-v1-form-forms.context.d.ts +17 -0
  38. package/build/es/src/events-v1-form-forms.context.js +17 -0
  39. package/build/es/src/events-v1-form-forms.context.js.map +1 -0
  40. package/build/es/src/events-v1-form-forms.http.d.ts +22 -0
  41. package/build/es/src/events-v1-form-forms.http.js +643 -0
  42. package/build/es/src/events-v1-form-forms.http.js.map +1 -0
  43. package/build/es/src/events-v1-form-forms.meta.d.ts +35 -0
  44. package/build/es/src/events-v1-form-forms.meta.js +128 -0
  45. package/build/es/src/events-v1-form-forms.meta.js.map +1 -0
  46. package/build/es/src/events-v1-form-forms.public.d.ts +72 -0
  47. package/build/es/src/events-v1-form-forms.public.js +145 -0
  48. package/build/es/src/events-v1-form-forms.public.js.map +1 -0
  49. package/build/es/src/events-v1-form-forms.types.d.ts +2991 -0
  50. package/build/es/src/events-v1-form-forms.types.js +485 -0
  51. package/build/es/src/events-v1-form-forms.types.js.map +1 -0
  52. package/build/{events-v1-form-forms.universal-DsBBfrf9.d.ts → es/src/events-v1-form-forms.universal.d.ts} +442 -251
  53. package/build/es/src/events-v1-form-forms.universal.js +833 -0
  54. package/build/es/src/events-v1-form-forms.universal.js.map +1 -0
  55. package/build/internal/cjs/index.d.ts +1 -0
  56. package/build/internal/cjs/index.js +18 -0
  57. package/build/internal/cjs/index.js.map +1 -0
  58. package/build/internal/cjs/index.typings.d.ts +1 -0
  59. package/build/internal/cjs/index.typings.js +18 -0
  60. package/build/internal/cjs/index.typings.js.map +1 -0
  61. package/build/internal/cjs/meta.d.ts +1 -0
  62. package/build/internal/cjs/meta.js +18 -0
  63. package/build/internal/cjs/meta.js.map +1 -0
  64. package/build/internal/cjs/src/events-v1-form-forms.context.d.ts +17 -0
  65. package/build/internal/cjs/src/events-v1-form-forms.context.js +67 -0
  66. package/build/internal/cjs/src/events-v1-form-forms.context.js.map +1 -0
  67. package/build/internal/cjs/src/events-v1-form-forms.http.d.ts +22 -0
  68. package/build/internal/cjs/src/events-v1-form-forms.http.js +653 -0
  69. package/build/internal/cjs/src/events-v1-form-forms.http.js.map +1 -0
  70. package/build/internal/cjs/src/events-v1-form-forms.meta.d.ts +35 -0
  71. package/build/internal/cjs/src/events-v1-form-forms.meta.js +161 -0
  72. package/build/internal/cjs/src/events-v1-form-forms.meta.js.map +1 -0
  73. package/build/internal/cjs/src/events-v1-form-forms.public.d.ts +72 -0
  74. package/build/internal/cjs/src/events-v1-form-forms.public.js +202 -0
  75. package/build/internal/cjs/src/events-v1-form-forms.public.js.map +1 -0
  76. package/build/internal/cjs/src/events-v1-form-forms.types.d.ts +2991 -0
  77. package/build/internal/cjs/src/events-v1-form-forms.types.js +488 -0
  78. package/build/internal/cjs/src/events-v1-form-forms.types.js.map +1 -0
  79. package/build/internal/{events-v1-form-forms.universal-DsBBfrf9.d.mts → cjs/src/events-v1-form-forms.universal.d.ts} +442 -251
  80. package/build/internal/cjs/src/events-v1-form-forms.universal.js +867 -0
  81. package/build/internal/cjs/src/events-v1-form-forms.universal.js.map +1 -0
  82. package/build/internal/es/index.d.ts +1 -0
  83. package/build/internal/es/index.js +2 -0
  84. package/build/internal/es/index.js.map +1 -0
  85. package/build/internal/es/index.typings.d.ts +1 -0
  86. package/build/internal/es/index.typings.js +2 -0
  87. package/build/internal/es/index.typings.js.map +1 -0
  88. package/build/internal/es/meta.d.ts +1 -0
  89. package/build/internal/es/meta.js +2 -0
  90. package/build/internal/es/meta.js.map +1 -0
  91. package/build/internal/es/src/events-v1-form-forms.context.d.ts +17 -0
  92. package/build/internal/es/src/events-v1-form-forms.context.js +17 -0
  93. package/build/internal/es/src/events-v1-form-forms.context.js.map +1 -0
  94. package/build/internal/es/src/events-v1-form-forms.http.d.ts +22 -0
  95. package/build/internal/es/src/events-v1-form-forms.http.js +643 -0
  96. package/build/internal/es/src/events-v1-form-forms.http.js.map +1 -0
  97. package/build/internal/es/src/events-v1-form-forms.meta.d.ts +35 -0
  98. package/build/internal/es/src/events-v1-form-forms.meta.js +128 -0
  99. package/build/internal/es/src/events-v1-form-forms.meta.js.map +1 -0
  100. package/build/internal/es/src/events-v1-form-forms.public.d.ts +72 -0
  101. package/build/internal/es/src/events-v1-form-forms.public.js +145 -0
  102. package/build/internal/es/src/events-v1-form-forms.public.js.map +1 -0
  103. package/build/internal/es/src/events-v1-form-forms.types.d.ts +2991 -0
  104. package/build/internal/es/src/events-v1-form-forms.types.js +485 -0
  105. package/build/internal/es/src/events-v1-form-forms.types.js.map +1 -0
  106. package/build/internal/{events-v1-form-forms.universal-DsBBfrf9.d.ts → es/src/events-v1-form-forms.universal.d.ts} +442 -251
  107. package/build/internal/es/src/events-v1-form-forms.universal.js +833 -0
  108. package/build/internal/es/src/events-v1-form-forms.universal.js.map +1 -0
  109. package/package.json +11 -12
  110. package/build/index.d.mts +0 -84
  111. package/build/index.d.ts +0 -84
  112. package/build/index.js +0 -1512
  113. package/build/index.js.map +0 -1
  114. package/build/index.mjs +0 -1435
  115. package/build/index.mjs.map +0 -1
  116. package/build/internal/index.d.mts +0 -84
  117. package/build/internal/index.d.ts +0 -84
  118. package/build/internal/index.js +0 -1512
  119. package/build/internal/index.js.map +0 -1
  120. package/build/internal/index.mjs +0 -1435
  121. package/build/internal/index.mjs.map +0 -1
  122. package/build/internal/meta.d.mts +0 -648
  123. package/build/internal/meta.d.ts +0 -648
  124. package/build/internal/meta.js +0 -800
  125. package/build/internal/meta.js.map +0 -1
  126. package/build/internal/meta.mjs +0 -767
  127. package/build/internal/meta.mjs.map +0 -1
  128. package/build/meta.d.mts +0 -648
  129. package/build/meta.d.ts +0 -648
  130. package/build/meta.js +0 -800
  131. package/build/meta.js.map +0 -1
  132. package/build/meta.mjs +0 -767
  133. package/build/meta.mjs.map +0 -1
@@ -1,3 +1,4 @@
1
+ import { NonNullablePaths } from '@wix/sdk-types';
1
2
  /**
2
3
  * The form defines which elements are displayed to a site visitor during the registration process (RSVP or checkout).
3
4
  * It also contains customizable messages and labels.
@@ -11,7 +12,7 @@
11
12
  *
12
13
  * By default, name and email controls are always required and are pinned to the top of the form.
13
14
  */
14
- interface Form {
15
+ export interface Form {
15
16
  /** Nested fields as an ordered list. */
16
17
  controls?: InputControl[];
17
18
  /**
@@ -24,7 +25,7 @@ interface Form {
24
25
  * A block of nested fields.
25
26
  * Used to aggregate similar inputs like First Name and Last Name.
26
27
  */
27
- interface InputControl {
28
+ export interface InputControl {
28
29
  /** Field control type. */
29
30
  type?: InputControlType;
30
31
  /** Whether the control is mandatory (such as `name` & `email`). When `true`, only the label can be changed. */
@@ -51,7 +52,7 @@ interface InputControl {
51
52
  */
52
53
  deleted?: boolean | null;
53
54
  }
54
- declare enum InputControlType {
55
+ export declare enum InputControlType {
55
56
  /** Single text value field. */
56
57
  INPUT = "INPUT",
57
58
  /** Single text value field with multiple lines. */
@@ -74,7 +75,7 @@ declare enum InputControlType {
74
75
  DATE = "DATE"
75
76
  }
76
77
  /** Child inputs. */
77
- interface Input {
78
+ export interface Input {
78
79
  /** Field name. */
79
80
  name?: string;
80
81
  /**
@@ -116,7 +117,7 @@ interface Input {
116
117
  */
117
118
  labels?: Label[];
118
119
  }
119
- declare enum ValueType {
120
+ export declare enum ValueType {
120
121
  TEXT = "TEXT",
121
122
  NUMBER = "NUMBER",
122
123
  TEXT_ARRAY = "TEXT_ARRAY",
@@ -127,7 +128,7 @@ declare enum ValueType {
127
128
  * Describes initially selected option when an input has multiple choices.
128
129
  * Defaults to first (0th) option if not configured.
129
130
  */
130
- interface OptionSelection extends OptionSelectionSelectedOptionOneOf {
131
+ export interface OptionSelection extends OptionSelectionSelectedOptionOneOf {
131
132
  /**
132
133
  * 0-based index from predefined `controls.inputs.options` which is initial selection.
133
134
  * @max 199
@@ -141,7 +142,7 @@ interface OptionSelection extends OptionSelectionSelectedOptionOneOf {
141
142
  placeholderText?: string;
142
143
  }
143
144
  /** @oneof */
144
- interface OptionSelectionSelectedOptionOneOf {
145
+ export interface OptionSelectionSelectedOptionOneOf {
145
146
  /**
146
147
  * 0-based index from predefined `controls.inputs.options` which is initial selection.
147
148
  * @max 199
@@ -154,7 +155,7 @@ interface OptionSelectionSelectedOptionOneOf {
154
155
  */
155
156
  placeholderText?: string;
156
157
  }
157
- interface Label {
158
+ export interface Label {
158
159
  /** Field name. */
159
160
  name?: string;
160
161
  /** Field label. */
@@ -164,7 +165,7 @@ interface Label {
164
165
  * Defines form messages shown in UI before, during, and after registration flow.
165
166
  * It enables configuration of form titles, response labels, "thank you" messages, and call-to-action texts.
166
167
  */
167
- interface FormMessages {
168
+ export interface FormMessages {
168
169
  /** 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
170
  rsvp?: RsvpFormMessages;
170
171
  /** Checkout form messages. */
@@ -174,7 +175,7 @@ interface FormMessages {
174
175
  /** Messages shown when event tickets are unavailable. */
175
176
  ticketsUnavailable?: TicketsUnavailableMessages;
176
177
  }
177
- interface RsvpFormMessages {
178
+ export interface RsvpFormMessages {
178
179
  /** Label text indicating RSVP's `status` is `"YES"`. */
179
180
  rsvpYesOption?: string;
180
181
  /** Label text indicating RSVP's `status` is `"NO"`. */
@@ -189,7 +190,7 @@ interface RsvpFormMessages {
189
190
  submitActionLabel?: string;
190
191
  }
191
192
  /** Confirmation messages shown after registration. */
192
- interface PositiveResponseConfirmation {
193
+ export interface PositiveResponseConfirmation {
193
194
  /** Confirmation message title. */
194
195
  title?: string;
195
196
  /** Confirmation message text. */
@@ -200,27 +201,27 @@ interface PositiveResponseConfirmation {
200
201
  shareActionLabel?: string;
201
202
  }
202
203
  /** Confirmation messages shown after registration. */
203
- interface NegativeResponseConfirmation {
204
+ export interface NegativeResponseConfirmation {
204
205
  /** Confirmation message title. */
205
206
  title?: string;
206
207
  /** "Share event" call-to-action label text. */
207
208
  shareActionLabel?: string;
208
209
  }
209
210
  /** Set of messages shown during registration when RSVP response is positive. */
210
- interface Positive {
211
+ export interface Positive {
211
212
  /** Main form title for positive response. */
212
213
  title?: string;
213
214
  /** Confirmation messages shown after registration. */
214
215
  confirmation?: PositiveResponseConfirmation;
215
216
  }
216
217
  /** A set of messages shown during registration with negative response */
217
- interface Negative {
218
+ export interface Negative {
218
219
  /** Main form title for negative response. */
219
220
  title?: string;
220
221
  /** Confirmation messages shown after registration. */
221
222
  confirmation?: NegativeResponseConfirmation;
222
223
  }
223
- interface CheckoutFormMessages {
224
+ export interface CheckoutFormMessages {
224
225
  /** Main form title for response. */
225
226
  title?: string;
226
227
  /** Submit form call-to-action label text. */
@@ -229,7 +230,7 @@ interface CheckoutFormMessages {
229
230
  confirmation?: ResponseConfirmation;
230
231
  }
231
232
  /** Confirmation messages shown after checkout. */
232
- interface ResponseConfirmation {
233
+ export interface ResponseConfirmation {
233
234
  /** Confirmation message title. */
234
235
  title?: string;
235
236
  /** Confirmation message text. */
@@ -241,49 +242,49 @@ interface ResponseConfirmation {
241
242
  /** "Share event" call-to-action label text. */
242
243
  shareEventLabel?: string;
243
244
  }
244
- interface RegistrationClosedMessages {
245
+ export interface RegistrationClosedMessages {
245
246
  /** Message shown when event registration is closed. */
246
247
  message?: string;
247
248
  /** "Explore other events" call-to-action label text. */
248
249
  exploreEventsActionLabel?: string;
249
250
  }
250
- interface TicketsUnavailableMessages {
251
+ export interface TicketsUnavailableMessages {
251
252
  /** Message shown when event tickets are unavailable. */
252
253
  message?: string;
253
254
  /** "Explore other events" call-to-action label text. */
254
255
  exploreEventsActionLabel?: string;
255
256
  }
256
- interface FormInputControlAdded {
257
+ export interface FormInputControlAdded {
257
258
  /** Event ID. */
258
259
  eventId?: string;
259
260
  /** Input control. */
260
261
  inputControl?: InputControl;
261
262
  }
262
- interface FormInputControlUpdated {
263
+ export interface FormInputControlUpdated {
263
264
  /** Event ID. */
264
265
  eventId?: string;
265
266
  /** Input control. */
266
267
  updatedInputControl?: InputControl;
267
268
  }
268
- interface FormInputControlDeleted {
269
+ export interface FormInputControlDeleted {
269
270
  /** Event ID. */
270
271
  eventId?: string;
271
272
  /** Input control. */
272
273
  deletedInputControl?: InputControl;
273
274
  }
274
- interface GetFormRequest {
275
+ export interface GetFormRequest {
275
276
  /**
276
277
  * Event ID to which the form belongs.
277
278
  * @format GUID
278
279
  */
279
280
  eventId: string;
280
281
  }
281
- declare enum RequestedFields {
282
+ export declare enum RequestedFields {
282
283
  UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
283
284
  /** Include soft deleted input controls in the response. */
284
285
  DELETED = "DELETED"
285
286
  }
286
- interface GetFormResponse {
287
+ export interface GetFormResponse {
287
288
  /**
288
289
  * Currently published event form.
289
290
  * Published form is visible to site visitors.
@@ -295,7 +296,7 @@ interface GetFormResponse {
295
296
  */
296
297
  draftForm?: Form;
297
298
  }
298
- interface AddControlRequest extends AddControlRequestControlOneOf {
299
+ export interface AddControlRequest extends AddControlRequestControlOneOf {
299
300
  /** Phone number input control. */
300
301
  phone?: PhoneControl;
301
302
  /** Single-line or full address input control. */
@@ -319,7 +320,7 @@ interface AddControlRequest extends AddControlRequestControlOneOf {
319
320
  eventId: string;
320
321
  }
321
322
  /** @oneof */
322
- interface AddControlRequestControlOneOf {
323
+ export interface AddControlRequestControlOneOf {
323
324
  /** Phone number input control. */
324
325
  phone?: PhoneControl;
325
326
  /** Single-line or full address input control. */
@@ -337,7 +338,7 @@ interface AddControlRequestControlOneOf {
337
338
  /** Single-choice radio button style input control. */
338
339
  radioButton?: RadioButtonControl;
339
340
  }
340
- interface PhoneControl {
341
+ export interface PhoneControl {
341
342
  /**
342
343
  * Phone input label.
343
344
  * @maxLength 100
@@ -346,7 +347,7 @@ interface PhoneControl {
346
347
  /** Whether the phone input is required. */
347
348
  mandatory?: boolean;
348
349
  }
349
- interface AddressControl {
350
+ export interface AddressControl {
350
351
  /** Address control labels for each input. */
351
352
  labels?: AddressControlLabels;
352
353
  /** Whether an address is multi-line (consisting of multiple fields such as country, city, postal code). When `false`, address is single-line. */
@@ -354,7 +355,7 @@ interface AddressControl {
354
355
  /** Whether the address input is required. */
355
356
  mandatory?: boolean;
356
357
  }
357
- interface AddressControlLabels {
358
+ export interface AddressControlLabels {
358
359
  /**
359
360
  * Single-line address input label.
360
361
  * @maxLength 100
@@ -386,7 +387,7 @@ interface AddressControlLabels {
386
387
  */
387
388
  streetAddress?: string;
388
389
  }
389
- interface DateControl {
390
+ export interface DateControl {
390
391
  /**
391
392
  * Input control label.
392
393
  * @maxLength 100
@@ -395,7 +396,7 @@ interface DateControl {
395
396
  /** Whether the date input is required. */
396
397
  mandatory?: boolean;
397
398
  }
398
- interface AdditionalGuestsControl {
399
+ export interface AdditionalGuestsControl {
399
400
  /** Additional guests control labels for each input. */
400
401
  labels?: Labels;
401
402
  /** Whether the individual guest names are required. */
@@ -407,7 +408,7 @@ interface AdditionalGuestsControl {
407
408
  */
408
409
  maxGuests?: number;
409
410
  }
410
- interface Labels {
411
+ export interface Labels {
411
412
  /**
412
413
  * Input label for a single guest.
413
414
  * @maxLength 200
@@ -419,7 +420,7 @@ interface Labels {
419
420
  */
420
421
  multiple?: string;
421
422
  }
422
- interface DropdownControl {
423
+ export interface DropdownControl {
423
424
  /**
424
425
  * Input control label.
425
426
  * @maxLength 200
@@ -441,7 +442,7 @@ interface DropdownControl {
441
442
  */
442
443
  defaultOptionSelection?: OptionSelection;
443
444
  }
444
- interface RadioButtonControl {
445
+ export interface RadioButtonControl {
445
446
  /**
446
447
  * Input control label.
447
448
  * @maxLength 200
@@ -455,7 +456,7 @@ interface RadioButtonControl {
455
456
  */
456
457
  options?: string[];
457
458
  }
458
- interface CheckboxControl {
459
+ export interface CheckboxControl {
459
460
  /**
460
461
  * Input control label.
461
462
  * @maxLength 200
@@ -471,7 +472,7 @@ interface CheckboxControl {
471
472
  */
472
473
  options?: string[];
473
474
  }
474
- interface TextControl {
475
+ export interface TextControl {
475
476
  /**
476
477
  * Input control label.
477
478
  * @maxLength 200
@@ -489,13 +490,13 @@ interface TextControl {
489
490
  /** Whether the input control should be displayed as a comment. */
490
491
  comment?: boolean;
491
492
  }
492
- interface AddControlResponse {
493
+ export interface AddControlResponse {
493
494
  /** Generated unique input control ID. */
494
495
  _id?: string;
495
496
  /** Modified draft event form. */
496
497
  form?: Form;
497
498
  }
498
- interface UpdateControlRequest extends UpdateControlRequestControlOneOf {
499
+ export interface UpdateControlRequest extends UpdateControlRequestControlOneOf {
499
500
  /** Phone number input control. */
500
501
  phone?: PhoneControl;
501
502
  /** Single-line or full address input control. */
@@ -527,7 +528,7 @@ interface UpdateControlRequest extends UpdateControlRequestControlOneOf {
527
528
  orderIndex?: number;
528
529
  }
529
530
  /** @oneof */
530
- interface UpdateControlRequestControlOneOf {
531
+ export interface UpdateControlRequestControlOneOf {
531
532
  /** Phone number input control. */
532
533
  phone?: PhoneControl;
533
534
  /** Single-line or full address input control. */
@@ -549,11 +550,11 @@ interface UpdateControlRequestControlOneOf {
549
550
  /** Single-choice radio style input control. */
550
551
  radioButton?: RadioButtonControl;
551
552
  }
552
- interface NameControl {
553
+ export interface NameControl {
553
554
  /** Name control labels of each input. */
554
555
  labels?: NameControlLabels;
555
556
  }
556
- interface NameControlLabels {
557
+ export interface NameControlLabels {
557
558
  /**
558
559
  * First name input label.
559
560
  * @maxLength 100
@@ -565,18 +566,18 @@ interface NameControlLabels {
565
566
  */
566
567
  lastName?: string;
567
568
  }
568
- interface EmailControl {
569
+ export interface EmailControl {
569
570
  /**
570
571
  * Email input label.
571
572
  * @maxLength 100
572
573
  */
573
574
  label?: string;
574
575
  }
575
- interface UpdateControlResponse {
576
+ export interface UpdateControlResponse {
576
577
  /** Modified draft event form. */
577
578
  form?: Form;
578
579
  }
579
- interface DeleteControlRequest {
580
+ export interface DeleteControlRequest {
580
581
  /**
581
582
  * Event ID to which the form belongs.
582
583
  * @format GUID
@@ -588,11 +589,11 @@ interface DeleteControlRequest {
588
589
  */
589
590
  _id: string;
590
591
  }
591
- interface DeleteControlResponse {
592
+ export interface DeleteControlResponse {
592
593
  /** Modified draft event form. */
593
594
  form?: Form;
594
595
  }
595
- interface UpdateMessagesRequest {
596
+ export interface UpdateMessagesRequest {
596
597
  /**
597
598
  * Event ID to which the form belongs.
598
599
  * @format GUID
@@ -607,22 +608,22 @@ interface UpdateMessagesRequest {
607
608
  /** Set of configured form messages to update. */
608
609
  messages?: FormMessages;
609
610
  }
610
- interface UpdateMessagesResponse {
611
+ export interface UpdateMessagesResponse {
611
612
  /** Modified draft event form. */
612
613
  form?: Form;
613
614
  }
614
- interface PublishDraftRequest {
615
+ export interface PublishDraftRequest {
615
616
  /**
616
617
  * Event ID to which the form belongs.
617
618
  * @format GUID
618
619
  */
619
620
  eventId: string;
620
621
  }
621
- interface PublishDraftResponse {
622
+ export interface PublishDraftResponse {
622
623
  /** Published event form. */
623
624
  form?: Form;
624
625
  }
625
- interface EventUpdated {
626
+ export interface EventUpdated {
626
627
  /** Event update timestamp in ISO UTC format. */
627
628
  timestamp?: Date | null;
628
629
  /**
@@ -644,7 +645,7 @@ interface EventUpdated {
644
645
  /** Updated event */
645
646
  event?: Event;
646
647
  }
647
- interface Location {
648
+ export interface Location {
648
649
  /**
649
650
  * Location name.
650
651
  * @maxLength 50
@@ -676,7 +677,7 @@ interface Location {
676
677
  */
677
678
  tbd?: boolean | null;
678
679
  }
679
- interface MapCoordinates {
680
+ export interface MapCoordinates {
680
681
  /**
681
682
  * Latitude.
682
683
  * @min -90
@@ -690,12 +691,12 @@ interface MapCoordinates {
690
691
  */
691
692
  lng?: number;
692
693
  }
693
- declare enum LocationType {
694
+ export declare enum LocationType {
694
695
  VENUE = "VENUE",
695
696
  ONLINE = "ONLINE"
696
697
  }
697
698
  /** Physical address */
698
- interface Address extends AddressStreetOneOf {
699
+ export interface Address extends AddressStreetOneOf {
699
700
  /** a break down of the street to number and street name */
700
701
  streetAddress?: StreetAddress;
701
702
  /** Main address line (usually street and number) as free text */
@@ -726,19 +727,19 @@ interface Address extends AddressStreetOneOf {
726
727
  subdivisions?: Subdivision[];
727
728
  }
728
729
  /** @oneof */
729
- interface AddressStreetOneOf {
730
+ export interface AddressStreetOneOf {
730
731
  /** a break down of the street to number and street name */
731
732
  streetAddress?: StreetAddress;
732
733
  /** Main address line (usually street and number) as free text */
733
734
  addressLine?: string | null;
734
735
  }
735
- interface StreetAddress {
736
+ export interface StreetAddress {
736
737
  /** street number */
737
738
  number?: string;
738
739
  /** street name */
739
740
  name?: string;
740
741
  }
741
- interface AddressLocation {
742
+ export interface AddressLocation {
742
743
  /**
743
744
  * address latitude coordinates
744
745
  * @min -90
@@ -752,13 +753,13 @@ interface AddressLocation {
752
753
  */
753
754
  longitude?: number | null;
754
755
  }
755
- interface Subdivision {
756
+ export interface Subdivision {
756
757
  /** subdivision short code */
757
758
  code?: string;
758
759
  /** subdivision full-name */
759
760
  name?: string;
760
761
  }
761
- declare enum SubdivisionType {
762
+ export declare enum SubdivisionType {
762
763
  UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
763
764
  /** State */
764
765
  ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
@@ -773,7 +774,7 @@ declare enum SubdivisionType {
773
774
  /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
774
775
  COUNTRY = "COUNTRY"
775
776
  }
776
- interface ScheduleConfig {
777
+ export interface ScheduleConfig {
777
778
  /**
778
779
  * Defines event as TBD (To Be Determined) schedule.
779
780
  * When event time is not yet defined, TBD message is displayed instead of event start and end times.
@@ -801,7 +802,7 @@ interface ScheduleConfig {
801
802
  /** Event recurrences. */
802
803
  recurrences?: Recurrences;
803
804
  }
804
- interface Recurrences {
805
+ export interface Recurrences {
805
806
  /**
806
807
  * Event occurrences.
807
808
  * @maxSize 1000
@@ -818,7 +819,7 @@ interface Recurrences {
818
819
  */
819
820
  status?: Status;
820
821
  }
821
- interface Occurrence {
822
+ export interface Occurrence {
822
823
  /** Event start timestamp. */
823
824
  startDate?: Date | null;
824
825
  /** Event end timestamp. */
@@ -831,7 +832,7 @@ interface Occurrence {
831
832
  /** Whether time zone is displayed in formatted schedule. */
832
833
  showTimeZone?: boolean;
833
834
  }
834
- declare enum Status {
835
+ export declare enum Status {
835
836
  /** Event occurs only once. */
836
837
  ONE_TIME = "ONE_TIME",
837
838
  /** Event is recurring. */
@@ -843,7 +844,7 @@ declare enum Status {
843
844
  /** Marks the most recent canceled occurrence of the recurring event. */
844
845
  RECURRING_LAST_CANCELED = "RECURRING_LAST_CANCELED"
845
846
  }
846
- interface Event {
847
+ export interface Event {
847
848
  /**
848
849
  * Event ID.
849
850
  * @format GUID
@@ -913,7 +914,7 @@ interface Event {
913
914
  */
914
915
  publishedDate?: Date | null;
915
916
  }
916
- interface Scheduling {
917
+ export interface Scheduling {
917
918
  /** Schedule configuration. */
918
919
  config?: ScheduleConfig;
919
920
  /** Formatted schedule representation. */
@@ -927,7 +928,7 @@ interface Scheduling {
927
928
  /** Formatted end time of the event (empty for TBD schedules or when end date is hidden). */
928
929
  endTimeFormatted?: string;
929
930
  }
930
- declare enum EventStatus {
931
+ export declare enum EventStatus {
931
932
  /** Event is public and scheduled to start */
932
933
  SCHEDULED = "SCHEDULED",
933
934
  /** Event has started */
@@ -937,7 +938,7 @@ declare enum EventStatus {
937
938
  /** Event was canceled */
938
939
  CANCELED = "CANCELED"
939
940
  }
940
- interface Registration {
941
+ export interface Registration {
941
942
  /** Event type. */
942
943
  type?: EventType;
943
944
  /** Event registration status. */
@@ -953,7 +954,7 @@ interface Registration {
953
954
  /** Initial event type which was set when creating an event. */
954
955
  initialType?: EventType;
955
956
  }
956
- declare enum EventType {
957
+ export declare enum EventType {
957
958
  /** Type not available for this request fieldset */
958
959
  NA_EVENT_TYPE = "NA_EVENT_TYPE",
959
960
  /** Registration via RSVP */
@@ -965,7 +966,7 @@ declare enum EventType {
965
966
  /** Registration not available */
966
967
  NO_REGISTRATION = "NO_REGISTRATION"
967
968
  }
968
- declare enum RegistrationStatus {
969
+ export declare enum RegistrationStatus {
969
970
  /** Registration status is not applicable */
970
971
  NA_REGISTRATION_STATUS = "NA_REGISTRATION_STATUS",
971
972
  /** Registration to event is closed */
@@ -983,11 +984,11 @@ declare enum RegistrationStatus {
983
984
  /** Registration will be open via RSVP */
984
985
  SCHEDULED_RSVP = "SCHEDULED_RSVP"
985
986
  }
986
- interface RsvpCollection {
987
+ export interface RsvpCollection {
987
988
  /** RSVP collection configuration. */
988
989
  config?: RsvpCollectionConfig;
989
990
  }
990
- interface RsvpCollectionConfig {
991
+ export interface RsvpCollectionConfig {
991
992
  /** Defines the supported RSVP statuses. */
992
993
  rsvpStatusOptions?: RsvpStatusOptions;
993
994
  /**
@@ -1002,13 +1003,13 @@ interface RsvpCollectionConfig {
1002
1003
  /** Registration end timestamp. */
1003
1004
  endDate?: Date | null;
1004
1005
  }
1005
- declare enum RsvpStatusOptions {
1006
+ export declare enum RsvpStatusOptions {
1006
1007
  /** Only YES RSVP status is available for RSVP registration */
1007
1008
  YES_ONLY = "YES_ONLY",
1008
1009
  /** YES and NO RSVP status options are available for the registration */
1009
1010
  YES_AND_NO = "YES_AND_NO"
1010
1011
  }
1011
- interface Ticketing {
1012
+ export interface Ticketing {
1012
1013
  /**
1013
1014
  * Deprecated.
1014
1015
  * @deprecated
@@ -1049,7 +1050,7 @@ interface Ticketing {
1049
1050
  */
1050
1051
  soldOut?: boolean | null;
1051
1052
  }
1052
- interface TicketingConfig {
1053
+ export interface TicketingConfig {
1053
1054
  /** Whether the form must be filled out separately for each ticket. */
1054
1055
  guestAssignedTickets?: boolean;
1055
1056
  /** Tax configuration. */
@@ -1066,7 +1067,7 @@ interface TicketingConfig {
1066
1067
  */
1067
1068
  reservationDurationInMinutes?: number | null;
1068
1069
  }
1069
- interface TaxConfig {
1070
+ export interface TaxConfig {
1070
1071
  /** Tax application settings. */
1071
1072
  type?: TaxType;
1072
1073
  /**
@@ -1083,7 +1084,7 @@ interface TaxConfig {
1083
1084
  /** Applies taxes for donations, default true. */
1084
1085
  appliesToDonations?: boolean | null;
1085
1086
  }
1086
- declare enum TaxType {
1087
+ export declare enum TaxType {
1087
1088
  /** Tax is included in the ticket price. */
1088
1089
  INCLUDED = "INCLUDED",
1089
1090
  /** Tax is added to the order at the checkout. */
@@ -1091,7 +1092,7 @@ declare enum TaxType {
1091
1092
  /** Tax is added to the final total at the checkout. */
1092
1093
  ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
1093
1094
  }
1094
- interface Money {
1095
+ export interface Money {
1095
1096
  /**
1096
1097
  * *Deprecated:** Use `value` instead.
1097
1098
  * @format DECIMAL_VALUE
@@ -1109,11 +1110,11 @@ interface Money {
1109
1110
  */
1110
1111
  value?: string | null;
1111
1112
  }
1112
- interface ExternalEvent {
1113
+ export interface ExternalEvent {
1113
1114
  /** External event registration URL. */
1114
1115
  registration?: string;
1115
1116
  }
1116
- declare enum VisitorType {
1117
+ export declare enum VisitorType {
1117
1118
  /** Site visitor (including member) */
1118
1119
  VISITOR = "VISITOR",
1119
1120
  /** Site member */
@@ -1121,14 +1122,14 @@ declare enum VisitorType {
1121
1122
  /** Site visitor or member */
1122
1123
  VISITOR_OR_MEMBER = "VISITOR_OR_MEMBER"
1123
1124
  }
1124
- interface CalendarLinks {
1125
+ export interface CalendarLinks {
1125
1126
  /** "Add to Google calendar" URL. */
1126
1127
  google?: string;
1127
1128
  /** "Download ICS calendar file" URL. */
1128
1129
  ics?: string;
1129
1130
  }
1130
1131
  /** Site URL components */
1131
- interface SiteUrl {
1132
+ export interface SiteUrl {
1132
1133
  /**
1133
1134
  * Base URL. For premium sites, this will be the domain.
1134
1135
  * For free sites, this would be site URL (e.g `mysite.wixsite.com/mysite`)
@@ -1137,7 +1138,7 @@ interface SiteUrl {
1137
1138
  /** The path to that page - e.g `/my-events/weekly-meetup-2` */
1138
1139
  path?: string;
1139
1140
  }
1140
- interface Dashboard {
1141
+ export interface Dashboard {
1141
1142
  /** Guest RSVP summary. */
1142
1143
  rsvpSummary?: RsvpSummary;
1143
1144
  /**
@@ -1146,7 +1147,7 @@ interface Dashboard {
1146
1147
  */
1147
1148
  ticketingSummary?: TicketingSummary;
1148
1149
  }
1149
- interface RsvpSummary {
1150
+ export interface RsvpSummary {
1150
1151
  /** Total number of RSVPs. */
1151
1152
  total?: number;
1152
1153
  /** Number of RSVPs with status `YES`. */
@@ -1156,7 +1157,7 @@ interface RsvpSummary {
1156
1157
  /** Number of RSVPs in waitlist. */
1157
1158
  waitlist?: number;
1158
1159
  }
1159
- interface TicketingSummary {
1160
+ export interface TicketingSummary {
1160
1161
  /** Number of tickets sold. */
1161
1162
  tickets?: number;
1162
1163
  /**
@@ -1171,19 +1172,19 @@ interface TicketingSummary {
1171
1172
  /** Total balance of confirmed transactions. */
1172
1173
  totalSales?: Money;
1173
1174
  }
1174
- interface GuestListConfig {
1175
+ export interface GuestListConfig {
1175
1176
  /** Whether members can see other members attending the event (defaults to true). */
1176
1177
  publicGuestList?: boolean;
1177
1178
  }
1178
- interface Feed {
1179
+ export interface Feed {
1179
1180
  /** Event discussion feed token. */
1180
1181
  token?: string;
1181
1182
  }
1182
- interface OnlineConferencing {
1183
+ export interface OnlineConferencing {
1183
1184
  config?: OnlineConferencingConfig;
1184
1185
  session?: OnlineConferencingSession;
1185
1186
  }
1186
- interface OnlineConferencingConfig {
1187
+ export interface OnlineConferencingConfig {
1187
1188
  /**
1188
1189
  * Whether online conferencing is enabled (not supported for TBD schedules).
1189
1190
  * When enabled, links to join conferencing are generated and provided to guests.
@@ -1197,13 +1198,13 @@ interface OnlineConferencingConfig {
1197
1198
  /** Conference type */
1198
1199
  conferenceType?: ConferenceType;
1199
1200
  }
1200
- declare enum ConferenceType {
1201
+ export declare enum ConferenceType {
1201
1202
  /** Everyone in the meeting can publish and subscribe video and audio. */
1202
1203
  MEETING = "MEETING",
1203
1204
  /** Guests can only subscribe to video and audio. */
1204
1205
  WEBINAR = "WEBINAR"
1205
1206
  }
1206
- interface OnlineConferencingSession {
1207
+ export interface OnlineConferencingSession {
1207
1208
  /**
1208
1209
  * Link for event host to start the online conference session.
1209
1210
  * @readonly
@@ -1230,7 +1231,7 @@ interface OnlineConferencingSession {
1230
1231
  */
1231
1232
  sessionId?: string | null;
1232
1233
  }
1233
- interface SeoSettings {
1234
+ export interface SeoSettings {
1234
1235
  /**
1235
1236
  * URL slug
1236
1237
  * @maxLength 130
@@ -1249,13 +1250,13 @@ interface SeoSettings {
1249
1250
  * The search engines use this information for ranking purposes, or to display snippets in the search results.
1250
1251
  * 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
1252
  */
1252
- interface SeoSchema {
1253
+ export interface SeoSchema {
1253
1254
  /** SEO tag information. */
1254
1255
  tags?: Tag[];
1255
1256
  /** SEO general settings. */
1256
1257
  settings?: Settings;
1257
1258
  }
1258
- interface Keyword {
1259
+ export interface Keyword {
1259
1260
  /** Keyword value. */
1260
1261
  term?: string;
1261
1262
  /** Whether the keyword is the main focus keyword. */
@@ -1266,7 +1267,7 @@ interface Keyword {
1266
1267
  */
1267
1268
  origin?: string | null;
1268
1269
  }
1269
- interface Tag {
1270
+ export interface Tag {
1270
1271
  /**
1271
1272
  * SEO tag type.
1272
1273
  *
@@ -1288,7 +1289,7 @@ interface Tag {
1288
1289
  /** Whether the tag is disabled. */
1289
1290
  disabled?: boolean;
1290
1291
  }
1291
- interface Settings {
1292
+ export interface Settings {
1292
1293
  /**
1293
1294
  * Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.
1294
1295
  *
@@ -1302,7 +1303,7 @@ interface Settings {
1302
1303
  */
1303
1304
  keywords?: Keyword[];
1304
1305
  }
1305
- interface Agenda {
1306
+ export interface Agenda {
1306
1307
  /** Whether the schedule is enabled for the event. */
1307
1308
  enabled?: boolean;
1308
1309
  /**
@@ -1311,7 +1312,7 @@ interface Agenda {
1311
1312
  */
1312
1313
  pageUrl?: SiteUrl;
1313
1314
  }
1314
- interface Category {
1315
+ export interface Category {
1315
1316
  /**
1316
1317
  * Category ID.
1317
1318
  * @format GUID
@@ -1349,13 +1350,13 @@ interface Category {
1349
1350
  */
1350
1351
  states?: State[];
1351
1352
  }
1352
- interface CategoryCounts {
1353
+ export interface CategoryCounts {
1353
1354
  /** Total number of draft events assigned to the category. */
1354
1355
  assignedEventsCount?: number | null;
1355
1356
  /** Total number of published events assigned to the category. Deleted events are excluded. */
1356
1357
  assignedDraftEventsCount?: number | null;
1357
1358
  }
1358
- declare enum State {
1359
+ export declare enum State {
1359
1360
  /** Created manually by the user. */
1360
1361
  MANUAL = "MANUAL",
1361
1362
  /** Created automatically. */
@@ -1365,15 +1366,15 @@ declare enum State {
1365
1366
  /** Category is hidden. */
1366
1367
  HIDDEN = "HIDDEN"
1367
1368
  }
1368
- interface EventDisplaySettings {
1369
+ export interface EventDisplaySettings {
1369
1370
  /** Whether event details button is hidden. Only available for events with no registration. */
1370
1371
  hideEventDetailsButton?: boolean | null;
1371
1372
  /** Disables event details page visibility. If event has an external registration configured visitors will be redirected from this page. */
1372
1373
  hideEventDetailsPage?: boolean | null;
1373
1374
  }
1374
- interface LabellingSettings {
1375
+ export interface LabellingSettings {
1375
1376
  }
1376
- interface RichContent {
1377
+ export interface RichContent {
1377
1378
  /** Node objects representing a rich content document. */
1378
1379
  nodes?: Node[];
1379
1380
  /** Object metadata. */
@@ -1381,7 +1382,7 @@ interface RichContent {
1381
1382
  /** Global styling for header, paragraph, block quote, and code block nodes in the object. */
1382
1383
  documentStyle?: DocumentStyle;
1383
1384
  }
1384
- interface Node extends NodeDataOneOf {
1385
+ export interface Node extends NodeDataOneOf {
1385
1386
  /** Data for a button node. */
1386
1387
  buttonData?: ButtonData;
1387
1388
  /** Data for a code block node. */
@@ -1446,7 +1447,7 @@ interface Node extends NodeDataOneOf {
1446
1447
  style?: NodeStyle;
1447
1448
  }
1448
1449
  /** @oneof */
1449
- interface NodeDataOneOf {
1450
+ export interface NodeDataOneOf {
1450
1451
  /** Data for a button node. */
1451
1452
  buttonData?: ButtonData;
1452
1453
  /** Data for a code block node. */
@@ -1502,7 +1503,7 @@ interface NodeDataOneOf {
1502
1503
  /** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
1503
1504
  layoutCellData?: LayoutCellData;
1504
1505
  }
1505
- declare enum NodeType {
1506
+ export declare enum NodeType {
1506
1507
  PARAGRAPH = "PARAGRAPH",
1507
1508
  TEXT = "TEXT",
1508
1509
  HEADING = "HEADING",
@@ -1538,7 +1539,7 @@ declare enum NodeType {
1538
1539
  LAYOUT = "LAYOUT",
1539
1540
  LAYOUT_CELL = "LAYOUT_CELL"
1540
1541
  }
1541
- interface NodeStyle {
1542
+ export interface NodeStyle {
1542
1543
  /** The top padding value in pixels. */
1543
1544
  paddingTop?: string | null;
1544
1545
  /** The bottom padding value in pixels. */
@@ -1546,7 +1547,7 @@ interface NodeStyle {
1546
1547
  /** The background color as a hexadecimal value. */
1547
1548
  backgroundColor?: string | null;
1548
1549
  }
1549
- interface ButtonData {
1550
+ export interface ButtonData {
1550
1551
  /** Styling for the button's container. */
1551
1552
  containerData?: PluginContainerData;
1552
1553
  /** The button type. */
@@ -1558,7 +1559,7 @@ interface ButtonData {
1558
1559
  /** Button link details. */
1559
1560
  link?: Link;
1560
1561
  }
1561
- interface Border {
1562
+ export interface Border {
1562
1563
  /**
1563
1564
  * Deprecated: Use `borderWidth` in `styles` instead.
1564
1565
  * @deprecated
@@ -1570,7 +1571,7 @@ interface Border {
1570
1571
  */
1571
1572
  radius?: number | null;
1572
1573
  }
1573
- interface Colors {
1574
+ export interface Colors {
1574
1575
  /**
1575
1576
  * Deprecated: Use `textColor` in `styles` instead.
1576
1577
  * @deprecated
@@ -1587,7 +1588,7 @@ interface Colors {
1587
1588
  */
1588
1589
  background?: string | null;
1589
1590
  }
1590
- interface PluginContainerData {
1591
+ export interface PluginContainerData {
1591
1592
  /** The width of the node when it's displayed. */
1592
1593
  width?: PluginContainerDataWidth;
1593
1594
  /** The node's alignment within its container. */
@@ -1599,7 +1600,7 @@ interface PluginContainerData {
1599
1600
  /** 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
1601
  textWrap?: boolean | null;
1601
1602
  }
1602
- declare enum WidthType {
1603
+ export declare enum WidthType {
1603
1604
  /** Width matches the content width */
1604
1605
  CONTENT = "CONTENT",
1605
1606
  /** Small Width */
@@ -1609,7 +1610,7 @@ declare enum WidthType {
1609
1610
  /** coast-to-coast display */
1610
1611
  FULL_WIDTH = "FULL_WIDTH"
1611
1612
  }
1612
- interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
1613
+ export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
1613
1614
  /**
1614
1615
  * One of the following predefined width options:
1615
1616
  * `CONTENT`: The width of the container matches the content width.
@@ -1622,7 +1623,7 @@ interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
1622
1623
  custom?: string | null;
1623
1624
  }
1624
1625
  /** @oneof */
1625
- interface PluginContainerDataWidthDataOneOf {
1626
+ export interface PluginContainerDataWidthDataOneOf {
1626
1627
  /**
1627
1628
  * One of the following predefined width options:
1628
1629
  * `CONTENT`: The width of the container matches the content width.
@@ -1634,7 +1635,7 @@ interface PluginContainerDataWidthDataOneOf {
1634
1635
  /** A custom width value in pixels. */
1635
1636
  custom?: string | null;
1636
1637
  }
1637
- declare enum PluginContainerDataAlignment {
1638
+ export declare enum PluginContainerDataAlignment {
1638
1639
  /** Center Alignment */
1639
1640
  CENTER = "CENTER",
1640
1641
  /** Left Alignment */
@@ -1642,7 +1643,7 @@ declare enum PluginContainerDataAlignment {
1642
1643
  /** Right Alignment */
1643
1644
  RIGHT = "RIGHT"
1644
1645
  }
1645
- interface Spoiler {
1646
+ export interface Spoiler {
1646
1647
  /** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
1647
1648
  enabled?: boolean | null;
1648
1649
  /** The description displayed on top of the spoiler cover. */
@@ -1650,17 +1651,17 @@ interface Spoiler {
1650
1651
  /** The text for the button used to remove the spoiler cover. */
1651
1652
  buttonText?: string | null;
1652
1653
  }
1653
- interface Height {
1654
+ export interface Height {
1654
1655
  /** A custom height value in pixels. */
1655
1656
  custom?: string | null;
1656
1657
  }
1657
- declare enum ButtonDataType {
1658
+ export declare enum ButtonDataType {
1658
1659
  /** Regular link button */
1659
1660
  LINK = "LINK",
1660
1661
  /** Triggers custom action that is defined in plugin configuration by the consumer */
1661
1662
  ACTION = "ACTION"
1662
1663
  }
1663
- interface Styles {
1664
+ export interface Styles {
1664
1665
  /**
1665
1666
  * Deprecated: Use `borderWidth` and `borderRadius` instead.
1666
1667
  * @deprecated
@@ -1713,7 +1714,7 @@ interface Styles {
1713
1714
  /** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
1714
1715
  buttonSize?: string | null;
1715
1716
  }
1716
- interface Link extends LinkDataOneOf {
1717
+ export interface Link extends LinkDataOneOf {
1717
1718
  /** The absolute URL for the linked document. */
1718
1719
  url?: string;
1719
1720
  /** The target node's ID. Used for linking to another node in this object. */
@@ -1732,13 +1733,13 @@ interface Link extends LinkDataOneOf {
1732
1733
  customData?: string | null;
1733
1734
  }
1734
1735
  /** @oneof */
1735
- interface LinkDataOneOf {
1736
+ export interface LinkDataOneOf {
1736
1737
  /** The absolute URL for the linked document. */
1737
1738
  url?: string;
1738
1739
  /** The target node's ID. Used for linking to another node in this object. */
1739
1740
  anchor?: string;
1740
1741
  }
1741
- declare enum Target {
1742
+ export declare enum Target {
1742
1743
  /** Opens the linked document in the same frame as it was clicked (this is default) */
1743
1744
  SELF = "SELF",
1744
1745
  /** Opens the linked document in a new window or tab */
@@ -1748,7 +1749,7 @@ declare enum Target {
1748
1749
  /** Opens the linked document in the full body of the window */
1749
1750
  TOP = "TOP"
1750
1751
  }
1751
- interface Rel {
1752
+ export interface Rel {
1752
1753
  /** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
1753
1754
  nofollow?: boolean | null;
1754
1755
  /** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
@@ -1758,17 +1759,17 @@ interface Rel {
1758
1759
  /** Indicates that this link protect referral information from being passed to the target website. */
1759
1760
  noreferrer?: boolean | null;
1760
1761
  }
1761
- interface CodeBlockData {
1762
+ export interface CodeBlockData {
1762
1763
  /** Styling for the code block's text. */
1763
1764
  textStyle?: TextStyle;
1764
1765
  }
1765
- interface TextStyle {
1766
+ export interface TextStyle {
1766
1767
  /** Text alignment. Defaults to `AUTO`. */
1767
1768
  textAlignment?: TextAlignment;
1768
1769
  /** 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
1770
  lineHeight?: string | null;
1770
1771
  }
1771
- declare enum TextAlignment {
1772
+ export declare enum TextAlignment {
1772
1773
  /** browser default, eqivalent to `initial` */
1773
1774
  AUTO = "AUTO",
1774
1775
  /** Left align */
@@ -1780,7 +1781,7 @@ declare enum TextAlignment {
1780
1781
  /** 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
1782
  JUSTIFY = "JUSTIFY"
1782
1783
  }
1783
- interface DividerData {
1784
+ export interface DividerData {
1784
1785
  /** Styling for the divider's container. */
1785
1786
  containerData?: PluginContainerData;
1786
1787
  /** Divider line style. */
@@ -1790,7 +1791,7 @@ interface DividerData {
1790
1791
  /** Divider alignment. */
1791
1792
  alignment?: Alignment;
1792
1793
  }
1793
- declare enum LineStyle {
1794
+ export declare enum LineStyle {
1794
1795
  /** Single Line */
1795
1796
  SINGLE = "SINGLE",
1796
1797
  /** Double Line */
@@ -1800,7 +1801,7 @@ declare enum LineStyle {
1800
1801
  /** Dotted Line */
1801
1802
  DOTTED = "DOTTED"
1802
1803
  }
1803
- declare enum Width {
1804
+ export declare enum Width {
1804
1805
  /** Large line */
1805
1806
  LARGE = "LARGE",
1806
1807
  /** Medium line */
@@ -1808,7 +1809,7 @@ declare enum Width {
1808
1809
  /** Small line */
1809
1810
  SMALL = "SMALL"
1810
1811
  }
1811
- declare enum Alignment {
1812
+ export declare enum Alignment {
1812
1813
  /** Center alignment */
1813
1814
  CENTER = "CENTER",
1814
1815
  /** Left alignment */
@@ -1816,7 +1817,7 @@ declare enum Alignment {
1816
1817
  /** Right alignment */
1817
1818
  RIGHT = "RIGHT"
1818
1819
  }
1819
- interface FileData {
1820
+ export interface FileData {
1820
1821
  /** Styling for the file's container. */
1821
1822
  containerData?: PluginContainerData;
1822
1823
  /** The source for the file's data. */
@@ -1839,7 +1840,7 @@ interface FileData {
1839
1840
  /** File size in KB. */
1840
1841
  sizeInKb?: string | null;
1841
1842
  }
1842
- declare enum ViewMode {
1843
+ export declare enum ViewMode {
1843
1844
  /** No PDF view */
1844
1845
  NONE = "NONE",
1845
1846
  /** Full PDF view */
@@ -1847,7 +1848,7 @@ declare enum ViewMode {
1847
1848
  /** Mini PDF view */
1848
1849
  MINI = "MINI"
1849
1850
  }
1850
- interface FileSource extends FileSourceDataOneOf {
1851
+ export interface FileSource extends FileSourceDataOneOf {
1851
1852
  /** The absolute URL for the file's source. */
1852
1853
  url?: string | null;
1853
1854
  /**
@@ -1861,7 +1862,7 @@ interface FileSource extends FileSourceDataOneOf {
1861
1862
  private?: boolean | null;
1862
1863
  }
1863
1864
  /** @oneof */
1864
- interface FileSourceDataOneOf {
1865
+ export interface FileSourceDataOneOf {
1865
1866
  /** The absolute URL for the file's source. */
1866
1867
  url?: string | null;
1867
1868
  /**
@@ -1872,7 +1873,7 @@ interface FileSourceDataOneOf {
1872
1873
  /** An ID that's resolved to a URL by a resolver function. */
1873
1874
  _id?: string | null;
1874
1875
  }
1875
- interface PDFSettings {
1876
+ export interface PDFSettings {
1876
1877
  /**
1877
1878
  * PDF view mode. One of the following:
1878
1879
  * `NONE` : The PDF isn't displayed.
@@ -1885,7 +1886,7 @@ interface PDFSettings {
1885
1886
  /** Sets whether the PDF print button is disabled. Defaults to `false`. */
1886
1887
  disablePrint?: boolean | null;
1887
1888
  }
1888
- interface GalleryData {
1889
+ export interface GalleryData {
1889
1890
  /** Styling for the gallery's container. */
1890
1891
  containerData?: PluginContainerData;
1891
1892
  /** The items in the gallery. */
@@ -1897,7 +1898,7 @@ interface GalleryData {
1897
1898
  /** Sets whether the gallery's download button is disabled. Defaults to `false`. */
1898
1899
  disableDownload?: boolean | null;
1899
1900
  }
1900
- interface Media {
1901
+ export interface Media {
1901
1902
  /** The source for the media's data. */
1902
1903
  src?: FileSource;
1903
1904
  /** Media width in pixels. */
@@ -1907,19 +1908,19 @@ interface Media {
1907
1908
  /** Media duration in seconds. Only relevant for audio and video files. */
1908
1909
  duration?: number | null;
1909
1910
  }
1910
- interface Image {
1911
+ export interface Image {
1911
1912
  /** Image file details. */
1912
1913
  media?: Media;
1913
1914
  /** Link details for images that are links. */
1914
1915
  link?: Link;
1915
1916
  }
1916
- interface Video {
1917
+ export interface Video {
1917
1918
  /** Video file details. */
1918
1919
  media?: Media;
1919
1920
  /** Video thumbnail file details. */
1920
1921
  thumbnail?: Media;
1921
1922
  }
1922
- interface Item extends ItemDataOneOf {
1923
+ export interface Item extends ItemDataOneOf {
1923
1924
  /** An image item. */
1924
1925
  image?: Image;
1925
1926
  /** A video item. */
@@ -1930,13 +1931,13 @@ interface Item extends ItemDataOneOf {
1930
1931
  altText?: string | null;
1931
1932
  }
1932
1933
  /** @oneof */
1933
- interface ItemDataOneOf {
1934
+ export interface ItemDataOneOf {
1934
1935
  /** An image item. */
1935
1936
  image?: Image;
1936
1937
  /** A video item. */
1937
1938
  video?: Video;
1938
1939
  }
1939
- interface GalleryOptions {
1940
+ export interface GalleryOptions {
1940
1941
  /** Gallery layout. */
1941
1942
  layout?: Layout;
1942
1943
  /** Styling for gallery items. */
@@ -1944,7 +1945,7 @@ interface GalleryOptions {
1944
1945
  /** Styling for gallery thumbnail images. */
1945
1946
  thumbnails?: Thumbnails;
1946
1947
  }
1947
- declare enum LayoutType {
1948
+ export declare enum LayoutType {
1948
1949
  /** Collage type */
1949
1950
  COLLAGE = "COLLAGE",
1950
1951
  /** Masonry type */
@@ -1966,19 +1967,19 @@ declare enum LayoutType {
1966
1967
  /** Fullsize images type */
1967
1968
  FULLSIZE = "FULLSIZE"
1968
1969
  }
1969
- declare enum Orientation {
1970
+ export declare enum Orientation {
1970
1971
  /** Rows Orientation */
1971
1972
  ROWS = "ROWS",
1972
1973
  /** Columns Orientation */
1973
1974
  COLUMNS = "COLUMNS"
1974
1975
  }
1975
- declare enum Crop {
1976
+ export declare enum Crop {
1976
1977
  /** Crop to fill */
1977
1978
  FILL = "FILL",
1978
1979
  /** Crop to fit */
1979
1980
  FIT = "FIT"
1980
1981
  }
1981
- declare enum ThumbnailsAlignment {
1982
+ export declare enum ThumbnailsAlignment {
1982
1983
  /** Top alignment */
1983
1984
  TOP = "TOP",
1984
1985
  /** Right alignment */
@@ -1990,7 +1991,7 @@ declare enum ThumbnailsAlignment {
1990
1991
  /** No thumbnail */
1991
1992
  NONE = "NONE"
1992
1993
  }
1993
- interface Layout {
1994
+ export interface Layout {
1994
1995
  /** Gallery layout type. */
1995
1996
  type?: LayoutType;
1996
1997
  /** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
@@ -2002,7 +2003,7 @@ interface Layout {
2002
2003
  /** The number of columns to display on mobile screens. */
2003
2004
  mobileNumberOfColumns?: number | null;
2004
2005
  }
2005
- interface ItemStyle {
2006
+ export interface ItemStyle {
2006
2007
  /** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
2007
2008
  targetSize?: number | null;
2008
2009
  /** Item ratio */
@@ -2012,13 +2013,13 @@ interface ItemStyle {
2012
2013
  /** The spacing between items in pixels. */
2013
2014
  spacing?: number | null;
2014
2015
  }
2015
- interface Thumbnails {
2016
+ export interface Thumbnails {
2016
2017
  /** Thumbnail alignment. */
2017
2018
  placement?: ThumbnailsAlignment;
2018
2019
  /** Spacing between thumbnails in pixels. */
2019
2020
  spacing?: number | null;
2020
2021
  }
2021
- interface GIFData {
2022
+ export interface GIFData {
2022
2023
  /** Styling for the GIF's container. */
2023
2024
  containerData?: PluginContainerData;
2024
2025
  /** The source of the full size GIF. */
@@ -2032,7 +2033,7 @@ interface GIFData {
2032
2033
  /** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
2033
2034
  gifType?: GIFType;
2034
2035
  }
2035
- interface GIF {
2036
+ export interface GIF {
2036
2037
  /**
2037
2038
  * GIF format URL.
2038
2039
  * @format WEB_URL
@@ -2049,11 +2050,11 @@ interface GIF {
2049
2050
  */
2050
2051
  still?: string | null;
2051
2052
  }
2052
- declare enum GIFType {
2053
+ export declare enum GIFType {
2053
2054
  NORMAL = "NORMAL",
2054
2055
  STICKER = "STICKER"
2055
2056
  }
2056
- interface HeadingData {
2057
+ export interface HeadingData {
2057
2058
  /** Heading level from 1-6. */
2058
2059
  level?: number;
2059
2060
  /** Styling for the heading text. */
@@ -2061,7 +2062,7 @@ interface HeadingData {
2061
2062
  /** Indentation level from 1-4. */
2062
2063
  indentation?: number | null;
2063
2064
  }
2064
- interface HTMLData extends HTMLDataDataOneOf {
2065
+ export interface HTMLData extends HTMLDataDataOneOf {
2065
2066
  /** The URL for the HTML code for the node. */
2066
2067
  url?: string;
2067
2068
  /** The HTML code for the node. */
@@ -2079,7 +2080,7 @@ interface HTMLData extends HTMLDataDataOneOf {
2079
2080
  autoHeight?: boolean | null;
2080
2081
  }
2081
2082
  /** @oneof */
2082
- interface HTMLDataDataOneOf {
2083
+ export interface HTMLDataDataOneOf {
2083
2084
  /** The URL for the HTML code for the node. */
2084
2085
  url?: string;
2085
2086
  /** The HTML code for the node. */
@@ -2090,11 +2091,11 @@ interface HTMLDataDataOneOf {
2090
2091
  */
2091
2092
  isAdsense?: boolean | null;
2092
2093
  }
2093
- declare enum Source {
2094
+ export declare enum Source {
2094
2095
  HTML = "HTML",
2095
2096
  ADSENSE = "ADSENSE"
2096
2097
  }
2097
- interface ImageData {
2098
+ export interface ImageData {
2098
2099
  /** Styling for the image's container. */
2099
2100
  containerData?: PluginContainerData;
2100
2101
  /** Image file details. */
@@ -2117,7 +2118,7 @@ interface ImageData {
2117
2118
  /** Styling for the image. */
2118
2119
  styles?: ImageDataStyles;
2119
2120
  }
2120
- interface StylesBorder {
2121
+ export interface StylesBorder {
2121
2122
  /** Border width in pixels. */
2122
2123
  width?: number | null;
2123
2124
  /**
@@ -2128,11 +2129,11 @@ interface StylesBorder {
2128
2129
  /** Border radius in pixels. */
2129
2130
  radius?: number | null;
2130
2131
  }
2131
- interface ImageDataStyles {
2132
+ export interface ImageDataStyles {
2132
2133
  /** Border attributes. */
2133
2134
  border?: StylesBorder;
2134
2135
  }
2135
- interface LinkPreviewData {
2136
+ export interface LinkPreviewData {
2136
2137
  /** Styling for the link preview's container. */
2137
2138
  containerData?: PluginContainerData;
2138
2139
  /** Link details. */
@@ -2148,7 +2149,7 @@ interface LinkPreviewData {
2148
2149
  /** Styling for the link preview. */
2149
2150
  styles?: LinkPreviewDataStyles;
2150
2151
  }
2151
- declare enum Position {
2152
+ export declare enum Position {
2152
2153
  /** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
2153
2154
  START = "START",
2154
2155
  /** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
@@ -2158,7 +2159,7 @@ declare enum Position {
2158
2159
  /** Thumbnail hidden and not displayed */
2159
2160
  HIDDEN = "HIDDEN"
2160
2161
  }
2161
- interface LinkPreviewDataStyles {
2162
+ export interface LinkPreviewDataStyles {
2162
2163
  /**
2163
2164
  * Background color as a hexadecimal value.
2164
2165
  * @format COLOR_HEX
@@ -2191,13 +2192,13 @@ interface LinkPreviewDataStyles {
2191
2192
  /** Position of thumbnail. Defaults to `START`. */
2192
2193
  thumbnailPosition?: Position;
2193
2194
  }
2194
- interface MapData {
2195
+ export interface MapData {
2195
2196
  /** Styling for the map's container. */
2196
2197
  containerData?: PluginContainerData;
2197
2198
  /** Map settings. */
2198
2199
  mapSettings?: MapSettings;
2199
2200
  }
2200
- interface MapSettings {
2201
+ export interface MapSettings {
2201
2202
  /** The address to display on the map. */
2202
2203
  address?: string | null;
2203
2204
  /** Sets whether the map is draggable. */
@@ -2221,7 +2222,7 @@ interface MapSettings {
2221
2222
  /** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
2222
2223
  mapType?: MapType;
2223
2224
  }
2224
- declare enum MapType {
2225
+ export declare enum MapType {
2225
2226
  /** Roadmap map type */
2226
2227
  ROADMAP = "ROADMAP",
2227
2228
  /** Satellite map type */
@@ -2231,7 +2232,7 @@ declare enum MapType {
2231
2232
  /** Terrain map type */
2232
2233
  TERRAIN = "TERRAIN"
2233
2234
  }
2234
- interface ParagraphData {
2235
+ export interface ParagraphData {
2235
2236
  /** Styling for the paragraph text. */
2236
2237
  textStyle?: TextStyle;
2237
2238
  /** Indentation level from 1-4. */
@@ -2239,7 +2240,7 @@ interface ParagraphData {
2239
2240
  /** Paragraph level */
2240
2241
  level?: number | null;
2241
2242
  }
2242
- interface PollData {
2243
+ export interface PollData {
2243
2244
  /** Styling for the poll's container. */
2244
2245
  containerData?: PluginContainerData;
2245
2246
  /** Poll data. */
@@ -2249,7 +2250,7 @@ interface PollData {
2249
2250
  /** Styling for the poll and voting options. */
2250
2251
  design?: Design;
2251
2252
  }
2252
- declare enum ViewRole {
2253
+ export declare enum ViewRole {
2253
2254
  /** Only Poll creator can view the results */
2254
2255
  CREATOR = "CREATOR",
2255
2256
  /** Anyone who voted can see the results */
@@ -2257,13 +2258,13 @@ declare enum ViewRole {
2257
2258
  /** Anyone can see the results, even if one didn't vote */
2258
2259
  EVERYONE = "EVERYONE"
2259
2260
  }
2260
- declare enum VoteRole {
2261
+ export declare enum VoteRole {
2261
2262
  /** Logged in member */
2262
2263
  SITE_MEMBERS = "SITE_MEMBERS",
2263
2264
  /** Anyone */
2264
2265
  ALL = "ALL"
2265
2266
  }
2266
- interface Permissions {
2267
+ export interface Permissions {
2267
2268
  /** Sets who can view the poll results. */
2268
2269
  view?: ViewRole;
2269
2270
  /** Sets who can vote. */
@@ -2271,7 +2272,7 @@ interface Permissions {
2271
2272
  /** Sets whether one voter can vote multiple times. Defaults to `false`. */
2272
2273
  allowMultipleVotes?: boolean | null;
2273
2274
  }
2274
- interface Option {
2275
+ export interface Option {
2275
2276
  /** Option ID. */
2276
2277
  _id?: string | null;
2277
2278
  /** Option title. */
@@ -2279,7 +2280,7 @@ interface Option {
2279
2280
  /** The image displayed with the option. */
2280
2281
  image?: Media;
2281
2282
  }
2282
- interface PollSettings {
2283
+ export interface PollSettings {
2283
2284
  /** Permissions settings for voting. */
2284
2285
  permissions?: Permissions;
2285
2286
  /** Sets whether voters are displayed in the vote results. Defaults to `true`. */
@@ -2287,19 +2288,19 @@ interface PollSettings {
2287
2288
  /** Sets whether the vote count is displayed. Defaults to `true`. */
2288
2289
  showVotesCount?: boolean | null;
2289
2290
  }
2290
- declare enum PollLayoutType {
2291
+ export declare enum PollLayoutType {
2291
2292
  /** List */
2292
2293
  LIST = "LIST",
2293
2294
  /** Grid */
2294
2295
  GRID = "GRID"
2295
2296
  }
2296
- declare enum PollLayoutDirection {
2297
+ export declare enum PollLayoutDirection {
2297
2298
  /** Left-to-right */
2298
2299
  LTR = "LTR",
2299
2300
  /** Right-to-left */
2300
2301
  RTL = "RTL"
2301
2302
  }
2302
- interface PollLayout {
2303
+ export interface PollLayout {
2303
2304
  /** The layout for displaying the voting options. */
2304
2305
  type?: PollLayoutType;
2305
2306
  /** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
@@ -2307,11 +2308,11 @@ interface PollLayout {
2307
2308
  /** Sets whether to display the main poll image. Defaults to `false`. */
2308
2309
  enableImage?: boolean | null;
2309
2310
  }
2310
- interface OptionLayout {
2311
+ export interface OptionLayout {
2311
2312
  /** Sets whether to display option images. Defaults to `false`. */
2312
2313
  enableImage?: boolean | null;
2313
2314
  }
2314
- declare enum BackgroundType {
2315
+ export declare enum BackgroundType {
2315
2316
  /** Color background type */
2316
2317
  COLOR = "COLOR",
2317
2318
  /** Image background type */
@@ -2319,7 +2320,7 @@ declare enum BackgroundType {
2319
2320
  /** Gradiant background type */
2320
2321
  GRADIENT = "GRADIENT"
2321
2322
  }
2322
- interface Gradient {
2323
+ export interface Gradient {
2323
2324
  /** The gradient angle in degrees. */
2324
2325
  angle?: number | null;
2325
2326
  /**
@@ -2333,7 +2334,7 @@ interface Gradient {
2333
2334
  */
2334
2335
  lastColor?: string | null;
2335
2336
  }
2336
- interface Background extends BackgroundBackgroundOneOf {
2337
+ export interface Background extends BackgroundBackgroundOneOf {
2337
2338
  /**
2338
2339
  * The background color as a hexademical value.
2339
2340
  * @format COLOR_HEX
@@ -2347,7 +2348,7 @@ interface Background extends BackgroundBackgroundOneOf {
2347
2348
  type?: BackgroundType;
2348
2349
  }
2349
2350
  /** @oneof */
2350
- interface BackgroundBackgroundOneOf {
2351
+ export interface BackgroundBackgroundOneOf {
2351
2352
  /**
2352
2353
  * The background color as a hexademical value.
2353
2354
  * @format COLOR_HEX
@@ -2358,17 +2359,17 @@ interface BackgroundBackgroundOneOf {
2358
2359
  /** Details for a gradient background. */
2359
2360
  gradient?: Gradient;
2360
2361
  }
2361
- interface PollDesign {
2362
+ export interface PollDesign {
2362
2363
  /** Background styling. */
2363
2364
  background?: Background;
2364
2365
  /** Border radius in pixels. */
2365
2366
  borderRadius?: number | null;
2366
2367
  }
2367
- interface OptionDesign {
2368
+ export interface OptionDesign {
2368
2369
  /** Border radius in pixels. */
2369
2370
  borderRadius?: number | null;
2370
2371
  }
2371
- interface Poll {
2372
+ export interface Poll {
2372
2373
  /** Poll ID. */
2373
2374
  _id?: string | null;
2374
2375
  /** Poll title. */
@@ -2382,26 +2383,26 @@ interface Poll {
2382
2383
  /** The poll's permissions and display settings. */
2383
2384
  settings?: PollSettings;
2384
2385
  }
2385
- interface PollDataLayout {
2386
+ export interface PollDataLayout {
2386
2387
  /** Poll layout settings. */
2387
2388
  poll?: PollLayout;
2388
2389
  /** Voting otpions layout settings. */
2389
2390
  options?: OptionLayout;
2390
2391
  }
2391
- interface Design {
2392
+ export interface Design {
2392
2393
  /** Styling for the poll. */
2393
2394
  poll?: PollDesign;
2394
2395
  /** Styling for voting options. */
2395
2396
  options?: OptionDesign;
2396
2397
  }
2397
- interface TextData {
2398
+ export interface TextData {
2398
2399
  /** The text to apply decorations to. */
2399
2400
  text?: string;
2400
2401
  /** The decorations to apply. */
2401
2402
  decorations?: Decoration[];
2402
2403
  }
2403
2404
  /** Adds appearence changes to text */
2404
- interface Decoration extends DecorationDataOneOf {
2405
+ export interface Decoration extends DecorationDataOneOf {
2405
2406
  /** Data for an anchor link decoration. */
2406
2407
  anchorData?: AnchorData;
2407
2408
  /** Data for a color decoration. */
@@ -2426,7 +2427,7 @@ interface Decoration extends DecorationDataOneOf {
2426
2427
  type?: DecorationType;
2427
2428
  }
2428
2429
  /** @oneof */
2429
- interface DecorationDataOneOf {
2430
+ export interface DecorationDataOneOf {
2430
2431
  /** Data for an anchor link decoration. */
2431
2432
  anchorData?: AnchorData;
2432
2433
  /** Data for a color decoration. */
@@ -2448,7 +2449,7 @@ interface DecorationDataOneOf {
2448
2449
  /** Data for a strikethrough decoration. Defaults to `true`. */
2449
2450
  strikethroughData?: boolean | null;
2450
2451
  }
2451
- declare enum DecorationType {
2452
+ export declare enum DecorationType {
2452
2453
  BOLD = "BOLD",
2453
2454
  ITALIC = "ITALIC",
2454
2455
  UNDERLINE = "UNDERLINE",
@@ -2461,21 +2462,21 @@ declare enum DecorationType {
2461
2462
  EXTERNAL = "EXTERNAL",
2462
2463
  STRIKETHROUGH = "STRIKETHROUGH"
2463
2464
  }
2464
- interface AnchorData {
2465
+ export interface AnchorData {
2465
2466
  /** The target node's ID. */
2466
2467
  anchor?: string;
2467
2468
  }
2468
- interface ColorData {
2469
+ export interface ColorData {
2469
2470
  /** The text's background color as a hexadecimal value. */
2470
2471
  background?: string | null;
2471
2472
  /** The text's foreground color as a hexadecimal value. */
2472
2473
  foreground?: string | null;
2473
2474
  }
2474
- interface LinkData {
2475
+ export interface LinkData {
2475
2476
  /** Link details. */
2476
2477
  link?: Link;
2477
2478
  }
2478
- interface MentionData {
2479
+ export interface MentionData {
2479
2480
  /** The mentioned user's name. */
2480
2481
  name?: string;
2481
2482
  /** The version of the user's name that appears after the `@` character in the mention. */
@@ -2483,21 +2484,21 @@ interface MentionData {
2483
2484
  /** Mentioned user's ID. */
2484
2485
  _id?: string | null;
2485
2486
  }
2486
- interface FontSizeData {
2487
+ export interface FontSizeData {
2487
2488
  /** The units used for the font size. */
2488
2489
  unit?: FontType;
2489
2490
  /** Font size value. */
2490
2491
  value?: number | null;
2491
2492
  }
2492
- declare enum FontType {
2493
+ export declare enum FontType {
2493
2494
  PX = "PX",
2494
2495
  EM = "EM"
2495
2496
  }
2496
- interface SpoilerData {
2497
+ export interface SpoilerData {
2497
2498
  /** Spoiler ID. */
2498
2499
  _id?: string | null;
2499
2500
  }
2500
- interface AppEmbedData extends AppEmbedDataAppDataOneOf {
2501
+ export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
2501
2502
  /** Data for embedded Wix Bookings content. */
2502
2503
  bookingData?: BookingData;
2503
2504
  /** Data for embedded Wix Events content. */
@@ -2519,28 +2520,28 @@ interface AppEmbedData extends AppEmbedDataAppDataOneOf {
2519
2520
  image?: Media;
2520
2521
  }
2521
2522
  /** @oneof */
2522
- interface AppEmbedDataAppDataOneOf {
2523
+ export interface AppEmbedDataAppDataOneOf {
2523
2524
  /** Data for embedded Wix Bookings content. */
2524
2525
  bookingData?: BookingData;
2525
2526
  /** Data for embedded Wix Events content. */
2526
2527
  eventData?: EventData;
2527
2528
  }
2528
- declare enum AppType {
2529
+ export declare enum AppType {
2529
2530
  PRODUCT = "PRODUCT",
2530
2531
  EVENT = "EVENT",
2531
2532
  BOOKING = "BOOKING"
2532
2533
  }
2533
- interface BookingData {
2534
+ export interface BookingData {
2534
2535
  /** Booking duration in minutes. */
2535
2536
  durations?: string | null;
2536
2537
  }
2537
- interface EventData {
2538
+ export interface EventData {
2538
2539
  /** Event schedule. */
2539
2540
  scheduling?: string | null;
2540
2541
  /** Event location. */
2541
2542
  location?: string | null;
2542
2543
  }
2543
- interface VideoData {
2544
+ export interface VideoData {
2544
2545
  /** Styling for the video's container. */
2545
2546
  containerData?: PluginContainerData;
2546
2547
  /** Video details. */
@@ -2554,7 +2555,7 @@ interface VideoData {
2554
2555
  /** Video options. */
2555
2556
  options?: PlaybackOptions;
2556
2557
  }
2557
- interface PlaybackOptions {
2558
+ export interface PlaybackOptions {
2558
2559
  /** Sets whether the media will automatically start playing. */
2559
2560
  autoPlay?: boolean | null;
2560
2561
  /** Sets whether media's will be looped. */
@@ -2562,7 +2563,7 @@ interface PlaybackOptions {
2562
2563
  /** Sets whether media's controls will be shown. */
2563
2564
  showControls?: boolean | null;
2564
2565
  }
2565
- interface EmbedData {
2566
+ export interface EmbedData {
2566
2567
  /** Styling for the oEmbed node's container. */
2567
2568
  containerData?: PluginContainerData;
2568
2569
  /** An [oEmbed](https://www.oembed.com) object. */
@@ -2570,7 +2571,7 @@ interface EmbedData {
2570
2571
  /** Origin asset source. */
2571
2572
  src?: string | null;
2572
2573
  }
2573
- interface Oembed {
2574
+ export interface Oembed {
2574
2575
  /** The resource type. */
2575
2576
  type?: string | null;
2576
2577
  /** The width of the resource specified in the `url` property in pixels. */
@@ -2602,7 +2603,7 @@ interface Oembed {
2602
2603
  /** The oEmbed version number. This value must be `1.0`. */
2603
2604
  version?: string | null;
2604
2605
  }
2605
- interface CollapsibleListData {
2606
+ export interface CollapsibleListData {
2606
2607
  /** Styling for the collapsible list's container. */
2607
2608
  containerData?: PluginContainerData;
2608
2609
  /** If `true`, only one item can be expanded at a time. Defaults to `false`. */
@@ -2614,7 +2615,7 @@ interface CollapsibleListData {
2614
2615
  /** If `true`, The collapsible item will appear in search results as an FAQ. */
2615
2616
  isQapageData?: boolean | null;
2616
2617
  }
2617
- declare enum InitialExpandedItems {
2618
+ export declare enum InitialExpandedItems {
2618
2619
  /** First item will be expended initally */
2619
2620
  FIRST = "FIRST",
2620
2621
  /** All items will expended initally */
@@ -2622,13 +2623,13 @@ declare enum InitialExpandedItems {
2622
2623
  /** All items collapsed initally */
2623
2624
  NONE = "NONE"
2624
2625
  }
2625
- declare enum Direction {
2626
+ export declare enum Direction {
2626
2627
  /** Left-to-right */
2627
2628
  LTR = "LTR",
2628
2629
  /** Right-to-left */
2629
2630
  RTL = "RTL"
2630
2631
  }
2631
- interface TableData {
2632
+ export interface TableData {
2632
2633
  /** Styling for the table's container. */
2633
2634
  containerData?: PluginContainerData;
2634
2635
  /** The table's dimensions. */
@@ -2643,7 +2644,7 @@ interface TableData {
2643
2644
  /** Sets whether the table's first column is a header. Defaults to `false`. */
2644
2645
  columnHeader?: boolean | null;
2645
2646
  }
2646
- interface Dimensions {
2647
+ export interface Dimensions {
2647
2648
  /** An array representing relative width of each column in relation to the other columns. */
2648
2649
  colsWidthRatio?: number[];
2649
2650
  /** An array representing the height of each row in pixels. */
@@ -2651,13 +2652,13 @@ interface Dimensions {
2651
2652
  /** An array representing the minimum width of each column in pixels. */
2652
2653
  colsMinWidth?: number[];
2653
2654
  }
2654
- interface TableCellData {
2655
+ export interface TableCellData {
2655
2656
  /** Styling for the cell's background color and text alignment. */
2656
2657
  cellStyle?: CellStyle;
2657
2658
  /** The cell's border colors. */
2658
2659
  borderColors?: BorderColors;
2659
2660
  }
2660
- declare enum VerticalAlignment {
2661
+ export declare enum VerticalAlignment {
2661
2662
  /** Top alignment */
2662
2663
  TOP = "TOP",
2663
2664
  /** Middle alignment */
@@ -2665,7 +2666,7 @@ declare enum VerticalAlignment {
2665
2666
  /** Bottom alignment */
2666
2667
  BOTTOM = "BOTTOM"
2667
2668
  }
2668
- interface CellStyle {
2669
+ export interface CellStyle {
2669
2670
  /** Vertical alignment for the cell's text. */
2670
2671
  verticalAlignment?: VerticalAlignment;
2671
2672
  /**
@@ -2674,7 +2675,7 @@ interface CellStyle {
2674
2675
  */
2675
2676
  backgroundColor?: string | null;
2676
2677
  }
2677
- interface BorderColors {
2678
+ export interface BorderColors {
2678
2679
  /**
2679
2680
  * Left border color as a hexadecimal value.
2680
2681
  * @format COLOR_HEX
@@ -2702,7 +2703,7 @@ interface BorderColors {
2702
2703
  *
2703
2704
  * The JSON representation for `NullValue` is JSON `null`.
2704
2705
  */
2705
- declare enum NullValue {
2706
+ export declare enum NullValue {
2706
2707
  /** Null value. */
2707
2708
  NULL_VALUE = "NULL_VALUE"
2708
2709
  }
@@ -2711,11 +2712,11 @@ declare enum NullValue {
2711
2712
  *
2712
2713
  * The JSON representation for `ListValue` is JSON array.
2713
2714
  */
2714
- interface ListValue {
2715
+ export interface ListValue {
2715
2716
  /** Repeated field of dynamically typed values. */
2716
2717
  values?: any[];
2717
2718
  }
2718
- interface AudioData {
2719
+ export interface AudioData {
2719
2720
  /** Styling for the audio node's container. */
2720
2721
  containerData?: PluginContainerData;
2721
2722
  /** Audio file details. */
@@ -2731,7 +2732,7 @@ interface AudioData {
2731
2732
  /** An HTML version of the audio node. */
2732
2733
  html?: string | null;
2733
2734
  }
2734
- interface OrderedListData {
2735
+ export interface OrderedListData {
2735
2736
  /** Indentation level from 0-4. */
2736
2737
  indentation?: number;
2737
2738
  /** Offset level from 0-4. */
@@ -2739,24 +2740,24 @@ interface OrderedListData {
2739
2740
  /** List start number. */
2740
2741
  start?: number | null;
2741
2742
  }
2742
- interface BulletedListData {
2743
+ export interface BulletedListData {
2743
2744
  /** Indentation level from 0-4. */
2744
2745
  indentation?: number;
2745
2746
  /** Offset level from 0-4. */
2746
2747
  offset?: number | null;
2747
2748
  }
2748
- interface BlockquoteData {
2749
+ export interface BlockquoteData {
2749
2750
  /** Indentation level from 1-4. */
2750
2751
  indentation?: number;
2751
2752
  }
2752
- interface CaptionData {
2753
+ export interface CaptionData {
2753
2754
  textStyle?: TextStyle;
2754
2755
  }
2755
- interface LayoutCellData {
2756
+ export interface LayoutCellData {
2756
2757
  /** Size of the cell in 12 columns grid. */
2757
2758
  colSpan?: number | null;
2758
2759
  }
2759
- interface Metadata {
2760
+ export interface Metadata {
2760
2761
  /** Schema version. */
2761
2762
  version?: number;
2762
2763
  /**
@@ -2773,7 +2774,7 @@ interface Metadata {
2773
2774
  /** Object ID. */
2774
2775
  _id?: string | null;
2775
2776
  }
2776
- interface DocumentStyle {
2777
+ export interface DocumentStyle {
2777
2778
  /** Styling for H1 nodes. */
2778
2779
  headerOne?: TextNodeStyle;
2779
2780
  /** Styling for H2 nodes. */
@@ -2793,7 +2794,7 @@ interface DocumentStyle {
2793
2794
  /** Styling for code block nodes. */
2794
2795
  codeBlock?: TextNodeStyle;
2795
2796
  }
2796
- interface TextNodeStyle {
2797
+ export interface TextNodeStyle {
2797
2798
  /** The decorations to apply to the node. */
2798
2799
  decorations?: Decoration[];
2799
2800
  /** Padding and background color for the node. */
@@ -2801,7 +2802,7 @@ interface TextNodeStyle {
2801
2802
  /** Line height for text in the node. */
2802
2803
  lineHeight?: string | null;
2803
2804
  }
2804
- interface Badge {
2805
+ export interface Badge {
2805
2806
  /** Badge type. */
2806
2807
  type?: Type;
2807
2808
  /**
@@ -2810,7 +2811,7 @@ interface Badge {
2810
2811
  */
2811
2812
  text?: string | null;
2812
2813
  }
2813
- declare enum Type {
2814
+ export declare enum Type {
2814
2815
  /** Unknown badge type. */
2815
2816
  UNKNOWN_BADGE_TYPE = "UNKNOWN_BADGE_TYPE",
2816
2817
  /** 1st priority badge type. */
@@ -2820,16 +2821,16 @@ declare enum Type {
2820
2821
  /** 3rd priority badge type. */
2821
2822
  THIRD_PRIORITY = "THIRD_PRIORITY"
2822
2823
  }
2823
- interface DiscardDraftRequest {
2824
+ export interface DiscardDraftRequest {
2824
2825
  /**
2825
2826
  * Event ID to which the form belongs.
2826
2827
  * @format GUID
2827
2828
  */
2828
2829
  eventId: string;
2829
2830
  }
2830
- interface DiscardDraftResponse {
2831
+ export interface DiscardDraftResponse {
2831
2832
  }
2832
- interface DomainEvent extends DomainEventBodyOneOf {
2833
+ export interface DomainEvent extends DomainEventBodyOneOf {
2833
2834
  createdEvent?: EntityCreatedEvent;
2834
2835
  updatedEvent?: EntityUpdatedEvent;
2835
2836
  deletedEvent?: EntityDeletedEvent;
@@ -2872,19 +2873,19 @@ interface DomainEvent extends DomainEventBodyOneOf {
2872
2873
  entityEventSequence?: string | null;
2873
2874
  }
2874
2875
  /** @oneof */
2875
- interface DomainEventBodyOneOf {
2876
+ export interface DomainEventBodyOneOf {
2876
2877
  createdEvent?: EntityCreatedEvent;
2877
2878
  updatedEvent?: EntityUpdatedEvent;
2878
2879
  deletedEvent?: EntityDeletedEvent;
2879
2880
  actionEvent?: ActionEvent;
2880
2881
  }
2881
- interface EntityCreatedEvent {
2882
+ export interface EntityCreatedEvent {
2882
2883
  entity?: string;
2883
2884
  }
2884
- interface RestoreInfo {
2885
+ export interface RestoreInfo {
2885
2886
  deletedDate?: Date | null;
2886
2887
  }
2887
- interface EntityUpdatedEvent {
2888
+ export interface EntityUpdatedEvent {
2888
2889
  /**
2889
2890
  * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
2890
2891
  * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
@@ -2892,14 +2893,14 @@ interface EntityUpdatedEvent {
2892
2893
  */
2893
2894
  currentEntity?: string;
2894
2895
  }
2895
- interface EntityDeletedEvent {
2896
+ export interface EntityDeletedEvent {
2896
2897
  /** Entity that was deleted */
2897
2898
  deletedEntity?: string | null;
2898
2899
  }
2899
- interface ActionEvent {
2900
+ export interface ActionEvent {
2900
2901
  body?: string;
2901
2902
  }
2902
- interface MessageEnvelope {
2903
+ export interface MessageEnvelope {
2903
2904
  /**
2904
2905
  * App instance ID.
2905
2906
  * @format GUID
@@ -2915,7 +2916,7 @@ interface MessageEnvelope {
2915
2916
  /** Stringify payload. */
2916
2917
  data?: string;
2917
2918
  }
2918
- interface IdentificationData extends IdentificationDataIdOneOf {
2919
+ export interface IdentificationData extends IdentificationDataIdOneOf {
2919
2920
  /**
2920
2921
  * ID of a site visitor that has not logged in to the site.
2921
2922
  * @format GUID
@@ -2940,7 +2941,7 @@ interface IdentificationData extends IdentificationDataIdOneOf {
2940
2941
  identityType?: WebhookIdentityType;
2941
2942
  }
2942
2943
  /** @oneof */
2943
- interface IdentificationDataIdOneOf {
2944
+ export interface IdentificationDataIdOneOf {
2944
2945
  /**
2945
2946
  * ID of a site visitor that has not logged in to the site.
2946
2947
  * @format GUID
@@ -2962,14 +2963,14 @@ interface IdentificationDataIdOneOf {
2962
2963
  */
2963
2964
  appId?: string;
2964
2965
  }
2965
- declare enum WebhookIdentityType {
2966
+ export declare enum WebhookIdentityType {
2966
2967
  UNKNOWN = "UNKNOWN",
2967
2968
  ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
2968
2969
  MEMBER = "MEMBER",
2969
2970
  WIX_USER = "WIX_USER",
2970
2971
  APP = "APP"
2971
2972
  }
2972
- interface BaseEventMetadata {
2973
+ export interface BaseEventMetadata {
2973
2974
  /**
2974
2975
  * App instance ID.
2975
2976
  * @format GUID
@@ -2983,11 +2984,106 @@ interface BaseEventMetadata {
2983
2984
  /** The identification type and identity data. */
2984
2985
  identity?: IdentificationData;
2985
2986
  }
2986
- interface FormEventUpdatedEnvelope {
2987
+ export interface FormEventUpdatedEnvelope {
2987
2988
  data: EventUpdated;
2988
2989
  metadata: BaseEventMetadata;
2989
2990
  }
2990
- interface AddControlOptions extends AddControlOptionsControlOneOf {
2991
+ /**
2992
+ * Triggered when a form is updated or published.
2993
+ * @permissionScope Read Events - all read permissions
2994
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
2995
+ * @permissionScope Manage Bookings Services and Settings
2996
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
2997
+ * @permissionScope Manage Events - all permissions
2998
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
2999
+ * @permissionScope Manage Events
3000
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
3001
+ * @permissionScope Read Events
3002
+ * @permissionScopeId SCOPE.DC-EVENTS.READ-EVENTS
3003
+ * @permissionScope Manage Challenges
3004
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
3005
+ * @permissionScope Manage Portfolio
3006
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
3007
+ * @permissionScope Access Verticals by Automations
3008
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
3009
+ * @permissionScope Manage Restaurants - all permissions
3010
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3011
+ * @permissionScope Set Up Automations
3012
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
3013
+ * @permissionScope Manage Guest List
3014
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
3015
+ * @permissionScope Manage Events
3016
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
3017
+ * @permissionId WIX_EVENTS.READ_EVENTS
3018
+ * @webhook
3019
+ * @eventType wix.events.events.EventUpdated
3020
+ * @serviceIdentifier wix.events.form.FormBuilder
3021
+ * @slug event_updated
3022
+ */
3023
+ export declare function onFormEventUpdated(handler: (event: FormEventUpdatedEnvelope) => void | Promise<void>): void;
3024
+ type FormNonNullablePaths = `controls` | `controls.${number}.type` | `controls.${number}.system` | `controls.${number}.name` | `controls.${number}.inputs` | `controls.${number}.inputs.${number}.name` | `controls.${number}.inputs.${number}.array` | `controls.${number}.inputs.${number}.label` | `controls.${number}.inputs.${number}.options` | `controls.${number}.inputs.${number}.mandatory` | `controls.${number}.inputs.${number}.maxLength` | `controls.${number}.inputs.${number}.type` | `controls.${number}.inputs.${number}.defaultOptionSelection.optionIndex` | `controls.${number}.inputs.${number}.defaultOptionSelection.placeholderText` | `controls.${number}.inputs.${number}.labels` | `controls.${number}.inputs.${number}.labels.${number}.name` | `controls.${number}.inputs.${number}.labels.${number}.label` | `controls.${number}.label` | `controls.${number}.orderIndex` | `controls.${number}._id` | `messages.rsvp.rsvpYesOption` | `messages.rsvp.rsvpNoOption` | `messages.rsvp.positiveMessages.title` | `messages.rsvp.positiveMessages.confirmation.title` | `messages.rsvp.positiveMessages.confirmation.message` | `messages.rsvp.positiveMessages.confirmation.addToCalendarActionLabel` | `messages.rsvp.positiveMessages.confirmation.shareActionLabel` | `messages.rsvp.negativeMessages.title` | `messages.rsvp.negativeMessages.confirmation.title` | `messages.rsvp.negativeMessages.confirmation.shareActionLabel` | `messages.rsvp.submitActionLabel` | `messages.checkout.title` | `messages.checkout.submitActionLabel` | `messages.checkout.confirmation.title` | `messages.checkout.confirmation.message` | `messages.checkout.confirmation.downloadTicketsLabel` | `messages.checkout.confirmation.addToCalendarLabel` | `messages.checkout.confirmation.shareEventLabel` | `messages.registrationClosed.message` | `messages.registrationClosed.exploreEventsActionLabel` | `messages.ticketsUnavailable.message` | `messages.ticketsUnavailable.exploreEventsActionLabel`;
3025
+ /**
3026
+ * Retrieves an event registration form.
3027
+ *
3028
+ * Retrieves both the draft and published versions.
3029
+ * @param eventId - Event ID to which the form belongs.
3030
+ * @public
3031
+ * @requiredField eventId
3032
+ * @param options - Optional fields.
3033
+ * @permissionId WIX_EVENTS.READ_EVENTS
3034
+ * @permissionScope Read Events - all read permissions
3035
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
3036
+ * @permissionScope Manage Bookings Services and Settings
3037
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
3038
+ * @permissionScope Manage Events - all permissions
3039
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
3040
+ * @permissionScope Manage Events
3041
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
3042
+ * @permissionScope Read Events
3043
+ * @permissionScopeId SCOPE.DC-EVENTS.READ-EVENTS
3044
+ * @permissionScope Manage Challenges
3045
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
3046
+ * @permissionScope Manage Portfolio
3047
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
3048
+ * @permissionScope Access Verticals by Automations
3049
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
3050
+ * @permissionScope Manage Restaurants - all permissions
3051
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3052
+ * @permissionScope Set Up Automations
3053
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
3054
+ * @permissionScope Manage Guest List
3055
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
3056
+ * @permissionScope Manage Events
3057
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
3058
+ * @applicableIdentity APP
3059
+ * @applicableIdentity VISITOR
3060
+ * @returns Currently published event form.
3061
+ * Published form is visible to site visitors.
3062
+ * @fqn wix.events.form.FormBuilder.GetForm
3063
+ */
3064
+ export declare function getForm(eventId: string): Promise<NonNullablePaths<Form, FormNonNullablePaths>>;
3065
+ /**
3066
+ * Adds an input control to the draft form.
3067
+ * @param eventId - Event ID to which the form belongs.
3068
+ * @public
3069
+ * @requiredField eventId
3070
+ * @requiredField options
3071
+ * @requiredField options.control
3072
+ * @param options - Optional fields.
3073
+ * @permissionId WIX_EVENTS.MANAGE_EVENTS
3074
+ * @permissionScope Manage Events - all permissions
3075
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
3076
+ * @permissionScope Manage Events
3077
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
3078
+ * @permissionScope Manage Events
3079
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
3080
+ * @applicableIdentity APP
3081
+ * @fqn wix.events.form.FormBuilder.AddControl
3082
+ */
3083
+ export declare function addControl(eventId: string, options: AddControlOptions): Promise<NonNullablePaths<AddControlResponse, `_id` | {
3084
+ [P in FormNonNullablePaths]: `form.${P}`;
3085
+ }[FormNonNullablePaths]>>;
3086
+ export interface AddControlOptions extends AddControlOptionsControlOneOf {
2991
3087
  /** Phone number input control. */
2992
3088
  phone?: PhoneControl;
2993
3089
  /** Single-line or full address input control. */
@@ -3006,7 +3102,7 @@ interface AddControlOptions extends AddControlOptionsControlOneOf {
3006
3102
  radioButton?: RadioButtonControl;
3007
3103
  }
3008
3104
  /** @oneof */
3009
- interface AddControlOptionsControlOneOf {
3105
+ export interface AddControlOptionsControlOneOf {
3010
3106
  /** Phone number input control. */
3011
3107
  phone?: PhoneControl;
3012
3108
  /** Single-line or full address input control. */
@@ -3024,7 +3120,29 @@ interface AddControlOptionsControlOneOf {
3024
3120
  /** Single-choice radio button style input control. */
3025
3121
  radioButton?: RadioButtonControl;
3026
3122
  }
3027
- interface UpdateControlIdentifiers extends UpdateControlIdentifiersControlOneOf {
3123
+ /**
3124
+ * Updates an existing input control in the draft form.
3125
+ * @public
3126
+ * @requiredField identifiers
3127
+ * @requiredField identifiers._id
3128
+ * @requiredField identifiers.eventId
3129
+ * @requiredField options.control
3130
+ * @param options - Optional fields.
3131
+ * @param identifiers - Identifies what form to update.
3132
+ * @permissionId WIX_EVENTS.MANAGE_EVENTS
3133
+ * @permissionScope Manage Events - all permissions
3134
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
3135
+ * @permissionScope Manage Events
3136
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
3137
+ * @permissionScope Manage Events
3138
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
3139
+ * @applicableIdentity APP
3140
+ * @fqn wix.events.form.FormBuilder.UpdateControl
3141
+ */
3142
+ export declare function updateControl(identifiers: NonNullablePaths<UpdateControlIdentifiers, `_id` | `eventId`>, options?: UpdateControlOptions): Promise<NonNullablePaths<UpdateControlResponse, {
3143
+ [P in FormNonNullablePaths]: `form.${P}`;
3144
+ }[FormNonNullablePaths]>>;
3145
+ export interface UpdateControlIdentifiers extends UpdateControlIdentifiersControlOneOf {
3028
3146
  /**
3029
3147
  * Event ID to which the form belongs.
3030
3148
  * @format GUID
@@ -3034,7 +3152,7 @@ interface UpdateControlIdentifiers extends UpdateControlIdentifiersControlOneOf
3034
3152
  _id: string;
3035
3153
  }
3036
3154
  /** @oneof */
3037
- interface UpdateControlIdentifiersControlOneOf {
3155
+ export interface UpdateControlIdentifiersControlOneOf {
3038
3156
  /** Phone number input control. */
3039
3157
  phone?: PhoneControl;
3040
3158
  /** Single-line or full address input control. */
@@ -3056,7 +3174,7 @@ interface UpdateControlIdentifiersControlOneOf {
3056
3174
  /** Single-choice radio style input control. */
3057
3175
  radioButton?: RadioButtonControl;
3058
3176
  }
3059
- interface UpdateControlOptions extends UpdateControlOptionsControlOneOf {
3177
+ export interface UpdateControlOptions extends UpdateControlOptionsControlOneOf {
3060
3178
  /** Index used to sort input controls in ascending order. */
3061
3179
  orderIndex?: number;
3062
3180
  /** Phone number input control. */
@@ -3081,7 +3199,7 @@ interface UpdateControlOptions extends UpdateControlOptionsControlOneOf {
3081
3199
  radioButton?: RadioButtonControl;
3082
3200
  }
3083
3201
  /** @oneof */
3084
- interface UpdateControlOptionsControlOneOf {
3202
+ export interface UpdateControlOptionsControlOneOf {
3085
3203
  /** Phone number input control. */
3086
3204
  phone?: PhoneControl;
3087
3205
  /** Single-line or full address input control. */
@@ -3103,7 +3221,27 @@ interface UpdateControlOptionsControlOneOf {
3103
3221
  /** Single-choice radio style input control. */
3104
3222
  radioButton?: RadioButtonControl;
3105
3223
  }
3106
- interface DeleteControlIdentifiers {
3224
+ /**
3225
+ * Deletes an input control from the draft form.
3226
+ * @public
3227
+ * @requiredField identifiers
3228
+ * @requiredField identifiers._id
3229
+ * @requiredField identifiers.eventId
3230
+ * @param identifiers - Identifies what form to delete.
3231
+ * @permissionId WIX_EVENTS.MANAGE_EVENTS
3232
+ * @permissionScope Manage Events - all permissions
3233
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
3234
+ * @permissionScope Manage Events
3235
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
3236
+ * @permissionScope Manage Events
3237
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
3238
+ * @applicableIdentity APP
3239
+ * @fqn wix.events.form.FormBuilder.DeleteControl
3240
+ */
3241
+ export declare function deleteControl(identifiers: NonNullablePaths<DeleteControlIdentifiers, `_id` | `eventId`>): Promise<NonNullablePaths<DeleteControlResponse, {
3242
+ [P in FormNonNullablePaths]: `form.${P}`;
3243
+ }[FormNonNullablePaths]>>;
3244
+ export interface DeleteControlIdentifiers {
3107
3245
  /**
3108
3246
  * Event ID to which the form belongs.
3109
3247
  * @format GUID
@@ -3115,7 +3253,27 @@ interface DeleteControlIdentifiers {
3115
3253
  */
3116
3254
  _id: string;
3117
3255
  }
3118
- interface UpdateMessagesOptions {
3256
+ /**
3257
+ * Updates a set of defined form messages that are displayed to a site visitor before, during, and after the registration flow.
3258
+ * Includes the configuration of form titles, response labels, "thank you" messages, and call-to-action texts.
3259
+ * @param eventId - Event ID to which the form belongs.
3260
+ * @public
3261
+ * @requiredField eventId
3262
+ * @param options - Optional fields.
3263
+ * @permissionId WIX_EVENTS.MANAGE_EVENTS
3264
+ * @permissionScope Manage Events - all permissions
3265
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
3266
+ * @permissionScope Manage Events
3267
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
3268
+ * @permissionScope Manage Events
3269
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
3270
+ * @applicableIdentity APP
3271
+ * @fqn wix.events.form.FormBuilder.UpdateMessages
3272
+ */
3273
+ export declare function updateMessages(eventId: string, options?: UpdateMessagesOptions): Promise<NonNullablePaths<UpdateMessagesResponse, {
3274
+ [P in FormNonNullablePaths]: `form.${P}`;
3275
+ }[FormNonNullablePaths]>>;
3276
+ export interface UpdateMessagesOptions {
3119
3277
  /**
3120
3278
  * Set of field paths, specifying which parts of this resource to update.
3121
3279
  * When fields are empty, request is interpreted as full update.
@@ -3125,5 +3283,38 @@ interface UpdateMessagesOptions {
3125
3283
  /** Set of configured form messages to update. */
3126
3284
  messages?: FormMessages;
3127
3285
  }
3128
-
3129
- 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 };
3286
+ /**
3287
+ * Publishes the draft form.
3288
+ * @param eventId - Event ID to which the form belongs.
3289
+ * @public
3290
+ * @requiredField eventId
3291
+ * @permissionId WIX_EVENTS.MANAGE_EVENTS
3292
+ * @permissionScope Manage Events - all permissions
3293
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
3294
+ * @permissionScope Manage Events
3295
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
3296
+ * @permissionScope Manage Events
3297
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
3298
+ * @applicableIdentity APP
3299
+ * @fqn wix.events.form.FormBuilder.PublishDraft
3300
+ */
3301
+ export declare function publishDraft(eventId: string): Promise<NonNullablePaths<PublishDraftResponse, {
3302
+ [P in FormNonNullablePaths]: `form.${P}`;
3303
+ }[FormNonNullablePaths]>>;
3304
+ /**
3305
+ * Clears all changes to the draft form.
3306
+ * @param eventId - Event ID to which the form belongs.
3307
+ * @public
3308
+ * @requiredField eventId
3309
+ * @permissionId WIX_EVENTS.MANAGE_EVENTS
3310
+ * @permissionScope Manage Events - all permissions
3311
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
3312
+ * @permissionScope Manage Events
3313
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
3314
+ * @permissionScope Manage Events
3315
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
3316
+ * @applicableIdentity APP
3317
+ * @fqn wix.events.form.FormBuilder.DiscardDraft
3318
+ */
3319
+ export declare function discardDraft(eventId: string): Promise<void>;
3320
+ export {};