@wix/auto_sdk_events_wix-events-v-2 1.0.26 → 1.0.27

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